gflags是什么:
gflags是google的一個開源的處理命令行參數的庫,使用c++開發,具備python接口,可以替代getopt。
gflags使用起來比getopt方便,但是不支持參數的簡寫(例如getopt支持--list縮寫成-l,gflags不支持)。
如何安裝使用gflags:
安裝:請訪問地址
https://code.google.com/p/gflags/,下載最新版的gflags,編譯安裝。
使用:
1.首先需要include "gflags.h"
#include <gflags/gflags.h>
2.將需要的命令行參數使用gflags的宏:DEFINE_xxxxx(變量名,默認值,help-string) 定義在文件當中,注意全局域哦。gflags支持以下類型:
DEFINE_bool: boolean DEFINE_int32: 32-bit integer DEFINE_int64: 64-bit integer DEFINE_uint64: unsigned 64-bit integer DEFINE_double: double DEFINE_string: C++ string
3.在main函數中加入:
google::ParseCommandLineFlags(&argc, &argv, true);
argc和argv想必大家都很清楚了,說明以下第三個參數的作用:
如果設為true,則該函數處理完成后,argv中只保留argv[0],argc會被設置為1。
如果為false,則argv和argc會被保留,但是注意函數會調整argv中的順序。
4.這樣,在后續代碼中可以使用FLAGS_變量名訪問對應的命令行參數了
printf("%s", FLAGS_mystr);
5.最后,編譯成可執行文件之后,用戶可以使用:executable --參數1=值1 --參數2=值2 ... 來為這些命令行參數賦值。
./mycmd --var1="test" --var2=3.141592654 --var3=32767 --mybool1=true --mybool2 --nomybool3
這里值得注意的是bool類型命令行參數,除了可以使用--xxx=true/false之外,還可以使用--xxx和--noxxx后面不加等號的方式指定true和false
gflags進階使用:
1.在其他文件中使用定義的flags變量:有些時候需要在main之外的文件使用定義的flags變量,這時候可以使用宏定義DECLARE_xxx(變量名)聲明一下(就和c++中全局變量的使用是一樣的,extern一下一樣)
DECLARE_bool: boolean DECLARE_int32: 32-bit integer DECLARE_int64: 64-bit integer DECLARE_uint64: unsigned 64-bit integer DECLARE_double: double DECLARE_string: C++ string
在gflags的doc中,推薦在對應的.h文件中進行DECLARE_xxx聲明,需要使用的文件直接include就行了。
2.檢驗輸入參數是否合法:gflags庫支持定制自己的輸入參數檢查的函數,如下:
static bool ValidatePort(const char* flagname, int32 value) { if (value > 0 && value < 32768) // value is ok return true; printf("Invalid value for --%s: %d\n", flagname, (int)value); return false; } DEFINE_int32(port, 0, "What port to listen on"); static const bool port_dummy = RegisterFlagValidator(&FLAGS_port, &ValidatePort);
3.判斷flags變量是否被用戶使用:在gflags.h中,還定義了一些平常用不到的函數和結構體。這里舉一個例子,判斷參數port有沒有被用戶設定過
google::CommandLineFlagInfo info; if(GetCommandLineFlagInfo("port" ,&info) && info.is_default) { FLAGS_port = 27015; }
4.定制你自己的help信息與version信息:(gflags里面已經定義了-h和--version,你可以通過以下方式定制它們的內容)
version信息:使用google::SetVersionString設定,使用google::VersionString訪問
help信息:使用google::SetUsageMessage設定,使用google::ProgramUsage訪問
注意:google::SetUsageMessage和google::SetVersionString必須在google::ParseCommandLineFlags之前執行
參考:
- https://code.google.com/p/gflags/
- https://gflags.googlecode.com/git-history/master/doc/gflags.html#flagfiles