Make jdis releasable

-Added a README.md file

-Define a jdis version number in the Makefile

-Add dependency autogeneration to the Makefile

-Add a "clean" target to the Makefile

-License everything under creative commons zero

-Add a LICENSE file

-Add jdis options to select between GPU and DSP
 RISC CPU flavors. Default to GPU

-Print usage information when invalid parameters
 are specified in jdis

-Print version of jdis upon request

.gitignore

@@ -2,3 +2,4 @@
 *.o
 *~
 .*.swp
+.*.dep

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

Makefile

@@ -1,16 +1,46 @@
-CFLAGS=-O0 -g
-
-jdis: jdis.c jrisc_ctx.o jrisc_ctx_file.o jrisc_inst.o jrisc_inst_string.o
-	$(CC) $(CFLAGS) -o $@ $^
-
-jrisc_ctx.o: jrisc_ctx.c
-	$(CC) $(CFLAGS) -c -o $@ $<
-
-jrisc_ctx_file.o: jrisc_ctx_file.c
-	$(CC) $(CFLAGS) -c -o $@ $<
-
-jrisc_inst.o: jrisc_inst.c
-	$(CC) $(CFLAGS) -c -o $@ $<
-
-jrisc_inst_string.o: jrisc_inst_string.c
-	$(CC) $(CFLAGS) -c -o $@ $<
+###############################################################################
+#
+# SPDX-License-Identifier: CC0-1.0
+#
+# Author: James Jones
+#
+###############################################################################
+
+# Adjust these when making new releases
+
+JDIS_MAJOR = 1
+JDIS_MINOR = 0
+JDIS_MICRO = 0
+
+CDEFS ?=
+CPPFLAGS ?=
+CFLAGS ?=
+LDLIBS ?=
+
+CDEFS += -DJDIS_MAJOR=$(JDIS_MAJOR) \
+	-DJDIS_MINOR=$(JDIS_MINOR) \
+	-DJDIS_MICRO=$(JDIS_MICRO)
+
+CPPFLAGS += $(CDEFS)
+
+JRISC_CORE_OBJECTS = jrisc_ctx.o jrisc_inst.o
+JRISC_UTIL_OBJECTS = jrisc_ctx_file.o jrisc_ctx_mem.o jrisc_inst_string.o
+
+JDIS_OBJECTS = jdis.o
+
+ALL_OBJECTS = $(JRISC_CORE_OBJECTS) $(JRISC_UTIL_OBJECTS) $(JDIS_OBJECTS)
+DEPS = $(patsubst %.o,.%.dep,$(ALL_OBJECTS))
+
+PROGS = jdis
+
+all: $(PROGS)
+
+.%.dep: %.c
+	$(CC) -MM $^ -o $@
+
+jdis: $(JDIS_OBJECTS) $(JRISC_CORE_OBJECTS) $(JRISC_UTIL_OBJECTS)
+
+clean:
+	rm -f $(ALL_OBJECTS) $(PROGS)
+
+include $(DEPS)

README.md

@@ -0,0 +1,28 @@
+Atari Jaguar RISC Tools
+=======================
+
+Currently the only tool here is jdis, a minimal disassembler for Jaguar RISC
+machine code. However, I've attempted to structure the code such that the core
+routines could be used to build other tools such as assemblers, optimizers,
+hazard warning generators, etc.
+
+Building
+--------
+
+On a POSIX system with a C compiler and GNU make installed:
+
+    $ make
+
+You're on your own in Windows or other operating systems for now, but patches
+for Visual Studio or Xcode support are welcome.
+
+JDIS Usage
+----------
+
+    jdis [-gdhv] <JRISC machine code file>
+
+    Options:
+      -g: Parse code as Tom/GPU instructions [default].
+      -d: Parse code as Jerry/DSP instructions.
+      -h: Help. Print this text.
+      -v: Version. Print the version and exit.

jdis.c

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #include "jrisc_base.h"
 #include "jrisc_ctx.h"
 #include "jrisc_ctx_file.h"
@@ -7,32 +13,91 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-int main(int argc, char *argv[])
+static void
+version(void)
+{
+	printf("Jaguar RISC Disassembler Version %d.%d.%d\n",
+		   JDIS_MAJOR, JDIS_MINOR, JDIS_MICRO);
+}
+
+static void
+usage(void)
+{
+	version();
+	printf("\n");
+	printf("Usage: jdis [-gdhv] <JRISC machine code file>\n");
+	printf("\n");
+	printf("Options:\n");
+	printf("  -g: Parse code as Tom/GPU instructions [default].\n");
+	printf("  -d: Parse code as Jerry/DSP instructions.\n");
+	printf("  -h: Help. Print this text.\n");
+	printf("  -v: Version. Print the version and exit.\n");
+}
+
+int
+main(int argc, char *argv[])
 {
 	FILE *fp;
 	struct JRISC_Context *ctx;
 	struct JRISC_Instruction inst;
 	enum JRISC_Error err;
+	const char *fileName = NULL;
+	enum JRISC_CPU cpu = JRISC_gpu;
+	int i;
+	int j;
+
+	for (i = 1; i < argc; i++) {
+		if (argv[i][0] == '-') {
+			for (j = 1; argv[i][j]; j++) {
+				switch (argv[i][j]) {
+				case 'h':
+					usage();
+					exit(0);
+
+				case 'v':
+					version();
+					exit(0);
+
+				case 'g':
+					cpu = JRISC_gpu;
+					break;
+
+				case 'd':
+					cpu = JRISC_dsp;
+					break;
+
+				default:
+					usage();
+					exit(1);
+				}
+			}
+		} else if (!fileName) {
+			fileName = argv[i];
+		} else {
+			usage();
+			exit(1);
+		}
+	}
 
-	if (argc < 2) {
-		printf("Usage: test <raw JRISC machine code>\n");
+	if (!fileName) {
+		usage();
 		exit(1);
 	}
 
-	fp = fopen(argv[1], "rb");
+	fp = fopen(fileName, "rb");
 
 	if (!fp) {
-		printf("Could not open %s\n", argv[1]);
+		fprintf(stderr, "Could not open %s\n", fileName);
 		exit(1);
 	}
 
 	err = jriscContextFromFile(fp, fp, &ctx);
 	if (err != JRISC_success) {
-		printf("Failed to create context\n");
+		fprintf(stderr, "Failed to create context\n");
 		exit(1);
 	}
 
-	while ((err = jriscInstructionRead(ctx, JRISC_gpu, &inst)) == JRISC_success)
+	while ((err = jriscInstructionRead(ctx, cpu, &inst)) == JRISC_success)
 		jriscInstructionPrint(&inst);
 
 	return 0;

jrisc_base.h

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #ifndef JRISC_BASE_H_
 #define JRISC_BASE_H_
 

jrisc_ctx.c

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #include "jrisc_base.h"
 #include "jrisc_ctx.h"
 

jrisc_ctx.h

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #ifndef JRISC_CTX_H_
 #define JRISC_CTX_H_
 

jrisc_ctx_file.c

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #include "jrisc_base.h"
 #include "jrisc_ctx.h"
 #include "jrisc_ctx_file.h"

jrisc_ctx_file.h

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #ifndef JRISC_CONTEXT_FILE_H_
 #define JRISC_CONTEXT_FILE_H_
 

jrisc_ctx_mem.c

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #include "jrisc_base.h"
 #include "jrisc_ctx.h"
 #include "jrisc_ctx_mem.h"

jrisc_ctx_mem.h

@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ * Author: James Jones
+ */
+
 #ifndef JRISC_CONTEXT_MEM_H_
 #define JRISC_CONTEXT_MEM_H_