base.c File Reference

#include <rz_util.h>
#include <rz_type.h>
#include <string.h>

Go to the source code of this file.

Classes
struct	list_kind

Functions
RZ_API void	rz_type_base_enum_case_free (void *e, void *user)
RZ_API void	rz_type_base_struct_member_free (void *e, void *user)
RZ_API void	rz_type_base_union_member_free (void *e, void *user)
RZ_API RZ_BORROW const char *	rz_type_base_type_kind_as_string (RzBaseTypeKind kind)
	Returns string representing the kind of base type. More...
RZ_API RZ_BORROW RzBaseType *	rz_type_db_get_base_type (const RzTypeDB *typedb, RZ_NONNULL const char *name)
	Searches for the RzBaseType in the types database given the name. More...
RZ_API bool	rz_type_db_delete_base_type (RzTypeDB *typedb, RZ_NONNULL RzBaseType *type)
	Removes RzBaseType from the Types DB. More...
static bool	base_type_kind_collect_cb (void *user, const void *k, const void *v)
RZ_API RZ_OWN RzList *	rz_type_db_get_base_types_of_kind (const RzTypeDB *typedb, RzBaseTypeKind kind)
	Returns the list of all basic types of the chosen kind. More...
static bool	base_type_collect_cb (void *user, const void *k, const void *v)
RZ_API RZ_OWN RzList *	rz_type_db_get_base_types (const RzTypeDB *typedb)
	Returns the list of all basic types. More...
RZ_API void	rz_type_base_type_free (RzBaseType *type)
	Frees the RzBaseType instance and all of its members. More...
RZ_API RZ_OWN RzBaseType *	rz_type_base_type_new (RzBaseTypeKind kind)
	Allocates a new instance of RzBaseType given the kind. More...
RZ_API void	rz_type_db_save_base_type (const RzTypeDB *typedb, const RzBaseType *type)
	Saves RzBaseType into the Types DB. More...
RZ_API RZ_OWN char *	rz_type_db_base_type_as_string (const RzTypeDB *typedb, RZ_NONNULL const RzBaseType *btype)
	Returns C representation as string of RzBaseType (see rz_type_db_base_type_as_pretty_string for cusom print options) More...
RZ_API RZ_OWN char *	rz_type_db_base_type_as_pretty_string (RZ_NONNULL const RzTypeDB *typedb, RZ_NONNULL const RzBaseType *btype, unsigned int opts, int unfold_level)
	Returns C representation as string of RzBaseType. More...
RZ_API RZ_BORROW RzBaseType *	rz_type_db_get_compound_type (const RzTypeDB *typedb, RZ_NONNULL const char *name)
	Searches for the compound RzBaseType in the types database given the name. More...

Function Documentation

base_type_collect_cb()

static bool base_type_collect_cb ( void *  user, const void *  k, const void *  v  )

static

Definition at line 108 of file base.c.

                                                                           {
    rz_return_val_if_fail(user && k && v, false);
    RzList *l = user;
    rz_list_append(l, (void *)v);
    return true;
}

References k, rz_list_append(), rz_return_val_if_fail, and v.

Referenced by rz_type_db_get_base_types().

base_type_kind_collect_cb()

static bool base_type_kind_collect_cb ( void *  user, const void *  k, const void *  v  )

static

Definition at line 85 of file base.c.

                                                                                {
    struct list_kind *l = user;
    RzBaseType *btype = (RzBaseType *)v;
    if (l->kind == btype->kind) {
        rz_list_append(l->types, btype);
    }
    return true;
}

References rz_base_type_t::kind, list_kind::kind, rz_list_append(), list_kind::types, and v.

Referenced by rz_type_db_get_base_types_of_kind().

rz_type_base_enum_case_free()

RZ_API void rz_type_base_enum_case_free	(	void *	e,
		void *	user
	)

Definition at line 8 of file base.c.

                                                             {
    (void)user;
    RzTypeEnumCase *cas = e;
    free((char *)cas->name);
}

References e, free(), and rz_type_enum_case_t::name.

Referenced by parse_enum(), parse_enum_type(), and rz_type_base_type_new().

rz_type_base_struct_member_free()

RZ_API void rz_type_base_struct_member_free	(	void *	e,
		void *	user
	)

Definition at line 14 of file base.c.

                                                                 {
    (void)user;
    RzTypeStructMember *member = e;
    rz_type_free(member->type);
    free((char *)member->name);
}

References e, free(), rz_type_struct_member_t::name, rz_type_free(), and rz_type_struct_member_t::type.

Referenced by parse_structure(), and rz_type_base_type_new().

rz_type_base_type_free()

RZ_API void rz_type_base_type_free

(

RzBaseType *

type

)

Frees the RzBaseType instance and all of its members.

Parameters

type	RzBaseType pointer

