]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/cmdline.cpp
moving all dataview files to advanced
[wxWidgets.git] / src / common / cmdline.cpp
index 30bf7f09d6e50d1db4b6b8a767d3e475592c0649..c0a7e4131c1fe19717173c52fe38302eb878f167 100644 (file)
 
 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
@@ -69,21 +73,27 @@ struct wxCmdLineOption
                     wxCmdLineParamType typ,
                     int fl)
     {
-        wxASSERT_MSG( !shrt.empty() || !lng.empty(),
-                      _T("option should have at least one name") );
+        // 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
+            wxASSERT_MSG
             (
-                GetShortOptionName(shrt).Len() == shrt.Len(),
+                GetShortOptionName(shrt.begin(), shrt.end()).Len() == shrt.Len(),
                 wxT("Short option contains invalid characters")
             );
 
-        wxASSERT_MSG
+            wxASSERT_MSG
             (
-                GetLongOptionName(lng).Len() == lng.Len(),
+                GetLongOptionName(lng.begin(), lng.end()).Len() == lng.Len(),
                 wxT("Long option contains invalid characters")
             );
-
+        }
 
         kind = k;
 
@@ -107,6 +117,8 @@ struct wxCmdLineOption
         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
@@ -116,6 +128,8 @@ struct wxCmdLineOption
         { 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)
@@ -139,6 +153,7 @@ public:
 private:
     bool m_hasVal;
 
+    double m_doubleVal;
     long m_longVal;
     wxString m_strVal;
 #if wxUSE_DATETIME
@@ -189,6 +204,7 @@ struct wxCmdLineParserData
     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);
 
@@ -236,6 +252,12 @@ void wxCmdLineParserData::SetArguments(int argc, wxChar **argv)
     }
 }
 
+void wxCmdLineParserData::SetArguments(int WXUNUSED(argc),
+                                       const wxCmdLineArgsArray& argv)
+{
+    m_arguments = argv.GetArguments();
+}
+
 #endif // wxUSE_UNICODE
 
 void wxCmdLineParserData::SetArguments(const wxString& cmdLine)
@@ -306,6 +328,11 @@ void wxCmdLineParser::SetCmdLine(int argc, wxChar **argv)
     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)
@@ -332,7 +359,7 @@ void wxCmdLineParser::EnableLongOptions(bool enable)
     m_data->m_enableLongOptions = enable;
 }
 
-bool wxCmdLineParser::AreLongOptionsEnabled()
+bool wxCmdLineParser::AreLongOptionsEnabled() const
 {
     return m_data->m_enableLongOptions;
 }
@@ -353,17 +380,24 @@ void wxCmdLineParser::SetDesc(const wxCmdLineEntryDesc *desc)
         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;
+
+            case wxCMD_LINE_USAGE_TEXT:
+                AddUsageText(wxGetTranslation(desc->description));
                 break;
 
             default:
