Wrappers for *ToText

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

diff --git a/include/wx/cmdline.h b/include/wx/cmdline.h
index 0b7576b8cfd5f38ef3f138569fcbc5566590440d..66beea5a44e99860db9bef5cdec33b7f76fc74db 100644 (file)
--- a/include/wx/cmdline.h
+++ b/include/wx/cmdline.h
@@ -7,19 +7,24 @@
 // Created:     04.01.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     04.01.00
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CMDLINE_H_
 #define _WX_CMDLINE_H_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CMDLINE_H_
 #define _WX_CMDLINE_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "cmdline.h"
 #endif
 
     #pragma interface "cmdline.h"
 #endif
 

+#include "wx/defs.h"
+

 #include "wx/string.h"
 #include "wx/string.h"

+#include "wx/arrstr.h"
+
+#if wxUSE_CMDLINE_PARSER

 
 

-class WXDLLEXPORT wxDateTime;
+class WXDLLIMPEXP_BASE wxDateTime;

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


@@ -32,7 +37,8 @@ enum
     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_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_HELP      = 0x08, // this option is a help request
+    wxCMD_LINE_NEEDS_SEPARATOR  = 0x10  // must have sep before the value

 };
 
 // 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


@@ -87,7 +93,7 @@ struct wxCmdLineEntryDesc
 // 4. use GetXXX() to retrieve the parsed info
 // ----------------------------------------------------------------------------
 
 // 4. use GetXXX() to retrieve the parsed info
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxCmdLineParser
+class WXDLLIMPEXP_BASE wxCmdLineParser

 {
 public:
     // ctors and initializers
 {
 public:
     // ctors and initializers


@@ -95,20 +101,20 @@ public:
 
     // default ctor or ctor giving the cmd line in either Unix or Win form
     wxCmdLineParser() { Init(); }
 
     // default ctor or ctor giving the cmd line in either Unix or Win form
     wxCmdLineParser() { Init(); }

-    wxCmdLineParser(int argc, char **argv) { Init(); SetCmdLine(argc, argv); }
+    wxCmdLineParser(int argc, wxChar **argv) { Init(); SetCmdLine(argc, argv); }

     wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); }
 
     // the same as above, but also gives the cmd line description - otherwise,
     // use AddXXX() later
     wxCmdLineParser(const wxCmdLineEntryDesc *desc)
         { Init(); SetDesc(desc); }
     wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); }
 
     // the same as above, but also gives the cmd line description - otherwise,
     // use AddXXX() later
     wxCmdLineParser(const wxCmdLineEntryDesc *desc)
         { Init(); SetDesc(desc); }

-    wxCmdLineParser(const wxCmdLineEntryDesc *desc, int argc, char **argv)
+    wxCmdLineParser(const wxCmdLineEntryDesc *desc, int argc, wxChar **argv)

         { Init(); SetCmdLine(argc, argv); SetDesc(desc); }
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, const wxString& cmdline)
         { Init(); SetCmdLine(cmdline); SetDesc(desc); }
 
     // set cmd line to parse after using one of the ctors which don't do it
         { Init(); SetCmdLine(argc, argv); SetDesc(desc); }
     wxCmdLineParser(const wxCmdLineEntryDesc *desc, const wxString& cmdline)
         { Init(); SetCmdLine(cmdline); SetDesc(desc); }
 
     // set cmd line to parse after using one of the ctors which don't do it

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

     void SetCmdLine(const wxString& cmdline);
 
     // not virtual, don't use this class polymorphically
     void SetCmdLine(const wxString& cmdline);
 
     // not virtual, don't use this class polymorphically


@@ -126,6 +132,11 @@ public:
     void EnableLongOptions(bool enable = TRUE);
     void DisableLongOptions() { EnableLongOptions(FALSE); }
 
     void EnableLongOptions(bool enable = TRUE);
     void DisableLongOptions() { EnableLongOptions(FALSE); }
 

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

     // construct the cmd line description
     // ----------------------------------
 
     // construct the cmd line description
     // ----------------------------------
 


@@ -154,7 +165,10 @@ public:
     // parse the command line, return 0 if ok, -1 if "-h" or "--help" option
     // was encountered and the help message was given or a positive value if a
     // syntax error occured
     // parse the command line, return 0 if ok, -1 if "-h" or "--help" option
     // was encountered and the help message was given or a positive value if a
     // syntax error occured

-    int Parse();
+    //
+    // if showUsage is true, Usage() is called in case of syntax error or if
+    // help was requested
+    int Parse(bool showUsage = TRUE);

 
     // give the usage message describing all program options
     void Usage();
 
     // give the usage message describing all program options
     void Usage();


@@ -173,21 +187,47 @@ 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;
 

+#if wxUSE_DATETIME

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

+#endif // wxUSE_DATETIME

 
     // gets the number of parameters found
     size_t GetParamCount() const;
 
     // gets the value of Nth parameter (as string only for now)
 
     // gets the number of parameters found
     size_t GetParamCount() const;
 
     // gets the value of Nth parameter (as string only for now)

-    wxString GetParam(size_t n) const;
+    wxString GetParam(size_t n = 0u) const;
+
+    // Resets switches and options
+    void Reset();
+
+    // break down the command line in arguments
+    static wxArrayString ConvertStringToArgs(const wxChar *cmdline);

 
 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)

 };
 
 };
 

+#else // !wxUSE_CMDLINE_PARSER
+
+// this function is always available (even if !wxUSE_CMDLINE_PARSER) because it
+// is used by wxWin itself under Windows
+class WXDLLIMPEXP_BASE wxCmdLineParser
+{
+public:
+    static wxArrayString ConvertStringToArgs(const wxChar *cmdline);
+};
+
+#endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER
+

 #endif // _WX_CMDLINE_H_
 #endif // _WX_CMDLINE_H_

+