rz_serialize.h File Reference

#include <rz_util/rz_json.h>
#include <rz_list.h>

Go to the source code of this file.

Macros
#define	RZ_SERIALIZE_ERR(res, ...)
	Push an error to the local RzSerializeResultInfo \res RzSerializeInfoResult *. More...
#define	RZ_KEY_PARSER_UNKNOWN   -1
#define	RZ_KEY_PARSER_SWITCH(parser, key)
	switch-like macro over RzKeyParser values More...
#define	RZ_KEY_PARSER_JSON(parser, json, child, body)
	Iterate over all keys in a json object and call RZ_KEY_PARSER_SWITCH on each. More...
#define	RZ_SERIALIZE_SUB(db, subdb, res, ns, rip)
	Get an sdb sub-namespace or fail. More...
#define	RZ_SERIALIZE_SUB_DO(db, subdb, res, ns, call, rip)
	Get an sdb sub-namespace and evaluate call or fail. More...

Typedefs
typedef RzList	RzSerializeResultInfo
	Detailed info about a (de)serialization result. More...
typedef HtPP	RzKeyParser
	Hashtable-based key parser to prevent strcmp chains. More...

Functions
static RzSerializeResultInfo *	rz_serialize_result_info_new (void)
static void	rz_serialize_result_info_free (RzSerializeResultInfo *info)
static RzKeyParser *	rz_key_parser_new (void)
static void	rz_key_parser_free (RzKeyParser *parser)
static void	rz_key_parser_add (RzKeyParser *parser, const char *key, int val)

Macro Definition Documentation

RZ_KEY_PARSER_JSON

#define RZ_KEY_PARSER_JSON	(		parser,
			json,
			child,
			body
	)

Value:

    if (json->type == RZ_JSON_OBJECT) { \
        for (RzJson *child = json->children.first; child; child = child->next) { \
            RZ_KEY_PARSER_SWITCH(parser, child->key) { body } \
        } \
    }

Iterate over all keys in a json object and call RZ_KEY_PARSER_SWITCH on each.

Parameters

parser	RzKeyParser *
json	RzJson *
child	var name for the RzJson *child
body	code block with cases

Definition at line 82 of file rz_serialize.h.

RZ_KEY_PARSER_SWITCH

#define RZ_KEY_PARSER_SWITCH	(		parser,
			key
	)

Value:

    bool key_parser_found = false; \
    int key_parser_v = (int)(size_t)ht_pp_find(parser, key, &key_parser_found); \
    if (!key_parser_found) { \
        key_parser_v = RZ_KEY_PARSER_UNKNOWN; \
    } \
    switch (key_parser_v)

switch-like macro over RzKeyParser values

Parameters

parser	RzKeyParser *
key	const char *

Definition at line 67 of file rz_serialize.h.

RZ_KEY_PARSER_UNKNOWN

#define RZ_KEY_PARSER_UNKNOWN   -1

Definition at line 60 of file rz_serialize.h.

RZ_SERIALIZE_ERR

#define RZ_SERIALIZE_ERR	(		res,
			...
	)

Value:

    do { \
        if (res) { \
            rz_list_push(res, rz_str_newf(__VA_ARGS__)); \
        } \
    } while (0)

Push an error to the local RzSerializeResultInfo \res RzSerializeInfoResult *.

Parameters

...	printf-style arguments to be pushed as the error to res

Definition at line 33 of file rz_serialize.h.

RZ_SERIALIZE_SUB

#define RZ_SERIALIZE_SUB	(		db,
			subdb,
			res,
			ns,
			rip
	)

Value:

    do { \
        subdb = sdb_ns(db, ns, false); \
        if (!subdb) { \
            RZ_SERIALIZE_ERR(res, "missing " ns " namespace"); \
            rip \
        } \
    } while (0)

Get an sdb sub-namespace or fail.

Parameters

db	Sdb * the Sdb from which to take the sub-namespace
subdb	Sdb * where to put the sub-namespace
res	RzSerializeResult * where to push an error on failure
ns	const char *
rip	code to execute if the function failed

