document On{Open,Save}Document()

[wxWidgets.git] / src / common / cmdline.cpp

diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp
index be17b4d7470a7a96156c4703ac324bae067f1b25..63ee43c1a82c3498481d9f7bec6930608e8d84dc 100644 (file)
--- a/src/common/cmdline.cpp
+++ b/src/common/cmdline.cpp
@@ -41,6 +41,7 @@
 #include "wx/datetime.h"
 #include "wx/msgout.h"
 #include "wx/filename.h"
 #include "wx/datetime.h"
 #include "wx/msgout.h"
 #include "wx/filename.h"

+#include "wx/apptrait.h"

 
 // ----------------------------------------------------------------------------
 // private functions
 
 // ----------------------------------------------------------------------------
 // private functions


@@ -48,11 +49,15 @@
 
 static wxString GetTypeName(wxCmdLineParamType type);
 
 
 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
 
 // ----------------------------------------------------------------------------
 // private structs


@@ -72,16 +77,16 @@ struct wxCmdLineOption
                       _T("option should have at least one name") );
 
         wxASSERT_MSG
                       _T("option should have at least one name") );
 
         wxASSERT_MSG

-            (
-                GetShortOptionName(shrt).Len() == shrt.Len(),
-                wxT("Short option contains invalid characters")
-            );
+        (
+            GetShortOptionName(shrt.begin(), shrt.end()).Len() == shrt.Len(),
+            wxT("Short option contains invalid characters")
+        );

 
         wxASSERT_MSG
 
         wxASSERT_MSG

-            (
-                GetLongOptionName(lng).Len() == lng.Len(),
-                wxT("Long option contains invalid characters")
-            );
+        (
+            GetLongOptionName(lng.begin(), lng.end()).Len() == lng.Len(),
+            wxT("Long option contains invalid characters")
+        );

 
 
         kind = k;
 
 
         kind = k;


@@ -106,6 +111,8 @@ struct wxCmdLineOption
         wxASSERT_MSG( type == typ, _T("type mismatch in 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
     long GetLongVal() const
         { Check(wxCMD_LINE_VAL_NUMBER); return m_longVal; }
     const wxString& GetStrVal() const


@@ -115,6 +122,8 @@ struct wxCmdLineOption
         { Check(wxCMD_LINE_VAL_DATE);   return m_dateVal; }
 #endif // wxUSE_DATETIME
 
         { 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)
     void SetLongVal(long val)
         { Check(wxCMD_LINE_VAL_NUMBER); m_longVal = val; m_hasVal = true; }
     void SetStrVal(const wxString& val)


@@ -138,6 +147,7 @@ public:
 private:
     bool m_hasVal;
 
 private:
     bool m_hasVal;
 

+    double m_doubleVal;

     long m_longVal;
     wxString m_strVal;
 #if wxUSE_DATETIME
     long m_longVal;
     wxString m_strVal;
 #if wxUSE_DATETIME


@@ -179,7 +189,7 @@ struct wxCmdLineParserData
 
     // cmd line data
     wxArrayString m_arguments;  // == argv, argc == m_arguments.GetCount()
 
     // cmd line data
     wxArrayString m_arguments;  // == argv, argc == m_arguments.GetCount()

-    wxArrayOptions m_options;   // all possible options and switchrs
+    wxArrayOptions m_options;   // all possible options and switches

     wxArrayParams m_paramDesc;  // description of all possible params
     wxArrayString m_parameters; // all params found
 
     wxArrayParams m_paramDesc;  // description of all possible params
     wxArrayString m_parameters; // all params found
 


@@ -188,6 +198,7 @@ struct wxCmdLineParserData
     void SetArguments(int argc, char **argv);
 #if wxUSE_UNICODE
     void SetArguments(int argc, wxChar **argv);
     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);
 
 #endif // wxUSE_UNICODE
     void SetArguments(const wxString& cmdline);
 


@@ -235,6 +246,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)
 #endif // wxUSE_UNICODE
 
 void wxCmdLineParserData::SetArguments(const wxString& cmdLine)


@@ -305,6 +322,11 @@ void wxCmdLineParser::SetCmdLine(int argc, wxChar **argv)
     m_data->SetArguments(argc, 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)
 #endif // wxUSE_UNICODE
 
 void wxCmdLineParser::SetCmdLine(const wxString& cmdline)


