source: git/src/cmdline.c @ ff0f549

stereo-2025
Last change on this file since ff0f549 was ce668fb, checked in by Olly Betts <olly@…>, 4 months ago

Use putchar_unlocked() where available

  • Property mode set to 100644
File size: 7.2 KB
Line 
1/* cmdline.c
2 * Wrapper for GNU getopt which deals with standard options
3 * Copyright (C) 1998-2001,2003,2004,2011,2012,2014,2024 Olly Betts
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18 */
19
20#include <config.h>
21
22#include <ctype.h>
23#include <errno.h>
24#include <float.h>
25#include <stdio.h>
26#include <string.h>
27#include <limits.h>
28
29#include "getopt.h"
30
31#include "cmdline.h"
32#include "debug.h"
33#include "filename.h"
34
35#include "message.h"
36
37/* It might be useful to be able to disable all long options on small
38 * platforms like older PDAs.
39 */
40#if 0
41# define getopt_long(ARGC, ARGV, STR, OPTS, PTR) getopt(ARGC, ARGV, STR)
42#endif
43
44/*
45 * bad command line give:
46 * <problem>
47 *
48 * <short syntax>
49 *
50 * --help gives:
51 * <version>
52 *
53 * <short syntax>
54 *
55 * <table>
56 *
57 * <blurb>
58 *
59 * --version gives:
60 * <version>
61 */
62
63/*
64 * want to cope with optional/required parameters on long options
65 * and also parameters on short options
66 */
67
68static const char newline_tabs[] = "\n\t\t\t\t";
69
70static int argc;
71static char * const *argv;
72static const char *shortopts;
73static const struct option *longopts;
74static int *longind;
75static const struct help_msg *help;
76static int min_args, max_args;
77static int msg_args, msg_extra;
78static const char * msg_extra_arg;
79
80void
81cmdline_help(void)
82{
83   while (help && help->opt) {
84      const char *longopt = 0;
85      int opt = help->opt;
86      const struct option *o = 0;
87
88      if (HLP_ISLONG(opt)) {
89         o = longopts + HLP_DECODELONG(opt);
90         longopt = o->name;
91         opt = o->val;
92      }
93
94      if (isalnum((unsigned char)opt))
95         printf("  -%c%c", opt, longopt ? ',' : ' ');
96      else
97         fputs("     ", stdout);
98
99      if (longopt) {
100         int len = strlen(longopt);
101         printf(" --%s", longopt);
102         if (o && o->has_arg) {
103            const char *p;
104            len += len + 1;
105
106            if (o->has_arg == optional_argument) {
107               PUTCHAR('[');
108               len += 2;
109            }
110
111            PUTCHAR('=');
112
113            if (help->placeholder) {
114                fputs(help->placeholder, stdout);
115            } else {
116                for (p = longopt; *p ; p++) {
117                    unsigned char ch = *p;
118                    PUTCHAR((ch == '-') ? '_' : toupper(ch));
119                }
120            }
121
122            if (o->has_arg == optional_argument) PUTCHAR(']');
123         }
124         len = (len >> 3) + 2;
125         if (len > 4) len = 0;
126         fputs(newline_tabs + len, stdout);
127      } else {
128         fputs(newline_tabs + 1, stdout);
129      }
130
131      if (help->arg) {
132          SVX_ASSERT(strstr(msg(help->msg_no), "%s") != NULL);
133          printf(msg(help->msg_no), help->arg);
134          putnl();
135      } else {
136          SVX_ASSERT(strstr(msg(help->msg_no), "%s") == NULL);
137          puts(msg(help->msg_no));
138      }
139      help++;
140   }
141   fputs("      --help\t\t\t", stdout);
142   /* TRANSLATORS: description of --help option */
143   puts(msg(/*display this help and exit*/150));
144   fputs("      --version\t\t\t", stdout);
145   /* TRANSLATORS: description of --version option */
146   puts(msg(/*output version information and exit*/151));
147
148   if (msg_extra) {
149      putnl();
150      if (msg_extra_arg) {
151          SVX_ASSERT(strstr(msg(msg_extra), "%s") != NULL);
152          printf(msg(msg_extra), msg_extra_arg);
153          putnl();
154      } else {
155          SVX_ASSERT(strstr(msg(msg_extra), "%s") == NULL);
156          puts(msg(msg_extra));
157      }
158   }
159
160   exit(0);
161}
162
163void
164cmdline_version(void)
165{
166   printf("%s - "PRETTYPACKAGE" "VERSION"\n", msg_appname());
167}
168
169void
170cmdline_syntax(void)
171{
172   /* TRANSLATORS: as in: Usage: cavern … */
173   printf("\n%s: %s", msg(/*Usage*/49), msg_appname());
174   /* TRANSLATORS: in command line usage messages e.g. Usage: cavern [OPTION]… */
175   if (help && help->opt) printf(" [%s]...", msg(/*OPTION*/153));
176   if (msg_args) {
177      PUTCHAR(' ');
178      puts(msg(msg_args));
179      return;
180   }
181   if (min_args) {
182      int i = min_args;
183      while (i--) printf(" %s", msg(/*FILE*/124));
184   }
185   if (max_args == -1) {
186      if (!min_args) printf(" [%s]", msg(/*FILE*/124));
187      fputs("...", stdout);
188   } else if (max_args > min_args) {
189      int i = max_args - min_args;
190      while (i--) printf(" [%s]", msg(/*FILE*/124));
191   }
192   putnl();
193}
194
195static void
196syntax_and_help_pointer(void)
197{
198   cmdline_syntax();
199   fprintf(stderr, msg(/*Try “%s --help” for more information.\n*/157),
200           msg_appname());
201   exit(1);
202}
203
204static void
205moan_and_die(int msgno)
206{
207   fprintf(stderr, "%s: ", msg_appname());
208   fprintf(stderr, msg(msgno), optarg);
209   fputnl(stderr);
210   cmdline_syntax();
211   exit(1);
212}
213
214void
215cmdline_too_few_args(void)
216{
217   fprintf(stderr, "%s: %s\n", msg_appname(), msg(/*too few arguments*/122));
218   syntax_and_help_pointer();
219}
220
221void
222cmdline_too_many_args(void)
223{
224   fprintf(stderr, "%s: %s\n", msg_appname(), msg(/*too many arguments*/123));
225   syntax_and_help_pointer();
226}
227
228void
229cmdline_set_syntax_message(int msg_args_, int msg_extra_, const char * arg)
230{
231   msg_args = msg_args_;
232   msg_extra = msg_extra_;
233   msg_extra_arg = arg;
234}
235
236int
237cmdline_int_arg(void)
238{
239   long result;
240   char *endptr;
241
242   errno = 0;
243
244   result = strtol(optarg, &endptr, 10);
245
246   if (errno == ERANGE || result > INT_MAX || result < INT_MIN) {
247      moan_and_die(/*numeric argument “%s” out of range*/185);
248   } else if (*optarg == '\0' || *endptr != '\0') {
249      moan_and_die(/*argument “%s” not an integer*/186);
250   }
251
252   return (int)result;
253}
254
255double
256cmdline_double_arg(void)
257{
258   double result;
259   char *endptr;
260
261   errno = 0;
262
263   result = strtod(optarg, &endptr);
264
265   if (errno == ERANGE) {
266      moan_and_die(/*numeric argument “%s” out of range*/185);
267   } else if (*optarg == '\0' || *endptr != '\0') {
268      moan_and_die(/*argument “%s” not a number*/187);
269   }
270
271   return result;
272}
273
274void
275cmdline_init(int argc_, char *const *argv_, const char *shortopts_,
276             const struct option *longopts_, int *longind_,
277             const struct help_msg *help_,
278             int min_args_, int max_args_)
279{
280   argc = argc_;
281   argv = argv_;
282   shortopts = shortopts_;
283   longopts = longopts_;
284   longind = longind_;
285   help = help_;
286   min_args = min_args_;
287   max_args = max_args_;
288}
289
290int
291cmdline_getopt(void)
292{
293   int opt = getopt_long(argc, argv, shortopts, longopts, longind);
294
295   switch (opt) {
296    case EOF:
297      /* check valid # of args given - if not give syntax message */
298      if (argc - optind < min_args) {
299         cmdline_too_few_args();
300      } else if (max_args >= 0 && argc - optind > max_args) {
301         cmdline_too_many_args();
302      }
303      break;
304    case ':': /* parameter missing */
305    case '?': /* unknown opt, ambiguous match, or extraneous param */
306      /* getopt displays a message for us */
307      syntax_and_help_pointer();
308      break;
309    case HLP_VERSION: /* --version */
310      cmdline_version();
311      exit(0);
312    case HLP_HELP: /* --help */
313      cmdline_version();
314      cmdline_syntax();
315      PUTCHAR('\n');
316      cmdline_help();
317      exit(0);
318   }
319   return opt;
320}
Note: See TracBrowser for help on using the repository browser.