rz_annotated_code.h File Reference

#include <rz_types.h>
#include <rz_vector.h>

Go to the source code of this file.

Classes
struct	rz_code_annotation_t
	Annotations for the decompiled code are represented using this structure. More...
struct	rz_annotated_code_t
	This structure contains the decompiled code and all the annotations for the decompiled code. More...

Typedefs
typedef enum rz_syntax_highlight_type_t	RSyntaxHighlightType
typedef enum rz_code_annotation_type_t	RzCodeAnnotationType
typedef struct rz_code_annotation_t	RzCodeAnnotation
	Annotations for the decompiled code are represented using this structure. More...
typedef struct rz_annotated_code_t	RzAnnotatedCode
	This structure contains the decompiled code and all the annotations for the decompiled code. More...

Enumerations
enum	rz_syntax_highlight_type_t {   RZ_SYNTAX_HIGHLIGHT_TYPE_KEYWORD , RZ_SYNTAX_HIGHLIGHT_TYPE_COMMENT , RZ_SYNTAX_HIGHLIGHT_TYPE_DATATYPE , RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_NAME ,   RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_PARAMETER , RZ_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE , RZ_SYNTAX_HIGHLIGHT_TYPE_CONSTANT_VARIABLE , RZ_SYNTAX_HIGHLIGHT_TYPE_GLOBAL_VARIABLE }
enum	rz_code_annotation_type_t {   RZ_CODE_ANNOTATION_TYPE_OFFSET , RZ_CODE_ANNOTATION_TYPE_SYNTAX_HIGHLIGHT , RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME , RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE ,   RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE , RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE , RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER }

Functions
RZ_API RzAnnotatedCode *	rz_annotated_code_new (char *code)
	Create and initialize a RzAnnotatedCode structure and returns its pointer. More...
RZ_API void	rz_annotated_code_free (RzAnnotatedCode *code)
	Deallocates the dynamically allocated memory for the specified RzAnnotatedCode. More...
RZ_API void	rz_annotation_free (void *e, void *user)
	Deallocates dynamically allocated memory for the specified annotation. More...
RZ_API bool	rz_annotation_is_reference (RzCodeAnnotation *annotation)
	Checks if the specified annotation is a reference. More...
RZ_API bool	rz_annotation_is_variable (RzCodeAnnotation *annotation)
	Checks if the specified annotation is a function variable. More...
RZ_API void	rz_annotated_code_add_annotation (RzAnnotatedCode *code, RzCodeAnnotation *annotation)
	Inserts the specified annotation into the list of annotations in the specified RzAnnotatedCode. More...
RZ_API RzPVector *	rz_annotated_code_annotations_in (RzAnnotatedCode *code, size_t offset)
	Returns all annotations with range that contains the given offset. More...
RZ_API RzPVector *	rz_annotated_code_annotations_range (RzAnnotatedCode *code, size_t start, size_t end)
	Returns all annotations with range that overlap with the specified range. More...
RZ_API RzVector *	rz_annotated_code_line_offsets (RzAnnotatedCode *code)
	Returns the offset for every line of decompiled code in the specified RzAnnotatedCode. More...

Typedef Documentation

RSyntaxHighlightType

typedef enum rz_syntax_highlight_type_t RSyntaxHighlightType

RzAnnotatedCode

typedef struct rz_annotated_code_t RzAnnotatedCode

This structure contains the decompiled code and all the annotations for the decompiled code.

RzCodeAnnotation

typedef struct rz_code_annotation_t RzCodeAnnotation

Annotations for the decompiled code are represented using this structure.

RzCodeAnnotationType

typedef enum rz_code_annotation_type_t RzCodeAnnotationType

Represents the type of annnotation.

Enumeration Type Documentation

rz_code_annotation_type_t

enum rz_code_annotation_type_t

Represents the type of annnotation.

Enumerator
RZ_CODE_ANNOTATION_TYPE_OFFSET	Gives the offset of the specified range in annotation.
RZ_CODE_ANNOTATION_TYPE_SYNTAX_HIGHLIGHT	Represents the kind of data the specified range represents for highlighting purposes.
RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME	Specified range in annotation represents a function name.
RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE	Specified range in annotation represents a global variable.
RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE	Specified range in annotation represents a constant variable with an address.
RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE	Specified range in annotation represents a local variable.
RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER	Specified range in annotation represents a function parameter.

Definition at line 25 of file rz_annotated_code.h.

                                       {
    RZ_CODE_ANNOTATION_TYPE_OFFSET, 
    RZ_CODE_ANNOTATION_TYPE_SYNTAX_HIGHLIGHT, 
    RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME, 
    RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE, 
    RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE, 
    RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE, 
    RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER, 
    // ...
} RzCodeAnnotationType;

