/**@ingroup msg_headers  -*- C -*-
 * @file sofia-sip/msg_protos.h.in
 *
 * Template for <msg_protos.h>.
 */

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef MSG_PROTOS_H
/** Defined when <sofia-sip/msg_protos.h> has been included. */
#define MSG_PROTOS_H

/**@ingroup msg_headers
 * @file sofia-sip/msg_protos.h
 *
 * Prototypes for common headers
 *
 * #AUTO#
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 *
 * @date Created: Fri Aug 16 19:18:26 EEST 2002 ppessi
 */

#ifndef MSG_HEADER_H
#include <sofia-sip/msg_header.h>
#endif

SOFIA_BEGIN_DECLS

enum {
  msg_request_hash = -1,
  msg_status_hash = -2
};


/* Declare internal prototypes for #xxxxxxx_xxxxxxx# */

/**@addtogroup msg_#xxxxxx#
 * @{
 */

enum {
  /** Hash of #xxxxxxx_xxxxxxx#. @internal */
  msg_#xxxxxx#_hash = #hash#
};

/** Parse a #xxxxxxx_xxxxxxx#. @internal */
MSG_DLL msg_parse_f msg_#xxxxxx#_d;

/** Print a #xxxxxxx_xxxxxxx#. @internal */
MSG_DLL msg_print_f msg_#xxxxxx#_e;

/**Header class for #xxxxxxx_xxxxxxx#.
 *
 * The header class msg_#xxxxxx#_class defines how a
 * #xxxxxxx_xxxxxxx# header is parsed and printed.  It also
 * contains methods used by message parser and other functions
 * to manipulate the msg_#xxxxxx#_t header structure.
 *
 */
MSG_DLL extern msg_hclass_t msg_#xxxxxx#_class[];

/**Initializer for structure msg_#xxxxxx#_t.
 *
 * A static msg_#xxxxxx#_t structure must be initialized
 * with the MSG_#XXXXXX#_INIT() macro. For instance,
 * @code
 *
 *  msg_#xxxxxx#_t msg_#xxxxxx# = MSG_#XXXXXX#_INIT;
 *
 * @endcode
 * @HI
 */
#define MSG_#XXXXXX#_INIT() MSG_HDR_INIT(#xxxxxx#)

/**Initialize a structure msg_#xxxxxx#_t.
 *
 * An msg_#xxxxxx#_t structure can be initialized with the
 * msg_#xxxxxx#_init() function/macro. For instance,
 * @code
 *
 *  msg_#xxxxxx#_t msg_#xxxxxx#;
 *
 *  msg_#xxxxxx#_init(&msg_#xxxxxx#);
 *
 * @endcode
 *
 * @param x pointer to msg_#xxxxxx#_t structure
 */
