[[319060]]

我將在本系列的第二篇中深入研究由多個文件組成的 C 程序的結構。

在第一篇中，我設計了一個名為喵嗚喵嗚的多文件 C 程序，該程序?qū)崿F(xiàn)了一個玩具編解碼器。我也提到了程序設計中的 Unix 哲學，即在一開始創(chuàng)建多個空文件，并建立一個好的結構。最后，我創(chuàng)建了一個 Makefile 文件夾并闡述了它的作用。在本文中將另一個方向展開：現(xiàn)在我將介紹簡單但具有指導性的喵嗚喵嗚編解碼器的實現(xiàn)。

當讀過我的《如何寫一個好的 C 語言 main 函數(shù)》后，你會覺得喵嗚喵嗚編解碼器的 main.c 文件的結構很熟悉，其主體結構如下：

/* main.c - 喵嗚喵嗚流式編解碼器 */
 
/* 00 系統(tǒng)包含文件 */
/* 01 項目包含文件 */
/* 02 外部聲明 */
/* 03 定義 */
/* 04 類型定義 */
/* 05 全局變量聲明（不要用）*/
/* 06 附加的函數(shù)原型 */
   
int main(int argc, char *argv[])
{
  /* 07 變量聲明 */
  /* 08 檢查 argv[0] 以查看該程序是被如何調(diào)用的 */
  /* 09 處理來自用戶的命令行選項 */
  /* 10 做點有用的事情 */
}
   
/* 11 其它輔助函數(shù) */

包含項目頭文件

位于第二部分中的 /* 01 項目包含文件 */ 的源代碼如下：

/* main.c - 喵嗚喵嗚流式編解碼器 */
...
/* 01 項目包含文件 */
#include "main.h"
#include "mmecode.h"
#include "mmdecode.h"

#include 是 C 語言的預處理命令，它會將該文件名的文件內(nèi)容拷貝到當前文件中。如果程序員在頭文件名稱周圍使用雙引號（""），編譯器將會在當前目錄尋找該文件。如果文件被尖括號包圍（<>），編譯器將在一組預定義的目錄中查找該文件。

main.h 文件中包含了 main.c 文件中用到的定義和類型定義。我喜歡盡可能多將聲明放在頭文件里，以便我在我的程序的其他位置使用這些定義。

頭文件 mmencode.h 和 mmdecode.h 幾乎相同，因此我以 mmencode.h 為例來分析。

/* mmencode.h - 喵嗚喵嗚流編解碼器 */
  
#ifndef _MMENCODE_H
#define _MMENCODE_H
  
#include <stdio.h>
  
int mm_encode(FILE *src, FILE *dst);
  
#endif /* _MMENCODE_H */

#ifdef、#define、#endif 指令統(tǒng)稱為 “防護” 指令。其可以防止 C 編譯器在一個文件中多次包含同一文件。如果編譯器在一個文件中發(fā)現(xiàn)多個定義/原型/聲明，它將會產(chǎn)生警告。因此這些防護措施是必要的。

在這些防護內(nèi)部，只有兩個東西：#include 指令和函數(shù)原型聲明。我在這里包含了 stdio.h 頭文件，以便于能在函數(shù)原型中使用 FILE 定義。函數(shù)原型也可以被包含在其他 C 文件中，以便于在文件的命名空間中創(chuàng)建它。你可以將每個文件視為一個獨立的命名空間，其中的變量和函數(shù)不能被另一個文件中的函數(shù)或者變量使用。

編寫頭文件很復雜，并且在大型項目中很難管理它。不要忘記使用防護。

喵嗚喵嗚編碼的最終實現(xiàn)

