msg_mime_protos.h

Sofia SIP is an open-source SIP User-Agent library, compliant with the IETF RFC3261 specification.

  return (msg_content_transfer_encoding_t *)
    msg_header_dup_as(home, msg_content_transfer_encoding_class, (msg_header_t const *)header); 
}
#endif


/**Copy an #msg_content_transfer_encoding_t header structure.
 * 
 * The function msg_content_transfer_encoding_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
 * 
 *   content_transfer_encoding = msg_content_transfer_encoding_copy(home, msg->msg_content_transfer_encoding);
 * 
 * @endcode
 * 
 * @return
 * The function msg_content_transfer_encoding_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_content_transfer_encoding_t *msg_content_transfer_encoding_copy(su_home_t *home, 
				  msg_content_transfer_encoding_t const *header);

#if SU_HAVE_INLINE
su_inline
msg_content_transfer_encoding_t *msg_content_transfer_encoding_copy(su_home_t *home, 
				  msg_content_transfer_encoding_t const *header)
{
  return (msg_content_transfer_encoding_t *)
    msg_header_copy_as(home, msg_content_transfer_encoding_class, (msg_header_t const *)header); 
}
#endif


/**Make a header structure #msg_content_transfer_encoding_t.
 * 
 * The function msg_content_transfer_encoding_make() makes a new #msg_content_transfer_encoding_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 may be implemented as a macro calling
 * msg_header_make().
 * 
 * @return
 * The function msg_content_transfer_encoding_make() returns a pointer to newly maked
 * #msg_content_transfer_encoding_t header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline msg_content_transfer_encoding_t *msg_content_transfer_encoding_make(su_home_t *home, char const *s)
{
  return (msg_content_transfer_encoding_t*)msg_header_make(home, msg_content_transfer_encoding_class, s);
}
#else
msg_content_transfer_encoding_t *msg_content_transfer_encoding_make(su_home_t *home, char const *s);
#endif


/**Make a Content-Transfer-Encoding header from formatting result.
 * 
 * The function msg_content_transfer_encoding_format() makes a new Content-Transfer-Encoding header object
 * using snprintf-formatted 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 may be implemented as a macro calling
 * msg_header_format().
 * 
 * @return
 * The function msg_content_transfer_encoding_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_content_transfer_encoding_t *msg_content_transfer_encoding_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline msg_content_transfer_encoding_t *msg_content_transfer_encoding_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_content_transfer_encoding_class, fmt, ap);
  va_end(ap);
 
  return (msg_content_transfer_encoding_t*)h;
}
#endif

/** @} */

/* Declare internal prototypes for Accept header */

/**@addtogroup msg_accept 
 * @{ 
 */

enum { 
  /** Hash of Accept header. @internal */
  msg_accept_hash = 29344 
};

/** Parse a Accept header. @internal */
MSG_DLL msg_parse_f msg_accept_d;

/** Print a Accept header. @internal */
MSG_DLL msg_print_f msg_accept_e;

MSG_DLL msg_xtra_f msg_accept_dup_xtra;
MSG_DLL msg_dup_f msg_accept_dup_one;

/**Header class for Accept header.
 * 
 * The header class msg_accept_class defines how a 
 * Accept header header is parsed and printed.  It also
 * contains methods used by message parser and other functions
 * to manipulate the #msg_accept_t header structure.
 * 
 */
#ifndef msg_accept_class
MSG_DLL extern msg_hclass_t msg_accept_class[];
#endif

/**Initializer for an #msg_accept_t structure.
 * 
 * A static msg_accept_t structure must be initialized
 * with the MSG_ACCEPT_INIT() macro. For instance,
 * @code 
 * 
 *  msg_accept_t msg_accept = MSG_ACCEPT_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_ACCEPT_INIT() MSG_HDR_INIT(accept)

/**Initialize an #msg_accept_t structure.
 * 
 * An #msg_accept_t structure can be initialized with the
 * msg_accept_init() function/macro. For instance,
 * @code
 * 
 *  msg_accept_t msg_accept;
 * 
 *  msg_accept_init(&msg_accept);
 * 
 * @endcode
 * 
 * @param x pointer to #msg_accept_t structure 
 */
#if SU_HAVE_INLINE
su_inline msg_accept_t *msg_accept_init(msg_accept_t x[1])
{
  return MSG_HEADER_INIT(x, msg_accept_class, sizeof(msg_accept_t));
}
#else
#define msg_accept_init(x) \
  MSG_HEADER_INIT(x, msg_accept_class, sizeof(msg_accept_t))
#endif

