getarg.c

/* -*- c-basic-offset: 4; -*- */
/*
 * Copyright (C) 2003-2005 MySQL AB, 2008, 2009 Sun Microsystems, Inc.
 * (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 <ndb_global.h>

#include "getarg.h"
#include <basestring_vsnprintf.h>

#ifndef HAVE_STRLCPY
static size_t
strlcpy (char *dst, const char *src, size_t dst_sz)
{
    size_t n;
    char *p;
    for (p = dst, n = 0;
         n + 1 < dst_sz && *src != '\0';
         ++p, ++src, ++n)
        *p = *src;
    *p = '\0';
    if (*src == '\0')
        return n;
    else
        return n + strlen (src);
}
#endif
#ifndef HAVE_STRLCAT
static size_t
strlcat (char *dst, const char *src, size_t dst_sz)
{
    size_t len = strlen(dst);
    return len + strlcpy (dst + len, src, dst_sz - len);
}
#endif

#define ISFLAG(X) ((X).type == arg_flag || (X).type == arg_negative_flag)

#ifndef max
#define max(a, b) (a) > (b) ? (a) : (b)
#endif

#ifdef HAVE___PROGNAME
extern char *__progname;
#endif

#ifndef TRUE
#define TRUE 1
#endif

#ifndef FALSE
#define FALSE 0
#endif

char *
strupr(char *str)
{
  char *s;

  for(s = str; *s; s++)
    *s = toupper(*s);
  return str;
}

static size_t
print_arg (char *string, size_t len, int mdoc, int longp, struct getargs *arg)
{
    const char *s;

    *string = '\0';

    if (ISFLAG(*arg) || (!longp && arg->type == arg_counter))
        return 0;

    if(mdoc){
        if(longp)
            strlcat(string, "= Ns", len);
        strlcat(string, " Ar ", len);
    }else
        if (longp)
            strlcat (string, "=", len);
        else
            strlcat (string, " ", len);

    if (arg->arg_help)
        s = arg->arg_help;
    else if (arg->type == arg_integer || arg->type == arg_counter)
        s = "integer";
    else if (arg->type == arg_string)
        s = "string";
    else if (arg->type == arg_double)
        s = "float";
    else
        s = "<undefined>";

    strlcat(string, s, len);
    return 1 + strlen(s);
}

#ifdef GETARGMANDOC
static void
mandoc_template(struct getargs *args,
                size_t num_args,
                const char *progname,
                const char *extra_string)
{
    size_t i;
    char timestr[64], cmd[64];
    char buf[128];
    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 %e, %Y", localtime(&t));
    printf(".Dd %s\n", timestr);
    p = strrchr(progname, '/');
    if(p) p++; else p = progname;
    strlcpy(cmd, p, sizeof(cmd));
    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(i = 0; i < num_args; i++){
        /* we seem to hit a limit on number of arguments if doing
           short and long flags with arguments -- split on two lines */
        if(ISFLAG(args[i]) || 
           args[i].short_name == 0 || args[i].long_name == NULL) {
            printf(".Op ");

            if(args[i].short_name) {
                print_arg(buf, sizeof(buf), 1, 0, args + i);
                printf("Fl %c%s", args[i].short_name, buf);
                if(args[i].long_name)
                    printf(" | ");
            }
            if(args[i].long_name) {
                print_arg(buf, sizeof(buf), 1, 1, args + i);
                printf("Fl -%s%s%s",
                       args[i].type == arg_negative_flag ? "no-" : "",
                       args[i].long_name, buf);
            }
            printf("\n");
        } else {
            print_arg(buf, sizeof(buf), 1, 0, args + i);
            printf(".Oo Fl %c%s \\*(Ba Xo\n", args[i].short_name, buf);
            print_arg(buf, sizeof(buf), 1, 1, args + i);
            printf(".Fl -%s%s Oc\n.Xc\n", args[i].long_name, buf);
        }
    /*
            if(args[i].type == arg_strings)
                fprintf (stderr, "...");
                */
    }
    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");
    for(i = 0; i < num_args; i++){
        printf(".It Xo\n");
        if(args[i].short_name){
            printf(".Fl %c", args[i].short_name);
            print_arg(buf, sizeof(buf), 1, 0, args + i);
            printf("%s", buf);
            if(args[i].long_name)
                printf(" Ns ,");
            printf("\n");
        }
        if(args[i].long_name){
            printf(".Fl -%s%s",
                   args[i].type == arg_negative_flag ? "no-" : "",
                   args[i].long_name);
            print_arg(buf, sizeof(buf), 1, 1, args + i);
            printf("%s\n", buf);
        }
        printf(".Xc\n");
        if(args[i].help)
            printf("%s\n", args[i].help);
    /*
            if(args[i].type == arg_strings)
                fprintf (stderr, "...");
                */
    }
    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");
}
#endif /* GETARGMANDOC */

