學習如何構造一個 C 文件并編寫一個 C main 函數來成功地處理命令行參數。

-- Erik O'shaughnessy（作者）

我知道，現在孩子們用 Python 和 JAVAScript 編寫他們的瘋狂“應用程序”。但是不要這么快就否定 C 語言 —— 它能夠提供很多東西，并且簡潔。如果你需要速度，用 C 語言編寫可能就是你的答案。如果你正在尋找穩定的職業或者想學習如何捕獲 空指針解引用 ，C 語言也可能是你的答案！在本文中，我將解釋如何構造一個 C 文件并編寫一個 C main 函數來成功地處理命令行參數。

我：一個頑固的 Unix 系統程序員。

你：一個有編輯器、C 編譯器，并有時間打發的人。

讓我們開工吧。

一個無聊但正確的 C 程序

Parody O'Reilly book cover, "Hating Other People's Code"

C 程序以 main() 函數開頭，通常保存在名為 main.c 的文件中。

/* main.c */
int main(int argc, char *argv[]) {
}

這個程序可以編譯但不干任何事。

$ gcc main.c
$ ./a.out -o foo -vv
$

正確但無聊。

main 函數是唯一的。

main() 函數是開始執行時所執行的程序的第一個函數，但不是第一個執行的函數。第一個函數是 _start()，它通常由 C 運行庫提供，在編譯程序時自動鏈入。此細節高度依賴于操作系統和編譯器工具鏈，所以我假裝沒有提到它。

main() 函數有兩個參數，通常稱為 argc 和 argv，并返回一個有符號整數。大多數 Unix 環境都希望程序在成功時返回 0（零），失敗時返回 -1（負一）。

參數名稱描述argc參數個數參數向量的個數argv參數向量字符指針數組

參數向量 argv 是調用你的程序的命令行的標記化表示形式。在上面的例子中，argv 將是以下字符串的列表：

argv = [ "/path/to/a.out", "-o", "foo", "-vv" ];

參數向量在其第一個索引 argv[0] 中確保至少會有一個字符串，這是執行程序的完整路徑。

main.c 文件的剖析

當我從頭開始編寫 main.c 時，它的結構通常如下：

/* main.c */
/* 0 版權/許可證 */
/* 1 包含 */
/* 2 定義 */
/* 3 外部聲明 */
/* 4 類型定義 */
/* 5 全局變量聲明 */
/* 6 函數原型 */
int main(int argc, char *argv[]) {
/* 7 命令行解析 */
}
/* 8 函數聲明 */

下面我將討論這些編號的各個部分，除了編號為 0 的那部分。如果你必須把版權或許可文本放在源代碼中，那就放在那里。

另一件我不想討論的事情是注釋。

“評論謊言。”
- 一個憤世嫉俗但聰明又好看的程序員。

與其使用注釋，不如使用有意義的函數名和變量名。

鑒于程序員固有的惰性，一旦添加了注釋，維護負擔就會增加一倍。如果更改或重構代碼，則需要更新或擴充注釋。隨著時間的推移，代碼會變得面目全非，與注釋所描述的內容完全不同。

如果你必須寫注釋，不要寫關于代碼正在做什么，相反，寫下代碼為什么要這樣寫。寫一些你將要在五年后讀到的注釋，那時你已經將這段代碼忘得一干二凈。世界的命運取決于你。不要有壓力。

1、包含

我添加到 main.c 文件的第一個東西是包含文件，它們為程序提供大量標準 C 標準庫函數和變量。C 標準庫做了很多事情。瀏覽 /usr/include 中的頭文件，你可以了解到它們可以做些什么。

#include 字符串是 C 預處理程序 （cpp）指令，它會將引用的文件完整地包含在當前文件中。C 中的頭文件通常以 .h 擴展名命名，且不應包含任何可執行代碼。它只有宏、定義、類型定義、外部變量和函數原型。字符串 <header.h> 告訴 cpp 在系統定義的頭文件路徑中查找名為 header.h 的文件，它通常在 /usr/include 目錄中。

/* main.c */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <libgen.h>
#include <errno.h>
#include <string.h>
#include <getopt.h>
#include <sys/types.h>

這是我默認會全局包含的最小包含集合，它將引入：

