5,699,997 members and growing! (15,140 online)
Email Password   helpLost your password?
Languages » C / C++ Language » Command line processing     Intermediate

Command line parser

By Pavel Antonov

An intuitive and extensible command line parser class that handles multiple command line formats
VC6, VC7, C++Windows, Win2K, WinXP, MFC, STL, VS6, Visual Studio, Dev

Posted: 17 Aug 2002
Updated: 17 Aug 2002
Views: 108,236
Bookmarked: 62 times
Announcements
Loading...



Search    
Advanced Search
Sitemap
44 votes for this Article.
Popularity: 7.65 Rating: 4.65 out of 5
2 votes, 6.1%
1
1 vote, 3.0%
2
0 votes, 0.0%
3
4 votes, 12.1%
4
26 votes, 78.8%
5

Introduction

Getting list of arguments from command line is a common task which is required by a lot of applications. However, there is no standard solution (as far as I know ;). So I wrote class CCmdLineParser, which can parse arguments from command line, if they are typed in folowing form: 

  • /Key 
  • /KeyWithValue:Value 
  • /KeyWithComplexValue:"Some really complex value of /KeyWithComplexValue"

Of course, multiple keys, Unicode and long (up to 32Kb) command lines are supported.

This implementation requires the MFC or ATL CString class, or some clone with similar interface as well as the STL class map.

Usage

First, you should construct the object and call the Parse function (from constructor or
CCmdLineParser parser(::GetCommandLine());
or
CCmdLineParser parser;
parser.Parse(_T("/Key /Key2:Val /Key3:\"Complex-Value\" -Key4"));

Then, there are two ways of working with results. You can check if some particular key was specified in the command line:

if(parser.HasKey(_T("Key")) {
	// Do some stuff

}
if(parser.HasKey(_T("Key2")) {
	LPCTSTR szKey2Value = parser.GetVal(_T("Key2"));
	// Do something with value of Key2

}

LPCTSTR szKey3Value = parser.GetVal(_T("Key3"));
if(szKey3Value) {
	// There was key "Key3" in input,  

} else {
	// No key "Key3" in input

}

LPCTSTR szKey4Value = parser.GetVal(_T("Key4"));
// Key4 was found in input, but since no value was specified, 

// szKey4Value points to empty string

Another way to use is to enumerate all keys in command line:

CString sKey, sValue;

CCmdLineParser::POSITION pos = parser.getFirst();
while(!realParser.isLast(pos)) {
	realParser.getNext(pos, sKey, sValue);
	// Do something with current key and value

}

Customization and "how it works"

Repeated keys

If several different values are specified with same key, only the first value is stored. So, if user passes command line /Add:One /Add:Two, /Add:Two will be ignored and will not be added to parsed list.

Case sensitive/insensitive

By default, keys are not case-sensitive. So, /KeyOne is equal to -keyONE. This is done by converting all keys to lowercase before storing them. If you want to change this behaviour, call setCaseSensitive(true) or call the constructor with the second argument set to true:
CCmdLineParser parser(::GetCommandLine(), true);
This will switch the parser to case-sensitive mode, and if the user passes -key, then GetKey(_T("Key")) will return false

Syntax

Formally, command line should be in following form:
CommandLine::=[<Key> [,<Key>...]]
<Key>::=<Delimeter>KeyName[<Separator><Value>]
<Value> ::= { KeyValue | <QuoteChar>Quoted Key Value<QuoteChar>} ][
<Delimeter>::= { - | / }
<Separator>::= { : }
<QuoteChar>::= { " }

Values for <Delimeter>, <Separator> and <QuoteChar> are stored in static variables m_sDelimeters, m_sValueSep and m_sQuotes respectively. If you want to change them (for instance, allow user to specify quoted values in apostrophes), you can do it in the beginning of CmdLineParser.cpp:

const TCHAR CCmdLineParser::m_sQuotes[] = _T("\"\'");
Note: If you want to change m_sDelimeters, space must be the first character of this string. Also, if you have your own CString class with other name than CString, you can change it in the beginning of CmdLineParser.h:
typedef MyOwnCString CCmdLineParser_String;
That's it! ;)

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Pavel Antonov



Occupation: Web Developer
Location: Russian Federation Russian Federation

Other popular C / C++ Language articles:

Article Top
Sign Up to vote for this article
You must Sign In to use this message board.
FAQ FAQ Noise ToleranceSearch Search Messages 
 Layout  Per page   
 Msgs 1 to 25 of 31 (Total in Forum: 31) (Refresh)FirstPrevNext
QuestionGood!But a question.membersuxiaojack2:28 26 Apr '08  
GeneralBug report and my implementation of CCmdLineParser::CCmdLineParser() [modified]memberdoroboy22:11 27 Nov '07  
GeneralRe: Bug report and my implementation of CCmdLineParser::CCmdLineParser()memberdoroboy14:56 13 Dec '07  
GeneralThank you, I'm just looking for thismemberPeter Liu4:46 26 Aug '07  
GeneralExcellentmemberkpinkert10:06 19 Aug '05  
GeneralSupporting - - parameters and map.memberdB.7:52 29 Jun '05  
GeneralRe: Supporting - - parameters and map.memberdB.12:05 19 Dec '05  
GeneralToo much blah....memberdouglash17:29 28 Oct '04  
GeneralRe: Too much blah....memberJohn M. Drescher7:53 28 Oct '04  
GeneralRe: Too much blah....supporterpeterchen2:28 1 Nov '04  
GeneralRe: Too much blah....memberTim Stubbs6:11 28 Nov '08  
GeneralAnother suggestionmemberJim Crafton4:46 3 Oct '04  
GeneralRe: Another suggestionmemberahz3:33 14 Dec '05  
GeneralThanksmemberRutger Ellen5:50 23 Jul '04  
GeneralLicense issue...memberR. Douglas Barbieri9:48 14 Apr '04  
GeneralLicense: FreewarememberPavel Antonov21:25 14 Apr '04  
GeneralNot a standardsusscodep@michaelleesimons.com10:35 13 Jan '04  
GeneralRe: Not a standardmemberStewart Heitmann19:41 19 Jan '04  
GeneralAt last !!!memberSerge Wautier3:34 11 Dec '03  
Generalspaces in command line parametersmemberJogi012:17 17 Nov '03  
GeneralRe: spaces in command line parametersmemberPavel Antonov2:55 17 Nov '03  
GeneralRe: spaces in command line parametersmemberJogi011:59 19 Nov '03  
GeneralCommand Line redirectionmemberTom White7:02 5 Nov '03  
GeneralRe: Command Line redirectionsussdeiceone10:42 5 Nov '03  
GeneralRe: Command Line redirectionmemberTom White10:53 5 Nov '03  

General General    News News    Question Question    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

PermaLink | Privacy | Terms of Use
Last Updated: 17 Aug 2002
Editor: Chris Maunder
Copyright 2002 by Pavel Antonov
Everything else Copyright © CodeProject, 1999-2008
Web20 | Advertise on the Code Project