Kannel: Open Source WAP and SMS gateway  $Revision: 5037 $
wsp_strings.h
Go to the documentation of this file.
1 /* ====================================================================
2  * The Kannel Software License, Version 1.0
3  *
4  * Copyright (c) 2001-2016 Kannel Group
5  * Copyright (c) 1998-2001 WapIT Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Kannel Group (http://www.kannel.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Kannel" and "Kannel Group" must not be used to
28  * endorse or promote products derived from this software without
29  * prior written permission. For written permission, please
30  * contact org@kannel.org.
31  *
32  * 5. Products derived from this software may not be called "Kannel",
33  * nor may "Kannel" appear in their name, without prior written
34  * permission of the Kannel Group.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
40  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
41  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
42  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
43  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
44  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
45  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
46  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Kannel Group. For more information on
51  * the Kannel Group, please see <http://www.kannel.org/>.
52  *
53  * Portions of this software are based upon software originally written at
54  * WapIT Ltd., Helsinki, Finland for the Kannel project.
55  */
56 
57 /* wsp-strings.h: interface to tables defined by WSP standard
58  *
59  * This file defines an interface to the Assigned Numbers tables
60  * in appendix A of the WSP specification. For each supported
61  * table there is a function to convert from number to string and
62  * a function to convert from string to number.
63  *
64  * The tables are in wsp-strings.def, in a special format suitable for
65  * use with the C preprocessor, which we abuse liberally to get the
66  * interface we want.
67  *
68  * For a table named foo, these functions will be declared:
69  *
70  * Octstr *wsp_foo_to_string(long number);
71  * - return NULL if the number has no assigned string.
72  *
73  * unsigned char *wsp_foo_to_cstr(long number);
74  * - return NULL if the number has no assigned string.
75  *
76  * long wsp_string_to_foo(Octstr *ostr);
77  * - case-insensitive lookup.
78  * - Return -1 if the string has no assigned number.
79  *
80  * Richard Braakman
81  */
82 
83 #ifndef WSP_STRINGS_H
84 #define WSP_STRINGS_H
85 
86 #include "gwlib/gwlib.h"
87 #include "wap/wsp.h"
88 
89 /* Must be called before any of the other functions in this file.
90  * Can be called more than once, in which case multiple shutdowns
91  * are also required. */
92 void wsp_strings_init(void);
93 
94 /* Call this to clean up memory allocations */
95 void wsp_strings_shutdown(void);
96 
97 /* Declare the functions */
98 #define LINEAR(name, strings) \
99 Octstr *wsp_##name##_to_string(long number); \
100 unsigned char *wsp_##name##_to_cstr(long number); \
101 long wsp_string_to_##name(Octstr *ostr); \
102 long wsp_string_to_versioned_##name(Octstr *ostr, int version);
103 #define STRING(string)
104 #include "wsp_strings.def"
105 
106 /* Define the enumerated types */
107 #define LINEAR(name, strings)
108 #define STRING(string)
109 #define NAMED(name, strings) enum name##_enum { strings name##_dummy };
110 #define NSTRING(string, name) name,
111 #define VNSTRING(version, string, name) name,
112 #include "wsp_strings.def"
113 
114 #endif
void wsp_strings_init(void)
Definition: wsp_strings.c:269
void wsp_strings_shutdown(void)
Definition: wsp_strings.c:286
See file LICENSE for details about the license agreement for using, modifying, copying or deriving work from this software.