XXX add basic buildinfo ideas

Add basic buildinfo ideas, quick and dirty and not tested comprehensively:

  * Define build information for libavrdude and the avrdude CLI tool

  * Add a long "--version" argument which shows a long version message.

This buildinfo contains the name and version of the software component,
and then a key-value-list for each buildinfo item.

Author: ndim

CMakeLists.txt

@@ -49,6 +49,7 @@ include(FindPackageMessage)
 include(GNUInstallDirs)
 
 set(CONFIG_DIR "${CMAKE_INSTALL_FULL_SYSCONFDIR}")
+set(AVRDUDE_BUILDSYSTEM "cmake")
 set(AVRDUDE_FULL_VERSION "${CMAKE_PROJECT_VERSION}${EXTRA_VERSION_SUFFIX}")
 
 # =====================================

src/CMakeLists.txt

@@ -179,6 +179,7 @@ set(SOURCES
     avrpart.c
     bitbang.c
     bitbang.h
+    buildinfo.c
     buspirate.c
     buspirate.h
     butterfly.c

src/Makefile.am

@@ -106,6 +106,7 @@ libavrdude_la_SOURCES = \
 	avr_opcodes.c \
 	bitbang.c \
 	bitbang.h \
+	buildinfo.c \
 	buspirate.c \
 	buspirate.h \
 	butterfly.c \

src/buildinfo.c

@@ -0,0 +1,109 @@
+#include <libavrdude.h>
+
+#include <ac_cfg.h>
+
+
+const avr_buildinfo libavrdude_buildinfo = {
+  "libavrdude", AVRDUDE_FULL_VERSION,
+  {
+    {"buildsystem", AVRDUDE_BUILDSYSTEM},
+
+    {"libelf",
+#ifdef HAVE_LIBELF
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libusb",
+#ifdef HAVE_LIBUSB
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libusb_1_0",
+#ifdef HAVE_LIBUSB_1_0
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libhidapi",
+#ifdef HAVE_LIBHIDAPI
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libhid",
+#ifdef HAVE_LIBHID
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libftdi",
+#ifdef HAVE_LIBFTDI
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libftdi1",
+#ifdef HAVE_LIBFTDI1
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libreadline",
+#ifdef HAVE_LIBREADLINE
+     "yes"
+#else
+     NULL
+#endif
+    },
+
+    {"libserialport",
+#ifdef HAVE_LIBSERIALPORT
+    "yes"
+#else
+    NULL
+#endif
+    },
+
+    {"parport",
+#ifdef HAVE_PARPORT
+     "yes"
+#else
+    NULL
+#endif
+    },
+
+    {"linuxgpio",
+#ifdef HAVE_LINUXGPIO
+     "yes"
+#else
+    NULL
+#endif
+    },
+
+    {"linuxspi",
+#ifdef HAVE_LINUXSPI
+     "yes"
+#else
+    NULL
+#endif
+    },
+
+    {NULL, NULL},
+  },
+};

src/cmake_config.h.in

@@ -21,6 +21,7 @@
 #endif
 
 #define AVRDUDE_FULL_VERSION "@AVRDUDE_FULL_VERSION@"
+#define AVRDUDE_BUILDSYSTEM "@AVRDUDE_BUILDSYSTEM@"
 
 /* Options */
 

src/configure.ac

@@ -93,6 +93,9 @@ AC_DEFINE_UNQUOTED([AVRDUDE_FULL_VERSION], ["$AVRDUDE_FULL_VERSION"],
                    [The full avrdude version as displayed in -? and avrdude.conf])
 AC_SUBST([AVRDUDE_FULL_VERSION])
 
+AC_DEFINE_UNQUOTED([AVRDUDE_BUILDSYSTEM], ["autotools"],
+                   [The buildsystem used to build avrdude])
+
 
 # Define libavrdude libtool version from cmake libavrdude information
 dnl

src/libavrdude.h

@@ -1202,6 +1202,21 @@ extern "C" {
   int avr_flush_cache(const PROGRAMMER *pgm, const AVRPART *p);
   int avr_reset_cache(const PROGRAMMER *pgm, const AVRPART *p);
 
+
+typedef struct avr_buildinfo_item {
+  const char *const key;
+  const char *const value;
+} avr_buildinfo_item;
+
+typedef struct avr_buildinfo {
+  const char *const name;
+  const char *const version;
+  avr_buildinfo_item items[];
+} avr_buildinfo;
+
+extern const avr_buildinfo libavrdude_buildinfo;
+
+
 #ifdef __cplusplus
 }
 #endif

src/main.c

@@ -49,6 +49,8 @@
 #include <dirent.h>
 #endif
 
+#include <getopt.h>
+
 #include "avrdude.h"
 #include "libavrdude.h"
 #include "config.h"
@@ -229,6 +231,52 @@ const char *pgmid;              // Programmer -c string
 
 static char usr_config[PATH_MAX];       // Per-user config file
 
+
+static
+const avr_buildinfo avrdude_buildinfo = {
+  "avrdude", AVRDUDE_FULL_VERSION,
+  {
+    {"buildsystem", AVRDUDE_BUILDSYSTEM},
+    {NULL, NULL},
+  }
+};
+
+
+static void print_buildinfo(const avr_buildinfo *const buildinfo)
+{
+  msg_info("  * %s %s\n",
+           buildinfo->name, buildinfo->version);
+
+  for (unsigned int i=0; buildinfo->items[i].key; ++i) {
+    if (buildinfo->items[i].value) {
+      msg_info("    %3u. %s: %s\n",
+               i+1,
+               buildinfo->items[i].key,
+               buildinfo->items[i].value);
+    }
+  }
+}
+
+
+static void print_version_message(void)
+{
+  msg_info("avrdude %s\n", AVRDUDE_FULL_VERSION);
+  msg_info("Copyright (C) ...2024...\n");
+  msg_info("License GPL...\n");
+  msg_info("This is free software...\n");
+
+  const avr_buildinfo *const all_buildinfos[] = {
+    &avrdude_buildinfo,
+    &libavrdude_buildinfo,
+    NULL,
+  };
+
+  for (unsigned int i=0; all_buildinfos[i]; ++i) {
+    print_buildinfo(all_buildinfos[i]);
+  }
+}
+
+
 // Usage message
 static void usage(void) {
   char *home = getenv("HOME");
@@ -273,6 +321,7 @@ static void usage(void) {
     "  -q                        Quell progress output; -q -q for less\n"
     "  -l, --logfile logfile     Use logfile rather than stderr for diagnostics\n"
     "  -?, --help                Display this usage\n"
+    "  --version                 Display build and version information\n"
     "\navrdude version %s, https://github.com/avrdudes/avrdude\n",
     progname, strlen(cfg) < 24? "config file ": "", cfg, AVRDUDE_FULL_VERSION);
 
@@ -817,6 +866,7 @@ int main(int argc, char *argv[]) {
 #endif
 
   // Process command line arguments
+#define LONGOPT_VERSION 0x2342
   struct option longopts[] = {
     {"help",       no_argument,       NULL, '?'},
     {"baud",       required_argument, NULL, 'b'},
@@ -838,6 +888,7 @@ int main(int argc, char *argv[]) {
     {"memory",     required_argument, NULL, 'U'},
     {"verbose",    no_argument,       NULL, 'v'},
     {"noverify",   no_argument,       NULL, 'V'},
+    {"version",    no_argument,       NULL, LONGOPT_VERSION},
     {NULL,         0,                 NULL, 0}
   };
   while((ch = getopt_long(argc, argv,
@@ -988,6 +1039,11 @@ int main(int argc, char *argv[]) {
       exit(0);
       break;
 
+    case LONGOPT_VERSION:
+      print_version_message();
+      exit(0);
+      break;
+
     default:
       pmsg_error("invalid option -%c\n\n", ch);
       usage();