#if SU_HAVE_INLINE
su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_init(msg_#xxxxxx#_t x[1])
{
  return MSG_HEADER_INIT(x, msg_#xxxxxx#_class, sizeof(msg_#xxxxxx#_t));
}
#else
#define msg_#xxxxxx#_init(x) \
  MSG_HEADER_INIT(x, msg_#xxxxxx#_class, sizeof(msg_#xxxxxx#_t))
#endif

/**Test if header object is instance of msg_#xxxxxx#_t.
 *
 * The function msg_is_#xxxxxx#() returns true (nonzero) if
 * the header class is an instance of #xxxxxxx_xxxxxxx#
 * object and false (zero) otherwise.
 *
 * @param header pointer to the header structure to be tested
 *
 * @return
 * The function msg_is_#xxxxxx#() returns true (nonzero) if
 * the header object is an instance of header #xxxxxx# and
 * false (zero) otherwise.
 */
#if SU_HAVE_INLINE
su_inline int msg_is_#xxxxxx#(msg_header_t const *header)
{
  msg_generic_t const *h = (msg_generic_t *)header;
  return h && h->g_common->h_class->hc_hash == msg_#xxxxxx#_hash;
}
#else
int msg_is_#xxxxxx#(msg_header_t const *header);
#endif

/**Duplicate (deep copy) @c msg_#xxxxxx#_t.
 *
 * The function msg_#xxxxxx#_dup() duplicates a header structure @a
 * header. If the header structure @a header contains a reference
 * (@c header->x_next) to a list of headers, all the headers in the
 * list are duplicated, too.
 *
 * @param home   memory home used to allocate new structure
 * @param header header structure to be duplicated
 *
 * When duplicating, all parameter lists and non-constant strings
 * attached to the header are copied, too. The function uses given
 * memory @a home to allocate all the memory areas used to copy the
 * header.
 *
 * @par Example
 * @code
 *
 *   #xxxxxx# = msg_#xxxxxx#_dup(home, msg->msg_#xxxxxx#);
 *
 * @endcode
 *
 * @return
 * The function msg_#xxxxxx#_dup() returns a pointer to the
 * newly duplicated msg_#xxxxxx#_t header structure, or NULL
 * upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home,
				 msg_#xxxxxx#_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_#xxxxxx#_t *msg_#xxxxxx#_dup(su_home_t *home,
				 msg_#xxxxxx#_t const *header)
{
  return (msg_#xxxxxx#_t *)
    msg_header_dup_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header);
}
#endif


/**Copy a msg_#xxxxxx#_t header structure.
 *
 * The function msg_#xxxxxx#_copy() copies a header structure @a
 * header. If the header structure @a header contains a reference
 * (@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
 * allocate all the memory areas used to copy the header structure
 * @a header.
 *
 * @param home    memory home used to allocate new structure
 * @param header  pointer to the header structure to be duplicated
 *
 * When copying, only the header structure and parameter lists
 * attached to it are duplicated. The new header structure retains
 * all the references to the strings within the old @a header,
 * including the encoding of the old header, if present.
 *
 * @par Example
 * @code
 *
 *   #xxxxxx# = msg_#xxxxxx#_copy(home, msg->msg_#xxxxxx#);
 *
 * @endcode
 *
 * @return
 * The function msg_#xxxxxx#_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home,
				  msg_#xxxxxx#_t const *header)
     __attribute__((__malloc__));

#if SU_HAVE_INLINE
su_inline
msg_#xxxxxx#_t *msg_#xxxxxx#_copy(su_home_t *home,
				  msg_#xxxxxx#_t const *header)
{
  return (msg_#xxxxxx#_t *)
    msg_header_copy_as(home, msg_#xxxxxx#_class, (msg_header_t const *)header);
}
#endif

/**Make a header structure msg_#xxxxxx#_t.
 *
 * The function msg_#xxxxxx#_make() makes a new
 * msg_#xxxxxx#_t header structure.  It allocates a new
 * header structure, and decodes the string @a s as the
 * value of the structure.
 *
 * @param home memory home used to allocate 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
 * msg_header_make().
 *
 * @return
 * The function msg_#xxxxxx#_make() returns a pointer to
 * newly maked msg_#xxxxxx#_t header structure, or NULL upon
 * an error.
 */
#if SU_HAVE_INLINE
su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_make(su_home_t *home, char const *s)
{
  return (msg_#xxxxxx#_t*)msg_header_make(home, msg_#xxxxxx#_class, s);
}
#else
msg_#xxxxxx#_t *msg_#xxxxxx#_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));
#endif

/**Make a #xxxxxxx_xxxxxxx# from formatting result.
 *
 * The function msg_#xxxxxx#_format() makes a new
 * #xxxxxxx_xxxxxxx# object using formatting result as its
 * value.  The function first prints the arguments according to
 * the format @a fmt specified.  Then it allocates a new header
 * structure, and uses the formatting result as the header
 * value.
 *
 * @param home   memory home used to allocate new header structure.
 * @param fmt    string used as a printf()-style format
 * @param ...    argument list for format
 *
 * @note This function is usually implemented as a macro calling
 * msg_header_format().
 *
 * @return
 * The function msg_#xxxxxx#_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 *
 * @HIDE
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_#xxxxxx#_t *msg_#xxxxxx#_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__malloc__, __format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline msg_#xxxxxx#_t *msg_#xxxxxx#_format(su_home_t *home, char const *fmt, ...)
{
  msg_header_t *h;
  va_list ap;

  va_start(ap, fmt);
  h = msg_header_vformat(home, msg_#xxxxxx#_class, fmt, ap);
  va_end(ap);

  return (msg_#xxxxxx#_t*)h;
}
#endif

/** @} */


SOFIA_END_DECLS

#endif /** !defined(MSG_PROTOS_H) */
