yajl_gen.c File Reference

#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <stdarg.h>
#include "epicsMath.h"
#include "yajl_gen.h"
#include "yajl_buf.h"
#include "yajl_encode.h"

Include dependency graph for yajl_gen.c:

Go to the source code of this file.

Classes
struct	yajl_gen_t

Macros
#define	INSERT_SEP
#define	INSERT_WHITESPACE
#define	ENSURE_NOT_KEY
#define	ENSURE_VALID_STATE
#define	INCREMENT_DEPTH   if (++(g->depth) >= YAJL_MAX_DEPTH) return yajl_max_depth_exceeded;
#define	DECREMENT_DEPTH   if (--(g->depth) >= YAJL_MAX_DEPTH) return yajl_max_depth_exceeded;
#define	APPENDED_ATOM
#define	FINAL_NEWLINE

Enumerations
enum	yajl_gen_state {   yajl_gen_start, yajl_gen_map_start, yajl_gen_map_key, yajl_gen_map_val,   yajl_gen_array_start, yajl_gen_in_array, yajl_gen_complete, yajl_gen_error }

Functions
int	yajl_gen_config (yajl_gen g, yajl_gen_option opt,...)
yajl_gen	yajl_gen_alloc (const yajl_alloc_funcs *afs)
void	yajl_gen_free (yajl_gen g)
yajl_gen_status	yajl_gen_integer (yajl_gen g, long long int number)
yajl_gen_status	yajl_gen_double (yajl_gen g, double number)
yajl_gen_status	yajl_gen_number (yajl_gen g, const char *s, size_t l)
yajl_gen_status	yajl_gen_string (yajl_gen g, const unsigned char *str, size_t len)
yajl_gen_status	yajl_gen_null (yajl_gen g)
yajl_gen_status	yajl_gen_bool (yajl_gen g, int boolean)
yajl_gen_status	yajl_gen_map_open (yajl_gen g)
yajl_gen_status	yajl_gen_map_close (yajl_gen g)
yajl_gen_status	yajl_gen_array_open (yajl_gen g)
yajl_gen_status	yajl_gen_array_close (yajl_gen g)
yajl_gen_status	yajl_gen_get_buf (yajl_gen g, const unsigned char **buf, size_t *len)
void	yajl_gen_clear (yajl_gen g)

Macro Definition Documentation

#define APPENDED_ATOM

Value:

switch (g->state[g->depth]) {                   \
        case yajl_gen_start:                        \
            g->state[g->depth] = yajl_gen_complete; \
            break;                                  \
        case yajl_gen_map_start:                    \
        case yajl_gen_map_key:                      \
            g->state[g->depth] = yajl_gen_map_val;  \
            break;                                  \
        case yajl_gen_array_start:                  \
            g->state[g->depth] = yajl_gen_in_array; \
            break;                                  \
        case yajl_gen_map_val:                      \
            g->state[g->depth] = yajl_gen_map_key;  \
            break;                                  \
        default:                                    \
            break;                                  \
    }                                               \

Definition at line 176 of file yajl_gen.c.

#define DECREMENT_DEPTH   if (--(g->depth) >= YAJL_MAX_DEPTH) return yajl_max_depth_exceeded;

Definition at line 173 of file yajl_gen.c.

#define ENSURE_NOT_KEY

Value:

if (g->state[g->depth] == yajl_gen_map_key ||       \
        g->state[g->depth] == yajl_gen_map_start)  {    \
        return yajl_gen_keys_must_be_strings;           \
    }                                                   \

Definition at line 155 of file yajl_gen.c.

#define ENSURE_VALID_STATE

Value:

if (g->state[g->depth] == yajl_gen_error) {   \
        return yajl_gen_in_error_state;\
    } else if (g->state[g->depth] == yajl_gen_complete) {   \
        return yajl_gen_generation_complete;                \
    }

Definition at line 163 of file yajl_gen.c.

#define FINAL_NEWLINE

Value:

if ((g->flags & yajl_gen_beautify) && g->state[g->depth] == yajl_gen_complete) \
        g->print(g->ctx, "\n", 1);

Definition at line 195 of file yajl_gen.c.

#define INCREMENT_DEPTH   if (++(g->depth) >= YAJL_MAX_DEPTH) return yajl_max_depth_exceeded;

Definition at line 170 of file yajl_gen.c.

#define INSERT_SEP

Value:

if (g->state[g->depth] == yajl_gen_map_key ||               \
        g->state[g->depth] == yajl_gen_in_array) {              \
        g->print(g->ctx, ",", 1);                               \
        if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, "\n", 1);               \
    } else if (g->state[g->depth] == yajl_gen_map_val) {        \
        g->print(g->ctx, ":", 1);                               \
        if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, " ", 1);                \
   }

