// Created: 05.01.00
// RCS-ID: $Id$
// Copyright: (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
#include <ctype.h>
#include "wx/datetime.h"
+#include "wx/msgout.h"
// ----------------------------------------------------------------------------
// private functions
GetLongOptionName(lng).Len() == lng.Len(),
wxT("Long option contains invalid characters")
);
+
kind = k;
{ 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; }
void SetStrVal(const wxString& val)
{ 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; }
bool HasValue() const { return m_hasVal; }
long m_longVal;
wxString m_strVal;
+#if wxUSE_DATETIME
wxDateTime m_dateVal;
+#endif // wxUSE_DATETIME
};
struct wxCmdLineParam
return TRUE;
}
+#if wxUSE_DATETIME
bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const
{
int i = m_data->FindOption(name);
return TRUE;
}
+#endif // wxUSE_DATETIME
size_t wxCmdLineParser::GetParamCount() const
{
size_t currentParam = 0; // the index in m_paramDesc
size_t countParam = m_data->m_paramDesc.GetCount();
+ wxString errorMsg;
Reset();
optInd = m_data->FindOptionByLongName(name);
if ( optInd == wxNOT_FOUND )
{
- wxLogError(_("Unknown long option '%s'"), name.c_str());
+ errorMsg << wxString::Format(_("Unknown long option '%s'"), name.c_str()) << wxT("\n");
}
}
else
// Print the argument including leading "--"
name.Prepend( wxT("--") );
- wxLogError(_("Unknown option '%s'"), name.c_str());
+ errorMsg << wxString::Format(_("Unknown option '%s'"), name.c_str()) << wxT("\n");
}
}
{
// 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()) << wxT("\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()) << wxT("\n");
ok = FALSE;
}
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()) << wxT("\n");
ok = FALSE;
}
// not depending on the option style
if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR )
{
- wxLogError(_("Separator expected after the option '%s'."),
- name.c_str());
+ errorMsg << wxString::Format(_("Separator expected after the option '%s'."),
+ name.c_str()) << wxT("\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()) << wxT("\n");
ok = FALSE;
}
}
break;
+#if wxUSE_DATETIME
case wxCMD_LINE_VAL_DATE:
{
wxDateTime dt;
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()) << wxT("\n");
ok = FALSE;
}
}
}
break;
+#endif // wxUSE_DATETIME
}
}
}
}
else
{
- wxLogError(_("Unexpected parameter '%s'"), arg.c_str());
+ errorMsg << wxString::Format(_("Unexpected parameter '%s'"), arg.c_str()) << wxT("\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()) << wxT("\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()) << wxT("\n");
ok = FALSE;
}
}
}
- if ( !ok && showUsage )
+ // 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;
// ----------------------------------------------------------------------------
void wxCmdLineParser::Usage()
+{
+ 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 = 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);
// 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 brief;
+ wxString usage;
wxArrayString namesOptions, descOptions;
- brief.Printf(_("Usage: %s"), appname.c_str());
+
+ 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
{
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() )
{
- brief << chSwitch << opt.shortName;
+ usage << chSwitch << opt.shortName;
}
else if ( areLongOptionsEnabled && !opt.longName.empty() )
{
- brief << _T("--") << opt.longName;
+ usage << _T("--") << opt.longName;
}
else
{
{
wxString val;
val << _T('<') << GetTypeName(opt.type) << _T('>');
- brief << _T(' ') << val;
+ usage << _T(' ') << val;
option << (!opt.longName ? _T(':') : _T('=')) << val;
}
if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
{
- brief << _T(']');
+ usage << _T(']');
}
namesOptions.Add(option);
{
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(']');
}
}
- if ( !!m_data->m_logo )
- {
- wxLogMessage(m_data->m_logo);
- }
-
- // in console mode we want to show the brief usage message first, then the
- // detailed one but in GUI build we give the details first and then the
- // summary - like this, the brief message appears in the wxLogGui dialog,
- // as expected
-#if !wxUSE_GUI
- wxLogMessage(brief);
-#endif // !wxUSE_GUI
+ usage << _T('\n');
// now construct the detailed help message
size_t len, lenMax = 0;
lenMax = len;
}
- wxString detailed;
for ( n = 0; n < count; n++ )
{
len = namesOptions[n].length();
- detailed << namesOptions[n]
- << wxString(_T(' '), lenMax - len) << _T('\t')
- << descOptions[n]
- << _T('\n');
+ usage << namesOptions[n]
+ << wxString(_T(' '), lenMax - len) << _T('\t')
+ << descOptions[n]
+ << _T('\n');
}
- wxLogMessage(detailed);
-
- // do it now if not done above
-#if wxUSE_GUI
- wxLogMessage(brief);
-#endif // wxUSE_GUI
+ return usage;
}
// ----------------------------------------------------------------------------
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;
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"