static int
check_column(FILE *f, int col, int len, int columns)
{
    if(col + len > columns) {
        fprintf(f, "\n");
        col = fprintf(f, "  ");
    }
    return col;
}

void
arg_printusage (struct getargs *args,
                size_t num_args,
                const char *progname,
                const char *extra_string)
{
    unsigned int i;
    size_t max_len = 0;
    char buf[128];
    int col = 0, columns;

#ifdef HAVE___PROGNAME
    if (progname == NULL)
        progname = __progname;
#endif
    if (progname == NULL)
        progname = "";

#ifdef GETARGMANDOC
    if(getenv("GETARGMANDOC")){
        mandoc_template(args, num_args, progname, extra_string);
        return;
    }
#endif

    columns = 80; /* Always assume that the window is 80 chars wide */
    col = 0;
    col += fprintf (stderr, "Usage: %s", progname);
    for (i = 0; i < num_args; ++i) {
        size_t len = 0;

        if (args[i].long_name) {
            buf[0] = '\0';
            strlcat(buf, "[--", sizeof(buf));
            len += 2;
            if(args[i].type == arg_negative_flag) {
                strlcat(buf, "no-", sizeof(buf));
                len += 3;
            }
            strlcat(buf, args[i].long_name, sizeof(buf));
            len += strlen(args[i].long_name);
            len += print_arg(buf + strlen(buf), sizeof(buf) - strlen(buf), 
                             0, 1, &args[i]);
            strlcat(buf, "]", sizeof(buf));
            if(args[i].type == arg_strings)
                strlcat(buf, "...", sizeof(buf));
            col = check_column(stderr, col, strlen(buf) + 1, columns);
            col += fprintf(stderr, " %s", buf);
        }
        if (args[i].short_name) {
            basestring_snprintf(buf, sizeof(buf), "[-%c", args[i].short_name);
            len += 2;
            len += print_arg(buf + strlen(buf), sizeof(buf) - strlen(buf), 
                             0, 0, &args[i]);
            strlcat(buf, "]", sizeof(buf));
            if(args[i].type == arg_strings)
                strlcat(buf, "...", sizeof(buf));
            col = check_column(stderr, col, strlen(buf) + 1, columns);
            col += fprintf(stderr, " %s", buf);
        }
        if (args[i].long_name && args[i].short_name)
            len += 2; /* ", " */
        max_len = max(max_len, len);
    }
    if (extra_string) {
        col = check_column(stderr, col, strlen(extra_string) + 1, columns);
        fprintf (stderr, " %s\n", extra_string);
    } else
        fprintf (stderr, "\n");
    for (i = 0; i < num_args; ++i) {
        if (args[i].help) {
            size_t count = 0;

            if (args[i].short_name) {
                count += fprintf (stderr, "-%c", args[i].short_name);
                print_arg (buf, sizeof(buf), 0, 0, &args[i]);
                count += fprintf(stderr, "%s", buf);
            }
            if (args[i].short_name && args[i].long_name)
                count += fprintf (stderr, ", ");
            if (args[i].long_name) {
                count += fprintf (stderr, "--");
                if (args[i].type == arg_negative_flag)
                    count += fprintf (stderr, "no-");
                count += fprintf (stderr, "%s", args[i].long_name);
                print_arg (buf, sizeof(buf), 0, 1, &args[i]);
                count += fprintf(stderr, "%s", buf);
            }
            while(count++ <= max_len)
                putc (' ', stderr);
            fprintf (stderr, "%s\n", args[i].help);
        }
    }
}

