///////////////////////////////////////////////////////////////////////////////
-// 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 <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "cmdline.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#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 <ctype.h>
#include "wx/datetime.h"
#include "wx/msgout.h"
+#include "wx/filename.h"
// ----------------------------------------------------------------------------
// private functions
wxT("Long option contains invalid characters")
);
+
kind = k;
shortName = shrt;
type = typ;
flags = fl;
- m_hasVal = FALSE;
+ m_hasVal = false;
}
// can't use union easily here, so just store all possible data fields, we
{ 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(bool hasValue = TRUE) { m_hasVal = hasValue; }
+ void SetHasValue(bool hasValue = true) { m_hasVal = hasValue; }
bool HasValue() const { return m_hasVal; }
public:
long m_longVal;
wxString m_strVal;
+#if wxUSE_DATETIME
wxDateTime m_dateVal;
+#endif // wxUSE_DATETIME
};
struct wxCmdLineParam
#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
// 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);
wxCmdLineParserData::wxCmdLineParserData()
{
- m_enableLongOptions = TRUE;
+ m_enableLongOptions = true;
#ifdef __UNIX_LIKE__
m_switchChars = _T("-");
#else // !Unix
#endif
}
+void wxCmdLineParserData::SetArguments(int argc, char **argv)
+{
+ m_arguments.clear();
+
+ for ( int n = 0; n < argc; n++ )
+ {
+ m_arguments.push_back(wxString::FromAscii(argv[n]));
+ }
+}
+
+#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]);
}
}
+#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);
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);
}
+#endif // wxUSE_UNICODE
+
void wxCmdLineParser::SetCmdLine(const wxString& cmdline)
{
m_data->SetArguments(cmdline);
if ( i == wxNOT_FOUND )
i = m_data->FindOptionByLongName(name);
- wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") );
+ 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
if ( i == wxNOT_FOUND )
i = m_data->FindOptionByLongName(name);
- wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
+ 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
if ( i == wxNOT_FOUND )
i = m_data->FindOptionByLongName(name);
- wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
+ 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);
if ( i == wxNOT_FOUND )
i = m_data->FindOptionByLongName(name);
- wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
+ 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
for ( size_t i = 0; i < m_data->m_options.Count(); i++ )
{
wxCmdLineOption& opt = m_data->m_options[i];
- opt.SetHasValue(FALSE);
+ opt.SetHasValue(false);
}
}
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
// 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];
// not like options (this is POSIX-like)
if ( arg == _T("--") )
{
- maybeOption = FALSE;
+ maybeOption = false;
continue;
}
if ( arg[0u] == _T('-') && arg[1u] == _T('-') )
{
// a long one
- isLong = TRUE;
+ isLong = true;
// Skip leading "--"
const wxChar *p = arg.c_str() + 2;
optInd = m_data->FindOptionByLongName(name);
if ( optInd == wxNOT_FOUND )
{
- errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << "\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()) << "\n";
+ 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
{
// we couldn't find a valid option name in the
// beginning of this string
- errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << "\n";
+ errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str())
+ << _T('\n');
break;
}
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++;
}
//else: it's our value, we'll deal with it below
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('=') )
{
- errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str()) << "\n";
+ errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
}
- else
+ else // short option
{
switch ( *p )
{
{
// ... but there is none
errorMsg << wxString::Format(_("Option '%s' requires a value."),
- name.c_str()) << "\n";
+ name.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
else
{
if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR )
{
errorMsg << wxString::Format(_("Separator expected after the option '%s'."),
- name.c_str()) << "\n";
+ name.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
}
}
else
{
errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."),
- value.c_str(), name.c_str()) << "\n";
+ value.c_str(), name.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
}
break;
+#if wxUSE_DATETIME
case wxCMD_LINE_VAL_DATE:
{
wxDateTime dt;
if ( !res || *res )
{
errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),
- name.c_str(), value.c_str()) << "\n";
+ name.c_str(), value.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
else
{
}
}
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) )
{
_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
{
- errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << "\n";
+ errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str())
+ << _T('\n');
- ok = FALSE;
+ 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() );
+ }
}
errorMsg << wxString::Format(_("The value for the option '%s' must be specified."),
- optName.c_str()) << "\n";
+ optName.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
}
if ( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL) )
{
errorMsg << wxString::Format(_("The required parameter '%s' was not specified."),
- param.description.c_str()) << "\n";
+ param.description.c_str())
+ << _T('\n');
- ok = FALSE;
+ ok = false;
}
}
}
- if ( !ok && errorMsg.length() != 0 )
+ // 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)) )
{
- wxString usage;
wxMessageOutput* msgOut = wxMessageOutput::Get();
- if ( showUsage ) usage = GetUsageString();
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;
void wxCmdLineParser::Usage()
{
- wxString usage = GetUsageString();
wxMessageOutput* msgOut = wxMessageOutput::Get();
if ( msgOut )
- msgOut->Printf( wxT("%s"), usage.c_str() );
+ {
+ msgOut->Printf( wxT("%s"), GetUsageString().c_str() );
+ }
+ else
+ {
+ wxFAIL_MSG( _T("no wxMessageOutput object?") );
+ }
}
wxString wxCmdLineParser::GetUsageString()
{
- wxString appname = wxTheApp->GetAppName();
- if ( !appname )
+ wxString appname;
+ if ( m_data->m_arguments.empty() )
{
- wxCHECK_MSG( !m_data->m_arguments.IsEmpty(), wxEmptyString,
- _T("no program name") );
-
- appname = wxFileNameFromPath(m_data->m_arguments[0]);
- wxStripExtension(appname);
+ 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
wxString usage;
wxArrayString namesOptions, descOptions;
- if ( !!m_data->m_logo )
+ if ( !m_data->m_logo.empty() )
{
usage << m_data->m_logo << _T('\n');
}
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(']');
}
- namesOptions.Add(option);
- descOptions.Add(opt.description);
+ namesOptions.push_back(option);
+ descOptions.push_back(opt.description);
}
count = m_data->m_paramDesc.GetCount();
// now construct the detailed help message
size_t len, lenMax = 0;
- count = namesOptions.GetCount();
+ count = namesOptions.size();
for ( n = 0; n < count; n++ )
{
len = namesOptions[n].length();
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;
/*
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.
+ 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 */
wxString arg;
arg.reserve(1024);
- bool isInsideQuotes = FALSE;
+ bool isInsideQuotes = false;
for ( ;; )
{
// skip white space
break;
// parse this parameter
- arg.clear();
- for ( ;; p++ )
+ bool endParam = false;
+ bool lastBS = false;
+ for ( arg.clear(); !endParam; 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 )
+ if ( !lastBS )
{
- // don't put the quote itself in the arg
- skipChar = TRUE;
-
isInsideQuotes = !isInsideQuotes;
- }
- //else: insert a literal quote
+ // 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'):
- // 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
+ // backslash does *not* quote the space, only quotes do
if ( isInsideQuotes )
{
- // preserve it, skip endParam below
+ // skip assignment below
break;
}
- //else: fall through
+ // fall through
case _T('\0'):
- endParam = TRUE;
- break;
+ endParam = true;
- 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('\\');
- }
+ break;
}
- // end of argument?
if ( endParam )
- break;
-
- // otherwise copy this char to arg
- if ( !skipChar )
{
- arg += *p;
+ break;
}
+
+ lastBS = *p == _T('\\');
+
+ arg += *p;
}
- args.Add(arg);
+ args.push_back(arg);
}
return args;
}
-
projects / wxWidgets.git / blobdiff