28.1. コーディング規約

表 28.1. クラスとマクロの命名規則

クラス	解説
SFA`Name`	SophiaFramework UNIVERSE の内部クラスです。
SFB`Name`	SophiaFramework UNIVERSE の BREW インターフェースラッパークラスです。
SFC`Name`	SophiaFramework UNIVERSE のコアクラスです。
SFD`Name`	SophiaFramework UNIVERSE のデバッグ用クラスです。
SFH`Name`	予約されています（未使用）。
SFI`Name`	予約されています（未使用）。
SFM`Name`	SophiaFramework UNIVERSE のマクロです。
SFO`Name`	SophiaFramework UNIVERSE の参照カウント機能を備えたオブジェクトクラスです。
SFP`Name`	SophiaFramework UNIVERSE の定数名です。
SFR`Name`	SophiaFramework UNIVERSE の SFR レスポンダシステム（旧レスポンダシステム）のクラスです。（SophiaFramework UNIVERSE 6.0 以降廃止予定）
SFT`Name`	予約されています（未使用）。
SFU`Name`	予約されています。(SophiaFramework UNIVERSE 旧バージョンのユーティリティクラス )
SFX`Name`	SophiaFramework UNIVERSE のユーティリティクラスです。
SFY`Name`	SophiaFramework UNIVERSE の SFY レスポンダシステム（新レスポンダシステム）のクラスです。
SFZ`Name`	SophiaFramework UNIVERSE の SFZ レスポンダシステム（新レスポンダシステム）のクラスです。
SFW`Name`	予約されています（未使用）。

表 28.2. 関数ポインタの命名規則

関数ポインタ	解説
`Name`MPP	メンバ関数へのポインタ (MPP = Member Procedure Pointer)
`Name`SPP	静的関数へのポインタ (SPP = Static Procedure Pointer)

SophiaFramework UNIVERSE では、ソースコードの可読性のため、関数により変更される引数は参照渡しではなくポインタ渡しとなります。

逆に、関数により変更されない定数オブジェクトの引数は、ポインタではなく const 参照となります。

たとえば、SFXRingBuffer::Read 関数のプロトタイプは次のようになっており、ポインタ渡しで値を受け取ります。

例 28.1. SFXRingBuffer::Read 関数のプロトタイプ

SFCError Read(SFXBufferPtr buffer);

	注意
	読み込みに成功したかどうかを戻り値で返し、読み込んだデータは引数の buffer に格納されます。

SFXRingBuffer::Write 関数のプロトタイプは次のようになっており、 const 参照渡しで定数オブジェクトを渡します。

例 28.2. SFXRingBuffer::Write 関数のプロトタイプ

SFCError Write(SFXBufferConstRef buffer);

SophiaFramework UNIVERSE では、多くのクラスに Set 関数と Get 関数が存在します。以下のように Set 関数はオブジェクトに対して破壊的に作用し、Get 関数はオブジェクトに対して非破壊的に作用します。

Set 関数を呼び出したとき、エラーが発生しなかった場合は呼び出す前に設定されていた値は引数の値で上書きされます。エラーが発生した場合は引数の値で呼び出す前に設定されていた値が上書きされることはありません（元の状態を保持します）。

ただし、エラーを返さない Set 関数では呼び出す前に設定されていた値は引数の値で単純に上書きされます。たとえば、SFXGraphics、SFXResponderPointer、SFXBrewPointer などのクラスの Set 関数がこれに該当します。

Get 関数は呼び出しても、呼び出す前に設定されていた値は失われません（元の状態を保持します）。