#include 文件提供的東西stdio提供 FILE、stdin、stdout、stderr 和 fprint() 函數系列stdlib提供 malloc()、calloc() 和 realloc()unistd提供 EXIT_FAILURE、EXIT_SUCCESSlibgen提供 basename() 函數errno定義外部 errno 變量及其可以接受的所有值string提供 memcpy()、memset() 和 strlen() 函數系列getopt提供外部 optarg、opterr、optind 和 getopt() 函數sys/types類型定義快捷方式，如 uint32_t 和 uint64_t

2、定義

/* main.c */
<...>
#define OPTSTR "vi:o:f:h"
#define USAGE_FMT "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"
#define ERR_FOPEN_INPUT "fopen(input, r)"
#define ERR_FOPEN_OUTPUT "fopen(output, w)"
#define ERR_DO_THE_NEEDFUL "do_the_needful blew up"
#define DEFAULT_PROGNAME "george"

這在現在沒有多大意義，但 OPTSTR 定義我這里會說明一下，它是程序推薦的命令行開關。參考 getopt(3) man 頁面，了解 OPTSTR 將如何影響 getopt() 的行為。

USAGE_FMT 定義了一個 printf() 風格的格式字符串，它用在 usage() 函數中。

我還喜歡將字符串常量放在文件的 #define 這一部分。如果需要，把它們收集在一起可以更容易地修正拼寫、重用消息和國際化消息。

最后，在命名 #define 時全部使用大寫字母，以區別變量和函數名。如果需要，可以將單詞放連在一起或使用下劃線分隔，只要確保它們都是大寫的就行。

3、外部聲明

/* main.c */
<...>
extern int errno;
extern char *optarg;
extern int opterr, optind;

extern 聲明將該名稱帶入當前編譯單元的命名空間（即 “文件”），并允許程序訪問該變量。這里我們引入了三個整數變量和一個字符指針的定義。opt 前綴的幾個變量是由 getopt() 函數使用的，C 標準庫使用 errno 作為帶外通信通道來傳達函數可能的失敗原因。

4、類型定義

/* main.c */
<...>
typedef struct {
 int verbose;
 uint32_t flags;
 FILE *input;
 FILE *output;
} options_t;

在外部聲明之后，我喜歡為結構、聯合和枚舉聲明 typedef。命名一個 typedef 是一種傳統習慣。我非常喜歡使用 _t 后綴來表示該名稱是一種類型。在這個例子中，我將 options_t 聲明為一個包含 4 個成員的 struct。C 是一種空格無關的編程語言，因此我使用空格將字段名排列在同一列中。我只是喜歡它看起來的樣子。對于指針聲明，我在名稱前面加上星號，以明確它是一個指針。

5、全局變量聲明

/* main.c */
<...>
int dumb_global_variable = -11;

全局變量是一個壞主意，你永遠不應該使用它們。但如果你必須使用全局變量，請在這里聲明，并確保給它們一個默認值。說真的，不要使用全局變量。

6、函數原型

/* main.c */
<...>
void usage(char *progname, int opt);
int do_the_needful(options_t *options);

在編寫函數時，將它們添加到 main() 函數之后而不是之前，在這里放函數原型。早期的 C 編譯器使用單遍策略，這意味著你在程序中使用的每個符號（變量或函數名稱）必須在使用之前聲明。現代編譯器幾乎都是多遍編譯器，它們在生成代碼之前構建一個完整的符號表，因此并不嚴格要求使用函數原型。但是，有時你無法選擇代碼要使用的編譯器，所以請編寫函數原型并繼續這樣做下去。

當然，我總是包含一個 usage() 函數，當 main() 函數不理解你從命令行傳入的內容時，它會調用這個函數。

7、命令行解析

