msg_mime_protos.h

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

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <[e-mail]>
 *
 * 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_MIME_PROTOS_H
/** Defined when <sofia-sip/msg_mime_protos.h> has been included. */
#define MSG_MIME_PROTOS_H 

/**@ingroup msg_mime
 * @file sofia-sip/msg_mime_protos.h
 *
 * Prototypes for MIME headers (@RFC2045).
 *
 * This file is automatically generated from <msg_mime.h> by msg_parser.awk.
 *
 * @author Pekka Pessi <[e-mail]>
 */

#ifndef MSG_PARSER_H
#include <sofia-sip/msg_parser.h>
#endif
#ifndef MSG_MIME_H
#include <sofia-sip/msg_mime.h>
#endif
#ifndef MSG_MCLASS_H
#include <sofia-sip/msg_mclass.h>
#endif
#ifndef MSG_MCLASS_H
#include <sofia-sip/msg_mclass.h>
#endif

SOFIA_BEGIN_DECLS

MSG_DLL extern msg_mclass_t const msg_multipart_mclass[1];

#define msg_multipart_class ((msg_hclass_t *)msg_multipart_mclass)


/* Declare internal prototypes for Content-Type header */

/**@addtogroup msg_content_type 
 * @{ 
 */

enum { 
  /** Hash of Content-Type header. @internal */
  msg_content_type_hash = 51226 
};

/** Parse a Content-Type header. @internal */
MSG_DLL msg_parse_f msg_content_type_d;

/** Print a Content-Type header. @internal */
MSG_DLL msg_print_f msg_content_type_e;

MSG_DLL msg_xtra_f msg_content_type_dup_xtra;
MSG_DLL msg_dup_f msg_content_type_dup_one;

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

/**Initializer for an #msg_content_type_t structure.
 * 
 * A static msg_content_type_t structure must be initialized
 * with the MSG_CONTENT_TYPE_INIT() macro. For instance,
 * @code 
 * 
 *  msg_content_type_t msg_content_type = MSG_CONTENT_TYPE_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_CONTENT_TYPE_INIT() MSG_HDR_INIT(content_type)

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

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

#define msg_content_type_p(h) msg_is_content_type((h))

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

#if SU_HAVE_INLINE
su_inline
msg_content_type_t *msg_content_type_dup(su_home_t *home, 
				 msg_content_type_t const *header)
{
  return (msg_content_type_t *)
    msg_header_dup_as(home, msg_content_type_class, (msg_header_t const *)header); 
}
#endif


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

#if SU_HAVE_INLINE
su_inline
msg_content_type_t *msg_content_type_copy(su_home_t *home, 
				  msg_content_type_t const *header)
{
  return (msg_content_type_t *)
    msg_header_copy_as(home, msg_content_type_class, (msg_header_t const *)header); 
}
#endif


/**Make a header structure #msg_content_type_t.
 * 
 * The function msg_content_type_make() makes a new #msg_content_type_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_type_make() returns a pointer to newly maked
 * #msg_content_type_t header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline msg_content_type_t *msg_content_type_make(su_home_t *home, char const *s)
{
  return (msg_content_type_t*)msg_header_make(home, msg_content_type_class, s);
}
#else
msg_content_type_t *msg_content_type_make(su_home_t *home, char const *s);
#endif


/**Make a Content-Type header from formatting result.
 * 
 * The function msg_content_type_format() makes a new Content-Type 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_type_format() returns a pointer to newly
 * makes header structure, or NULL upon an error.
 * 
 * @HIDE
 */
#if SU_HAVE_INLINE
su_inline
#endif
msg_content_type_t *msg_content_type_format(su_home_t *home, char const *fmt, ...)
     __attribute__((__format__ (printf, 2, 3)));

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

/** @} */

/* Declare internal prototypes for Content-Disposition header */

/**@addtogroup msg_content_disposition 
 * @{ 
 */

enum { 
  /** Hash of Content-Disposition header. @internal */
  msg_content_disposition_hash = 16333 
};

/** Parse a Content-Disposition header. @internal */
MSG_DLL msg_parse_f msg_content_disposition_d;

/** Print a Content-Disposition header. @internal */
MSG_DLL msg_print_f msg_content_disposition_e;

MSG_DLL msg_xtra_f msg_content_disposition_dup_xtra;
MSG_DLL msg_dup_f msg_content_disposition_dup_one;

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

/**Initializer for an #msg_content_disposition_t structure.
 * 
 * A static msg_content_disposition_t structure must be initialized
 * with the MSG_CONTENT_DISPOSITION_INIT() macro. For instance,
 * @code 
 * 
 *  msg_content_disposition_t msg_content_disposition = MSG_CONTENT_DISPOSITION_INIT;
 * 
 * @endcode
 * @HI
 */
#define MSG_CONTENT_DISPOSITION_INIT() MSG_HDR_INIT(content_disposition)

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

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

#define msg_content_disposition_p(h) msg_is_content_disposition((h))

/**Duplicate (deep copy) #msg_content_disposition_t.
 * 
 * The function msg_content_disposition_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
 * 
 *   content_disposition = msg_content_disposition_dup(home, msg->msg_content_disposition);
 * 
 * @endcode
 *