Commit 93058096 authored by Pekka Pessi's avatar Pekka Pessi

msg/sofia-sip/msg_protos.h.in: fixed whitespace

darcs-hash:20081127232501-db55f-580c57f67c92c154628a2fe8758832ec20dc2851.gz
parent 6b6dfd6b
...@@ -30,7 +30,7 @@ ...@@ -30,7 +30,7 @@
#ifndef MSG_PROTOS_H #ifndef MSG_PROTOS_H
/** Defined when <sofia-sip/msg_protos.h> has been included. */ /** Defined when <sofia-sip/msg_protos.h> has been included. */
#define MSG_PROTOS_H #define MSG_PROTOS_H
/**@ingroup msg_headers /**@ingroup msg_headers
* @file sofia-sip/msg_protos.h * @file sofia-sip/msg_protos.h
...@@ -58,13 +58,13 @@ enum { ...@@ -58,13 +58,13 @@ enum {
/* Declare internal prototypes for #xxxxxxx_xxxxxxx# */ /* Declare internal prototypes for #xxxxxxx_xxxxxxx# */
/**@addtogroup msg_#xxxxxx# /**@addtogroup msg_#xxxxxx#
* @{ * @{
*/ */
enum { enum {
/** Hash of #xxxxxxx_xxxxxxx#. @internal */ /** Hash of #xxxxxxx_xxxxxxx#. @internal */
msg_#xxxxxx#_hash = #hash# msg_#xxxxxx#_hash = #hash#
}; };
/** Parse a #xxxxxxx_xxxxxxx#. @internal */ /** Parse a #xxxxxxx_xxxxxxx#. @internal */
...@@ -74,41 +74,41 @@ MSG_DLL msg_parse_f msg_#xxxxxx#_d; ...@@ -74,41 +74,41 @@ MSG_DLL msg_parse_f msg_#xxxxxx#_d;
MSG_DLL msg_print_f msg_#xxxxxx#_e; MSG_DLL msg_print_f msg_#xxxxxx#_e;
/**Header class for #xxxxxxx_xxxxxxx#. /**Header class for #xxxxxxx_xxxxxxx#.
* *
* The header class msg_#xxxxxx#_class defines how a * The header class msg_#xxxxxx#_class defines how a
* #xxxxxxx_xxxxxxx# header is parsed and printed. It also * #xxxxxxx_xxxxxxx# header is parsed and printed. It also
* contains methods used by message parser and other functions * contains methods used by message parser and other functions
* to manipulate the msg_#xxxxxx#_t header structure. * to manipulate the msg_#xxxxxx#_t header structure.
* *
*/ */
MSG_DLL extern msg_hclass_t msg_#xxxxxx#_class[]; MSG_DLL extern msg_hclass_t msg_#xxxxxx#_class[];
/**Initializer for structure msg_#xxxxxx#_t. /**Initializer for structure msg_#xxxxxx#_t.
* *
* A static msg_#xxxxxx#_t structure must be initialized * A static msg_#xxxxxx#_t structure must be initialized
* with the MSG_#XXXXXX#_INIT() macro. For instance, * with the MSG_#XXXXXX#_INIT() macro. For instance,
* @code * @code
* *
* msg_#xxxxxx#_t msg_#xxxxxx# = MSG_#XXXXXX#_INIT; * msg_#xxxxxx#_t msg_#xxxxxx# = MSG_#XXXXXX#_INIT;
* *
* @endcode * @endcode
* @HI * @HI
*/ */
#define MSG_#XXXXXX#_INIT() MSG_HDR_INIT(#xxxxxx#) #define MSG_#XXXXXX#_INIT() MSG_HDR_INIT(#xxxxxx#)
/**Initialize a structure msg_#xxxxxx#_t. /**Initialize a structure msg_#xxxxxx#_t.
* *
* An msg_#xxxxxx#_t structure can be initialized with the * An msg_#xxxxxx#_t structure can be initialized with the
* msg_#xxxxxx#_init() function/macro. For instance, * msg_#xxxxxx#_init() function/macro. For instance,
* @code * @code
* *
* msg_#xxxxxx#_t msg_#xxxxxx#; * msg_#xxxxxx#_t msg_#xxxxxx#;
* *
* msg_#xxxxxx#_init(&msg_#xxxxxx#); * msg_#xxxxxx#_init(&msg_#xxxxxx#);
* *
* @endcode * @endcode
* *
* @param x pointer to msg_#xxxxxx#_t structure * @param x pointer to msg_#xxxxxx#_t structure
*/ */
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_init(msg_#xxxxxx#_t x[1]) su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_init(msg_#xxxxxx#_t x[1])
...@@ -121,13 +121,13 @@ su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_init(msg_#xxxxxx#_t x[1]) ...@@ -121,13 +121,13 @@ su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_init(msg_#xxxxxx#_t x[1])
#endif #endif
/**Test if header object is instance of msg_#xxxxxx#_t. /**Test if header object is instance of msg_#xxxxxx#_t.
* *
* The function msg_is_#xxxxxx#() returns true (nonzero) if * The function msg_is_#xxxxxx#() returns true (nonzero) if
* the header class is an instance of #xxxxxxx_xxxxxxx# * the header class is an instance of #xxxxxxx_xxxxxxx#
* object and false (zero) otherwise. * object and false (zero) otherwise.
* *
* @param header pointer to the header structure to be tested * @param header pointer to the header structure to be tested
* *
* @return * @return
* The function msg_is_#xxxxxx#() returns true (nonzero) if * The function msg_is_#xxxxxx#() returns true (nonzero) if
* the header object is an instance of header #xxxxxx# and * the header object is an instance of header #xxxxxx# and
...@@ -144,27 +144,27 @@ int msg_is_#xxxxxx#(msg_header_t const *header); ...@@ -144,27 +144,27 @@ int msg_is_#xxxxxx#(msg_header_t const *header);
#endif #endif
/**Duplicate (deep copy) @c msg_#xxxxxx#_t. /**Duplicate (deep copy) @c msg_#xxxxxx#_t.
* *
* The function msg_#xxxxxx#_dup() duplicates a header structure @a * The function msg_#xxxxxx#_dup() duplicates a header structure @a
* header. If the header structure @a header contains a reference * header. If the header structure @a header contains a reference
* (@c header->x_next) to a list of headers, all the headers in the * (@c header->x_next) to a list of headers, all the headers in the
* list are duplicated, too. * list are duplicated, too.
* *
* @param home memory home used to allocate new structure * @param home memory home used to allocate new structure
* @param header header structure to be duplicated * @param header header structure to be duplicated
* *
* When duplicating, all parameter lists and non-constant strings * When duplicating, all parameter lists and non-constant strings
* attached to the header are copied, too. The function uses given * attached to the header are copied, too. The function uses given
* memory @a home to allocate all the memory areas used to copy the * memory @a home to allocate all the memory areas used to copy the
* header. * header.
* *
* @par Example * @par Example
* @code * @code
* *
* #xxxxxx# = msg_#xxxxxx#_dup(home, msg->msg_#xxxxxx#); * #xxxxxx# = msg_#xxxxxx#_dup(home, msg->msg_#xxxxxx#);
* *
* @endcode * @endcode
* *
* @return * @return
* The function msg_#xxxxxx#_dup() returns a pointer to the * The function msg_#xxxxxx#_dup() returns a pointer to the
* newly duplicated msg_#xxxxxx#_t header structure, or NULL * newly duplicated msg_#xxxxxx#_t header structure, or NULL
...@@ -173,45 +173,45 @@ int msg_is_#xxxxxx#(msg_header_t const *header); ...@@ -173,45 +173,45 @@ int msg_is_#xxxxxx#(msg_header_t const *header);
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
su_inline su_inline
#endif #endif
msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home, msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home,
msg_#xxxxxx#_t const *header) msg_#xxxxxx#_t const *header)
__attribute__((__malloc__)); __attribute__((__malloc__));
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
su_inline su_inline
msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home, msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home,
msg_#xxxxxx#_t const *header) msg_#xxxxxx#_t const *header)
{ {
return (msg_#xxxxxx#_t *) return (msg_#xxxxxx#_t *)
msg_header_dup_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header); msg_header_dup_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header);
} }
#endif #endif
/**Copy a msg_#xxxxxx#_t header structure. /**Copy a msg_#xxxxxx#_t header structure.
* *
* The function msg_#xxxxxx#_copy() copies a header structure @a * The function msg_#xxxxxx#_copy() copies a header structure @a
* header. If the header structure @a header contains a reference * header. If the header structure @a header contains a reference
* (@c header->h_next) to a list of headers, all the headers in that * (@c header->h_next) to a list of headers, all the headers in that
* list are copied, too. The function uses given memory @a home to * list are copied, too. The function uses given memory @a home to
* allocate all the memory areas used to copy the header structure * allocate all the memory areas used to copy the header structure
* @a header. * @a header.
* *
* @param home memory home used to allocate new structure * @param home memory home used to allocate new structure
* @param header pointer to the header structure to be duplicated * @param header pointer to the header structure to be duplicated
* *
* When copying, only the header structure and parameter lists * When copying, only the header structure and parameter lists
* attached to it are duplicated. The new header structure retains * attached to it are duplicated. The new header structure retains
* all the references to the strings within the old @a header, * all the references to the strings within the old @a header,
* including the encoding of the old header, if present. * including the encoding of the old header, if present.
* *
* @par Example * @par Example
* @code * @code
* *
* #xxxxxx# = msg_#xxxxxx#_copy(home, msg->msg_#xxxxxx#); * #xxxxxx# = msg_#xxxxxx#_copy(home, msg->msg_#xxxxxx#);
* *
* @endcode * @endcode
* *
* @return * @return
* The function msg_#xxxxxx#_copy() returns a pointer to * The function msg_#xxxxxx#_copy() returns a pointer to
* newly copied header structure, or NULL upon an error. * newly copied header structure, or NULL upon an error.
...@@ -219,33 +219,33 @@ msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home, ...@@ -219,33 +219,33 @@ msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home,
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
su_inline su_inline
#endif #endif
msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home, msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home,
msg_#xxxxxx#_t const *header) msg_#xxxxxx#_t const *header)
__attribute__((__malloc__)); __attribute__((__malloc__));
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
su_inline su_inline
msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home, msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home,
msg_#xxxxxx#_t const *header) msg_#xxxxxx#_t const *header)
{ {
return (msg_#xxxxxx#_t *) return (msg_#xxxxxx#_t *)
msg_header_copy_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header); msg_header_copy_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header);
} }
#endif #endif
/**Make a header structure msg_#xxxxxx#_t. /**Make a header structure msg_#xxxxxx#_t.
* *
* The function msg_#xxxxxx#_make() makes a new * The function msg_#xxxxxx#_make() makes a new
* msg_#xxxxxx#_t header structure. It allocates a new * msg_#xxxxxx#_t header structure. It allocates a new
* header structure, and decodes the string @a s as the * header structure, and decodes the string @a s as the
* value of the structure. * value of the structure.
* *
* @param home memory home used to allocate new header structure. * @param home memory home used to allocate new header structure.
* @param s string to be decoded as value of the new header structure * @param s string to be decoded as value of the new header structure
* *
* @note This function is usually implemented as a macro calling * @note This function is usually implemented as a macro calling
* msg_header_make(). * msg_header_make().
* *
* @return * @return
* The function msg_#xxxxxx#_make() returns a pointer to * The function msg_#xxxxxx#_make() returns a pointer to
* newly maked msg_#xxxxxx#_t header structure, or NULL upon * newly maked msg_#xxxxxx#_t header structure, or NULL upon
...@@ -262,25 +262,25 @@ msg_#xxxxxx#_t *msg_#xxxxxx#_make(su_home_t *home, char const *s) ...@@ -262,25 +262,25 @@ msg_#xxxxxx#_t *msg_#xxxxxx#_make(su_home_t *home, char const *s)
#endif #endif
/**Make a #xxxxxxx_xxxxxxx# from formatting result. /**Make a #xxxxxxx_xxxxxxx# from formatting result.
* *
* The function msg_#xxxxxx#_format() makes a new * The function msg_#xxxxxx#_format() makes a new
* #xxxxxxx_xxxxxxx# object using formatting result as its * #xxxxxxx_xxxxxxx# object using formatting result as its
* value. The function first prints the arguments according to * value. The function first prints the arguments according to
* the format @a fmt specified. Then it allocates a new header * the format @a fmt specified. Then it allocates a new header
* structure, and uses the formatting result as the header * structure, and uses the formatting result as the header
* value. * value.
* *
* @param home memory home used to allocate new header structure. * @param home memory home used to allocate new header structure.
* @param fmt string used as a printf()-style format * @param fmt string used as a printf()-style format
* @param ... argument list for format * @param ... argument list for format
* *
* @note This function is usually implemented as a macro calling * @note This function is usually implemented as a macro calling
* msg_header_format(). * msg_header_format().
* *
* @return * @return
* The function msg_#xxxxxx#_format() returns a pointer to newly * The function msg_#xxxxxx#_format() returns a pointer to newly
* makes header structure, or NULL upon an error. * makes header structure, or NULL upon an error.
* *
* @HIDE * @HIDE
*/ */
#if SU_HAVE_INLINE #if SU_HAVE_INLINE
...@@ -294,11 +294,11 @@ su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_format(su_home_t *home, char const *fmt, ...@@ -294,11 +294,11 @@ su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_format(su_home_t *home, char const *fmt,
{ {
msg_header_t *h; msg_header_t *h;
va_list ap; va_list ap;
va_start(ap, fmt); va_start(ap, fmt);
h = msg_header_vformat(home, msg_#xxxxxx#_class, fmt, ap); h = msg_header_vformat(home, msg_#xxxxxx#_class, fmt, ap);
va_end(ap); va_end(ap);
return (msg_#xxxxxx#_t*)h; return (msg_#xxxxxx#_t*)h;
} }
#endif #endif
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment