added wx/defs.h include to correct compilation issues under Mac OS X

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

diff --git a/src/common/cmdline.cpp b/src/common/cmdline.cpp
index f42ca0f098d1327f0637e93c65be426d2f9d69bd..46517df3a2700ad2668214ba7cd2d8d72580cde5 100644 (file)
--- a/src/common/cmdline.cpp
+++ b/src/common/cmdline.cpp
@@ -28,13 +28,19 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_CMDLINE_PARSER
+

 #ifndef WX_PRECOMP
     #include "wx/string.h"
     #include "wx/log.h"
     #include "wx/intl.h"
 #ifndef WX_PRECOMP
     #include "wx/string.h"
     #include "wx/log.h"
     #include "wx/intl.h"

+    #include "wx/app.h"

     #include "wx/dynarray.h"
     #include "wx/dynarray.h"

+    #include "wx/filefn.h"

 #endif //WX_PRECOMP
 
 #endif //WX_PRECOMP
 

+#include <ctype.h>
+

 #include "wx/datetime.h"
 #include "wx/cmdline.h"
 
 #include "wx/datetime.h"
 #include "wx/cmdline.h"
 


@@ -58,6 +64,9 @@ struct wxCmdLineOption
                     wxCmdLineParamType typ,
                     int fl)
     {
                     wxCmdLineParamType typ,
                     int fl)
     {

+        wxASSERT_MSG( !shrt.empty() || !lng.empty(),
+                      _T("option should have at least one name") );
+

         kind = k;
 
         shortName = shrt;
         kind = k;
 
         shortName = shrt;


@@ -75,7 +84,7 @@ struct wxCmdLineOption
     // types increases, so always use the accessor functions and don't access
     // the fields directly!)
 
     // types increases, so always use the accessor functions and don't access
     // the fields directly!)
 

-    void Check(wxCmdLineParamType typ) const
+    void Check(wxCmdLineParamType WXUNUSED_UNLESS_DEBUG(typ)) const

     {
         wxASSERT_MSG( type == typ, _T("type mismatch in wxCmdLineOption") );
     }
     {
         wxASSERT_MSG( type == typ, _T("type mismatch in wxCmdLineOption") );
     }


@@ -94,7 +103,7 @@ struct wxCmdLineOption
     void SetDateVal(const wxDateTime val)
         { Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = TRUE; }
 
     void SetDateVal(const wxDateTime val)
         { Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = TRUE; }
 

-    void SetHasValue() { m_hasVal = TRUE; }
+    void SetHasValue(bool hasValue = TRUE) { m_hasVal = hasValue; }

     bool HasValue() const { return m_hasVal; }
 
 public:
     bool HasValue() const { return m_hasVal; }
 
 public:


@@ -140,8 +149,8 @@ struct wxCmdLineParserData
 {
     // options
     wxString m_switchChars;     // characters which may start an option
 {
     // 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
     wxArrayString m_arguments;  // == argv, argc == m_arguments.GetCount()
 
     // cmd line data
     wxArrayString m_arguments;  // == argv, argc == m_arguments.GetCount()


@@ -151,7 +160,7 @@ struct wxCmdLineParserData
 
     // methods
     wxCmdLineParserData();
 
     // methods
     wxCmdLineParserData();

-    void SetArguments(int argc, char **argv);
+    void SetArguments(int argc, wxChar **argv);

     void SetArguments(const wxString& cmdline);
 
     int FindOption(const wxString& name);
     void SetArguments(const wxString& cmdline);
 
     int FindOption(const wxString& name);


@@ -176,7 +185,7 @@ wxCmdLineParserData::wxCmdLineParserData()
 #endif
 }
 
 #endif
 }
 

-void wxCmdLineParserData::SetArguments(int argc, char **argv)
+void wxCmdLineParserData::SetArguments(int argc, wxChar **argv)

 {
     m_arguments.Empty();
 
 {
     m_arguments.Empty();
 


@@ -186,23 +195,64 @@ void wxCmdLineParserData::SetArguments(int argc, char **argv)
     }
 }
 
     }
 }
 

