#if wxUSE_CMDLINE_PARSER
#include <ctype.h>
+#include <locale.h> // 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
wxCmdLineParamType typ,
int fl)
{
- wxASSERT_MSG( !shrt.empty() || !lng.empty(),
- _T("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")
- );
-
+ // 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;
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
{
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++ )
{
- m_arguments.push_back(wxString::FromAscii(argv[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);
}
}
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:
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,
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,
{
// 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
// ----------------------------------------------------------------------------
if ( i == wxNOT_FOUND )
i = m_data->FindOptionByLongName(name);
- wxCHECK_MSG( i != wxNOT_FOUND, false, _T("unknown switch") );
+ wxCHECK_MSG( i != wxNOT_FOUND, false, wxT("unknown switch") );
wxCmdLineOption& opt = m_data->m_options[(size_t)i];
if ( !opt.HasValue() )
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;
- wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") );
+ wxCHECK_MSG( value, false, wxT("NULL pointer in wxCmdLineOption::Found") );
*value = opt.GetStrVal();
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;
- wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") );
+ wxCHECK_MSG( value, false, wxT("NULL pointer in wxCmdLineOption::Found") );
*value = opt.GetLongVal();
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;
- wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") );
+ wxCHECK_MSG( value, false, wxT("NULL pointer in wxCmdLineOption::Found") );
*value = opt.GetDoubleVal();
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;
- wxCHECK_MSG( value, false, _T("NULL pointer in wxCmdLineOption::Found") );
+ wxCHECK_MSG( value, false, wxT("NULL pointer in wxCmdLineOption::Found") );
*value = opt.GetDateVal();
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];
}
// 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;
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.length() >= 3 && arg[0u] == _T('-') && arg[1u] == _T('-') )
+ if ( arg.length() >= 3 && arg[0u] == wxT('-') && arg[1u] == wxT('-') )
{
// a long one
isLong = true;
if ( optInd == wxNOT_FOUND )
{
errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str())
- << _T('\n');
+ << wxT('\n');
}
}
else
// Print the argument including leading "--"
name.Prepend( wxT("--") );
errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str())
- << _T('\n');
+ << wxT('\n');
}
}
// we couldn't find a valid option name in the
// beginning of this string
errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str())
- << _T('\n');
+ << wxT('\n');
break;
}
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
}
if ( p != arg.end() )
{
errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
else // no value, as expected
}
else // it's an option. not a switch
{
- switch ( (*p).GetValue() )
+ switch ( p == end ? '\0' : (*p).GetValue() )
{
- case _T('='):
- case _T(':'):
+ case '=':
+ case ':':
// the value follows
++p;
break;
- case 0:
+ 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');
+ << wxT('\n');
ok = false;
}
{
errorMsg << wxString::Format(_("Separator expected after the option '%s'."),
name.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
switch ( opt.type )
{
default:
- wxFAIL_MSG( _T("unknown option type") );
+ wxFAIL_MSG( wxT("unknown option type") );
// still fall through
case wxCMD_LINE_VAL_STRING:
{
errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."),
value.c_str(), name.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
{
errorMsg << wxString::Format(_("'%s' is not a correct numeric value for option '%s'."),
value.c_str(), name.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
case wxCMD_LINE_VAL_DATE:
{
wxDateTime dt;
- const char *res = dt.ParseDate(value);
- if ( !res || *res )
+ wxString::const_iterator end;
+ if ( !dt.ParseDate(value, &end) || end != value.end() )
{
errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),
name.c_str(), value.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
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;
else
{
errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
errorMsg << wxString::Format(_("The value for the option '%s' must be specified."),
optName.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
{
errorMsg << wxString::Format(_("The required parameter '%s' was not specified."),
param.description.c_str())
- << _T('\n');
+ << wxT('\n');
ok = false;
}
}
else
{
- wxFAIL_MSG( _T("no wxMessageOutput object?") );
+ wxFAIL_MSG( wxT("no wxMessageOutput object?") );
}
}
}
else
{
- wxFAIL_MSG( _T("no wxMessageOutput object?") );
+ wxFAIL_MSG( wxT("no wxMessageOutput object?") );
}
}
if ( !m_data->m_logo.empty() )
{
- usage << m_data->m_logo << _T('\n');
+ 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();
for ( n = 0; n < count; n++ )
{
wxCmdLineOption& opt = m_data->m_options[n];
+ wxString option;
- usage << _T(' ');
- if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
+ if ( opt.kind != wxCMD_LINE_USAGE_TEXT )
{
- usage << _T('[');
- }
+ usage << wxT(' ');
+ if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
+ {
+ usage << wxT('[');
+ }
- if ( !opt.shortName.empty() )
- {
- usage << chSwitch << opt.shortName;
- }
- else if ( areLongOptionsEnabled && !opt.longName.empty() )
- {
- usage << _T("--") << opt.longName;
- }
- else
- {
- if (!opt.longName.empty())
+ if ( !opt.shortName.empty() )
+ {
+ usage << chSwitch << opt.shortName;
+ }
+ else if ( areLongOptionsEnabled && !opt.longName.empty() )
{
- wxFAIL_MSG( wxT("option with only a long name while long ")
- wxT("options are disabled") );
+ usage << wxT("--") << opt.longName;
}
else
{
- wxFAIL_MSG( _T("option without neither short nor long name") );
+ 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") );
+ }
}
- }
- wxString option;
-
- if ( !opt.shortName.empty() )
- {
- option << _T(" ") << chSwitch << opt.shortName;
- }
+ if ( !opt.shortName.empty() )
+ {
+ option << wxT(" ") << chSwitch << opt.shortName;
+ }
- if ( areLongOptionsEnabled && !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('>');
- usage << _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) )
- {
- usage << _T(']');
+ if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
+ {
+ usage << wxT(']');
+ }
}
namesOptions.push_back(option);
{
wxCmdLineParam& param = m_data->m_paramDesc[n];
- usage << _T(' ');
+ usage << wxT(' ');
if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL )
{
- usage << _T('[');
+ usage << wxT('[');
}
usage << param.description;
if ( param.flags & wxCMD_LINE_PARAM_MULTIPLE )
{
- usage << _T("...");
+ usage << wxT("...");
}
if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL )
{
- usage << _T(']');
+ usage << wxT(']');
}
}
- usage << _T('\n');
+ usage << wxT('\n');
// set to number of our own options, not counting the standard ones
count = namesOptions.size();
for ( n = 0; n < namesOptions.size(); n++ )
{
if ( n == count )
- usage << _T('\n') << stdDesc;
+ usage << wxT('\n') << stdDesc;
len = namesOptions[n].length();
- usage << 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');
+ }
}
return usage;
switch ( type )
{
default:
- wxFAIL_MSG( _T("unknown option type") );
+ wxFAIL_MSG( wxT("unknown option type") );
// still fall through
case wxCMD_LINE_VAL_STRING:
*/
/* static */
-wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxString& cmdline)
+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 != cmdline.end() && (*p == _T(' ') || *p == _T('\t')) )
+ while ( p != end && (*p == ' ' || *p == '\t') )
++p;
// anything left?
- if ( p == cmdline.end() )
+ if ( p == end )
break;
// parse this parameter
- bool endParam = false;
- bool lastBS = false;
- for ( arg.clear(); !endParam; p++ )
+ bool lastBS = false,
+ isInsideQuotes = false;
+ wxChar chDelim = '\0';
+ for ( arg.clear(); p != end; ++p )
{
- switch ( (*p).GetValue() )
+ const wxChar ch = *p;
+
+ if ( type == wxCMD_LINE_SPLIT_DOS )
{
- case _T('"'):
+ if ( ch == '"' )
+ {
if ( !lastBS )
{
isInsideQuotes = !isInsideQuotes;
//else: quote has no special meaning but the backslash
// still remains -- makes no sense but this is what
// Windows does
+ }
+ // note that backslash does *not* quote the space, only quotes do
+ else if ( !isInsideQuotes && (ch == ' ' || ch == '\t') )
+ {
+ ++p; // skip this space anyhow
break;
+ }
- case _T(' '):
- case _T('\t'):
- // backslash does *not* quote the space, only quotes do
+ lastBS = !lastBS && ch == '\\';
+ }
+ else // type == wxCMD_LINE_SPLIT_UNIX
+ {
+ if ( !lastBS )
+ {
if ( isInsideQuotes )
{
- // skip assignment below
- break;
+ if ( ch == chDelim )
+ {
+ isInsideQuotes = false;
+
+ continue; // don't use the quote itself
+ }
}
- // fall through
+ else // not in quotes and not escaped
+ {
+ if ( ch == '\'' || ch == '"' )
+ {
+ isInsideQuotes = true;
+ chDelim = ch;
- case _T('\0'):
- endParam = true;
+ continue; // don't use the quote itself
+ }
- break;
- }
+ if ( ch == ' ' || ch == '\t' )
+ {
+ ++p; // skip this space anyhow
+ break;
+ }
+ }
- if ( endParam )
- {
- break;
+ lastBS = ch == '\\';
+ if ( lastBS )
+ continue;
+ }
+ else // escaped by backslash, just use as is
+ {
+ lastBS = false;
+ }
}
- lastBS = *p == _T('\\');
-
- arg += *p;
+ arg += ch;
}
args.push_back(arg);
projects / wxWidgets.git / blobdiff