jas_tvp.h (5316B)
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) 1999-2000 Image Power, Inc. 11 * Copyright (c) 1999-2000 The University of British Columbia 12 * Copyright (c) 2001-2003 Michael David Adams 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: jas_tvp.h 1918 2005-07-24 14:12:08Z baford $ 66 */ 67 68 #ifndef JAS_TVP_H 69 #define JAS_TVP_H 70 71 /******************************************************************************\ 72 * Includes. 73 \******************************************************************************/ 74 75 #include <jasper/jas_config.h> 76 77 #ifdef __cplusplus 78 extern "C" { 79 #endif 80 81 /******************************************************************************\ 82 * Types. 83 \******************************************************************************/ 84 85 /* Tag information type. */ 86 87 typedef struct { 88 89 int id; 90 /* The ID for the tag. */ 91 92 char *name; 93 /* The name of the tag. */ 94 95 } jas_taginfo_t; 96 97 /* Tag-value parser type. */ 98 99 typedef struct { 100 101 char *buf; 102 /* The parsing buffer. */ 103 104 char *tag; 105 /* The current tag name. */ 106 107 char *val; 108 /* The current value. */ 109 110 char *pos; 111 /* The current position in the parsing buffer. */ 112 113 } jas_tvparser_t; 114 115 /******************************************************************************\ 116 * Tag information functions. 117 \******************************************************************************/ 118 119 /* Lookup a tag by name. */ 120 jas_taginfo_t *jas_taginfos_lookup(jas_taginfo_t *taginfos, const char *name); 121 122 /* This function returns a pointer to the specified taginfo object if it 123 exists (i.e., the pointer is nonnull); otherwise, a pointer to a dummy 124 object is returned. This is useful in some situations to avoid checking 125 for a null pointer. */ 126 jas_taginfo_t *jas_taginfo_nonull(jas_taginfo_t *taginfo); 127 128 /******************************************************************************\ 129 * Tag-value parser functions. 130 \******************************************************************************/ 131 132 /* Create a tag-value parser for the specified string. */ 133 jas_tvparser_t *jas_tvparser_create(const char *s); 134 135 /* Destroy a tag-value parser. */ 136 void jas_tvparser_destroy(jas_tvparser_t *tvparser); 137 138 /* Get the next tag-value pair. */ 139 int jas_tvparser_next(jas_tvparser_t *tvparser); 140 141 /* Get the tag name for the current tag-value pair. */ 142 char *jas_tvparser_gettag(jas_tvparser_t *tvparser); 143 144 /* Get the value for the current tag-value pair. */ 145 char *jas_tvparser_getval(jas_tvparser_t *tvparser); 146 147 #ifdef __cplusplus 148 } 149 #endif 150 151 #endif