Provide additional interfaces and documentation for version-etc module.

* lib/version-etc.c (version_etc_arn, version_etc_ar): New
interfaces.
* lib/version-etc.h (version_etc_arn, version_etc_ar): New
prototypes.

diff --git a/ChangeLog b/ChangeLog
index 8aa5ac0212e99d82e7cb008def5ab14e1a35c91b..740548255c9a7e7174d3c3693b5b72c46233ec5d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2009-06-25  Sergey Poznyakoff  <gray@gnu.org.ua>
+
+       Provide additional interfaces and documentation for version-etc
+       module.
+
+       * lib/version-etc.c (version_etc_arn, version_etc_ar): New
+       interfaces.
+       * lib/version-etc.h (version_etc_arn, version_etc_ar): New
+       prototypes.
+
 2009-06-24  Bruno Haible  <bruno@clisp.org>
 
        * m4/lib-link.m4 (AC_LIB_HAVE_LINKFLAGS): Fix description of

diff --git a/lib/version-etc.c b/lib/version-etc.c
index c3b028926b8cd76130016bc8e217f509926e8c71..ddac30542fd3cda6f661828ed94e786014fbadfe 100644 (file)
--- a/lib/version-etc.c
+++ b/lib/version-etc.c
@@ -34,26 +34,30 @@
 
 enum { COPYRIGHT_YEAR = 2009 };
 
-/* Like version_etc, below, but with the NULL-terminated author list
-   provided via a variable of type va_list.  */
-void
-version_etc_va (FILE *stream,
-               const char *command_name, const char *package,
-               const char *version, va_list authors)
-{
-  size_t n_authors;
+/* The three functions below display the --version information the
+   standard way.
+
+   If COMMAND_NAME is NULL, the PACKAGE is asumed to be the name of
+   the program.  The formats are therefore:
 
-  /* Count the number of authors.  */
-  {
-    va_list tmp_authors;
+   PACKAGE VERSION
 
-    va_copy (tmp_authors, authors);
+   or
 
-    n_authors = 0;
-    while (va_arg (tmp_authors, const char *) != NULL)
-      ++n_authors;
-  }
+   COMMAND_NAME (PACKAGE) VERSION.
 
+   The functions differ in the way they are passed author names. */
+
+/* Display the --version information the standard way.
+
+   Author names are given in the array AUTHORS. N_AUTHORS is the
+   number of elements in the array. */
+void
+version_etc_arn (FILE *stream,
+                const char *command_name, const char *package,
+                const char *version,
+                const char * const * authors, size_t n_authors)
+{
   if (command_name)
     fprintf (stream, "%s (%s) %s\n", command_name, package, version);
   else
@@ -89,57 +93,64 @@ There is NO WARRANTY, to the extent permitted by law.\n\
       abort ();
     case 1:
       /* TRANSLATORS: %s denotes an author name.  */
-      vfprintf (stream, _("Written by %s.\n"), authors);
+      fprintf (stream, _("Written by %s.\n"), authors[0]);
       break;
     case 2:
       /* TRANSLATORS: Each %s denotes an author name.  */
-      vfprintf (stream, _("Written by %s and %s.\n"), authors);
+      fprintf (stream, _("Written by %s and %s.\n"), authors[0], authors[1]);
       break;
     case 3:
       /* TRANSLATORS: Each %s denotes an author name.  */
-      vfprintf (stream, _("Written by %s, %s, and %s.\n"), authors);
+      fprintf (stream, _("Written by %s, %s, and %s.\n"),
+              authors[0], authors[1], authors[2]);
       break;
     case 4:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("Written by %s, %s, %s,\nand %s.\n"), authors);
+      fprintf (stream, _("Written by %s, %s, %s,\nand %s.\n"),
+              authors[0], authors[1], authors[2], authors[3]);
       break;
     case 5:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("Written by %s, %s, %s,\n%s, and %s.\n"), authors);
+      fprintf (stream, _("Written by %s, %s, %s,\n%s, and %s.\n"),
+              authors[0], authors[1], authors[2], authors[3], authors[4]);
       break;
     case 6:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("Written by %s, %s, %s,\n%s, %s, and %s.\n"),
-               authors);
+      fprintf (stream, _("Written by %s, %s, %s,\n%s, %s, and %s.\n"),
+              authors[0], authors[1], authors[2], authors[3], authors[4],
+              authors[5]);
       break;
     case 7:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("Written by %s, %s, %s,\n%s, %s, %s, and %s.\n"),
