jsonpull.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Greenbone AG
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef _GVM_JSONPULL_H
#define _GVM_JSONPULL_H
 
#define _GNU_SOURCE
 
#include "json.h"
 
#include <glib.h>
#include <stdio.h>

typedef enum
{
  GVM_JSON_PULL_CONTAINER_NONE = 0, 
  GVM_JSON_PULL_CONTAINER_ARRAY,    
  GVM_JSON_PULL_CONTAINER_OBJECT,   
} gvm_json_pull_container_type_t;

typedef struct gvm_json_path_elem
{
  gvm_json_pull_container_type_t parent_type; 
  int index; 
  char *key; 
  int depth; 
} gvm_json_path_elem_t;

typedef enum
{
  GVM_JSON_PULL_EVENT_UNDEFINED = 0,
  GVM_JSON_PULL_EVENT_ARRAY_START,
  GVM_JSON_PULL_EVENT_ARRAY_END,
  GVM_JSON_PULL_EVENT_OBJECT_START,
  GVM_JSON_PULL_EVENT_OBJECT_END,
  GVM_JSON_PULL_EVENT_STRING,
  GVM_JSON_PULL_EVENT_NUMBER,
  GVM_JSON_PULL_EVENT_BOOLEAN,
  GVM_JSON_PULL_EVENT_NULL,
  GVM_JSON_PULL_EVENT_EOF,
  GVM_JSON_PULL_EVENT_ERROR,
} gvm_json_pull_event_type_t;

typedef struct
{
  gvm_json_pull_event_type_t type; 
  GQueue *path;                    
  cJSON *value;                    
  gchar *error_message;            
} gvm_json_pull_event_t;

typedef enum
{
  GVM_JSON_PULL_EXPECT_UNDEFINED = 0, 
  GVM_JSON_PULL_EXPECT_VALUE,         
  GVM_JSON_PULL_EXPECT_KEY,           
  GVM_JSON_PULL_EXPECT_COMMA,         
  GVM_JSON_PULL_EXPECT_EOF            
} gvm_json_pull_expect_t;
 
#define GVM_JSON_PULL_PARSE_BUFFER_LIMIT 10485760
 
#define GVM_JSON_PULL_READ_BUFFER_SIZE 4096

typedef struct
{
  GQueue *path;                   
  gvm_json_path_elem_t *path_add; 
  gvm_json_pull_expect_t expect;  
  int keyword_pos;           
  FILE *input_stream;        
  char *read_buffer;         
  size_t read_buffer_size;   
  size_t last_read_size;     
  int last_read_char;        
  size_t read_pos;           
  GString *parse_buffer;     
  size_t parse_buffer_limit; 
} gvm_json_pull_parser_t;
 
gvm_json_path_elem_t *
gvm_json_pull_path_elem_new (gvm_json_pull_container_type_t, int);
 
void
gvm_json_pull_path_elem_free (gvm_json_path_elem_t *);
 
void
gvm_json_pull_event_init (gvm_json_pull_event_t *);
 
void
gvm_json_pull_event_cleanup (gvm_json_pull_event_t *);
 
void
gvm_json_pull_parser_init_full (gvm_json_pull_parser_t *, FILE *, size_t,
                                size_t);
 
void
gvm_json_pull_parser_init (gvm_json_pull_parser_t *, FILE *);
 
void
gvm_json_pull_parser_cleanup (gvm_json_pull_parser_t *);
 
void
gvm_json_pull_parser_next (gvm_json_pull_parser_t *, gvm_json_pull_event_t *);
 
cJSON *
gvm_json_pull_expand_container (gvm_json_pull_parser_t *, gchar **);
 
gchar *
gvm_json_path_to_string (GQueue *path);
 
#endif /* _GVM_JSONPULL_H */