GOptionEntry

每當我們執行一個命令時後面可能需要一些參數,舉例來說,在terminal中輸入ls -l main.c . GOptionEntry就是GLib提供一個方便我們設定這些參數的結構
typedef struct {
const gchar *long_name; //就是一個參數的完整的名字比如ls -all
gchar short_name; //一個可列印的ASICC字元(character),也就是long_name的簡寫,ls -all 可以寫成ls -a
gintflags; //來自GOptionFlags
GOptionArg arg; // 這個參數的類型,來自GOptionArg, 如G_OPTION_ARG_STRING
gpointer arg_data; //如果arg的類型是G_OPTION_ARG_ARG_CALLBACK, arg_data指向一個GOptionArgFunc類型的callback function,否則,它指向存儲數據的位置,arg_data的具體類型依賴arg的類型
const gchar *description;//該參數在幫助中輸出的信息 -a --all don't ignore entries staring with .
const gchar *arg_description;//選項後面的緊接著的參數說明
} GOptionEntry;
使用,例如我們安裝兩個參數時可以申明一個結構數組
gchar* pointer = NULL;
const GOptionEntry options[] ={
{"-all", 'a', 0, G_OPTION_ARG_STRING, &pointer, "don't ignore staring with .", NULL},
{.........},
{NULL}
};
解析程式後面所跟隨的command line參數,過程中會使用到一開始宣告的幾個自訂變數:options[0]、options[1] (型別為GOptionEntry)、opt_ctx (型別為GOptionContext)。GOptionContext主要用來設定該如何解析所代入的command line參數,值得注意的是GOptionContext並不允許開發者對其內容做直接存取的動作,也就是無法寫成像是opt_ctx->xxx = ooo;,取而代之,開發者得使用GLib所提供的函式對此變數的內容做設定。
n g_option_context_new() ─ 建立新的GOptionContext
n g_option_context_set_translation_domain() ─ 設定以UTF -8碼做為解讀參數依據
n g_option_context_set_ignore_unknown_options() ─ 設定當遇到無法辨識的參數內容時是忽略還是標示成錯誤 (TRUE:忽略, FALSE:錯誤)
n g_option_context_set_help_enabled() ─ 設定是否支援--help此一參數 (TRUE:支援, FALSE:不支援)
n g_option_context_add_main_entries() ─ 匯入所有支援的command line參數資訊
n g_option_context_set_summary() ─ 當有支援--help選項時,呼叫此函式所寫入的summary內容將會顯示在help里
n g_option_context_parse() ─ 解析所帶入的command line參數。當使用者輸入--help且--help有被支援時,此函式會根據上述的設定自動產生help檔案。請注意,此函式執行完畢後會修改 argv的內容 (刪除--和-),另外當呼叫g_option_context_parse()解析command line參數的時候,此函式會根據GOptionEntry中的arg決定arg_data該輸入何值。以本程式為例,G_OPTION_ARG_NONE會讓後面的變數(become_daemon)內容設成TRUE;而G_OPTION_ARG_FILENAME 則會將使用者所輸入的字串存入後面的變數(user_pidfile)
n g_option_context_free() ─ 釋放使用完畢的GOptionContext
一個具體的函式例子流程:
gpointer iter; //具體的類型自己決定
GOptionEntry options[] = {
{......},
{......},
{NULL}
};
GError* error = NULL;
GOptionContext * opt_ctx = g_option_context_new(...);
g_option_context_add_main_entries(opt_ctx, options, NULL);
g_option_context_parse(....);
g_option_context_free();

相關詞條

熱門詞條

聯絡我們