Definition at line 132 of file base.c.

                                                     {
    rz_return_if_fail(type);
    RZ_FREE(type->name);
    rz_type_free(type->type);
    type->type = NULL;
 
    switch (type->kind) {
    case RZ_BASE_TYPE_KIND_STRUCT:
        rz_vector_fini(&type->struct_data.members);
        break;
    case RZ_BASE_TYPE_KIND_UNION:
        rz_vector_fini(&type->union_data.members);
        break;
    case RZ_BASE_TYPE_KIND_ENUM:
        rz_vector_fini(&type->enum_data.cases);
        break;
    case RZ_BASE_TYPE_KIND_TYPEDEF:
    case RZ_BASE_TYPE_KIND_ATOMIC:
        break;
    default:
        break;
    }
    RZ_FREE(type);
}

References NULL, RZ_BASE_TYPE_KIND_ATOMIC, RZ_BASE_TYPE_KIND_ENUM, RZ_BASE_TYPE_KIND_STRUCT, RZ_BASE_TYPE_KIND_TYPEDEF, RZ_BASE_TYPE_KIND_UNION, RZ_FREE, rz_return_if_fail, rz_type_free(), rz_vector_fini(), and type.

Referenced by c_parser_new_enum_type(), c_parser_new_primitive_type(), c_parser_new_structure_type(), c_parser_new_typedef(), c_parser_new_union_type(), get_atomic_type(), get_enum_type(), get_struct_type(), get_typedef_type(), get_union_type(), parse_enum(), parse_enum_type(), parse_sole_type_name(), parse_structure(), parse_structure_type(), parse_typedef(), parse_union(), rz_type_db_edit_base_type(), and types_ht_free().

rz_type_base_type_kind_as_string()

RZ_API RZ_BORROW const char* rz_type_base_type_kind_as_string

(

RzBaseTypeKind

kind

)

Returns string representing the kind of base type.

Parameters

kind	RzBaseTypeKind to return string representation of

Definition at line 33 of file base.c.

                                                                                   {
    switch (kind) {
    case RZ_BASE_TYPE_KIND_STRUCT:
        return "struct";
    case RZ_BASE_TYPE_KIND_UNION:
        return "union";
    case RZ_BASE_TYPE_KIND_ENUM:
        return "enum";
    case RZ_BASE_TYPE_KIND_TYPEDEF:
        return "typedef";
    case RZ_BASE_TYPE_KIND_ATOMIC:
        return "atomic";
    default:
        rz_warn_if_reached();
        return "unknown";
    }
}

References RZ_BASE_TYPE_KIND_ATOMIC, RZ_BASE_TYPE_KIND_ENUM, RZ_BASE_TYPE_KIND_STRUCT, RZ_BASE_TYPE_KIND_TYPEDEF, RZ_BASE_TYPE_KIND_UNION, and rz_warn_if_reached.

Referenced by parse_enum(), parse_structure(), and parse_union().

rz_type_base_type_new()

RZ_API RZ_OWN RzBaseType* rz_type_base_type_new

(

RzBaseTypeKind

kind

)

Allocates a new instance of RzBaseType given the kind.

Parameters

kind	Kind of RzBaseType to create

Definition at line 162 of file base.c.

                                                                     {
    RzBaseType *type = RZ_NEW0(RzBaseType);
    if (!type) {
        return NULL;
    }
    type->kind = kind;
    switch (type->kind) {
    case RZ_BASE_TYPE_KIND_STRUCT:
        rz_vector_init(&type->struct_data.members, sizeof(RzTypeStructMember), rz_type_base_struct_member_free, NULL);
        break;
    case RZ_BASE_TYPE_KIND_ENUM:
        rz_vector_init(&type->enum_data.cases, sizeof(RzTypeEnumCase), rz_type_base_enum_case_free, NULL);
        break;
    case RZ_BASE_TYPE_KIND_UNION:
        rz_vector_init(&type->union_data.members, sizeof(RzTypeUnionMember), rz_type_base_union_member_free, NULL);
        break;
    default:
        break;
    }
 
    return type;
}

References list_kind::kind, NULL, RZ_BASE_TYPE_KIND_ENUM, RZ_BASE_TYPE_KIND_STRUCT, RZ_BASE_TYPE_KIND_UNION, RZ_NEW0, rz_type_base_enum_case_free(), rz_type_base_struct_member_free(), rz_type_base_union_member_free(), rz_vector_init(), and type.

Referenced by c_parser_new_enum_type(), c_parser_new_primitive_type(), c_parser_new_structure_type(), c_parser_new_typedef(), c_parser_new_union_type(), get_atomic_type(), get_enum_type(), get_struct_type(), get_typedef_type(), get_union_type(), parse_atomic_type(), parse_enum(), parse_enum_type(), parse_structure(), parse_structure_type(), parse_type_nest(), parse_typedef(), and parse_union().