Definition at line 134 of file yajl_gen.c.

#define INSERT_WHITESPACE

Value:

if ((g->flags & yajl_gen_beautify)) {                                                    \
        if (g->state[g->depth] != yajl_gen_map_val) {                   \
            unsigned int _i;                                            \
            for (_i=0;_i<g->depth;_i++)                                 \
                g->print(g->ctx,                                        \
                         g->indentString,                               \
                         (unsigned int)strlen(g->indentString));        \
        }                                                               \
    }

Definition at line 144 of file yajl_gen.c.

Enumeration Type Documentation

enum yajl_gen_state

Enumerator
yajl_gen_start
yajl_gen_map_start
yajl_gen_map_key
yajl_gen_map_val
yajl_gen_array_start
yajl_gen_in_array
yajl_gen_complete
yajl_gen_error

Definition at line 27 of file yajl_gen.c.

             {
    yajl_gen_start,
    yajl_gen_map_start,
    yajl_gen_map_key,
    yajl_gen_map_val,
    yajl_gen_array_start,
    yajl_gen_in_array,
    yajl_gen_complete,
    yajl_gen_error
} yajl_gen_state;

Function Documentation

yajl_gen yajl_gen_alloc

(

const yajl_alloc_funcs *

allocFuncs

)

Allocate a generator handle

Parameters

allocFuncs

An optional pointer to a structure which allows the client to overide the memory allocation used by yajl. May be NULL, in which case malloc(), free() and realloc() will be used.

Returns

an allocated handle on success, NULL on failure (bad params)

Definition at line 97 of file yajl_gen.c.

{
    yajl_gen g = NULL;
    yajl_alloc_funcs afsBuffer;

    /* first order of business is to set up memory allocation routines */
    if (afs != NULL) {
        if (afs->malloc == NULL || afs->realloc == NULL || afs->free == NULL)
        {
            return NULL;
        }
    } else {
        yajl_set_default_alloc_funcs(&afsBuffer);
        afs = &afsBuffer;
    }

    g = (yajl_gen) YA_MALLOC(afs, sizeof(struct yajl_gen_t));
    if (!g) return NULL;

    memset((void *) g, 0, sizeof(struct yajl_gen_t));
    /* copy in pointers to allocation routines */
    memcpy((void *) &(g->alloc), (void *) afs, sizeof(yajl_alloc_funcs));

    g->print = (yajl_print_t)&yajl_buf_append;
    g->ctx = yajl_buf_alloc(&(g->alloc));
    g->indentString = "    ";

    return g;
}

yajl_gen_status yajl_gen_array_close

(

yajl_gen

hand

)

Finish generating a JSON array.

Definition at line 318 of file yajl_gen.c.

{
    ENSURE_VALID_STATE;
    DECREMENT_DEPTH;
    if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, "\n", 1);
    APPENDED_ATOM;
    INSERT_WHITESPACE;
    g->print(g->ctx, "]", 1);
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_array_open

(

yajl_gen

hand

)

Start generating a JSON array.

Definition at line 306 of file yajl_gen.c.

{
    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    INCREMENT_DEPTH;
    g->state[g->depth] = yajl_gen_array_start;
    g->print(g->ctx, "[", 1);
    if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, "\n", 1);
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_bool	(	yajl_gen	hand,
		int	boolean
	)

Generate a true or false value from boolean.

Definition at line 267 of file yajl_gen.c.

