Driver utility functions

Utility functions for the runtime. More...

Collaboration diagram for Driver utility functions:

Data Structures
struct	search_t
struct	decl_search_t

Functions
CT_UTIL_API void *	util_select_decl (tree_t *sema, search_t search, const char *name)
	search for a declaration by name in a set of tags More...
CT_UTIL_API tree_t *	util_search_namespace (tree_t *sema, search_t search, const node_t *node, const vector_t *path, bool *is_imported)
	search for a namespace given a path, ignoring the last element in the path More...
CT_UTIL_API tree_t *	util_search_path (tree_t *sema, const decl_search_t *search, const node_t *node, vector_t *path)
	search for a decl given a path More...
CT_UTIL_API tree_t *	util_search_qualified (tree_t *sema, const decl_search_t *search, const node_t *node, const char *mod, const char *name)
	search for a decl inside a module More...
CT_UTIL_API bool	util_eval_digit (mpz_t value, const tree_t *expr)
	evaluate a digit expression More...
CT_BEGIN_API CT_UTIL_API text_t	util_text_escape (logger_t *reports, const node_t *node, STA_READS(length) const char *text, size_t length, arena_t *arena)
	escape a string literal into a string More...
CT_UTIL_API bool	util_text_has_escapes (STA_READS(length) const char *text, size_t length)
CT_BEGIN_API CT_UTIL_API bool	util_types_equal (const tree_t *lhs, const tree_t *rhs)
	compare two types for strict equality compares two types for exact equality, does not follow typedefs More...
CT_UTIL_API bool	util_types_comparable (tree_cookie_t *cookie, const tree_t *lhs, const tree_t *rhs)
	query two types for comparability in binary logic operations More...
CT_UTIL_API tree_t *	util_type_cast (const tree_t *dst, tree_t *expr)
	attempt to cast an expression to a type More...
CT_UTIL_API bool	util_length_bounded (size_t length)
	check if the length of an array is bounded More...
CT_UTIL_API const char *	util_length_name (size_t length)
	get the pretty name of a length return either the length as a string or "unbounded" if the length is unbounded More...
CT_UTIL_API bool	util_type_is_aggregate (const tree_t *type)
CT_UTIL_API bool	util_type_is_pointer (const tree_t *type)
CT_UTIL_API bool	util_type_is_array (const tree_t *type)
CT_UTIL_API bool	util_type_is_opaque (const tree_t *type)
CT_UTIL_API bool	util_type_is_reference (const tree_t *type)
CT_UTIL_API bool	util_type_is_digit (const tree_t *type)

Detailed Description

Utility functions for the runtime.

Function Documentation

util_eval_digit()

CT_UTIL_API bool util_eval_digit	(	mpz_t	value,
		const tree_t *	expr
	)

evaluate a digit expression

Parameters

value	the value to set
expr	the expression to evaluate

Returns

true if the expression was evaluated, false otherwise

Definition at line 293 of file util.c.

util_length_bounded()

CT_UTIL_API bool util_length_bounded

(

size_t

length

)

check if the length of an array is bounded

Parameters

length

the length of the array

Returns

true if the length is bounded, false otherwise

Definition at line 312 of file util.c.

util_length_name()

CT_UTIL_API const char* util_length_name

(

size_t

length

)

get the pretty name of a length return either the length as a string or "unbounded" if the length is unbounded

Parameters

length

the length to get the name of

Returns

the name of the length

Definition at line 317 of file util.c.

util_search_namespace()

CT_UTIL_API tree_t* util_search_namespace	(	tree_t *	sema,
		search_t	search,
		const node_t *	node,
		const vector_t *	path,
		bool *	is_imported
	)

search for a namespace given a path, ignoring the last element in the path

Parameters

sema	the sema context
search	the search options
node	the node to report errors on
path	the path to search
is_imported	whether the namespace was imported

Returns

the namespace if found, an error otherwise

Definition at line 66 of file query.c.

util_search_path()

CT_UTIL_API tree_t* util_search_path	(	tree_t *	sema,
		const decl_search_t *	search,
		const node_t *	node,
		vector_t *	path
	)

search for a decl given a path

Parameters

sema	the sema context
search	the search options
node	the node to report errors on
path	the path to search

Returns

tree_t* the decl if found, an error otherwise

Definition at line 92 of file query.c.

util_search_qualified()

CT_UTIL_API tree_t* util_search_qualified	(	tree_t *	sema,
		const decl_search_t *	search,
		const node_t *	node,
		const char *	mod,
		const char *	name
	)

search for a decl inside a module

Parameters

sema	the sema context
search	the search options
node	the node to report errors on
mod	the module to search in
name	the name of the decl

Returns

tree_t*

Definition at line 125 of file query.c.

util_select_decl()

CT_UTIL_API void* util_select_decl	(	tree_t *	sema,
		search_t	search,
		const char *	name
	)

search for a declaration by name in a set of tags

Parameters

sema	the sema context
search	the tags ids to search
name	the name of the decl

Returns

the decl if found, an error otherwise

Definition at line 16 of file util.c.

util_text_escape()

CT_BEGIN_API CT_UTIL_API text_t util_text_escape	(	logger_t *	reports,
		const node_t *	node,
		STA_READS(length) const char *	text,
		size_t	length,
		arena_t *	arena
	)

escape a string literal into a string

Parameters

reports	the reports to use
node	the node to report errors on
text	the text to escape
length	the length of the text
arena	the arena to allocate the escaped text in

Returns

the escaped text

util_text_has_escapes()

CT_UTIL_API bool util_text_has_escapes	(	STA_READS(length) const char *	text,
		size_t	length
	)

util_type_cast()

CT_UTIL_API tree_t* util_type_cast	(	const tree_t *	dst,
		tree_t *	expr
	)

attempt to cast an expression to a type

Parameters

dst	the desired type
expr	the expression to try and cast

Returns

tree_t* the casted expression or tree_error if the cast could not be done

Definition at line 212 of file util.c.

util_type_is_aggregate()

CT_UTIL_API bool util_type_is_aggregate

(

const tree_t *

type

)

Definition at line 323 of file util.c.

util_type_is_array()

CT_UTIL_API bool util_type_is_array

(

const tree_t *

type

)

Definition at line 335 of file util.c.

util_type_is_digit()

CT_UTIL_API bool util_type_is_digit

(

const tree_t *

type

)

Definition at line 353 of file util.c.

util_type_is_opaque()

CT_UTIL_API bool util_type_is_opaque

(

const tree_t *

type

)

Definition at line 341 of file util.c.

util_type_is_pointer()

CT_UTIL_API bool util_type_is_pointer

(

const tree_t *

type

)

Definition at line 329 of file util.c.

util_type_is_reference()

CT_UTIL_API bool util_type_is_reference

(

const tree_t *

type

)

Definition at line 347 of file util.c.

util_types_comparable()

CT_UTIL_API bool util_types_comparable	(	tree_cookie_t *	cookie,
		const tree_t *	lhs,
		const tree_t *	rhs
	)

query two types for comparability in binary logic operations

Parameters

lhs	the left hand side type
rhs	the right hand side type

Returns

true if the types are comparable, false otherwise

Definition at line 69 of file util.c.

util_types_equal()

CT_BEGIN_API CT_UTIL_API bool util_types_equal	(	const tree_t *	lhs,
		const tree_t *	rhs
	)

compare two types for strict equality compares two types for exact equality, does not follow typedefs

Parameters

lhs	the left hand side type
rhs	the right hand side type

Returns

true if the types are equal, false otherwise

Definition at line 33 of file util.c.