/usr/include/jaula/jaula_parse.h is in libjaula-dev 1.4.0-3ubuntu1.
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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | /*
* jaula_parse.h : JSON Analysis User Library Acronym
* JSON data parser
*
* Copyright (C) 2007, 2008, 2009 Kombo Morongo <morongo666@gmail.com>
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or (at
* your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*
* svn info:
* $Author: morongo $
* $HeadURL: https://jaula.svn.sourceforge.net/svnroot/jaula/tags/jaula-1.4.0/jaula/jaula_parse.h $
* $Id: jaula_parse.h 45 2009-01-11 16:17:03Z morongo $
* $Revision: 45 $
*/
#ifndef _JAULA_PARSE_H_
#define _JAULA_PARSE_H_
/**
* \addtogroup jaula_parse JAULA: JSON data parser
*/
#include <jaula/jaula_lexan.h>
#include <jaula/jaula_syntax_error.h>
#include <jaula/jaula_value_complex.h>
namespace JAULA
{ // namespace JAULA
/**
* \brief JSON Data Parser
*
* \ingroup jaula_parse
*
* \par
* This class implements the JSON parser itself as specified by RFC 4627.
*
* \author Kombo Morongo <morongo666@gmail.com>
*/
class Parser
{ // class Parser
public:
/**
* \brief Constructor
*/
Parser(void);
/**
* \brief Destructor
*/
~Parser(void);
/**
* \brief Parses JSON data from a stream
*
* \param inpStream stream from where to read the data to parse.
*
* \param comments_allowed flag that if it is true means that the input
* can contain comments that begin with the hash '#' symbol and ends
* with eoln (as in bash).
* If it is false, it means that no comments are allowed in the input
* and if present will be considered as a syntax error.
*
* \param full_read flag that if it is true means that the parser must
* analyze the input stream until the end of file is although it already
* had got a full array or object from it.
* In this situation, as JSON specification expects just only one array
* or object per input, any further data that is not a space for the
* syntax (or a comment if comments are allowed) will launch a syntax
* error exception.
*
* \par
* If this flag is false, the parser will stop once a full array or
* object is taken from the input and, on exit, the stream will point to
* the start of the remaining data.
*
* \returns a pointer to memory taken from the heap containing a complex
* value (array or object) with all the data from the stream parsed on
* individual / nested items.
*
* \exception Exception
* An exception will be thrown as soon as a lexical or syntax error is
* found analyzing the stream.
* The result of printing the exception through a stream is a human
* readable text explaining the error found and an approximation of the
* error line where occurred.
*
* \par Description
* This method is the entry point for the JSON parser.
*
* \warning
* As this method returns a pointer to memory from the heap, it is up to
* the user to free it when it is no longer needed in order to avoid
* leaks.
*/
static Value_Complex *parseStream(std::istream &inpStream
, bool comments_allowed = false
, bool full_read = true
) throw(Exception);
private:
/**
* \brief JSON Value Parser
*
* \ingroup jaula_parse
*
* \par
* Parses a value from the input stream.
*
* \author Kombo Morongo <morongo666@gmail.com>
*/
class Value_Parser
{ // class Value_Parser
public:
/**
* \brief Constructor
*/
Value_Parser(void);
/**
* \brief Destructor
*/
~Value_Parser(void);
/**
* \brief reads a single JSON value
*
* \param lexan Reference to the lexical analysis instance that
* reads from the input.
*
* \param token Token read from the upper level.
* * If this token does not belong to an starting value token, an
* error condition will arise.
*
* \returns a pointer to memory taken from the heap containing the
* value read.
* If this value belongs to a complex type, all the items that it
* contains have been recursively parsed.
*
* \exception Exception
* An exception will be thrown as soon as a lexical or syntax error
* is found analyzing the stream. The result of printing the
* exception retrurned through a stream is a human readable text
* explaining the error found and an approximation of the error line
* where it occurred.
*
* \par Description
* This method fully reads a whole value from the input or until a
* syntax or lexical error is found. Upon execution input stream is
* positioned so that a new token or EOF can be read from the input.
*/
static Value *parseValue(Lexan &lexan, unsigned int token)
throw(Exception);
private:
/**
* \brief Enumeration for the parser state machine
*
* \par Description
* This type defines a constant for each state that the parser may
* assume during the process.
*/
enum parser_states
{
/** initial state */
START,
/** a new item for an array has been read */
array_addItem,
/** an inter-item delimiter for an array has been read */
array_nextItem,
/** error condition detected
* (pseudostate that launches an exception terminating the
* process)
*/
error,
/** a boolean false value constant has been read (pseudostate) */
false_value,
/** a null value constant has been read (pseudostate) */
null_value,
/** a numeric (integer) value has been read (pseudostate) */
number_int_value,
/** a numeric (float) value has been read (pseudostate) */
number_value,
/** an object initial delimiter has been read */
property_begin,
/** an object property name has been read */
property_name,
/** an object property delimiter has been read */
property_value,
/** an inter-property delimiter for an object has been read */
property_next,
/** a string value has been read (pseudostate) */
string_value,
/** a boolean true value constant has been read (pseudostate) */
true_value,
/** final state (pseudostate) */
END
}; //enum parser_states
/**
* \brief Analyzes the reason for an EOF condition
*
* \param lexan Reference to the lexical analysis instance that
* reads from the input.
*
* \param ex Syntax error to be thrown detailing why an EOF at this
* point is an error.
*
* \exception Exception
* As a result of the execution of this method an exception is
* thrown with the data conatined in the input parameter or with a
* JAULA::LEXAN_ERROR type if the EOF is due to an error in the
* lexical analysis phase.
*
* \par Description
* This method is to be launched whenever an unexpected end of file
* is encountered.
* Its implementation includes analyzing if the EOF condition is
* real or a side effect from a lexical analysis error and chooses
* to send the Lexan::LexerError Exception or the one received in
* the input parameter based on this.
*/
static void EOFError(Lexan &lexan, Syntax_Error const &ex)
throw(Exception);
}; // class Value_Parser
}; // class Parser
} // namespace JAULA
#endif
// EOF $Id: jaula_parse.h 45 2009-01-11 16:17:03Z morongo $
|