/* main.c */
<...>
int main(int argc, char *argv[]) {
 int opt;
 options_t options = { 0, 0x0, stdin, stdout };
 opterr = 0;
 while ((opt = getopt(argc, argv, OPTSTR)) != EOF) 
 switch(opt) {
 case 'i':
 if (!(options.input = fopen(optarg, "r")) ){
 perror(ERR_FOPEN_INPUT);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 }
 break;
 case 'o':
 if (!(options.output = fopen(optarg, "w")) ){
 perror(ERR_FOPEN_OUTPUT);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 } 
 break;
 
 case 'f':
 options.flags = (uint32_t )strtoul(optarg, NULL, 16);
 break;
 case 'v':
 options.verbose += 1;
 break;
 case 'h':
 default:
 usage(basename(argv[0]), opt);
 /* NOTREACHED */
 break;
 }
 if (do_the_needful(&options) != EXIT_SUCCESS) {
 perror(ERR_DO_THE_NEEDFUL);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 }
 return EXIT_SUCCESS;
}

好吧，代碼有點多。這個 main() 函數的目的是收集用戶提供的參數，執行最基本的輸入驗證，然后將收集到的參數傳遞給使用它們的函數。這個示例聲明一個使用默認值初始化的 options 變量，并解析命令行，根據需要更新 options。

main() 函數的核心是一個 while 循環，它使用 getopt() 來遍歷 argv，尋找命令行選項及其參數（如果有的話）。文件前面定義的 OPTSTR 是驅動 getopt() 行為的模板。opt 變量接受 getopt() 找到的任何命令行選項的字符值，程序對檢測命令行選項的響應發生在 switch 語句中。

如果你注意到了可能會問，為什么 opt 被聲明為 32 位 int，但是預期是 8 位 char？事實上 getopt() 返回一個 int，當它到達 argv 末尾時取負值，我會使用 EOF（文件末尾標記）匹配。char 是有符號的，但我喜歡將變量匹配到它們的函數返回值。

當檢測到一個已知的命令行選項時，會發生特定的行為。在 OPTSTR 中指定一個以冒號結尾的參數，這些選項可以有一個參數。當一個選項有一個參數時，argv 中的下一個字符串可以通過外部定義的變量 optarg 提供給程序。我使用 optarg 來打開文件進行讀寫，或者將命令行參數從字符串轉換為整數值。

這里有幾個關于代碼風格的要點：

• 將 opterr 初始化為 0，禁止 getopt 觸發 ?。
• 在 main() 的中間使用 exit(EXIT_FAILURE); 或 exit(EXIT_SUCCESS);。
• /* NOTREACHED */ 是我喜歡的一個 lint 指令。
• 在返回 int 類型的函數末尾使用 return EXIT_SUCCESS;。
• 顯示強制轉換隱式類型。

這個程序的命令行格式，經過編譯如下所示：

$ ./a.out -h
a.out [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]

事實上，在編譯后 usage() 就會向 stderr 發出這樣的內容。

8、函數聲明

/* main.c */
<...>
void usage(char *progname, int opt) {
 fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
}
int do_the_needful(options_t *options) {
 if (!options) {
 errno = EINVAL;
 return EXIT_FAILURE;
 }
 if (!options->input || !options->output) {
 errno = ENOENT;
 return EXIT_FAILURE;
 }
 /* XXX do needful stuff */
 return EXIT_SUCCESS;
}

我最后編寫的函數不是個樣板函數。在本例中，函數 do_the_needful() 接受一個指向 options_t 結構的指針。我驗證 options 指針不為 NULL，然后繼續驗證 input 和 output 結構成員。如果其中一個測試失敗，返回 EXIT_FAILURE，并且通過將外部全局變量 errno 設置為常規錯誤代碼，我可以告知調用者常規的錯誤原因。調用者可以使用便捷函數 perror() 來根據 errno 的值發出便于閱讀的錯誤消息。

函數幾乎總是以某種方式驗證它們的輸入。如果完全驗證代價很大，那么嘗試執行一次并將驗證后的數據視為不可變。usage() 函數使用 fprintf() 調用中的條件賦值驗證 progname 參數。接下來 usage() 函數就退出了，所以我不會費心設置 errno，也不用操心是否使用正確的程序名。

在這里，我要避免的最大錯誤是解引用 NULL 指針。這將導致操作系統向我的進程發送一個名為 SYSSEGV 的特殊信號，導致不可避免的死亡。用戶最不希望看到的是由 SYSSEGV 而導致的崩潰。最好是捕獲 NULL 指針以發出更合適的錯誤消息并優雅地關閉程序。

