afw_yaml_declare_helpers.h File Reference

Adaptive Framework declare helpers for afw_yaml_. More...

#include <apr_general.h>

Go to the source code of this file.

Macros
#define	AFW_YAML_BEGIN_DECLARES
#define	AFW_YAML_END_DECLARES
#define	AFW_YAML_DECLSPEC_DECLARE   extern
#define	AFW_YAML_DECLSPEC_DEFINE
#define	AFW_YAML_CALLING_CONVENTION
#define	AFW_YAML_CALLING_CONVENTION_ELLIPSIS
#define	AFW_YAML_DECLARE_INTERNAL_CONST_DATA(type)   extern const type
	Declare an internal variable for /src/afw_yaml/ source*.h files. More...
#define	AFW_YAML_DEFINE_INTERNAL_CONST_DATA(type)   const type
	Define an internal variable for /src/afw_yaml/ source*.c files. More...
#define	AFW_YAML_DECLARE_INTERNAL(type)   extern type
	Declare an internal function for /src/afw_yaml/ source*.h files. More...
#define	AFW_YAML_DEFINE_INTERNAL(type)   type
	Define an internal function for /src/afw_yaml/ source*.c files. More...
#define	AFW_YAML_DECLARE(type)
	Declare a public afw_yaml function. More...
#define	AFW_YAML_DECLARE_ELLIPSIS(type)
	Declare a public afw_yaml function with variable arguments. More...
#define	AFW_YAML_DECLARE_CONST_DATA(type)
	Declare a public afw_yaml variable. More...
#define	AFW_YAML_DEFINE(type)
	Define a public afw_yaml function. More...
#define	AFW_YAML_DEFINE_ELLIPSIS(type)
	Define a public afw_yaml function with variable arguments. More...
#define	AFW_YAML_DEFINE_CONST_DATA(type)
	Define a public afw_yaml variable. More...
#define	AFW_YAML_CALLBACK   AFW_YAML_CALLING_CONVENTION
#define	AFW_YAML_CALLBACK_ELLIPSIS   AFW_YAML_CALLING_CONVENTION_ELLIPSIS
#define	AFW_YAML_DEFINE_DSO(type)   type
#define	AFW_YAML_HAS_INLINE   APR_HAS_INLINE
#define	AFW_YAML_INLINE   APR_INLINE
#define	AFW_YAML_STATIC_INLINE   static AFW_YAML_INLINE
#define	AFW_YAML_DECLARE_STATIC(type)   static type
#define	AFW_YAML_DEFINE_STATIC_INLINE(type)   type

Detailed Description

Adaptive Framework declare helpers for afw_yaml_.

Definition in file afw_yaml_declare_helpers.h.

Macro Definition Documentation

AFW_YAML_BEGIN_DECLARES

#define AFW_YAML_BEGIN_DECLARES

AFW_YAML_BEGIN_DECLARES goes before declares and AFW_YAML_END_DECLARES at end in afw_yaml*.h files.

Definition at line 40 of file afw_yaml_declare_helpers.h.

AFW_YAML_DECLARE

#define AFW_YAML_DECLARE

(

type

)

Value:

AFW_YAML_DECLSPEC_DECLARE \
type \
AFW_YAML_CALLING_CONVENTION

Declare a public afw_yaml function.

Parameters

type	of return value.

There must be a corresponding AFW_YAML_DEFINE() in a /src/afw_yaml/ source*.c files.

Example:

const afw_utf8_t * afw_yaml_some_function(int a);

is decorated this way:

AFW_YAML_DECLARE(const afw_utf8_t *) afw_yaml_some_function(int a);

Definition at line 141 of file afw_yaml_declare_helpers.h.

AFW_YAML_DECLARE_CONST_DATA

#define AFW_YAML_DECLARE_CONST_DATA

(

type

)

Value:

AFW_YAML_DECLSPEC_DECLARE \
const type

Declare a public afw_yaml variable.

Parameters

type	of variable

There must be a corresponding AFW_YAML_DEFINE_CONST_DATA in a /src/afw_yaml/ source*.c files.

Example:

extern const afw_utf8_t * afw_yaml_a_string;

is decorated this way:

AFW_YAML_DECLARE_CONST_DATA(afw_utf8_t *) afw_yaml_a_string;

Definition at line 187 of file afw_yaml_declare_helpers.h.

