在 C 語言中使用 getopt 解析命令行短選項

作者：Jim Hall 2023-03-02 19:36:34

通過使用命令行讓用戶告訴程序要什么，可以讓程序更加靈活。

在已經知道要處理什么文件和對文件進行哪些操作的情況下，編寫處理文件的 C 語言程序就很容易了。如果將文件名“硬編碼”在程序中，或者你的程序只以一種方式來處理文件，那么你的程序總是知道要做什么。

但是如果程序每次運行時能夠對用戶的輸入做出反應，可以使程序更靈活。讓用戶告訴程序要處理什么文件，或者以不同的方式完成任務，要實現這樣的功能就需要讀取命令行參數。

讀取命令行

一個 C 語言程序可以用如下聲明開頭：

int main()

這是啟動 C 程序最簡單的形式。但如果在圓括號中加入標準參數，你的程序就可以從命令行中讀取選項了：

int main(int argc, char **argv)

??argc?? 表示命令行中的參數個數。它總是一個至少為 1 的數。

??argv?? 是一個二級指針，它指向一個字符串數組。這個數組中保存的是從命令行接收的各個參數。數組的第一個元素 ??*argv[0]?? 是程序的名稱。??**argv?? 數組的其它元素包含剩下的命令行參數。

下面我將寫一個簡單的示例程序，它能夠回顯通過命令行參數傳遞給它的選項。它跟 Linux 的 ??echo?? 命令類似，只不過我們的程序會打印出程序名。同時它還會調用 ??puts?? 函數將命令行選項按行打印輸出。

#include <stdio.h>

int
main(int argc, char **argv)
{
  int i;

  printf("argc=%d\n", argc); /* debugging */

  for (i = 0; i < argc; i++) {
    puts(argv[i]);
  }

  return 0;
}

編譯此程序，并在運行時提供一些命令行參數，你會看到傳入的命令行參數被逐行打印出來：

$ ./echo this program can read the command line
argc=8
./echo
this
program
can
read
the
command
line

這個命令行將程序的 ??argc?? 置為 8，??**argv?? 數組包含 8 個元素：程序名以及用戶輸入的 7 個單詞。由于 C 語言中數組下標從 0 開始，所以這些元素的標號分別是 0 到 7。這也是在 ??for?? 循環中處理命令行參數時能夠用 ??i < argc?? 作為比較條件的原因。

你也可以用這個方式實現自己的 ??cat?? 或 ??cp?? 命令。??cat?? 命令的基本功能是顯示一個或幾個文件的內容。下面是一個簡化版的??cat?? 命令，它從命令行獲取文件名：

#include <stdio.h>

void
copyfile(FILE *in, FILE *out)
{
  int ch;

  while ((ch = fgetc(in)) != EOF) {
    fputc(ch, out);
  }
}

int
main(int argc, char **argv)
{
  int i;
  FILE *fileptr;

  for (i = 1; i < argc; i++) {
    fileptr = fopen(argv[i], "r");

    if (fileptr != NULL) {
      copyfile(fileptr, stdout);
      fclose(fileptr);
    }
  }

  return 0;
}

這個簡化版的 ??cat?? 命令從命令行讀取文件名列表，然后將各個文件的內容逐字符地顯示到標準輸出上。假定我有一個叫做 ??hello.txt?? 的文件，其中包含數行文本內容。我能用自己實現的 ??cat?? 命令將它的內容顯示出來：

$ ./cat hello.txt
Hi there!
This is a sample text file.

以這個簡單程序為出發點，你也可以實現自己版本的其它 Linux 命令。比如 ??cp?? 命令，它從命令行讀取兩個文件名：要讀取的文件和要寫入的文件。

讀取命令行選項

通過命令行讀取文件名和其它文本固然很棒，但是如果想要程序根據用戶給出的選項改變行為呢？比如 Linux 的 ??cat?? 命令就支持以下命令行選項：

??-b?? 顯示非空行的行號
??-E?? 在行尾顯示 ??$??
??-n?? 顯示行號
??-s?? 合并顯示空行
??-T?? 將制表符顯示為 ??^I??
??-v?? 用 ??^x?? 和 ??M-x?? 方式顯示非打印字符，換行符和制表符除外

這些以一個連字符開頭的單字母的選項叫做短選項。通常短選項是分開使用的，就像這樣 ??cat -E -n??。但是也可以將多個短選項合并，比如 ??cat -En??。

