~drizzle-trunk/drizzle/development

/* Copyright (C) 2002-2006 MySQL AB

   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; version 2 of the License.

   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, write to the Free Software

   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA */

#include "config.h"

#include "drizzled/internal/my_sys.h"

#include <drizzled/gettext.h>

#include "drizzled/internal/m_string.h"

#include "drizzled/internal/my_sys.h"

#include "drizzled/error.h"

#include "drizzled/option.h"

#include <stdio.h>

#include <stdlib.h>

#include <errno.h>

#include <iostream>

#include <algorithm>

using namespace std;

namespace drizzled

{

  typedef void (*init_func_p)(const struct option *option, char **variable,

      int64_t value);

  void default_reporter(enum loglevel level, const char *format, ...);

  my_error_reporter my_getopt_error_reporter= &default_reporter;

  static int findopt(char *optpat, uint32_t length,

      const struct option **opt_res,

      char **ffname);

  static int64_t getopt_ll(char *arg, const struct option *optp, int *err);

  static uint64_t getopt_ull(char *arg, const struct option *optp,

      int *err);

  static size_t getopt_size(char *arg, const struct option *optp, int *err);

  static double getopt_double(char *arg, const struct option *optp, int *err);

  static void init_variables(const struct option *options,

      init_func_p init_one_value);

  static void init_one_value(const struct option *option, char **variable,

      int64_t value);

  static void fini_one_value(const struct option *option, char **variable,

      int64_t value);

  static int setval(const struct option *opts, char* *value, char *argument,

      bool set_maximum_value);

  static char *check_struct_option(char *cur_arg, char *key_name);

  /*

     The following three variables belong to same group and the number and

     order of their arguments must correspond to each other.

   */

  static const char *special_opt_prefix[]=

  {"skip", "disable", "enable", "maximum", "loose", 0};

  static const uint32_t special_opt_prefix_lengths[]=

  { 4,      7,         6,        7,         5,      0};

  enum enum_special_opt

  { OPT_SKIP, OPT_DISABLE, OPT_ENABLE, OPT_MAXIMUM, OPT_LOOSE};

  char *disabled_my_option= (char*) "0";

  /*

     This is a flag that can be set in client programs. 1 means that

     my_getopt will skip over options it does not know how to handle.

   */

  bool my_getopt_skip_unknown= 0;

  void default_reporter(enum loglevel level, const char *format, ...)

  {

    va_list args;

    va_start(args, format);

    if (level == WARNING_LEVEL)

      fprintf(stderr, "%s", _("Warning: "));

    else if (level == INFORMATION_LEVEL)

      fprintf(stderr, "%s", _("Info: "));

    vfprintf(stderr, format, args);

    va_end(args);

    fputc('\n', stderr);

    fflush(stderr);

  }

  /*

function: handle_options

Sort options; put options first, until special end of options (--), or

until end of argv. Parse options; check that the given option matches with

one of the options in struct 'option', return error in case of ambiguous

or unknown option. Check that option was given an argument if it requires

one. Call function 'get_one_option()' once for each option.

   */

  static getopt_get_addr_func getopt_get_addr;

  int handle_options(int *argc, char ***argv,

      const struct option *longopts,

      my_get_one_option get_one_option)

