3.2.2 compiler.h: compiler-specific macro definitions

   

SYNOPSIS

#include <oskit/compiler.h>

DESCRIPTION

Defines a variety of macros used to hide compiler-dependent ways of doing things.

OSKIT_BEGIN_DECLS, OSKIT_END_DECLS

    All function prototypes should be surrounded by these macros, so that a C++ compiler will identify them as C functions.

OSKIT_INLINE

  Identifies a function as being inline-able.

OSKIT_PURE

  Identifies a function as ``pure.'' A pure function has no side-effects: it examines no values other than its arguments and changes no values other than its return value.

OSKIT_NORETURN

  Identifies a function as never returning (e.g., _exit).

OSKIT_STDCALL

  Indicates that a function uses an alternative calling convention compatibile with COM. In particular, this option indicates the called function will pop its parameters unless there were a variable number of them.