-void wxCmdLineParserData::SetArguments(const wxString& cmdline)
+void wxCmdLineParserData::SetArguments(const wxString& cmdLine)

 {
 {

-    // either use wxMSW wxApp::ConvertToStandardCommandArgs() or move its logic
-    // here and use this method from it - but don't duplicate the code
+    m_arguments.Empty();
+
+    m_arguments.Add(wxTheApp->GetAppName());
+
+    // Break up string
+    // Treat strings enclosed in double-quotes as single arguments
+    int i = 0;
+    int len = cmdLine.Length();
+    while (i < len)
+    {
+        // Skip whitespace
+        while ((i < len) && wxIsspace(cmdLine.GetChar(i)))
+            i ++;
+
+        if (i < len)
+        {
+            if (cmdLine.GetChar(i) == wxT('"')) // We found the start of a string
+            {
+                i ++;
+                int first = i;
+                while ((i < len) && (cmdLine.GetChar(i) != wxT('"')))
+                    i ++;
+
+                wxString arg(cmdLine.Mid(first, (i - first)));
+
+                m_arguments.Add(arg);
+
+                if (i < len)
+                    i ++; // Skip past 2nd quote
+            }
+            else // Unquoted argument
+            {
+                int first = i;
+                while ((i < len) && !wxIsspace(cmdLine.GetChar(i)))
+                    i ++;
+
+                wxString arg(cmdLine.Mid(first, (i - first)));

 
 

-    wxFAIL_MSG(_T("TODO"));
+                m_arguments.Add(arg);
+            }
+        }
+    }

 }
 
 int wxCmdLineParserData::FindOption(const wxString& name)
 {
 }
 
 int wxCmdLineParserData::FindOption(const wxString& name)
 {

-    size_t count = m_options.GetCount();
-    for ( size_t n = 0; n < count; n++ )
+    if ( !name.empty() )

     {
     {

-        if ( m_options[n].shortName == name )
+        size_t count = m_options.GetCount();
+        for ( size_t n = 0; n < count; n++ )

         {
         {

-            // found
-            return n;
+            if ( m_options[n].shortName == name )
+            {
+                // found
+                return n;
+            }

         }
     }
 
         }
     }
 


@@ -233,7 +283,7 @@ void wxCmdLineParser::Init()
     m_data = new wxCmdLineParserData;
 }
 
     m_data = new wxCmdLineParserData;
 }
 

-void wxCmdLineParser::SetCmdLine(int argc, char **argv)
+void wxCmdLineParser::SetCmdLine(int argc, wxChar **argv)

 {
     m_data->SetArguments(argc, argv);
 }
 {
     m_data->SetArguments(argc, argv);
 }


@@ -262,6 +312,11 @@ void wxCmdLineParser::EnableLongOptions(bool enable)
     m_data->m_enableLongOptions = enable;
 }
 
     m_data->m_enableLongOptions = enable;
 }
 

+void wxCmdLineParser::SetLogo(const wxString& logo)
+{
+    m_data->m_logo = logo;
+}
+

 // ----------------------------------------------------------------------------
 // command line construction
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // command line construction
 // ----------------------------------------------------------------------------


@@ -273,7 +328,8 @@ 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, desc->description,
+                          desc->flags);

                 break;
 
             case wxCMD_LINE_OPTION:
                 break;
 
             case wxCMD_LINE_OPTION:


@@ -338,14 +394,12 @@ void wxCmdLineParser::AddParam(const wxString& desc,
         wxCmdLineParam& param = m_data->m_paramDesc.Last();
 
         wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_MULTIPLE),
         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") );
+                      _T("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),
 
         if ( !(flags & wxCMD_LINE_PARAM_OPTIONAL) )
         {
             wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL),

-                          _T("a required parameter can't follow an "
-                             "optional one") );
+                          _T("a required parameter can't follow an optional one") );

         }
     }
 #endif // Debug
         }
     }
 #endif // Debug


@@ -362,6 +416,9 @@ void wxCmdLineParser::AddParam(const wxString& desc,
 bool wxCmdLineParser::Found(const wxString& name) const
 {
     int i = m_data->FindOption(name);
 bool wxCmdLineParser::Found(const wxString& name) const
 {
     int i = m_data->FindOption(name);

+    if ( i == wxNOT_FOUND )
+        i = m_data->FindOptionByLongName(name);
+

     wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];
     wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];


@@ -374,6 +431,9 @@ bool wxCmdLineParser::Found(const wxString& name) const
 bool wxCmdLineParser::Found(const wxString& name, wxString *value) const
 {
     int i = m_data->FindOption(name);
 bool wxCmdLineParser::Found(const wxString& name, wxString *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];
     wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];


@@ -390,6 +450,9 @@ bool wxCmdLineParser::Found(const wxString& name, wxString *value) const
 bool wxCmdLineParser::Found(const wxString& name, long *value) const
 {
     int i = m_data->FindOption(name);
 bool wxCmdLineParser::Found(const wxString& name, long *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];
     wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];


@@ -406,6 +469,9 @@ bool wxCmdLineParser::Found(const wxString& name, long *value) const
 bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const
 {
     int i = m_data->FindOption(name);
 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") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];
     wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
 
     wxCmdLineOption& opt = m_data->m_options[(size_t)i];


@@ -429,6 +495,17 @@ wxString wxCmdLineParser::GetParam(size_t n) const
     return m_data->m_parameters[n];
 }
 
     return m_data->m_parameters[n];
 }
 