{
    const char * val = boolean ? "true" : "false";

    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    g->print(g->ctx, val, (unsigned int)strlen(val));
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

void yajl_gen_clear

(

yajl_gen

hand

)

Clear yajl's output buffer, but maintain all internal generation state. This function will not "reset" the generator state, and is intended to enable incremental JSON outputing.

Definition at line 341 of file yajl_gen.c.

{
    if (g->print == (yajl_print_t)&yajl_buf_append) yajl_buf_clear((yajl_buf)g->ctx);
}

int yajl_gen_config	(	yajl_gen	g,
		yajl_gen_option	opt,
			...
	)

Allow the modification of generator options subsequent to handle allocation (via yajl_alloc())

Returns

zero in case of errors, non-zero otherwise

Definition at line 51 of file yajl_gen.c.

{
    int rv = 1;
    va_list ap;
    va_start(ap, opt);

    switch(opt) {
        case yajl_gen_beautify:
        case yajl_gen_validate_utf8:
            if (va_arg(ap, int)) g->flags |= opt;
            else g->flags &= ~opt;
            break;
        case yajl_gen_indent_string: {
            const char *indent = va_arg(ap, const char *);
            g->indentString = indent;
            for (; *indent; indent++) {
                if (*indent != '\n'
                    && *indent != '\v'
                    && *indent != '\f'
                    && *indent != '\t'
                    && *indent != '\r'
                    && *indent != ' ')
                {
                    g->indentString = NULL;
                    rv = 0;
                }
            }
            break;
        }
        case yajl_gen_print_callback:
            yajl_buf_free(g->ctx);
            g->print = va_arg(ap, const yajl_print_t);
            g->ctx = va_arg(ap, void *);
            break;
        default:
            rv = 0;
    }

    va_end(ap);

    return rv;
}

yajl_gen_status yajl_gen_double	(	yajl_gen	hand,
		double	number
	)

Generate a floating point number. number may not be infinity or NaN, as these have no representation in JSON. In these cases the generator will return yajl_gen_invalid_number

Definition at line 212 of file yajl_gen.c.

{
    char i[32];
    ENSURE_VALID_STATE; ENSURE_NOT_KEY;
    if (isnan(number) || isinf(number)) return yajl_gen_invalid_number;
    INSERT_SEP; INSERT_WHITESPACE;
    sprintf(i, "%.20g", number);
    g->print(g->ctx, i, (unsigned int)strlen(i));
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

void yajl_gen_free

(

yajl_gen

handle

)

Free a generator handle

Definition at line 128 of file yajl_gen.c.

{
    if (g->print == (yajl_print_t)&yajl_buf_append) yajl_buf_free((yajl_buf)g->ctx);
    YA_FREE(&(g->alloc), g);
}

yajl_gen_status yajl_gen_get_buf	(	yajl_gen	hand,
		const unsigned char **	buf,
		size_t *	len
	)

Access the null terminated generator buffer. If incrementally outputing JSON, one should call yajl_gen_clear() to clear the buffer. This allows stream generation.

Definition at line 331 of file yajl_gen.c.

{
    if (g->print != (yajl_print_t)&yajl_buf_append) return yajl_gen_no_buf;
    *buf = yajl_buf_data((yajl_buf)g->ctx);
    *len = yajl_buf_len((yajl_buf)g->ctx);
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_integer	(	yajl_gen	hand,
		long long int	number
	)

Generate an integer number.

Definition at line 200 of file yajl_gen.c.

{
    char i[32];
    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    sprintf(i, "%lld", number);
    g->print(g->ctx, i, (unsigned int)strlen(i));
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_map_close

(

yajl_gen

hand

)

Finish generating a JSON map.

Definition at line 292 of file yajl_gen.c.

{
    ENSURE_VALID_STATE;
    DECREMENT_DEPTH;

    if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, "\n", 1);
    APPENDED_ATOM;
    INSERT_WHITESPACE;
    g->print(g->ctx, "}", 1);
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_map_open

(

yajl_gen

hand

)

Start generating a JSON map. This should be followed by calls to yajl_gen_string() to provide a key and another yajl_gen routine to provide the value associated with that key.

Definition at line 279 of file yajl_gen.c.

{
    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    INCREMENT_DEPTH;

    g->state[g->depth] = yajl_gen_map_start;
    g->print(g->ctx, "{", 1);
    if ((g->flags & yajl_gen_beautify)) g->print(g->ctx, "\n", 1);
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_null

(

yajl_gen

hand

)

Generate a null value.

Definition at line 257 of file yajl_gen.c.

{
    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    g->print(g->ctx, "null", strlen("null"));
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_number	(	yajl_gen	hand,
		const char *	num,
		size_t	len
	)

Generate a number from the string given in num.

Definition at line 226 of file yajl_gen.c.

{
    ENSURE_VALID_STATE; ENSURE_NOT_KEY; INSERT_SEP; INSERT_WHITESPACE;
    g->print(g->ctx, s, l);
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}

yajl_gen_status yajl_gen_string	(	yajl_gen	hand,
		const unsigned char *	str,
		size_t	len
	)

Generate a string value or map key from str.

Definition at line 236 of file yajl_gen.c.

{
    // if validation is enabled, check that the string is valid utf8
    // XXX: This checking could be done a little faster, in the same pass as
    // the string encoding
    if (g->flags & yajl_gen_validate_utf8) {
        if (!yajl_string_validate_utf8(str, len)) {
            return yajl_gen_invalid_string;
        }
    }
    ENSURE_VALID_STATE; INSERT_SEP; INSERT_WHITESPACE;
    g->print(g->ctx, "\"", 1);
    yajl_string_encode(g->print, g->ctx, str, len, g->flags & yajl_gen_escape_solidus);
    g->print(g->ctx, "\"", 1);
    APPENDED_ATOM;
    FINAL_NEWLINE;
    return yajl_gen_status_ok;
}