28.1. Coding Rules

28.1.1. Naming convention

Table 28.1. Class and macro naming convention

Class	Description
SFA`Name`	Internal classes of SophiaFramework UNIVERSE.
SFB`Name`	Wrapper classes for BREW interfaces of SophiaFramework UNIVERSE.
SFC`Name`	Core classes of SophiaFramework UNIVERSE.
SFD`Name`	Debugging classes of SophiaFramework UNIVERSE.
SFH`Name`	Reserved (not used).
SFI`Name`	Reserved (not used).
SFM`Name`	Macros of SophiaFramework UNIVERSE.
SFO`Name`	Reference counting classes of SophiaFramework UNIVERSE.
SFP`Name`	Constant values of SophiaFramework UNIVERSE.
SFR`Name`	SFR responder classes of SophiaFramework UNIVERSE.
SFT`Name`	Reserved (not used).
SFU`Name`	Reserved (utility classes of previous SophiaFramework versions).
SFX`Name`	SophiaFramework utility classes.
SFY`Name`	SFY responder classes of SophiaFramework UNIVERSE.
SFZ`Name`	SFZ responder classes of SophiaFramework UNIVERSE.
SFW`Name`	Reserved (not used).

Table 28.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)

28.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 28.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 28.2. SFXRingBuffer::Write() prototype

SFCError Write(SFXBufferConstRef buffer);

28.1.3. Set, Get Functions

In SophiaFramework UNIVERSE, there are the Set function and the Get function in many classes. The Set function operates on its object destructively and the Get function operates on its object non-destructively as follows:

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

If an error does not orror in calling the Set function, the value that has been set before will be lost. Otherwise, the value that has been set before will never be overridden.

However, the Set function that does not return no errors always override the object with the value of its argument. For example, the Set function of SFXGraphics, SFXResponderPointer, SFXBrewPointer and so on is this kind of function.

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