AFW_YAML_DECLARE_ELLIPSIS

#define AFW_YAML_DECLARE_ELLIPSIS

(

type

)

Value:

AFW_YAML_DECLSPEC_DECLARE \
type \
AFW_YAML_CALLING_CONVENTION_ELLIPSIS

Declare a public afw_yaml function with variable arguments.

Parameters

type	of return value.

There must be a corresponding AFW_YAML_DEFINE_ELLIPSIS() in a /src/afw_yaml/ source*.c files.

Example:

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

is decorated this way:

AFW_YAML_DECLARE_ELLIPSIS(const afw_utf8_t *) afw_yaml_some_function(int a, ...);

Definition at line 164 of file afw_yaml_declare_helpers.h.

AFW_YAML_DECLARE_INTERNAL

#define AFW_YAML_DECLARE_INTERNAL

(

type

)

extern type

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

Parameters

type	of 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_YAML_DEFINE_INTERNAL() in a /src/afw_yaml/ source*.c files.

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

Definition at line 108 of file afw_yaml_declare_helpers.h.

AFW_YAML_DECLARE_INTERNAL_CONST_DATA

#define AFW_YAML_DECLARE_INTERNAL_CONST_DATA

(

type

)

extern const type

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

Parameters

type	of 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_YAML_DEFINE_INTERNAL_CONST_DATA() in a /src/afw_yaml/ source*.h files.

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

Definition at line 80 of file afw_yaml_declare_helpers.h.

AFW_YAML_DEFINE

#define AFW_YAML_DEFINE

(

type

)

Value:

AFW_YAML_DECLSPEC_DEFINE \
type \
AFW_YAML_CALLING_CONVENTION

Define a public afw_yaml function.

Parameters

type	of return value.

There must be a corresponding AFW_YAML_DECLARE() in a /src/afw_yaml/ source*.h files.

Example:

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

is decorated this way:

AFW_YAML_DEFINE(const afw_utf8_t *) afw_yaml_some_function(int a) {...}

Definition at line 209 of file afw_yaml_declare_helpers.h.

AFW_YAML_DEFINE_CONST_DATA

#define AFW_YAML_DEFINE_CONST_DATA

(

type

)

Value:

AFW_YAML_DECLSPEC_DEFINE \
const type

Define a public afw_yaml variable.

Parameters

type	of variable

There must be a corresponding AFW_YAML_DECLARE_CONST_DATA in a /src/afw_yaml/ source*.h files.

Example:

const afw_utf8_t * afw_yaml_a_string;

is decorated this way:

AFW_YAML_DEFINE_CONST_DATA(afw_utf8_t *) afw_yaml_a_string;

Definition at line 255 of file afw_yaml_declare_helpers.h.

AFW_YAML_DEFINE_ELLIPSIS

#define AFW_YAML_DEFINE_ELLIPSIS

(

type

)

Value:

AFW_YAML_DECLSPEC_DEFINE \
type \
AFW_YAML_CALLING_CONVENTION_ELLIPSIS

Define a public afw_yaml function with variable arguments.

Parameters

type	of return value.

There must be a corresponding AFW_YAML_DECLARE_ELLIPSIS() in a /src/afw_yaml/ source*.h files.

Example:

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

is decorated this way:

AFW_YAML_DEFINE_ELLIPSIS(const afw_utf8_t *) afw_yaml_some_function(int a, ...) {...}

Definition at line 232 of file afw_yaml_declare_helpers.h.

AFW_YAML_DEFINE_INTERNAL

#define AFW_YAML_DEFINE_INTERNAL

(

type

)

type

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

Parameters

type	of 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_YAML_DECLARE_INTERNAL() in a /src/afw_yaml/ source*.h files.

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

Definition at line 122 of file afw_yaml_declare_helpers.h.

AFW_YAML_DEFINE_INTERNAL_CONST_DATA

#define AFW_YAML_DEFINE_INTERNAL_CONST_DATA

(

type

)

const type

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

Parameters

type	of 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_YAML_DECLARE_INTERNAL_CONST_DATA() in a /src/afw_yaml/ source*.h files.

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

Definition at line 94 of file afw_yaml_declare_helpers.h.

AFW_YAML_STATIC_INLINE

#define AFW_YAML_STATIC_INLINE   static AFW_YAML_INLINE

AFW Inline.

Definition at line 285 of file afw_yaml_declare_helpers.h.