Style guidelines

libkempozer is implemented using C11.

Source files

All source files must:

• use a tab of 4 spaces.
• use Unix line endings.
• be prefixed with kmz_.

Structs

All exposed structs must:

• be named using snake casing.
• be suffixed with _t.
• be prefixed with kmz_.
• include the opening parenthesis ({) on the same line as the struct identifier.
• include a typedef following the struct declaration with the struct identifier converted to Pascal Case excluding the trailing t.
• use the doxygen @const tag on fields that are read-only.

• prefix non-public fields with _.

  Example:

    struct kmz_my_struct_t {
        /** @const */
        int _var;
    };
    typedef struct kmz_my_struct_t KmzMyStruct;
  

• provide a macro constructor if the struct represents a value type.

  Example:

    struct kmz_my_value_struct_t {
        int var_1, var_2;
    };
    typedef struct kmz_my_value_struct_t KmzMyValueStruct;
      
    #define kmz_my_value_struct(var_1, var_2) (MyValueStruct) {var_1,var_2}
  

Constructors

All exposed struct constructors must:

• follow all method naming conventions.
• be prefixed with from_ immediately following the common method prefix.

• return <struct> or <struct> *.

  Example:

    KmzMyStruct * KmzMyStruct__from_int(int var) {
        KmzMyStruct * me = malloc(sizeof(KmzMyStruct));
        me->_var = var;
        return me;
    }
  

Methods

All exposed struct methods must:

• be declared in a header and defined in a source file.
• be named using snake casing.
• be prefixed with the typedef identifier of the struct followed by __.

• have a first parameter of <struct> me or <struct> * me.

  Example:

    int KmzMyStruct__get_var(KmzMyStruct * me);
  

• include the opening parenthesis ({) on the same line as the method identifier in the source file.

  Example:

    int KmzMyStruct__get_var(KmzMyStruct * me) {
        return me->_var;
    }
  

Constants

All exposed struct constants must:

• be declared with the modifier static const.
• be named using upper snake casing.

• be prefixed with the typedef identifier of the struct followed by __.

  Example:

    static const int KmzMyStruct__MY_CONSTANT = 0;
  

Macros

All exposed macros that are designed to be used in code must:

• be named using lower snake casing.
• be defined as a function macro.

• be prefixed with kmz__.

  Example:

    #define kmz__my_macro(arg1)
  

• define a name for any varargs expected.

  Example:

    #define kmz_my_vararg_macro(args...)