Example:

Sdb *subdb;
RZ_SERIALIZE_SUB(db, subdb, res, "files", return false;)
// do something with subdb

Definition at line 104 of file rz_serialize.h.

RZ_SERIALIZE_SUB_DO

#define RZ_SERIALIZE_SUB_DO	(		db,
			subdb,
			res,
			ns,
			call,
			rip
	)

Value:

    RZ_SERIALIZE_SUB(db, subdb, res, ns, rip); \
    if (!(call)) { \
        rip \
    }

Get an sdb sub-namespace and evaluate call or fail.

Parameters

db	Sdb * the Sdb from which to take the sub-namespace
subdb	Sdb * where to put the sub-namespace
res	RzSerializeResult * where to push an error on failure
ns	const char *
call	function call
rip	code to execute if the function failed

Example:

Sdb *subdb;
RZ_SERIALIZE_SUB_DO(db, subdb, res, "files",
    rz_serialize_io_files_load(subdb, io, res), return false;)

Definition at line 129 of file rz_serialize.h.

Typedef Documentation

RzKeyParser

typedef HtPP RzKeyParser

Hashtable-based key parser to prevent strcmp chains.

This enables string values to be used in a switch/case-like fashion.

Definition at line 46 of file rz_serialize.h.

RzSerializeResultInfo

typedef RzList RzSerializeResultInfo

Detailed info about a (de)serialization result.

This is currently just a list of strings which may be warnings or detailed error messages.

Definition at line 16 of file rz_serialize.h.

Function Documentation

rz_key_parser_add()

static void rz_key_parser_add ( RzKeyParser *  parser, const char *  key, int  val  )

inlinestatic

Definition at line 56 of file rz_serialize.h.

                                                                                    {
    ht_pp_insert(parser, key, (void *)(size_t)val);
}

References key, cmd_descs_generate::parser, and val.

Referenced by load_flags(), rz_serialize_analysis_blocks_load(), rz_serialize_analysis_diff_parser_new(), rz_serialize_analysis_functions_load(), rz_serialize_analysis_global_var_parser_new(), rz_serialize_analysis_hints_load(), rz_serialize_analysis_var_parser_new(), and rz_serialize_bp_parser_new().

rz_key_parser_free()

static void rz_key_parser_free ( RzKeyParser *  parser )

inlinestatic

Definition at line 52 of file rz_serialize.h.

                                                           {
    ht_pp_free(parser);
}

References cmd_descs_generate::parser.

Referenced by load_flags(), rz_serialize_analysis_blocks_load(), rz_serialize_analysis_diff_parser_free(), rz_serialize_analysis_functions_load(), rz_serialize_analysis_global_var_load(), rz_serialize_analysis_global_var_parser_free(), rz_serialize_analysis_hints_load(), rz_serialize_analysis_var_parser_free(), and rz_serialize_bp_load().

rz_key_parser_new()

static RzKeyParser* rz_key_parser_new ( void  )

inlinestatic

Definition at line 48 of file rz_serialize.h.

                                                   {
    return ht_pp_new0();
}

Referenced by load_flags(), rz_serialize_analysis_blocks_load(), rz_serialize_analysis_diff_parser_new(), rz_serialize_analysis_functions_load(), rz_serialize_analysis_global_var_parser_new(), rz_serialize_analysis_hints_load(), rz_serialize_analysis_var_parser_new(), and rz_serialize_bp_parser_new().

rz_serialize_result_info_free()

static void rz_serialize_result_info_free ( RzSerializeResultInfo *  info )

inlinestatic

Definition at line 22 of file rz_serialize.h.

                                                                              {
    rz_list_free(info);
}

References info(), and rz_list_free().

Referenced by rz_core_project_load_for_cli().

rz_serialize_result_info_new()

static RzSerializeResultInfo* rz_serialize_result_info_new ( void  )

inlinestatic

Definition at line 18 of file rz_serialize.h.

                                                                        {
    return rz_list_newf(free);
}

References free(), and rz_list_newf().

Referenced by rz_core_project_load_for_cli().