jas_tvp.h Source File

jas_tvp.h
1 /*
2 * Copyright (c) 2001-2002 Michael David Adams.
3 * All rights reserved.
4 */
5
6 /* __START_OF_JASPER_LICENSE__
7 *
8 * JasPer License Version 2.0
9 *
10 * Copyright (c) 2001-2006 Michael David Adams
11 * Copyright (c) 1999-2000 Image Power, Inc.
12 * Copyright (c) 1999-2000 The University of British Columbia
13 *
14 * All rights reserved.
15 *
16 * Permission is hereby granted, free of charge, to any person (the
17 * "User") obtaining a copy of this software and associated documentation
18 * files (the "Software"), to deal in the Software without restriction,
19 * including without limitation the rights to use, copy, modify, merge,
20 * publish, distribute, and/or sell copies of the Software, and to permit
21 * persons to whom the Software is furnished to do so, subject to the
22 * following conditions:
23 *
24 * 1. The above copyright notices and this permission notice (which
25 * includes the disclaimer below) shall be included in all copies or
26 * substantial portions of the Software.
27 *
28 * 2. The name of a copyright holder shall not be used to endorse or
29 * promote products derived from the Software without specific prior
30 * written permission.
31 *
32 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
33 * LICENSE. NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
34 * THIS DISCLAIMER. THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
35 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
36 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
37 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO
38 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
39 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
40 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
41 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
42 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. NO ASSURANCES ARE
43 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
44 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
45 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
46 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
47 * PROPERTY RIGHTS OR OTHERWISE. AS A CONDITION TO EXERCISING THE RIGHTS
48 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
49 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY. THE SOFTWARE
50 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
51 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
52 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
53 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
54 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
55 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
56 * RISK ACTIVITIES"). THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
57 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
58 *
59 * __END_OF_JASPER_LICENSE__
60 */
61
62 /*
63 * Tag/Value Parser
64 *
65 * $Id$
66 */
67
68 #ifndef JAS_TVP_H
69 #define JAS_TVP_H
70
71 /******************************************************************************\
72 * Includes.
73 \******************************************************************************/
74
75 /* The configuration header file should be included first. */
76 #include <jasper/jas_config.h>
77
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81
82 /******************************************************************************\
83 * Types.
84 \******************************************************************************/
85
86 /* Tag information type. */
87
88 typedef struct {
89
90 int id;
91 /* The ID for the tag. */
92
93 char *name;
94 /* The name of the tag. */
95
96 } jas_taginfo_t;
97
98 /* Tag-value parser type. */
99
100 typedef struct {
101
102 char *buf;
103 /* The parsing buffer. */
104
105 char *tag;
106 /* The current tag name. */
107
108 char *val;
109 /* The current value. */
110
111 char *pos;
112 /* The current position in the parsing buffer. */
113
114 } jas_tvparser_t;
115
116 /******************************************************************************\
117 * Tag information functions.
118 \******************************************************************************/
119
120 /* Lookup a tag by name. */
121 JAS_DLLEXPORT jas_taginfo_t *jas_taginfos_lookup(jas_taginfo_t *taginfos, const char *name);
122
123 /* This function returns a pointer to the specified taginfo object if it
124 exists (i.e., the pointer is nonnull); otherwise, a pointer to a dummy
125 object is returned. This is useful in some situations to avoid checking
126 for a null pointer. */
127 JAS_DLLEXPORT jas_taginfo_t *jas_taginfo_nonull(jas_taginfo_t *taginfo);
128
129 /******************************************************************************\
130 * Tag-value parser functions.
131 \******************************************************************************/
132
133 /* Create a tag-value parser for the specified string. */
134 JAS_DLLEXPORT jas_tvparser_t *jas_tvparser_create(const char *s);
135
136 /* Destroy a tag-value parser. */
137 JAS_DLLEXPORT void jas_tvparser_destroy(jas_tvparser_t *tvparser);
138
139 /* Get the next tag-value pair. */
140 JAS_DLLEXPORT int jas_tvparser_next(jas_tvparser_t *tvparser);
141
142 /* Get the tag name for the current tag-value pair. */
143 JAS_DLLEXPORT char *jas_tvparser_gettag(jas_tvparser_t *tvparser);
144
145 /* Get the value for the current tag-value pair. */
146 JAS_DLLEXPORT char *jas_tvparser_getval(jas_tvparser_t *tvparser);
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif