26.1. Coding Rules

26.1.1. Naming convention

Table 26.1. Class and macro naming convention

Class	Description
SFA`Name`	SophiaFramework internal classes.
SFB`Name`	SophiaFramework wrapper classes for BREW interfaces.
SFC`Name`	SophiaFramework core classes.
SFD`Name`	SophiaFramework debugging classes.
SFH`Name`	Reserved (not used).
SFI`Name`	Reserved (not used).
SFM`Name`	SophiaFramework macros
SFP`Name`	Reserved (not used).
SFR`Name`	SophiaFramework responder classes.
SFT`Name`	Reserved (not used).
SFU`Name`	Reserved (utility classes of previous SophiaFramework versions).
SFX`Name`	SophiaFramework utility classes.
SFY`Name`	Reserved (not used).
SFZ`Name`	Reserved (not used).
SFW`Name`	Reserved (not used).

Table 26.2. Function pointer naming convention

Function Pointer	Description
`Name`MPP	A pointer to the member function (MPP = Member Procedure Pointer)
`Name`SPP	A pointer to the static function (SPP = Static Procedure Pointer)

26.1.2. Function Argument

For the source code to be readable, when the value of an argument might be changed by the function, the argument of not reference but pointer type is passed.

Example 26.1. SFXRingBuffer::Read() protype

SFCError Read(SFXBufferPtr buffer);

	Note
	The return value shows whether the reading is succeeded or not, and data to be read is stored in the argument "buffer".

To pass a constant object to a function, specify the argument of not pointer but const reference type.

Example 26.2. SFXRingBuffer::Write() prototype

SFCError Write(SFXBufferConstRef buffer);

26.1.3. Set, Get Functions

If Set function is called, the value that was set before is lost.

If Get function is called, the value that was set before is not lost.