rz_type_base_union_member_free()

RZ_API void rz_type_base_union_member_free	(	void *	e,
		void *	user
	)

Definition at line 21 of file base.c.

                                                                {
    (void)user;
    RzTypeUnionMember *member = e;
    rz_type_free(member->type);
    free((char *)member->name);
}

References e, free(), rz_type_union_member_t::name, rz_type_free(), and rz_type_union_member_t::type.

Referenced by parse_union(), and rz_type_base_type_new().

rz_type_db_base_type_as_pretty_string()

RZ_API RZ_OWN char* rz_type_db_base_type_as_pretty_string	(	RZ_NONNULL const RzTypeDB *	typedb,
		RZ_NONNULL const RzBaseType *	btype,
		unsigned int	opts,
		int	unfold_level
	)

Returns C representation as string of RzBaseType.

Parameters

typedb	type database instance
btype	RzBaseType to convert
opts	options for pretty printing (see RzTypePrintOpts)
unfold_level	level of unfolding to do in case of nested structures/unions (any negative number means maximum unfolding, i.e. INT32_MAX. 0 means no unfolding, just the typename and identifier, if any)

Returns

char* pretty printed form of the base string (similar to rz_type_as_pretty_string, but for RzBaseType)

Definition at line 219 of file base.c.

                                                                                                                                                                      {
    rz_return_val_if_fail(typedb && btype, NULL);
 
    RzType *type = rz_type_identifier_of_base_type(typedb, btype, false);
    return rz_type_as_pretty_string(typedb, type, NULL, opts, unfold_level);
}

References NULL, rz_return_val_if_fail, rz_type_as_pretty_string(), rz_type_identifier_of_base_type(), and type.

Referenced by pdb_types_print_standard(), rz_core_base_type_as_c(), rz_core_types_enum_as_c(), rz_core_types_struct_as_c(), rz_core_types_typedef_as_c(), and rz_core_types_union_as_c().

rz_type_db_base_type_as_string()

RZ_API RZ_OWN char* rz_type_db_base_type_as_string	(	const RzTypeDB *	typedb,
		RZ_NONNULL const RzBaseType *	btype
	)

Returns C representation as string of RzBaseType (see rz_type_db_base_type_as_pretty_string for cusom print options)

Parameters

typedb	type database instance
btype	RzBaseType to convert

Returns

char* one line C representation of the string with no semicolon at the end and no unfolding of inner types

Definition at line 203 of file base.c.

                                                                                                               {
    rz_return_val_if_fail(typedb && btype, NULL);
 
    RzType *type = rz_type_identifier_of_base_type(typedb, btype, false);
    return rz_type_as_pretty_string(typedb, type, NULL, RZ_TYPE_PRINT_NO_END_SEMICOLON | RZ_TYPE_PRINT_ZERO_VLA, 1);
}

References NULL, rz_return_val_if_fail, rz_type_as_pretty_string(), rz_type_identifier_of_base_type(), RZ_TYPE_PRINT_NO_END_SEMICOLON, RZ_TYPE_PRINT_ZERO_VLA, and type.

rz_type_db_delete_base_type()

RZ_API bool rz_type_db_delete_base_type	(	RzTypeDB *	typedb,
		RZ_NONNULL RzBaseType *	type
	)

Removes RzBaseType from the Types DB.

Parameters

typedb	Type Database instance
type	RzBaseType to remove

Definition at line 74 of file base.c.

                                                                                       {
    rz_return_val_if_fail(typedb && type && type->name, false);
    ht_pp_delete(typedb->types, type->name);
    return true;
}

References rz_return_val_if_fail, type, and rz_type_db_t::types.

Referenced by parse_enum(), parse_structure(), parse_union(), and rz_type_db_del().

rz_type_db_get_base_type()

