Don't create multiple parent-less top level frames in layout sample.

[wxWidgets.git] / include / wx / cmdline.h

diff --git a/include/wx/cmdline.h b/include/wx/cmdline.h
index dc1d4ee9da007405a2369d1a85e6a264cf328701..28d110c9b9e06dd9af02e88566fe5313ba50855b 100644 (file)
--- a/include/wx/cmdline.h
+++ b/include/wx/cmdline.h
@@ -17,10 +17,18 @@
 
 #include "wx/string.h"
 #include "wx/arrstr.h"
 
 #include "wx/string.h"
 #include "wx/arrstr.h"

+#include "wx/cmdargs.h"
+
+// determines ConvertStringToArgs() behaviour
+enum wxCmdLineSplitType
+{
+    wxCMD_LINE_SPLIT_DOS,
+    wxCMD_LINE_SPLIT_UNIX
+};

 
 #if wxUSE_CMDLINE_PARSER
 
 
 #if wxUSE_CMDLINE_PARSER
 

-class WXDLLIMPEXP_BASE wxDateTime;
+class WXDLLIMPEXP_FWD_BASE wxDateTime;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -28,13 +36,14 @@ class WXDLLIMPEXP_BASE wxDateTime;
 
 // by default, options are optional (sic) and each call to AddParam() allows
 // one more parameter - this may be changed by giving non-default flags to it
 
 // by default, options are optional (sic) and each call to AddParam() allows
 // one more parameter - this may be changed by giving non-default flags to it

-enum
+enum wxCmdLineEntryFlags

 {
     wxCMD_LINE_OPTION_MANDATORY = 0x01, // this option must be given
     wxCMD_LINE_PARAM_OPTIONAL   = 0x02, // the parameter may be omitted
     wxCMD_LINE_PARAM_MULTIPLE   = 0x04, // the parameter may be repeated
     wxCMD_LINE_OPTION_HELP      = 0x08, // this option is a help request
 {
     wxCMD_LINE_OPTION_MANDATORY = 0x01, // this option must be given
     wxCMD_LINE_PARAM_OPTIONAL   = 0x02, // the parameter may be omitted
     wxCMD_LINE_PARAM_MULTIPLE   = 0x04, // the parameter may be repeated
     wxCMD_LINE_OPTION_HELP      = 0x08, // this option is a help request

-    wxCMD_LINE_NEEDS_SEPARATOR  = 0x10  // must have sep before the value
+    wxCMD_LINE_NEEDS_SEPARATOR  = 0x10, // must have sep before the value
+    wxCMD_LINE_SWITCH_NEGATABLE = 0x20  // this switch can be negated (e.g. /S-)

 };
 
 // an option value or parameter may be a string (the most common case), a
 };
 
 // an option value or parameter may be a string (the most common case), a


@@ -44,6 +53,7 @@ enum wxCmdLineParamType
     wxCMD_LINE_VAL_STRING,  // should be 0 (default)
     wxCMD_LINE_VAL_NUMBER,
     wxCMD_LINE_VAL_DATE,
     wxCMD_LINE_VAL_STRING,  // should be 0 (default)
     wxCMD_LINE_VAL_NUMBER,
     wxCMD_LINE_VAL_DATE,

+    wxCMD_LINE_VAL_DOUBLE,

     wxCMD_LINE_VAL_NONE
 };
 
     wxCMD_LINE_VAL_NONE
 };
 


@@ -53,9 +63,18 @@ enum wxCmdLineEntryType
     wxCMD_LINE_SWITCH,
     wxCMD_LINE_OPTION,
     wxCMD_LINE_PARAM,
     wxCMD_LINE_SWITCH,
     wxCMD_LINE_OPTION,
     wxCMD_LINE_PARAM,

+    wxCMD_LINE_USAGE_TEXT,

     wxCMD_LINE_NONE         // to terminate the list
 };
 
     wxCMD_LINE_NONE         // to terminate the list
 };
 

+// Possible return values of wxCmdLineParser::FoundSwitch()
+enum wxCmdLineSwitchState
+{
+    wxCMD_SWITCH_OFF = -1,  // Found but turned off/negated.
+    wxCMD_SWITCH_NOT_FOUND, // Not found at all.
+    wxCMD_SWITCH_ON         // Found in normal state.
+};
+

 // ----------------------------------------------------------------------------
 // wxCmdLineEntryDesc is a description of one command line
 // switch/option/parameter
 // ----------------------------------------------------------------------------
 // wxCmdLineEntryDesc is a description of one command line
 // switch/option/parameter


