X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8c9892c2a8c2d0e06e1823e375bdec6ec58fe828..bf2c43c76e2819be443ab1d830ab68d9569d66b1:/src/common/cmdline.cpp diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp index 2c5ea56421..e8892831ac 100644 --- a/src/common/cmdline.cpp +++ b/src/common/cmdline.cpp @@ -1,12 +1,11 @@ /////////////////////////////////////////////////////////////////////////////// -// 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 +16,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "cmdline.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,22 +23,26 @@ #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 // for LC_ALL #include "wx/datetime.h" +#include "wx/msgout.h" +#include "wx/filename.h" +#include "wx/apptrait.h" +#include "wx/scopeguard.h" // ---------------------------------------------------------------------------- // private functions @@ -51,8 +50,18 @@ static wxString GetTypeName(wxCmdLineParamType type); +static wxString GetOptionName(wxString::const_iterator p, + wxString::const_iterator end, + const wxChar *allowedChars); + +static wxString GetShortOptionName(wxString::const_iterator p, + wxString::const_iterator end); + +static wxString GetLongOptionName(wxString::const_iterator p, + wxString::const_iterator end); + // ---------------------------------------------------------------------------- -// private classes +// private structs // ---------------------------------------------------------------------------- // an internal representation of an option @@ -65,8 +74,27 @@ struct wxCmdLineOption wxCmdLineParamType typ, int fl) { - wxASSERT_MSG( !shrt.empty() || !lng.empty(), - _T("option should have at least one name") ); + // wxCMD_LINE_USAGE_TEXT uses only description, shortName and longName is empty + if ( k != wxCMD_LINE_USAGE_TEXT ) + { + wxASSERT_MSG + ( + !shrt.empty() || !lng.empty(), + wxT("option should have at least one name") + ); + + wxASSERT_MSG + ( + GetShortOptionName(shrt.begin(), shrt.end()).Len() == shrt.Len(), + wxT("Short option contains invalid characters") + ); + + wxASSERT_MSG + ( + GetLongOptionName(lng.begin(), lng.end()).Len() == lng.Len(), + wxT("Long option contains invalid characters") + ); + } kind = k; @@ -77,7 +105,7 @@ struct wxCmdLineOption type = typ; flags = fl; - m_hasVal = FALSE; + Reset(); } // can't use union easily here, so just store all possible data fields, we @@ -87,26 +115,44 @@ struct wxCmdLineOption void Check(wxCmdLineParamType WXUNUSED_UNLESS_DEBUG(typ)) const { - wxASSERT_MSG( type == typ, _T("type mismatch in wxCmdLineOption") ); + wxASSERT_MSG( type == typ, wxT("type mismatch in wxCmdLineOption") ); } + double GetDoubleVal() const + { Check(wxCMD_LINE_VAL_DOUBLE); return m_doubleVal; } long GetLongVal() const { 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 SetDoubleVal(double val) + { Check(wxCMD_LINE_VAL_DOUBLE); m_doubleVal = val; m_hasVal = true; } 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() { m_hasVal = true; } bool HasValue() const { return m_hasVal; } + void SetNegated() { m_isNegated = true; } + bool IsNegated() const { return m_isNegated; } + + // Reset to the initial state, called before parsing another command line. + void Reset() + { + m_hasVal = + m_isNegated = false; + } + public: wxCmdLineEntryType kind; wxString shortName, @@ -117,10 +163,14 @@ public: private: bool m_hasVal; + bool m_isNegated; + double m_doubleVal; long m_longVal; wxString m_strVal; +#if wxUSE_DATETIME wxDateTime m_dateVal; +#endif // wxUSE_DATETIME }; struct wxCmdLineParam @@ -144,26 +194,30 @@ 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 wxArrayString m_arguments; // == argv, argc == m_arguments.GetCount() - wxArrayOptions m_options; // all possible options and switchrs + wxArrayOptions m_options; // all possible options and switches wxArrayParams m_paramDesc; // description of all possible params wxArrayString m_parameters; // all params found // methods wxCmdLineParserData(); + void SetArguments(int argc, char **argv); +#if wxUSE_UNICODE void SetArguments(int argc, wxChar **argv); + void SetArguments(int argc, const wxCmdLineArgsArray& argv); +#endif // wxUSE_UNICODE void SetArguments(const wxString& cmdline); int FindOption(const wxString& name); @@ -180,29 +234,84 @@ struct wxCmdLineParserData wxCmdLineParserData::wxCmdLineParserData() { - m_enableLongOptions = TRUE; + m_enableLongOptions = true; #ifdef __UNIX_LIKE__ - m_switchChars = _T("-"); + m_switchChars = wxT("-"); #else // !Unix - m_switchChars = _T("/-"); + m_switchChars = wxT("/-"); #endif } +namespace +{ + +// Small helper function setting locale for all categories. +// +// We define it because wxSetlocale() can't be easily used with wxScopeGuard as +// it has several overloads -- while this one can. +inline char *SetAllLocaleFacets(const char *loc) +{ + return wxSetlocale(LC_ALL, loc); +} + +} // private namespace + +void wxCmdLineParserData::SetArguments(int argc, char **argv) +{ + m_arguments.clear(); + + // Command-line arguments are supposed to be in the user locale encoding + // (what else?) but wxLocale probably wasn't initialized yet as we're + // called early during the program startup and so our locale might not have + // been set from the environment yet. To work around this problem we + // temporarily change the locale here. The only drawback is that changing + // the locale is thread-unsafe but precisely because we're called so early + // it's hopefully safe to assume that no other threads had been created yet. + char * const locOld = SetAllLocaleFacets(""); + wxON_BLOCK_EXIT1( SetAllLocaleFacets, locOld ); + + for ( int n = 0; n < argc; n++ ) + { + // try to interpret the string as being in the current locale + wxString arg(argv[n]); + + // but just in case we guessed wrongly and the conversion failed, do + // try to salvage at least something + if ( arg.empty() && argv[n][0] != '\0' ) + arg = wxString(argv[n], wxConvISO8859_1); + + m_arguments.push_back(arg); + } +} + +#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]); } } +void wxCmdLineParserData::SetArguments(int WXUNUSED(argc), + const wxCmdLineArgsArray& argv) +{ + m_arguments = argv.GetArguments(); +} + +#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); @@ -251,11 +360,25 @@ 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); } +void wxCmdLineParser::SetCmdLine(int argc, const wxCmdLineArgsArray& argv) +{ + m_data->SetArguments(argc, argv); +} + +#endif // wxUSE_UNICODE + void wxCmdLineParser::SetCmdLine(const wxString& cmdline) { m_data->SetArguments(cmdline); @@ -280,6 +403,11 @@ void wxCmdLineParser::EnableLongOptions(bool enable) m_data->m_enableLongOptions = enable; } +bool wxCmdLineParser::AreLongOptionsEnabled() const +{ + return m_data->m_enableLongOptions; +} + void wxCmdLineParser::SetLogo(const wxString& logo) { m_data->m_logo = logo; @@ -296,21 +424,28 @@ void wxCmdLineParser::SetDesc(const wxCmdLineEntryDesc *desc) switch ( desc->kind ) { case wxCMD_LINE_SWITCH: - AddSwitch(desc->shortName, desc->longName, desc->description, + AddSwitch(desc->shortName, desc->longName, + wxGetTranslation(desc->description), desc->flags); break; case wxCMD_LINE_OPTION: - AddOption(desc->shortName, desc->longName, desc->description, + AddOption(desc->shortName, desc->longName, + wxGetTranslation(desc->description), desc->type, desc->flags); break; case wxCMD_LINE_PARAM: - AddParam(desc->description, desc->type, desc->flags); + AddParam(wxGetTranslation(desc->description), + desc->type, desc->flags); + break; + + case wxCMD_LINE_USAGE_TEXT: + AddUsageText(wxGetTranslation(desc->description)); break; default: - wxFAIL_MSG( _T("unknown command line entry type") ); + wxFAIL_MSG( wxT("unknown command line entry type") ); // still fall through case wxCMD_LINE_NONE: @@ -325,7 +460,7 @@ void wxCmdLineParser::AddSwitch(const wxString& shortName, int flags) { wxASSERT_MSG( m_data->FindOption(shortName) == wxNOT_FOUND, - _T("duplicate switch") ); + wxT("duplicate switch") ); wxCmdLineOption *option = new wxCmdLineOption(wxCMD_LINE_SWITCH, shortName, longName, desc, @@ -341,7 +476,7 @@ void wxCmdLineParser::AddOption(const wxString& shortName, int flags) { wxASSERT_MSG( m_data->FindOption(shortName) == wxNOT_FOUND, - _T("duplicate option") ); + wxT("duplicate option") ); wxCmdLineOption *option = new wxCmdLineOption(wxCMD_LINE_OPTION, shortName, longName, desc, @@ -356,44 +491,60 @@ void wxCmdLineParser::AddParam(const wxString& desc, { // do some consistency checks: a required parameter can't follow an // optional one and nothing should follow a parameter with MULTIPLE flag -#ifdef __WXDEBUG__ +#if wxDEBUG_LEVEL if ( !m_data->m_paramDesc.IsEmpty() ) { wxCmdLineParam& param = m_data->m_paramDesc.Last(); wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_MULTIPLE), - _T("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style will be ignored") ); + wxT("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style will be ignored") ); if ( !(flags & wxCMD_LINE_PARAM_OPTIONAL) ) { wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL), - _T("a required parameter can't follow an optional one") ); + wxT("a required parameter can't follow an optional one") ); } } -#endif // Debug +#endif // wxDEBUG_LEVEL wxCmdLineParam *param = new wxCmdLineParam(desc, type, flags); m_data->m_paramDesc.Add(param); } +void wxCmdLineParser::AddUsageText(const wxString& text) +{ + wxASSERT_MSG( !text.empty(), wxT("text can't be empty") ); + + wxCmdLineOption *option = new wxCmdLineOption(wxCMD_LINE_USAGE_TEXT, + wxEmptyString, wxEmptyString, + text, wxCMD_LINE_VAL_NONE, 0); + + m_data->m_options.Add(option); +} + // ---------------------------------------------------------------------------- // access to parse command line // ---------------------------------------------------------------------------- bool wxCmdLineParser::Found(const wxString& name) const +{ + return FoundSwitch(name) != wxCMD_SWITCH_NOT_FOUND; +} + +wxCmdLineSwitchState wxCmdLineParser::FoundSwitch(const wxString& name) const { int i = m_data->FindOption(name); if ( i == wxNOT_FOUND ) i = m_data->FindOptionByLongName(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") ); + wxCHECK_MSG( i != wxNOT_FOUND, wxCMD_SWITCH_NOT_FOUND, wxT("unknown switch") ); wxCmdLineOption& opt = m_data->m_options[(size_t)i]; if ( !opt.HasValue() ) - return FALSE; + return wxCMD_SWITCH_NOT_FOUND; - return TRUE; + return opt.IsNegated() ? wxCMD_SWITCH_OFF : wxCMD_SWITCH_ON; } bool wxCmdLineParser::Found(const wxString& name, wxString *value) const @@ -402,17 +553,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, wxT("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, wxT("NULL pointer in wxCmdLineOption::Found") ); *value = opt.GetStrVal(); - return TRUE; + return true; } bool wxCmdLineParser::Found(const wxString& name, long *value) const @@ -421,46 +572,67 @@ 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, wxT("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, wxT("NULL pointer in wxCmdLineOption::Found") ); *value = opt.GetLongVal(); - return TRUE; + return true; } +bool wxCmdLineParser::Found(const wxString& name, double *value) const +{ + int i = m_data->FindOption(name); + if ( i == wxNOT_FOUND ) + i = m_data->FindOptionByLongName(name); + + wxCHECK_MSG( i != wxNOT_FOUND, false, wxT("unknown option") ); + + wxCmdLineOption& opt = m_data->m_options[(size_t)i]; + if ( !opt.HasValue() ) + return false; + + wxCHECK_MSG( value, false, wxT("NULL pointer in wxCmdLineOption::Found") ); + + *value = opt.GetDoubleVal(); + + 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, wxT("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, wxT("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 { - wxCHECK_MSG( n < GetParamCount(), wxEmptyString, _T("invalid param index") ); + wxCHECK_MSG( n < GetParamCount(), wxEmptyString, wxT("invalid param index") ); return m_data->m_parameters[n]; } @@ -468,10 +640,9 @@ wxString wxCmdLineParser::GetParam(size_t n) const // Resets switches and options void wxCmdLineParser::Reset() { - for ( size_t i = 0; i < m_data->m_options.Count(); i++ ) + for ( size_t i = 0; i < m_data->m_options.GetCount(); i++ ) { - wxCmdLineOption& opt = m_data->m_options[i]; - opt.SetHasValue(FALSE); + m_data->m_options[i].Reset(); } } @@ -482,20 +653,21 @@ 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 size_t countParam = m_data->m_paramDesc.GetCount(); + wxString errorMsg; Reset(); // 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]; @@ -503,51 +675,106 @@ int wxCmdLineParser::Parse(bool showUsage) // special case: "--" should be discarded and all following arguments // should be considered as parameters, even if they start with '-' and // not like options (this is POSIX-like) - if ( arg == _T("--") ) + if ( arg == wxT("--") ) { - maybeOption = FALSE; + maybeOption = false; continue; } - +#ifdef __WXOSX__ + if ( arg == wxT("-ApplePersistenceIgnoreState") ) + { + maybeOption = false; + + continue; + } +#endif + // empty argument or just '-' is not an option but a parameter if ( maybeOption && arg.length() > 1 && - wxStrchr(m_data->m_switchChars, arg[0u]) ) + // FIXME-UTF8: use wc_str() after removing ANSI build + wxStrchr(m_data->m_switchChars.c_str(), arg[0u]) ) { bool isLong; wxString name; 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.length() >= 3 && arg[0u] == wxT('-') && arg[1u] == wxT('-') ) { // a long one - isLong = TRUE; + isLong = true; + + // Skip leading "--" + wxString::const_iterator p = arg.begin() + 2; + + bool longOptionsEnabled = AreLongOptionsEnabled(); + + name = GetLongOptionName(p, arg.end()); - const wxChar *p = arg.c_str() + 2; - while ( wxIsalnum(*p) || (*p == _T('_')) || (*p == _T('-')) ) + if (longOptionsEnabled) { - name += *p++; - } + wxString errorOpt; + + optInd = m_data->FindOptionByLongName(name); + if ( optInd == wxNOT_FOUND ) + { + // Check if this could be a negatable long option. + if ( name.Last() == '-' ) + { + name.RemoveLast(); - optInd = m_data->FindOptionByLongName(name); - if ( optInd == wxNOT_FOUND ) + optInd = m_data->FindOptionByLongName(name); + if ( optInd != wxNOT_FOUND ) + { + if ( !(m_data->m_options[optInd].flags & + wxCMD_LINE_SWITCH_NEGATABLE) ) + { + errorOpt.Printf + ( + _("Option '%s' can't be negated"), + name + ); + optInd = wxNOT_FOUND; + } + } + } + + if ( optInd == wxNOT_FOUND ) + { + if ( errorOpt.empty() ) + { + errorOpt.Printf + ( + _("Unknown long option '%s'"), + name + ); + } + + errorMsg << errorOpt << wxT('\n'); + } + } + } + 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()) + << wxT('\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 - const wxChar *p = arg.c_str() + 1; - while ( wxIsalnum(*p) || (*p == _T('_')) ) - { - name += *p++; - } + wxString::const_iterator p = arg.begin() + 1; + + name = GetShortOptionName(p, arg.end()); size_t len = name.length(); do @@ -556,7 +783,8 @@ int wxCmdLineParser::Parse(bool showUsage) { // 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()) + << wxT('\n'); break; } @@ -583,13 +811,26 @@ int wxCmdLineParser::Parse(bool showUsage) if ( m_data->m_options[(size_t)optInd].kind == wxCMD_LINE_SWITCH ) { + // if the switch is negatable and it is just followed + // by '-' the '-' is considered to be part of this + // switch + if ( (m_data->m_options[(size_t)optInd].flags & + wxCMD_LINE_SWITCH_NEGATABLE) && + arg[len] == '-' ) + ++len; + // pretend that all the rest of the argument is the // next argument, in fact 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++; + + // only leave the part which wasn't extracted into the + // next argument in this one + arg = arg.Left(len + 1); } //else: it's our value, we'll deal with it below } @@ -597,89 +838,98 @@ 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 '-' + wxString::const_iterator p = arg.begin() + 1 + name.length(); + wxString::const_iterator end = arg.end(); + + 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(); + // we must check that there is no value following the switch + bool negated = (opt.flags & wxCMD_LINE_SWITCH_NEGATABLE) && + p != arg.end() && *p == '-'; - if ( opt.flags & wxCMD_LINE_OPTION_HELP ) + if ( !negated && p != arg.end() ) { - helpRequested = TRUE; - - // it's not an error, but we still stop here - ok = FALSE; + errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str()) + << wxT('\n'); + ok = false; } - } - else - { - // get the value - - // +1 for leading '-' - const wxChar *p = arg.c_str() + 1 + name.length(); - if ( isLong ) + else // no value, as expected { - p++; // for another leading '-' + // nothing more to do + opt.SetHasValue(); + if ( negated ) + opt.SetNegated(); - if ( *p++ != _T('=') ) + if ( opt.flags & wxCMD_LINE_OPTION_HELP ) { - wxLogError(_("Option '%s' requires a value, '=' expected."), name.c_str()); + helpRequested = true; - ok = FALSE; + // it's not an error, but we still stop here + ok = false; } } - else + } + else // it's an option. not a switch + { + switch ( p == end ? '\0' : (*p).GetValue() ) { - switch ( *p ) - { - case _T('='): - case _T(':'): - // the value follows - p++; - break; - - case 0: - // the value is in the next argument - if ( ++n == count ) - { - // ... but there is none - wxLogError(_("Option '%s' requires a value."), - name.c_str()); - - ok = FALSE; - } - else - { - // ... take it from there - p = m_data->m_arguments[n].c_str(); - } - break; + case '=': + case ':': + // the value follows + ++p; + break; - default: - // the value is right here: this may be legal or - // not depending on the option style - if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR ) - { - wxLogError(_("Separator expected after the option '%s'."), - name.c_str()); + case '\0': + // the value is in the next argument + if ( ++n == count ) + { + // ... but there is none + errorMsg << wxString::Format(_("Option '%s' requires a value."), + name.c_str()) + << wxT('\n'); + + ok = false; + } + else + { + // ... take it from there + p = m_data->m_arguments[n].begin(); + end = m_data->m_arguments[n].end(); + } + break; - ok = FALSE; - } - } + default: + // the value is right here: this may be legal or + // not depending on the option style + if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR ) + { + errorMsg << wxString::Format(_("Separator expected after the option '%s'."), + name.c_str()) + << wxT('\n'); + + ok = false; + } } if ( ok ) { - wxString value = p; + wxString value(p, end); switch ( opt.type ) { default: - wxFAIL_MSG( _T("unknown option type") ); + wxFAIL_MSG( wxT("unknown option type") ); // still fall through case wxCMD_LINE_VAL_STRING: @@ -695,24 +945,45 @@ int wxCmdLineParser::Parse(bool showUsage) } 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()) + << wxT('\n'); - ok = FALSE; + ok = false; } } break; + case wxCMD_LINE_VAL_DOUBLE: + { + double val; + if ( value.ToDouble(&val) ) + { + opt.SetDoubleVal(val); + } + else + { + errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."), + value.c_str(), name.c_str()) + << wxT('\n'); + + ok = false; + } + } + break; + +#if wxUSE_DATETIME case wxCMD_LINE_VAL_DATE: { wxDateTime dt; - const wxChar *res = dt.ParseDate(value); - if ( !res || *res ) + wxString::const_iterator endDate; + if ( !dt.ParseDate(value, &endDate) || endDate != value.end() ) { - 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()) + << wxT('\n'); - ok = FALSE; + ok = false; } else { @@ -720,20 +991,20 @@ int wxCmdLineParser::Parse(bool showUsage) } } break; +#endif // wxUSE_DATETIME } } } } - else + else // not an option, must be a parameter { - // a parameter if ( currentParam < countParam ) { wxCmdLineParam& param = m_data->m_paramDesc[currentParam]; // 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) ) { @@ -742,17 +1013,18 @@ int wxCmdLineParser::Parse(bool showUsage) else { wxASSERT_MSG( currentParam == countParam - 1, - _T("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style are ignored") ); + wxT("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 { - wxLogError(_("Unexpected parameter '%s'"), arg.c_str()); + errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) + << wxT('\n'); - ok = FALSE; + ok = false; } } } @@ -773,15 +1045,24 @@ 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() ); + } } - 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()) + << wxT('\n'); - ok = FALSE; + ok = false; } } @@ -799,17 +1080,32 @@ int wxCmdLineParser::Parse(bool showUsage) 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()) + << wxT('\n'); - ok = FALSE; + ok = false; } } } - if ( !ok && showUsage ) + // 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)) ) { - Usage(); + wxMessageOutput* msgOut = wxMessageOutput::Get(); + if ( msgOut ) + { + wxString usage; + if ( showUsage ) + usage = GetUsageString(); + + msgOut->Printf( wxT("%s%s"), usage.c_str(), errorMsg.c_str() ); + } + else + { + wxFAIL_MSG( wxT("no wxMessageOutput object?") ); + } } return ok ? 0 : helpRequested ? -1 : 1; @@ -819,81 +1115,116 @@ int wxCmdLineParser::Parse(bool showUsage) // give the usage message // ---------------------------------------------------------------------------- -void wxCmdLineParser::Usage() +void wxCmdLineParser::Usage() const { - wxString appname = wxTheApp->GetAppName(); - if ( !appname ) + wxMessageOutput* msgOut = wxMessageOutput::Get(); + if ( msgOut ) { - wxCHECK_RET( !m_data->m_arguments.IsEmpty(), _T("no program name") ); + msgOut->Printf( wxT("%s"), GetUsageString().c_str() ); + } + else + { + wxFAIL_MSG( wxT("no wxMessageOutput object?") ); + } +} - appname = wxFileNameFromPath(m_data->m_arguments[0]); - wxStripExtension(appname); +wxString wxCmdLineParser::GetUsageString() const +{ + wxString appname; + if ( m_data->m_arguments.empty() ) + { + 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 // 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.empty() ) + { + usage << m_data->m_logo << wxT('\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('-') + wxChar chSwitch = !m_data->m_switchChars ? wxT('-') : 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]; + wxString option, negator; - brief << _T(' '); - if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) + if ( opt.kind != wxCMD_LINE_USAGE_TEXT ) { - brief << _T('['); - } + usage << wxT(' '); + if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) + { + usage << wxT('['); + } - if ( !opt.shortName.empty() ) - { - brief << chSwitch << opt.shortName; - } - else if ( !opt.longName.empty() ) - { - brief << _T("--") << opt.longName; - } - else - { - wxFAIL_MSG( _T("option without neither short nor long name?") ); - } + if ( opt.flags & wxCMD_LINE_SWITCH_NEGATABLE ) + negator = wxT("[-]"); - wxString option; + if ( !opt.shortName.empty() ) + { + usage << chSwitch << opt.shortName << negator; + } + else if ( areLongOptionsEnabled && !opt.longName.empty() ) + { + usage << wxT("--") << opt.longName << negator; + } + else + { + if (!opt.longName.empty()) + { + wxFAIL_MSG( wxT("option with only a long name while long ") + wxT("options are disabled") ); + } + else + { + wxFAIL_MSG( wxT("option without neither short nor long name") ); + } + } - if ( !opt.shortName.empty() ) - { - option << _T(" ") << chSwitch << opt.shortName; - } + if ( !opt.shortName.empty() ) + { + option << wxT(" ") << chSwitch << opt.shortName; + } - if ( !opt.longName.empty() ) - { - option << (option.empty() ? _T(" ") : _T(", ")) - << _T("--") << opt.longName; - } + if ( areLongOptionsEnabled && !opt.longName.empty() ) + { + option << (option.empty() ? wxT(" ") : wxT(", ")) + << wxT("--") << opt.longName; + } - if ( opt.kind != wxCMD_LINE_SWITCH ) - { - wxString val; - val << _T('<') << GetTypeName(opt.type) << _T('>'); - brief << _T(' ') << val; - option << (!opt.longName ? _T(':') : _T('=')) << val; - } + if ( opt.kind != wxCMD_LINE_SWITCH ) + { + wxString val; + val << wxT('<') << GetTypeName(opt.type) << wxT('>'); + usage << wxT(' ') << val; + option << (!opt.longName ? wxT(':') : wxT('=')) << val; + } - if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) - { - brief << _T(']'); + if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) + { + usage << wxT(']'); + } } - namesOptions.Add(option); - descOptions.Add(opt.description); + namesOptions.push_back(option); + descOptions.push_back(opt.description); } count = m_data->m_paramDesc.GetCount(); @@ -901,64 +1232,66 @@ void wxCmdLineParser::Usage() { wxCmdLineParam& param = m_data->m_paramDesc[n]; - brief << _T(' '); + usage << wxT(' '); if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL ) { - brief << _T('['); + usage << wxT('['); } - brief << param.description; + usage << param.description; if ( param.flags & wxCMD_LINE_PARAM_MULTIPLE ) { - brief << _T("..."); + usage << wxT("..."); } if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL ) { - brief << _T(']'); + usage << wxT(']'); } } - if ( !!m_data->m_logo ) - { - wxLogMessage(m_data->m_logo); - } + usage << wxT('\n'); + + // set to number of our own options, not counting the standard ones + count = namesOptions.size(); - // in console mode we want to show the brief usage message first, then the - // detailed one but in GUI build we give the details first and then the - // summary - like this, the brief message appears in the wxLogGui dialog, - // as expected -#if !wxUSE_GUI - wxLogMessage(brief); -#endif // !wxUSE_GUI + // get option names & descriptions for standard options, if any: + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + wxString stdDesc; + if ( traits ) + stdDesc = traits->GetStandardCmdLineOptions(namesOptions, descOptions); // now construct the detailed help message size_t len, lenMax = 0; - count = namesOptions.GetCount(); - for ( n = 0; n < count; n++ ) + for ( n = 0; n < namesOptions.size(); n++ ) { len = namesOptions[n].length(); if ( len > lenMax ) lenMax = len; } - wxString detailed; - for ( n = 0; n < count; n++ ) + for ( n = 0; n < namesOptions.size(); n++ ) { + if ( n == count ) + usage << wxT('\n') << stdDesc; + len = namesOptions[n].length(); - detailed << namesOptions[n] - << wxString(_T(' '), lenMax - len) << _T('\t') - << descOptions[n] - << _T('\n'); + // desc contains text if name is empty + if (len == 0) + { + usage << descOptions[n] << wxT('\n'); + } + else + { + usage << namesOptions[n] + << wxString(wxT(' '), lenMax - len) << wxT('\t') + << descOptions[n] + << wxT('\n'); + } } - wxLogMessage(detailed); - - // do it now if not done above -#if wxUSE_GUI - wxLogMessage(brief); -#endif // wxUSE_GUI + return usage; } // ---------------------------------------------------------------------------- @@ -971,17 +1304,74 @@ static wxString GetTypeName(wxCmdLineParamType type) switch ( type ) { default: - wxFAIL_MSG( _T("unknown option type") ); + wxFAIL_MSG( wxT("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_DOUBLE: + s = _("double"); + break; + + case wxCMD_LINE_VAL_DATE: + s = _("date"); + break; } 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(wxString::const_iterator p, + wxString::const_iterator end, + const wxChar *allowedChars) +{ + wxString argName; + + while ( p != end && (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(wxString::const_iterator p, + wxString::const_iterator end) +{ + return GetOptionName(p, end, wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION); +} + +static wxString GetLongOptionName(wxString::const_iterator p, + wxString::const_iterator end) +{ + return GetOptionName(p, end, wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION); +} + #endif // wxUSE_CMDLINE_PARSER // ---------------------------------------------------------------------------- @@ -990,124 +1380,129 @@ static wxString GetTypeName(wxCmdLineParamType type) /* This function is mainly used under Windows (as under Unix we always get the - command line arguments as agrc/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. + 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. + + TODO: Rewrite this to follow the even more complicated rule used by Windows + CommandLineToArgv(): - 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" + * A string of backslashes not followed by a quotation mark has no special + meaning. + * An even number of backslashes followed by a quotation mark is treated as + pairs of protected backslashes, followed by a word terminator. + * An odd number of backslashes followed by a quotation mark is treated as + pairs of protected backslashes, followed by a protected quotation mark. - To pass an argument containing spaces and quotes, the latter should be - escaped with a backslash: + See http://blogs.msdn.com/b/oldnewthing/archive/2010/09/17/10063629.aspx - myprog.exe "foo \"bar\"" -> argc = 2, argv[1] = "foo "bar"" + It could also be useful to provide a converse function which is also + non-trivial, see - This hopefully matches the conventions used by Explorer/command line - interpreter under Windows. If not, this function should be fixed. + http://blogs.msdn.com/b/twistylittlepassagesallalike/archive/2011/04/23/everyone-quotes-arguments-the-wrong-way.aspx */ /* static */ -wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) +wxArrayString +wxCmdLineParser::ConvertStringToArgs(const wxString& cmdline, + wxCmdLineSplitType type) { wxArrayString args; wxString arg; arg.reserve(1024); - bool isInsideQuotes = FALSE; + const wxString::const_iterator end = cmdline.end(); + wxString::const_iterator p = cmdline.begin(); + for ( ;; ) { // skip white space - while ( *p == _T(' ') || *p == _T('\t') ) - p++; + while ( p != end && (*p == ' ' || *p == '\t') ) + ++p; // anything left? - if ( *p == _T('\0') ) + if ( p == end ) break; // parse this parameter - arg.clear(); - for ( ;; p++ ) + bool lastBS = false, + isInsideQuotes = false; + wxChar chDelim = '\0'; + for ( arg.clear(); p != end; ++p ) { - // do we have a (lone) backslash? - bool isQuotedByBS = FALSE; - while ( *p == _T('\\') ) - { - p++; + const wxChar ch = *p; - // if we have 2 backslashes in a row, output one - if ( isQuotedByBS ) + if ( type == wxCMD_LINE_SPLIT_DOS ) + { + if ( ch == '"' ) { - arg += _T('\\'); - isQuotedByBS = FALSE; + if ( !lastBS ) + { + isInsideQuotes = !isInsideQuotes; + + // 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 } - else // the next char is quoted + // note that backslash does *not* quote the space, only quotes do + else if ( !isInsideQuotes && (ch == ' ' || ch == '\t') ) { - isQuotedByBS = TRUE; + ++p; // skip this space anyhow + break; } - } - bool skipChar = FALSE, - endParam = FALSE; - switch ( *p ) + lastBS = !lastBS && ch == '\\'; + } + else // type == wxCMD_LINE_SPLIT_UNIX { - case _T('"'): - if ( !isQuotedByBS ) + if ( !lastBS ) + { + if ( isInsideQuotes ) { - // don't put the quote itself in the arg - skipChar = TRUE; + if ( ch == chDelim ) + { + isInsideQuotes = false; - isInsideQuotes = !isInsideQuotes; + continue; // don't use the quote itself + } } - //else: insert a literal quote - - 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 - if ( isInsideQuotes ) + else // not in quotes and not escaped { - // preserve it, skip endParam below - break; - } - //else: fall through + if ( ch == '\'' || ch == '"' ) + { + isInsideQuotes = true; + chDelim = ch; - case _T('\0'): - endParam = TRUE; - break; + continue; // don't use the quote itself + } - 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('\\'); + if ( ch == ' ' || ch == '\t' ) + { + ++p; // skip this space anyhow + break; + } } - } - // end of argument? - if ( endParam ) - break; - - // otherwise copy this char to arg - if ( !skipChar ) - { - arg += *p; + lastBS = ch == '\\'; + if ( lastBS ) + continue; + } + else // escaped by backslash, just use as is + { + lastBS = false; + } } + + arg += ch; } - args.Add(arg); + args.push_back(arg); } return args; } -