linux 中解析命令列引數 (getopt_long用法)

forthforward發表於2017-08-29

getopt_long支援長選項的命令列解析,使用man getopt_long,得到其宣告如下:

#include <getopt.h>

       int getopt_long(int argc, char * const argv[],
                  const char *optstring,
                  const struct option *longopts, int *longindex);

       int getopt_long_only(int argc, char * const argv[],
                  const char *optstring,
                  const struct option *longopts, int *longindex);

說明:函式中的argc和argv通常直接從main()到兩個引數傳遞而來。optsting是選項引數組成的字串,如

果該字串裡任一字母后有冒號,那麼這個選項就要求有引數。下一個引數是指向陣列的指標,這個陣列是

option結構陣列,option結構稱為長選項表,其宣告如下:

struct option {
const char *name;
int has_arg;
int *flag;
int val;
};

結構中的元素解釋如下:
const char *name:選項名,前面沒有短橫線。譬如”help”、”verbose”之類。
int has_arg:描述長選項是否有選項引數,如果有,是哪種型別的引數,其值見下表:
符號常量 數值 含義
no_argument 0 選項沒有引數
required_argument 1 選項需要引數
optional_argument 2 選項引數是可選的
int *flag:
如果該指標為NULL,那麼getopt_long返回val欄位的值;
如果該指標不為NULL,那麼會使得它所指向的結構填入val欄位的值,同時getopt_long返回0
int val:
如果flag是NULL,那麼val通常是個字元常量,如果短選項和長選項一致,那麼該字元就應該與optstring中

出現的這個選項的引數相同;

最後一個引數:longindex引數一般賦為NULL即可;如果沒有設定為NULL,那麼它就指向一個變數,這個變數

會被賦值為尋找到的長選項在longopts中的索引值,這可以用於錯誤診斷。

注:GNU提供的getopt-long()和getopt-long-only()函式,其中,後者的長選項字串是以一個短橫線開始的

,而非一對短橫線。

Linux 命令列約定:
幾乎所有的GNU/linux程式都遵循一些命令列引數定義的約定。程式希望出現的引數可以分成兩種:選

項(options or flags)、其他型別的的引數。Options修飾了程式執行的方式,其他型別的引數則提供了輸

入(例如,輸入檔案的名稱)。

 對於options型別引數可以有兩種方式:
 1)短選項(short options):顧名思義,就是短小引數。它們通常包含一個連字號和一個字母(大寫
   或小寫字母)。例如:-s,-h等。
 2)長選項(long options):長選項,包含了兩個連字號和一些大小寫字母組成的單詞。例如,--
size,--help等。
 *注:一個程式通常會提供包括short options和long options兩種引數形式的引數。

 對於其他型別引數的說明:
 這種型別的引數,通常跟隨在options型別引數之後。例如,ls –s /功能為顯示root目錄的大小。’/
’這個引數告訴ls要顯示目錄的路徑。

getopt_long()函式使用規則:

(1)使用前準備兩種資料結構
字元指標型變數
該資料結構包括了所有要定義的短選項,每一個選項都只用單個字母表示。如果該選項需要引數(如,

需要檔案路徑等),則其後跟一個冒號。例如,三個短選項分別為‘-h’‘-o’‘-v’,其中-o需要引數,

其他兩個不需要引數。那麼,我們可以將資料結構定義成如下形式:
const char * const shor_options = “ho:v” ;

struct option 型別陣列
該資料結構中的每個元素對應了一個長選項,並且每個元素是由四個域組成。通常情況下,可以按以下

規則使用。第一個元素,描述長選項的名稱;第二個選項,代表該選項是否需要跟著引數,需要引數則為1,

反之為0;第三個選項,可以賦為NULL;第四個選項,是該長選項對應的短選項名稱。另外,資料結構的最後

一個元素,要求所有域的內容均為0,即{NULL,0,NULL,0}。下面舉例說明,還是按照短選項為‘-h’‘-o’

‘-v’的例子,該資料結構可以定義成如下形式:
const struct option long_options = {
{ “help”, 0, NULL, ‘h’ },
{ “output”, 1, NULL, ‘o’ },
{ “verbose”, 0, NULL, ‘v’ },
{ NULL, 0, NULL, 0 }
};

(2)呼叫方法
參照(1)準備的兩個資料結構,則呼叫方式可為:
getopt_long( argc, argv, short_options, long_options, NULL);

(3)幾種常見返回值
(a)每次呼叫該函式,它都會分析一個選項,並且返回它的短選項,如果分析完畢,即已經沒有選項了,

則會返回-1。
(b)如果getopt_long()在分析選項時,遇到一個沒有定義過的選項,則返回值為‘?’,此時,程式設計師可

以列印出所定義命令列的使用資訊給使用者。
(c)當處理一個帶引數的選項時,全域性變數optarg會指向它的引數
(d)當函式分析完所有引數時,全域性變數optind(into argv)會指向第一個‘非選項’的位置

實踐小例子:

[c-sharp] view plain copy 
#include <stdio.h>  
#include <getopt.h>  
char *l_opt_arg;  
char* const short_options = "nbl:";  
struct option long_options[] = {  
     { "name",     0,   NULL,    'n'     },  
     { "bf_name",  0,   NULL,    'b'     },  
     { "love",     1,   NULL,    'l'     },  
     {      0,     0,     0,     0},  
};  
int main(int argc, char *argv[])  
{  
     int c;  
     while((c = getopt_long (argc, argv, short_options, long_options, NULL)) != -1)  
     {  
         switch (c)  
         {  
         case 'n':  
             printf("My name is XL./n");  
             break;  
         case 'b':  
             printf("His name is ST./n");  
             break;  
         case 'l':  
             l_opt_arg = optarg;  
             printf("Our love is %s!/n", l_opt_arg);  
             break;  
         }  
     }  
     return 0;  
}  