該程序的功能是按照字節(jié)進行 MeowMeow 字符串的編解碼，事實上這是該項目中最簡單的部分。截止目前我所做的工作便是支持允許在適當?shù)奈恢谜{(diào)用此函數(shù)：解析命令行，確定要使用的操作，并打開將要操作的文件。下面的循環(huán)是編碼的過程：

/* mmencode.c - 喵嗚喵嗚流式編解碼器 */
...
   while (!feof(src)) {
 
     if (!fgets(buf, sizeof(buf), src))
       break;
 
     for(i=0; i<strlen(buf); i++) {
       lo = (buf[i] & 0x000f);
       hi = (buf[i] & 0x00f0) >> 4;
       fputs(tbl[hi], dst);
       fputs(tbl[lo], dst);
     }
   }

簡單的說，當文件中還有數(shù)據(jù)塊時（ feof(3) ），該循環(huán)讀取（feof(3) ）文件中的一個數(shù)據(jù)塊。然后將讀入的內(nèi)容的每個字節(jié)分成兩個 hi 和 lo 的半字節(jié)nibble。半字節(jié)是半個字節(jié)，即 4 個位。這里的奧妙之處在于可以用 4 個位來編碼 16 個值。我將 hi 和 lo 用作 16 個字符串查找表 tbl 的索引，表中包含了用半字節(jié)編碼的 MeowMeow 字符串。這些字符串使用 fputs(3) 函數(shù)寫入目標 FILE 流，然后我們繼續(xù)處理緩存區(qū)的下一個字節(jié)。

該表使用 table.h 中的宏定義進行初始化，在沒有特殊原因（比如：要展示包含了另一個項目的本地頭文件）時，我喜歡使用宏來進行初始化。我將在未來的文章中進一步探討原因。

喵嗚喵嗚解碼的實現(xiàn)

我承認在開始工作前花了一些時間。解碼的循環(huán)與編碼類似：讀取 MeowMeow 字符串到緩沖區(qū)，將編碼從字符串轉(zhuǎn)換為字節(jié)

 /* mmdecode.c - 喵嗚喵嗚流式編解碼器 */
 ...
 int mm_decode(FILE *src, FILE *dst)
 {
   if (!src || !dst) {
     errno = EINVAL;
     return -1;
   }
   return stupid_decode(src, dst);
 }

這不符合你的期望嗎？

在這里，我通過外部公開的 mm_decode() 函數(shù)公開了 stupid_decode() 函數(shù)細節(jié)。我上面所說的“外部”是指在這個文件之外。因為 stupid_decode() 函數(shù)不在該頭文件中，因此無法在其他文件中調(diào)用它。

當我們想發(fā)布一個可靠的公共接口時，有時候會這樣做，但是我們還沒有完全使用函數(shù)解決問題。在本例中，我編寫了一個 I/O 密集型函數(shù)，該函數(shù)每次從源中讀取 8 個字節(jié)，然后解碼獲得 1 個字節(jié)寫入目標流中。較好的實現(xiàn)是一次處理多于 8 個字節(jié)的緩沖區(qū)。更好的實現(xiàn)還可以通過緩沖區(qū)輸出字節(jié)，進而減少目標流中單字節(jié)的寫入次數(shù)。

/* mmdecode.c - 喵嗚喵嗚流式編解碼器 */
...
int stupid_decode(FILE *src, FILE *dst)
{
  char           buf[9];
  decoded_byte_t byte;
  int            i;
    
  while (!feof(src)) {
    if (!fgets(buf, sizeof(buf), src))
      break;
    byte.field.f0 = isupper(buf[0]);
    byte.field.f1 = isupper(buf[1]);
    byte.field.f2 = isupper(buf[2]);
    byte.field.f3 = isupper(buf[3]);
    byte.field.f4 = isupper(buf[4]);
    byte.field.f5 = isupper(buf[5]);
    byte.field.f6 = isupper(buf[6]);
    byte.field.f7 = isupper(buf[7]);
      
    fputc(byte.value, dst);
  }
  return 0;
}

我并沒有使用編碼器中使用的位移方法，而是創(chuàng)建了一個名為 decoded_byte_t 的自定義數(shù)據(jù)結構。

/* mmdecode.c - 喵嗚喵嗚流式編解碼器 */
...
 
typedef struct {
  unsigned char f7:1;
  unsigned char f6:1;
  unsigned char f5:1;
  unsigned char f4:1;
  unsigned char f3:1;
  unsigned char f2:1;
  unsigned char f1:1;
  unsigned char f0:1;
} fields_t;
  
typedef union {
  fields_t      field;
  unsigned char value;
} decoded_byte_t;

初次看到代碼時可能會感到有點兒復雜，但不要放棄。decoded_byte_t 被定義為 fields_t 和 unsigned char 的 聯(lián)合?？梢詫⒙?lián)合中的命名成員看作同一內(nèi)存區(qū)域的別名。在這種情況下，value 和 field 指向相同的 8 位內(nèi)存區(qū)域。將 field.f0 設置為 1 也將會設置 value 中的最低有效位。

雖然 unsigned char 并不神秘，但是對 fields_t 的類型定義（typedef）也許看起來有些陌生。現(xiàn)代 C 編譯器允許程序員在結構體中指定單個位字段的值。字段所在的類型是一個無符號整數(shù)類型，并在成員標識符后緊跟一個冒號和一個整數(shù)，該整數(shù)指定了位字段的長度。

這種數(shù)據(jù)結構使得按字段名稱訪問字節(jié)中的每個位變得簡單，并可以通過聯(lián)合中的 value 字段訪問組合后的值。我們依賴編譯器生成正確的移位指令來訪問字段，這可以在調(diào)試時為你節(jié)省不少時間。

最后，因為 stupid_decode() 函數(shù)一次僅從源 FILE 流中讀取 8 個字節(jié)，所以它效率并不高。通常我們嘗試最小化讀寫次數(shù)，以提高性能和降低調(diào)用系統(tǒng)調(diào)用的開銷。請記?。荷倭康淖x取/寫入大的塊比大量的讀取/寫入小的塊好得多。

總結

用 C 語言編寫一個多文件程序需要程序員要比只是是一個 main.c 做更多的規(guī)劃。但是當你添加功能或者重構時，只需要多花費一點兒努力便可以節(jié)省大量時間以及避免讓你頭痛的問題。

回顧一下，我更喜歡這樣做：多個文件，每個文件僅有簡單功能；通過頭文件公開那些文件中的小部分功能；把數(shù)字常量和字符串常量保存在頭文件中；使用 Makefile 而不是 Bash 腳本來自動化處理事務；使用 main() 函數(shù)來處理命令行參數(shù)解析并作為程序主要功能的框架。