@@ -331,7 +353,7 @@ void wxCmdLineParser::EnableLongOptions(bool enable)
     m_data->m_enableLongOptions = enable;
 }
 
     m_data->m_enableLongOptions = enable;
 }
 

-bool wxCmdLineParser::AreLongOptionsEnabled()
+bool wxCmdLineParser::AreLongOptionsEnabled() const

 {
     return m_data->m_enableLongOptions;
 }
 {
     return m_data->m_enableLongOptions;
 }


@@ -352,17 +374,20 @@ void wxCmdLineParser::SetDesc(const wxCmdLineEntryDesc *desc)
         switch ( desc->kind )
         {
             case wxCMD_LINE_SWITCH:
         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:
                           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:
                           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;
 
             default:
                 break;
 
             default:


@@ -490,6 +515,25 @@ bool wxCmdLineParser::Found(const wxString& name, long *value) const
     return true;
 }
 
     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
 {
 #if wxUSE_DATETIME
 bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const
 {


@@ -571,24 +615,25 @@ int wxCmdLineParser::Parse(bool showUsage)
 
         // empty argument or just '-' is not an option but a parameter
         if ( maybeOption && arg.length() > 1 &&
 
         // 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
         {
             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 "--"
             {
                 // a long one
                 isLong = true;
 
                 // Skip leading "--"

-                const wxChar *p = arg.c_str() + 2;
+                wxString::const_iterator p = arg.begin() + 2;

 
                 bool longOptionsEnabled = AreLongOptionsEnabled();
 
 
                 bool longOptionsEnabled = AreLongOptionsEnabled();
 

-                name = GetLongOptionName(p);
+                name = GetLongOptionName(p, arg.end());

 
                 if (longOptionsEnabled)
                 {
 
                 if (longOptionsEnabled)
                 {


@@ -616,9 +661,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
 
                 // 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
 
                 size_t len = name.length();
                 do


@@ -678,15 +723,17 @@ int wxCmdLineParser::Parse(bool showUsage)
             // look at what follows:
 
             // +1 for leading '-'
             // 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 )
             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
 
             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');
                 {
                     errorMsg << wxString::Format(_("Unexpected characters following option '%s'."), name.c_str())
                              << _T('\n');


@@ -708,62 +755,49 @@ int wxCmdLineParser::Parse(bool showUsage)
             }
             else // it's an option. not a switch
             {
             }
             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).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 _T('='):
+                    case _T(':'):
+                        // 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 )
                 {
                 }
 
                 if ( ok )
                 {

-                    wxString value = p;
+                    wxString value(p, end);

                     switch ( opt.type )
                     {
                         default:
                     switch ( opt.type )
                     {
                         default:


@@ -792,11 +826,29 @@ int wxCmdLineParser::Parse(bool showUsage)
                             }
                             break;
 
                             }
                             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;
 #if wxUSE_DATETIME
                         case wxCMD_LINE_VAL_DATE:
                             {
                                 wxDateTime dt;

-                                const wxChar *res = dt.ParseDate(value);
+                                const char *res = dt.ParseDate(value);

                                 if ( !res || *res )
                                 {
                                     errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),
                                 if ( !res || *res )
                                 {
                                     errorMsg << wxString::Format(_("Option '%s': '%s' cannot be converted to a date."),


@@ -935,7 +987,7 @@ int wxCmdLineParser::Parse(bool showUsage)
 // give the usage message
 // ----------------------------------------------------------------------------
 
 // give the usage message
 // ----------------------------------------------------------------------------
 

-void wxCmdLineParser::Usage()
+void wxCmdLineParser::Usage() const

 {
     wxMessageOutput* msgOut = wxMessageOutput::Get();
     if ( msgOut )
 {
     wxMessageOutput* msgOut = wxMessageOutput::Get();
     if ( msgOut )


@@ -948,7 +1000,7 @@ void wxCmdLineParser::Usage()
     }
 }
 
     }
 }
 

-wxString wxCmdLineParser::GetUsageString()
+wxString wxCmdLineParser::GetUsageString() const

 {
     wxString appname;
     if ( m_data->m_arguments.empty() )
 {
     wxString appname;
     if ( m_data->m_arguments.empty() )


@@ -1068,18 +1120,29 @@ wxString wxCmdLineParser::GetUsageString()
 
     usage << _T('\n');
 
 
     usage << _T('\n');
 

+    // set to number of our own options, not counting the standard ones
+    count = namesOptions.size();
+
+    // get option names & descriptions for standard options, if any:
+    wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+    wxString stdDesc;
+    if ( traits )
+        stdDesc = traits->GetStandardCmdLineOptions(namesOptions, descOptions);
+

     // now construct the detailed help message
     size_t len, lenMax = 0;
     // now construct the detailed help message
     size_t len, lenMax = 0;

-    count = namesOptions.size();
-    for ( n = 0; n < count; n++ )
+    for ( n = 0; n < namesOptions.size(); n++ )

     {
         len = namesOptions[n].length();
         if ( len > lenMax )
             lenMax = len;
     }
 
     {
         len = namesOptions[n].length();
         if ( len > lenMax )
             lenMax = len;
     }
 

-    for ( n = 0; n < count; n++ )
+    for ( n = 0; n < namesOptions.size(); n++ )

     {
     {

+        if ( n == count )
+            usage << _T('\n') << stdDesc;
+

         len = namesOptions[n].length();
         usage << namesOptions[n]
               << wxString(_T(' '), lenMax - len) << _T('\t')
         len = namesOptions[n].length();
         usage << namesOptions[n]
               << wxString(_T(' '), lenMax - len) << _T('\t')


@@ -1111,6 +1174,10 @@ static wxString GetTypeName(wxCmdLineParamType type)
             s = _("num");
             break;
 
             s = _("num");
             break;
 

+        case wxCMD_LINE_VAL_DOUBLE:
+            s = _("double");
+            break;
+

         case wxCMD_LINE_VAL_DATE:
             s = _("date");
             break;
         case wxCMD_LINE_VAL_DATE:
             s = _("date");
             break;


@@ -1128,12 +1195,13 @@ the parameter allowedChars.
 For example, if p points to "abcde-@-_", and allowedChars is "-_",
 this function returns "abcde-".
 */
 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;
 
 {
     wxString argName;
 

-    while ( *p && (wxIsalnum(*p) || wxStrchr(allowedChars, *p)) )
+    while ( p != end && (wxIsalnum(*p) || wxStrchr(allowedChars, *p)) )

     {
         argName += *p++;
     }
     {
         argName += *p++;
     }


@@ -1151,14 +1219,16 @@ static wxString GetOptionName(const wxChar *p,
 #define wxCMD_LINE_CHARS_ALLOWED_BY_LONG_OPTION \
     wxCMD_LINE_CHARS_ALLOWED_BY_SHORT_OPTION wxT("-")
 
 #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
 }
 
 #endif // wxUSE_CMDLINE_PARSER


@@ -1176,7 +1246,7 @@ static wxString GetLongOptionName(const wxChar *p)
  */
 
 /* static */
  */
 
 /* static */

-wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
+wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxString& cmdline)

 {
     wxArrayString args;
 
 {
     wxArrayString args;
 


@@ -1184,14 +1254,17 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
     arg.reserve(1024);
 
     bool isInsideQuotes = false;
     arg.reserve(1024);
 
     bool isInsideQuotes = false;

+
+    wxString::const_iterator p = cmdline.begin();
+

     for ( ;; )
     {
         // skip white space
     for ( ;; )
     {
         // skip white space

-        while ( *p == _T(' ') || *p == _T('\t') )
-            p++;
+        while ( p != cmdline.end() && (*p == _T(' ') || *p == _T('\t')) )
+            ++p;

 
         // anything left?
 
         // anything left?

-        if ( *p == _T('\0') )
+        if ( p == cmdline.end() )

             break;
 
         // parse this parameter
             break;
 
         // parse this parameter


@@ -1199,7 +1272,7 @@ wxArrayString wxCmdLineParser::ConvertStringToArgs(const wxChar *p)
         bool lastBS = false;
         for ( arg.clear(); !endParam; p++ )
         {
         bool lastBS = false;
         for ( arg.clear(); !endParam; p++ )
         {

-            switch ( *p )
+            switch ( (*p).GetValue() )

             {
                 case _T('"'):
                     if ( !lastBS )
             {
                 case _T('"'):
                     if ( !lastBS )