  {

    uint32_t opt_found, argvpos= 0, length;

    bool end_of_options= 0, must_be_var, set_maximum_value=false,

         option_is_loose;

    char **pos, **pos_end, *optend, *prev_found=NULL,

         *opt_str, key_name[FN_REFLEN];

    const struct option *optp;

    char* *value;

    int error, i;

    /* handle_options() assumes arg0 (program name) always exists */

    assert(argc && *argc >= 1);

    assert(argv && *argv);

    (*argc)--; /* Skip the program name */

    (*argv)++; /*      --- || ----      */

    init_variables(longopts, init_one_value);

    for (pos= *argv, pos_end=pos+ *argc; pos != pos_end ; pos++)

    {

      char **first= pos;

      char *cur_arg= *pos;

      if (cur_arg[0] == '-' && cur_arg[1] && !end_of_options) /* must be opt */

      {

        char *argument=    0;

        must_be_var=       0;

        set_maximum_value= 0;

        option_is_loose=   0;

        cur_arg++;  /* skip '-' */

        if (*cur_arg == '-' || *cur_arg == 'O') /* check for long option, */

        {                                       /* --set-variable, or -O  */

          if (*cur_arg == 'O')

          {

            must_be_var= 1;

            if (!(*++cur_arg))	/* If not -Ovar=# */

            {

              /* the argument must be in next argv */

              if (!*++pos)

              {

                my_getopt_error_reporter(ERROR_LEVEL,

                    "%s: Option '-O' requires an argument",

                    internal::my_progname);

                return EXIT_ARGUMENT_REQUIRED;

              }

              cur_arg= *pos;

              (*argc)--;

            }

          }

          else if (!getopt_compare_strings(cur_arg, "-set-variable", 13))

          {

            must_be_var= 1;

            if (cur_arg[13] == '=')

            {

              cur_arg+= 14;

              if (!*cur_arg)

              {

                my_getopt_error_reporter(ERROR_LEVEL,

                    "%s: Option '--set-variable' requires an argument",

                    internal::my_progname);

                return EXIT_ARGUMENT_REQUIRED;

              }

            }

            else if (cur_arg[14]) /* garbage, or another option. break out */

              must_be_var= 0;

            else

            {

              /* the argument must be in next argv */

              if (!*++pos)

              {

                my_getopt_error_reporter(ERROR_LEVEL,

                    "%s: Option '--set-variable' requires an argument",

                    internal::my_progname);

                return EXIT_ARGUMENT_REQUIRED;

              }

              cur_arg= *pos;

              (*argc)--;

            }

          }

          else if (!must_be_var)

          {

            if (!*++cur_arg)	/* skip the double dash */

            {

              /* '--' means end of options, look no further */

              end_of_options= 1;

              (*argc)--;

              continue;

            }

          }

          opt_str= check_struct_option(cur_arg, key_name);

          optend= strchr(opt_str, '=');

          if (optend != NULL)

          {

            length= (uint32_t) (optend - opt_str);

            optend++;

          }

          else

          {

            length= static_cast<uint32_t>(strlen(opt_str));

            optend= 0;

          }

          /*

             Find first the right option. Return error in case of an ambiguous,

             or unknown option

           */

          optp= longopts;

          if (!(opt_found= findopt(opt_str, length, &optp, &prev_found)))

          {

            /*

               Didn't find any matching option. Let's see if someone called

               option with a special option prefix

             */

            if (!must_be_var)

            {

              if (optend)

                must_be_var= 1; /* option is followed by an argument */

              for (i= 0; special_opt_prefix[i]; i++)

              {

                if (!getopt_compare_strings(special_opt_prefix[i], opt_str,

                      special_opt_prefix_lengths[i]) &&

                    (opt_str[special_opt_prefix_lengths[i]] == '-' ||

                     opt_str[special_opt_prefix_lengths[i]] == '_'))

                {

                  /*

                     We were called with a special prefix, we can reuse opt_found

                   */

                  opt_str+= special_opt_prefix_lengths[i] + 1;

                  length-= special_opt_prefix_lengths[i] + 1;

                  if (i == OPT_LOOSE)

                    option_is_loose= 1;

                  if ((opt_found= findopt(opt_str, length, &optp, &prev_found)))

                  {

                    if (opt_found > 1)

                    {

                      my_getopt_error_reporter(ERROR_LEVEL,

                          "%s: ambiguous option '--%s-%s' (--%s-%s)",

                          internal::my_progname,

                          special_opt_prefix[i],

                          cur_arg, special_opt_prefix[i],

                          prev_found);

                      return EXIT_AMBIGUOUS_OPTION;

                    }

                    switch (i) {

                      case OPT_SKIP:

                      case OPT_DISABLE: /* fall through */

                        /*

                           double negation is actually enable again,

                           for example: --skip-option=0 -> option = true

                         */

                        optend= (optend && *optend == '0' && !(*(optend + 1))) ?

                          (char*) "1" : disabled_my_option;

                        break;

                      case OPT_ENABLE:

                        optend= (optend && *optend == '0' && !(*(optend + 1))) ?

                          disabled_my_option : (char*) "1";

                        break;

                      case OPT_MAXIMUM:

                        set_maximum_value= true;

                        must_be_var= true;

                        break;

                    }

                    break; /* break from the inner loop, main loop continues */

                  }

                  i= -1; /* restart the loop */

                }

              }

            }

            if (!opt_found)

            {

              if (my_getopt_skip_unknown)

              {

                /*

                   preserve all the components of this unknown option, this may

                   occurr when the user provides options like: "-O foo" or

                   "--set-variable foo" (note that theres a space in there)

                   Generally, these kind of options are to be avoided

                 */

                do {

                  (*argv)[argvpos++]= *first++;

                } while (first <= pos);

                continue;

              }

              if (must_be_var)

              {

                my_getopt_error_reporter(option_is_loose ?

                    WARNING_LEVEL : ERROR_LEVEL,

                    "%s: unknown variable '%s'",

                    internal::my_progname, cur_arg);

                if (!option_is_loose)

                  return EXIT_UNKNOWN_VARIABLE;

              }

              else

              {

                my_getopt_error_reporter(option_is_loose ?

                    WARNING_LEVEL : ERROR_LEVEL,

                    "%s: unknown option '--%s'",

                    internal::my_progname, cur_arg);

                if (!option_is_loose)

                  return EXIT_UNKNOWN_OPTION;

              }

              if (option_is_loose)

              {

                (*argc)--;

                continue;

              }

            }

          }

          if (opt_found > 1)

          {

            if (must_be_var)

            {

              my_getopt_error_reporter(ERROR_LEVEL,

                  "%s: variable prefix '%s' is not unique",

                  internal::my_progname, opt_str);

              return EXIT_VAR_PREFIX_NOT_UNIQUE;

            }

            else

            {

              my_getopt_error_reporter(ERROR_LEVEL,

                  "%s: ambiguous option '--%s' (%s, %s)",

                  internal::my_progname, opt_str, prev_found,

                  optp->name);

              return EXIT_AMBIGUOUS_OPTION;

            }

          }

          if ((optp->var_type & GET_TYPE_MASK) == GET_DISABLED)

          {

            fprintf(stderr,

                _("%s: %s: Option '%s' used, but is disabled\n"),

                internal::my_progname,

                option_is_loose ? _("WARNING") : _("ERROR"), opt_str);

            if (option_is_loose)

            {

              (*argc)--;

              continue;

            }

            return EXIT_OPTION_DISABLED;

          }

          if (must_be_var && (optp->var_type & GET_TYPE_MASK) == GET_NO_ARG)

          {

            my_getopt_error_reporter(ERROR_LEVEL,

                "%s: option '%s' cannot take an argument",

                internal::my_progname, optp->name);

            return EXIT_NO_ARGUMENT_ALLOWED;

          }

          value= optp->var_type & GET_ASK_ADDR ?

            (*getopt_get_addr)(key_name, (uint32_t) strlen(key_name), optp) : optp->value;

          if (optp->arg_type == NO_ARG)

          {

            if (optend && (optp->var_type & GET_TYPE_MASK) != GET_BOOL)

            {

              my_getopt_error_reporter(ERROR_LEVEL,

                  "%s: option '--%s' cannot take an argument",

                  internal::my_progname, optp->name);

              return EXIT_NO_ARGUMENT_ALLOWED;

            }

            if ((optp->var_type & GET_TYPE_MASK) == GET_BOOL)

            {

              /*

                 Set bool to 1 if no argument or if the user has used

                 --enable-'option-name'.

               *optend was set to '0' if one used --disable-option

               */

              (*argc)--;

              if (!optend || *optend == '1' ||

                  !my_strcasecmp(&my_charset_utf8_general_ci, optend, "true"))

                *((bool*) value)= (bool) 1;

              else if (*optend == '0' ||

                  !my_strcasecmp(&my_charset_utf8_general_ci, optend, "false"))

                *((bool*) value)= (bool) 0;

              else

              {

                my_getopt_error_reporter(WARNING_LEVEL,

                    "%s: ignoring option '--%s' due to "

                    "invalid value '%s'",

                    internal::my_progname,

                    optp->name, optend);

                continue;

              }

              error= get_one_option(optp->id, optp, *((bool*) value) ?

                                    (char*) "1" : disabled_my_option);

              if (error != 0)

                return error;

              else

                continue;

            }

            argument= optend;

          }

          else if (optp->arg_type == OPT_ARG &&

              (optp->var_type & GET_TYPE_MASK) == GET_BOOL)

          {

            if (optend == disabled_my_option)

              *((bool*) value)= (bool) 0;

            else

            {

              if (!optend) /* No argument -> enable option */

                *((bool*) value)= (bool) 1;

              else

                argument= optend;

            }

          }

          else if (optp->arg_type == REQUIRED_ARG && !optend)

          {

            /* Check if there are more arguments after this one */

            if (!*++pos)

            {

              my_getopt_error_reporter(ERROR_LEVEL,

                  "%s: option '--%s' requires an argument",

                  internal::my_progname, optp->name);

              return EXIT_ARGUMENT_REQUIRED;

            }

            argument= *pos;

            (*argc)--;

          }

          else

            argument= optend;

        }

        else  /* must be short option */

        {

          for (optend= cur_arg; *optend; optend++)

          {

            opt_found= 0;

            for (optp= longopts; optp->id; optp++)

            {

              if (optp->id == (int) (unsigned char) *optend)

              {

                /* Option recognized. Find next what to do with it */

                opt_found= 1;

                if ((optp->var_type & GET_TYPE_MASK) == GET_DISABLED)

                {

                  fprintf(stderr,

                      _("%s: ERROR: Option '-%c' used, but is disabled\n"),

                      internal::my_progname, optp->id);

                  return EXIT_OPTION_DISABLED;

                }

                if ((optp->var_type & GET_TYPE_MASK) == GET_BOOL &&

                    optp->arg_type == NO_ARG)

                {

                  *((bool*) optp->value)= (bool) 1;

                  error= get_one_option(optp->id, optp, argument);

                  if (error != 0)

                    return error;

                  else

                    continue;

                }

                else if (optp->arg_type == REQUIRED_ARG ||

                    optp->arg_type == OPT_ARG)

                {

                  if (*(optend + 1))

                  {

                    /* The rest of the option is option argument */

                    argument= optend + 1;

                    /* This is in effect a jump out of the outer loop */

                    optend= (char*) " ";

                  }

                  else

                  {

                    if (optp->arg_type == OPT_ARG)

                    {

                      if (optp->var_type == GET_BOOL)

                        *((bool*) optp->value)= (bool) 1;

                      error= get_one_option(optp->id, optp, argument);

                      if (error != 0)

                        return error;

                      else

                        continue;

                    }

                    /* Check if there are more arguments after this one */

                    if (!pos[1])

                    {

                      my_getopt_error_reporter(ERROR_LEVEL,

                          "%s: option '-%c' requires "

                          "an argument",

                          internal::my_progname, optp->id);

                      return EXIT_ARGUMENT_REQUIRED;

                    }

                    argument= *++pos;

                    (*argc)--;

                    /* the other loop will break, because *optend + 1 == 0 */

                  }

                }

                if ((error= setval(optp, optp->value, argument,

                        set_maximum_value)))

                {

                  my_getopt_error_reporter(ERROR_LEVEL,

                      "%s: Error while setting value '%s' "

                      "to '%s'",

                      internal::my_progname,

                      argument, optp->name);

                  return error;

                }

                error= get_one_option(optp->id, optp, argument);

                if (error != 0)

                  return error;

                else

                  break;

              }

            }

            if (!opt_found)

            {

              my_getopt_error_reporter(ERROR_LEVEL,

                  "%s: unknown option '-%c'",

                  internal::my_progname, *optend);

              return EXIT_UNKNOWN_OPTION;

            }

          }

          (*argc)--; /* option handled (short), decrease argument count */

          continue;

        }

        if ((error= setval(optp, value, argument, set_maximum_value)))

        {

          my_getopt_error_reporter(ERROR_LEVEL,

              "%s: Error while setting value '%s' to '%s'",

              internal::my_progname, argument, optp->name);

          return error;

        }

        error= get_one_option(optp->id, optp, argument);

        if (error != 0)

          return error;

        (*argc)--; /* option handled (short or long), decrease argument count */

      }

      else /* non-option found */

        (*argv)[argvpos++]= cur_arg;

    }

    /*

       Destroy the first, already handled option, so that programs that look

       for arguments in 'argv', without checking 'argc', know when to stop.

       Items in argv, before the destroyed one, are all non-option -arguments

       to the program, yet to be (possibly) handled.

     */

    (*argv)[argvpos]= 0;

    return 0;

  }

