學習如何構造一個 C 檔案并撰寫一個 C main 函式來成功地處理命令列引數，
我知道，現在孩子們用 Python 和 JavaScript 撰寫他們的瘋狂“應用程式”，但是不要這么快就否定 C 語言 —— 它能夠提供很多東西，并且簡潔，
如果你需要速度，用 C 語言撰寫可能就是你的答案，如果你正在尋找穩定的職業或者想學習如何捕獲空指標解參考，C 語言也可能是你的答案！在本文中，我將解釋如何構造一個 C 檔案并撰寫一個 C main 函式來成功地處理命令列引數，
我：一個頑固的 sd程式員，
你：一個有編輯器、C 編譯器，并有時間打發的人，
讓我們開工吧，
一個無聊但正確的 C 程式
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（負一），
引數向量 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>
這是我默認會全域包含的最小包含集合，它將引入：
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;
}
函式幾乎總是以某種方式驗證它們的輸入，如果完全驗證代價很大，那么嘗試執行一次并將驗證后的資料視為不可變，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 語言了嗎，
如果你想學習編程，小編推薦我的C語言/C++編程學習基地【點擊進入】！
都是學編程小伙伴們，帶你入個門還是簡簡單單啦，一起學習，一起加油~
還有許多學習資料和視頻，相信你會喜歡的！
涉及：游戲開發、常用軟體開發、編程基礎知識、課程設計、黑客等等......
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/16153.html
標籤：C
上一篇：學習第23天