介紹
命令行接口是普遍,基礎(chǔ)的人機(jī)交互接口,從命令行提取程序的運(yùn)行時(shí)選項(xiàng)的方法有很多。你可以自己編寫相對(duì)應(yīng)的完整的解析函數(shù),或許你有豐富的C語(yǔ)言編程經(jīng)驗(yàn),熟知getopt()函數(shù)的用法,又或許使用Python的你已經(jīng)在使用optparse庫(kù)來(lái)簡(jiǎn)化這一工作。大家在平時(shí)不斷地談及到“不要重復(fù)造輪子”,那就需要掌握一些順手的庫(kù),這里介紹一種C++方式來(lái)解析命令行選項(xiàng)的方法,就是使用Boost.Program_options庫(kù)。
program_options提供程序員一種方便的命令行和配置文件進(jìn)行程序選項(xiàng)設(shè)置的方法。使用program_options庫(kù)而不是你自己動(dòng)手寫相關(guān)的解析代碼,因?yàn)樗?jiǎn)單,聲明程序選項(xiàng)的語(yǔ)法簡(jiǎn)潔,并且?guī)熳陨硪卜浅P ⑦x項(xiàng)值轉(zhuǎn)換為適合的類型值的工作也都能自動(dòng)完成。庫(kù)有著完備的錯(cuò)誤檢查機(jī)制,如果自己手寫解析代碼時(shí),就可能會(huì)錯(cuò)過(guò)對(duì)一些出錯(cuò)情況的檢查了。最后,選項(xiàng)值不僅能從命令行獲取,也能從配置文件,甚至于環(huán)境變量中提取,而這些選擇不會(huì)增加明顯的工作量。
示例說(shuō)明
以下面簡(jiǎn)單的hello程序進(jìn)行說(shuō)明,默認(rèn)打印hello world,如果傳入-p選項(xiàng),就會(huì)打印出人的姓名,另外通過(guò)傳入-h選項(xiàng),可以打印出幫助選項(xiàng)。略微看一眼代碼文件和相應(yīng)的屏幕輸入輸出,然后我們?cè)僖黄饋?lái)看看這些是如何發(fā)生的。
//hello.cpp #include <iostream> #include <string> #include <boost/program_options.hpp> using namespace std; int main(int argc, char* argv[]) { using namespace boost::program_options; //聲明需要的選項(xiàng) options_description desc("Allowed options"); desc.add_options() ("help,h", "produce help message") ("person,p", value<string>()->default_value("world"), "who") ; variables_map vm; store(parse_command_line(argc, argv, desc), vm); notify(vm); if (vm.count("help")) { cout << desc; return 0; } cout << "Hello " << vm["person"].as<string>() << endl; return 0; }
下面是在Windows命令提示符窗口上的輸入輸出結(jié)果,其中">"表示提示符。
>hello Hello world >hello -h Allowed options: -h [ --help ] produce help message -p [ --person ] arg (=world) who >hello --person len Hello len
首先通過(guò)options_description類聲明了需要的選項(xiàng),add_options返回了定義了operator()的特殊的代理對(duì)象。這個(gè)調(diào)用看起來(lái)有點(diǎn)奇怪,其參數(shù)依次為選項(xiàng)名,選項(xiàng)值,以及選項(xiàng)的描述。注意到示例中的選項(xiàng)名為"help,h",是因?yàn)槁暶髁司哂卸踢x項(xiàng)名和長(zhǎng)選項(xiàng)名的選項(xiàng),這跟gnu程序的命令行具有一致性。當(dāng)然你可以省略短選項(xiàng)名,但是這樣就不能用命令選項(xiàng)簡(jiǎn)寫了。第二個(gè)選項(xiàng)的聲明,定義了選項(xiàng)值為string類型,其默認(rèn)值為world.
接下來(lái),聲明了variables_map類的對(duì)象,它主要用來(lái)存儲(chǔ)選項(xiàng)值,并且能儲(chǔ)存任意類型的值。然后,store,parse_command_line和notify函數(shù)使vm能存儲(chǔ)在命令行中發(fā)現(xiàn)的選項(xiàng)。
最后我們就自由地使用這些選項(xiàng)了,variables_map類的使用就像使用std::map一樣,除了它必須用as方法去獲取值。如果as方法調(diào)用的指定類型與實(shí)際存儲(chǔ)的類型不同,就會(huì)有異常拋出。
具有編程的你可能有這樣的經(jīng)驗(yàn),使用cl或gcc對(duì)源文件進(jìn)行編譯時(shí),可直接將源文件名放置在命令行中,而無(wú)需什么選項(xiàng)字母,如gcc a.c之類的。prgram_options也能處理這種情況,在庫(kù)中被稱為"positional options"(位置選項(xiàng)),但這需要程序員的一點(diǎn)兒幫助才能完成。看下面的經(jīng)過(guò)對(duì)應(yīng)修改的代碼,我們無(wú)需傳入"-p"選項(xiàng),就能可指定"person"選項(xiàng)值
positional_options_description p; p.add("person", -1); store(command_line_parser(argc, argv).options(desc).positional(p).run(), vm);
>hello len Hello len
前面新增的兩行是為了說(shuō)明所有的位置選項(xiàng)都應(yīng)被解釋成"person"選項(xiàng),這里還采用了command_line_parser類來(lái)解析命令行,而不是用parse_command_line函數(shù)。后者只是對(duì)前者類的簡(jiǎn)單封裝,但是現(xiàn)在我們需要傳入一些額外的信息,所以要使用類本身。
選項(xiàng)復(fù)合來(lái)源
一般來(lái)說(shuō),在命令行上指定所有選項(xiàng),對(duì)用戶來(lái)說(shuō)是非常煩人的。如果有些選項(xiàng)要應(yīng)用于每次運(yùn)行,那該怎么辦呢。我們當(dāng)然希望能創(chuàng)建出帶有些常用設(shè)置的選項(xiàng)文件,跟命令行一起應(yīng)用于程序中。當(dāng)然這一切需要將命令行與配置文件中的值結(jié)合起來(lái)。比如,在命令行中指定的某些選項(xiàng)值應(yīng)該能覆蓋配置文件中的對(duì)應(yīng)值,或者將這些值組合起來(lái)。
下面的代碼段將選項(xiàng)通過(guò)文件讀取,這文件是文本格式,可用"#"表示注釋,格式如命令行中的參數(shù)一樣,選項(xiàng)=值
ifstream ifs("config.cfg"); store(parse_config_file(ifs,config),vm); notify(vm);
參考