  /*

function: check_struct_option

Arguments: Current argument under processing from argv and a variable

where to store the possible key name.

Return value: In case option is a struct option, returns a pointer to

the current argument at the position where the struct option (key_name)

ends, the next character after the dot. In case argument is not a struct

option, returns a pointer to the argument.

key_name will hold the name of the key, or 0 if not found.

   */

  static char *check_struct_option(char *cur_arg, char *key_name)

  {

    char *ptr, *end;

    ptr= NULL; //Options with '.' are now supported.

    end= strrchr(cur_arg, '=');

    /*

       If the first dot is after an equal sign, then it is part

       of a variable value and the option is not a struct option.

       Also, if the last character in the string before the ending

       NULL, or the character right before equal sign is the first

       dot found, the option is not a struct option.

     */

    if ((ptr != NULL) && (end != NULL) && (end - ptr > 1))

    {

      uint32_t len= (uint32_t) (ptr - cur_arg);

      set_if_smaller(len, (uint32_t)FN_REFLEN-1);

      strncpy(key_name, cur_arg, len);

      return ++ptr;

    }

    key_name[0]= 0;

    return cur_arg;

  }

  /*

function: setval

Arguments: opts, argument

Will set the option value to given value

   */

  static int setval(const struct option *opts, char **value, char *argument,

      bool set_maximum_value)

