#pragma hdrstop
#endif
+#include "wx/cmdline.h"
+
+#if wxUSE_CMDLINE_PARSER
+
#ifndef WX_PRECOMP
#include "wx/string.h"
#include "wx/log.h"
#include "wx/filefn.h"
#endif //WX_PRECOMP
+#include <ctype.h>
+
#include "wx/datetime.h"
-#include "wx/cmdline.h"
+#include "wx/msgout.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
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;
// 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") );
}
void SetDateVal(const wxDateTime val)
{ Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = TRUE; }
- 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;
{
// options
wxString m_switchChars; // characters which may start an option
-
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()
// methods
wxCmdLineParserData();
- void SetArguments(int argc, char **argv);
+ void SetArguments(int argc, wxChar **argv);
void SetArguments(const wxString& cmdline);
int FindOption(const wxString& name);
#endif
}
-void wxCmdLineParserData::SetArguments(int argc, char **argv)
+void wxCmdLineParserData::SetArguments(int argc, wxChar **argv)
{
m_arguments.Empty();
}
}
-void wxCmdLineParserData::SetArguments(const wxString& cmdline)
+void wxCmdLineParserData::SetArguments(const wxString& cmdLine)
{
- // either use wxMSW wxApp::ConvertToStandardCommandArgs() or move its logic
- // here and use this method from it - but don't duplicate the code
+ m_arguments.Empty();
+
+ m_arguments.Add(wxTheApp->GetAppName());
- wxFAIL_MSG(_T("TODO"));
+ 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;
+ }
}
}
m_data = new wxCmdLineParserData;
}
-void wxCmdLineParser::SetCmdLine(int argc, char **argv)
+void wxCmdLineParser::SetCmdLine(int argc, wxChar **argv)
{
m_data->SetArguments(argc, argv);
}
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
// ----------------------------------------------------------------------------
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:
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
bool wxCmdLineParser::Found(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") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
bool wxCmdLineParser::Found(const wxString& name, wxString *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];
bool wxCmdLineParser::Found(const wxString& name, long *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];
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") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
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
size_t currentParam = 0; // the index in m_paramDesc
size_t countParam = m_data->m_paramDesc.GetCount();
+ wxString errorMsg;
+
+ Reset();
// parse everything
wxString arg;
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 ( 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()) << "\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
{
// 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
{
// 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;
}
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;
}
{
switch ( *p )
{
+ case _T('='):
case _T(':'):
// the value follows
p++;
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;
}
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()) << "\n";
+
+ ok = FALSE;
+ }
}
}
}
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;
}
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;
}
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;
}
else
{
- wxLogError(_("Unexpected parameter '%s'"), arg.c_str());
+ errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << "\n";
ok = FALSE;
}
}
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;
}
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;
// ----------------------------------------------------------------------------
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);
}
- wxString brief, detailed;
- brief.Printf(_("Usage: %s"), appname.c_str());
+ // 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 )
+ {
+ 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('[');
+ }
+
+ 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;
+
+ if ( !opt.shortName.empty() )
+ {
+ option << _T(" ") << chSwitch << opt.shortName;
}
- brief << _T('-') << opt.shortName;
- detailed << _T(" -") << opt.shortName;
- if ( !!opt.longName )
+ if ( areLongOptionsEnabled && !opt.longName.empty() )
{
- detailed << _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;
- 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.Add(option);
+ descOptions.Add(opt.description);
}
count = m_data->m_paramDesc.GetCount();
{
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.GetCount();
+ 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)
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)
+{
+ 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
+ arg.clear();
+ for ( ;; p++ )
+ {
+ // do we have a (lone) backslash?
+ bool isQuotedByBS = FALSE;
+ while ( *p == _T('\\') )
+ {
+ p++;
+
+ // if we have 2 backslashes in a row, output one
+ // unless it looks like a UNC path \\machine\dir\file.ext
+ if ( isQuotedByBS || arg.Len() == 0 )
+ {
+ arg += _T('\\');
+ isQuotedByBS = FALSE;
+ }
+ else // the next char is quoted
+ {
+ isQuotedByBS = TRUE;
+ }
+ }
+
+ bool skipChar = FALSE,
+ endParam = FALSE;
+ switch ( *p )
+ {
+ case _T('"'):
+ if ( !isQuotedByBS )
+ {
+ // don't put the quote itself in the arg
+ skipChar = TRUE;
+
+ isInsideQuotes = !isInsideQuotes;
+ }
+ //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 )
+ {
+ // preserve it, skip endParam below
+ break;
+ }
+ //else: fall through
+
+ 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?
+ if ( endParam )
+ break;
+
+ // otherwise copy this char to arg
+ if ( !skipChar )
+ {
+ arg += *p;
+ }
+ }
+
+ args.Add(arg);
+ }
+
+ return args;
+}
+
projects / wxWidgets.git / blobdiff