/*
* Command line utility for making sense of C declarations.
- * Copyright © 2011-2012, 2020 Nick Bowler
+ * Copyright © 2011-2012, 2020-2024 Nick Bowler
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <errno.h>
#include <locale.h>
#include <assert.h>
-#include "history.h"
-#include "cdecl.h"
+#include <stdarg.h>
+#include <inttypes.h>
#include <getopt.h>
#include <gettext.h>
-#include <readline.h>
-#include <striconv.h>
-#include <localcharset.h>
+#include <mbswidth.h>
-#define _(x) gettext(x)
-#define N_(x) x
-#define PN_(c, x) x
+#include "cdecl99.h"
+#include "cdecl.h"
+#include "help.h"
+#include "xtra.h"
+#include "options.h"
+#include "version.h"
+#include "getline.h"
+
+#if HAVE_READLINE_READLINE_H
+# include <readline/readline.h>
+#endif
+#if HAVE_RL_ADD_HISTORY && HAVE_READLINE_HISTORY_H
+# include <readline/history.h>
+
+/* call add_history only if the line is non-blank */
+static void do_add_history(const char *line)
+{
+ if (line[strspn(line, " \t")])
+ add_history(line);
+}
+#else
+static void do_add_history(const char *line)
+{
+}
+#endif
static const char *progname = "cdecl99";
-static const char sopts[] = "qbif:e:VH";
-#define RAW_LOPTS \
- { PN_("longopt", "quiet"), 0, NULL, 'q' }, \
- { PN_("longopt", "batch"), 0, NULL, 'b' }, \
- { PN_("longopt", "interactive"), 0, NULL, 'i' }, \
- { PN_("longopt", "file"), 1, NULL, 'f' }, \
- { PN_("longopt", "execute"), 1, NULL, 'e' }, \
- { PN_("longopt", "version"), 0, NULL, 'V' }, \
- { PN_("longopt", "help"), 0, NULL, 'H' }
-
-/*
- * With NLS, we need a buffer big enough to store the translated options.
- * The translations will be filled in at program startup.
- */
-enum { NOPTS = sizeof (struct option[]){RAW_LOPTS} / sizeof (struct option) };
-static struct option lopts[NOPTS + !!ENABLE_NLS * NOPTS + 1] = { RAW_LOPTS };
-
-static struct helptext {
- int val;
- const char *text;
- const char *argname;
-} helptext[] = {
- /*
- * TRANSLATORS: Help messages are indented 20 spaces and thus should
- * not have lines longer than 60 columns.
- */
- { 'q', N_("Suppress the welcome message.\n") },
- { 'b', N_("Execute commands as normal, but do not print any prompts.\n") },
- { 'i', N_("Run in interactive mode. This is the default.\n") },
- { 'f', N_("Read commands from FILE instead of standard input.\n"),
- PN_("longopt|file", "FILE") },
- { 'e', N_("Execute COMMAND as if it were entered at the prompt.\n"
- "This can be specified multiple times.\n"),
- PN_("longopt|execute", "COMMAND") },
- { 'V', N_("Print a version message and then exit.\n") },
- { 'H', N_("Print this message.\n") },
-
- /* TRANSLATORS: ARG is only used for options without help text. */
- { 0, NULL, PN_("longopt", "ARG") }
-};
+static bool batch_mode;
-static void print_version(void)
+void print_error(const char *fmt, ...)
{
- const char *copysign = "(C)";
- void *convsign = NULL;
+ va_list(ap);
- if (ENABLE_NLS) {
- convsign = str_iconv("\xc2\xa9", "UTF-8", locale_charset());
- if (convsign)
- copysign = convsign;
- }
+ fprintf(stderr, batch_mode ? "%s: %s" : "%.0s%s",
+ progname, _("error: "));
- puts(PACKAGE_STRING);
- printf("Copyright %s 2020 Nick Bowler.\n", copysign);
- puts("License GPLv3+: GNU GPL version 3 or any later version.");
- puts("This is free software: you are free to change and redistribute it.");
- puts("There is NO WARRANTY, to the extent permitted by law.");
+ va_start(ap, fmt);
+ vfprintf(stderr, fmt, ap);
+ va_end(ap);
- free(convsign);
+ fprintf(stderr, "\n");
}
-static void print_usage(FILE *f)
+static void print_version(void)
{
- fprintf(f, "Usage: %s [options]\n", progname);
+ do_print_version(PACKAGE_STRING);
}
-/*
- * Print the help description of a particular command-line option, identified
- * by its short option name.
- */
-static void print_option(int val)
+static void print_usage(FILE *f)
{
- const struct option *tmp[2];
- const struct helptext *help;
- const char *argname;
- char context[32];
- size_t rc, n = 0;
- int w;
-
- /* Find the options and help text corresponding to val. */
- for (const struct option *o = lopts; o->val; o++) {
- if (o->val == val) {
- assert(n < sizeof tmp / sizeof tmp[0]);
- tmp[n++] = o;
- }
- }
-
- for (help = helptext; help->val; help++) {
- if (help->val == val)
- break;
- }
-
- /* Prepare translations. */
- if (!ENABLE_NLS) {
- argname = help->argname;
- } else if (n > 0) {
- rc = snprintf(context, sizeof context, "longopt%c%s",
- help->text ? '|' : '\0', tmp[0]->name);
- assert(rc < sizeof context);
-
- if (help->argname)
- argname = pgettext_expr(context, help->argname);
- }
-
- switch (n) {
- case 0:
- w = printf(_(" -%c"), val);
- break;
- case 1:
- w = printf(tmp[0]->has_arg ? _(" -%c, --%s=%s")
- : _(" -%c, --%s"),
- val, tmp[0]->name, argname);
- break;
- case 2:
- if (tmp[0]->has_arg) {
- w = printf(_(" -%c, --%s=%s, --%s=%s"), val,
- tmp[0]->name, argname,
- tmp[1]->name, argname);
- } else {
- w = printf(_(" -%c, --%s, --%s"), val,
- tmp[0]->name, tmp[1]->name);
- }
- break;
- default:
- assert(0);
- }
-
- if (!help->text) {
- putchar('\n');
- return;
- }
-
- if (w > 18) {
- putchar('\n');
- w = 0;
- }
-
- for (const char *line = gettext(help->text); *line;) {
- const char *nl = strchr(line, '\n');
-
- if (!nl) {
- printf("%*s%s\n", 20-w, "", line);
- break;
- }
-
- printf("%*s%.*s\n", 20-w, "", (int)(nl-line), line);
- line = nl+1;
- }
+ fprintf(f, _("Usage: %s [options]\n"), progname);
+ if (f != stdout)
+ fprintf(f, _("Try %s --help for more information.\n"),
+ progname);
}
-static void print_help(void)
+static void print_help(const struct option *lopts)
{
+ struct lopt_help help = {0};
+ const struct option *opt;
+
print_usage(stdout);
- puts(_(
-"This is \"cdecl99\": a command-line tool for parsing and constructing\n"
-"complicated C declarations.\n"));
+ puts(_("This is \"cdecl99\": a command-line tool for parsing and constructing\n"
+ "complicated C declarations."));
+ putchar('\n');
puts(_("Options:"));
- for (const char *c = sopts; *c; c++) {
- if (*c == ':' || *c == '+' || *c == '-')
+ for (opt = lopts; opt->name; opt++) {
+ if (!lopt_get_help(opt, &help))
continue;
- print_option(*c);
+ help_print_option(opt, help.arg, help.desc, 20);
}
- putchar('\n');
- puts(_("For more information, see the cdecl99(1) man page.\n"));
+ printf("\n%s\n\n",
+ _("For more information, see the cdecl99(1) man page."));
/*
* TRANSLATORS: Please add *another line* indicating where users should
printf(_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT);
}
-/*
- * Format a declaration according to the given function and return a pointer
- * to the formatted string. The returned pointer remains valid until the
- * next call, after which it must not be re-used.
- *
- * Returns NULL on failure.
- */
-static const char *
-do_format(size_t func(char *, size_t, struct cdecl *), struct cdecl *decl)
-{
- static size_t bufsz;
- static char *buf;
-
- size_t rc;
-
-retry:
- rc = func(buf, bufsz, decl);
- if (rc >= bufsz) {
- char *tmp;
-
- tmp = realloc(buf, rc + 1);
- if (!tmp) {
- fprintf(stderr, "failed to allocate memory\n");
- return NULL;
- }
-
- buf = tmp;
- bufsz = rc + 1;
- goto retry;
- }
-
- return buf;
-}
-
-static int cmd_explain(const char *cmd, const char *arg)
-{
- const struct cdecl_error *err;
- struct cdecl *decl;
- const char *str;
- int ret = -1;
-
- decl = cdecl_parse_decl(arg);
- if (!decl) {
- err = cdecl_get_error();
- fprintf(stderr, "%s\n", err->str);
- goto out;
- }
-
- for (struct cdecl *i = decl; i; i = i->next) {
- str = do_format(cdecl_explain, i);
- if (!str)
- goto out;
-
- printf("%s\n", str);
- }
-
- ret = 1;
-out:
- cdecl_free(decl);
- return ret;
-}
-
-static int cmd_simplify(const char *cmd, const char *arg)
+static int do_getline(char **linebuf, size_t *n)
{
- const struct cdecl_error *err;
- struct cdecl *decl;
- const char *str;
- int ret = -1;
-
- decl = cdecl_parse_decl(arg);
- if (!decl) {
- err = cdecl_get_error();
- fprintf(stderr, "%s\n", err->str);
- goto out;
- }
-
- for (struct cdecl *i = decl; i; i = i->next) {
- struct cdecl_declspec *s = i->specifiers;
-
- if (i != decl) {
- i->specifiers = NULL;
- printf(", ");
- }
-
- str = do_format(cdecl_declare, i);
- i->specifiers = s;
-
- if (!str)
- goto out;
-
- printf("%s", str);
+ int rc;
+
+ if ((rc = dx_getline(linebuf, n, stdin)) < 0) {
+ if (rc == DX_GETLINE_ENOMEM)
+ print_error("%s", _("failed to allocate memory"));
+ else
+ print_error("%s", strerror(errno));
+ return 0;
}
- putchar('\n');
-
- ret = 1;
-out:
- cdecl_free(decl);
- return ret;
+ return rc;
}
-static int cmd_declare(const char *cmd, const char *arg)
+static int do_readline(char **linebuf, size_t *n, bool batch)
{
- const struct cdecl_error *err;
- struct cdecl *decl;
- const char *str;
- int ret = -1;
-
- /* The name of the command is significant here. */
- decl = cdecl_parse_english(cmd);
- if (!decl) {
- err = cdecl_get_error();
- fprintf(stderr, "%s\n", err->str);
- goto out;
+#if !HAVE_READLINE
+ if (!batch) {
+ fputs("> ", stdout);
+ fflush(stdout);
}
- /*
- * English parses have at most one full declarator, so no loop is
- * needed here.
- */
- str = do_format(cdecl_declare, decl);
- if (!str)
- goto out;
-
- printf("%s\n", str);
- ret = 1;
-out:
- cdecl_free(decl);
- return ret;
-}
-
-static int cmd_quit(const char *cmd, const char *arg)
-{
- return 0;
-}
-
-static int cmd_help(const char *cmd, const char *arg);
-
-static const struct command {
- char name[16];
- int (*func)(const char *cmd, const char *arg);
- const char *blurb;
-} commands[] = {
- { "explain", cmd_explain, "Explain a C declaration." },
- { "simplify", cmd_simplify, "Simplify a C declaration." },
- { "declare", cmd_declare, "Construct a C declaration." },
- { "type", cmd_declare, "Construct a C type name." },
- { "help", cmd_help, "Print this list of commands." },
- { "quit", cmd_quit, "Quit the program." },
- { "exit", cmd_quit, NULL }
-};
-static const size_t ncommands = sizeof commands / sizeof commands[0];
+ return do_getline(linebuf, n);
+#else
+ if (batch)
+ return do_getline(linebuf, n);
-static int cmd_help(const char *cmd, const char *arg)
-{
- for (size_t i = 0; i < ncommands; i++) {
- if (!commands[i].blurb)
- continue;
-
- printf("%s -- %s\n", commands[i].name, commands[i].blurb);
- }
+ free(*linebuf);
+ if (!(*linebuf = readline("> ")))
+ return 0;
+ do_add_history(*linebuf);
return 1;
+#endif
}
-/*
- * Ensure that the first n characters of str equal the entire (null-terminated)
- * string cmd.
- */
-static int cmd_cmp(const char *str, const char *cmd, size_t n)
-{
- size_t cmdlen = strlen(cmd);
-
- if (n < cmdlen)
- return -1;
- if (n > cmdlen)
- return 1;
- return memcmp(str, cmd, n);
-}
-
-static int run_command(const char *line)
-{
- const char *cmd = line + strspn(line, " \t");
- const char *arg = cmd + strcspn(cmd, " \t");
-
- if (cmd[0] == '\0')
- return 1;
-
- for (size_t i = 0; i < ncommands; i++) {
- if (cmd_cmp(cmd, commands[i].name, arg-cmd) != 0)
- continue;
-
- return commands[i].func(cmd, arg);
- }
-
- fprintf(stderr, "Undefined command: %.*s\n", (int)(arg-cmd), cmd);
- return -1;
-}
-
-static bool is_blank_line(const char *line)
+static int repl(bool batch)
{
- for (size_t i = 0; line[i]; i++) {
- if (!isblank((unsigned char)line[i]))
- return false;
- }
-
- return true;
-}
-
-static int repl(void)
-{
- char *line;
-
- for (; (line = readline("> ")); free(line)) {
- if (!is_blank_line(line))
- cdecl_add_history(line);
+ char *line = NULL;
+ bool fail = 0;
+ size_t n = 0;
- if (!run_command(line))
+ while (do_readline(&line, &n, batch)) {
+ int rc = run_command(line, batch);
+ if (rc > 0)
break;
+ if (rc < 0)
+ fail = batch;
}
free(line);
- return 0;
+ return fail ? EXIT_FAILURE : 0;
}
-static int repl_cmdline(int argc, char **argv)
+static int repl_cmdline(unsigned count, char **commands)
{
- int opt, rc, ret = 0;
-
- optind = 1;
- while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
- if (opt != 'e')
- continue;
+ bool fail = 0;
+ unsigned i;
- rc = run_command(optarg);
- if (rc < 0)
- ret = -1;
- else if (rc == 0)
+ for (i = 0; i < count; i++) {
+ int rc = run_command(commands[i], true);
+ if (rc > 0)
break;
- }
-
- return ret;
-}
-
-static int repl_noninteractive(void)
-{
- int rc, ret = 0, saved_errno;
- char *line = NULL;
- size_t n;
-
- while (getline(&line, &n, stdin) >= 0) {
- char *c = strchr(line, '\n');
- if (c)
- *c = '\0';
-
- rc = run_command(line);
if (rc < 0)
- ret = -1;
- else if (rc == 0)
- break;
+ fail = true;
}
- saved_errno = errno;
- free(line);
-
- if (ferror(stdin)) {
- errno = saved_errno;
- perror("read error");
- return -1;
- }
-
- return ret;
+ return fail ? EXIT_FAILURE : 0;
}
-/* Initialize gettext and setup translated long options. */
+/* Initialize gettext */
static void init_i18n(void)
{
if (!ENABLE_NLS)
setlocale(LC_ALL, "");
bindtextdomain(PACKAGE, LOCALEDIR);
textdomain(PACKAGE);
-
- for (int i = 0, j = NOPTS; i < NOPTS; i++) {
- const char *tname = pgettext_expr("longopt", lopts[i].name);
-
- if (strcmp(tname, lopts[i].name) != 0) {
- lopts[j] = lopts[i];
- lopts[j].name = tname;
- j++;
- }
- }
}
-int main(int argc, char **argv)
+enum {
+ INIT_EXIT_SUCCESS = -1,
+ INIT_EXIT_FAILURE = -2
+};
+
+static int initialize(int argc, char **argv)
{
- bool show_intro = true, interactive = true, execute = false;
+ int i, opt, quiet = 0, execute = 0;
const char *filename = NULL;
- int opt, rc;
+
+ XTRA_PACKED_LOPTS(lopts);
if (argc > 0)
progname = argv[0];
init_i18n();
- while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
+ while ((opt = getopt_long(argc, argv, SOPT_STRING, lopts, 0)) != -1) {
switch (opt) {
case 'q':
- show_intro = false;
+ quiet = 1;
break;
case 'b':
- interactive = false;
+ batch_mode = true;
break;
case 'i':
- interactive = true;
+ batch_mode = false;
break;
case 'f':
filename = optarg;
break;
case 'e':
- execute = true;
+ argv[execute++] = optarg;
break;
case 'V':
print_version();
- return EXIT_SUCCESS;
+ return INIT_EXIT_SUCCESS;
case 'H':
- print_help();
- return EXIT_SUCCESS;
+ print_help(lopts);
+ return INIT_EXIT_SUCCESS;
default:
print_usage(stderr);
- return EXIT_FAILURE;
+ return INIT_EXIT_FAILURE;
+ }
+ }
+
+ if (optind < argc) {
+ fprintf(stderr, "%s: %s", progname,
+ _("excess command-line arguments:"));
+ for (i = optind; i < argc; i++) {
+ fprintf(stderr, " %s", argv[i]);
}
+ fprintf(stderr, "\n");
+ print_usage(stderr);
+ return INIT_EXIT_FAILURE;
}
/* --filename and --execute imply --batch. */
if (filename || execute)
- interactive = false;
+ batch_mode = true;
/* --batch implies --quiet */
- if (interactive && show_intro)
+ if (!batch_mode && !quiet)
print_version();
/* --execute supersedes --filename */
if (filename && !execute) {
if (!freopen(filename, "r", stdin)) {
- perror(filename);
- return EXIT_FAILURE;
+ print_error("failed to open %s: %s", filename,
+ strerror(errno));
+ return INIT_EXIT_FAILURE;
}
}
- if (interactive)
- rc = repl();
- else if (execute)
- rc = repl_cmdline(argc, argv);
- else
- rc = repl_noninteractive();
+ return execute;
+}
- if (rc != 0)
- return EXIT_FAILURE;
- return EXIT_SUCCESS;
+int main(int argc, char **argv)
+{
+ int execute;
+
+ switch ((execute = initialize(argc, argv))) {
+ case INIT_EXIT_SUCCESS: return EXIT_SUCCESS;
+ case INIT_EXIT_FAILURE: return EXIT_FAILURE;
+ }
+
+ if (execute)
+ return repl_cmdline(execute, argv);
+ else
+ return repl(batch_mode);
}
projects / cdecl99.git / blobdiff