  {

    int err= 0;

    if (value && argument)

    {

      char* *result_pos= ((set_maximum_value) ?

          opts->u_max_value : value);

      if (!result_pos)

        return EXIT_NO_PTR_TO_VARIABLE;

      switch ((opts->var_type & GET_TYPE_MASK)) {

        case GET_BOOL: /* If argument differs from 0, enable option, else disable */

          *((bool*) result_pos)= (bool) atoi(argument) != 0;

          break;

        case GET_INT:

          *((int32_t*) result_pos)= (int) getopt_ll(argument, opts, &err);

          break;

        case GET_UINT:

        case GET_UINT32:

          *((uint32_t*) result_pos)= (uint32_t) getopt_ull(argument, opts, &err);

          break;

        case GET_ULONG_IS_FAIL:

          *((ulong*) result_pos)= (ulong) getopt_ull(argument, opts, &err);

          break;

        case GET_LONG:

          *((long*) result_pos)= (long) getopt_ll(argument, opts, &err);

          break;

        case GET_LL:

          *((int64_t*) result_pos)= getopt_ll(argument, opts, &err);

          break;

        case GET_ULL:

        case GET_UINT64:

          *((uint64_t*) result_pos)= getopt_ull(argument, opts, &err);

          break;

        case GET_SIZE:

          *((size_t*) result_pos)= getopt_size(argument, opts, &err);

          break;

        case GET_DOUBLE:

          *((double*) result_pos)= getopt_double(argument, opts, &err);

          break;

        case GET_STR:

          *((char**) result_pos)= argument;

          break;

        case GET_STR_ALLOC:

          if ((*((char**) result_pos)))

            free((*(char**) result_pos));

          if (!(*((char**) result_pos)= strdup(argument)))

            return EXIT_OUT_OF_MEMORY;

          break;

        case GET_ENUM:

          if (((*(int*)result_pos)= find_type(argument, opts->typelib, 2) - 1) < 0)

            return EXIT_ARGUMENT_INVALID;

          break;

        case GET_SET:

          *((uint64_t*)result_pos)= find_typeset(argument, opts->typelib, &err);

          if (err)

            return EXIT_ARGUMENT_INVALID;

          break;

        default:    /* dummy default to avoid compiler warnings */

          break;

      }

      if (err)

        return EXIT_UNKNOWN_SUFFIX;

    }

    return 0;

  }

