misc/options.c

   1 /*
   2  * Option parsing
   3  *
   4  * Copyright 2000 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "config.h"
  22 #include <stdarg.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25
  26 #include "windef.h"
  27 #include "winbase.h"
  28 #include "winnls.h"
  29 #include "winreg.h"
  30 #include "winternl.h"
  31 #include "wine/library.h"
  32 #include "options.h"
  33 #include "module.h"
  34 #include "wine/debug.h"
  35
  36 struct option_descr
  37 {
  38     const char *longname;
  39     char        shortname;
  40     int         has_arg;
  41     int         inherit;
  42     void      (*func)( const char *arg );
  43     const char *usage;
  44 };
  45
  46 static char *inherit_str;  /* options to pass to child processes */
  47
  48 static void DECLSPEC_NORETURN out_of_memory(void);
  49 static void out_of_memory(void)
  50 {
  51     MESSAGE( "Virtual memory exhausted\n" );
  52     ExitProcess(1);
  53 }
  54
  55 static void do_debugmsg( const char *arg );
  56 static void do_dll( const char *arg );
  57 static void do_help( const char *arg );
  58 static void do_version( const char *arg );
  59
  60 static const struct option_descr option_table[] =
  61 {
  62     { "debugmsg",     0, 1, 1, do_debugmsg,
  63       "--debugmsg name  Turn debugging-messages on or off" },
  64     { "dll",          0, 1, 1, do_dll,
  65       "--dll name       This option is no longer supported" },
  66     { "help",       'h', 0, 0, do_help,
  67       "--help,-h        Show this help message" },
  68     { "version",    'v', 0, 0, do_version,
  69       "--version,-v     Display the Wine version" },
  70     { NULL,           0, 0, 0, NULL, NULL }  /* terminator */
  71 };
  72
  73
  74 static void do_help( const char *arg )
  75 {
  76     OPTIONS_Usage();
  77 }
  78
  79 static void do_version( const char *arg )
  80 {
  81     MESSAGE( "%s\n", PACKAGE_STRING );
  82     ExitProcess(0);
  83 }
  84
  85 static void do_debugmsg( const char *arg )
  86 {
  87     if (wine_dbg_parse_options( arg ))
  88     {
  89         MESSAGE("wine: Syntax: --debugmsg [class]+xxx,...  or -debugmsg [class]-xxx,...\n");
  90         MESSAGE("Example: --debugmsg +all,warn-heap\n"
  91                 "  turn on all messages except warning heap messages\n");
  92         MESSAGE("Available message classes: err, warn, fixme, trace\n\n");
  93         ExitProcess(1);
  94     }
  95 }
  96
  97 static void do_dll( const char *arg )
  98 {
  99     MESSAGE("The --dll option has been removed, you should use\n"
 100             "the WINEDLLOVERRIDES environment variable instead.\n"
 101             "To see a help message, run:\n"
 102             "    WINEDLLOVERRIDES=help wine <program.exe>\n");
 103     ExitProcess(1);
 104 }
 105
 106 static void remove_options( char *argv[], int pos, int count, int inherit )
 107 {
 108     if (inherit)
 109     {
 110         int i, len = 0;
 111         for (i = 0; i < count; i++) len += strlen(argv[pos+i]) + 1;
 112         if (inherit_str)
 113         {
 114             if (!(inherit_str = realloc( inherit_str, strlen(inherit_str) + 1 + len )))
 115                 out_of_memory();
 116             strcat( inherit_str, " " );
 117         }
 118         else
 119         {
 120             if (!(inherit_str = malloc( len ))) out_of_memory();
 121             inherit_str[0] = 0;
 122         }
 123         for (i = 0; i < count; i++)
 124         {
 125             strcat( inherit_str, argv[pos+i] );
 126             if (i < count-1) strcat( inherit_str, " " );
 127         }
 128     }
 129     while ((argv[pos] = argv[pos+count])) pos++;
 130 }
 131
 132 /* parse options from the argv array and remove all the recognized ones */
 133 static void parse_options( char *argv[] )
 134 {
 135     const struct option_descr *opt;
 136     int i;
 137
 138     for (i = 0; argv[i]; i++)
 139     {
 140         const char *equalarg = NULL;
 141         char *p = argv[i];
 142         if (*p++ != '-') continue;  /* not an option */
 143         if (*p && !p[1]) /* short name */
 144         {
 145             if (*p == '-') break; /* "--" option */
 146             for (opt = option_table; opt->longname; opt++) if (opt->shortname == *p) break;
 147         }
 148         else  /* long name */
 149         {
 150             const char *equal = strchr  (p, '=');
 151             if (*p == '-') p++;
 152             /* check for the long name */
 153             for (opt = option_table; opt->longname; opt++) {
 154                 /* Plain --option */
 155                 if (!strcmp( p, opt->longname )) break;
 156
 157                 /* --option=value */
 158                 if (opt->has_arg &&
 159                     equal &&
 160                     strlen (opt->longname) == equal - p &&
 161                     !strncmp (p, opt->longname, equal - p)) {
 162                         equalarg = equal + 1;
 163                         break;
 164                     }
 165             }
 166         }
 167         if (!opt->longname) continue;
 168
 169         if (equalarg)
 170         {
 171             opt->func( equalarg );
 172             remove_options( argv, i, 1, opt->inherit );
 173         }
 174         else if (opt->has_arg && argv[i+1])
 175         {
 176             opt->func( argv[i+1] );
 177             remove_options( argv, i, 2, opt->inherit );
 178         }
 179         else
 180         {
 181             opt->func( "" );
 182             remove_options( argv, i, 1, opt->inherit );
 183         }
 184         i--;
 185     }
 186 }
 187
 188 /* inherit options from WINEOPTIONS variable */
 189 static void inherit_options( char *buffer )
 190 {
 191     char *argv[256];
 192     unsigned int n;
 193
 194     char *p = strtok( buffer, " \t" );
 195     for (n = 0; n < sizeof(argv)/sizeof(argv[0])-1 && p; n++)
 196     {
 197         argv[n] = p;
 198         p = strtok( NULL, " \t" );
 199     }
 200     argv[n] = NULL;
 201     parse_options( argv );
 202     if (argv[0])  /* an option remains */
 203     {
 204         MESSAGE( "Unknown option '%s' in WINEOPTIONS variable\n\n", argv[0] );
 205         OPTIONS_Usage();
 206     }
 207 }
 208
 209 /***********************************************************************
 210  *              OPTIONS_Usage
 211  */
 212 void OPTIONS_Usage(void)
 213 {
 214     const struct option_descr *opt;
 215     MESSAGE( "%s\n\n", PACKAGE_STRING );
 216     MESSAGE( "Usage: wine [options] [--] program_name [arguments]\n" );
 217     MESSAGE("The -- has to be used if you specify arguments (of the program)\n\n");
 218     MESSAGE( "Options:\n" );
 219     for (opt = option_table; opt->longname; opt++) MESSAGE( "   %s\n", opt->usage );
 220     ExitProcess(0);
 221 }
 222
 223 /***********************************************************************
 224  *              OPTIONS_ParseOptions
 225  */
 226 void OPTIONS_ParseOptions( char *argv[] )
 227 {
 228     char buffer[1024];
 229     int i;
 230
 231     if (GetEnvironmentVariableA( "WINEOPTIONS", buffer, sizeof(buffer) ) && buffer[0])
 232         inherit_options( buffer );
 233     if (!argv) return;
 234
 235     parse_options( argv + 1 );
 236
 237     SetEnvironmentVariableA( "WINEOPTIONS", inherit_str );
 238
 239     /* check if any option remains */
 240     for (i = 1; argv[i]; i++)
 241     {
 242         if (!strcmp( argv[i], "--" ))
 243         {
 244             remove_options( argv, i, 1, 0 );
 245             break;
 246         }
 247         if (argv[i][0] == '-')
 248         {
 249             MESSAGE( "Unknown option '%s'\n\n", argv[i] );
 250             OPTIONS_Usage();
 251         }
 252     }
 253 }