X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/31f6de22b0575e7feac83e7f99b5774a3490fc1a..4e3ad7c095f0a047b48445d76316fc20f394f3e9:/src/common/cmdline.cpp diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp index 142cf53dad..524ee1f43a 100644 --- a/src/common/cmdline.cpp +++ b/src/common/cmdline.cpp @@ -44,6 +44,7 @@ #include #include "wx/datetime.h" +#include "wx/msgout.h" // ---------------------------------------------------------------------------- // private functions @@ -51,8 +52,14 @@ static wxString GetTypeName(wxCmdLineParamType type); +static wxString GetOptionName(const wxChar *p, const wxChar *allowedChars); + +static wxString GetShortOptionName(const wxChar *p); + +static wxString GetLongOptionName(const wxChar *p); + // ---------------------------------------------------------------------------- -// private classes +// private structs // ---------------------------------------------------------------------------- // an internal representation of an option @@ -68,6 +75,18 @@ struct wxCmdLineOption wxASSERT_MSG( !shrt.empty() || !lng.empty(), _T("option should have at least one name") ); + wxASSERT_MSG + ( + GetShortOptionName(shrt).Len() == shrt.Len(), + wxT("Short option contains invalid characters") + ); + + wxASSERT_MSG + ( + GetLongOptionName(lng).Len() == lng.Len(), + wxT("Long option contains invalid characters") + ); + kind = k; shortName = shrt; @@ -109,7 +128,9 @@ struct wxCmdLineOption public: wxCmdLineEntryType kind; - wxString shortName, longName, description; + wxString shortName, + longName, + description; wxCmdLineParamType type; int flags; @@ -278,6 +299,11 @@ void wxCmdLineParser::EnableLongOptions(bool enable) m_data->m_enableLongOptions = enable; } +bool wxCmdLineParser::AreLongOptionsEnabled() +{ + return m_data->m_enableLongOptions; +} + void wxCmdLineParser::SetLogo(const wxString& logo) { m_data->m_logo = logo; @@ -458,6 +484,8 @@ size_t wxCmdLineParser::GetParamCount() const wxString wxCmdLineParser::GetParam(size_t n) const { + wxCHECK_MSG( n < GetParamCount(), wxEmptyString, _T("invalid param index") ); + return m_data->m_parameters[n]; } @@ -476,7 +504,7 @@ void wxCmdLineParser::Reset() // the real work is done here // ---------------------------------------------------------------------------- -int wxCmdLineParser::Parse() +int wxCmdLineParser::Parse(bool showUsage) { bool maybeOption = TRUE; // can the following arg be an option? bool ok = TRUE; // TRUE until an error is detected @@ -486,6 +514,7 @@ int wxCmdLineParser::Parse() size_t currentParam = 0; // the index in m_paramDesc size_t countParam = m_data->m_paramDesc.GetCount(); + wxString errorMsg; Reset(); @@ -515,23 +544,35 @@ int wxCmdLineParser::Parse() int optInd = wxNOT_FOUND; // init to suppress warnings // an option or a switch: find whether it's a long or a short one - if ( m_data->m_enableLongOptions && - arg[0u] == _T('-') && arg[1u] == _T('-') ) + if ( arg[0u] == _T('-') && arg[1u] == _T('-') ) { // a long one isLong = TRUE; + // Skip leading "--" const wxChar *p = arg.c_str() + 2; - while ( wxIsalnum(*p) || (*p == _T('_')) || (*p == _T('-')) ) + + bool longOptionsEnabled = AreLongOptionsEnabled(); + + name = GetLongOptionName(p); + + if (longOptionsEnabled) { - name += *p++; + optInd = m_data->FindOptionByLongName(name); + if ( optInd == wxNOT_FOUND ) + { + errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << "\n"; + } } - - optInd = m_data->FindOptionByLongName(name); - if ( optInd == wxNOT_FOUND ) + else { - wxLogError(_("Unknown long option '%s'"), name.c_str()); + optInd = wxNOT_FOUND; // Sanity check + + // Print the argument including leading "--" + name.Prepend( wxT("--") ); + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << "\n"; } + } else { @@ -540,10 +581,8 @@ int wxCmdLineParser::Parse() // a short one: as they can be cumulated, we try to find the // longest substring which is a valid option const wxChar *p = arg.c_str() + 1; - while ( wxIsalnum(*p) || (*p == _T('_')) ) - { - name += *p++; - } + + name = GetShortOptionName(p); size_t len = name.length(); do @@ -552,7 +591,7 @@ int wxCmdLineParser::Parse() { // we couldn't find a valid option name in the // beginning of this string - wxLogError(_("Unknown option '%s'"), name.c_str()); + errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << "\n"; break; } @@ -624,7 +663,7 @@ int wxCmdLineParser::Parse() if ( *p++ != _T('=') ) { - wxLogError(_("Option '%s' requires a value, '=' expected."), name.c_str()); + errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << "\n"; ok = FALSE; } @@ -644,8 +683,8 @@ int wxCmdLineParser::Parse() if ( ++n == count ) { // ... but there is none - wxLogError(_("Option '%s' requires a value."), - name.c_str()); + errorMsg << wxString::Format(_("Option '%s' requires a value."), + name.c_str()) << "\n"; ok = FALSE; } @@ -661,8 +700,8 @@ int wxCmdLineParser::Parse() // not depending on the option style if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR ) { - wxLogError(_("Separator expected after the option '%s'."), - name.c_str()); + errorMsg << wxString::Format(_("Separator expected after the option '%s'."), + name.c_str()) << "\n"; ok = FALSE; } @@ -691,8 +730,8 @@ int wxCmdLineParser::Parse() } else { - wxLogError(_("'%s' is not a correct numeric value for option '%s'."), - value.c_str(), name.c_str()); + errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."), + value.c_str(), name.c_str()) << "\n"; ok = FALSE; } @@ -705,8 +744,8 @@ int wxCmdLineParser::Parse() const wxChar *res = dt.ParseDate(value); if ( !res || *res ) { - wxLogError(_("Option '%s': '%s' cannot be converted to a date."), - name.c_str(), value.c_str()); + errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."), + name.c_str(), value.c_str()) << "\n"; ok = FALSE; } @@ -746,7 +785,7 @@ int wxCmdLineParser::Parse() } else { - wxLogError(_("Unexpected parameter '%s'"), arg.c_str()); + errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << "\n"; ok = FALSE; } @@ -769,13 +808,21 @@ int wxCmdLineParser::Parse() } 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() ); + } } - wxLogError(_("The value for the option '%s' must be specified."), - optName.c_str()); + errorMsg << wxString::Format(_("The value for the option '%s' must be specified."), + optName.c_str()) << "\n"; ok = FALSE; } @@ -795,17 +842,22 @@ int wxCmdLineParser::Parse() if ( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL) ) { - wxLogError(_("The required parameter '%s' was not specified."), - param.description.c_str()); + errorMsg << wxString::Format(_("The required parameter '%s' was not specified."), + param.description.c_str()) << "\n"; ok = FALSE; } } } - if ( !ok ) + if ( !ok && (errorMsg.length() != 0 || helpRequested) ) { - Usage(); + wxString usage; + wxMessageOutput* msgOut = wxMessageOutput::Get(); + wxASSERT(msgOut); + if ( showUsage ) usage = GetUsageString(); + if ( msgOut ) + msgOut->Printf( wxT("%s%s"), usage.c_str(), errorMsg.c_str() ); } return ok ? 0 : helpRequested ? -1 : 1; @@ -816,11 +868,20 @@ int wxCmdLineParser::Parse() // ---------------------------------------------------------------------------- void wxCmdLineParser::Usage() +{ + wxString usage = GetUsageString(); + wxMessageOutput* msgOut = wxMessageOutput::Get(); + if ( msgOut ) + msgOut->Printf( wxT("%s"), usage.c_str() ); +} + +wxString wxCmdLineParser::GetUsageString() { wxString appname = wxTheApp->GetAppName(); if ( !appname ) { - wxCHECK_RET( !m_data->m_arguments.IsEmpty(), _T("no program name") ); + wxCHECK_MSG( !m_data->m_arguments.IsEmpty(), wxEmptyString, + _T("no program name") ); appname = wxFileNameFromPath(m_data->m_arguments[0]); wxStripExtension(appname); @@ -829,46 +890,78 @@ void wxCmdLineParser::Usage() // we construct the brief cmd line desc on the fly, but not the detailed // help message below because we want to align the options descriptions // and for this we must first know the longest one of them - wxString brief; + wxString usage; wxArrayString namesOptions, descOptions; - brief.Printf(_("Usage: %s"), appname.c_str()); + + if ( !!m_data->m_logo ) + { + usage << m_data->m_logo << _T('\n'); + } + + usage << wxString::Format(_("Usage: %s"), appname.c_str()); // the switch char is usually '-' but this can be changed with // SetSwitchChars() and then the first one of possible chars is used wxChar chSwitch = !m_data->m_switchChars ? _T('-') : m_data->m_switchChars[0u]; + bool areLongOptionsEnabled = AreLongOptionsEnabled(); size_t n, count = m_data->m_options.GetCount(); for ( n = 0; n < count; n++ ) { wxCmdLineOption& opt = m_data->m_options[n]; - brief << _T(' '); + usage << _T(' '); if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) { - brief << _T('['); + usage << _T('['); } - brief << chSwitch << opt.shortName; + if ( !opt.shortName.empty() ) + { + usage << chSwitch << opt.shortName; + } + else if ( areLongOptionsEnabled && !opt.longName.empty() ) + { + usage << _T("--") << opt.longName; + } + else + { + if (!opt.longName.empty()) + { + wxFAIL_MSG( wxT("option with only a long name while long ") + wxT("options are disabled") ); + } + else + { + wxFAIL_MSG( _T("option without neither short nor long name") ); + } + } wxString option; - option << _T(" ") << chSwitch << opt.shortName; - if ( !!opt.longName ) + + if ( !opt.shortName.empty() ) + { + option << _T(" ") << chSwitch << opt.shortName; + } + + if ( areLongOptionsEnabled && !opt.longName.empty() ) { - option << _T(" --") << opt.longName; + option << (option.empty() ? _T(" ") : _T(", ")) + << _T("--") << opt.longName; } if ( opt.kind != wxCMD_LINE_SWITCH ) { wxString val; val << _T('<') << GetTypeName(opt.type) << _T('>'); - brief << _T(' ') << val; + usage << _T(' ') << val; option << (!opt.longName ? _T(':') : _T('=')) << val; } if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) { - brief << _T(']'); + usage << _T(']'); } namesOptions.Add(option); @@ -880,31 +973,26 @@ void wxCmdLineParser::Usage() { wxCmdLineParam& param = m_data->m_paramDesc[n]; - brief << _T(' '); + usage << _T(' '); if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL ) { - brief << _T('['); + usage << _T('['); } - brief << param.description; + usage << param.description; if ( param.flags & wxCMD_LINE_PARAM_MULTIPLE ) { - brief << _T("..."); + usage << _T("..."); } if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL ) { - brief << _T(']'); + usage << _T(']'); } } - if ( !!m_data->m_logo ) - { - wxLogMessage(m_data->m_logo); - } - - wxLogMessage(brief); + usage << _T('\n'); // now construct the detailed help message size_t len, lenMax = 0; @@ -916,17 +1004,16 @@ void wxCmdLineParser::Usage() lenMax = len; } - wxString detailed; for ( n = 0; n < count; n++ ) { len = namesOptions[n].length(); - detailed << namesOptions[n] - << wxString(_T(' '), lenMax - len) << _T('\t') - << descOptions[n] - << _T('\n'); + usage << namesOptions[n] + << wxString(_T(' '), lenMax - len) << _T('\t') + << descOptions[n] + << _T('\n'); } - wxLogMessage(detailed); + return usage; } // ---------------------------------------------------------------------------- @@ -950,12 +1037,76 @@ static wxString GetTypeName(wxCmdLineParamType type) return s; } +/* +Returns a string which is equal to the string pointed to by p, but up to the +point where p contains an character that's not allowed. +Allowable characters are letters and numbers, and characters pointed to by +the parameter allowedChars. + +For example, if p points to "abcde-@-_", and allowedChars is "-_", +this function returns "abcde-". +*/ +static wxString GetOptionName(const wxChar *p, + const wxChar *allowedChars) +{ + wxString argName; + + while ( *p && (wxIsalnum(*p) || wxStrchr(allowedChars, *p)) ) + { + argName += *p++; + } + + return argName; +} + +// Besides alphanumeric characters, short and long options can +// have other characters. + +// A short option additionally can have these +#define wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION wxT("_?") + +// A long option can have the same characters as a short option and a '-'. +#define wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION \ + wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION wxT("-") + +static wxString GetShortOptionName(const wxChar *p) +{ + return GetOptionName(p, wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION); +} + +static wxString GetLongOptionName(const wxChar *p) +{ + return GetOptionName(p, wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION); +} + #endif // wxUSE_CMDLINE_PARSER // ---------------------------------------------------------------------------- // global functions // ---------------------------------------------------------------------------- +/* + 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. + */ + /* static */ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) { @@ -986,7 +1137,8 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) p++; // if we have 2 backslashes in a row, output one - if ( isQuotedByBS ) + // unless it looks like a UNC path \\machine\dir\file.ext + if ( isQuotedByBS || arg.Len() == 0 ) { arg += _T('\\'); isQuotedByBS = FALSE; @@ -1015,6 +1167,10 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) 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 if ( isInsideQuotes ) { // preserve it, skip endParam below @@ -1025,6 +1181,15 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) case _T('\0'): endParam = TRUE; break; + + 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('\\'); + } } // end of argument?