@@ -64,13 +83,17 @@ enum wxCmdLineEntryType
 struct wxCmdLineEntryDesc
 {
     wxCmdLineEntryType kind;
 struct wxCmdLineEntryDesc
 {
     wxCmdLineEntryType kind;

-    const wxChar *shortName;
-    const wxChar *longName;
-    const wxChar *description;
+    const char *shortName;
+    const char *longName;
+    const char *description;

     wxCmdLineParamType type;
     int flags;
 };
 
     wxCmdLineParamType type;
     int flags;
 };
 

+// the list of wxCmdLineEntryDesc objects should be terminated with this one
+#define wxCMD_LINE_DESC_END \
+        { wxCMD_LINE_NONE, NULL, NULL, NULL, wxCMD_LINE_VAL_NONE, 0x0 }
+

 // ----------------------------------------------------------------------------
 // wxCmdLineParser is a class for parsing command line.
 //
 // ----------------------------------------------------------------------------
 // wxCmdLineParser is a class for parsing command line.
 //


@@ -100,6 +123,8 @@ public:
     wxCmdLineParser(int argc, char **argv) { Init(); SetCmdLine(argc, argv); }
 #if wxUSE_UNICODE
     wxCmdLineParser(int argc, wxChar **argv) { Init(); SetCmdLine(argc, argv); }
     wxCmdLineParser(int argc, char **argv) { Init(); SetCmdLine(argc, argv); }
 #if wxUSE_UNICODE
     wxCmdLineParser(int argc, wxChar **argv) { Init(); SetCmdLine(argc, argv); }

+    wxCmdLineParser(int argc, const wxCmdLineArgsArray& argv)
+        { Init(); SetCmdLine(argc, argv); }

 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); }
 
 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); }
 


@@ -112,6 +137,10 @@ public:
 #if wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, int argc, wxChar **argv)
         { Init(); SetCmdLine(argc, argv); SetDesc(desc); }
 #if wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, int argc, wxChar **argv)
         { Init(); SetCmdLine(argc, argv); SetDesc(desc); }

+    wxCmdLineParser(const wxCmdLineEntryDesc *desc,
+                    int argc,
+                    const wxCmdLineArgsArray& argv)
+        { Init(); SetCmdLine(argc, argv); SetDesc(desc); }

 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, const wxString& cmdline)
         { Init(); SetCmdLine(cmdline); SetDesc(desc); }
 #endif // wxUSE_UNICODE
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, const wxString& cmdline)
         { Init(); SetCmdLine(cmdline); SetDesc(desc); }


@@ -120,6 +149,7 @@ public:
     void SetCmdLine(int argc, char **argv);
 #if wxUSE_UNICODE
     void SetCmdLine(int argc, wxChar **argv);
     void SetCmdLine(int argc, char **argv);
 #if wxUSE_UNICODE
     void SetCmdLine(int argc, wxChar **argv);

+    void SetCmdLine(int argc, const wxCmdLineArgsArray& argv);

 #endif // wxUSE_UNICODE
     void SetCmdLine(const wxString& cmdline);
 
 #endif // wxUSE_UNICODE
     void SetCmdLine(const wxString& cmdline);
 


@@ -138,7 +168,7 @@ public:
     void EnableLongOptions(bool enable = true);
     void DisableLongOptions() { EnableLongOptions(false); }
 
     void EnableLongOptions(bool enable = true);
     void DisableLongOptions() { EnableLongOptions(false); }
 

-    bool AreLongOptionsEnabled();
+    bool AreLongOptionsEnabled() const;

 
     // extra text may be shown by Usage() method if set by this function
     void SetLogo(const wxString& logo);
 
     // extra text may be shown by Usage() method if set by this function
     void SetLogo(const wxString& logo);


@@ -153,18 +183,34 @@ public:
     void AddSwitch(const wxString& name, const wxString& lng = wxEmptyString,
                    const wxString& desc = wxEmptyString,
                    int flags = 0);
     void AddSwitch(const wxString& name, const wxString& lng = wxEmptyString,
                    const wxString& desc = wxEmptyString,
                    int flags = 0);