+// Resets switches and options
+void wxCmdLineParser::Reset()
+{
+    for ( size_t i = 0; i < m_data->m_options.Count(); i++ )
+    {
+        wxCmdLineOption& opt = m_data->m_options[i];
+        opt.SetHasValue(FALSE);
+    }
+}
+
+

 // ----------------------------------------------------------------------------
 // the real work is done here
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // the real work is done here
 // ----------------------------------------------------------------------------


@@ -444,6 +521,8 @@ int wxCmdLineParser::Parse()
 
     size_t countParam = m_data->m_paramDesc.GetCount();
 
 
     size_t countParam = m_data->m_paramDesc.GetCount();
 

+    Reset();
+

     // parse everything
     wxString arg;
     size_t count = m_data->m_arguments.GetCount();
     // parse everything
     wxString arg;
     size_t count = m_data->m_arguments.GetCount();


@@ -477,7 +556,7 @@ int wxCmdLineParser::Parse()
                 isLong = TRUE;
 
                 const wxChar *p = arg.c_str() + 2;
                 isLong = TRUE;
 
                 const wxChar *p = arg.c_str() + 2;

-                while ( wxIsalpha(*p) || (*p == _T('-')) )
+                while ( wxIsalnum(*p) || (*p == _T('_')) || (*p == _T('-')) )

                 {
                     name += *p++;
                 }
                 {
                     name += *p++;
                 }


@@ -495,7 +574,7 @@ int wxCmdLineParser::Parse()
                 // 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;
                 // 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;

-                while ( wxIsalpha(*p) )
+                while ( wxIsalnum(*p) || (*p == _T('_')) )

                 {
                     name += *p++;
                 }
                 {
                     name += *p++;
                 }


@@ -521,8 +600,13 @@ int wxCmdLineParser::Parse()
                 }
                 while ( optInd == wxNOT_FOUND );
 
                 }
                 while ( optInd == wxNOT_FOUND );
 

-                if ( (len > 0) && (len != name.length()) )
+                len++;  // compensates extra len-- above
+                if ( (optInd != wxNOT_FOUND) && (len != name.length()) )

                 {
                 {

+                    // first of all, the option name is only part of this
+                    // string
+                    name = name.Left(len);
+

                     // our option is only part of this argument, there is
                     // something else in it - it is either the value of this
                     // option or other switches if it is a switch
                     // our option is only part of this argument, there is
                     // something else in it - it is either the value of this
                     // option or other switches if it is a switch


@@ -532,9 +616,10 @@ int wxCmdLineParser::Parse()
                         // pretend that all the rest of the argument is the
                         // next argument, in fact
                         wxString arg2 = arg[0u];
                         // pretend that all the rest of the argument is the
                         // next argument, in fact
                         wxString arg2 = arg[0u];

-                        arg2 += name.Mid(len);
+                        arg2 += arg.Mid(len + 1); // +1 for leading '-'

 
                         m_data->m_arguments.Insert(arg2, n + 1);
 
                         m_data->m_arguments.Insert(arg2, n + 1);

+                        count++;

                     }
                     //else: it's our value, we'll deal with it below
                 }
                     }
                     //else: it's our value, we'll deal with it below
                 }


@@ -573,8 +658,7 @@ int wxCmdLineParser::Parse()
 
                     if ( *p++ != _T('=') )
                     {
 
                     if ( *p++ != _T('=') )
                     {

-                        wxLogError(_("Option '%s' requires a value, '=' "
-                                     "expected."), name.c_str());
+                        wxLogError(_("Option '%s' requires a value, '=' expected."), name.c_str());

 
                         ok = FALSE;
                     }
 
                         ok = FALSE;
                     }


@@ -583,6 +667,7 @@ int wxCmdLineParser::Parse()
                 {
                     switch ( *p )
                     {
                 {
                     switch ( *p )
                     {

+                        case _T('='):

                         case _T(':'):
                             // the value follows
                             p++;
                         case _T(':'):
                             // the value follows
                             p++;


@@ -606,8 +691,15 @@ int wxCmdLineParser::Parse()
                             break;
 
                         default:
                             break;
 
                         default:

-                            // the value is right here
-                            ;
+                            // the value is right here: this may be legal or
+                            // not depending on the option style
+                            if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR )
+                            {
+                                wxLogError(_("Separator expected after the option '%s'."),
+                                           name.c_str());
+
+                                ok = FALSE;
+                            }

                     }
                 }
 
                     }
                 }
 


