src/libopts/version.c

   1
   2 /*
   3  * Time-stamp:      "2012-01-29 19:44:24 bkorb"
   4  *
   5  *  This module implements the default usage procedure for
   6  *  Automated Options.  It may be overridden, of course.
   7  */
   8
   9 /*
  10  *  This file is part of AutoOpts, a companion to AutoGen.
  11  *  AutoOpts is free software.
  12  *  AutoOpts is Copyright (c) 1992-2012 by Bruce Korb - all rights reserved
  13  *
  14  *  AutoOpts is available under any one of two licenses.  The license
  15  *  in use must be one of these two and the choice is under the control
  16  *  of the user of the license.
  17  *
  18  *   The GNU Lesser General Public License, version 3 or later
  19  *      See the files "COPYING.lgplv3" and "COPYING.gplv3"
  20  *
  21  *   The Modified Berkeley Software Distribution License
  22  *      See the file "COPYING.mbsd"
  23  *
  24  *  These files have the following md5sums:
  25  *
  26  *  43b91e8ca915626ed3818ffb1b71248b pkg/libopts/COPYING.gplv3
  27  *  06a1a2e4760c90ea5e1dad8dfaac4d39 pkg/libopts/COPYING.lgplv3
  28  *  66a5cedaf62c4b2637025f049f9b826f pkg/libopts/COPYING.mbsd
  29  */
  30
  31 /*=export_func  optionVersion
  32  *
  33  * what:     return the compiled AutoOpts version number
  34  * ret_type: char const*
  35  * ret_desc: the version string in constant memory
  36  * doc:
  37  *  Returns the full version string compiled into the library.
  38  *  The returned string cannot be modified.
  39 =*/
  40 char const*
  41 optionVersion(void)
  42 {
  43     static char const zVersion[] =
  44         STR(AO_CURRENT.AO_REVISION);
  45
  46     return zVersion;
  47 }
  48
  49 /**
  50  * Select among various ways to emit version information.
  51  *
  52  * @param pOpts the option descriptor
  53  * @param fp    the output stream
  54  */
  55 static void
  56 emit_simple_ver(tOptions * pOpts, FILE * fp)
  57 {
  58     /*
  59      *  Use the supplied string
  60      */
  61     if (pOpts->pzFullVersion != NULL)
  62         fputs(pOpts->pzFullVersion, fp);
  63
  64     /*
  65      *  Extract the interesting part of the copyright string
  66      */
  67     else if (pOpts->pzCopyright != NULL) {
  68         char const * pe = strchr(pOpts->pzCopyright, NL);
  69         if (pe == NULL)
  70             pe = pOpts->pzCopyright + strlen(pOpts->pzCopyright);
  71         fwrite(pOpts->pzCopyright, 1, pe - pOpts->pzCopyright, fp);
  72     }
  73
  74     /*
  75      *  Extract the interesting part of the usage title string
  76      */
  77     else {
  78         char const * pe = strchr(pOpts->pzUsageTitle, NL);
  79         if (pe == NULL)
  80             pe = pOpts->pzUsageTitle + strlen(pOpts->pzUsageTitle);
  81         fwrite(pOpts->pzUsageTitle, 1, pe - pOpts->pzUsageTitle, fp);
  82     }
  83     fputc(NL, fp);
  84 }
  85
  86 static void
  87 emit_copy_ver(tOptions * pOpts, FILE * fp)
  88 {
  89     if (pOpts->pzCopyright != NULL)
  90         fputs(pOpts->pzCopyright, fp);
  91
  92     else if (pOpts->pzFullVersion != NULL)
  93         fputs(pOpts->pzFullVersion, fp);
  94
  95     else {
  96         char const * pe = strchr(pOpts->pzUsageTitle, NL);
  97         if (pe == NULL)
  98             pe = pOpts->pzUsageTitle + strlen(pOpts->pzUsageTitle);
  99         fwrite(pOpts->pzUsageTitle, 1, pe - pOpts->pzCopyright, fp);
 100     }
 101
 102     fputc(NL, fp);
 103
 104     if (HAS_pzPkgDataDir(pOpts) && (pOpts->pzPackager != NULL))
 105         fputs(pOpts->pzPackager, fp);
 106
 107     else if (pOpts->pzBugAddr != NULL)
 108         fprintf(fp, zPlsSendBugs, pOpts->pzBugAddr);
 109 }
 110
 111 static void
 112 emit_copy_note(tOptions * pOpts, FILE * fp)
 113 {
 114     if (pOpts->pzCopyright != NULL) {
 115         fputs(pOpts->pzCopyright, fp);
 116         fputc(NL, fp);
 117     }
 118
 119     if (pOpts->pzCopyNotice != NULL) {
 120         fputs(pOpts->pzCopyNotice, fp);
 121         fputc(NL, fp);
 122     }
 123
 124     fprintf(fp, zAO_Ver, optionVersion());
 125
 126     if (HAS_pzPkgDataDir(pOpts) && (pOpts->pzPackager != NULL))
 127         fputs(pOpts->pzPackager, fp);
 128
 129     else if (pOpts->pzBugAddr != NULL)
 130         fprintf(fp, zPlsSendBugs, pOpts->pzBugAddr);
 131 }
 132
 133 static void
 134 print_ver(tOptions * pOpts, tOptDesc * pOD, FILE * fp)
 135 {
 136     char ch;
 137
 138     /*
 139      *  IF we have an argument for this option, use it
 140      *  Otherwise, default to version only or copyright note,
 141      *  depending on whether the layout is GNU standard form or not.
 142      */
 143     if (  (pOD->fOptState & OPTST_ARG_OPTIONAL)
 144        && (pOD->optArg.argString != NULL)
 145        && (pOD->optArg.argString[0] != NUL))
 146
 147         ch = pOD->optArg.argString[0];
 148
 149     else {
 150         set_usage_flags(pOpts, NULL);
 151         ch = (pOpts->fOptSet & OPTPROC_GNUUSAGE) ? 'c' : 'v';
 152     }
 153
 154     switch (ch) {
 155     case NUL: /* arg provided, but empty */
 156     case 'v': case 'V': emit_simple_ver(pOpts, fp); break;
 157     case 'c': case 'C': emit_copy_ver(pOpts, fp);   break;
 158     case 'n': case 'N': emit_copy_note(pOpts, fp);  break;
 159
 160     default:
 161         fprintf(stderr, zBadVerArg, ch);
 162         exit(EXIT_FAILURE);
 163     }
 164
 165     fflush(fp);
 166     if (ferror(fp) != 0) {
 167         fputs(zOutputFail, stderr);
 168         exit(EXIT_FAILURE);
 169     }
 170     exit(EXIT_SUCCESS);
 171 }
 172
 173 /*=export_func  optionPrintVersion
 174  * private:
 175  *
 176  * what:  Print the program version
 177  * arg:   + tOptions* + pOpts    + program options descriptor +
 178  * arg:   + tOptDesc* + pOptDesc + the descriptor for this arg +
 179  *
 180  * doc:
 181  *  This routine will print the version to stdout.
 182 =*/
 183 void
 184 optionPrintVersion(tOptions * pOpts, tOptDesc * pOD)
 185 {
 186     print_ver(pOpts, pOD, stdout);
 187 }
 188
 189 /*=export_func  optionVersionStderr
 190  * private:
 191  *
 192  * what:  Print the program version to stderr
 193  * arg:   + tOptions* + pOpts    + program options descriptor +
 194  * arg:   + tOptDesc* + pOptDesc + the descriptor for this arg +
 195  *
 196  * doc:
 197  *  This routine will print the version to stderr.
 198 =*/
 199 void
 200 optionVersionStderr(tOptions * pOpts, tOptDesc * pOD)
 201 {
 202     print_ver(pOpts, pOD, stderr);
 203 }
 204
 205 /*
 206  * Local Variables:
 207  * mode: C
 208  * c-file-style: "stroustrup"
 209  * indent-tabs-mode: nil
 210  * End:
 211  * end of autoopts/version.c */