+    void AddLongSwitch(const wxString& lng,
+                       const wxString& desc = wxEmptyString,
+                       int flags = 0)
+    {
+        AddSwitch(wxString(), lng, desc, flags);
+    }

 
     // an option taking a value of the given type
     void AddOption(const wxString& name, const wxString& lng = wxEmptyString,
                    const wxString& desc = wxEmptyString,
                    wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
                    int flags = 0);
 
     // an option taking a value of the given type
     void AddOption(const wxString& name, const wxString& lng = wxEmptyString,
                    const wxString& desc = wxEmptyString,
                    wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
                    int flags = 0);

+    void AddLongOption(const wxString& lng,
+                       const wxString& desc = wxEmptyString,
+                       wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
+                       int flags = 0)
+    {
+        AddOption(wxString(), lng, desc, type, flags);
+    }

 
     // a parameter
     void AddParam(const wxString& desc = wxEmptyString,
                   wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
                   int flags = 0);
 
 
     // a parameter
     void AddParam(const wxString& desc = wxEmptyString,
                   wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
                   int flags = 0);
 

+    // add an explanatory text to be shown to the user in help
+    void AddUsageText(const wxString& text);
+

     // actions
     // -------
 
     // actions
     // -------
 


@@ -177,7 +223,10 @@ public:
     int Parse(bool showUsage = true);
 
     // give the usage message describing all program options
     int Parse(bool showUsage = true);
 
     // give the usage message describing all program options

-    void Usage();
+    void Usage() const;
+
+    // return the usage string, call Usage() to directly show it to the user
+    wxString GetUsageString() const;

 
     // get the command line arguments
     // ------------------------------
 
     // get the command line arguments
     // ------------------------------


@@ -185,6 +234,12 @@ public:
     // returns true if the given switch was found
     bool Found(const wxString& name) const;
 
     // returns true if the given switch was found
     bool Found(const wxString& name) const;
 

+    // Returns wxCMD_SWITCH_NOT_FOUND if the switch was not found at all,
+    // wxCMD_SWITCH_ON if it was found in normal state and wxCMD_SWITCH_OFF if
+    // it was found but negated (i.e. followed by "-", this can only happen for
+    // the switches with wxCMD_LINE_SWITCH_NEGATABLE flag).
+    wxCmdLineSwitchState FoundSwitch(const wxString& name) const;
+

     // returns true if an option taking a string value was found and stores the
     // value in the provided pointer
     bool Found(const wxString& name, wxString *value) const;
     // returns true if an option taking a string value was found and stores the
     // value in the provided pointer
     bool Found(const wxString& name, wxString *value) const;


@@ -193,6 +248,10 @@ public:
     // the value in the provided pointer
     bool Found(const wxString& name, long *value) const;
 
     // the value in the provided pointer
     bool Found(const wxString& name, long *value) const;
 

+    // returns true if an option taking a double value was found and stores
+    // the value in the provided pointer
+    bool Found(const wxString& name, double *value) const;
+

 #if wxUSE_DATETIME
     // returns true if an option taking a date value was found and stores the
     // value in the provided pointer
 #if wxUSE_DATETIME
     // returns true if an option taking a date value was found and stores the
     // value in the provided pointer


@@ -209,18 +268,17 @@ public:
     void Reset();
 
     // break down the command line in arguments
     void Reset();
 
     // break down the command line in arguments

-    static wxArrayString ConvertStringToArgs(const wxChar *cmdline);
+    static wxArrayString
+    ConvertStringToArgs(const wxString& cmdline,
+                        wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS);

 
 private:
 
 private:

-    // get usage string
-    wxString GetUsageString();
-

     // common part of all ctors
     void Init();
 
     struct wxCmdLineParserData *m_data;
 
     // common part of all ctors
     void Init();
 
     struct wxCmdLineParserData *m_data;
 

-    DECLARE_NO_COPY_CLASS(wxCmdLineParser)
+    wxDECLARE_NO_COPY_CLASS(wxCmdLineParser);

 };
 
 #else // !wxUSE_CMDLINE_PARSER
 };
 
 #else // !wxUSE_CMDLINE_PARSER


@@ -230,10 +288,11 @@ private:
 class WXDLLIMPEXP_BASE wxCmdLineParser
 {
 public:
 class WXDLLIMPEXP_BASE wxCmdLineParser
 {
 public:

-    static wxArrayString ConvertStringToArgs(const wxChar *cmdline);
+    static wxArrayString
+    ConvertStringToArgs(const wxString& cmdline,
+                        wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS);

 };
 
 #endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER
 
 #endif // _WX_CMDLINE_H_
 };
 
 #endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER
 
 #endif // _WX_CMDLINE_H_

-