/* $NetBSD: sl.c,v 1.2.22.1 2023/08/11 13:40:02 martin Exp $ */ /* * Copyright (c) 1995 - 2006 Kungliga Tekniska Högskolan * (Royal Institute of Technology, Stockholm, Sweden). * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * 3. Neither the name of the Institute nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include #include "sl_locl.h" #include static void mandoc_template(SL_cmd *cmds, const char *extra_string) { SL_cmd *c, *prev; char timestr[64], cmd[64]; const char *p; time_t t; printf(".\\\" Things to fix:\n"); printf(".\\\" * correct section, and operating system\n"); printf(".\\\" * remove Op from mandatory flags\n"); printf(".\\\" * use better macros for arguments (like .Pa for files)\n"); printf(".\\\"\n"); t = time(NULL); strftime(timestr, sizeof(timestr), "%b %d, %Y", localtime(&t)); printf(".Dd %s\n", timestr); #ifdef HAVE_GETPROGNAME p = getprogname(); #else p = "unknown-application"; #endif strncpy(cmd, p, sizeof(cmd)); cmd[sizeof(cmd)-1] = '\0'; strupr(cmd); printf(".Dt %s SECTION\n", cmd); printf(".Os OPERATING_SYSTEM\n"); printf(".Sh NAME\n"); printf(".Nm %s\n", p); printf(".Nd\n"); printf("in search of a description\n"); printf(".Sh SYNOPSIS\n"); printf(".Nm\n"); for(c = cmds; c->name; ++c) { /* if (c->func == NULL) continue; */ printf(".Op Fl %s", c->name); printf("\n"); } if (extra_string && *extra_string) printf (".Ar %s\n", extra_string); printf(".Sh DESCRIPTION\n"); printf("Supported options:\n"); printf(".Bl -tag -width Ds\n"); prev = NULL; for(c = cmds; c->name; ++c) { if (c->func) { if (prev) printf ("\n%s\n", prev->usage); printf (".It Fl %s", c->name); prev = c; } else printf (", %s\n", c->name); } if (prev) printf ("\n%s\n", prev->usage); printf(".El\n"); printf(".\\\".Sh ENVIRONMENT\n"); printf(".\\\".Sh FILES\n"); printf(".\\\".Sh EXAMPLES\n"); printf(".\\\".Sh DIAGNOSTICS\n"); printf(".\\\".Sh SEE ALSO\n"); printf(".\\\".Sh STANDARDS\n"); printf(".\\\".Sh HISTORY\n"); printf(".\\\".Sh AUTHORS\n"); printf(".\\\".Sh BUGS\n"); } SL_cmd * sl_match (SL_cmd *cmds, char *cmd, int exactp) { SL_cmd *c, *current = NULL, *partial_cmd = NULL; int partial_match = 0; for (c = cmds; c->name; ++c) { if (c->func) current = c; if (strcmp (cmd, c->name) == 0) return current; else if (strncmp (cmd, c->name, strlen(cmd)) == 0 && partial_cmd != current) { ++partial_match; partial_cmd = current; } } if (partial_match == 1 && !exactp) return partial_cmd; else return NULL; } void sl_help (SL_cmd *cmds, int argc, char **argv) { SL_cmd *c, *prev_c; if (getenv("SLMANDOC")) { mandoc_template(cmds, NULL); return; } if (argc == 1) { prev_c = NULL; for (c = cmds; c->name; ++c) { if (c->func) { if(prev_c) printf ("\n\t%s%s", prev_c->usage ? prev_c->usage : "", prev_c->usage ? "\n" : ""); prev_c = c; printf ("%s", c->name); } else printf (", %s", c->name); } if(prev_c) printf ("\n\t%s%s", prev_c->usage ? prev_c->usage : "", prev_c->usage ? "\n" : ""); } else { c = sl_match (cmds, argv[1], 0); if (c == NULL) printf ("No such command: %s. " "Try \"help\" for a list of all commands\n", argv[1]); else { printf ("%s\t%s\n", c->name, c->usage); if(c->help && *c->help) printf ("%s\n", c->help); if((++c)->name && c->func == NULL) { printf ("Synonyms:"); while (c->name && c->func == NULL) printf ("\t%s", (c++)->name); printf ("\n"); } } } } #ifdef HAVE_READLINE char *readline(char *prompt); void add_history(char *p); #else static char * readline(char *prompt) { char buf[BUFSIZ]; printf ("%s", prompt); fflush (stdout); if(fgets(buf, sizeof(buf), stdin) == NULL) return NULL; buf[strcspn(buf, "\r\n")] = '\0'; return strdup(buf); } static void add_history(char *p) { } #endif int sl_command(SL_cmd *cmds, int argc, char **argv) { SL_cmd *c; c = sl_match (cmds, argv[0], 0); if (c == NULL) return -1; return (*c->func)(argc, argv); } struct sl_data { int max_count; char **ptr; }; int sl_make_argv(char *line, int *ret_argc, char ***ret_argv) { char *p, *begining; int argc, nargv; char **argv; int quote = 0; nargv = 10; argv = malloc(nargv * sizeof(*argv)); if(argv == NULL) return ENOMEM; argc = 0; p = line; while(isspace((unsigned char)*p)) p++; begining = p; while (1) { if (*p == '\0') { ; } else if (*p == '"') { quote = !quote; memmove(&p[0], &p[1], strlen(&p[1]) + 1); continue; } else if (*p == '\\') { if (p[1] == '\0') goto failed; memmove(&p[0], &p[1], strlen(&p[1]) + 1); p += 2; continue; } else if (quote || !isspace((unsigned char)*p)) { p++; continue; } else *p++ = '\0'; if (quote) goto failed; if(argc == nargv - 1) { char **tmp; nargv *= 2; tmp = realloc (argv, nargv * sizeof(*argv)); if (tmp == NULL) { free(argv); return ENOMEM; } argv = tmp; } argv[argc++] = begining; while(isspace((unsigned char)*p)) p++; if (*p == '\0') break; begining = p; } argv[argc] = NULL; *ret_argc = argc; *ret_argv = argv; return 0; failed: free(argv); return ERANGE; } static jmp_buf sl_jmp; static void sl_sigint(int sig) { longjmp(sl_jmp, 1); } static char *sl_readline(const char *prompt) { char *s; void (*old)(int); old = signal(SIGINT, sl_sigint); if(setjmp(sl_jmp)) printf("\n"); s = readline(rk_UNCONST(prompt)); signal(SIGINT, old); return s; } /* return values: * 0 on success, * -1 on fatal error, * -2 if EOF, or * return value of command */ int sl_command_loop(SL_cmd *cmds, const char *prompt, void **data) { int ret = 0; char *buf; int argc; char **argv; buf = sl_readline(prompt); if(buf == NULL) return -2; if(*buf) add_history(buf); ret = sl_make_argv(buf, &argc, &argv); if(ret) { fprintf(stderr, "sl_loop: out of memory\n"); free(buf); return -1; } if (argc >= 1) { ret = sl_command(cmds, argc, argv); if(ret == -1) { sl_did_you_mean(cmds, argv[0]); ret = 0; } } free(buf); free(argv); return ret; } int sl_loop(SL_cmd *cmds, const char *prompt) { void *data = NULL; int ret; while((ret = sl_command_loop(cmds, prompt, &data)) >= 0) ; return ret; } void sl_apropos (SL_cmd *cmd, const char *topic) { for (; cmd->name != NULL; ++cmd) if (cmd->usage != NULL && strstr(cmd->usage, topic) != NULL) printf ("%-20s%s\n", cmd->name, cmd->usage); } /* * Help to be used with slc. */ void sl_slc_help (SL_cmd *cmds, int argc, char **argv) { if(argc == 0) { sl_help(cmds, 1, argv - 1 /* XXX */); } else { SL_cmd *c = sl_match (cmds, argv[0], 0); if(c == NULL) { fprintf (stderr, "No such command: %s. " "Try \"help\" for a list of commands\n", argv[0]); } else { if(c->func) { static char help[] = "--help"; char *fake[3]; fake[0] = argv[0]; fake[1] = help; fake[2] = NULL; (*c->func)(2, fake); fprintf(stderr, "\n"); } if(c->help && *c->help) fprintf (stderr, "%s\n", c->help); if((++c)->name && c->func == NULL) { int f = 0; fprintf (stderr, "Synonyms:"); while (c->name && c->func == NULL) { fprintf (stderr, "%s%s", f ? ", " : " ", (c++)->name); f = 1; } fprintf (stderr, "\n"); } } } } /* OptimalStringAlignmentDistance */ static int osad(const char *s1, const char *s2) { size_t l1 = strlen(s1), l2 = strlen(s2), i, j; int *row0, *row1, *row2, *tmp, cost; row0 = calloc(sizeof(int), l2 + 1); row1 = calloc(sizeof(int), l2 + 1); row2 = calloc(sizeof(int), l2 + 1); for (j = 0; j < l2 + 1; j++) row1[j] = j; for (i = 0; i < l1; i++) { row2[0] = i + 1; for (j = 0; j < l2; j++) { row2[j + 1] = row1[j] + (s1[i] != s2[j]); /* substitute */ if (row2[j + 1] > row1[j + 1] + 1) /* delete */ row2[j + 1] = row1[j + 1] + 1; if (row2[j + 1] > row2[j] + 1) /* insert */ row2[j + 1] = row2[j] + 1; if (j > 0 && i > 0 && s1[i - 1] != s2[j - 1] && s1[i - 1] == s2[j] && s1[i] == s2[j - 1] && row2[j + 1] < row0[j - 1]) /* transposition */ row2[j + 1] = row0[j - 1] + 1; } tmp = row0; row0 = row1; row1 = row2; row2 = tmp; } cost = row1[l2]; free(row0); free(row1); free(row2); return cost; } /** * Will propose a list of command that are almost matching the command * used, if there is no matching, will ask the user to use "help". * * @param cmds command array to use for matching * @param match the command that didn't exists */ void sl_did_you_mean(SL_cmd *cmds, const char *match) { int *metrics, best_match = INT_MAX; SL_cmd *c; size_t n; for (n = 0, c = cmds; c->name; c++, n++) ; if (n == 0) return; metrics = calloc(n, sizeof(metrics[0])); if (metrics == NULL) return; for (n = 0; cmds[n].name; n++) { metrics[n] = osad(match, cmds[n].name); if (metrics[n] < best_match) best_match = metrics[n]; } if (best_match == INT_MAX) { free(metrics); fprintf(stderr, "What kind of command is %s", match); return; } /* if match distance is low, propose that for the user */ if (best_match < 7) { fprintf(stderr, "error: %s is not a known command, did you mean ?\n", match); for (n = 0; cmds[n].name; n++) { if (metrics[n] == best_match) { fprintf(stderr, "\t%s\n", cmds[n].name); } } fprintf(stderr, "\n"); } else { fprintf(stderr, "error: %s is not a command, use \"help\" for more list of commands.\n", match); } free(metrics); return; }