updated libopts

libopts/version.c

@@ -1,15 +1,16 @@
 
-/*
- * Time-stamp:      "2012-01-29 19:44:24 bkorb"
+/** \file version.c
  *
  *  This module implements the default usage procedure for
  *  Automated Options.  It may be overridden, of course.
+ *
+ * @addtogroup autoopts
+ * @{
  */
-
 /*
  *  This file is part of AutoOpts, a companion to AutoGen.
  *  AutoOpts is free software.
- *  AutoOpts is Copyright (c) 1992-2012 by Bruce Korb - all rights reserved
+ *  AutoOpts is Copyright (C) 1992-2013 by Bruce Korb - all rights reserved
  *
  *  AutoOpts is available under any one of two licenses.  The license
  *  in use must be one of these two and the choice is under the control
@@ -21,11 +22,11 @@
  *   The Modified Berkeley Software Distribution License
  *      See the file "COPYING.mbsd"
  *
- *  These files have the following md5sums:
+ *  These files have the following sha256 sums:
  *
- *  43b91e8ca915626ed3818ffb1b71248b pkg/libopts/COPYING.gplv3
- *  06a1a2e4760c90ea5e1dad8dfaac4d39 pkg/libopts/COPYING.lgplv3
- *  66a5cedaf62c4b2637025f049f9b826f pkg/libopts/COPYING.mbsd
+ *  8584710e9b04216a394078dc156b781d0b47e1729104d666658aecef8ee32e95  COPYING.gplv3
+ *  4379e7444a0e2ce2b12dd6f5a52a27a4d02d39d247901d3285c88cf0d37f477b  COPYING.lgplv3
+ *  13aa749a5b0a454917a944ed8fffc530b784f5ead522b1aacaf4ec8aa55a6239  COPYING.mbsd
  */
 
 /*=export_func  optionVersion
@@ -40,122 +41,128 @@
 char const*
 optionVersion(void)
 {
-    static char const zVersion[] =
-        STR(AO_CURRENT.AO_REVISION);
+    static char const ver[] = OPTIONS_DOTTED_VERSION;
+    return ver;
+}
 
-    return zVersion;
+static void
+emit_first_line(
+    FILE * fp, char const * alt1, char const * alt2, char const * alt3)
+{
+    char const * p = (alt1 != NULL) ? alt1 : ((alt2 != NULL) ? alt2 : alt3);
+    char const * e;
+    if (p == NULL)
+        return;
+    e = strchr(p, NL);
+    if (e == NULL)
+        fputs(p, fp);
+    else
+        fwrite(p, 1, (e - p), fp);
+    fputc(NL, fp);
 }
 
 /**
  * Select among various ways to emit version information.
  *
- * @param pOpts the option descriptor
- * @param fp    the output stream
+ * @param[in] o   the option descriptor
+ * @param[in] fp  the output stream
  */
 static void
-emit_simple_ver(tOptions * pOpts, FILE * fp)
+emit_simple_ver(tOptions * o, FILE * fp)
 {
-    /*
-     *  Use the supplied string
-     */
-    if (pOpts->pzFullVersion != NULL)
-        fputs(pOpts->pzFullVersion, fp);
-
-    /*
-     *  Extract the interesting part of the copyright string
-     */
-    else if (pOpts->pzCopyright != NULL) {
-        char const * pe = strchr(pOpts->pzCopyright, NL);
-        if (pe == NULL)
-            pe = pOpts->pzCopyright + strlen(pOpts->pzCopyright);
-        fwrite(pOpts->pzCopyright, 1, pe - pOpts->pzCopyright, fp);
-    }
-
-    /*
-     *  Extract the interesting part of the usage title string
-     */
-    else {
-        char const * pe = strchr(pOpts->pzUsageTitle, NL);
-        if (pe == NULL)
-            pe = pOpts->pzUsageTitle + strlen(pOpts->pzUsageTitle);
-        fwrite(pOpts->pzUsageTitle, 1, pe - pOpts->pzUsageTitle, fp);
-    }
-    fputc(NL, fp);
+    emit_first_line(fp, o->pzFullVersion, o->pzCopyright, o->pzUsageTitle);
 }
 
