http_protos.h.in 8.58 KB
Newer Older
1 2 3 4 5 6
/** -*- C -*-
 * @file http_protos.h.in
 *
 * Template for <http_protos.h>.
 */

Pekka Pessi's avatar
Pekka Pessi committed
7 8 9 10 11 12 13
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
14
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 * 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 HTTP_PROTOS_H  /** Defined when http_protos.h has been included. */
Pekka Pessi's avatar
Pekka Pessi committed
32
#define HTTP_PROTOS_H
Pekka Pessi's avatar
Pekka Pessi committed
33 34 35 36 37 38 39 40 41
/**@file http_protos.h 
 *
 * Macros for each HTTP header.
 *
 * #AUTO#
 * 
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 */

42
#include <sofia-sip/su_config.h>
Pekka Pessi's avatar
Pekka Pessi committed
43 44

#ifndef HTTP_HEADER_H
45
#include <sofia-sip/http_header.h>
Pekka Pessi's avatar
Pekka Pessi committed
46 47
#endif
#ifndef HTTP_HCLASSES_H
48
#include <sofia-sip/http_hclasses.h>
Pekka Pessi's avatar
Pekka Pessi committed
49 50 51 52 53 54
#endif

#define http_header_make(h, c, s) \
  ((http_header_t *)msg_header_make((h), (c), (s)))
#define http_header_vformat(h, c, f, a) \
  ((http_header_t *)msg_header_vformat((h), (c), (f), (a)))
55
SOFIA_BEGIN_DECLS
Pekka Pessi's avatar
Pekka Pessi committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306

/* Declare internal prototypes for #xxxxxxx_xxxxxxx# */

/**@addtogroup http_#xxxxxx#*/ /** @{ */

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

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

#ifndef HTTP_HCLASSES_ONLY

/** Decode (parse) a #xxxxxxx_xxxxxxx#. @internal */
msg_parse_f http_#xxxxxx#_d;

/** Encode (print) a #xxxxxxx_xxxxxxx#. @internal */
msg_print_f http_#xxxxxx#_e;

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

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

/**Test if header object is instance of http_#xxxxxx#_t.
 * 
 * The function http_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 http_is_x#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 http_is_#xxxxxx#(http_header_t const *header)
{
  return header && header->sh_class->hc_hash == http_#xxxxxx#_hash;
}
#else
#define http_is_#xxxxxx#(h) \
 ((h) && ((msg_common_t *)(h))->h_class->hc_hash == http_#xxxxxx#_hash)
#endif

/**Duplicate (deep copy) @c http_#xxxxxx#_t.
 * 
 * The function http_#xxxxxx#_dup() duplicates a header
 * structure @a hdr.  If the header structure @a hdr
 * contains a reference (@c hdr->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 hdr   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# = http_#xxxxxx#_dup(home, http->http_#xxxxxx#);
 * 
 * @endcode
 * 
 * @return
 * The function http_#xxxxxx#_dup() returns a pointer to the
 * newly duplicated http_#xxxxxx#_t header structure, or NULL
 * upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
http_#xxxxxx#_t *http_#xxxxxx#_dup(su_home_t *home, 
				   http_#xxxxxx#_t const *hdr)
     __attribute__((__malloc__));

/**Copy a http_#xxxxxx#_t header structure.
 * 
 * The function http_#xxxxxx#_copy() copies a header structure @a
 * hdr.  If the header structure @a hdr contains a reference (@c
 * hdr->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 hdr.
 * 
 * @param home    memory home used to allocate new structure
 * @param hdr     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# = http_#xxxxxx#_copy(home, http->http_#xxxxxx#);
 * 
 * @endcode
 * 
 * @return
 * The function http_#xxxxxx#_copy() returns a pointer to
 * newly copied header structure, or NULL upon an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
http_#xxxxxx#_t *http_#xxxxxx#_copy(su_home_t *home, 
				    http_#xxxxxx#_t const *hdr)
     __attribute__((__malloc__));

/**Make a header structure http_#xxxxxx#_t.
 * 
 * The function http_#xxxxxx#_make() makes a new
 * http_#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
 * http_header_make().
 * 
 * @return
 * The function http_#xxxxxx#_make() returns a pointer to
 * newly maked http_#xxxxxx#_t header structure, or NULL upon
 * an error.
 */
#if SU_HAVE_INLINE
su_inline
#endif
http_#xxxxxx#_t *http_#xxxxxx#_make(su_home_t *home, char const *s)
     __attribute__((__malloc__));

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


/* Inlined functions */
#if SU_HAVE_INLINE
su_inline
http_#xxxxxx#_t *http_#xxxxxx#_format(su_home_t *home, char const *fmt, ...)
{
  http_header_t *h;
  va_list ap;
  
  va_start(ap, fmt);
  h = http_header_vformat(home, http_#xxxxxx#_class, fmt, ap);
  va_end(ap);
 
  return (http_#xxxxxx#_t *)h;
}

su_inline
http_#xxxxxx#_t *http_#xxxxxx#_dup(su_home_t *home, http_#xxxxxx#_t const *o) 
{ 
  return (http_#xxxxxx#_t *)
    msg_header_dup_as(home, http_#xxxxxx#_class, (msg_header_t const *)o);
}

su_inline
http_#xxxxxx#_t *http_#xxxxxx#_copy(su_home_t *home, http_#xxxxxx#_t const *o) 
{ 
  return (http_#xxxxxx#_t *)
    msg_header_copy_as(home, http_#xxxxxx#_class, (msg_header_t const *)o); 
}

su_inline 
http_#xxxxxx#_t *http_#xxxxxx#_make(su_home_t *home, char const *s)
{
  return (http_#xxxxxx#_t *)http_header_make(home, http_#xxxxxx#_class, s);
}
#endif

#endif /* !define HTTP_HCLASSES_ONLY */

/** @} */


307
SOFIA_END_DECLS
Pekka Pessi's avatar
Pekka Pessi committed
308
#endif /* !defined(HTTP_PROTOS_H) */