如何寫好 C main 函數

時間 2019-11-30

標籤如何寫好 main 函數欄目 C&C++ 简体版

原文原文鏈接

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

我知道，如今孩子們用 Python 和 JavaScript 編寫他們的瘋狂「應用程序」。可是不要這麼快就否認 C 語言 —— 它可以提供不少東西，而且簡潔。若是你須要速度，用 C 語言編寫可能就是你的答案。若是你正在尋找穩定的職業或者想學習如何捕獲空指針解引用，C 語言也多是你的答案！在本文中，我將解釋如何構造一個 C 文件並編寫一個 C main 函數來成功地處理命令行參數。linux

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

你：一個有編輯器、C 編譯器，並有時間打發的人。程序員

讓咱們開工吧。github

一個無聊但正確的 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
$
複製代碼

正確但無聊。bash

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 的那部分。若是你必須把版權或許可文本放在源代碼中，那就放在那裏。

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

「評論謊話。」
- 一個憤世嫉俗但聰明又好看的程序員。
複製代碼

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

鑑於程序員固有的惰性，一旦添加了註釋，維護負擔就會增長一倍。若是更改或重構代碼，則須要更新或擴充註釋。隨着時間的推移，代碼會變得面目全非，與註釋所描述的內容徹底不一樣。

若是你必須寫註釋，不要寫關於代碼正在作什麼，相反，寫下代碼爲何要這樣寫。寫一些你將要在五年後讀到的註釋，那時你已經將這段代碼忘得一乾二淨。世界的命運取決於你。不要有壓力。

一、包含

我添加到 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_SUCCESS`
libgen	提供 `basename()` 函數
errno	定義外部 `errno` 變量及其能夠接受的全部值
string	提供 `memcpy()`、`memset()` 和 `strlen()` 函數系列
getopt	提供外部 `optarg`、`opterr`、`optind` 和 `getopt()` 函數
sys/types	類型定義快捷方式，如 `uint32_t` 和 `uint64_t`

二、定義

/* 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 時所有使用大寫字母，以區別變量和函數名。若是須要，能夠將單詞放連在一塊兒或使用下劃線分隔，只要確保它們都是大寫的就行。

三、外部聲明

/* main.c */
<...>

extern int errno;
extern char *optarg;
extern int opterr, optind;
複製代碼

extern 聲明將該名稱帶入當前編譯單元的命名空間（即「文件」），並容許程序訪問該變量。這裏咱們引入了三個整數變量和一個字符指針的定義。opt 前綴的幾個變量是由 getopt() 函數使用的，C 標準庫使用 errno 做爲帶外通訊通道來傳達函數可能的失敗緣由。

四、類型定義

/* main.c */
<...>

typedef struct {
  int           verbose;
  uint32_t      flags;
  FILE         *input;
  FILE         *output;
} options_t;
複製代碼

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

五、全局變量聲明

/* main.c */
<...>

int dumb_global_variable = -11;
複製代碼

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

六、函數原型

/* main.c */
<...>

void usage(char *progname, int opt);
int do_the_needful(options_t *options);
複製代碼

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

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

七、命令行解析

/* 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 發出這樣的內容。

八、函數聲明

/* 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;
}
複製代碼