/usr/include/kannel/gwlib/parse.h is in kannel-dev 1.4.4-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | /* ====================================================================
* The Kannel Software License, Version 1.0
*
* Copyright (c) 2001-2014 Kannel Group
* Copyright (c) 1998-2001 WapIT Ltd.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Kannel Group (http://www.kannel.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Kannel" and "Kannel Group" must not be used to
* endorse or promote products derived from this software without
* prior written permission. For written permission, please
* contact org@kannel.org.
*
* 5. Products derived from this software may not be called "Kannel",
* nor may "Kannel" appear in their name, without prior written
* permission of the Kannel Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Kannel Group. For more information on
* the Kannel Group, please see <http://www.kannel.org/>.
*
* Portions of this software are based upon software originally written at
* WapIT Ltd., Helsinki, Finland for the Kannel project.
*/
/*
* parse.h - functions for octet-by-octet parsing of an octstr
*
* Interface to keep track of position in an octstr, and remember
* error conditions so that they can be checked after a bunch of
* calls. Also allows temporary clipping of the string, so that
* parsing doesn't go past a boundary until it's explicitly allowed
* to. This helps parse strings containing length-defined chunks.
*
* The main use of this interface is to simplify code that does
* this kind of parsing, so that it can pass around a single
* ParseContext value instead of an octstr and one or more offset
* and length parameters.
*
* Note: The octstr involved MUST NOT change during parsing.
*
* Richard Braakman
*/
#ifndef PARSE_H
#define PARSE_H
typedef struct context ParseContext;
/*
* Return a ParseContext object for this octstr, with parsing starting
* at position 0 and the limit at the end of the string.
*/
ParseContext *parse_context_create(Octstr *str);
/*
* Destroy a ParseContext object. Note that this does not free the string
* that was parsed.
*/
void parse_context_destroy(ParseContext *context);
/*
* Return -1 if any error has occurred during parsing, otherwise 0.
*/
int parse_error(ParseContext *context);
/*
* Clear the error flag for the next call to parse_error.
*/
void parse_clear_error(ParseContext *context);
/*
* Set the error flag.
*/
void parse_set_error(ParseContext *context);
/*
* Set a new "end" of the string, for parsing purposes, at length
* octets from the current position. Return 0 if it's okay.
* If it doesn't fit in the current limit, don't do anything and
* return -1.
*/
int parse_limit(ParseContext *context, long length);
/*
* Restore the previous "end" of the string. Limits can be stacked
* as deeply as needed. The original limit (end-of-string) can
* not be popped. Return -1 and set the error flag if there was
* nothing to pop, otherwise return 0.
*/
int parse_pop_limit(ParseContext *context);
/*
* Return the number of octets between the current position and
* the current limit.
*/
long parse_octets_left(ParseContext *context);
/*
* Skip count octets. If that would go past the limit, return -1,
* skip to the limit, and set the error flag. Otherwise return 0.
*/
int parse_skip(ParseContext *context, long count);
/*
* Skip to the current limit. Cannot fail.
*/
void parse_skip_to_limit(ParseContext *context);
/*
* Set offset to new position. If that would go past the limit, return
* -1, skip to the limit, and set the error flag. Otherwise return 0.
*/
int parse_skip_to(ParseContext *context, long pos);
/*
* Return the next octet, but do not skip over it.
* If already at the limit, return -1 and set the error flag.
*/
int parse_peek_char(ParseContext *context);
/*
* Return the next octet and skip one position forward.
* If already at the limit, return -1 and set the error flag.
*/
int parse_get_char(ParseContext *context);
/*
* Return "length" octets starting at current position, and skip
* that many octets forward. If that would go over the limit,
* return NULL, do not skip, and set the error flag.
*/
Octstr *parse_get_octets(ParseContext *context, long length);
/*
* Return the value of an uintvar-encoded integer at current
* position, then skip over it. If there's an error in the
* encoding, or if it would go past the limit, then return 0,
* do not skip, and set the error flag. Since 0 is a valid
* uintvar value, the error flag is only way to detect this error.
*/
unsigned long parse_get_uintvar(ParseContext *context);
/*
* Look for a NUL-terminated string starting at the current offset,
* and return it (without the NUL) as an Octstr. Skip forward past
* the NUL. If there is no NUL, return NULL and set the error flag.
*/
Octstr *parse_get_nul_string(ParseContext *context);
/*
* Look for a EOL-terminated line starting at the current offset,
* and return it (without the EOL) as an Octstr. Skip forward past
* the EOL. If there is no EOL, return NULL and set the error flag.
*/
Octstr *parse_get_line(ParseContext *context);
/*
* Look for an Octstr block that is between two seperators defined by
* the seperator Octstr. Return the Octstr between the seperators and
* move the parsing context up before the last of the two seperators.
* So the last seperator is next in the parsing scope. If there are
* no two seperators in the parsing scope return NULL.
*/
Octstr *parse_get_seperated_block(ParseContext *context, Octstr *seperator);
/*
* Return unparsed content. This should be used only after all
* headers are parsed (and the headers and content are stored in
* same octstr).
*/
Octstr *parse_get_rest(ParseContext *context);
#endif
|