Add a version reporting feature to gsh

Author: starseeker

include/ged.h

@@ -50,6 +50,7 @@
 #include "raytrace.h"
 #include "analyze.h"
 #include "ged/defines.h"
+#include "ged/version.h"
 #include "ged/database.h"
 #include "ged/commands.h"
 #include "ged/objects.h"

include/ged/CMakeLists.txt

@@ -11,6 +11,7 @@ set(
   framebuffer.h
   objects.h
   rt.h
+  version.h
   view.h
 )
 brlcad_manage_files(ged_headers ${INCLUDE_DIR}/brlcad/ged REQUIRED libged)

include/ged/version.h

@@ -0,0 +1,51 @@
+/*                       V E R S I O N . H
+ * BRL-CAD
+ *
+ * Copyright (c) 2004-2025 United States Government as represented by
+ * the U.S. Army Research Laboratory.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this file; see the file named COPYING for more
+ * information.
+ */
+
+/*----------------------------------------------------------------------*/
+/** @addtogroup ged_version
+ * @brief
+ * report version information about LIBGED
+ */
+/** @{ */
+/* @file version.h */
+
+#ifndef GED_VERSION_H
+#define GED_VERSION_H
+
+#include "common.h"
+#include "ged/defines.h"
+
+__BEGIN_DECLS
+
+GED_EXPORT extern const char *ged_version(void);
+
+__END_DECLS
+
+#endif  /* GED_VERSION_H */
+/** @} */
+/*
+ * Local Variables:
+ * mode: C
+ * tab-width: 8
+ * indent-tabs-mode: t
+ * c-file-style: "stroustrup"
+ * End:
+ * ex: shiftwidth=4 tabstop=8
+ */

src/gtools/gsh/gsh.cpp

@@ -35,6 +35,7 @@
 
 #include "linenoise.hpp"
 
+#include "brlcad_ident.h"
 #include "bu.h"
 #include "bv.h"
 
@@ -752,11 +753,14 @@ main(int argc, const char **argv)
 
     /* Options */
     int print_help = 0;
+    int report_versions = 0;
     int new_cmd_forms = 0;
-    struct bu_opt_desc d[3];
-    BU_OPT(d[0],  "h",     "help",  "",  NULL, &print_help,        "print help and exit");
-    BU_OPT(d[1],  "",  "new-cmds",  "",  NULL, &new_cmd_forms,     "use new (qged style) commands");
-    BU_OPT_NULL(d[2]);
+    struct bu_opt_desc d[5];
+    BU_OPT(d[0], "h", "help",      "",  NULL, &print_help,        "print help and exit");
+    BU_OPT(d[1], "?", "",          "",  NULL, &print_help,        "");
+    BU_OPT(d[2], "v", "version",   "",  NULL, &report_versions,   "Report BRL-CAD and library versions, then exit");
+    BU_OPT(d[3], "",  "new-cmds",  "",  NULL, &new_cmd_forms,     "use new (qged style) commands");
+    BU_OPT_NULL(d[4]);
 
     /* Parse options, fail if anything goes wrong */
     struct bu_vls opt_msg = BU_VLS_INIT_ZERO;
@@ -771,9 +775,27 @@ main(int argc, const char **argv)
     if (print_help) {
 	struct bu_vls msg = BU_VLS_INIT_ZERO;
 	const char *help = bu_opt_describe(d, NULL);
-	bu_vls_sprintf(&msg, "Usage: 'gsh [options] model.g'\n\nOptions:\n%s\n", help);
+	bu_vls_sprintf(&msg, "Usage: 'gsh [options] model.g' [args] \n\nOptions:\n%s\n", help);
 	bu_free((char *)help, "done with help string");
-	fputs(bu_vls_addr(&msg), stderr);
+	fputs(bu_vls_cstr(&msg), stderr);
+	bu_vls_free(&msg);
+	bu_exit(EXIT_SUCCESS, NULL);
+    }
+
+    /* If we're just reporting BRL-CAD and lib versions, do that */
+    if (report_versions) {
+	struct bu_vls msg = BU_VLS_INIT_ZERO;
+	bu_vls_sprintf(&msg, "%s%s%s%s%s",
+		brlcad_ident("Geometry Shell (gsh)"),
+		bu_version(),
+		bn_version(),
+		rt_version(),
+		ged_version());
+#ifdef USE_DM
+	bu_vls_printf(&msg, "%s", dm_version());
+#endif
+	bu_vls_printf(&msg, "\n");
+	std::cout << bu_vls_cstr(&msg);
 	bu_vls_free(&msg);
 	bu_exit(EXIT_SUCCESS, NULL);
     }
@@ -874,7 +896,7 @@ main(int argc, const char **argv)
 	}
     }
 
-    return BRLCAD_OK;
+    return EXIT_SUCCESS;
 }
 
 // Local Variables:

src/libged/CMakeLists.txt

@@ -143,6 +143,7 @@ set(
   tab_complete.cpp
   trace.c
   track.c
+  vers.c
   vutil.c
   view/data_lines.c
   wdb_importFg4Section.c

src/libged/vers.c

@@ -0,0 +1,49 @@
+/*                          V E R S . C
+ * BRL-CAD
+ *
+ * Copyright (c) 2007-2025 United States Government as represented by
+ * the U.S. Army Research Laboratory.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this file; see the file named COPYING for more
+ * information.
+ */
+/** @file libged/vers.c
+ *
+ * version information about LIBGED
+ *
+ */
+
+#include "common.h"
+
+#include "ged/version.h"
+#include "brlcad_ident.h"
+
+
+/**
+ * returns the compile-time version of libged
+ */
+const char *
+ged_version(void)
+{
+    return brlcad_ident("The BRL-CAD Geometry Editing Library (libged)");
+}
+
+/*
+ * Local Variables:
+ * tab-width: 8
+ * mode: C
+ * indent-tabs-mode: t
+ * c-file-style: "stroustrup"
+ * End:
+ * ex: shiftwidth=4 tabstop=8
+ */