rz_syntax_highlight_type_t

enum rz_syntax_highlight_type_t

Enumerator
RZ_SYNTAX_HIGHLIGHT_TYPE_KEYWORD
RZ_SYNTAX_HIGHLIGHT_TYPE_COMMENT
RZ_SYNTAX_HIGHLIGHT_TYPE_DATATYPE
RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_NAME
RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_PARAMETER
RZ_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE
RZ_SYNTAX_HIGHLIGHT_TYPE_CONSTANT_VARIABLE
RZ_SYNTAX_HIGHLIGHT_TYPE_GLOBAL_VARIABLE

Definition at line 13 of file rz_annotated_code.h.

                                        {
    RZ_SYNTAX_HIGHLIGHT_TYPE_KEYWORD,
    RZ_SYNTAX_HIGHLIGHT_TYPE_COMMENT,
    RZ_SYNTAX_HIGHLIGHT_TYPE_DATATYPE,
    RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_NAME,
    RZ_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_PARAMETER,
    RZ_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE,
    RZ_SYNTAX_HIGHLIGHT_TYPE_CONSTANT_VARIABLE,
    RZ_SYNTAX_HIGHLIGHT_TYPE_GLOBAL_VARIABLE,
} RSyntaxHighlightType;

Function Documentation

rz_annotated_code_add_annotation()

RZ_API void rz_annotated_code_add_annotation	(	RzAnnotatedCode *	code,
		RzCodeAnnotation *	annotation
	)

Inserts the specified annotation into the list of annotations in the specified RzAnnotatedCode.

Parameters

code	Pointer to a RzAnnotatedCode.
annotation	Pointer to an annotation.

Definition at line 45 of file annotated_code.c.

                                                                                                  {
    rz_vector_push(&code->annotations, annotation);
}

References rz_vector_push().

rz_annotated_code_annotations_in()

RZ_API RzPVector* rz_annotated_code_annotations_in	(	RzAnnotatedCode *	code,
		size_t	offset
	)

Returns all annotations with range that contains the given offset.

Creates a RzPVector <RzCodeAnnotation> and inserts the pointers to all annotations in which annotation->start <= offset < annotation->end.

Parameters

code	Pointer to a RzAnnotatedCode.
offset	Offset.

Returns

Pointer to the RzPVector created.

Definition at line 49 of file annotated_code.c.

                                                                                         {
    RzPVector *r = rz_pvector_new(NULL);
    if (!r) {
        return NULL;
    }
    RzCodeAnnotation *annotation;
    rz_vector_foreach(&code->annotations, annotation) {
        if (offset >= annotation->start && offset < annotation->end) {
            rz_pvector_push(r, annotation);
        }
    }
    return r;
}

References test_evm::end, NULL, r, rz_pvector_new(), rz_pvector_push(), rz_vector_foreach, and rz_code_annotation_t::start.

rz_annotated_code_annotations_range()

RZ_API RzPVector* rz_annotated_code_annotations_range	(	RzAnnotatedCode *	code,
		size_t	start,
		size_t	end
	)

Returns all annotations with range that overlap with the specified range.

Creates an RzPVector <RzCodeAnnotation> and inserts the pointers to all annotations whose range overlap with range specified.

Parameters

code	Pointer to a RzAnnotatedCode.
start	Start of the range(inclusive).
end	End of the range(exclusive).

Returns

Pointer to the RzPVector created.

Definition at line 63 of file annotated_code.c.

                                                                                                       {
    RzPVector *r = rz_pvector_new(NULL);
    if (!r) {
        return NULL;
    }
    RzCodeAnnotation *annotation;
    rz_vector_foreach(&code->annotations, annotation) {
        if (start >= annotation->end || end < annotation->start) {
            continue;
        }
        rz_pvector_push(r, annotation);
    }
    return r;
}

References rz_code_annotation_t::end, NULL, r, rz_pvector_new(), rz_pvector_push(), rz_vector_foreach, and start.

Referenced by rz_annotated_code_line_offsets().

rz_annotated_code_free()

RZ_API void rz_annotated_code_free

(

RzAnnotatedCode *

code

)

Deallocates the dynamically allocated memory for the specified RzAnnotatedCode.

Parameters

code	Pointer to a RzAnnotatedCode.

Definition at line 36 of file annotated_code.c.

                                                          {
    if (!code) {
        return;
    }
    rz_vector_clear(&code->annotations);
    rz_free(code->code);
    rz_free(code);
}

References rz_free, and rz_vector_clear().

rz_annotated_code_line_offsets()

RZ_API RzVector* rz_annotated_code_line_offsets

(

RzAnnotatedCode *

code

)

