parser/parse_param.h
420b6bb0
 /* 
  * $Id$
  *
  * Generic Parameter Parser
  *
c32feee5
  * Copyright (C) 2001-2003 FhG Fokus
420b6bb0
  *
  * This file is part of ser, a free SIP server.
  *
  * ser is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
  * For a license to use the ser software under conditions
  * other than those described here, or to purchase support for this
  * software, please contact iptel.org by e-mail at the following addresses:
  *    info@iptel.org
  *
  * ser 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 General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License 
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  * History:
  * -------
  * 2003-03-24 Created by janakj
ed49bd28
  * 2003-04-07 shm duplication support (janakj)
  * 2003-04-07 URI class added (janakj)
420b6bb0
  */
 
1eb01c66
 /*! \file
  * \brief Parser :: Generic Parameter Parser
  *
  * \ingroup parser
  */
 
 
420b6bb0
 #ifndef PARSE_PARAM_H
 #define PARSE_PARAM_H
 
1c6135b6
 #include <stdio.h>
 
420b6bb0
 
1eb01c66
 /*! \brief
420b6bb0
  * Supported types of parameters
  */
 typedef enum ptype {
1eb01c66
 	P_OTHER = 0, /*!< Unknown parameter */
 	P_Q,         /*!< Contact: q parameter */
 	P_EXPIRES,   /*!< Contact: expires parameter */
 	P_METHODS,   /*!< Contact: methods parameter */
 	P_RECEIVED,  /*!< Contact: received parameter */
 	P_TRANSPORT, /*!< URI: transport parameter */
 	P_LR,        /*!< URI: lr parameter */
 	P_R2,        /*!< URI: r2 parameter (ser specific) */
 	P_MADDR,     /*!< URI: maddr parameter */
 	P_TTL,       /*!< URI: ttl parameter */
 	P_DSTIP,     /*!< URI: dstip parameter */
 	P_DSTPORT,   /*!< URi: dstport parameter */
 	P_INSTANCE,  /*!< Contact: sip.instance parameter */
 	P_FTAG,      /*!< URI: ftag parameter */
 	P_CALL_ID,   /*!< Dialog event package: call-id */
 	P_FROM_TAG,  /*!< Dialog event package: from-tag */
 	P_TO_TAG,    /*!< Dialog event package: to-tag */
 	P_ISD,       /*!< Dialog event package: include-session-description */
8791fc81
 	P_SLA,       /*!< Dialog event package: sla */
 	P_MA         /*!< Dialog event package: ma */
420b6bb0
 } ptype_t;
 
 
1eb01c66
 /*! \brief
420b6bb0
  * Class of parameters
  */
 typedef enum pclass {
1eb01c66
 	CLASS_ANY = 0,      /*!< Any parameters, well-known hooks will be not used */
 	CLASS_CONTACT,      /*!< Contact parameters */
 	CLASS_URI,          /*!< URI parameters */
 	CLASS_EVENT_DIALOG  /*!< Event dialog parameters */
420b6bb0
 } pclass_t;
 
 
1eb01c66
 /*! \brief
420b6bb0
  * Structure representing a parameter
  */
 typedef struct param {
1eb01c66
 	ptype_t type;         /*!< Type of the parameter */
 	str name;             /*!< Parameter name */
 	str body;             /*!< Parameter body */
 	int len;              /*!< Total length of the parameter including = and quotes */
 	struct param* next;   /*!< Next parameter in the list */
420b6bb0
 } param_t;
 
 
1eb01c66
 /*! \brief
420b6bb0
  * Hooks to well known parameters for contact class of parameters
  */
 struct contact_hooks {
1eb01c66
 	struct param* expires;  /*!< expires parameter */
 	struct param* q;        /*!< q parameter */
 	struct param* methods;  /*!< methods parameter */
 	struct param* received; /*!< received parameter */
 	struct param* instance; /*!< sip.instance parameter */
420b6bb0
 };
 
 
1eb01c66
 /*! \brief
ed49bd28
  * Hooks to well known parameter for URI class of parameters
  */
 struct uri_hooks {
1eb01c66
 	struct param* transport; /*!< transport parameter */
 	struct param* lr;        /*!< lr parameter */
 	struct param* r2;        /*!< r2 parameter */
 	struct param* maddr;     /*!< maddr parameter */
 	struct param* ttl;       /*!< ttl parameter */
 	struct param* dstip;     /*!< Destination IP */
 	struct param* dstport;   /*!< Destination port */
 	struct param* ftag;      /*!< From tag in the original request */
ed49bd28
 };
 
 
2eb780d7
 struct event_dialog_hooks {
 	struct param* call_id;
 	struct param* from_tag;
 	struct param* to_tag;
 	struct param* include_session_description;
 	struct param* sla;
3f8b07ca
 	struct param* ma;
2eb780d7
 };
 
1eb01c66
 /*! \brief
420b6bb0
  * Union of hooks structures for all classes
  */
 typedef union param_hooks {
1eb01c66
 	struct contact_hooks contact; /*!< Contact hooks */
 	struct uri_hooks uri;         /*!< URI hooks */
2eb780d7
 	struct event_dialog_hooks event_dialog;
420b6bb0
 } param_hooks_t;
 
1eb01c66
 /*! \brief
c91680f4
  * Only parse one parameter
  * @Return:
  * 	t: out parameter
  * 	-1: on error
  * 	0: success, but expect a next paramter
  * 	1: success and exepect no more parameters
  */
 inline int parse_param(str *_s, pclass_t _c, param_hooks_t *_h, param_t *t);
 
420b6bb0
 
1eb01c66
 /*! \brief
420b6bb0
  * Parse parameters
1eb01c66
  *  \param _s is string containing parameters
  *  \param _c is class of parameters
  *  \param _h is pointer to structure that will be filled with pointer to well known parameters
420b6bb0
  * linked list of parsed parameters will be stored in
  * the variable _p is pointing to
1eb01c66
  * \return The function returns 0 on success and negative number
420b6bb0
  * on an error
  */
 int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p);
 
 
1eb01c66
 /*! \brief
420b6bb0
  * Free linked list of parameters
  */
 void free_params(param_t* _p);
 
 
1eb01c66
 /*! \brief
91804f9b
  * Free linked list of parameters from shared memory
  */
 void shm_free_params(param_t* _p);
 
 
1eb01c66
 /*! \brief
420b6bb0
  * Print linked list of parameters, just for debugging
  */
1c6135b6
 void print_params(FILE* _o, param_t* _p);
420b6bb0
 
 
1eb01c66
 /*! \brief
5d17eb17
  * Duplicate linked list of parameters
  */
 int duplicate_params(param_t** _n, param_t* _p);
 
 
1eb01c66
 /*! \brief
91804f9b
  * Duplicate linked list of parameters
  */
 int shm_duplicate_params(param_t** _n, param_t* _p);
 
 
420b6bb0
 #endif /* PARSE_PARAM_H */