X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4f40f5e37059cad5b4bc6880f47f5dbeb06ec49e..55420742a101b2963c40694cb879ea3de4fb6bb2:/src/common/cmdline.cpp diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp index 3831fcf595..6a07dfb1a7 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" @@ -29,23 +25,37 @@ #endif #ifndef WX_PRECOMP + #include "wx/dynarray.h" #include "wx/string.h" #include "wx/log.h" #include "wx/intl.h" - #include "wx/dynarray.h" + #include "wx/app.h" #endif //WX_PRECOMP -#include "wx/datetime.h" #include "wx/cmdline.h" +#if wxUSE_CMDLINE_PARSER + +#include + +#include "wx/datetime.h" +#include "wx/msgout.h" +#include "wx/filename.h" + // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- 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 @@ -58,6 +68,22 @@ struct wxCmdLineOption wxCmdLineParamType typ, int fl) { + 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; @@ -67,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 @@ -75,7 +101,7 @@ struct wxCmdLineOption // types increases, so always use the accessor functions and don't access // the fields directly!) - void Check(wxCmdLineParamType typ) const + void Check(wxCmdLineParamType WXUNUSED_UNLESS_DEBUG(typ)) const { wxASSERT_MSG( type == typ, _T("type mismatch in wxCmdLineOption") ); } @@ -84,22 +110,28 @@ 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() { m_hasVal = TRUE; } + void SetHasValue(bool hasValue = true) { m_hasVal = hasValue; } bool HasValue() const { return m_hasVal; } public: wxCmdLineEntryType kind; - wxString shortName, longName, description; + wxString shortName, + longName, + description; wxCmdLineParamType type; int flags; @@ -108,7 +140,9 @@ private: long m_longVal; wxString m_strVal; +#if wxUSE_DATETIME wxDateTime m_dateVal; +#endif // wxUSE_DATETIME }; struct wxCmdLineParam @@ -132,16 +166,16 @@ 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() @@ -152,6 +186,9 @@ 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); @@ -168,7 +205,7 @@ struct wxCmdLineParserData wxCmdLineParserData::wxCmdLineParserData() { - m_enableLongOptions = TRUE; + m_enableLongOptions = true; #ifdef __UNIX_LIKE__ m_switchChars = _T("-"); #else // !Unix @@ -178,31 +215,54 @@ wxCmdLineParserData::wxCmdLineParserData() void wxCmdLineParserData::SetArguments(int argc, char **argv) { - m_arguments.Empty(); + m_arguments.clear(); for ( int n = 0; n < argc; n++ ) { - m_arguments.Add(argv[n]); + m_arguments.push_back(wxString::FromAscii(argv[n])); } } -void wxCmdLineParserData::SetArguments(const wxString& cmdline) +#if wxUSE_UNICODE + +void wxCmdLineParserData::SetArguments(int argc, wxChar **argv) { - // either use wxMSW wxApp::ConvertToStandardCommandArgs() or move its logic - // here and use this method from it - but don't duplicate the code + m_arguments.clear(); - wxFAIL_MSG(_T("TODO")); + for ( int n = 0; n < argc; n++ ) + { + m_arguments.push_back(argv[n]); + } +} + +#endif // wxUSE_UNICODE + +void wxCmdLineParserData::SetArguments(const wxString& cmdLine) +{ + m_arguments.clear(); + + if(wxTheApp && wxTheApp->argc > 0) + m_arguments.push_back(wxTheApp->argv[0]); + else + m_arguments.push_back(wxEmptyString); + + wxArrayString args = wxCmdLineParser::ConvertStringToArgs(cmdLine); + + WX_APPEND_ARRAY(m_arguments, args); } int wxCmdLineParserData::FindOption(const wxString& name) { - size_t count = m_options.GetCount(); - for ( size_t n = 0; n < count; n++ ) + if ( !name.empty() ) { - if ( m_options[n].shortName == name ) + size_t count = m_options.GetCount(); + for ( size_t n = 0; n < count; n++ ) { - // found - return n; + if ( m_options[n].shortName == name ) + { + // found + return n; + } } } @@ -238,6 +298,15 @@ 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); @@ -262,6 +331,16 @@ 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; +} + // ---------------------------------------------------------------------------- // command line construction // ---------------------------------------------------------------------------- @@ -273,7 +352,8 @@ 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, desc->description, + desc->flags); break; case wxCMD_LINE_OPTION: @@ -338,14 +418,12 @@ void wxCmdLineParser::AddParam(const wxString& desc, 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") ); + _T("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") ); + _T("a required parameter can't follow an optional one") ); } } #endif // Debug @@ -362,91 +440,121 @@ void wxCmdLineParser::AddParam(const wxString& desc, bool wxCmdLineParser::Found(const wxString& name) const { int i = m_data->FindOption(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") ); + if ( i == wxNOT_FOUND ) + i = m_data->FindOptionByLongName(name); + + 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 { int i = m_data->FindOption(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + if ( i == wxNOT_FOUND ) + i = m_data->FindOptionByLongName(name); + + 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 { int i = m_data->FindOption(name); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + if ( i == wxNOT_FOUND ) + i = m_data->FindOptionByLongName(name); + + 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); - wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") ); + if ( i == wxNOT_FOUND ) + i = m_data->FindOptionByLongName(name); + + 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 { + wxCHECK_MSG( n < GetParamCount(), wxEmptyString, _T("invalid param index") ); + return m_data->m_parameters[n]; } +// Resets switches and options +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); + } +} + + // ---------------------------------------------------------------------------- // 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 - 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]; @@ -456,7 +564,7 @@ int wxCmdLineParser::Parse() // not like options (this is POSIX-like) if ( arg == _T("--") ) { - maybeOption = FALSE; + maybeOption = false; continue; } @@ -470,35 +578,47 @@ 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; + isLong = true; + // Skip leading "--" const wxChar *p = arg.c_str() + 2; - while ( wxIsalpha(*p) || (*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()) + << _T('\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()) + << _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 const wxChar *p = arg.c_str() + 1; - while ( wxIsalpha(*p) ) - { - name += *p++; - } + + name = GetShortOptionName(p); size_t len = name.length(); do @@ -507,7 +627,8 @@ 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()) + << _T('\n'); break; } @@ -521,8 +642,13 @@ int wxCmdLineParser::Parse() } while ( optInd == wxNOT_FOUND ); + len++; // compensates extra len-- above if ( (optInd != wxNOT_FOUND) && (len != name.length()) ) { + // first of all, the option name is only part of this + // string + name = name.Left(len); + // our option is only part of this argument, there is // something else in it - it is either the value of this // option or other switches if it is a switch @@ -532,9 +658,10 @@ int wxCmdLineParser::Parse() // pretend that all the rest of the argument is the // next argument, in fact wxString arg2 = arg[0u]; - arg2 += name.Mid(len + 1); // compensates extra -- + 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 @@ -543,47 +670,60 @@ int wxCmdLineParser::Parse() 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('=') ) { - wxLogError(_("Option '%s' requires a value, '=' " - "expected."), name.c_str()); + errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } - else + else // short option { switch ( *p ) { + case _T('='): case _T(':'): // the value follows p++; @@ -594,10 +734,11 @@ 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()) + << _T('\n'); - ok = FALSE; + ok = false; } else { @@ -607,8 +748,16 @@ int wxCmdLineParser::Parse() break; default: - // the value is right here - ; + // 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()) + << _T('\n'); + + ok = false; + } } } @@ -634,27 +783,27 @@ 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()) + << _T('\n'); - ok = FALSE; + ok = false; } } break; +#if wxUSE_DATETIME case wxCMD_LINE_VAL_DATE: { wxDateTime dt; const wxChar *res = dt.ParseDate(value); if ( !res || *res ) { - wxLogError(_("Options '%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()) + << _T('\n'); - ok = FALSE; + ok = false; } else { @@ -662,20 +811,20 @@ int wxCmdLineParser::Parse() } } 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) ) { @@ -684,19 +833,18 @@ int wxCmdLineParser::Parse() else { wxASSERT_MSG( currentParam == countParam - 1, - _T("all parameters after the one with " - "wxCMD_LINE_PARAM_MULTIPLE style " - "are ignored") ); + _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 { - wxLogError(_("Unexpected parameter '%s'"), arg.c_str()); + errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) + << _T('\n'); - ok = FALSE; + ok = false; } } } @@ -717,15 +865,24 @@ 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()) + << _T('\n'); - ok = FALSE; + ok = false; } } @@ -743,17 +900,32 @@ 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()) + << _T('\n'); - ok = FALSE; + ok = false; } } } - if ( !ok ) + // 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( _T("no wxMessageOutput object?") ); + } } return ok ? 0 : helpRequested ? -1 : 1; @@ -765,41 +937,109 @@ int wxCmdLineParser::Parse() void wxCmdLineParser::Usage() { - wxString brief, detailed; - brief.Printf(_("Usage: %s"), wxTheApp->GetAppName().c_str()); + wxMessageOutput* msgOut = wxMessageOutput::Get(); + if ( msgOut ) + { + msgOut->Printf( wxT("%s"), GetUsageString().c_str() ); + } + else + { + wxFAIL_MSG( _T("no wxMessageOutput object?") ); + } +} + +wxString wxCmdLineParser::GetUsageString() +{ + 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 usage; + wxArrayString namesOptions, descOptions; + if ( !m_data->m_logo.empty() ) + { + 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 << _T('-') << opt.shortName; - detailed << _T(" -") << opt.shortName; - if ( !!opt.longName ) + if ( !opt.shortName.empty() ) + { + usage << chSwitch << opt.shortName; + } + else if ( areLongOptionsEnabled && !opt.longName.empty() ) { - detailed << _T(" --") << opt.longName; + 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; + + if ( !opt.shortName.empty() ) + { + option << _T(" ") << chSwitch << opt.shortName; + } + + if ( areLongOptionsEnabled && !opt.longName.empty() ) + { + 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; - detailed << (!opt.longName ? _T(':') : _T('=')) << val; + usage << _T(' ') << val; + option << (!opt.longName ? _T(':') : _T('=')) << val; } if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) ) { - brief << _T(']'); + usage << _T(']'); } - detailed << _T('\t') << opt.description << _T('\n'); + namesOptions.push_back(option); + descOptions.push_back(opt.description); } count = m_data->m_paramDesc.GetCount(); @@ -807,31 +1047,51 @@ 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(']'); } } - wxLogMessage(brief); - wxLogMessage(detailed); + usage << _T('\n'); + + // now construct the detailed help message + size_t len, lenMax = 0; + count = namesOptions.size(); + for ( n = 0; n < count; n++ ) + { + len = namesOptions[n].length(); + if ( len > lenMax ) + lenMax = len; + } + + for ( n = 0; n < count; n++ ) + { + len = namesOptions[n].length(); + usage << namesOptions[n] + << wxString(_T(' '), lenMax - len) << _T('\t') + << descOptions[n] + << _T('\n'); + } + + return usage; } // ---------------------------------------------------------------------------- -// global functions +// private functions // ---------------------------------------------------------------------------- static wxString GetTypeName(wxCmdLineParamType type) @@ -843,10 +1103,145 @@ 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; } + +/* +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 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 */ +wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p) +{ + wxArrayString args; + + wxString arg; + arg.reserve(1024); + + bool isInsideQuotes = false; + for ( ;; ) + { + // skip white space + while ( *p == _T(' ') || *p == _T('\t') ) + p++; + + // anything left? + if ( *p == _T('\0') ) + break; + + // parse this parameter + bool endParam = false; + bool lastBS = false; + for ( arg.clear(); !endParam; p++ ) + { + switch ( *p ) + { + case _T('"'): + 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 + break; + + case _T(' '): + case _T('\t'): + // backslash does *not* quote the space, only quotes do + if ( isInsideQuotes ) + { + // skip assignment below + break; + } + // fall through + + case _T('\0'): + endParam = true; + + break; + } + + if ( endParam ) + { + break; + } + + lastBS = *p == _T('\\'); + + arg += *p; + } + + args.push_back(arg); + } + + return args; +}