笨辦法學C 練習25：變參函式

飛龍發表於2019-05-10
函式

練習25：變參函式

原文：Exercise 25: Variable Argument Functions

譯者：飛龍

在C語言中，你可以通過建立“變參函式”來建立你自己的printf或者scanf版本。這些函式使用stdarg.h頭，它們可以讓你為你的庫建立更加便利的介面。它們對於建立特定型別的“構建”函式、格式化函式和任何用到可變引數的函式都非常實用。

理解“變參函式”對於C語言程式設計並不必要，我在程式設計生涯中也只有大約20次用到它。但是，理解變參函式如何工作有助於你對它的除錯，並且讓你更加了解計算機。

/** WARNING: This code is fresh and potentially isn`t correct yet. */

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include "dbg.h"

#define MAX_DATA 100

int read_string(char **out_string, int max_buffer)
{
    *out_string = calloc(1, max_buffer + 1);
    check_mem(*out_string);

    char *result = fgets(*out_string, max_buffer, stdin);
    check(result != NULL, "Input error.");

    return 0;

error:
    if(*out_string) free(*out_string);
    *out_string = NULL;
    return -1;
}

int read_int(int *out_int)
{
    char *input = NULL;
    int rc = read_string(&input, MAX_DATA);
    check(rc == 0, "Failed to read number.");

    *out_int = atoi(input);

    free(input);
    return 0;

error:
    if(input) free(input);
    return -1;
}

int read_scan(const char *fmt, ...)
{
    int i = 0;
    int rc = 0;
    int *out_int = NULL;
    char *out_char = NULL;
    char **out_string = NULL;
    int max_buffer = 0;

    va_list argp;
    va_start(argp, fmt);

    for(i = 0; fmt[i] != ` `; i++) {
        if(fmt[i] == `%`) {
            i++;
            switch(fmt[i]) {
                case ` `:
                    sentinel("Invalid format, you ended with %%.");
                    break;

                case `d`:
                    out_int = va_arg(argp, int *);
                    rc = read_int(out_int);
                    check(rc == 0, "Failed to read int.");
                    break;

                case `c`:
                    out_char = va_arg(argp, char *);
                    *out_char = fgetc(stdin);
                    break;

                case `s`:
                    max_buffer = va_arg(argp, int);
                    out_string = va_arg(argp, char **);
                    rc = read_string(out_string, max_buffer);
                    check(rc == 0, "Failed to read string.");
                    break;

                default:
                    sentinel("Invalid format.");
            }
        } else {
            fgetc(stdin);
        }

        check(!feof(stdin) && !ferror(stdin), "Input error.");
    }

    va_end(argp);
    return 0;

error:
    va_end(argp);
    return -1;
}



int main(int argc, char *argv[])
{
    char *first_name = NULL;
    char initial = ` `;
    char *last_name = NULL;
    int age = 0;

    printf("What`s your first name? ");
    int rc = read_scan("%s", MAX_DATA, &first_name);
    check(rc == 0, "Failed first name.");

    printf("What`s your initial? ");
    rc = read_scan("%c
", &initial);
    check(rc == 0, "Failed initial.");

    printf("What`s your last name? ");
    rc = read_scan("%s", MAX_DATA, &last_name);
    check(rc == 0, "Failed last name.");

    printf("How old are you? ");
    rc = read_scan("%d", &age);

    printf("---- RESULTS ----
");
    printf("First Name: %s", first_name);
    printf("Initial: `%c`
", initial);
    printf("Last Name: %s", last_name);
    printf("Age: %d
", age);

    free(first_name);
    free(last_name);
    return 0;
error:
    return -1;
}

這個程式和上一個練習很像，除了我編寫了自己的scanf風格函式，它以我自己的方式處理字串。你應該對main函式很清楚了，以及read_string和read_int兩個函式，因為它們並沒有做什麼新的東西。

這裡的變參函式叫做read_scan，它使用了va_list資料結構執行和scanf相同的工作，並支援巨集和函式。下面是它的工作原理：

  • 我將函式的最後一個引數設定為...，它向C表示這個函式在fmt引數之後接受任何數量的引數。我可以在它前面設定許多其它的引數，但是在它後面不能放置任何引數。

  • 在設定完一些引數時，我建立了va_list型別的變數，並且使用va_list來為其初始化。這配置了stdarg.h中的這一可以處理可變引數的元件。

  • 接著我使用了for迴圈，遍歷fmt格式化字串，並且處理了類似scanf的格式，但比它略簡單。它裡面只帶有整數、字元和字串。

  • 當我碰到佔位符時，我使用了switch語句來確定需要做什麼。

  • 現在，為了從va_list argp中獲得遍歷，我需要使用va_arg(argp, TYPE)巨集，其中TYPE是我將要向引數傳遞的準確型別。這一設計的後果是你會非常盲目，所以如果你沒有足夠的變數傳入，程式就會崩潰。

  • 和scanf的有趣的不同點是，當它碰到`s`佔位符時，我使用read_string來建立字串。va_list argp棧需要接受兩個函式：需要讀取的最大尺寸，以及用於輸出的字串指標。read_string使用這些資訊來執行實際工作。

  • 這使read_scan比scan更加一致，因為你總是使用&提供變數的地址，並且合理地設定它們。

  • 最後，如果它碰到了不在格式中的字元，它僅僅會讀取並跳過，而並不關心字元是什麼，因為它只需要跳過。

你會看到什麼

當你執行程式時，會得到與下面詳細的結果：

$ make ex25
cc -Wall -g -DNDEBUG    ex25.c   -o ex25
$ ./ex25
What`s your first name? Zed
What`s your initial? A
What`s your last name? Shaw
How old are you? 37
---- RESULTS ----
First Name: Zed
Initial: `A`
Last Name: Shaw
Age: 37

如何使它崩潰

這個程式對緩衝區溢位更加健壯，但是和scanf一樣，它不能夠處理輸入的格式錯誤。為了使它崩潰，試著修改程式碼，把首先傳入用於`%s`格式的尺寸去掉。同時試著傳入多於MAX_DATA的資料，之後找到在read_string中不使用calloc的方法，並且修改它的工作方式。最後還有個問題是fgets會吃掉換行符，所以試著使用fgetc修復它，要注意字串結尾應為` `。

附加題

  • 再三檢查確保你明白了每個out_變數的作用。最重要的是out_string，並且它是指標的指標。所以，理清當你設定時獲取到的是指標還是內容尤為重要。

  • 使用變參系統編寫一個和printf相似的函式，重新編寫main來使用它。

  • 像往常一樣，閱讀這些函式/巨集的手冊頁，確保知道了它在你的平臺做了什麼，一些平臺會使用巨集而其它平臺會使用函式，還有一些平臺會讓它們不起作用。這完全取決於你所用的編譯器和平臺。

相關文章