+/**
+ * print the version with a copyright notice.
+ *
+ * @param[in] o   the option descriptor
+ * @param[in] fp  the output stream
+ */
 static void
-emit_copy_ver(tOptions * pOpts, FILE * fp)
+emit_copy_full(tOptions * o, FILE * fp)
 {
-    if (pOpts->pzCopyright != NULL)
-        fputs(pOpts->pzCopyright, fp);
+    if (o->pzCopyright != NULL)
+        fputs(o->pzCopyright, fp);
 
-    else if (pOpts->pzFullVersion != NULL)
-        fputs(pOpts->pzFullVersion, fp);
+    else if (o->pzFullVersion != NULL)
+        fputs(o->pzFullVersion, fp);
 
-    else {
-        char const * pe = strchr(pOpts->pzUsageTitle, NL);
-        if (pe == NULL)
-            pe = pOpts->pzUsageTitle + strlen(pOpts->pzUsageTitle);
-        fwrite(pOpts->pzUsageTitle, 1, pe - pOpts->pzCopyright, fp);
+    else
+        emit_first_line(fp, o->pzUsageTitle, NULL, NULL);
+    
+    if (HAS_pzPkgDataDir(o) && (o->pzPackager != NULL)) {
+        fputc(NL, fp);
+        fputs(o->pzPackager, fp);
+
+    } else if (o->pzBugAddr != NULL) {
+        fputc(NL, fp);
+        fprintf(fp, zPlsSendBugs, o->pzBugAddr);
     }
+}
+
+/**
+ * print the version and any copyright notice.
+ * The version with a full copyright and additional notes.
+ *
+ * @param[in] opts  the option descriptor
+ * @param[in] fp    the output stream
+ */
+static void
+emit_copy_note(tOptions * opts, FILE * fp)
+{
+    if (opts->pzCopyright != NULL)
+        fputs(opts->pzCopyright, fp);
+
+    if (opts->pzCopyNotice != NULL)
+        fputs(opts->pzCopyNotice, fp);
 
     fputc(NL, fp);
+    fprintf(fp, zao_ver_fmt, optionVersion());
+    
+    if (HAS_pzPkgDataDir(opts) && (opts->pzPackager != NULL)) {
+        fputc(NL, fp);
+        fputs(opts->pzPackager, fp);
 
-    if (HAS_pzPkgDataDir(pOpts) && (pOpts->pzPackager != NULL))
-        fputs(pOpts->pzPackager, fp);
-
-    else if (pOpts->pzBugAddr != NULL)
-        fprintf(fp, zPlsSendBugs, pOpts->pzBugAddr);
+    } else if (opts->pzBugAddr != NULL) {
+        fputc(NL, fp);
+        fprintf(fp, zPlsSendBugs, opts->pzBugAddr);
+    }
 }
 
+/**
+ * Handle the version printing.  We must see how much information
+ * is being requested and select the correct printing routine.
+ */
 static void
-emit_copy_note(tOptions * pOpts, FILE * fp)
-{
-    if (pOpts->pzCopyright != NULL) {
-        fputs(pOpts->pzCopyright, fp);
-        fputc(NL, fp);
-    }
-
-    if (pOpts->pzCopyNotice != NULL) {
-        fputs(pOpts->pzCopyNotice, fp);
-        fputc(NL, fp);
-    }
-
-    fprintf(fp, zAO_Ver, optionVersion());
-
-    if (HAS_pzPkgDataDir(pOpts) && (pOpts->pzPackager != NULL))
-        fputs(pOpts->pzPackager, fp);
-
-    else if (pOpts->pzBugAddr != NULL)
-        fprintf(fp, zPlsSendBugs, pOpts->pzBugAddr);
-}
-
-static void
-print_ver(tOptions * pOpts, tOptDesc * pOD, FILE * fp)
+print_ver(tOptions * opts, tOptDesc * od, FILE * fp)
 {
     char ch;
 
+    if (opts <= OPTPROC_EMIT_LIMIT)
+        return;
+
     /*
      *  IF we have an argument for this option, use it
      *  Otherwise, default to version only or copyright note,
      *  depending on whether the layout is GNU standard form or not.
      */
-    if (  (pOD->fOptState & OPTST_ARG_OPTIONAL)
-       && (pOD->optArg.argString != NULL)
-       && (pOD->optArg.argString[0] != NUL))
+    if (  (od->fOptState & OPTST_ARG_OPTIONAL)
+       && (od->optArg.argString != NULL)
+       && (od->optArg.argString[0] != NUL))
 
-        ch = pOD->optArg.argString[0];
+        ch = od->optArg.argString[0];
 
     else {
-        set_usage_flags(pOpts, NULL);
-        ch = (pOpts->fOptSet & OPTPROC_GNUUSAGE) ? 'c' : 'v';
+        set_usage_flags(opts, NULL);
+        ch = (opts->fOptSet & OPTPROC_GNUUSAGE) ? 'c' : 'v';
     }
 
     switch (ch) {
     case NUL: /* arg provided, but empty */
-    case 'v': case 'V': emit_simple_ver(pOpts, fp); break;
-    case 'c': case 'C': emit_copy_ver(pOpts, fp);   break;
-    case 'n': case 'N': emit_copy_note(pOpts, fp);  break;
+    case 'v': case 'V': emit_simple_ver(opts, fp); break;
+    case 'c': case 'C': emit_copy_full( opts, fp); break;
+    case 'n': case 'N': emit_copy_note( opts, fp); break;
 
     default:
         fprintf(stderr, zBadVerArg, ch);
@@ -163,10 +170,10 @@ print_ver(tOptions * pOpts, tOptDesc * pOD, FILE * fp)
     }
 
     fflush(fp);
-    if (ferror(fp) != 0) {
-        fputs(zOutputFail, stderr);
-        exit(EXIT_FAILURE);
-    }
+    if (ferror(fp))
+        fserr_exit(opts->pzProgName, zwriting,
+                   (fp == stdout) ? zstdout_name : zstderr_name);
+
     exit(EXIT_SUCCESS);
 }
 
@@ -174,35 +181,36 @@ print_ver(tOptions * pOpts, tOptDesc * pOD, FILE * fp)
  * private:
  *
  * what:  Print the program version
- * arg:   + tOptions* + pOpts    + program options descriptor +
- * arg:   + tOptDesc* + pOptDesc + the descriptor for this arg +
+ * arg:   + tOptions* + opts + program options descriptor +
+ * arg:   + tOptDesc* + od   + the descriptor for this arg +
  *
  * doc:
  *  This routine will print the version to stdout.
 =*/
 void
-optionPrintVersion(tOptions * pOpts, tOptDesc * pOD)
+optionPrintVersion(tOptions * opts, tOptDesc * od)
 {
-    print_ver(pOpts, pOD, stdout);
+    print_ver(opts, od, stdout);
 }
 
 /*=export_func  optionVersionStderr
  * private:
  *
  * what:  Print the program version to stderr
- * arg:   + tOptions* + pOpts    + program options descriptor +
- * arg:   + tOptDesc* + pOptDesc + the descriptor for this arg +
+ * arg:   + tOptions* + opts + program options descriptor +
+ * arg:   + tOptDesc* + od   + the descriptor for this arg +
  *
  * doc:
  *  This routine will print the version to stderr.
 =*/
 void
-optionVersionStderr(tOptions * pOpts, tOptDesc * pOD)
+optionVersionStderr(tOptions * opts, tOptDesc * od)
 {
-    print_ver(pOpts, pOD, stderr);
+    print_ver(opts, od, stderr);
 }
 
-/*
+/** @}
+ *
  * Local Variables:
  * mode: C
  * c-file-style: "stroustrup"