qemu_CODING_STYLE

Qemu Coding Style
=================

1. 空白文字 Whitespace

もちろんのことですが、いかなるコーディングスタイルにおいても最重要局面となるのが空白文字です。老眼鏡の厄介になっているようなガチガチの古参コーダーなら、タブと８文字スペースの違いについて、遥か５０光年の彼方からでも話しに来るでしょう。この件について幾多の戦火が上がり、そして消えてゆきました。

QEMU のインデントはスペース４文字です。タブは一切使いませんが、Makefile 中では構文に抜きがたく結び付けられてしまっているので例外とします。複数のスペースがタブより良い理由は以下の通りです。

空白文字を、二通りではなく、ただひとつの方法で指定するようになる。曖昧さは間違いの元になる。
「タブを使って字下げし、スペースで微調整」というような混用がなくなる。
タブはコードを右に押しやり、画面を冗談抜きでアンバランスにする。
タブストップを誤設定して８文字単位にしなかった人のエディタでは、タブが正しく展開されない。
パッチ中でのタブは見た目がおかしくなり、ほぼすべての行でパッチ個所の判定ミス（off-by-one error）の原因となる。
これが QEMU のコーディングスタイルということ。

行末に空白文字をつけっぱなしにしておかないように。

2. 行の文字数 Line width

各行は８０文字とします。それより長くしないこと。

根拠：

２４インチの画面に 80x24 の xterm を 6x4 個並べて、それ全部で vi を使うような人たちがいる。こういう人たちを処罰するには放置が一番。
一行をほどほどの長さに制限すれば、コード、特にパッチがもっと読みやすくなる。８０文字が慣例となっている。
これが QEMU のコーディングスタイルということ。

3. 命名 Naming

変数は、名前に使われる単語をすべて小文字にし、各単語はアンダースコアで繋ぎます（lower_case_with_underscores）。入力しやすく読みやすい。構造体の型名は、名前に使われる各単語の先頭を大文字にします（CamelCase）。入力しにくいですが目立ちます。スカラー型は、POSIX の uint64_t やその系列のように、単語をすべて小文字にし、各単語をアンダースコアで繋ぎ、最後に t をつけます。最後のやり方は POSIX に従っていないため、変更もありえることに注意してください。

標準ライブラリ関数のラッパーを使うとき、プレフィックス qemu_ をつけてラッパー版であることを読み手側に喚起します。それ以外の場合は qemu_ プレフィックスの使用を避けてください。

4. ブロック構文 Block structure

インデントされた文（statement）は、ブロック内にひとつしか文がない場合でも、すべて中括弧（brace）でくくります。左括弧は新しいブロックの始まりとなる制御文と同じ行に置きます。右括弧は else と同じ行に置きます。else がない場合は１行を使って単体で置きます。例：

    if (a == 5) {
        printf("a was 5.\n");
    } else if (a == 6) {
        printf("a was 6.\n");
    } else {
        printf("a was something else entirely.\n");
    }

例外は関数開始時の左括弧です。慣例であることならびにその明晰さから、この場合は以下のように１行を使って単体で置きます。

    void a_function(void)
    {
        do_something();
    }

根拠：一貫した括弧のスタイル（関数は例外だけど…）は曖昧さを減らし、行が増えたり減ったりしたときの無用なごたごたを避ける。さらにいえば、これが QEMU のコーディングスタイルということ。