RZ_API RZ_BORROW RzBaseType* rz_type_db_get_base_type	(	const RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Searches for the RzBaseType in the types database given the name.

Parameters

typedb	Type Database instance
name	Name of the RzBaseType

Definition at line 57 of file base.c.

                                                                                                           {
    rz_return_val_if_fail(typedb && name, NULL);
 
    bool found = false;
    RzBaseType *btype = ht_pp_find(typedb->types, name, &found);
    if (!found || !btype) {
        return NULL;
    }
    return btype;
}

References found, NULL, rz_return_val_if_fail, and rz_type_db_t::types.

Referenced by get_base_type_typeclass(), get_tpitype_basetype(), get_type_typeclass(), parse_type_nest(), resolve_type_links(), rz_core_types_as_c(), rz_type_array_of_base_type_str(), rz_type_atomic_eq(), rz_type_atomic_str_eq(), rz_type_db_del(), rz_type_db_enum_get_bitfield(), rz_type_db_enum_member_by_name(), rz_type_db_enum_member_by_val(), rz_type_db_get_bitsize(), rz_type_db_get_compound_type(), rz_type_db_get_enum(), rz_type_db_get_struct(), rz_type_db_get_typedef(), rz_type_db_get_union(), rz_type_db_struct_member_offset(), rz_type_db_struct_member_packed_offset(), rz_type_exists(), rz_type_format(), rz_type_get_base_type(), rz_type_identifier_of_base_type_str(), rz_type_integral_set_sign(), rz_type_is_atomic(), rz_type_is_strictly_atomic(), rz_type_kind(), rz_type_new_default(), rz_type_pointer_of_base_type_str(), structured_member_walker(), type_as_pretty_string(), type_decl_as_pretty_string(), type_paths_collect_by_address_cb(), type_paths_collect_by_offset_cb(), type_to_format_pair(), and var_add_structure_fields_to_list().

rz_type_db_get_base_types()

RZ_API RZ_OWN RzList* rz_type_db_get_base_types

(

const RzTypeDB *

typedb

)

Returns the list of all basic types.

Parameters

typedb

Types Database instance

Definition at line 120 of file base.c.

                                                                          {
    rz_return_val_if_fail(typedb, NULL);
    RzList *types = rz_list_new();
    ht_pp_foreach(typedb->types, base_type_collect_cb, types);
    return types;
}

References base_type_collect_cb(), NULL, rz_list_new(), rz_return_val_if_fail, types, and rz_type_db_t::types.

Referenced by rz_core_types_print_all(), rz_type_db_all(), and rz_type_db_get_by_offset().

rz_type_db_get_base_types_of_kind()

RZ_API RZ_OWN RzList* rz_type_db_get_base_types_of_kind	(	const RzTypeDB *	typedb,
		RzBaseTypeKind	kind
	)

Returns the list of all basic types of the chosen kind.

Parameters

typedb	Types Database instance
kind	Kind of the types to list

Definition at line 100 of file base.c.

                                                                                                       {
    rz_return_val_if_fail(typedb, NULL);
    RzList *types = rz_list_new();
    struct list_kind lk = { types, kind };
    ht_pp_foreach(typedb->types, base_type_kind_collect_cb, &lk);
    return types;
}

References base_type_kind_collect_cb(), list_kind::kind, NULL, rz_list_new(), rz_return_val_if_fail, types, and rz_type_db_t::types.

Referenced by rz_core_types_enum_as_c_all(), rz_core_types_enum_print_all(), rz_core_types_struct_as_c_all(), rz_core_types_struct_print_all(), rz_core_types_struct_print_format_all(), rz_core_types_typedef_as_c_all(), rz_core_types_typedef_print_all(), rz_core_types_union_as_c_all(), rz_core_types_union_print_all(), rz_core_types_union_print_format_all(), rz_type_db_enum_names(), rz_type_db_find_enums_by_val(), rz_type_db_struct_names(), rz_type_db_typedef_names(), and rz_type_db_union_names().

rz_type_db_get_compound_type()

RZ_API RZ_BORROW RzBaseType* rz_type_db_get_compound_type	(	const RzTypeDB *	typedb,
		RZ_NONNULL const char *	name
	)

Searches for the compound RzBaseType in the types database given the name.

Returns all types except atomic - structures, unions, enums, typedefs

Parameters

typedb	Type Database instance
name	Name of the RzBaseType

Definition at line 234 of file base.c.

                                                                                                               {
    rz_return_val_if_fail(name, NULL);
    RzBaseType *t = rz_type_db_get_base_type(typedb, name);
    if (!t) {
        RZ_LOG_ERROR("Cannot find type \"%s\"\n", name);
        return NULL;
    }
    if (t->kind == RZ_BASE_TYPE_KIND_ATOMIC) {
        RZ_LOG_ERROR("Atomic type \"%s\"\n", name);
        return NULL;
    }
    return t;
}

References rz_base_type_t::kind, NULL, RZ_BASE_TYPE_KIND_ATOMIC, RZ_LOG_ERROR, rz_return_val_if_fail, and rz_type_db_get_base_type().

Referenced by rz_type_db_edit_base_type(), and rz_types_open_editor().

rz_type_db_save_base_type()

RZ_API void rz_type_db_save_base_type	(	const RzTypeDB *	typedb,
		const RzBaseType *	type
	)

Saves RzBaseType into the Types DB.

Parameters

typedb	Type Database instance
type	RzBaseType to save

Definition at line 191 of file base.c.

                                                                                      {
    rz_return_if_fail(typedb && type && type->name);
    ht_pp_insert(typedb->types, type->name, (void *)type);
}

References rz_return_if_fail, type, and rz_type_db_t::types.

Referenced by parse_atomic_type(), parse_enum(), parse_enum_type(), parse_structure(), parse_structure_type(), parse_type_nest(), parse_typedef(), and parse_union().