HN 日本語サマリー

← 一覧へ戻る
プログラミング

Cの指定初期化子による名前付き引数

C's designated initializers give us named arguments (quuxplusone.github.io)

52 pointsby joshcsimmons38 コメント

要約

C言語の強力な指定初期化子(designated initializers)を利用することで、他の言語に見られるような名前付き引数(named arguments)を模倣できる方法が紹介されています。このテクニックは、構造体とマクロを組み合わせ、引数の順序に依存せず、デフォルト値を設定しやすくすることで、APIの拡張性を高める利点があります。ただし、コードの複雑さが増すため、常に必要とされるわけではないことも指摘されています。

全文翻訳

Cの指定初期化子による名前付き引数

私の以前の投稿では、C++の「比較的弱められた」指定初期化子の形式について話しました。今回は、Cのフルパワー指定初期化子でできる便利なことについてお話ししたいと思います。このパターンを最初に見たのは、Ben Klemensの著書『21st Century C』(2014年)の226〜228ページでした。(Godboltで確認できます。)

struct IdealVolumeArgs {
  double atm;      // P
  double moles;    // n
  double kelvin;   // T
};
#define ideal_volume(...) ideal_volume_impl(
  (struct IdealVolumeArgs){
    .atm=1, .moles=1, .kelvin=273.15, __VA_ARGS__ 
  })
)
double ideal_volume_impl(struct IdealVolumeArgs args) {
  // 理想気体の法則: PV = nRT
  return args.moles * 0.082057366 * args.kelvin / args.atm;
}

int main() {
  printf("1 mole of gas at STP occupies %g L\n",
    ideal_volume());
  printf("1 mole of gas at 100°C occupies %g L\n",
    ideal_volume(.kelvin = 373.15));
  printf("2 moles of gas at 100°C occupies %g L\n",
    ideal_volume(.kelvin = 373.15, .moles = 2));
  printf("2 moles of gas at 0°C and 2 atm occupies %g L\n",
    ideal_volume(.moles = 2, .atm = 2));
}

このイディオムは、自然な関数呼び出し構文を持つ、名前付きでデフォルト可能な引数を提供します。これは、C++20が採用しなかったCの指定初期化子の2つの機能に依存しています。

  • 任意の順序で指定できます: (struct IdealVolumeArgs){ .atm=1, .moles=2 } は (struct IdealVolumeArgs){ .moles=2, .atm=1 } と同じ意味です。

  • 同じ指定子を複数回指定でき、最後のものだけが有効になります: (struct IdealVolumeArgs){ .atm=1, .moles=2, .atm=3 } は (struct IdealVolumeArgs){ .atm=3, .moles=2 } と同じ意味です。

2番目の箇条書きは、意図的でない場合は悪いスタイルとなるような機能に依存していることを意味します。Clangはデフォルトで-Winitializer-overrides診断を出力します。GCC(私の意見ではより合理的)は、-Wextraを指定した場合にのみ-Woverride-initを出力します。

このイディオムを使用する関数ができた場合、関数の定義に新しい名前付きパラメータを追加してもAPIの破壊にはなりません!例えば、呼び出し元が理想気体定数Rの値を自分で指定できるように決定したとします。新しいフィールドをArgs構造体に追加するだけです。古い呼び出しサイトはすべて問題なくコンパイルされ、同じ動作をします。(APIの破壊ではありませんが、ABIの破壊ではあります:呼び出し元を書き直す必要はありませんが、新しいヘッダーに対して再コンパイルする必要があります。)

struct IdealVolumeArgs {
  double atm;      // P
  double moles;    // n
  double R;        // R -- この新しいフィールドはABIを変更します
  double kelvin;   // T
};
#define ideal_volume(...) ideal_volume_impl((struct IdealVolumeArgs){
  .atm=1, .moles=1, .R = 0.082057366, .kelvin=273.15, __VA_ARGS__ 
})
double ideal_volume_impl(struct IdealVolumeArgs args) {
  return args.moles * args.R * args.kelvin / args.atm;
}

関連する関数のファミリーを記述している場合、Args構造体をファミリー全体で共有できます。例えば、構造体に.litersフィールドを追加し、IdealGasArgsと改名して、そのキーワード引数のセットを使用した関数のファミリー全体を定義できます。

#define ideal_pressure(...) ideal_pressure_impl((struct IdealGasArgs){
  .atm=NAN, .moles=1, .kelvin=273.15, .liters=1, __VA_ARGS__ })
#define ideal_amount(...) ideal_amount_impl((struct IdealGasArgs){
  .atm=1, .moles=NAN, .kelvin=273.15, .liters=1, __VA_ARGS__ })
#define ideal_temperature(...) ideal_temperature_impl((struct IdealGasArgs){
  .atm=1, .moles=1, .kelvin=NAN, .liters=1, __VA_ARGS__ })

また、任意の数の非キーワード引数を先頭に追加することもできます。

typedef struct { int cx, cy, r; } CircleArgs;
void sc_circle_impl(ScreenContext *, int opcode, CircleArgs);
#define sc_erase_circle(sc, ...) sc_circle_impl(sc, 0, (CircleArgs){__VA_ARGS__})
#define sc_draw_circle(sc, ...)  sc_circle_impl(sc, 1, (CircleArgs){__VA_ARGS__})
#define sc_fill_circle(sc, ...)  sc_circle_impl(sc, 2, (CircleArgs){__VA_ARGS__})

実例での使用

このイディオムを使って、すべての通常のCコードを置き換えるべきでしょうか?絶対に違います。これは、単に通常の非名前付き引数関数を書くのと比べて、重厚で「かわいらしい」ものです。

double ideal_volume(double atm, double moles, double kelvin) {
  return moles * 0.082057366 * kelvin / atm;
}

これはほとんどの場合、必要なすべてです。それでも、GitHubでの簡単な正規表現検索では、このパターンの実際の使用例がいくつか見つかります。最初に見つけた共有に値する使用例は、gab462/hof-flecs-raylibにありました。これは、次のような呼び出しを書くために使用されています。

send_message(&globals.send_buf, msg, .from_id = globals.name);

このパターンが見つかった中で最も注目度の高いプロジェクトは、EpicGames/raddebuggerでした。

typedef struct UI_AnimParams UI_AnimParams;
struct UI_AnimParams {
  F32 initial;
  F32 target;
  F32 rate;
  F32 epsilon;
  B32 reset;
};
internal F32 ui_anim_(UI_Key key, UI_AnimParams *params);
#define ui_anim(key, target_val, ...) ui_anim_((key), &(UI_AnimParams){.target = (target_val), .rate = (ui_state->default_animation_rate), __VA_ARGS__})
~~~~// この行は原文のフォーマットを維持
F32 cursor_pixel_off__animated = ui_anim(ui_key_from_stringf(~~~~), cursor_pixel_off, .initial = cursor_pixel_off);
~~~~// この行は原文のフォーマットを維持
u->alive_t = ui_anim(ui_key_from_stringf(~~~~), 1.f, .rate = entity_alive_t_rate);
~~~~// この行は原文のフォーマットを維持