Contiki-NG
jsonparse.h
1 /*
2  * Copyright (c) 2011-2012, Swedish Institute of Computer Science.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  */
31 
32 #ifndef JSONPARSE_H_
33 #define JSONPARSE_H_
34 
35 #include "contiki.h"
36 #include "json.h"
37 
38 #ifdef JSONPARSE_CONF_MAX_DEPTH
39 #define JSONPARSE_MAX_DEPTH JSONPARSE_CONF_MAX_DEPTH
40 #else
41 #define JSONPARSE_MAX_DEPTH 10
42 #endif
43 
44 struct jsonparse_state {
45  const char *json;
46  int pos;
47  int len;
48  int depth;
49  /* for handling atomic values */
50  int vstart;
51  int vlen;
52  char vtype;
53  char error;
54  char stack[JSONPARSE_MAX_DEPTH];
55 };
56 
57 /**
58  * \brief Initialize a JSON parser state.
59  * \param state A pointer to a JSON parser state
60  * \param json The string to parse as JSON
61  * \param len The length of the string to parse
62  *
63  * This function initializes a JSON parser state for
64  * parsing a string as JSON.
65  */
66 void jsonparse_setup(struct jsonparse_state *state, const char *json,
67  int len);
68 
69 /* move to next JSON element */
70 int jsonparse_next(struct jsonparse_state *state);
71 
72 /* copy the current JSON value into the specified buffer */
73 int jsonparse_copy_value(struct jsonparse_state *state, char *buf,
74  int buf_size);
75 
76 /* get the current JSON value parsed as an int */
77 int jsonparse_get_value_as_int(struct jsonparse_state *state);
78 
79 /* get the current JSON value parsed as a long */
80 long jsonparse_get_value_as_long(struct jsonparse_state *state);
81 
82 /* get the length of the current JSON value */
83 int jsonparse_get_len(struct jsonparse_state *state);
84 
85 /* get the type of the current JSON value */
86 int jsonparse_get_type(struct jsonparse_state *state);
87 
88 /* compare the JSON value with the specified string */
89 int jsonparse_strcmp_value(struct jsonparse_state *state, const char *str);
90 
91 #endif /* JSONPARSE_H_ */
A few JSON defines used for parsing and generating JSON.