]> git.saurik.com Git - wxWidgets.git/blame - src/common/cmdline.cpp
Removed 'interface' pragma for gcc 2.96
[wxWidgets.git] / src / common / cmdline.cpp
CommitLineData
9f83044f
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: common/cmdline.cpp
3// Purpose: wxCmdLineParser implementation
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 05.01.00
7// RCS-ID: $Id$
8// Copyright: (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9// Licence: wxWindows license
10///////////////////////////////////////////////////////////////////////////////
11
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
20#ifdef __GNUG__
21 #pragma implementation "cmdline.h"
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
28 #pragma hdrstop
29#endif
30
31#ifndef WX_PRECOMP
32 #include "wx/string.h"
33 #include "wx/log.h"
34 #include "wx/intl.h"
2822ee33 35 #include "wx/app.h"
9f83044f 36 #include "wx/dynarray.h"
2822ee33 37 #include "wx/filefn.h"
9f83044f
VZ
38#endif //WX_PRECOMP
39
ff0ea71c
GT
40#include <ctype.h>
41
9f83044f
VZ
42#include "wx/datetime.h"
43#include "wx/cmdline.h"
44
45// ----------------------------------------------------------------------------
46// private functions
47// ----------------------------------------------------------------------------
48
49static wxString GetTypeName(wxCmdLineParamType type);
50
51// ----------------------------------------------------------------------------
52// private classes
53// ----------------------------------------------------------------------------
54
55// an internal representation of an option
56struct wxCmdLineOption
57{
58 wxCmdLineOption(wxCmdLineEntryType k,
59 const wxString& shrt,
60 const wxString& lng,
61 const wxString& desc,
62 wxCmdLineParamType typ,
63 int fl)
64 {
65 kind = k;
66
67 shortName = shrt;
68 longName = lng;
69 description = desc;
70
71 type = typ;
72 flags = fl;
73
74 m_hasVal = FALSE;
75 }
76
77 // can't use union easily here, so just store all possible data fields, we
78 // don't waste much (might still use union later if the number of supported
79 // types increases, so always use the accessor functions and don't access
80 // the fields directly!)
81
6f2a55e3 82 void Check(wxCmdLineParamType WXUNUSED_UNLESS_DEBUG(typ)) const
9f83044f
VZ
83 {
84 wxASSERT_MSG( type == typ, _T("type mismatch in wxCmdLineOption") );
85 }
86
87 long GetLongVal() const
88 { Check(wxCMD_LINE_VAL_NUMBER); return m_longVal; }
89 const wxString& GetStrVal() const
90 { Check(wxCMD_LINE_VAL_STRING); return m_strVal; }
91 const wxDateTime& GetDateVal() const
92 { Check(wxCMD_LINE_VAL_DATE); return m_dateVal; }
93
94 void SetLongVal(long val)
95 { Check(wxCMD_LINE_VAL_NUMBER); m_longVal = val; m_hasVal = TRUE; }
96 void SetStrVal(const wxString& val)
97 { Check(wxCMD_LINE_VAL_STRING); m_strVal = val; m_hasVal = TRUE; }
98 void SetDateVal(const wxDateTime val)
99 { Check(wxCMD_LINE_VAL_DATE); m_dateVal = val; m_hasVal = TRUE; }
100
07d09af8 101 void SetHasValue(bool hasValue = TRUE) { m_hasVal = hasValue; }
9f83044f
VZ
102 bool HasValue() const { return m_hasVal; }
103
104public:
105 wxCmdLineEntryType kind;
106 wxString shortName, longName, description;
107 wxCmdLineParamType type;
108 int flags;
109
110private:
111 bool m_hasVal;
112
113 long m_longVal;
114 wxString m_strVal;
115 wxDateTime m_dateVal;
116};
117
118struct wxCmdLineParam
119{
120 wxCmdLineParam(const wxString& desc,
121 wxCmdLineParamType typ,
122 int fl)
123 : description(desc)
124 {
125 type = typ;
126 flags = fl;
127 }
128
129 wxString description;
130 wxCmdLineParamType type;
131 int flags;
132};
133
134WX_DECLARE_OBJARRAY(wxCmdLineOption, wxArrayOptions);
135WX_DECLARE_OBJARRAY(wxCmdLineParam, wxArrayParams);
136
137#include "wx/arrimpl.cpp"
138
139WX_DEFINE_OBJARRAY(wxArrayOptions);
140WX_DEFINE_OBJARRAY(wxArrayParams);
141
142// the parser internal state
143struct wxCmdLineParserData
144{
145 // options
146 wxString m_switchChars; // characters which may start an option
9f83044f 147 bool m_enableLongOptions; // TRUE if long options are enabled
e612f101 148 wxString m_logo; // some extra text to show in Usage()
9f83044f
VZ
149
150 // cmd line data
151 wxArrayString m_arguments; // == argv, argc == m_arguments.GetCount()
152 wxArrayOptions m_options; // all possible options and switchrs
153 wxArrayParams m_paramDesc; // description of all possible params
154 wxArrayString m_parameters; // all params found
155
156 // methods
157 wxCmdLineParserData();
158 void SetArguments(int argc, char **argv);
159 void SetArguments(const wxString& cmdline);
160
161 int FindOption(const wxString& name);
162 int FindOptionByLongName(const wxString& name);
163};
164
165// ============================================================================
166// implementation
167// ============================================================================
168
169// ----------------------------------------------------------------------------
170// wxCmdLineParserData
171// ----------------------------------------------------------------------------
172
173wxCmdLineParserData::wxCmdLineParserData()
174{
175 m_enableLongOptions = TRUE;
176#ifdef __UNIX_LIKE__
177 m_switchChars = _T("-");
178#else // !Unix
179 m_switchChars = _T("/-");
180#endif
181}
182
183void wxCmdLineParserData::SetArguments(int argc, char **argv)
184{
185 m_arguments.Empty();
186
187 for ( int n = 0; n < argc; n++ )
188 {
189 m_arguments.Add(argv[n]);
190 }
191}
192
97d59046 193void wxCmdLineParserData::SetArguments(const wxString& cmdLine)
9f83044f 194{
97d59046
JS
195 m_arguments.Empty();
196
197 m_arguments.Add(wxTheApp->GetAppName());
198
199 // Break up string
200 // Treat strings enclosed in double-quotes as single arguments
201 int i = 0;
202 int len = cmdLine.Length();
203 while (i < len)
204 {
205 // Skip whitespace
206 while ((i < len) && wxIsspace(cmdLine.GetChar(i)))
207 i ++;
9f83044f 208
97d59046
JS
209 if (i < len)
210 {
211 if (cmdLine.GetChar(i) == wxT('"')) // We found the start of a string
212 {
213 i ++;
214 int first = i;
215 while ((i < len) && (cmdLine.GetChar(i) != wxT('"')))
216 i ++;
217
218 wxString arg(cmdLine.Mid(first, (i - first)));
219
220 m_arguments.Add(arg);
221
222 if (i < len)
223 i ++; // Skip past 2nd quote
224 }
225 else // Unquoted argument
226 {
227 int first = i;
228 while ((i < len) && !wxIsspace(cmdLine.GetChar(i)))
229 i ++;
230
231 wxString arg(cmdLine.Mid(first, (i - first)));
232
233 m_arguments.Add(arg);
234 }
235 }
236 }
9f83044f
VZ
237}
238
239int wxCmdLineParserData::FindOption(const wxString& name)
240{
241 size_t count = m_options.GetCount();
242 for ( size_t n = 0; n < count; n++ )
243 {
244 if ( m_options[n].shortName == name )
245 {
246 // found
247 return n;
248 }
249 }
250
251 return wxNOT_FOUND;
252}
253
254int wxCmdLineParserData::FindOptionByLongName(const wxString& name)
255{
256 size_t count = m_options.GetCount();
257 for ( size_t n = 0; n < count; n++ )
258 {
259 if ( m_options[n].longName == name )
260 {
261 // found
262 return n;
263 }
264 }
265
266 return wxNOT_FOUND;
267}
268
269// ----------------------------------------------------------------------------
270// construction and destruction
271// ----------------------------------------------------------------------------
272
273void wxCmdLineParser::Init()
274{
275 m_data = new wxCmdLineParserData;
276}
277
278void wxCmdLineParser::SetCmdLine(int argc, char **argv)
279{
280 m_data->SetArguments(argc, argv);
281}
282
283void wxCmdLineParser::SetCmdLine(const wxString& cmdline)
284{
285 m_data->SetArguments(cmdline);
286}
287
288wxCmdLineParser::~wxCmdLineParser()
289{
290 delete m_data;
291}
292
293// ----------------------------------------------------------------------------
294// options
295// ----------------------------------------------------------------------------
296
297void wxCmdLineParser::SetSwitchChars(const wxString& switchChars)
298{
299 m_data->m_switchChars = switchChars;
300}
301
302void wxCmdLineParser::EnableLongOptions(bool enable)
303{
304 m_data->m_enableLongOptions = enable;
305}
306
e612f101
VZ
307void wxCmdLineParser::SetLogo(const wxString& logo)
308{
309 m_data->m_logo = logo;
310}
311
9f83044f
VZ
312// ----------------------------------------------------------------------------
313// command line construction
314// ----------------------------------------------------------------------------
315
316void wxCmdLineParser::SetDesc(const wxCmdLineEntryDesc *desc)
317{
318 for ( ;; desc++ )
319 {
320 switch ( desc->kind )
321 {
322 case wxCMD_LINE_SWITCH:
e612f101
VZ
323 AddSwitch(desc->shortName, desc->longName, desc->description,
324 desc->flags);
9f83044f
VZ
325 break;
326
327 case wxCMD_LINE_OPTION:
328 AddOption(desc->shortName, desc->longName, desc->description,
329 desc->type, desc->flags);
330 break;
331
332 case wxCMD_LINE_PARAM:
333 AddParam(desc->description, desc->type, desc->flags);
334 break;
335
336 default:
337 wxFAIL_MSG( _T("unknown command line entry type") );
338 // still fall through
339
340 case wxCMD_LINE_NONE:
341 return;
342 }
343 }
344}
345
346void wxCmdLineParser::AddSwitch(const wxString& shortName,
347 const wxString& longName,
348 const wxString& desc,
349 int flags)
350{
351 wxASSERT_MSG( m_data->FindOption(shortName) == wxNOT_FOUND,
352 _T("duplicate switch") );
353
354 wxCmdLineOption *option = new wxCmdLineOption(wxCMD_LINE_SWITCH,
355 shortName, longName, desc,
356 wxCMD_LINE_VAL_NONE, flags);
357
358 m_data->m_options.Add(option);
359}
360
361void wxCmdLineParser::AddOption(const wxString& shortName,
362 const wxString& longName,
363 const wxString& desc,
364 wxCmdLineParamType type,
365 int flags)
366{
367 wxASSERT_MSG( m_data->FindOption(shortName) == wxNOT_FOUND,
368 _T("duplicate option") );
369
370 wxCmdLineOption *option = new wxCmdLineOption(wxCMD_LINE_OPTION,
371 shortName, longName, desc,
372 type, flags);
373
374 m_data->m_options.Add(option);
375}
376
377void wxCmdLineParser::AddParam(const wxString& desc,
378 wxCmdLineParamType type,
379 int flags)
380{
381 // do some consistency checks: a required parameter can't follow an
382 // optional one and nothing should follow a parameter with MULTIPLE flag
383#ifdef __WXDEBUG__
384 if ( !m_data->m_paramDesc.IsEmpty() )
385 {
386 wxCmdLineParam& param = m_data->m_paramDesc.Last();
387
388 wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_MULTIPLE),
fbdcff4a 389 _T("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style will be ignored") );
9f83044f
VZ
390
391 if ( !(flags & wxCMD_LINE_PARAM_OPTIONAL) )
392 {
393 wxASSERT_MSG( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL),
fbdcff4a 394 _T("a required parameter can't follow an optional one") );
9f83044f
VZ
395 }
396 }
397#endif // Debug
398
399 wxCmdLineParam *param = new wxCmdLineParam(desc, type, flags);
400
401 m_data->m_paramDesc.Add(param);
402}
403
404// ----------------------------------------------------------------------------
405// access to parse command line
406// ----------------------------------------------------------------------------
407
408bool wxCmdLineParser::Found(const wxString& name) const
409{
410 int i = m_data->FindOption(name);
411 wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown switch") );
412
413 wxCmdLineOption& opt = m_data->m_options[(size_t)i];
414 if ( !opt.HasValue() )
415 return FALSE;
416
417 return TRUE;
418}
419
420bool wxCmdLineParser::Found(const wxString& name, wxString *value) const
421{
422 int i = m_data->FindOption(name);
423 wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
424
425 wxCmdLineOption& opt = m_data->m_options[(size_t)i];
426 if ( !opt.HasValue() )
427 return FALSE;
428
429 wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") );
430
431 *value = opt.GetStrVal();
432
433 return TRUE;
434}
435
436bool wxCmdLineParser::Found(const wxString& name, long *value) const
437{
438 int i = m_data->FindOption(name);
439 wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
440
441 wxCmdLineOption& opt = m_data->m_options[(size_t)i];
442 if ( !opt.HasValue() )
443 return FALSE;
444
445 wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") );
446
447 *value = opt.GetLongVal();
448
449 return TRUE;
450}
451
452bool wxCmdLineParser::Found(const wxString& name, wxDateTime *value) const
453{
454 int i = m_data->FindOption(name);
455 wxCHECK_MSG( i != wxNOT_FOUND, FALSE, _T("unknown option") );
456
457 wxCmdLineOption& opt = m_data->m_options[(size_t)i];
458 if ( !opt.HasValue() )
459 return FALSE;
460
461 wxCHECK_MSG( value, FALSE, _T("NULL pointer in wxCmdLineOption::Found") );
462
463 *value = opt.GetDateVal();
464
465 return TRUE;
466}
467
468size_t wxCmdLineParser::GetParamCount() const
469{
470 return m_data->m_parameters.GetCount();
471}
472
473wxString wxCmdLineParser::GetParam(size_t n) const
474{
475 return m_data->m_parameters[n];
476}
477
07d09af8
JS
478// Resets switches and options
479void wxCmdLineParser::Reset()
480{
481 unsigned int i;
482 for (i = 0; i < m_data->m_options.Count(); i++)
483 {
484 wxCmdLineOption& opt = m_data->m_options[(size_t)i];
485 opt.SetHasValue(FALSE);
486 }
487}
488
489
9f83044f
VZ
490// ----------------------------------------------------------------------------
491// the real work is done here
492// ----------------------------------------------------------------------------
493
494int wxCmdLineParser::Parse()
495{
496 bool maybeOption = TRUE; // can the following arg be an option?
497 bool ok = TRUE; // TRUE until an error is detected
498 bool helpRequested = FALSE; // TRUE if "-h" was given
499 bool hadRepeatableParam = FALSE; // TRUE if found param with MULTIPLE flag
500
501 size_t currentParam = 0; // the index in m_paramDesc
502
503 size_t countParam = m_data->m_paramDesc.GetCount();
504
07d09af8
JS
505 Reset();
506
9f83044f
VZ
507 // parse everything
508 wxString arg;
509 size_t count = m_data->m_arguments.GetCount();
510 for ( size_t n = 1; ok && (n < count); n++ ) // 0 is program name
511 {
512 arg = m_data->m_arguments[n];
513
514 // special case: "--" should be discarded and all following arguments
515 // should be considered as parameters, even if they start with '-' and
516 // not like options (this is POSIX-like)
517 if ( arg == _T("--") )
518 {
519 maybeOption = FALSE;
520
521 continue;
522 }
523
524 // empty argument or just '-' is not an option but a parameter
525 if ( maybeOption && arg.length() > 1 &&
526 wxStrchr(m_data->m_switchChars, arg[0u]) )
527 {
528 bool isLong;
529 wxString name;
530 int optInd = wxNOT_FOUND; // init to suppress warnings
531
532 // an option or a switch: find whether it's a long or a short one
533 if ( m_data->m_enableLongOptions &&
534 arg[0u] == _T('-') && arg[1u] == _T('-') )
535 {
536 // a long one
537 isLong = TRUE;
538
539 const wxChar *p = arg.c_str() + 2;
f6bcfd97 540 while ( wxIsalnum(*p) || (*p == _T('_')) || (*p == _T('-')) )
9f83044f
VZ
541 {
542 name += *p++;
543 }
544
545 optInd = m_data->FindOptionByLongName(name);
546 if ( optInd == wxNOT_FOUND )
547 {
548 wxLogError(_("Unknown long option '%s'"), name.c_str());
549 }
550 }
551 else
552 {
553 isLong = FALSE;
554
555 // a short one: as they can be cumulated, we try to find the
556 // longest substring which is a valid option
557 const wxChar *p = arg.c_str() + 1;
f6bcfd97 558 while ( wxIsalnum(*p) || (*p == _T('_')) )
9f83044f
VZ
559 {
560 name += *p++;
561 }
562
563 size_t len = name.length();
564 do
565 {
566 if ( len == 0 )
567 {
568 // we couldn't find a valid option name in the
569 // beginning of this string
570 wxLogError(_("Unknown option '%s'"), name.c_str());
571
572 break;
573 }
574 else
575 {
576 optInd = m_data->FindOption(name.Left(len));
577
578 // will try with one character less the next time
579 len--;
580 }
581 }
582 while ( optInd == wxNOT_FOUND );
583
2822ee33 584 len++; // compensates extra len-- above
4f40f5e3 585 if ( (optInd != wxNOT_FOUND) && (len != name.length()) )
9f83044f 586 {
2822ee33
VZ
587 // first of all, the option name is only part of this
588 // string
589 name = name.Left(len);
590
9f83044f
VZ
591 // our option is only part of this argument, there is
592 // something else in it - it is either the value of this
593 // option or other switches if it is a switch
594 if ( m_data->m_options[(size_t)optInd].kind
595 == wxCMD_LINE_SWITCH )
596 {
597 // pretend that all the rest of the argument is the
598 // next argument, in fact
599 wxString arg2 = arg[0u];
2822ee33 600 arg2 += arg.Mid(len + 1); // +1 for leading '-'
9f83044f
VZ
601
602 m_data->m_arguments.Insert(arg2, n + 1);
4f40f5e3 603 count++;
9f83044f
VZ
604 }
605 //else: it's our value, we'll deal with it below
606 }
607 }
608
609 if ( optInd == wxNOT_FOUND )
610 {
611 ok = FALSE;
612
613 continue; // will break, in fact
614 }
615
616 wxCmdLineOption& opt = m_data->m_options[(size_t)optInd];
617 if ( opt.kind == wxCMD_LINE_SWITCH )
618 {
619 // nothing more to do
620 opt.SetHasValue();
621
622 if ( opt.flags & wxCMD_LINE_OPTION_HELP )
623 {
624 helpRequested = TRUE;
625
626 // it's not an error, but we still stop here
627 ok = FALSE;
628 }
629 }
630 else
631 {
632 // get the value
633
634 // +1 for leading '-'
635 const wxChar *p = arg.c_str() + 1 + name.length();
636 if ( isLong )
637 {
638 p++; // for another leading '-'
639
640 if ( *p++ != _T('=') )
641 {
fbdcff4a 642 wxLogError(_("Option '%s' requires a value, '=' expected."), name.c_str());
9f83044f
VZ
643
644 ok = FALSE;
645 }
646 }
647 else
648 {
649 switch ( *p )
650 {
f6bcfd97 651 case _T('='):
9f83044f
VZ
652 case _T(':'):
653 // the value follows
654 p++;
655 break;
656
657 case 0:
658 // the value is in the next argument
659 if ( ++n == count )
660 {
661 // ... but there is none
662 wxLogError(_("Option '%s' requires a value."),
663 name.c_str());
664
665 ok = FALSE;
666 }
667 else
668 {
669 // ... take it from there
670 p = m_data->m_arguments[n].c_str();
671 }
672 break;
673
674 default:
f6bcfd97
BP
675 // the value is right here: this may be legal or
676 // not depending on the option style
677 if ( opt.flags & wxCMD_LINE_NEEDS_SEPARATOR )
678 {
679 wxLogError(_("Separator expected after the option '%s'."),
680 name.c_str());
681
682 ok = FALSE;
683 }
9f83044f
VZ
684 }
685 }
686
687 if ( ok )
688 {
689 wxString value = p;
690 switch ( opt.type )
691 {
692 default:
693 wxFAIL_MSG( _T("unknown option type") );
694 // still fall through
695
696 case wxCMD_LINE_VAL_STRING:
697 opt.SetStrVal(value);
698 break;
699
700 case wxCMD_LINE_VAL_NUMBER:
701 {
702 long val;
703 if ( value.ToLong(&val) )
704 {
705 opt.SetLongVal(val);
706 }
707 else
708 {
fbdcff4a 709 wxLogError(_("'%s' is not a correct numeric value for option '%s'."),
9f83044f
VZ
710 value.c_str(), name.c_str());
711
712 ok = FALSE;
713 }
714 }
715 break;
716
717 case wxCMD_LINE_VAL_DATE:
718 {
719 wxDateTime dt;
720 const wxChar *res = dt.ParseDate(value);
721 if ( !res || *res )
722 {
fbdcff4a 723 wxLogError(_("Option '%s': '%s' cannot be converted to a date."),
9f83044f
VZ
724 name.c_str(), value.c_str());
725
726 ok = FALSE;
727 }
728 else
729 {
730 opt.SetDateVal(dt);
731 }
732 }
733 break;
734 }
735 }
736 }
737 }
738 else
739 {
740 // a parameter
741 if ( currentParam < countParam )
742 {
743 wxCmdLineParam& param = m_data->m_paramDesc[currentParam];
744
745 // TODO check the param type
746
747 m_data->m_parameters.Add(arg);
748
749 if ( !(param.flags & wxCMD_LINE_PARAM_MULTIPLE) )
750 {
751 currentParam++;
752 }
753 else
754 {
755 wxASSERT_MSG( currentParam == countParam - 1,
fbdcff4a 756 _T("all parameters after the one with wxCMD_LINE_PARAM_MULTIPLE style are ignored") );
9f83044f
VZ
757
758 // remember that we did have this last repeatable parameter
759 hadRepeatableParam = TRUE;
760 }
761 }
762 else
763 {
764 wxLogError(_("Unexpected parameter '%s'"), arg.c_str());
765
766 ok = FALSE;
767 }
768 }
769 }
770
771 // verify that all mandatory options were given
772 if ( ok )
773 {
774 size_t countOpt = m_data->m_options.GetCount();
775 for ( size_t n = 0; ok && (n < countOpt); n++ )
776 {
777 wxCmdLineOption& opt = m_data->m_options[n];
778 if ( (opt.flags & wxCMD_LINE_OPTION_MANDATORY) && !opt.HasValue() )
779 {
780 wxString optName;
781 if ( !opt.longName )
782 {
783 optName = opt.shortName;
784 }
785 else
786 {
787 optName.Printf(_("%s (or %s)"),
788 opt.shortName.c_str(),
789 opt.longName.c_str());
790 }
791
792 wxLogError(_("The value for the option '%s' must be specified."),
793 optName.c_str());
794
795 ok = FALSE;
796 }
797 }
798
799 for ( ; ok && (currentParam < countParam); currentParam++ )
800 {
801 wxCmdLineParam& param = m_data->m_paramDesc[currentParam];
802 if ( (currentParam == countParam - 1) &&
803 (param.flags & wxCMD_LINE_PARAM_MULTIPLE) &&
804 hadRepeatableParam )
805 {
806 // special case: currentParam wasn't incremented, but we did
807 // have it, so don't give error
808 continue;
809 }
810
811 if ( !(param.flags & wxCMD_LINE_PARAM_OPTIONAL) )
812 {
813 wxLogError(_("The required parameter '%s' was not specified."),
814 param.description.c_str());
815
816 ok = FALSE;
817 }
818 }
819 }
820
821 if ( !ok )
822 {
823 Usage();
824 }
825
826 return ok ? 0 : helpRequested ? -1 : 1;
827}
828
829// ----------------------------------------------------------------------------
830// give the usage message
831// ----------------------------------------------------------------------------
832
833void wxCmdLineParser::Usage()
834{
2822ee33
VZ
835 wxString appname = wxTheApp->GetAppName();
836 if ( !appname )
837 {
838 wxCHECK_RET( !m_data->m_arguments.IsEmpty(), _T("no program name") );
839
840 appname = wxFileNameFromPath(m_data->m_arguments[0]);
841 wxStripExtension(appname);
842 }
843
f6bcfd97
BP
844 // we construct the brief cmd line desc on the fly, but not the detailed
845 // help message below because we want to align the options descriptions
846 // and for this we must first know the longest one of them
847 wxString brief;
848 wxArrayString namesOptions, descOptions;
2822ee33 849 brief.Printf(_("Usage: %s"), appname.c_str());
9f83044f 850
f6bcfd97
BP
851 // the switch char is usually '-' but this can be changed with
852 // SetSwitchChars() and then the first one of possible chars is used
853 wxChar chSwitch = !m_data->m_switchChars ? _T('-')
854 : m_data->m_switchChars[0u];
855
9f83044f
VZ
856 size_t n, count = m_data->m_options.GetCount();
857 for ( n = 0; n < count; n++ )
858 {
859 wxCmdLineOption& opt = m_data->m_options[n];
860
861 brief << _T(' ');
862 if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
863 {
864 brief << _T('[');
865 }
866
f6bcfd97
BP
867 brief << chSwitch << opt.shortName;
868
869 wxString option;
870 option << _T(" ") << chSwitch << opt.shortName;
9f83044f
VZ
871 if ( !!opt.longName )
872 {
f6bcfd97 873 option << _T(" --") << opt.longName;
9f83044f
VZ
874 }
875
876 if ( opt.kind != wxCMD_LINE_SWITCH )
877 {
878 wxString val;
879 val << _T('<') << GetTypeName(opt.type) << _T('>');
880 brief << _T(' ') << val;
f6bcfd97 881 option << (!opt.longName ? _T(':') : _T('=')) << val;
9f83044f
VZ
882 }
883
884 if ( !(opt.flags & wxCMD_LINE_OPTION_MANDATORY) )
885 {
886 brief << _T(']');
887 }
888
f6bcfd97
BP
889 namesOptions.Add(option);
890 descOptions.Add(opt.description);
9f83044f
VZ
891 }
892
893 count = m_data->m_paramDesc.GetCount();
894 for ( n = 0; n < count; n++ )
895 {
896 wxCmdLineParam& param = m_data->m_paramDesc[n];
897
898 brief << _T(' ');
899 if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL )
900 {
901 brief << _T('[');
902 }
903
904 brief << param.description;
905
906 if ( param.flags & wxCMD_LINE_PARAM_MULTIPLE )
907 {
908 brief << _T("...");
909 }
910
911 if ( param.flags & wxCMD_LINE_PARAM_OPTIONAL )
912 {
913 brief << _T(']');
914 }
915 }
916
e612f101
VZ
917 if ( !!m_data->m_logo )
918 {
919 wxLogMessage(m_data->m_logo);
920 }
921
9f83044f 922 wxLogMessage(brief);
f6bcfd97
BP
923
924 // now construct the detailed help message
925 size_t len, lenMax = 0;
926 count = namesOptions.GetCount();
927 for ( n = 0; n < count; n++ )
928 {
929 len = namesOptions[n].length();
930 if ( len > lenMax )
931 lenMax = len;
932 }
933
934 wxString detailed;
935 for ( n = 0; n < count; n++ )
936 {
937 len = namesOptions[n].length();
938 detailed << namesOptions[n]
939 << wxString(_T(' '), lenMax - len) << _T('\t')
940 << descOptions[n]
941 << _T('\n');
942 }
943
9f83044f
VZ
944 wxLogMessage(detailed);
945}
946
947// ----------------------------------------------------------------------------
948// global functions
949// ----------------------------------------------------------------------------
950
951static wxString GetTypeName(wxCmdLineParamType type)
952{
953 wxString s;
954 switch ( type )
955 {
956 default:
957 wxFAIL_MSG( _T("unknown option type") );
958 // still fall through
959
960 case wxCMD_LINE_VAL_STRING: s = _("str"); break;
961 case wxCMD_LINE_VAL_NUMBER: s = _("num"); break;
962 case wxCMD_LINE_VAL_DATE: s = _("date"); break;
963 }
964
965 return s;
966}