core, lib, modules: restructured source code tree
[sip-router] / src / lib / kmi / tree.h
1 /*
2  * $Id: tree.h 4518 2008-07-28 15:39:28Z henningw $
3  *
4  * Copyright (C) 2006 Voice Sistem SRL
5  *
6  * This file is part of Kamailio, a free SIP server.
7  *
8  * Kamailio is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * Kamailio is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21  *
22  *
23  * History:
24  * ---------
25  *  2006-09-08  first version (bogdan)
26  *  2010-08-18  use mi types from ../../mi/mi_types.h (andrei)
27  */
28
29 /*!
30  * \file 
31  * \brief MI :: Tree
32  * \ingroup mi
33  */
34
35
36
37
38 #ifndef _MI_TREE_H
39 #define _MI_TREE_H
40
41 #include <stdarg.h>
42 #include "../../str.h"
43 #include "../../mi/mi_types.h"
44
45 struct mi_node;
46 struct mi_handler;
47
48 #include "attr.h"
49
50 #define MI_DUP_NAME   (1<<0)
51 #define MI_DUP_VALUE  (1<<1)
52
53 #define MI_OK_S              "OK"
54 #define MI_OK_LEN            (sizeof(MI_OK_S)-1)
55 #define MI_INTERNAL_ERR_S    "Server Internal Error"
56 #define MI_INTERNAL_ERR_LEN  (sizeof(MI_INTERNAL_ERR_S)-1)
57 #define MI_MISSING_PARM_S    "Too few or too many arguments"
58 #define MI_MISSING_PARM_LEN  (sizeof(MI_MISSING_PARM_S)-1)
59 #define MI_BAD_PARM_S        "Bad parameter"
60 #define MI_BAD_PARM_LEN      (sizeof(MI_BAD_PARM_S)-1)
61
62 #define MI_SSTR(_s)           _s,(sizeof(_s)-1)
63 #define MI_OK                 MI_OK_S
64 #define MI_INTERNAL_ERR       MI_INTERNAL_ERR_S
65 #define MI_MISSING_PARM       MI_MISSING_PARM_S
66 #define MI_BAD_PARM           MI_BAD_PARM_S
67
68
69
70 struct mi_root *init_mi_tree(unsigned int code, char *reason, int reason_len);
71
72 void free_mi_tree(struct mi_root *parent);
73
74 struct mi_node *add_mi_node_sibling(struct mi_node *brother, int flags,
75         char *name, int name_len, char *value, int value_len);
76
77 struct mi_node *addf_mi_node_sibling(struct mi_node *brother, int flags,
78         char *name, int name_len, char *fmt_val, ...);
79
80 struct mi_node *add_mi_node_child(struct mi_node *parent, int flags,
81         char *name, int name_len, char *value, int value_len);
82
83 struct mi_node *addf_mi_node_child(struct mi_node *parent, int flags,
84         char *name, int name_len, char *fmt_val, ...);
85
86 struct mi_root* clone_mi_tree(struct mi_root *org, int shm);
87
88 void free_shm_mi_tree(struct mi_root *parent);
89
90 #endif
91