Source location tracking

AST source position tracking. More...

Collaboration diagram for Source location tracking:

Data Structures
struct	node_t
	a position in a source file More...
struct	scan_t
	a source file scanner More...

Functions
CT_NODISCARD CT_PUREFN CT_SCAN_API const scan_t *	node_get_scan (const node_t *node)
	get the associated source file of a node More...
CT_NODISCARD CT_PUREFN CT_SCAN_API where_t	node_get_location (const node_t *node)
	get the location of a node inside its source file More...
CT_SCAN_API void	node_init (OUT_NOTNULL node_t *node, const scan_t *scan, where_t where)
	initialize a source node More...
CT_NODISCARD CT_SCAN_API node_t *	node_new (const scan_t *scan, where_t where)
	create a new node on the heap More...
CT_NODISCARD CT_SCAN_API node_t	node_make (const scan_t *scan, where_t where)
	create a new node on the stack More...
CT_NODISCARD CT_SCAN_API node_t *	node_builtin (const char *name, arena_t *arena)
	get the builtin node node used for drivers that declare builtin symbols More...
CT_NODISCARD CT_PUREFN CT_SCAN_API bool	node_is_builtin (const node_t *node)
	check if a node is the builtin node More...

Variables
CT_SCAN_API const where_t	kNowhere
	nowhere in a source file More...

Detailed Description

AST source position tracking.

Function Documentation

node_builtin()

CT_NODISCARD CT_SCAN_API node_t* node_builtin	(	const char *	name,
		arena_t *	arena
	)

get the builtin node node used for drivers that declare builtin symbols

Parameters

name	the name of the builtin file
arena	the arena to allocate from

Returns

the builtin node

Definition at line 11 of file node.c.

node_get_location()

CT_NODISCARD CT_PUREFN CT_SCAN_API where_t node_get_location

(

const node_t *

node

)

get the location of a node inside its source file

Parameters

node	the node to get the location of

Returns

the location of node

Definition at line 65 of file node.c.

node_get_scan()

CT_NODISCARD CT_PUREFN CT_SCAN_API const scan_t* node_get_scan

(

const node_t *

node

)

get the associated source file of a node

Parameters

node	the node to get the source file of

Returns

the source file of node

Definition at line 57 of file node.c.

node_init()

CT_SCAN_API void node_init	(	OUT_NOTNULL node_t *	node,
		const scan_t *	scan,
		where_t	where
	)

initialize a source node

Parameters

node	the node to initialize
scan	the scanner that this node is in
where	the location of this node

node_is_builtin()

CT_NODISCARD CT_PUREFN CT_SCAN_API bool node_is_builtin

(

const node_t *

node

)

check if a node is the builtin node

Parameters

node	the node to check

Returns

whether or not node is the builtin node

Definition at line 23 of file node.c.

node_make()

CT_NODISCARD CT_SCAN_API node_t node_make	(	const scan_t *	scan,
		where_t	where
	)

create a new node on the stack

Parameters

scan	the scanner that this node is in
where	the location of this node

Returns

the created node

Definition at line 49 of file node.c.

node_new()

CT_NODISCARD CT_SCAN_API node_t* node_new	(	const scan_t *	scan,
		where_t	where
	)

create a new node on the heap

Parameters

scan	the scanner that this node is in
where	the location of this node

Returns

the created node

Definition at line 40 of file node.c.

Variable Documentation

kNowhere

CT_SCAN_API const where_t kNowhere

extern

nowhere in a source file

Definition at line 8 of file node.c.