/*
- * Command line utility for making sense of C declarations.
- * Copyright © 2011 Nick Bowler
+ * Command line utility for making sense of C declarations.
+ * Copyright © 2011-2012, 2020-2021 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
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
+
#include <config.h>
#include <stdio.h>
#include <stdlib.h>
+#include <stdbool.h>
#include <string.h>
-#include <getopt.h>
-#include "readline.h"
+#include <ctype.h>
+#include <errno.h>
+#include <locale.h>
+#include <assert.h>
+#include "history.h"
#include "cdecl.h"
+#include <getopt.h>
+#include <gettext.h>
+#include <readline.h>
+#include <striconv.h>
+#include <localcharset.h>
+#include <mbswidth.h>
+
+#define _(x) gettext(x)
+
static const char *progname = "cdecl99";
-static const char sopts[] = "VH";
+
+#include "options.h"
+static const char sopts[] = SOPT_STRING;
static const struct option lopts[] = {
- { "version", 0, NULL, 'V' },
- { "help", 0, NULL, 'H' },
- { 0 }
+ LOPTS_INITIALIZER,
+ {0}
};
static void print_version(void)
{
+ const char *copysign = "(C)";
+ void *convsign = NULL;
+
+ if (ENABLE_NLS) {
+ convsign = str_iconv("\xc2\xa9", "UTF-8", locale_charset());
+ if (convsign)
+ copysign = convsign;
+ }
+
puts(PACKAGE_STRING);
- puts("Copyright (C) 2011 Nick Bowler.");
- puts("License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.");
+ printf("Copyright %s 2021 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.");
+
+ free(convsign);
}
static void print_usage(FILE *f)
{
- fprintf(f, "Usage: %s [options]\n", progname);
+ fprintf(f, _("Usage: %s [options]\n"), progname);
+ if (f != stdout)
+ fprintf(f, _("Try %s --help for more information.\n"),
+ progname);
+}
+
+static int
+print_optstring(const struct option *opt, const struct lopt_help *help)
+{
+ char optstring[100];
+ int w;
+
+ if (!ENABLE_NLS)
+ goto no_translate;
+
+ if (opt->has_arg) {
+ w = snprintf(optstring, sizeof optstring,
+ _(" -%c, --%s=%s"), opt->val, opt->name,
+ pgettext_expr(opt->name, help->arg));
+ } else {
+ w = snprintf(optstring, sizeof optstring,
+ _(" -%c, --%s"), opt->val, opt->name);
+ }
+
+ if (w < 0)
+ goto no_translate;
+
+ w = mbsnwidth(optstring, w, 0);
+ printf("%s", optstring);
+ goto out;
+
+no_translate:
+ if (opt->has_arg) {
+ w = printf(" -%c, --%s=%s", opt->val, opt->name, help->arg);
+ } else {
+ w = printf(" -%c, --%s", opt->val, opt->name);
+ }
+out:
+ if (w < 0 || w > 18) {
+ putchar('\n');
+ return 0;
+ }
+
+ return w;
}
static void print_help(void)
{
+ const struct option *opt;
+
print_usage(stdout);
- puts("Detailed help coming soon.");
+
+ puts(_("This is \"cdecl99\": a command-line tool for parsing and constructing\n"
+ "complicated C declarations."));
+ putchar('\n');
+
+ puts(_("Options:"));
+ for (opt = lopts; opt->name; opt++) {
+ struct lopt_help help;
+ const char *line;
+ int w;
+
+ if (!lopt_get_help(opt, &help))
+ continue;
+
+ w = print_optstring(opt, &help);
+
+ if (ENABLE_NLS)
+ help.desc = pgettext_expr(opt->name, help.desc);
+
+ for (line = help.desc; *line; w = 0) {
+ const char *nl = strchr(line, '\n');
+ int n = (nl ? nl-line : -1);
+
+ printf("%*s%.*s\n", 20-w, "", n, line);
+ if (!nl)
+ break;
+
+ line = nl+1;
+ }
+ }
+ putchar('\n');
+
+ puts(_("For more information, see the cdecl99(1) man page."));
+ putchar('\n');
+
+ /*
+ * TRANSLATORS: Please add *another line* indicating where users should
+ * report translation bugs.
+ */
+ printf(_("Report bugs to <%s>.\n"), PACKAGE_BUGREPORT);
}
-static int cmd_explain(char *cmd, char *arg)
+/*
+ * 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;
- struct cdecl *decl;
size_t rc;
+retry:
+ rc = func(buf, bufsz, decl);
+ if (rc >= bufsz) {
+ char *tmp;
+
+ tmp = realloc(buf, rc + 1);
+ if (!tmp) {
+ fprintf(stderr, "%s\n", _("failed to allocate memory"));
+ 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)
+ if (!decl) {
+ err = cdecl_get_error();
+ fprintf(stderr, "%s\n", err->str);
goto out;
+ }
for (struct cdecl *i = decl; i; i = i->next) {
-retry:
- rc = cdecl_explain(buf, bufsz, i);
- if (rc >= bufsz) {
- char *tmp;
-
- tmp = realloc(buf, rc + 1);
- if (!tmp) {
- fprintf(stderr, "failed to allocate memory\n");
- goto out;
- }
-
- buf = tmp;
- bufsz = rc + 1;
- goto retry;
+ 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)
+{
+ 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(", ");
}
- printf("%s\n", buf);
+ str = do_format(cdecl_declare, i);
+ i->specifiers = s;
+
+ if (!str)
+ goto out;
+
+ printf("%s", str);
}
+
+ putchar('\n');
+
+ ret = 1;
out:
cdecl_free(decl);
- return 1;
+ return ret;
}
-static int cmd_quit(char *cmd, char *arg)
+static int cmd_declare(const char *cmd, const char *arg)
+{
+ 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;
+ }
+
+ /*
+ * 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(char *cmd, char *arg);
+static int cmd_help(const char *cmd, const char *arg);
static const struct command {
char name[16];
- int (*func)(char *cmd, char *arg);
+ int (*func)(const char *cmd, const char *arg);
const char *blurb;
} commands[] = {
- { "explain", cmd_explain, "Explain a C declaration." },
- { "help", cmd_help, "Print this list of commands." },
- { "quit", cmd_quit, "Quit the program." },
- { "exit", cmd_quit, NULL }
+ { "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];
-static int cmd_help(char *cmd, char *arg)
+static int cmd_help(const char *cmd, const char *arg)
{
for (size_t i = 0; i < ncommands; i++) {
if (!commands[i].blurb)
return 1;
}
+/*
+ * 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)
+{
+ for (size_t i = 0; line[i]; i++) {
+ if (!isblank((unsigned char)line[i]))
+ return false;
+ }
+
+ return true;
+}
+
static int repl(void)
{
char *line;
- int ret;
-
- print_version();
for (; (line = readline("> ")); free(line)) {
- char *cmd = line + strspn(line, " \t");
- char *arg = cmd + strcspn(cmd, " \t");
+ if (!is_blank_line(line))
+ cdecl_add_history(line);
+
+ if (!run_command(line))
+ break;
+ }
+
+ free(line);
+ return 0;
+}
+
+static int repl_cmdline(int argc, char **argv)
+{
+ int opt, rc, ret = 0;
- if (cmd[0] == '\0')
+ optind = 1;
+ while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
+ if (opt != 'e')
continue;
- if (arg[0] != '\0')
- *arg++ = '\0';
- for (size_t i = 0; i < ncommands; i++) {
- if (strcmp(cmd, commands[i].name) != 0)
- continue;
+ rc = run_command(optarg);
+ if (rc < 0)
+ ret = -1;
+ else if (rc == 0)
+ break;
+ }
- ret = commands[i].func(cmd, arg);
- if (ret <= 0)
- goto out;
- goto next;
- }
+ return ret;
+}
- fprintf(stderr, "Undefined command: %s\n", cmd);
- next:
- ;
+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;
}
- ret = 0;
-out:
+ saved_errno = errno;
free(line);
+
+ if (ferror(stdin)) {
+ errno = saved_errno;
+ perror("read error");
+ return -1;
+ }
+
return ret;
}
+/* Initialize gettext */
+static void init_i18n(void)
+{
+ if (!ENABLE_NLS)
+ return;
+
+ setlocale(LC_ALL, "");
+ bindtextdomain(PACKAGE, LOCALEDIR);
+ textdomain(PACKAGE);
+}
+
int main(int argc, char **argv)
{
- int opt;
+ bool show_intro = true, interactive = true, execute = false;
+ const char *filename = NULL;
+ int i, opt, rc;
if (argc > 0)
progname = argv[0];
+ init_i18n();
+
while ((opt = getopt_long(argc, argv, sopts, lopts, NULL)) != -1) {
switch (opt) {
+ case 'q':
+ show_intro = false;
+ break;
+ case 'b':
+ interactive = false;
+ break;
+ case 'i':
+ interactive = true;
+ break;
+ case 'f':
+ filename = optarg;
+ break;
+ case 'e':
+ execute = true;
+ break;
case 'V':
print_version();
return EXIT_SUCCESS;
}
}
- if (repl() != 0)
+ if (optind < argc) {
+ fprintf(stderr, _("%s: excess command-line arguments:"),
+ progname);
+ for (i = optind; i < argc; i++) {
+ fprintf(stderr, " %s", argv[i]);
+ }
+ fprintf(stderr, "\n");
+ print_usage(stderr);
return EXIT_FAILURE;
+ }
+
+ /* --filename and --execute imply --batch. */
+ if (filename || execute)
+ interactive = false;
+
+ /* --batch implies --quiet */
+ if (interactive && show_intro)
+ print_version();
+ /* --execute supersedes --filename */
+ if (filename && !execute) {
+ if (!freopen(filename, "r", stdin)) {
+ perror(filename);
+ return EXIT_FAILURE;
+ }
+ }
+
+ if (interactive)
+ rc = repl();
+ else if (execute)
+ rc = repl_cmdline(argc, argv);
+ else
+ rc = repl_noninteractive();
+
+ if (rc != 0)
+ return EXIT_FAILURE;
return EXIT_SUCCESS;
}