wsutil/wsjson.h

   1 /** @file
   2  *
   3  * JSON parsing functions.
   4  *
   5  * Copyright 2016, Dario Lombardo
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * SPDX-License-Identifier: GPL-2.0-or-later
  12  */
  13
  14 #ifndef __WSJSON_H__
  15 #define __WSJSON_H__
  16
  17 #include "ws_symbol_export.h"
  18
  19 #include <inttypes.h>
  20 #include <stdbool.h>
  21
  22 #include "jsmn.h"
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * Check if a buffer is json an returns true if it is.
  30  */
  31 WS_DLL_PUBLIC bool json_validate(const uint8_t *buf, const size_t len);
  32
  33 WS_DLL_PUBLIC int json_parse(const char *buf, jsmntok_t *tokens, unsigned int max_tokens);
  34
  35 /**
  36  * Get the pointer to an object belonging to parent object and named as the name variable.
  37  * Returns NULL if not found.
  38  */
  39 WS_DLL_PUBLIC jsmntok_t *json_get_object(const char *buf, jsmntok_t *parent, const char *name);
  40
  41 /**
  42  * Get the pointer to an array belonging to parent object and named as the name variable.
  43  * Returns NULL if not found.
  44  */
  45 WS_DLL_PUBLIC jsmntok_t *json_get_array(const char *buf, jsmntok_t *parent, const char *name);
  46
  47 /**
  48  * Get the number of elements of an array.
  49  * Returns -1 if the JSON objecct is not an array.
  50  */
  51 WS_DLL_PUBLIC int json_get_array_len(jsmntok_t *array);
  52
  53 /**
  54  * Get the pointer to idx element of an array.
  55  * Returns NULL if not found.
  56  */
  57 WS_DLL_PUBLIC jsmntok_t *json_get_array_index(jsmntok_t *parent, int idx);
  58
  59 /**
  60  * Get the unescaped value of a string object belonging to parent object and named as the name variable.
  61  * Returns NULL if not found. Caution: it modifies input buffer.
  62  */
  63 WS_DLL_PUBLIC char *json_get_string(char *buf, jsmntok_t *parent, const char *name);
  64
  65 /**
  66  * Get the value of a number object belonging to parent object and named as the name variable.
  67  * Returns false if not found. Caution: it modifies input buffer.
  68  * Scientific notation not supported yet.
  69  */
  70 WS_DLL_PUBLIC bool json_get_double(char *buf, jsmntok_t *parent, const char *name, double *val);
  71
  72 /**
  73  * Get the value of a boolean belonging to parent object and named as the name variable.
  74  * Returns false if not found. (Not the same as the boolean present but false.)
  75  */
  76 WS_DLL_PUBLIC bool json_get_boolean(char *buf, jsmntok_t *parent, const char *name, bool *val);
  77
  78 /**
  79  * Decode the contents of a JSON string value by overwriting the input data.
  80  * Returns true on success and false if invalid characters were encountered.
  81  */
  82 WS_DLL_PUBLIC bool json_decode_string_inplace(char *text);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif
  89
  90 /*
  91  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
  92  *
  93  * Local variables:
  94  * c-basic-offset: 4
  95  * tab-width: 8
  96  * indent-tabs-mode: nil
  97  * End:
  98  *
  99  * vi: set shiftwidth=4 tabstop=8 expandtab:
 100  * :indentSize=4:tabSize=8:noTabs=true:
 101  */