///////////////////////////////////////////////////////////////////////////////
-// Name: common/cmdline.cpp
+// Name: src/common/cmdline.cpp
// Purpose: wxCmdLineParser implementation
// Author: Vadim Zeitlin
// Modified by:
#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"
#endif //WX_PRECOMP
+#include "wx/cmdline.h"
+
+#if wxUSE_CMDLINE_PARSER
+
#include <ctype.h>
#include "wx/datetime.h"
#include "wx/msgout.h"
#include "wx/filename.h"
+#include "wx/apptrait.h"
// ----------------------------------------------------------------------------
// private functions
static wxString GetTypeName(wxCmdLineParamType type);
-static wxString GetOptionName(const wxChar *p, const wxChar *allowedChars);
+static wxString GetOptionName(wxString::const_iterator p,
+ wxString::const_iterator end,
+ const wxChar *allowedChars);
-static wxString GetShortOptionName(const wxChar *p);
+static wxString GetShortOptionName(wxString::const_iterator p,
+ wxString::const_iterator end);
-static wxString GetLongOptionName(const wxChar *p);
+static wxString GetLongOptionName(wxString::const_iterator p,
+ wxString::const_iterator end);
// ----------------------------------------------------------------------------
// private structs
_T("option should have at least one name") );
wxASSERT_MSG
- (
- GetShortOptionName(shrt).Len() == shrt.Len(),
- wxT("Short option contains invalid characters")
- );
+ (
+ GetShortOptionName(shrt.begin(), shrt.end()).Len() == shrt.Len(),
+ wxT("Short option contains invalid characters")
+ );
wxASSERT_MSG
- (
- GetLongOptionName(lng).Len() == lng.Len(),
- wxT("Long option contains invalid characters")
- );
+ (
+ GetLongOptionName(lng.begin(), lng.end()).Len() == lng.Len(),
+ wxT("Long option contains invalid characters")
+ );
kind = k;
wxASSERT_MSG( type == typ, _T("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_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; }
void SetStrVal(const wxString& val)
{ Check(wxCMD_LINE_VAL_STRING); m_strVal = val; m_hasVal = true; }
#if wxUSE_DATETIME
- void SetDateVal(const wxDateTime val)
+ void SetDateVal(const wxDateTime& val)
{ Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = true; }
#endif // wxUSE_DATETIME
private:
bool m_hasVal;
+ double m_doubleVal;
long m_longVal;
wxString m_strVal;
#if wxUSE_DATETIME
#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
// 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
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);
}
}
+void wxCmdLineParserData::SetArguments(int WXUNUSED(argc),
+ const wxCmdLineArgsArray& argv)
+{
+ m_arguments = argv.GetArguments();
+}
+
#endif // wxUSE_UNICODE
void wxCmdLineParserData::SetArguments(const wxString& cmdLine)
{
m_arguments.clear();
- m_arguments.push_back(wxTheApp ? wxTheApp->argv[0] : _T(""));
+ if(wxTheApp && wxTheApp->argc > 0)
+ m_arguments.push_back(wxTheApp->argv[0]);
+ else
+ m_arguments.push_back(wxEmptyString);
wxArrayString args = wxCmdLineParser::ConvertStringToArgs(cmdLine);
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->m_enableLongOptions = enable;
}
-bool wxCmdLineParser::AreLongOptionsEnabled()
+bool wxCmdLineParser::AreLongOptionsEnabled() const
{
return m_data->m_enableLongOptions;
}
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;
default:
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, _T("unknown option") );
+
+ wxCmdLineOption& opt = m_data->m_options[(size_t)i];
+ if ( !opt.HasValue() )
+ return false;
+
+ wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") );
+
+ *value = opt.GetDoubleVal();
+
+ return true;
+}
+
#if wxUSE_DATETIME
bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) 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);
// 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 ( arg[0u] == _T('-') && arg[1u] == _T('-') )
+ if ( arg.length() >= 3 && arg[0u] == _T('-') && arg[1u] == _T('-') )
{
// a long one
isLong = true;
// Skip leading "--"
- const wxChar *p = arg.c_str() + 2;
+ wxString::const_iterator p = arg.begin() + 2;
bool longOptionsEnabled = AreLongOptionsEnabled();
- name = GetLongOptionName(p);
+ name = GetLongOptionName(p, arg.end());
if (longOptionsEnabled)
{
optInd = m_data->FindOptionByLongName(name);
if ( optInd == wxNOT_FOUND )
{
- errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << wxT("\n");
+ errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str())
+ << _T('\n');
}
}
else
// Print the argument including leading "--"
name.Prepend( wxT("--") );
- errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n");
+ errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str())
+ << _T('\n');
}
}
- else
+ else // not a long option
{
isLong = false;
// 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;
+ wxString::const_iterator p = arg.begin() + 1;
- name = GetShortOptionName(p);
+ name = GetShortOptionName(p, arg.end());
size_t len = name.length();
do
{
// we couldn't find a valid option name in the
// beginning of this string
- errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n");
+ errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str())
+ << _T('\n');
break;
}
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();
-
- if ( opt.flags & wxCMD_LINE_OPTION_HELP )
+ // we must check that there is no value following the switch
+ if ( p != arg.end() )
{
- helpRequested = true;
-
- // it's not an error, but we still stop here
+ errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str())
+ << _T('\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 ( *p++ != _T('=') )
+ if ( opt.flags & wxCMD_LINE_OPTION_HELP )
{
- errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << wxT("\n");
+ helpRequested = true;
+ // it's not an error, but we still stop here
ok = false;
}
}
- else
+ }
+ else // it's an option. not a switch
+ {
+ switch ( (*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
- 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].c_str();
- }
- break;
+ case _T('='):
+ case _T(':'):
+ // 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 )
- {
- errorMsg << wxString::Format(_("Separator expected after the option '%s'."),
- name.c_str()) << wxT("\n");
+ 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())
+ << _T('\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())
+ << _T('\n');
+
+ ok = false;
+ }
}
if ( ok )
{
- wxString value = p;
+ wxString value(p, end);
switch ( opt.type )
{
default:
else
{
errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."),
- value.c_str(), name.c_str()) << wxT("\n");
+ value.c_str(), name.c_str())
+ << _T('\n');
+
+ ok = false;
+ }
+ }
+ 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())
+ << _T('\n');
ok = false;
}
case wxCMD_LINE_VAL_DATE:
{
wxDateTime dt;
- const wxChar *res = dt.ParseDate(value);
+ const char *res = dt.ParseDate(value);
if ( !res || *res )
{
errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),
- name.c_str(), value.c_str()) << wxT("\n");
+ name.c_str(), value.c_str())
+ << _T('\n');
ok = false;
}
}
}
}
- else
+ else // not an option, must be a parameter
{
- // a parameter
if ( currentParam < countParam )
{
wxCmdLineParam& param = m_data->m_paramDesc[currentParam];
}
else
{
- errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << wxT("\n");
+ errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str())
+ << _T('\n');
ok = false;
}
}
errorMsg << wxString::Format(_("The value for the option '%s' must be specified."),
- optName.c_str()) << wxT("\n");
+ optName.c_str())
+ << _T('\n');
ok = false;
}
if ( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL) )
{
errorMsg << wxString::Format(_("The required parameter '%s' was not specified."),
- param.description.c_str()) << wxT("\n");
+ param.description.c_str())
+ << _T('\n');
ok = false;
}
// give the usage message
// ----------------------------------------------------------------------------
-void wxCmdLineParser::Usage()
+void wxCmdLineParser::Usage() const
{
wxMessageOutput* msgOut = wxMessageOutput::Get();
if ( msgOut )
}
}
-wxString wxCmdLineParser::GetUsageString()
+wxString wxCmdLineParser::GetUsageString() const
{
wxString appname;
if ( m_data->m_arguments.empty() )
if (!opt.longName.empty())
{
wxFAIL_MSG( wxT("option with only a long name while long ")
- wxT("options are disabled") );
+ wxT("options are disabled") );
}
else
{
usage << _T('\n');
+ // set to number of our own options, not counting the standard ones
+ count = namesOptions.size();
+
+ // 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.size();
- for ( n = 0; n < count; n++ )
+ for ( n = 0; n < namesOptions.size(); n++ )
{
len = namesOptions[n].length();
if ( len > lenMax )
lenMax = len;
}
- for ( n = 0; n < count; n++ )
+ for ( n = 0; n < namesOptions.size(); n++ )
{
+ if ( n == count )
+ usage << _T('\n') << stdDesc;
+
len = namesOptions[n].length();
usage << namesOptions[n]
<< wxString(_T(' '), lenMax - len) << _T('\t')
s = _("num");
break;
+ case wxCMD_LINE_VAL_DOUBLE:
+ s = _("double");
+ break;
+
case wxCMD_LINE_VAL_DATE:
s = _("date");
break;
For example, if p points to "abcde-@-_", and allowedChars is "-_",
this function returns "abcde-".
*/
-static wxString GetOptionName(const wxChar *p,
- const wxChar *allowedChars)
+static wxString GetOptionName(wxString::const_iterator p,
+ wxString::const_iterator end,
+ const wxChar *allowedChars)
{
wxString argName;
- while ( *p && (wxIsalnum(*p) || wxStrchr(allowedChars, *p)) )
+ while ( p != end && (wxIsalnum(*p) || wxStrchr(allowedChars, *p)) )
{
argName += *p++;
}
#define wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION \
wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION wxT("-")
-static wxString GetShortOptionName(const wxChar *p)
+static wxString GetShortOptionName(wxString::const_iterator p,
+ wxString::const_iterator end)
{
- return GetOptionName(p, wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION);
+ return GetOptionName(p, end, wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION);
}
-static wxString GetLongOptionName(const wxChar *p)
+static wxString GetLongOptionName(wxString::const_iterator p,
+ wxString::const_iterator end)
{
- return GetOptionName(p, wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION);
+ return GetOptionName(p, end, wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION);
}
#endif // wxUSE_CMDLINE_PARSER
*/
/* static */
-wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
+wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxString& cmdline)
{
wxArrayString args;
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
- bool endParam = false;
bool lastBS = false;
- for ( arg.clear(); !endParam; p++ )
+ for ( arg.clear(); p != end; ++p )
{
- switch ( *p )
+ const wxChar ch = *p;
+ if ( ch == '"' )
{
- 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;
+ if ( !lastBS )
+ {
+ isInsideQuotes = !isInsideQuotes;
- break;
+ // 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
}
-
- if ( endParam )
+ // note that backslash does *not* quote the space, only quotes do
+ else if ( !isInsideQuotes && (ch == ' ' || ch == '\t') )
{
+ ++p; // skip this space anyhow
break;
}
- lastBS = *p == _T('\\');
+ lastBS = ch == '\\';
- arg += *p;
+ arg += ch;
}
args.push_back(arg);
return args;
}
-