projects
/
wxWidgets.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
don't duplicate base class m_acceleratorTable as m_accelTable in wxMenuBar, this...
[wxWidgets.git]
/
include
/
wx
/
cmdline.h
diff --git
a/include/wx/cmdline.h
b/include/wx/cmdline.h
index b34d1142255cafa2ed3e15da6fa286d5cc41960a..10bf956eb0052af0cf0127481b53e97ca95acdc1 100644
(file)
--- a/
include/wx/cmdline.h
+++ b/
include/wx/cmdline.h
@@
-7,22
+7,28
@@
// 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 licen
s
e
+// Licence: wxWindows licen
c
e
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_CMDLINE_H_
#define _WX_CMDLINE_H_
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_CMDLINE_H_
#define _WX_CMDLINE_H_
-#ifdef __GNUG__
- #pragma interface "cmdline.h"
-#endif
-
#include "wx/defs.h"
#include "wx/defs.h"
+
#include "wx/string.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 WXDLL
EXPORT
wxDateTime;
+class WXDLL
IMPEXP_FWD_BASE
wxDateTime;
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
// constants
@@
-46,6
+52,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
};
@@
-55,6
+62,7
@@
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
};
@@
-66,13
+74,17
@@
enum wxCmdLineEntryType
struct wxCmdLineEntryDesc
{
wxCmdLineEntryType kind;
struct wxCmdLineEntryDesc
{
wxCmdLineEntryType kind;
- const
wxC
har *shortName;
- const
wxC
har *longName;
- const
wxC
har *description;
+ const
c
har *shortName;
+ const
c
har *longName;
+ const
c
har *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.
//
@@
-91,7
+103,7
@@
struct wxCmdLineEntryDesc
// 4. use GetXXX() to retrieve the parsed info
// ----------------------------------------------------------------------------
// 4. use GetXXX() to retrieve the parsed info
// ----------------------------------------------------------------------------
-class WXDLL
EXPORT
wxCmdLineParser
+class WXDLL
IMPEXP_BASE
wxCmdLineParser
{
public:
// ctors and initializers
{
public:
// ctors and initializers
@@
-99,20
+111,37
@@
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); }
+#if wxUSE_UNICODE
wxCmdLineParser(int argc, wxChar **argv) { Init(); SetCmdLine(argc, argv); }
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 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, 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
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, 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 SetCmdLine(const wxString& cmdline);
// not virtual, don't use this class polymorphically
@@
-127,8
+156,10
@@
public:
void SetSwitchChars(const wxString& switchChars);
// long options are not POSIX-compliant, this option allows to disable them
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);
// extra text may be shown by Usage() method if set by this function
void SetLogo(const wxString& logo);
@@
-155,37
+186,49
@@
public:
wxCmdLineParamType type = wxCMD_LINE_VAL_STRING,
int flags = 0);
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
// 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
+ // syntax error occur
r
ed
//
// if showUsage is true, Usage() is called in case of syntax error or if
// help was requested
//
// if showUsage is true, Usage() is called in case of syntax error or if
// help was requested
- int Parse(bool showUsage =
TRUE
);
+ int Parse(bool showUsage =
true
);
// give the usage message describing all program options
// 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
// ------------------------------
- // returns
TRUE
if the given switch was found
+ // returns
true
if the given switch was found
bool Found(const wxString& name) const;
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;
// 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;
// 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;
// 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 number of parameters found
size_t GetParamCount() const;
@@
-197,26
+240,31
@@
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:
// common part of all ctors
void Init();
struct wxCmdLineParserData *m_data;
private:
// 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
};
#else // !wxUSE_CMDLINE_PARSER
// this function is always available (even if !wxUSE_CMDLINE_PARSER) because it
// is used by wxWin itself under Windows
-class WXDLL
EXPORT
wxCmdLineParser
+class WXDLL
IMPEXP_BASE
wxCmdLineParser
{
public:
{
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_
-