編譯並執行:

[root@localhost liuxltest]# gcc -o getopt getopt.c

[root@localhost liuxltest]# ./getopt -n -b -l forever
My name is XL.
His name is ST.
Our love is forever!
[root@localhost liuxltest]#

[root@localhost liuxltest]# ./getopt -nb -l forever
My name is XL.
His name is ST.
Our love is forever!
[root@localhost liuxltest]# ./getopt -nbl forever
My name is XL.
His name is ST.
Our love is forever!

————————————————————————》
getopt_long, getopt_long_only – 命令列解析函式,支援長選項解析

【說明】getopt_long/getopt_long_only是getopt的泛集,getopt是getopt_long的一個子集,getopt支援的所有特性,getopt_long都支援,包括錯誤列印、argv元素順序調整等;getopt_long相比getopt增加了長選項的解析,具體如下:

1、形如:cmd [–create][–file] //對長選項的解析;

2、形如:cmd [–create a_argument][-file b_argument] //對長選項及長選項的引數解析;

3、形如:cmd [–create [a_argument]] //選項create的引數也是可選的情況解析

getopt_long_only與getopt_long的區別在於:getopt_long僅僅只能將”–”開始的選項視為長選項,但getopt_long_only將”-“開頭選項也會視為長選項,當長選項列表均不滿足時,且短選項滿足時,”-“才會解析為短選項;

原型:

#define _GNU_SOURCE

#include <getopt.h>



extern char *optarg;

extern int optind, opterr, optopt;



int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex);

int getopt_long_only(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex);
1、注意相比getopt,使用getopt_long需要加標頭檔案<getopt.h>;

2、getopt_long除了會接受長選項,其他概念和getopt是一樣的;

3、如果使用getopt_long想只接受短選項,設定longopts為NULL即可;如果只想接受長選項,相應地設定optstring為NULL即可;

4、長選項名是可以使用縮寫方式,比如:選項有--file\--create,那麼輸入--c/--cr/--cre等均會被正確識別為create選項;

5、對於帶引數的長選項格式是:--arg=param或--arg param;

6、longopts是指向struct option陣列的第一個元素的指標,struct option定義在<getopt.h>中;

7、longindex如果非NULL,則是返回識別到struct option陣列中元素的位置指標;

struct option的說明:
/*
name: 長選項名

has_arg: 是否帶引數或可選引數,這個值在getopt.h中有巨集定義,如下:

 # define no_argument        0

 # define required_argument  1

 # define optional_argument  2

flag: 確定函式返回值的情況,如果flag==NULL,則識別選項後返回val(常用的如:設定val為長命令的短命令字元);否則,識別後getopt_long返回0,flag指向一個設定到val的變數;

val: 設定為返回值,或者是flag指向的變數;這裡要注意不要寫-1到val,否則其作用是getopt_long返回-1,然後停止解析選項;

[注意] longopts的最後一個元素必須是全0填充,否則會報段錯誤

*/

struct option {

    const char *name; 

    int has_arg;  

    int *flag;

    int val;

};
返回值:

1、如果識別短選項,同getopt一樣返回短選項字元;

2、如果識別長選項,根據flag的設定返回不同的內容,一般flag都設定為NULL,返回val;

3、如果發生錯誤,如:未識別選項或者必須加引數的選項丟失引數,返回'?',如果在optstring中設定了第一個字元為':',丟失引數返回':',這個同getopt返回時一樣的;

4、當縮寫長選項引起歧義時或者不需要的選項強加了引數,都會返回'?';

5、返回-1表示選項處理全部結束;

6、如果在輸入的argv[]中包含了獨立的"--"字串,同getopt一樣,解析到這裡返回-1,停止選項的解析;





測試例項:

#include <stdio.h>

#include <stdlib.h>

#include <getopt.h>



int main(int argc, char **argv)

{

        extern char *optarg;

        extern int optind, opterr, optopt;



        int c;

        int digit_optind = 0;



        while (1)

        {

                int this_option_optind= optind ? optind : 1;

                int option_index = 0;

                static struct option long_options[] =

                {

                        {"add", required_argument, NULL, 0},

                        {"append", no_argument, NULL, 0},

                        {"delete", required_argument, NULL, 0},

                        {"verbose", no_argument, NULL, 0},

                        {"create", required_argument, NULL, 'c'},

                        {"file", required_argument, NULL, 0},

                        {0, 0, 0, 0},

                };



                c = getopt_long(argc, argv, ":abc:d:012", long_options, &option_index);

                if (c == -1)

                        break;



                switch (c)

                {

                        case 0:

                                printf ("option %s", long_options[option_index].name);

                                if (optarg)

                                        printf (" with arg %s", optarg);

                                printf ("\n");

                                break;

                        case '0':

                        case '1':

                        case '2':

                                if (digit_optind != 0 && digit_optind != this_option_optind)

                                        printf ("digits occur in two different argv-elements.\n");

                                digit_optind = this_option_optind;

                                printf ("option %c\n", c);

                                break;

                        case 'a':

                                printf ("option a\n");

                                break;

                        case 'b':

                                printf ("option b\n");

                                break;

                        case 'c':

                                printf ("option c with value \"%s\"\n", optarg);

                                break;

                        case 'd':

                                printf ("option d with value \"%s\"\n", optarg);

                                break;

                        case '?':

                                break;

                        default:

                                printf ("?? getopt returned character code 0%o ??\n", c);

                }

        }



        if (optind < argc) {

                 printf ("non-option ARGV-elements: ");

                 while (optind < argc)

                          printf ("%s ", argv[optind++]);

                 printf ("\n");

         }



        exit(0);

}

相關文章