Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Macros
afw_command_declare_helpers.h File Reference

Adaptive Framework declare helpers for afw_command_. More...

#include <apr_general.h>

Go to the source code of this file.

Macros

#define AFW_COMMAND_BEGIN_DECLARES
 
#define AFW_COMMAND_END_DECLARES
 
#define AFW_COMMAND_DECLSPEC_DECLARE   extern
 
#define AFW_COMMAND_DECLSPEC_DEFINE
 
#define AFW_COMMAND_CALLING_CONVENTION
 
#define AFW_COMMAND_CALLING_CONVENTION_ELLIPSIS
 
#define AFW_COMMAND_DECLARE_INTERNAL_CONST_DATA(type)   extern const type
 Declare an internal variable for /src/afw_command/ source*.h files. More...
 
#define AFW_COMMAND_DEFINE_INTERNAL_CONST_DATA(type)   const type
 Define an internal variable for /src/afw_command/ source*.c files. More...
 
#define AFW_COMMAND_DECLARE_INTERNAL(type)   extern type
 Declare an internal function for /src/afw_command/ source*.h files. More...
 
#define AFW_COMMAND_DEFINE_INTERNAL(type)   type
 Define an internal function for /src/afw_command/ source*.c files. More...
 
#define AFW_COMMAND_DECLARE(type)
 Declare a public afw_command function. More...
 
#define AFW_COMMAND_DECLARE_ELLIPSIS(type)
 Declare a public afw_command function with variable arguments. More...
 
#define AFW_COMMAND_DECLARE_CONST_DATA(type)
 Declare a public afw_command variable. More...
 
#define AFW_COMMAND_DEFINE(type)
 Define a public afw_command function. More...
 
#define AFW_COMMAND_DEFINE_ELLIPSIS(type)
 Define a public afw_command function with variable arguments. More...
 
#define AFW_COMMAND_DEFINE_CONST_DATA(type)
 Define a public afw_command variable. More...
 
#define AFW_COMMAND_CALLBACK   AFW_COMMAND_CALLING_CONVENTION
 
#define AFW_COMMAND_CALLBACK_ELLIPSIS   AFW_COMMAND_CALLING_CONVENTION_ELLIPSIS
 
#define AFW_COMMAND_DEFINE_DSO(type)   type
 
#define AFW_COMMAND_HAS_INLINE   APR_HAS_INLINE
 
#define AFW_COMMAND_INLINE   APR_INLINE
 
#define AFW_COMMAND_STATIC_INLINE   static AFW_COMMAND_INLINE
 
#define AFW_COMMAND_DECLARE_STATIC(type)   static type
 
#define AFW_COMMAND_DEFINE_STATIC_INLINE(type)   type
 

Detailed Description

Adaptive Framework declare helpers for afw_command_.

Definition in file afw_command_declare_helpers.h.

Macro Definition Documentation

◆ AFW_COMMAND_BEGIN_DECLARES

#define AFW_COMMAND_BEGIN_DECLARES

AFW_COMMAND_BEGIN_DECLARES goes before declares and AFW_COMMAND_END_DECLARES at end in afw_command*.h files.

Definition at line 40 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DECLARE

#define AFW_COMMAND_DECLARE (   type)
Value:
AFW_COMMAND_DECLSPEC_DECLARE \
type \
AFW_COMMAND_CALLING_CONVENTION

Declare a public afw_command function.

Parameters
typeof return value.

There must be a corresponding AFW_COMMAND_DEFINE() in a /src/afw_command/ source*.c files.

Example:

const afw_utf8_t * afw_command_some_function(int a);

is decorated this way:

AFW_COMMAND_DECLARE(const afw_utf8_t *) afw_command_some_function(int a);

Definition at line 124 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DECLARE_CONST_DATA

#define AFW_COMMAND_DECLARE_CONST_DATA (   type)
Value:
AFW_COMMAND_DECLSPEC_DECLARE \
const type

Declare a public afw_command variable.

Parameters
typeof variable

There must be a corresponding AFW_COMMAND_DEFINE_CONST_DATA in a /src/afw_command/ source*.c files.

Example:

extern const afw_utf8_t * afw_command_a_string;

is decorated this way:

AFW_COMMAND_DECLARE_CONST_DATA(afw_utf8_t *) afw_command_a_string;

Definition at line 170 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DECLARE_ELLIPSIS

#define AFW_COMMAND_DECLARE_ELLIPSIS (   type)
Value:
AFW_COMMAND_DECLSPEC_DECLARE \
type \
AFW_COMMAND_CALLING_CONVENTION_ELLIPSIS

Declare a public afw_command function with variable arguments.

Parameters
typeof return value.

