X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0d5ab92f849923daa1418661aaf55135cddd4e47..da8b1d4b3b535aba94d04494f5b6e2b3e47901ee:/include/wx/cmdline.h diff --git a/include/wx/cmdline.h b/include/wx/cmdline.h index 88ce4e51d3..1ab9966364 100644 --- a/include/wx/cmdline.h +++ b/include/wx/cmdline.h @@ -17,6 +17,14 @@ #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 @@ -28,7 +36,7 @@ class WXDLLIMPEXP_FWD_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 -enum +enum wxCmdLineEntryFlags { wxCMD_LINE_OPTION_MANDATORY = 0x01, // this option must be given wxCMD_LINE_PARAM_OPTIONAL = 0x02, // the parameter may be omitted @@ -44,6 +52,7 @@ enum wxCmdLineParamType wxCMD_LINE_VAL_STRING, // should be 0 (default) wxCMD_LINE_VAL_NUMBER, wxCMD_LINE_VAL_DATE, + wxCMD_LINE_VAL_DOUBLE, wxCMD_LINE_VAL_NONE }; @@ -53,6 +62,7 @@ enum wxCmdLineEntryType wxCMD_LINE_SWITCH, wxCMD_LINE_OPTION, wxCMD_LINE_PARAM, + wxCMD_LINE_USAGE_TEXT, wxCMD_LINE_NONE // to terminate the list }; @@ -104,6 +114,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, const wxCmdLineArgsArray& argv) + { Init(); SetCmdLine(argc, argv); } #endif // wxUSE_UNICODE wxCmdLineParser(const wxString& cmdline) { Init(); SetCmdLine(cmdline); } @@ -116,6 +128,10 @@ public: #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); } @@ -124,6 +140,7 @@ public: 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); @@ -142,7 +159,7 @@ public: 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); @@ -169,6 +186,9 @@ public: 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 // ------- @@ -181,7 +201,10 @@ public: 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 // ------------------------------ @@ -197,6 +220,10 @@ public: // 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 @@ -213,18 +240,17 @@ public: void Reset(); // break down the command line in arguments - static wxArrayString ConvertStringToArgs(const wxString& cmdline); + static wxArrayString + ConvertStringToArgs(const wxString& cmdline, + wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS); private: - // get usage string - wxString GetUsageString(); - // 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 @@ -234,10 +260,11 @@ private: class WXDLLIMPEXP_BASE wxCmdLineParser { public: - static wxArrayString ConvertStringToArgs(const wxString& cmdline); + static wxArrayString + ConvertStringToArgs(const wxString& cmdline, + wxCmdLineSplitType type = wxCMD_LINE_SPLIT_DOS); }; #endif // wxUSE_CMDLINE_PARSER/!wxUSE_CMDLINE_PARSER #endif // _WX_CMDLINE_H_ -