自作出力関数snapshot関数の解説

コード

#include <stdio.h>
#include <stdarg.h>
#include <time.h>

#define MAX_SIZE 4096

extern int snapshot(const char *fmt, ...)
{
    char tstr[MAX_SIZE];
    char buff[MAX_SIZE];
    char message[MAX_SIZE];
    time_t ct;
    struct tm *lst;
    va_list ap;
    int ret;

    time(&ct);
    lst = localtime(&ct);
    strftime(tstr, sizeof(tstr), "%Y/%m/%d %H:%M:%S", lst);

    va_start(ap, fmt);

    ret = vsnprintf(message, sizeof(message), fmt, ap);
    if (ret < 0)
    {
        va_end(ap);
        return -1; /* vsnprintf error */
    }
    else if (ret >= sizeof(message))
    {
        va_end(ap);
        return -2; /* message buffer overflow */
    }

    ret = snprintf(buff, sizeof(buff), "| %s | %s", tstr, message);
    if (ret < 0)
    {
        va_end(ap);
        return -3; /* snprintf error */
    }
    else if (ret >= sizeof(buff))
    {
        va_end(ap);
        return -4; /* buff buffer overflow */
    }

    va_end(ap);

    fprintf(stdout, "%s\n", buff); /* Added newline for standard log behavior */

    return 0;
}

使用しているライブラリ

使用している関数とその役割

特徴点

詳細解説

宣言・定義

#define MAX_SIZE 4096

char tstr[MAX_SIZE];

char buff[MAX_SIZE];

char message[MAX_SIZE];

（その他の変数 time_t ct;, struct tm *lst;, va_list ap;, int ret; はそれぞれの型と役割に応じて宣言されています。）

処理の流れ

1. 現在時刻の取得とフォーマット:
   • time(&ct); で現在のカレンダー時刻（エポックからの秒数）を取得します。
   • localtime(&ct); で取得したカレンダー時刻を、年月日時分秒などの要素に分解したローカル時刻の構造体 (struct tm) に変換します。
   • strftime(tstr, sizeof(tstr), "%Y/%m/%d %H:%M:%S", lst); で、ローカル時刻構造体を指定された書式（"YYYY/MM/DD HH:MM:SS"）の文字列に変換し、tstrに格納します。
2. 可変長引数の処理開始:
   • va_start(ap, fmt); マクロを使用して、可変長引数リスト ap の処理を開始します。fmt は最後の固定引数（この関数の場合はフォーマット文字列）です。
3. ユーザーメッセージのフォーマット:
   • ret = vsnprintf(message, sizeof(message), fmt, ap); で、ユーザーが渡したフォーマット文字列 fmt とそれに対応する可変長引数 ap を使用して、書式設定された文字列を message バッファに書き込みます。sizeof(message) でバッファサイズを指定し、オーバーフローを防ぎます。
   • エラーチェック:
     • ret < 0: vsnprintf がエンコードエラーなどで失敗した場合、-1を返して終了します。
     • ret >= sizeof(message): フォーマット後の文字列が message バッファに収まらなかった場合（切り捨てが発生した場合を含む）、-2を返して終了します。
4. タイムスタンプとメッセージの結合:
   • ret = snprintf(buff, sizeof(buff), "| %s | %s", tstr, message); で、先にフォーマットした日時文字列 tstr とユーザーメッセージ message を、指定された書式 "| タイムスタンプ | メッセージ" で buff バッファに結合・格納します。
   • エラーチェック:
     • ret < 0: snprintf が失敗した場合、-3を返して終了します。
     • ret >= sizeof(buff): 結合後の文字列が buff バッファに収まらなかった場合、-4を返して終了します。
5. 可変長引数の処理終了:
   • va_end(ap); マクロを使用して、可変長引数リスト ap の処理をクリーンアップします。これは va_start と対で必ず呼び出す必要があります。
6. 標準出力への出力:
   • fprintf(stdout, "%s\n", buff); で、最終的にフォーマットされた文字列 buff を標準出力 (通常はコンソール) に出力します。末尾に改行 \n を追加しています。
7. 正常終了:
   • すべて成功した場合、0 を返します。

主要なマクロ・関数解説