static void
add_string(getarg_strings *s, char *value)
{
    s->strings = realloc(s->strings, (s->num_strings + 1) * sizeof(*s->strings));
    s->strings[s->num_strings] = value;
    s->num_strings++;
}

static int
arg_match_long(struct getargs *args, size_t num_args,
               char *argv, int argc, const char **rargv, int *optind)
{
    unsigned int i;
    const char *optarg = NULL;
    int negate = 0;
    int partial_match = 0;
    struct getargs *partial = NULL;
    struct getargs *current = NULL;
    int argv_len;
    char *p;

    argv_len = strlen(argv);
    p = strchr (argv, '=');
    if (p != NULL)
        argv_len = p - argv;

    for (i = 0; i < num_args; ++i) {
        if(args[i].long_name) {
            int len = strlen(args[i].long_name);
            char *p = argv;
            int p_len = argv_len;
            negate = 0;

            for (;;) {
                if (strncmp (args[i].long_name, p, p_len) == 0) {
                    if(p_len == len)
                        current = &args[i];
                    else {
                        ++partial_match;
                        partial = &args[i];
                    }
                    optarg  = p + p_len;
                } else if (ISFLAG(args[i]) && strncmp (p, "no-", 3) == 0) {
                    negate = !negate;
                    p += 3;
                    p_len -= 3;
                    continue;
                }
                break;
            }
            if (current)
                break;
        }
    }
    if (current == NULL) {
        if (partial_match == 1)
            current = partial;
        else
            return ARG_ERR_NO_MATCH;
    }
    
    if(*optarg == '\0'
       && !ISFLAG(*current)
       && current->type != arg_collect
       && current->type != arg_counter)
        return ARG_ERR_NO_MATCH;
    switch(current->type){
    case arg_integer:
    {
        int tmp;
        if(sscanf(optarg + 1, "%d", &tmp) != 1)
            return ARG_ERR_BAD_ARG;
        *(int*)current->value = tmp;
        return 0;
    }
    case arg_string:
    {
        *(char**)current->value = (char*)optarg + 1;
        return 0;
    }
    case arg_strings:
    {
        add_string((getarg_strings*)current->value, (char*)optarg + 1);
        return 0;
    }
    case arg_flag:
    case arg_negative_flag:
    {
        int *flag = current->value;
        if(*optarg == '\0' ||
           strcmp(optarg + 1, "yes") == 0 || 
           strcmp(optarg + 1, "true") == 0){
            *flag = !negate;
            return 0;
        } else if (*optarg && strcmp(optarg + 1, "maybe") == 0) {
            *flag = rand() & 1;
        } else {
            *flag = negate;
            return 0;
        }
        return ARG_ERR_BAD_ARG;
    }
    case arg_counter :
    {
        int val;

        if (*optarg == '\0')
            val = 1;
        else {
            char *endstr;

            val = strtol (optarg, &endstr, 0);
            if (endstr == optarg)
                return ARG_ERR_BAD_ARG;
        }
        *(int *)current->value += val;
        return 0;
    }
    case arg_double:
    {
        double tmp;
        if(sscanf(optarg + 1, "%lf", &tmp) != 1)
            return ARG_ERR_BAD_ARG;
        *(double*)current->value = tmp;
        return 0;
    }
    case arg_collect:{
        struct getarg_collect_info *c = current->value;
        int o = argv - rargv[*optind];
        return (*c->func)(FALSE, argc, rargv, optind, &o, c->data);
    }

    default:
        abort ();
        return ARG_ERR_BAD_ARG;
    }
}

