// 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_
-#ifdef __GNUG__
- #pragma interface "cmdline.h"
-#endif
-
#include "wx/defs.h"
-#if wxUSE_CMDLINE_PARSER
-
#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
+};
-class WXDLLEXPORT wxDateTime;
+#if wxUSE_CMDLINE_PARSER
+
+class WXDLLIMPEXP_FWD_BASE wxDateTime;
// ----------------------------------------------------------------------------
// constants
// 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_VAL_STRING, // should be 0 (default)
wxCMD_LINE_VAL_NUMBER,
wxCMD_LINE_VAL_DATE,
+ wxCMD_LINE_VAL_DOUBLE,
wxCMD_LINE_VAL_NONE
};
wxCMD_LINE_SWITCH,
wxCMD_LINE_OPTION,
wxCMD_LINE_PARAM,
+ wxCMD_LINE_USAGE_TEXT,
wxCMD_LINE_NONE // to terminate the list
};
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;
};
+// 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.
//
// 4. use GetXXX() to retrieve the parsed info
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxCmdLineParser
+class WXDLLIMPEXP_BASE wxCmdLineParser
{
public:
// ctors and initializers
// 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); }
+#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); }
// 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)
+ { 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); }
// set cmd line to parse after using one of the ctors which don't do it
+ 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);
// not virtual, don't use this class polymorphically
void SetSwitchChars(const wxString& switchChars);
// long options are not POSIX-compliant, this option allows to disable them
- void EnableLongOptions(bool enable = TRUE);
- void DisableLongOptions() { EnableLongOptions(FALSE); }
+ void EnableLongOptions(bool enable = true);
+ void DisableLongOptions() { EnableLongOptions(false); }
+
+ bool AreLongOptionsEnabled() const;
// extra text may be shown by Usage() method if set by this function
void SetLogo(const wxString& logo);
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
// -------
// 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();
+ // syntax error occurred
+ //
+ // 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();
+ void Usage() const;
+
+ // return the usage string, call Usage() to directly show it to the user
+ wxString GetUsageString() const;
// get the command line arguments
// ------------------------------
- // returns TRUE if the given switch was found
+ // returns true if the given switch was found
bool Found(const wxString& name) const;
- // returns TRUE if an option taking a string value was found and stores the
+ // 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 an integer value was found and stores
+ // returns true if an option taking an integer value was found and stores
// the value in the provided pointer
bool Found(const wxString& name, long *value) const;
- // returns TRUE if an option taking a date value was found and stores the
+ // 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
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)
wxString GetParam(size_t n = 0u) const;
- // Resets switches and options
- void Reset();
+ // Resets switches and options
+ void Reset();
+
+ // break down the command line in arguments
+ static wxArrayString
+ ConvertStringToArgs(const wxString& cmdline,
+ wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS);
private:
// common part of all ctors
void Init();
struct wxCmdLineParserData *m_data;
+
+ wxDECLARE_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 wxString& cmdline,
+ wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS);
};
-#endif // wxUSE_CMDLINE_PARSER
+#endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER
#endif // _WX_CMDLINE_H_
projects / wxWidgets.git / blobdiff