X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/14f355c2b5c71fc7c3d680aea366582d2ac60f7b..ce7208d49d5ce2ca1dc0b3b83f14f1d04f29c4bf:/src/common/cmdline.cpp diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp index dc3a857e66..6a07dfb1a7 100644 --- a/src/common/cmdline.cpp +++ b/src/common/cmdline.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: common/cmdline.cpp +// Name: src/common/cmdline.cpp // Purpose: wxCmdLineParser implementation // Author: Vadim Zeitlin // Modified by: @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "cmdline.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,23 +24,23 @@ #pragma hdrstop #endif -#include "wx/cmdline.h" - -#if wxUSE_CMDLINE_PARSER - #ifndef WX_PRECOMP + #include "wx/dynarray.h" #include "wx/string.h" #include "wx/log.h" #include "wx/intl.h" #include "wx/app.h" - #include "wx/dynarray.h" - #include "wx/filefn.h" #endif //WX_PRECOMP +#include "wx/cmdline.h" + +#if wxUSE_CMDLINE_PARSER + #include #include "wx/datetime.h" #include "wx/msgout.h" +#include "wx/filename.h" // ---------------------------------------------------------------------------- // private functions @@ -86,7 +82,7 @@ struct wxCmdLineOption GetLongOptionName(lng).Len() == lng.Len(), wxT("Long option contains invalid characters") ); - + kind = k; @@ -97,7 +93,7 @@ struct wxCmdLineOption type = typ; flags = fl; - m_hasVal = FALSE; + m_hasVal = false; } // can't use union easily here, so just store all possible data fields, we @@ -120,15 +116,15 @@ struct wxCmdLineOption #endif // wxUSE_DATETIME void SetLongVal(long val) - { Check(wxCMD_LINE_VAL_NUMBER); m_longVal = val; m_hasVal = TRUE; } + { Check(wxCMD_LINE_VAL_NUMBER); m_longVal = val; m_hasVal = true; } void SetStrVal(const wxString& val) - { Check(wxCMD_LINE_VAL_STRING); m_strVal = val; m_hasVal = TRUE; } + { Check(wxCMD_LINE_VAL_STRING); m_strVal = val; m_hasVal = true; } #if wxUSE_DATETIME - void SetDateVal(const wxDateTime val) - { Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = TRUE; } + void SetDateVal(const wxDateTime& val) + { Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = true; } #endif // wxUSE_DATETIME - void SetHasValue(bool hasValue = TRUE) { m_hasVal = hasValue; } + void SetHasValue(bool hasValue = true) { m_hasVal = hasValue; } bool HasValue() const { return m_hasVal; } public: @@ -170,15 +166,15 @@ WX_DECLARE_OBJARRAY(wxCmdLineParam, wxArrayParams); #include "wx/arrimpl.cpp" -WX_DEFINE_OBJARRAY(wxArrayOptions); -WX_DEFINE_OBJARRAY(wxArrayParams); +WX_DEFINE_OBJARRAY(wxArrayOptions) +WX_DEFINE_OBJARRAY(wxArrayParams) // the parser internal state struct wxCmdLineParserData { // options wxString m_switchChars; // characters which may start an option - bool m_enableLongOptions; // TRUE if long options are enabled + bool m_enableLongOptions; // true if long options are enabled wxString m_logo; // some extra text to show in Usage() // cmd line data @@ -189,7 +185,10 @@ struct wxCmdLineParserData // methods wxCmdLineParserData(); + void SetArguments(int argc, char **argv); +#if wxUSE_UNICODE void SetArguments(int argc, wxChar **argv); +#endif // wxUSE_UNICODE void SetArguments(const wxString& cmdline); int FindOption(const wxString& name); @@ -206,7 +205,7 @@ struct wxCmdLineParserData wxCmdLineParserData::wxCmdLineParserData() { - m_enableLongOptions = TRUE; + m_enableLongOptions = true; #ifdef __UNIX_LIKE__ m_switchChars = _T("-"); #else // !Unix @@ -214,6 +213,18 @@ wxCmdLineParserData::wxCmdLineParserData() #endif } +void wxCmdLineParserData::SetArguments(int argc, char **argv) +{ + m_arguments.clear(); + + for ( int n = 0; n < argc; n++ ) + { + m_arguments.push_back(wxString::FromAscii(argv[n])); + } +} + +#if wxUSE_UNICODE + void wxCmdLineParserData::SetArguments(int argc, wxChar **argv) { m_arguments.clear(); @@ -224,11 +235,16 @@ void wxCmdLineParserData::SetArguments(int argc, wxChar **argv) } } +#endif // wxUSE_UNICODE + void wxCmdLineParserData::SetArguments(const wxString& cmdLine) { m_arguments.clear(); - m_arguments.push_back(wxTheApp->GetAppName()); + if(wxTheApp && wxTheApp->argc > 0) + m_arguments.push_back(wxTheApp->argv[0]); + else + m_arguments.push_back(wxEmptyString); wxArrayString args = wxCmdLineParser::ConvertStringToArgs(cmdLine); @@ -277,11 +293,20 @@ void wxCmdLineParser::Init() m_data = new wxCmdLineParserData; } +void wxCmdLineParser::SetCmdLine(int argc, char **argv) +{ + m_data->SetArguments(argc, argv); +} + +#if wxUSE_UNICODE + void wxCmdLineParser::SetCmdLine(int argc, wxChar **argv) { m_data->SetArguments(argc, argv); } +#endif // wxUSE_UNICODE + void wxCmdLineParser::SetCmdLine(const wxString& cmdline) { m_data->SetArguments(cmdline); @@ -418,13 +443,13 @@ bool wxCmdLineParser::Found(const wxString& name) const if ( i == wxNOT_FOUND ) i = m_data->FindOptionByLongName(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") ); + wxCHECK_MSG( i != wxNOT_FOUND, false, _T("unknown switch") ); wxCmdLineOption& opt = m_data->m_options[(size_t)i]; if ( !opt.HasValue() ) - return FALSE; + return false; - return TRUE; + return true; } bool wxCmdLineParser::Found(const wxString& name, wxString *value) const @@ -433,17 +458,17 @@ bool wxCmdLineParser::Found(const wxString& name, wxString *value) const if ( i == wxNOT_FOUND ) i = m_data->FindOptionByLongName(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + wxCHECK_MSG( i != wxNOT_FOUND, false, _T("unknown option") ); wxCmdLineOption& opt = m_data->m_options[(size_t)i]; if ( !opt.HasValue() ) - return FALSE; + return false; - wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") ); + wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") ); *value = opt.GetStrVal(); - return TRUE; + return true; } bool wxCmdLineParser::Found(const wxString& name, long *value) const @@ -452,17 +477,17 @@ bool wxCmdLineParser::Found(const wxString& name, long *value) const if ( i == wxNOT_FOUND ) i = m_data->FindOptionByLongName(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + wxCHECK_MSG( i != wxNOT_FOUND, false, _T("unknown option") ); wxCmdLineOption& opt = m_data->m_options[(size_t)i]; if ( !opt.HasValue() ) - return FALSE; + return false; - wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") ); + wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") ); *value = opt.GetLongVal(); - return TRUE; + return true; } #if wxUSE_DATETIME @@ -472,17 +497,17 @@ bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const if ( i == wxNOT_FOUND ) i = m_data->FindOptionByLongName(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + wxCHECK_MSG( i != wxNOT_FOUND, false, _T("unknown option") ); wxCmdLineOption& opt = m_data->m_options[(size_t)i]; if ( !opt.HasValue() ) - return FALSE; + return false; - wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") ); + wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") ); *value = opt.GetDateVal(); - return TRUE; + return true; } #endif // wxUSE_DATETIME @@ -504,7 +529,7 @@ void wxCmdLineParser::Reset() for ( size_t i = 0; i < m_data->m_options.Count(); i++ ) { wxCmdLineOption& opt = m_data->m_options[i]; - opt.SetHasValue(FALSE); + opt.SetHasValue(false); } } @@ -515,10 +540,10 @@ void wxCmdLineParser::Reset() int wxCmdLineParser::Parse(bool showUsage) { - bool maybeOption = TRUE; // can the following arg be an option? - bool ok = TRUE; // TRUE until an error is detected - bool helpRequested = FALSE; // TRUE if "-h" was given - bool hadRepeatableParam = FALSE; // TRUE if found param with MULTIPLE flag + bool maybeOption = true; // can the following arg be an option? + bool ok = true; // true until an error is detected + bool helpRequested = false; // true if "-h" was given + bool hadRepeatableParam = false; // true if found param with MULTIPLE flag size_t currentParam = 0; // the index in m_paramDesc @@ -539,7 +564,7 @@ int wxCmdLineParser::Parse(bool showUsage) // not like options (this is POSIX-like) if ( arg == _T("--") ) { - maybeOption = FALSE; + maybeOption = false; continue; } @@ -556,7 +581,7 @@ int wxCmdLineParser::Parse(bool showUsage) if ( arg[0u] == _T('-') && arg[1u] == _T('-') ) { // a long one - isLong = TRUE; + isLong = true; // Skip leading "--" const wxChar *p = arg.c_str() + 2; @@ -570,7 +595,8 @@ int wxCmdLineParser::Parse(bool showUsage) optInd = m_data->FindOptionByLongName(name); if ( optInd == wxNOT_FOUND ) { - errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << wxT("\n"); + errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) + << _T('\n'); } } else @@ -579,13 +605,14 @@ int wxCmdLineParser::Parse(bool showUsage) // Print the argument including leading "--" name.Prepend( wxT("--") ); - errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n"); + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) + << _T('\n'); } } - else + else // not a long option { - isLong = FALSE; + isLong = false; // a short one: as they can be cumulated, we try to find the // longest substring which is a valid option @@ -600,7 +627,8 @@ int wxCmdLineParser::Parse(bool showUsage) { // we couldn't find a valid option name in the // beginning of this string - errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n"); + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) + << _T('\n'); break; } @@ -642,43 +670,56 @@ int wxCmdLineParser::Parse(bool showUsage) if ( optInd == wxNOT_FOUND ) { - ok = FALSE; + ok = false; continue; // will break, in fact } + // look at what follows: + + // +1 for leading '-' + const wxChar *p = arg.c_str() + 1 + name.length(); + if ( isLong ) + p++; // for another leading '-' + wxCmdLineOption& opt = m_data->m_options[(size_t)optInd]; if ( opt.kind == wxCMD_LINE_SWITCH ) { - // nothing more to do - opt.SetHasValue(); - - if ( opt.flags & wxCMD_LINE_OPTION_HELP ) + // we must check that there is no value following the switch + if ( *p != _T('\0') ) + { + errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str()) + << _T('\n'); + ok = false; + } + else // no value, as expected { - helpRequested = TRUE; + // nothing more to do + opt.SetHasValue(); - // it's not an error, but we still stop here - ok = FALSE; + if ( opt.flags & wxCMD_LINE_OPTION_HELP ) + { + helpRequested = true; + + // it's not an error, but we still stop here + ok = false; + } } } - else + else // it's an option. not a switch { // get the value - - // +1 for leading '-' - const wxChar *p = arg.c_str() + 1 + name.length(); if ( isLong ) { - p++; // for another leading '-' - if ( *p++ != _T('=') ) { - errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << wxT("\n"); + errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } - else + else // short option { switch ( *p ) { @@ -694,9 +735,10 @@ int wxCmdLineParser::Parse(bool showUsage) { // ... but there is none errorMsg << wxString::Format(_("Option '%s' requires a value."), - name.c_str()) << wxT("\n"); + name.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } else { @@ -711,9 +753,10 @@ int wxCmdLineParser::Parse(bool showUsage) if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR ) { errorMsg << wxString::Format(_("Separator expected after the option '%s'."), - name.c_str()) << wxT("\n"); + name.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } } @@ -741,9 +784,10 @@ int wxCmdLineParser::Parse(bool showUsage) else { errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."), - value.c_str(), name.c_str()) << wxT("\n"); + value.c_str(), name.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } break; @@ -756,9 +800,10 @@ int wxCmdLineParser::Parse(bool showUsage) if ( !res || *res ) { errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."), - name.c_str(), value.c_str()) << wxT("\n"); + name.c_str(), value.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } else { @@ -771,9 +816,8 @@ int wxCmdLineParser::Parse(bool showUsage) } } } - else + else // not an option, must be a parameter { - // a parameter if ( currentParam < countParam ) { wxCmdLineParam& param = m_data->m_paramDesc[currentParam]; @@ -792,14 +836,15 @@ int wxCmdLineParser::Parse(bool showUsage) _T("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style are ignored") ); // remember that we did have this last repeatable parameter - hadRepeatableParam = TRUE; + hadRepeatableParam = true; } } else { - errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << wxT("\n"); + errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } } @@ -834,9 +879,10 @@ int wxCmdLineParser::Parse(bool showUsage) } errorMsg << wxString::Format(_("The value for the option '%s' must be specified."), - optName.c_str()) << wxT("\n"); + optName.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } @@ -855,9 +901,10 @@ int wxCmdLineParser::Parse(bool showUsage) if ( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL) ) { errorMsg << wxString::Format(_("The required parameter '%s' was not specified."), - param.description.c_str()) << wxT("\n"); + param.description.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } } @@ -903,14 +950,15 @@ void wxCmdLineParser::Usage() wxString wxCmdLineParser::GetUsageString() { - wxString appname = wxTheApp->GetAppName(); - if ( !appname ) + wxString appname; + if ( m_data->m_arguments.empty() ) { - wxCHECK_MSG( m_data->m_arguments.size() != 0, wxEmptyString, - _T("no program name") ); - - appname = wxFileNameFromPath(m_data->m_arguments[0]); - wxStripExtension(appname); + if ( wxTheApp ) + appname = wxTheApp->GetAppName(); + } + else // use argv[0] + { + appname = wxFileName(m_data->m_arguments[0]).GetName(); } // we construct the brief cmd line desc on the fly, but not the detailed @@ -956,7 +1004,7 @@ wxString wxCmdLineParser::GetUsageString() if (!opt.longName.empty()) { wxFAIL_MSG( wxT("option with only a long name while long ") - wxT("options are disabled") ); + wxT("options are disabled") ); } else { @@ -1121,24 +1169,10 @@ static wxString GetLongOptionName(const wxChar *p) /* This function is mainly used under Windows (as under Unix we always get the - command line arguments as argc/argv anyhow) and so it tries to handle the - Windows path names (separated by backslashes) correctly. For this it only - considers that a backslash may be used to escape another backslash (but - normally this is _not_ needed) or a quote but nothing else. - - In particular, to pass a single argument containing a space to the program - it should be quoted: - - myprog.exe foo bar -> argc = 3, argv[1] = "foo", argv[2] = "bar" - myprog.exe "foo bar" -> argc = 2, argv[1] = "foo bar" - - To pass an argument containing spaces and quotes, the latter should be - escaped with a backslash: - - myprog.exe "foo \"bar\"" -> argc = 2, argv[1] = "foo "bar"" - - This hopefully matches the conventions used by Explorer/command line - interpreter under Windows. If not, this function should be fixed. + command line arguments as argc/argv anyhow) and so it tries to follow + Windows conventions for the command line handling, not Unix ones. For + instance, backslash is not special except when it precedes double quote when + it does quote it. */ /* static */ @@ -1149,7 +1183,7 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) wxString arg; arg.reserve(1024); - bool isInsideQuotes = FALSE; + bool isInsideQuotes = false; for ( ;; ) { // skip white space @@ -1161,80 +1195,49 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) break; // parse this parameter - arg.clear(); - for ( ;; p++ ) + bool endParam = false; + bool lastBS = false; + for ( arg.clear(); !endParam; p++ ) { - // do we have a (lone) backslash? - bool isQuotedByBS = FALSE; - while ( *p == _T('\\') ) - { - p++; - - // if we have 2 backslashes in a row, output one - // unless it looks like a UNC path \\machine\dir\file.ext - if ( isQuotedByBS || arg.Len() == 0 ) - { - arg += _T('\\'); - isQuotedByBS = FALSE; - } - else // the next char is quoted - { - isQuotedByBS = TRUE; - } - } - - bool skipChar = FALSE, - endParam = FALSE; switch ( *p ) { case _T('"'): - if ( !isQuotedByBS ) + if ( !lastBS ) { - // don't put the quote itself in the arg - skipChar = TRUE; - isInsideQuotes = !isInsideQuotes; - } - //else: insert a literal quote + // don't put quote in arg + continue; + } + //else: quote has no special meaning but the backslash + // still remains -- makes no sense but this is what + // Windows does break; case _T(' '): case _T('\t'): - // we intentionally don't check for preceding backslash - // here as if we allowed it to be used to escape spaces the - // cmd line of the form "foo.exe a:\ c:\bar" wouldn't be - // parsed correctly + // backslash does *not* quote the space, only quotes do if ( isInsideQuotes ) { - // preserve it, skip endParam below + // skip assignment below break; } - //else: fall through + // fall through case _T('\0'): - endParam = TRUE; - break; + endParam = true; - default: - if ( isQuotedByBS ) - { - // ignore backslash before an ordinary character - this - // is needed to properly handle the file names under - // Windows appearing in the command line - arg += _T('\\'); - } + break; } - // end of argument? if ( endParam ) - break; - - // otherwise copy this char to arg - if ( !skipChar ) { - arg += *p; + break; } + + lastBS = *p == _T('\\'); + + arg += *p; } args.push_back(arg); @@ -1242,4 +1245,3 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) return args; } -