static int
arg_match_short (struct getargs *args, size_t num_args,
                 char *argv, int argc, const char **rargv, int *optind)
{
    int j, k;

    for(j = 1; j > 0 && j < (int)strlen(rargv[*optind]); j++) {
        for(k = 0; k < (int)num_args; k++) {
            char *optarg;

            if(args[k].short_name == 0)
                continue;
            if(argv[j] == args[k].short_name) {
                if(args[k].type == arg_flag) {
                    *(int*)args[k].value = 1;
                    break;
                }
                if(args[k].type == arg_negative_flag) {
                    *(int*)args[k].value = 0;
                    break;
                } 
                if(args[k].type == arg_counter) {
                    ++*(int *)args[k].value;
                    break;
                }
                if(args[k].type == arg_collect) {
                    struct getarg_collect_info *c = args[k].value;

                    if((*c->func)(TRUE, argc, rargv, optind, &j, c->data))
                        return ARG_ERR_BAD_ARG;
                    break;
                }

                if(argv[j + 1])
                    optarg = &argv[j + 1];
                else {
                    ++*optind;
                    optarg = (char *) rargv[*optind];
                }
                if(optarg == NULL) {
                    --*optind;
                    return ARG_ERR_NO_ARG;
                }
                if(args[k].type == arg_integer) {
                    int tmp;
                    if(sscanf(optarg, "%d", &tmp) != 1)
                        return ARG_ERR_BAD_ARG;
                    *(int*)args[k].value = tmp;
                    return 0;
                } else if(args[k].type == arg_string) {
                    *(char**)args[k].value = optarg;
                    return 0;
                } else if(args[k].type == arg_strings) {
                    add_string((getarg_strings*)args[k].value, optarg);
                    return 0;
                } else if(args[k].type == arg_double) {
                    double tmp;
                    if(sscanf(optarg, "%lf", &tmp) != 1)
                        return ARG_ERR_BAD_ARG;
                    *(double*)args[k].value = tmp;
                    return 0;
                }
                return ARG_ERR_BAD_ARG;
            }
        }
        if (k == (int)num_args)
            return ARG_ERR_NO_MATCH;
    }
    return 0;
}

int
getarg(struct getargs *args, size_t num_args, 
       int argc, const char **argv, int *optind)
{
    int i;
    int ret = 0;

    srand ((unsigned int)time(NULL));
    (*optind)++;
    for(i = *optind; i < argc; i++) {
        if(argv[i][0] != '-')
            break;
        if(argv[i][1] == '-'){
            if(argv[i][2] == 0){
                i++;
                break;
            }
            ret = arg_match_long (args, num_args, (char *) argv[i] + 2, 
                                  argc, argv, &i);
        } else {
            ret = arg_match_short (args, num_args, (char *) argv[i],
                                   argc, argv, &i);
        }
        if(ret)
            break;
    }
    *optind = i;
    return ret;
}


#if TEST
int foo_flag = 2;
int flag1 = 0;
int flag2 = 0;
int bar_int;
char *baz_string;

struct getargs args[] = {
    { NULL, '1', arg_flag, &flag1, "one", NULL },
    { NULL, '2', arg_flag, &flag2, "two", NULL },
    { "foo", 'f', arg_negative_flag, &foo_flag, "foo", NULL },
    { "bar", 'b', arg_integer, &bar_int, "bar", "seconds"},
    { "baz", 'x', arg_string, &baz_string, "baz", "name" },
};

int main(int argc, char **argv)
{
    int optind = 0;
    while(getarg(args, 5, argc, argv, &optind))
        printf("Bad arg: %s\n", argv[optind]);
    printf("flag1 = %d\n", flag1);  
    printf("flag2 = %d\n", flag2);  
    printf("foo_flag = %d\n", foo_flag);  
    printf("bar_int = %d\n", bar_int);
    printf("baz_flag = %s\n", baz_string);
    arg_printusage (args, 5, argv[0], "nothing here");
}
#endif