There must be a corresponding AFW_COMMAND_DEFINE_ELLIPSIS() in a /src/afw_command/ source*.c files.

Example:

const afw_utf8_t * afw_command_some_function(int a, ...);

is decorated this way:

AFW_COMMAND_DECLARE_ELLIPSIS(const afw_utf8_t *) afw_command_some_function(int a, ...);

Definition at line 147 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DECLARE_INTERNAL

#define AFW_COMMAND_DECLARE_INTERNAL (   type)    extern type

Declare an internal function for /src/afw_command/ source*.h files.

Parameters
typeof return value.

Use this macro to supply the storage specifier of a function in a .h file that is only intended to be accessed internally to a linked object. There must be a corresponding AFW_COMMAND_DEFINE_INTERNAL() in a /src/afw_command/ source*.c files.

Any function declared this way is not considered part of the external API.

Definition at line 91 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DECLARE_INTERNAL_CONST_DATA

#define AFW_COMMAND_DECLARE_INTERNAL_CONST_DATA (   type)    extern const type

Declare an internal variable for /src/afw_command/ source*.h files.

Parameters
typeof variable

Use this macro to supply the storage specifier of a variable in a .h file that is only intended to be accessed internally to a linked object. There must be a corresponding AFW_COMMAND_DEFINE_INTERNAL_CONST_DATA() in a /src/afw_command/ source*.h files.

Any data declared this way is not considered part of the external API.

Definition at line 63 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DEFINE

#define AFW_COMMAND_DEFINE (   type)
Value:
AFW_COMMAND_DECLSPEC_DEFINE \
type \
AFW_COMMAND_CALLING_CONVENTION

Define a public afw_command function.

Parameters
typeof return value.

There must be a corresponding AFW_COMMAND_DECLARE() in a /src/afw_command/ source*.h files.

Example:

const afw_utf8_t * afw_command_some_function(int a) {...}

is decorated this way:

AFW_COMMAND_DEFINE(const afw_utf8_t *) afw_command_some_function(int a) {...}

Definition at line 192 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DEFINE_CONST_DATA

#define AFW_COMMAND_DEFINE_CONST_DATA (   type)
Value:
AFW_COMMAND_DECLSPEC_DEFINE \
const type

Define a public afw_command variable.

Parameters
typeof variable

There must be a corresponding AFW_COMMAND_DECLARE_CONST_DATA in a /src/afw_command/ source*.h files.

Example:

const afw_utf8_t * afw_command_a_string;

is decorated this way:

AFW_COMMAND_DEFINE_CONST_DATA(afw_utf8_t *) afw_command_a_string;

Definition at line 238 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DEFINE_ELLIPSIS

#define AFW_COMMAND_DEFINE_ELLIPSIS (   type)
Value:
AFW_COMMAND_DECLSPEC_DEFINE \
type \
AFW_COMMAND_CALLING_CONVENTION_ELLIPSIS

Define a public afw_command function with variable arguments.

Parameters
typeof return value.

There must be a corresponding AFW_COMMAND_DECLARE_ELLIPSIS() in a /src/afw_command/ source*.h files.

Example:

const afw_utf8_t * afw_command_some_function(int a, ...) {...}

is decorated this way:

AFW_COMMAND_DEFINE_ELLIPSIS(const afw_utf8_t *) afw_command_some_function(int a, ...) {...}

Definition at line 215 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DEFINE_INTERNAL

#define AFW_COMMAND_DEFINE_INTERNAL (   type)    type

Define an internal function for /src/afw_command/ source*.c files.

Parameters
typeof return value.

Use this macro to supply the storage specifier of a function in a .c files that is only intended to be accessed internally to a linked object. There must be a corresponding AFW_COMMAND_DECLARE_INTERNAL() in a /src/afw_command/ source*.h files.

Any function defined this way is not considered part of the external API.

Definition at line 105 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_DEFINE_INTERNAL_CONST_DATA

#define AFW_COMMAND_DEFINE_INTERNAL_CONST_DATA (   type)    const type

Define an internal variable for /src/afw_command/ source*.c files.

Parameters
typeof variable

Use this macro to supply the storage specifier of a variable in a .c files that is only intended to be accessed internally to a linked object. There must be a corresponding AFW_COMMAND_DECLARE_INTERNAL_CONST_DATA() in a /src/afw_command/ source*.h files.

Any data defined this way is not considered part of the external API.

Definition at line 77 of file afw_command_declare_helpers.h.

◆ AFW_COMMAND_STATIC_INLINE

#define AFW_COMMAND_STATIC_INLINE   static AFW_COMMAND_INLINE

AFW Inline.

Definition at line 268 of file afw_command_declare_helpers.h.