ref: 3dec5698dbfc2ccab17df905c603bfc889e72c40
parent: f8bbe9be48a5b485c79c16bc260ddb86c04b711a
parent: 086f02c1d99ce512f3694360d949bc13e1e32361
author: Antonio Niño Díaz <[email protected]>
date: Sat Jul 22 10:10:10 EDT 2017
Merge pull request #188 from version-string Add command to print version string Signed-off-by: Antonio Niño Díaz <[email protected]>
--- a/Makefile
+++ b/Makefile
@@ -15,6 +15,8 @@
PNGLDFLAGS := `${PKG_CONFIG} --static --libs-only-L libpng`
PNGLDLIBS := `${PKG_CONFIG} --static --libs-only-l libpng`
+VERSION_STRING := `git describe --tags --dirty --always 2>/dev/null`
+
WARNFLAGS := -Wall -Werror
# Overridable CFLAGS
@@ -21,7 +23,7 @@
CFLAGS := -g
# Non-overridable CFLAGS
REALCFLAGS := ${CFLAGS} ${WARNFLAGS} -std=c99 -D_POSIX_C_SOURCE=200809L \
- -Iinclude
+ -Iinclude -DBUILD_VERSION_STRING=\"${VERSION_STRING}\"
YFLAGS :=
LFLAGS := --nounistd
@@ -49,8 +51,10 @@
src/extern/err.o \
src/extern/reallocarray.o \
src/extern/strlcpy.o \
- src/extern/strlcat.o
+ src/extern/strlcat.o \
+ src/extern/version.o
+
src/asm/asmy.h: src/asm/asmy.c
src/asm/locallex.o src/asm/globlex.o src/asm/lexer.o: src/asm/asmy.h
@@ -66,7 +70,8 @@
src/link/parser.o \
src/link/script.o \
src/link/symbol.o \
- src/extern/err.o
+ src/extern/err.o \
+ src/extern/version.o
src/link/parser.h: src/link/parser.c
src/link/lexer.o: src/link/parser.h
@@ -73,13 +78,15 @@
rgbfix_obj := \
src/fix/main.o \
- src/extern/err.o
+ src/extern/err.o \
+ src/extern/version.o
rgbgfx_obj := \
src/gfx/gb.o \
src/gfx/main.o \
src/gfx/makepng.o \
- src/extern/err.o
+ src/extern/err.o \
+ src/extern/version.o
rgbasm: ${rgbasm_obj}
$Q${CC} ${REALCFLAGS} -o $@ ${rgbasm_obj} -lm
--- /dev/null
+++ b/include/extern/version.h
@@ -1,0 +1,21 @@
+/*
+ * Copyright (C) 2017 Antonio Nino Diaz <[email protected]>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#define PACKAGE_VERSION_MAJOR (0)
+#define PACKAGE_VERSION_MINOR (3)
+#define PACKAGE_VERSION_PATCH (2)
+
+const char * get_package_version_string(void);
--- a/src/asm/main.c
+++ b/src/asm/main.c
@@ -12,6 +12,7 @@
#include "asm/main.h"
#include "extern/err.h"
#include "extern/reallocarray.h"
+#include "extern/version.h"
int yyparse(void);
void setuplex(void);
@@ -278,7 +279,7 @@
usage(void)
{
printf(
-"Usage: rgbasm [-hvE] [-b chars] [-Dname[=value]] [-g chars] [-i path]\n"
+"Usage: rgbasm [-EhVvw] [-b chars] [-Dname[=value]] [-g chars] [-i path]\n"
" [-M dependfile] [-o outfile] [-p pad_value] file.asm\n");
exit(1);
}
@@ -324,7 +325,7 @@
newopt = CurrentOptions;
- while ((ch = getopt(argc, argv, "b:D:g:hi:M:o:p:vEw")) != -1) {
+ while ((ch = getopt(argc, argv, "b:D:g:hi:M:o:p:EVvw")) != -1) {
switch (ch) {
case 'b':
if (strlen(optarg) == 2) {
@@ -338,6 +339,9 @@
case 'D':
opt_AddDefine(optarg);
break;
+ case 'E':
+ newopt.exportall = true;
+ break;
case 'g':
if (strlen(optarg) == 4) {
newopt.gbgfx[0] = optarg[1];
@@ -373,17 +377,18 @@
"between 0 and 0xFF");
}
break;
+ case 'V':
+ printf("rgbasm %s\n", get_package_version_string());
+ exit(0);
case 'v':
newopt.verbose = true;
break;
- case 'E':
- newopt.exportall = true;
- break;
case 'w':
newopt.warnings = false;
break;
default:
usage();
+ /* NOTREACHED */
}
}
argc -= optind;
--- a/src/asm/rgbasm.1
+++ b/src/asm/rgbasm.1
@@ -20,7 +20,7 @@
.Nd Game Boy assembler
.Sh SYNOPSIS
.Nm rgbasm
-.Op Fl Ehvw
+.Op Fl EhVvw
.Op Fl b Ar chars
.Op Fl D Ar name Ns Op = Ns Ar value
.Op Fl g Ar chars
@@ -72,6 +72,8 @@
.It Fl p Ar pad_value
When padding an image, pad with this value.
The default is 0x00.
+.It Fl V
+Print the version of the program and exit.
.It Fl v
Be verbose.
.It Fl w
--- a/src/asm/rgbasm.5
+++ b/src/asm/rgbasm.5
@@ -549,6 +549,9 @@
.It Ic EQU Ta Ic __UTC_HOUR__ Ta Ta Current hour, 0-23
.It Ic EQU Ta Ic __UTC_MINUTE__ Ta Ta Current minute, 0-59
.It Ic EQU Ta Ic __UTC_SECOND__ Ta Ta Current second, 0-59
+.It Ic EQU Ta Ic __RGBDS_MAJOR__ Ta Ta Major version number of RGBDS.
+.It Ic EQU Ta Ic __RGBDS_MINOR__ Ta Ta Minor version number of RGBDS.
+.It Ic EQU Ta Ic __RGBDS_PATCH__ Ta Ta Patch version number of RGBDS.
.El
.Pp
.Sh DEFINING DATA
@@ -1012,6 +1015,15 @@
.It Sx __ISO_8601_UTC__
.It Sx __LINE__
.It Sx __TIME__
+.It Sx __RGBDS_MAJOR__
+.It Sx __RGBDS_MINOR__
+.It Sx __RGBDS_PATCH__
+.It Sx __UTC_YEAR__
+.It Sx __UTC_MONTH__
+.It Sx __UTC_DAY__
+.It Sx __UTC_HOUR__
+.It Sx __UTC_MINUTE__
+.It Sx __UTC_SECOND__
.It Sx _NARG
.It Sx _PI
.It Sx _RS
--- a/src/asm/symbol.c
+++ b/src/asm/symbol.c
@@ -13,6 +13,7 @@
#include "asm/mymath.h"
#include "asm/output.h"
#include "extern/err.h"
+#include "extern/version.h"
struct sSymbol *tHashedSymbols[HASHSIZE];
struct sSymbol *pScope = NULL;
@@ -848,6 +849,9 @@
sym_AddString("__UTC_HOUR__", SavedHOUR);
sym_AddString("__UTC_MINUTE__", SavedMINUTE);
sym_AddString("__UTC_SECOND__", SavedSECOND);
+ sym_AddEqu("__RGBDS_MAJOR__", PACKAGE_VERSION_MAJOR);
+ sym_AddEqu("__RGBDS_MINOR__", PACKAGE_VERSION_MINOR);
+ sym_AddEqu("__RGBDS_PATCH__", PACKAGE_VERSION_PATCH);
sym_AddSet("_RS", 0);
sym_AddEqu("_NARG", 0);
--- /dev/null
+++ b/src/extern/version.c
@@ -1,0 +1,34 @@
+/*
+ * Copyright (C) 2017 Antonio Nino Diaz <[email protected]>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <stdio.h>
+#include <string.h>
+
+#include "extern/version.h"
+
+const char * get_package_version_string(void)
+{
+ static char s[50];
+
+ /* The following conditional should be simplified by the compiler. */
+ if (strlen(BUILD_VERSION_STRING) == 0) {
+ snprintf(s, sizeof(s), "v%d.%d.%d", PACKAGE_VERSION_MAJOR,
+ PACKAGE_VERSION_MINOR, PACKAGE_VERSION_PATCH);
+ return s;
+ } else {
+ return BUILD_VERSION_STRING;
+ }
+}
--- a/src/fix/main.c
+++ b/src/fix/main.c
@@ -22,12 +22,13 @@
#include <unistd.h>
#include "extern/err.h"
+#include "extern/version.h"
static void
usage(void)
{
printf(
-"usage: rgbfix [-Ccjsv] [-i game_id] [-k licensee_str] [-l licensee_id]\n"
+"usage: rgbfix [-CcjsVv] [-i game_id] [-k licensee_str] [-l licensee_id]\n"
" [-m mbc_type] [-n rom_version] [-p pad_value] [-r ram_size]\n"
" [-t title_str] file\n");
exit(1);
@@ -69,7 +70,7 @@
int version; /* mask ROM version number */
int padvalue; /* to pad the rom with if it changes size */
- while ((ch = getopt(argc, argv, "Cci:jk:l:m:n:p:sr:t:v")) != -1) {
+ while ((ch = getopt(argc, argv, "Cci:jk:l:m:n:p:sr:t:Vv")) != -1) {
switch (ch) {
case 'C':
coloronly = true;
@@ -177,6 +178,9 @@
title = optarg;
break;
+ case 'V':
+ printf("rgbfix %s\n", get_package_version_string());
+ exit(0);
case 'v':
validate = true;
break;
--- a/src/fix/rgbfix.1
+++ b/src/fix/rgbfix.1
@@ -20,7 +20,7 @@
.Nd Game Boy checksum fixer
.Sh SYNOPSIS
.Nm rgbfix
-.Op Fl Ccjsv
+.Op Fl CcjsVv
.Op Fl i Ar game_id
.Op Fl k Ar licensee_str
.Op Fl l Ar licensee_id
@@ -108,6 +108,8 @@
.Pc .
If both this and the game ID are set, the game ID will overwrite the
overlapping portion of the title.
+.It Fl V
+Print the version of the program and exit.
.It Fl v
Validate the header and fix checksums: the Nintendo character area
.Pq Ad 0x104 Ns \(en Ns Ad 0x133 ,
--- a/src/gfx/main.c
+++ b/src/gfx/main.c
@@ -14,9 +14,11 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#include <getopt.h>
#include <stdlib.h>
#include <string.h>
+#include <unistd.h>
+
+#include "extern/version.h"
#include "gfx/main.h"
static void
@@ -23,8 +25,8 @@
usage(void)
{
printf(
-"usage: rgbgfx [-DFfhPTuv] [-d #] [-o outfile] [-p palfile] [-t mapfile]\n"
-"[-x #] infile\n");
+"usage: rgbgfx [-DFfhPTuVv] [-d #] [-o outfile] [-p palfile] [-t mapfile]\n"
+" [-x #] infile\n");
exit(1);
}
@@ -49,13 +51,13 @@
depth = 2;
- while((ch = getopt(argc, argv, "DvFfd:hx:Tt:uPp:o:")) != -1) {
+ while((ch = getopt(argc, argv, "Dd:Ffho:Tt:uPp:Vvx:")) != -1) {
switch(ch) {
case 'D':
opts.debug = true;
break;
- case 'v':
- opts.verbose = true;
+ case 'd':
+ depth = strtoul(optarg, NULL, 0);
break;
case 'F':
opts.hardfix = true;
@@ -62,15 +64,18 @@
case 'f':
opts.fix = true;
break;
- case 'd':
- depth = strtoul(optarg, NULL, 0);
- break;
case 'h':
opts.horizontal = true;
break;
- case 'x':
- opts.trim = strtoul(optarg, NULL, 0);
+ case 'o':
+ opts.outfile = optarg;
break;
+ case 'P':
+ opts.palout = true;
+ break;
+ case 'p':
+ opts.palfile = optarg;
+ break;
case 'T':
opts.mapout = true;
break;
@@ -80,17 +85,18 @@
case 'u':
opts.unique = true;
break;
- case 'P':
- opts.palout = true;
+ case 'V':
+ printf("rgbgfx %s\n", get_package_version_string());
+ exit(0);
+ case 'v':
+ opts.verbose = true;
break;
- case 'p':
- opts.palfile = optarg;
+ case 'x':
+ opts.trim = strtoul(optarg, NULL, 0);
break;
- case 'o':
- opts.outfile = optarg;
- break;
default:
usage();
+ /* NOTREACHED */
}
}
argc -= optind;
--- a/src/gfx/rgbgfx.1
+++ b/src/gfx/rgbgfx.1
@@ -20,7 +20,7 @@
.Nd Game Boy graphics converter
.Sh SYNOPSIS
.Nm rgbgfx
-.Op Fl DfFhPTv
+.Op Fl DfFhPTVv
.Op Fl o Ar outfile
.Op Fl d Ar depth
.Op Fl p Ar palfile
@@ -70,6 +70,8 @@
.Pa .tilemap .
.It Fl u
Truncate repeated tiles. Useful with tilemaps.
+.It Fl V
+Print the version of the program and exit.
.It Fl v
Verbose.
Print errors when the command line parameters and the parameters in
--- a/src/link/main.c
+++ b/src/link/main.c
@@ -4,6 +4,7 @@
#include <unistd.h>
#include "extern/err.h"
+#include "extern/version.h"
#include "link/object.h"
#include "link/output.h"
#include "link/assign.h"
@@ -33,7 +34,7 @@
usage(void)
{
printf(
-"usage: rgblink [-twd] [-l linkerscript] [-m mapfile] [-n symfile] [-O overlay]\n"
+"usage: rgblink [-dtVw] [-l linkerscript] [-m mapfile] [-n symfile] [-O overlay]\n"
" [-o outfile] [-p pad_value] [-s symbol] file [...]\n");
exit(1);
}
@@ -52,7 +53,7 @@
if (argc == 1)
usage();
- while ((ch = getopt(argc, argv, "l:m:n:o:O:p:s:twd")) != -1) {
+ while ((ch = getopt(argc, argv, "dl:m:n:O:o:p:s:tVw")) != -1) {
switch (ch) {
case 'l':
SetLinkerscriptName(optarg);
@@ -98,7 +99,7 @@
* This option implies OPT_CONTWRAM.
*/
options |= OPT_DMG_MODE;
- /* fallthrough */
+ /* FALLTHROUGH */
case 'w':
/* Set to set WRAM as a single continuous block as on
* DMG. All WRAM sections must be WRAM0 as bankable WRAM
@@ -106,6 +107,9 @@
* will raise an error. */
options |= OPT_CONTWRAM;
break;
+ case 'V':
+ printf("rgblink %s\n", get_package_version_string());
+ exit(0);
default:
usage();
/* NOTREACHED */
--- a/src/link/rgblink.1
+++ b/src/link/rgblink.1
@@ -20,9 +20,7 @@
.Nd Game Boy linker
.Sh SYNOPSIS
.Nm rgblink
-.Op Fl t
-.Op Fl w
-.Op Fl d
+.Op Fl dtVw
.Op Fl m Ar mapfile
.Op Fl n Ar symfile
.Op Fl O Ar overlayfile
@@ -95,6 +93,8 @@
See
.Xr rgblink 5
for more information about its format.
+.It Fl V
+Print the version of the program and exit.
.El
.Sh EXAMPLES
All you need for a basic ROM is an object file, which can be made into a ROM