  /*

     Find option

     SYNOPSIS

     findopt()

     optpat	Prefix of option to find (with - or _)

     length	Length of optpat

     opt_res	Options

     ffname	Place for pointer to first found name

     IMPLEMENTATION

     Go through all options in the option struct. Return number

     of options found that match the pattern and in the argument

     list the option found, if any. In case of ambiguous option, store

     the name in ffname argument

     RETURN

     0    No matching options

#   Number of matching options

ffname points to first matching option

   */

  static int findopt(char *optpat, uint32_t length,

      const struct option **opt_res,

      char **ffname)

  {

    uint32_t count;

    struct option *opt= (struct option *) *opt_res;

    for (count= 0; opt->name; opt++)

    {

      if (!getopt_compare_strings(opt->name, optpat, length)) /* match found */

      {

        (*opt_res)= opt;

        if (!opt->name[length])		/* Exact match */

          return 1;

        if (!count)

        {

          count= 1;

          *ffname= (char *) opt->name;	/* We only need to know one prev */

        }

        else if (strcmp(*ffname, opt->name))

        {

          /*

             The above test is to not count same option twice

             (see mysql.cc, option "help")

           */

          count++;

        }

      }

    }

    return count;

  }

  /*

function: compare_strings

Works like strncmp, other than 1.) considers '-' and '_' the same.

2.) Returns -1 if strings differ, 0 if they are equal

   */