值得慶幸的是，所有 Linux 和 Unix 系統都包含 ??getopt?? 庫。它提供了一種簡單的方式來讀取命令行參數。??getopt?? 定義在頭文件 ??unistd.h?? 中。你可以在程序中使用 ??getopt?? 來讀取命令行短選項。

與其它 Unix 系統不同的是，Linux 上的 ??getopt?? 總是保證短選項出現在命令行參數的最前面。比如，用戶輸入的是 ??cat -E file -n??。??-E?? 在最前面，??-n?? 在文件名之后。如果使用 Linux 的 ??getopt?? 來處理，程序會認為用戶輸入的是 ??cat -E -n file??。這樣做可以使處理過程更順暢，因為 ??getopt?? 可以解析完所有短選項，剩下的文件名列表可以通過 ??**argv?? 來統一處理。

你可以這樣使用 ??getopt??:

#include <unistd.h>

int getopt(int argc, char **argv, char *optstring);

??optstring?? 是由所有合法的選項字符組成的字符串。比如你的程序允許的選項是 ??-E?? 和 ??-n??，那么 ??optstring?? 的值就是 ??"En"??。

通常通過在循環中調用 ??getopt?? 來解析命令行選項。每次調用時 ??getopt?? 會返回找到的下一個短選項，如果遇到無法識別的選項則返回 ??'?'??。當沒有更多短選項時它返回 ??-1??，并且設置全局變量 ??optind?? 的值指向 ??**argv?? 中所有段選項之后的第一個元素。

下面看一個簡單的例子。這個演示程序沒有實現 ??cat?? 命令的所有選項，但它只是能夠解析命令行。每當發現一個合法的命令行選項，它就打印出相應的提示消息。在你自己的程序中，你可能會根據這些命令行選項執行變量賦值等者其它操作。

#include <stdio.h>
#include <unistd.h>

int
main(int argc, char **argv)
{
  int i;
  int option;

  /* parse short options */

  while ((option = getopt(argc, argv, "bEnsTv")) != -1) {
    switch (option) {
    case 'b':
      puts("Put line numbers next to non-blank lines");
      break;
    case 'E':
      puts("Show the ends of lines as $");
      break;
    case 'n':
      puts("Put line numbers next to all lines");
      break;
    case 's':
      puts("Suppress printing repeated blank lines");
      break;
    case 'T':
      puts("Show tabs as ^I");
      break;
    case 'v':
      puts("Verbose");
      break;
    default:                          /* '?' */
      puts("What's that??");
    }
  }

  /* print the rest of the command line */

  puts("------------------------------");

  for (i = optind; i < argc; i++) {
    puts(argv[i]);
  }

  return 0;
}

假如你把程序編譯為 ??args??，你可以通過嘗試不同的命令行參數組合，來了解程序是怎么解析短選項，以及是怎么將其它的命令行參數留下來的。最簡單的例子是將所有的選項都放在最前面，就像這樣：

$ ./args -b -T file1 file2
Put line numbers next to non-blank lines
Show tabs as ^I
------------------------------
file1
file2

現在試試將兩個短選項合并使用的效果：

$ ./args -bT file1 file2
Put line numbers next to non-blank lines
Show tabs as ^I
------------------------------
file1
file2

如果有必要的話，??getopt??可以對命令行參數進行重排：

$ ./args -E file1 file2 -T
Show the ends of lines as $
Show tabs as ^I
------------------------------
file1
file2

如果用戶輸入了錯誤的短選項，??getopt?? 會打印一條消息：

$ ./args -s -an file1 file2
Suppress printing repeated blank lines
./args: invalid option -- 'a'
What's that??
Put line numbers next to all lines
------------------------------
file1
file2

下載速查表

??getopt?? 還有更多的功能。例如，通過設計 ??-s string?? 或 ??-f file?? 這樣的命令行語法規則，可以讓短選項擁有自己的二級選項。你也可以告訴 ??getopt?? 在遇到無法識別的選項時不顯示錯誤信息。使用 ??man 3 getopt?? 命令查看 ??getopt(3)?? 手冊可以了解 ??getopt?? 的更多功能。

如果你需要 ??getopt()?? 和 ??getopt_long()??的使用語法和結構上的提示，可以 ??下載我制作的速查表??。它提供了最小可行代碼，并列出了你需要了解的一些全局變量的含義。速查表的一面是 ??getopt()?? 的用法，另一面是 ??getopt_long()??的用法。

責任編輯：龐桂玉來源： Linux中國

C語言