-               authors);
+      fprintf (stream, _("Written by %s, %s, %s,\n%s, %s, %s, and %s.\n"),
+              authors[0], authors[1], authors[2], authors[3], authors[4],
+              authors[5], authors[6]);
       break;
     case 8:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("\
+      fprintf (stream, _("\
 Written by %s, %s, %s,\n%s, %s, %s, %s,\nand %s.\n"),
-               authors);
+               authors[0], authors[1], authors[2], authors[3], authors[4],
+               authors[5], authors[6], authors[7]);
       break;
     case 9:
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("\
+      fprintf (stream, _("\
 Written by %s, %s, %s,\n%s, %s, %s, %s,\n%s, and %s.\n"),
-               authors);
+              authors[0], authors[1], authors[2], authors[3], authors[4],
+              authors[5], authors[6], authors[7], authors[8]);
       break;
     default:
       /* 10 or more authors.  Use an abbreviation, since the human reader
@@ -147,12 +158,49 @@ Written by %s, %s, %s,\n%s, %s, %s, %s,\n%s, and %s.\n"),
       /* TRANSLATORS: Each %s denotes an author name.
         You can use line breaks, estimating that each author name occupies
         ca. 16 screen columns and that a screen line has ca. 80 columns.  */
-      vfprintf (stream, _("\
+      fprintf (stream, _("\
 Written by %s, %s, %s,\n%s, %s, %s, %s,\n%s, %s, and others.\n"),
-               authors);
+               authors[0], authors[1], authors[2], authors[3], authors[4],
+               authors[5], authors[6], authors[7], authors[8], authors[9]);
       break;
     }
-  va_end (authors);
+}
+
+/* Display the --version information the standard way.  See the initial
+   comment to this module, for more information.
+
+   Author names are given in the NULL-terminated array AUTHORS. */
+void
+version_etc_ar (FILE *stream,
+               const char *command_name, const char *package,
+               const char *version, const char * const * authors)
+{
+  size_t n_authors;
+
+  for (n_authors = 0; authors[n_authors]; n_authors++)
+    ;
+  version_etc_arn (stream, command_name, package, version, authors, n_authors);
+}
+
+/* Display the --version information the standard way.  See the initial
+   comment to this module, for more information.
+
+   Author names are given in the NULL-terminated va_list AUTHORS. */
+void
+version_etc_va (FILE *stream,
+               const char *command_name, const char *package,
+               const char *version, va_list authors)
+{
+  size_t n_authors;
+  const char *authtab[10];
+
+  for (n_authors = 0;
+       n_authors < 10
+        && (authtab[n_authors++] = va_arg (authors, const char *)) != NULL;
+       n_authors++)
+    ;
+  version_etc_arn (stream, command_name, package, version,
+                  authtab, n_authors);
 }
 
 
@@ -167,7 +215,7 @@ Written by %s, %s, %s,\n%s, %s, %s, %s,\n%s, %s, and others.\n"),
 
    COMMAND_NAME (PACKAGE) VERSION.
 
-   The author names are passed as separate arguments, with an additional
+   The authors names are passed as separate arguments, with an additional
    NULL argument at the end.  */
 void
 version_etc (FILE *stream,
@@ -178,6 +226,7 @@ version_etc (FILE *stream,
 
   va_start (authors, version);
   version_etc_va (stream, command_name, package, version, authors);
+  va_end (authors);
 }
 
 void
@@ -195,5 +244,5 @@ emit_bug_reporting_address (void)
   printf (_("%s home page: <http://www.gnu.org/software/%s/>.\n"),
          PACKAGE_NAME, PACKAGE);
   fputs (_("General help using GNU software: <http://www.gnu.org/gethelp/>.\n"),
-         stdout);
+        stdout);
 }

diff --git a/lib/version-etc.h b/lib/version-etc.h
index 33a8e7f14352b4eabc54d66a407458c4c0806b58..078601c409cd80f8da3887f4d715d5fbee501569 100644 (file)
--- a/lib/version-etc.h
+++ b/lib/version-etc.h
@@ -24,15 +24,45 @@
 
 extern const char version_etc_copyright[];
 
+/* The three functions below display the --version information in the
+   standard way: command and package names, package version, followed
+   by a short GPLv3+ notice and a list of up to 10 author names.
+
+   If COMMAND_NAME is NULL, the PACKAGE is asumed to be the name of
+   the program.  The formats are therefore:
+
+   PACKAGE VERSION
+
+   or
+
+   COMMAND_NAME (PACKAGE) VERSION.
+
+   The functions differ in the way they are passed author names: */
+
+/* N_AUTHORS names are supplied in array AUTHORS */
+extern void version_etc_arn (FILE *stream,
+                            const char *command_name, const char *package,
+                            const char *version,
+                            const char * const * authors, size_t n_authors);
+
+/* Names are passed in the NULL-terminated array AUTHORS */
+extern void version_etc_ar (FILE *stream,
+                           const char *command_name, const char *package,
+                           const char *version, const char * const * authors);
+
+/* Names are passed in the NULL-terminated va_list */
 extern void version_etc_va (FILE *stream,
                            const char *command_name, const char *package,
                            const char *version, va_list authors);
 
+/* Names are passed as separate arguments, with an additional
+   NULL argument at the end. */
 extern void version_etc (FILE *stream,
                         const char *command_name, const char *package,
                         const char *version,
                         /* const char *author1, ...*/ ...);
 
+/* Display the usual `Report bugs to' stanza */
 extern void emit_bug_reporting_address (void);
 
 #endif /* VERSION_ETC_H */