Returns the offset for every line of decompiled code in the specified RzAnnotatedCode.

Creates an RzVector <ut64> and inserts the offsets for every seperate line of decompiled code in the specified RzAnnotatedCode. If a line of decompiled code doesn't have a unique offset, UT64_MAX is inserted as its offset.

Parameters

code	Pointer to a RzAnnotatedCode.

Returns

Pointer to the RzVector created.

Definition at line 78 of file annotated_code.c.

                                                                       {
    RzVector *r = rz_vector_new(sizeof(ut64), NULL, NULL);
    if (!r) {
        return NULL;
    }
    size_t cur = 0;
    size_t len = strlen(code->code);
    do {
        char *next = strchr(code->code + cur, '\n');
        size_t next_i = next ? (next - code->code) + 1 : len;
        RzPVector *annotations = rz_annotated_code_annotations_range(code, cur, next_i);
        ut64 offset = UT64_MAX;
        void **it;
        rz_pvector_foreach (annotations, it) {
            RzCodeAnnotation *annotation = *it;
            if (annotation->type != RZ_CODE_ANNOTATION_TYPE_OFFSET) {
                continue;
            }
            offset = annotation->offset.offset;
            break;
        }
        rz_vector_push(r, &offset);
        cur = next_i;
        rz_pvector_free(annotations);
    } while (cur < len);
    return r;
}

References len, NULL, rz_code_annotation_t::offset, r, rz_annotated_code_annotations_range(), RZ_CODE_ANNOTATION_TYPE_OFFSET, rz_pvector_foreach, rz_pvector_free(), rz_vector_new(), rz_vector_push(), rz_code_annotation_t::type, ut64(), and UT64_MAX.

rz_annotated_code_new()

RZ_API RzAnnotatedCode* rz_annotated_code_new

(

char *

code

)

Create and initialize a RzAnnotatedCode structure and returns its pointer.

This function creates and initializes a new RzAnnotatedCode structure with the specified decompiled code that's passed as an argument. Here, the argument code must be a string that can be deallocated. This will initialize RzVector <RzCodeAnnotation> annotations as well.

Parameters

code	A deallocatable character array.

Returns

Pointer to the new RzAnnotatedCode structure created.

Definition at line 8 of file annotated_code.c.

                                                          {
    RzAnnotatedCode *r = RZ_NEW0(RzAnnotatedCode);
    if (!r) {
        return NULL;
    }
    r->code = code;
    rz_vector_init(&r->annotations, sizeof(RzCodeAnnotation), rz_annotation_free, NULL);
    return r;
}

References code, NULL, r, rz_annotation_free(), RZ_NEW0, and rz_vector_init().

rz_annotation_free()

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

Deallocates dynamically allocated memory for the specified annotation.

This function recognizes the type of the specified annotation and frees memory that is dynamically allocated for it.

Parameters

e	Pointer to the annotation.
user	Always NULL for this function. Present here for this function to be of the type RzVectorFree.

Definition at line 18 of file annotated_code.c.

                                                    {
    (void)user;
    RzCodeAnnotation *annotation = e;
    if (annotation->type == RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME) {
        free(annotation->reference.name);
    } else if (annotation->type == RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE || annotation->type == RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER) {
        free(annotation->variable.name);
    }
}

References e, free(), rz_code_annotation_t::reference, RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME, RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER, RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE, rz_code_annotation_t::type, and rz_code_annotation_t::variable.

Referenced by rz_annotated_code_new().

rz_annotation_is_reference()

RZ_API bool rz_annotation_is_reference

(

RzCodeAnnotation *

annotation

)

Checks if the specified annotation is a reference.

This function recognizes the type of the specified annotation and returns true if its type is any of the following three: RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE, RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE, RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME

Parameters

annotation

Pointer to an annotation.

Returns

Returns true if the specified annotation is a reference.

Definition at line 28 of file annotated_code.c.

                                                                     {
    return (annotation->type == RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE || annotation->type == RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE || annotation->type == RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME);
}

References RZ_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE, RZ_CODE_ANNOTATION_TYPE_FUNCTION_NAME, RZ_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE, and rz_code_annotation_t::type.

rz_annotation_is_variable()

RZ_API bool rz_annotation_is_variable

(

RzCodeAnnotation *

annotation

)

Checks if the specified annotation is a function variable.

This function recognizes the type of the specified annotation and returns true if its type is any of the following two: RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE, RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER

Parameters

annotation

Pointer to an annotation.

Returns

Returns true if the specified annotation is a function variable.

Definition at line 32 of file annotated_code.c.

                                                                    {
    return (annotation->type == RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE || annotation->type == RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER);
}

References RZ_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER, RZ_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE, and rz_code_annotation_t::type.