11.1.2 Parameters naming conventions ¶

In this documentation we use DEFOBJ as function parameter name to indicate that the parameter given to a function call must be a string representing the name of a data variable: such variable must represent a default object. If the function is given a parameter of another type: its behaviour is undefined.

In this documentation we use DEFCLS as function parameter name to indicate that the parameter given to a function call must be a string representing the name of a data variable: such variable must be a default class. If the function is given a parameter of another type: its behaviour is undefined.

In this documentation we use DEFMETACLS as function parameter name to indicate that the parameter given to a function call must be a string representing the name of a data variable: such variable must be a default metaclass. If the function is given a parameter of another type: its behaviour is undefined.

If functions are described as follows:

my_func DEFOBJ
my_other_func DEFCLS

such functions must be used as follows:

mbfl_default_class_declare(COLOUR)
mbfl_default_object_declare(DARK_SLATE_BLUE)

mbfl_default_class_define _(COLOUR) _(mbfl_default_object) 'colour' red green blue
colour_define _(DARK_SLATE_BLUE) 72 61 139

my_func _(DARK_SLATE_BLUE)
my_other_func _(COLOUR)