  bool getopt_compare_strings(register const char *s, register const char *t,

      uint32_t length)

  {

    char const *end= s + length;

    for (;s != end ; s++, t++)

    {

      if ((*s != '-' ? *s : '_') != (*t != '-' ? *t : '_'))

        return 1;

    }

    return 0;

  }

  /*

function: eval_num_suffix

Transforms a number with a suffix to real number. Suffix can

be k|K for kilo, m|M for mega or g|G for giga.

   */

  static int64_t eval_num_suffix(char *argument, int *error, char *option_name)

  {

    char *endchar;

    int64_t num;

    *error= 0;

    errno= 0;

    num= strtoll(argument, &endchar, 10);

    if (errno == ERANGE)

    {

      my_getopt_error_reporter(ERROR_LEVEL,

          "Incorrect integer value: '%s'", argument);

      *error= 1;

      return 0;

    }

    if (*endchar == 'k' || *endchar == 'K')

      num*= 1024L;

    else if (*endchar == 'm' || *endchar == 'M')

      num*= 1024L * 1024L;

    else if (*endchar == 'g' || *endchar == 'G')

      num*= 1024L * 1024L * 1024L;

    else if (*endchar)

    {

      fprintf(stderr,

          _("Unknown suffix '%c' used for variable '%s' (value '%s')\n"),

          *endchar, option_name, argument);

      *error= 1;

      return 0;