有些人抱怨在函數體中有多個 return 語句，他們喋喋不休地說些“控制流的連續性”之類的東西。老實說，如果函數中間出現錯誤，那就應該返回這個錯誤條件。寫一大堆嵌套的 if 語句只有一個 return 絕不是一個“好主意”™。

最后，如果你編寫的函數接受四個以上的參數，請考慮將它們綁定到一個結構中，并傳遞一個指向該結構的指針。這使得函數簽名更簡單，更容易記住，并且在以后調用時不會出錯。它還可以使調用函數速度稍微快一些，因為需要復制到函數堆棧中的東西更少。在實踐中，只有在函數被調用數百萬或數十億次時，才會考慮這個問題。如果認為這沒有意義，那也無所謂。

等等，你不是說沒有注釋嗎！？??！

在 do_the_needful() 函數中，我寫了一種特殊類型的注釋，它被是作為占位符設計的，而不是為了說明代碼：

/* XXX do needful stuff */

當你寫到這里時，有時你不想停下來編寫一些特別復雜的代碼，你會之后再寫，而不是現在。那就是我留給自己再次回來的地方。我插入一個帶有 XXX 前綴的注釋和一個描述需要做什么的簡短注釋。之后，當我有更多時間的時候，我會在源代碼中尋找 XXX。使用什么前綴并不重要，只要確保它不太可能在另一個上下文環境（如函數名或變量）中出現在你代碼庫里。

把它們組合在一起

好吧，當你編譯這個程序后，它仍然幾乎沒有任何作用。但是現在你有了一個堅實的骨架來構建你自己的命令行解析 C 程序。

/* main.c - the complete listing */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <libgen.h>
#include <errno.h>
#include <string.h>
#include <getopt.h>
#define OPTSTR "vi:o:f:h"
#define USAGE_FMT "%s [-v] [-f hexflag] [-i inputfile] [-o outputfile] [-h]"
#define ERR_FOPEN_INPUT "fopen(input, r)"
#define ERR_FOPEN_OUTPUT "fopen(output, w)"
#define ERR_DO_THE_NEEDFUL "do_the_needful blew up"
#define DEFAULT_PROGNAME "george"
extern int errno;
extern char *optarg;
extern int opterr, optind;
typedef struct {
 int verbose;
 uint32_t flags;
 FILE *input;
 FILE *output;
} options_t;
int dumb_global_variable = -11;
void usage(char *progname, int opt);
int do_the_needful(options_t *options);
int main(int argc, char *argv[]) {
 int opt;
 options_t options = { 0, 0x0, stdin, stdout };
 opterr = 0;
 while ((opt = getopt(argc, argv, OPTSTR)) != EOF) 
 switch(opt) {
 case 'i':
 if (!(options.input = fopen(optarg, "r")) ){
 perror(ERR_FOPEN_INPUT);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 }
 break;
 case 'o':
 if (!(options.output = fopen(optarg, "w")) ){
 perror(ERR_FOPEN_OUTPUT);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 } 
 break;
 
 case 'f':
 options.flags = (uint32_t )strtoul(optarg, NULL, 16);
 break;
 case 'v':
 options.verbose += 1;
 break;
 case 'h':
 default:
 usage(basename(argv[0]), opt);
 /* NOTREACHED */
 break;
 }
 if (do_the_needful(&options) != EXIT_SUCCESS) {
 perror(ERR_DO_THE_NEEDFUL);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
 }
 return EXIT_SUCCESS;
}
void usage(char *progname, int opt) {
 fprintf(stderr, USAGE_FMT, progname?progname:DEFAULT_PROGNAME);
 exit(EXIT_FAILURE);
 /* NOTREACHED */
}
int do_the_needful(options_t *options) {
 if (!options) {
 errno = EINVAL;
 return EXIT_FAILURE;
 }
 if (!options->input || !options->output) {
 errno = ENOENT;
 return EXIT_FAILURE;
 }
 /* XXX do needful stuff */
 return EXIT_SUCCESS;
}

現在，你已經準備好編寫更易于維護的 C 語言。如果你有任何問題或反饋，請在評論中分享。

via: https://opensource.com/article/19/5/how-write-good-c-main-function

作者： Erik O'Shaughnessy 選題： lujun9972 譯者： MjSeven 校對： wxy

本文由 LCTT 原創編譯， linux中國 榮譽推出