@@ -413,7 +447,7 @@ void wxCmdLineParser::AddParam(const wxString& 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();
@@ -427,13 +461,24 @@ void wxCmdLineParser::AddParam(const wxString& desc,
                           _T("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
 // ----------------------------------------------------------------------------
@@ -491,6 +536,25 @@ bool wxCmdLineParser::Found(const wxString& name, long *value) const
     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
 {
@@ -572,24 +636,25 @@ int wxCmdLineParser::Parse(bool showUsage)
 
         // 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)
                 {
@@ -617,9 +682,9 @@ int wxCmdLineParser::Parse(bool showUsage)
 
                 // 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
@@ -679,15 +744,17 @@ int wxCmdLineParser::Parse(bool showUsage)
             // look at what follows:
 
             // +1 for leading '-'
-            const wxChar *p = arg.c_str() + 1 + name.length();
+            wxString::const_iterator p = arg.begin() + 1 + name.length();
+            wxString::const_iterator end = arg.end();
+
             if ( isLong )
-                p++;    // for another leading '-'
+                ++p;    // for another leading '-'
 
             wxCmdLineOption& opt = m_data->m_options[(size_t)optInd];
             if ( opt.kind == wxCMD_LINE_SWITCH )
             {
                 // we must check that there is no value following the switch
-                if ( *p != _T('\0') )
+                if ( p != arg.end() )
                 {
                     errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str())
                              << _T('\n');
@@ -709,62 +776,49 @@ int wxCmdLineParser::Parse(bool showUsage)
             }
             else // it's an option. not a switch
             {
-                // get the value
-                if ( isLong )
-                {
-                    if ( *p++ != _T('=') )
-                    {
-                        errorMsg << wxString::Format(_("Option '%s' requires a value, '=' expected."), name.c_str())
-                                 << _T('\n');
-
-                        ok = false;
-                    }
-                }
-                else // short option
+                switch ( p == end ? '\0' : (*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())
-                                         << _T('\n');
-
-                                ok = false;
-                            }
-                            else
-                            {
-                                // ... take it from there
-                                p = m_data->m_arguments[n].c_str();
-                            }
-                            break;
+                    case '=':
+                    case ':':
+                        // 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())
-                                        << _T('\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:
@@ -793,12 +847,30 @@ int wxCmdLineParser::Parse(bool showUsage)
                             }
                             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;
+                                }
+                            }
+                            break;
+
 #if wxUSE_DATETIME
                         case wxCMD_LINE_VAL_DATE:
                             {
                                 wxDateTime dt;
-                                const wxChar *res = dt.ParseDate(value);
-                                if ( !res || *res )
+                                wxString::const_iterator end;
+                                if ( !dt.ParseDate(value) || end != value.end() )
                                 {
                                     errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),
                                                                  name.c_str(), value.c_str())
@@ -936,7 +1008,7 @@ int wxCmdLineParser::Parse(bool showUsage)
 // give the usage message
 // ----------------------------------------------------------------------------
 
-void wxCmdLineParser::Usage()
+void wxCmdLineParser::Usage() const
 {
     wxMessageOutput* msgOut = wxMessageOutput::Get();
     if ( msgOut )
@@ -949,7 +1021,7 @@ void wxCmdLineParser::Usage()
     }
 }
 
-wxString wxCmdLineParser::GetUsageString()
+wxString wxCmdLineParser::GetUsageString() const
 {
     wxString appname;
     if ( m_data->m_arguments.empty() )
@@ -985,58 +1057,60 @@ wxString wxCmdLineParser::GetUsageString()
     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 << _T(' ');
+            if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
+            {
+                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())
+            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 << _T("--") << 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( _T("option without neither short nor long name") );
+                }
             }
-        }
 
-        wxString option;
-
-        if ( !opt.shortName.empty() )
-        {
-            option << _T("  ") << chSwitch << opt.shortName;
-        }
+            if ( !opt.shortName.empty() )
+            {
+                option << _T("  ") << chSwitch << opt.shortName;
+            }
 
-        if ( areLongOptionsEnabled && !opt.longName.empty() )
-        {
-            option << (option.empty() ? _T("  ") : _T(", "))
-                   << _T("--") << opt.longName;
-        }
+            if ( areLongOptionsEnabled && !opt.longName.empty() )
+            {
+                option << (option.empty() ? _T("  ") : _T(", "))
+                       << _T("--") << 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 << _T('<') << GetTypeName(opt.type) << _T('>');
+                usage << _T(' ') << val;
+                option << (!opt.longName ? _T(':') : _T('=')) << val;
+            }
 
-        if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
-        {
-            usage << _T(']');
+            if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
+            {
+                usage << _T(']');
+            }
         }
 
         namesOptions.push_back(option);
@@ -1093,10 +1167,18 @@ wxString wxCmdLineParser::GetUsageString()
             usage << _T('\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] << _T('\n');
+        }
+        else
+        {
+            usage << namesOptions[n]
+                  << wxString(_T(' '), lenMax - len) << _T('\t')
+                  << descOptions[n]
+                  << _T('\n');
+        }
     }
 
     return usage;
@@ -1123,6 +1205,10 @@ static wxString GetTypeName(wxCmdLineParamType type)
             s = _("num");
             break;
 
+        case wxCMD_LINE_VAL_DOUBLE:
+            s = _("double");
+            break;
+
         case wxCMD_LINE_VAL_DATE:
             s = _("date");
             break;
@@ -1140,12 +1226,13 @@ 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)
+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++;
     }
@@ -1163,14 +1250,16 @@ static wxString GetOptionName(const wxChar *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
@@ -1188,32 +1277,40 @@ static wxString GetLongOptionName(const wxChar *p)
  */
 
 /* static */
-wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
+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 == _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++ )
+        bool lastBS = false,
+             isInsideQuotes = false;
+        wxChar chDelim = '\0';
+        for ( arg.clear(); p != end; ++p )
         {
-            switch ( *p )
+            const wxChar ch = *p;
+
+            if ( type == wxCMD_LINE_SPLIT_DOS )
             {
-                case _T('"'):
+                if ( ch == '"' )
+                {
                     if ( !lastBS )
                     {
                         isInsideQuotes = !isInsideQuotes;
@@ -1224,32 +1321,57 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
                     //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);