/**Test if header object is an instance of #msg_accept_t.
 * 
 * The function msg_is_accept() returns true (nonzero) if
 * the header class is an instance of Accept header
 * object and false (zero) otherwise.
 * 
 * @param header pointer to the header structure to be tested
 * 
 * @return The function msg_is_accept() returns true (nonzero) if the
 * header object is an instance of header Accept header and false (zero)
 * otherwise.
 */
#if SU_HAVE_INLINE
su_inline int msg_is_accept(msg_header_t const *header)
{
  return header && header->sh_class->hc_hash == msg_accept_hash;
}
#else
int msg_is_accept(msg_header_t const *header);
#endif

#define msg_accept_p(h) msg_is_accept((h))

/**Duplicate (deep copy) #msg_accept_t.
 * 
 * The function msg_accept_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
 * 
 *   accept = msg_accept_dup(home, msg->msg_accept);
 * 
 * @endcode
 * 
 * @return
 * The function msg_accept_dup() returns a pointer to the
 * newly duplicated #msg_accept_t header structure, or NULL
 * upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_accept_t *msg_accept_dup(su_home_t *home, 
				 msg_accept_t const *header);

#if SU_HAVE_INLINE
su_inline
msg_accept_t *msg_accept_dup(su_home_t *home, 
				 msg_accept_t const *header)
{
  return (msg_accept_t *)
    msg_header_dup_as(home, msg_accept_class, (msg_header_t const *)header); 
}
#endif


/**Copy an #msg_accept_t header structure.
 * 
 * The function msg_accept_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
 * 
 *   accept = msg_accept_copy(home, msg->msg_accept);
 * 
 * @endcode
 * 
 * @return
 * The function msg_accept_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_accept_t *msg_accept_copy(su_home_t *home, 
				  msg_accept_t const *header);

#if SU_HAVE_INLINE
su_inline
msg_accept_t *msg_accept_copy(su_home_t *home, 
				  msg_accept_t const *header)
{
  return (msg_accept_t *)
    msg_header_copy_as(home, msg_accept_class, (msg_header_t const *)header); 
}
#endif


/**Make a header structure #msg_accept_t.
 * 
 * The function msg_accept_make() makes a new #msg_accept_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 may be implemented as a macro calling
 * msg_header_make().
 * 
 * @return
 * The function msg_accept_make() returns a pointer to newly maked
 * #msg_accept_t header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline msg_accept_t *msg_accept_make(su_home_t *home, char const *s)
{
  return (msg_accept_t*)msg_header_make(home, msg_accept_class, s);
}
#else
msg_accept_t *msg_accept_make(su_home_t *home, char const *s);
#endif


/**Make a Accept header from formatting result.
 * 
 * The function msg_accept_format() makes a new Accept header object
 * using snprintf-formatted 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 may be implemented as a macro calling
 * msg_header_format().
 * 
 * @return
 * The function msg_accept_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_accept_t *msg_accept_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__format__ (printf, 2, 3)));

#if SU_HAVE_INLINE
su_inline msg_accept_t *msg_accept_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_accept_class, fmt, ap);
  va_end(ap);
 
  return (msg_accept_t*)h;
}
#endif

/** @} */

/* Declare internal prototypes for Accept-Charset header */

/**@addtogroup msg_accept_charset 
 * @{ 
 */

enum { 
  /** Hash of Accept-Charset header. @internal */
  msg_accept_charset_hash = 41803 
};

/** Parse a Accept-Charset header. @internal */
MSG_DLL msg_parse_f msg_accept_charset_d;

/** Print a Accept-Charset header. @internal */
MSG_DLL msg_print_f msg_accept_charset_e;

MSG_DLL msg_xtra_f msg_accept_charset_dup_xtra;
MSG_DLL msg_dup_f msg_accept_charset_dup_one;

/**Header class for Accept-Charset header.
 * 
 * The header class msg_accept_charset_class defines how a 
 * Accept-Charset header header is parsed and printed.  It also
 * contains methods used by message parser and other functions
 * to manipulate the #msg_accept_charset_t header structure.
 * 
 */
#ifndef msg_accept_charset_class
MSG_DLL extern msg_hclass_t msg_accept_charset_class[];
#endif

/**Initializer for an #msg_accept_charset_t structure.
 * 
 * A static msg_accept_charset_t structure must be initialized
 * with the MSG_ACCEPT_CHARSET_INIT() macro. For instance,
 * @code 
 * 
 *  msg_accept_charset_t msg_accept_charset = MSG_ACCEPT_CHARSET_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_ACCEPT_CHARSET_INIT() MSG_HDR_INIT(accept_charset)

/**Initialize an #msg_accept_charset_t structure.
 * 
 * An #msg_accept_charset_t structure can be initialized with the
 * msg_accept_charset_init() function/macro. For instance,
 * @code
 * 
 *  msg_accept_chars