@@ -633,9 +725,7 @@ int wxCmdLineParser::Parse()
                                 }
                                 else
                                 {
                                 }
                                 else
                                 {

-                                    wxLogError(_("'%s' is not a correct "
-                                                 "numeric value for option "
-                                                 "'%s'."),
+                                    wxLogError(_("'%s' is not a correct numeric value for option '%s'."),

                                                value.c_str(), name.c_str());
 
                                     ok = FALSE;
                                                value.c_str(), name.c_str());
 
                                     ok = FALSE;


@@ -649,8 +739,7 @@ int wxCmdLineParser::Parse()
                                 const wxChar *res = dt.ParseDate(value);
                                 if ( !res || *res )
                                 {
                                 const wxChar *res = dt.ParseDate(value);
                                 if ( !res || *res )
                                 {

-                                    wxLogError(_("Options '%s': '%s' cannot "
-                                                  "be converted to a date."),
+                                    wxLogError(_("Option '%s': '%s' cannot be converted to a date."),

                                                name.c_str(), value.c_str());
 
                                     ok = FALSE;
                                                name.c_str(), value.c_str());
 
                                     ok = FALSE;


@@ -683,9 +772,7 @@ int wxCmdLineParser::Parse()
                 else
                 {
                     wxASSERT_MSG( currentParam == countParam - 1,
                 else
                 {
                     wxASSERT_MSG( currentParam == countParam - 1,

-                                  _T("all parameters after the one with "
-                                     "wxCMD_LINE_PARAM_MULTIPLE style "
-                                     "are ignored") );
+                                  _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;
 
                     // remember that we did have this last repeatable parameter
                     hadRepeatableParam = TRUE;


@@ -764,8 +851,26 @@ int wxCmdLineParser::Parse()
 
 void wxCmdLineParser::Usage()
 {
 
 void wxCmdLineParser::Usage()
 {

-    wxString brief, detailed;
-    brief.Printf(_("Usage: %s"), wxTheApp->GetAppName().c_str());
+    wxString appname = wxTheApp->GetAppName();
+    if ( !appname )
+    {
+        wxCHECK_RET( !m_data->m_arguments.IsEmpty(), _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;
+    wxArrayString namesOptions, descOptions;
+    brief.Printf(_("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('-')
+                                             : m_data->m_switchChars[0u];

 
     size_t n, count = m_data->m_options.GetCount();
     for ( n = 0; n < count; n++ )
 
     size_t n, count = m_data->m_options.GetCount();
     for ( n = 0; n < count; n++ )


@@ -778,11 +883,13 @@ void wxCmdLineParser::Usage()
             brief << _T('[');
         }
 
             brief << _T('[');
         }
 

-        brief << _T('-') << opt.shortName;
-        detailed << _T("  -") << opt.shortName;
+        brief << chSwitch << opt.shortName;
+
+        wxString option;
+        option << _T("  ") << chSwitch << opt.shortName;

         if ( !!opt.longName )
         {
         if ( !!opt.longName )
         {

-            detailed << _T("  --") << opt.longName;
+            option << _T("  --") << opt.longName;

         }
 
         if ( opt.kind != wxCMD_LINE_SWITCH )
         }
 
         if ( opt.kind != wxCMD_LINE_SWITCH )


@@ -790,7 +897,7 @@ void wxCmdLineParser::Usage()
             wxString val;
             val << _T('<') << GetTypeName(opt.type) << _T('>');
             brief << _T(' ') << val;
             wxString val;
             val << _T('<') << GetTypeName(opt.type) << _T('>');
             brief << _T(' ') << val;

-            detailed << (!opt.longName ? _T(':') : _T('=')) << val;
+            option << (!opt.longName ? _T(':') : _T('=')) << val;

         }
 
         if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
         }
 
         if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )


@@ -798,7 +905,8 @@ void wxCmdLineParser::Usage()
             brief << _T(']');
         }
 
             brief << _T(']');
         }
 

-        detailed << _T('\t') << opt.description << _T('\n');
+        namesOptions.Add(option);
+        descOptions.Add(opt.description);

     }
 
     count = m_data->m_paramDesc.GetCount();
     }
 
     count = m_data->m_paramDesc.GetCount();


@@ -825,7 +933,33 @@ void wxCmdLineParser::Usage()
         }
     }
 
         }
     }
 

+    if ( !!m_data->m_logo )
+    {
+        wxLogMessage(m_data->m_logo);
+    }
+

     wxLogMessage(brief);
     wxLogMessage(brief);

+
+    // now construct the detailed help message
+    size_t len, lenMax = 0;
+    count = namesOptions.GetCount();
+    for ( n = 0; n < count; n++ )
+    {
+        len = namesOptions[n].length();
+        if ( len > lenMax )
+            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');
+    }
+

     wxLogMessage(detailed);
 }
 
     wxLogMessage(detailed);
 }
 


@@ -849,3 +983,5 @@ static wxString GetTypeName(wxCmdLineParamType type)
 
     return s;
 }
 
     return s;
 }

+
+#endif // wxUSE_CMDLINE_PARSER