X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bd996abe63a8ed6aa07b26856a0d7935002e3e81..4f13428c4f852674c8f8fc99af26d9486bf907db:/src/common/cmdline.cpp diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp index ec1d43bdb4..dd154cbaee 100644 --- a/src/common/cmdline.cpp +++ b/src/common/cmdline.cpp @@ -1,12 +1,12 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: common/cmdline.cpp +// Name: src/common/cmdline.cpp // Purpose: wxCmdLineParser implementation // Author: Vadim Zeitlin // Modified by: // Created: 05.01.00 // RCS-ID: $Id$ // Copyright: (c) 2000 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #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 @@ -87,6 +83,7 @@ struct wxCmdLineOption wxT("Long option contains invalid characters") ); + kind = k; shortName = shrt; @@ -96,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 @@ -113,17 +110,21 @@ struct wxCmdLineOption { Check(wxCMD_LINE_VAL_NUMBER); return m_longVal; } const wxString& GetStrVal() const { Check(wxCMD_LINE_VAL_STRING); return m_strVal; } +#if wxUSE_DATETIME const wxDateTime& GetDateVal() const { Check(wxCMD_LINE_VAL_DATE); return m_dateVal; } +#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; } - void SetDateVal(const wxDateTime val) - { Check(wxCMD_LINE_VAL_DATE); m_dateVal = 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; } +#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: @@ -139,7 +140,9 @@ private: long m_longVal; wxString m_strVal; +#if wxUSE_DATETIME wxDateTime m_dateVal; +#endif // wxUSE_DATETIME }; struct wxCmdLineParam @@ -163,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 @@ -182,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); @@ -199,7 +205,7 @@ struct wxCmdLineParserData wxCmdLineParserData::wxCmdLineParserData() { - m_enableLongOptions = TRUE; + m_enableLongOptions = true; #ifdef __UNIX_LIKE__ m_switchChars = _T("-"); #else // !Unix @@ -207,21 +213,38 @@ 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.Empty(); + m_arguments.clear(); for ( int n = 0; n < argc; n++ ) { - m_arguments.Add(argv[n]); + m_arguments.push_back(argv[n]); } } +#endif // wxUSE_UNICODE + void wxCmdLineParserData::SetArguments(const wxString& cmdLine) { - m_arguments.Empty(); + m_arguments.clear(); - m_arguments.Add(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); @@ -270,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); @@ -411,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 @@ -426,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 @@ -445,41 +477,43 @@ 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 bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const { int i = m_data->FindOption(name); 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 size_t wxCmdLineParser::GetParamCount() const { - return m_data->m_parameters.GetCount(); + return m_data->m_parameters.size(); } wxString wxCmdLineParser::GetParam(size_t n) const @@ -495,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); } } @@ -506,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 @@ -520,7 +554,7 @@ int wxCmdLineParser::Parse(bool showUsage) // parse everything wxString arg; - size_t count = m_data->m_arguments.GetCount(); + size_t count = m_data->m_arguments.size(); for ( size_t n = 1; ok && (n < count); n++ ) // 0 is program name { arg = m_data->m_arguments[n]; @@ -530,7 +564,7 @@ int wxCmdLineParser::Parse(bool showUsage) // not like options (this is POSIX-like) if ( arg == _T("--") ) { - maybeOption = FALSE; + maybeOption = false; continue; } @@ -547,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; @@ -561,7 +595,7 @@ int wxCmdLineParser::Parse(bool showUsage) optInd = m_data->FindOptionByLongName(name); if ( optInd == wxNOT_FOUND ) { - errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << "\n"; + errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << wxT("\n"); } } else @@ -570,13 +604,13 @@ int wxCmdLineParser::Parse(bool showUsage) // Print the argument including leading "--" name.Prepend( wxT("--") ); - errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << "\n"; + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n"); } } else { - isLong = FALSE; + isLong = false; // a short one: as they can be cumulated, we try to find the // longest substring which is a valid option @@ -591,7 +625,7 @@ 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()) << "\n"; + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n"); break; } @@ -623,7 +657,8 @@ int wxCmdLineParser::Parse(bool showUsage) wxString arg2 = arg[0u]; arg2 += arg.Mid(len + 1); // +1 for leading '-' - m_data->m_arguments.Insert(arg2, n + 1); + m_data->m_arguments.insert + (m_data->m_arguments.begin() + n + 1, arg2); count++; } //else: it's our value, we'll deal with it below @@ -632,7 +667,7 @@ int wxCmdLineParser::Parse(bool showUsage) if ( optInd == wxNOT_FOUND ) { - ok = FALSE; + ok = false; continue; // will break, in fact } @@ -645,10 +680,10 @@ int wxCmdLineParser::Parse(bool showUsage) if ( opt.flags & wxCMD_LINE_OPTION_HELP ) { - helpRequested = TRUE; + helpRequested = true; // it's not an error, but we still stop here - ok = FALSE; + ok = false; } } else @@ -663,9 +698,9 @@ int wxCmdLineParser::Parse(bool showUsage) if ( *p++ != _T('=') ) { - errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << "\n"; + errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } else @@ -684,9 +719,9 @@ int wxCmdLineParser::Parse(bool showUsage) { // ... but there is none errorMsg << wxString::Format(_("Option '%s' requires a value."), - name.c_str()) << "\n"; + name.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } else { @@ -701,9 +736,9 @@ int wxCmdLineParser::Parse(bool showUsage) if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR ) { errorMsg << wxString::Format(_("Separator expected after the option '%s'."), - name.c_str()) << "\n"; + name.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } } @@ -731,13 +766,14 @@ 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()) << "\n"; + value.c_str(), name.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } break; +#if wxUSE_DATETIME case wxCMD_LINE_VAL_DATE: { wxDateTime dt; @@ -745,9 +781,9 @@ 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()) << "\n"; + name.c_str(), value.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } else { @@ -755,6 +791,7 @@ int wxCmdLineParser::Parse(bool showUsage) } } break; +#endif // wxUSE_DATETIME } } } @@ -768,7 +805,7 @@ int wxCmdLineParser::Parse(bool showUsage) // TODO check the param type - m_data->m_parameters.Add(arg); + m_data->m_parameters.push_back(arg); if ( !(param.flags & wxCMD_LINE_PARAM_MULTIPLE) ) { @@ -780,14 +817,14 @@ 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()) << "\n"; + errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } } @@ -808,15 +845,23 @@ int wxCmdLineParser::Parse(bool showUsage) } else { - optName.Printf(_("%s (or %s)"), - opt.shortName.c_str(), - opt.longName.c_str()); + if ( AreLongOptionsEnabled() ) + { + optName.Printf( _("%s (or %s)"), + opt.shortName.c_str(), + opt.longName.c_str() ); + } + else + { + optName.Printf( wxT("%s"), + opt.shortName.c_str() ); + } } errorMsg << wxString::Format(_("The value for the option '%s' must be specified."), - optName.c_str()) << "\n"; + optName.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } @@ -835,21 +880,30 @@ 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()) << "\n"; + param.description.c_str()) << wxT("\n"); - ok = FALSE; + ok = false; } } } - if ( !ok && (errorMsg.length() != 0 || helpRequested) ) + // if there was an error during parsing the command line, show this error + // and also the usage message if it had been requested + if ( !ok && (!errorMsg.empty() || (helpRequested && showUsage)) ) { - wxString usage; wxMessageOutput* msgOut = wxMessageOutput::Get(); - wxASSERT(msgOut); - if ( showUsage ) usage = GetUsageString(); if ( msgOut ) + { + wxString usage; + if ( showUsage ) + usage = GetUsageString(); + msgOut->Printf( wxT("%s%s"), usage.c_str(), errorMsg.c_str() ); + } + else + { + wxFAIL_MSG( _T("no wxMessageOutput object?") ); + } } return ok ? 0 : helpRequested ? -1 : 1; @@ -861,22 +915,28 @@ int wxCmdLineParser::Parse(bool showUsage) void wxCmdLineParser::Usage() { - wxString usage = GetUsageString(); wxMessageOutput* msgOut = wxMessageOutput::Get(); if ( msgOut ) - msgOut->Printf( wxT("%s"), usage.c_str() ); + { + msgOut->Printf( wxT("%s"), GetUsageString().c_str() ); + } + else + { + wxFAIL_MSG( _T("no wxMessageOutput object?") ); + } } wxString wxCmdLineParser::GetUsageString() { - wxString appname = wxTheApp->GetAppName(); - if ( !appname ) + wxString appname; + if ( m_data->m_arguments.empty() ) { - wxCHECK_MSG( !m_data->m_arguments.IsEmpty(), 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 @@ -885,7 +945,7 @@ wxString wxCmdLineParser::GetUsageString() wxString usage; wxArrayString namesOptions, descOptions; - if ( !!m_data->m_logo ) + if ( !m_data->m_logo.empty() ) { usage << m_data->m_logo << _T('\n'); } @@ -956,8 +1016,8 @@ wxString wxCmdLineParser::GetUsageString() usage << _T(']'); } - namesOptions.Add(option); - descOptions.Add(opt.description); + namesOptions.push_back(option); + descOptions.push_back(opt.description); } count = m_data->m_paramDesc.GetCount(); @@ -988,7 +1048,7 @@ wxString wxCmdLineParser::GetUsageString() // now construct the detailed help message size_t len, lenMax = 0; - count = namesOptions.GetCount(); + count = namesOptions.size(); for ( n = 0; n < count; n++ ) { len = namesOptions[n].length(); @@ -1021,9 +1081,17 @@ static wxString GetTypeName(wxCmdLineParamType type) wxFAIL_MSG( _T("unknown option type") ); // still fall through - case wxCMD_LINE_VAL_STRING: s = _("str"); break; - case wxCMD_LINE_VAL_NUMBER: s = _("num"); break; - case wxCMD_LINE_VAL_DATE: s = _("date"); break; + case wxCMD_LINE_VAL_STRING: + s = _("str"); + break; + + case wxCMD_LINE_VAL_NUMBER: + s = _("num"); + break; + + case wxCMD_LINE_VAL_DATE: + s = _("date"); + break; } return s; @@ -1079,24 +1147,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 */ @@ -1107,7 +1161,7 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) wxString arg; arg.reserve(1024); - bool isInsideQuotes = FALSE; + bool isInsideQuotes = false; for ( ;; ) { // skip white space @@ -1119,85 +1173,53 @@ 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.Add(arg); + args.push_back(arg); } return args; } -