scan.h File Reference

#include <ctu_scan_api.h>
#include "core/analyze.h"
#include "core/compiler.h"
#include "core/text.h"
#include <stddef.h>
#include <stdbool.h>

Include dependency graph for scan.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	scan_t
	a source file scanner More...
#define	CT_SCAN_BUILTIN_NAME   "<builtin>"
	the name of all builtin scanners builtin scanners are distinguished by their source language which maps to the source driver/plugin/target More...
CT_NODISCARD size_t	size
CT_NODISCARD CT_PUREFN CT_SCAN_API const char *	scan_language (const scan_t *scan)
	get the source language of a scanner More...
CT_NODISCARD CT_PUREFN CT_SCAN_API const char *	scan_path (const scan_t *scan)
	get the path of a scanner More...
CT_NODISCARD CT_PUREFN CT_SCAN_API void *	scan_get (scan_t *scan)
	get the compiled object from a scanner More...
CT_SCAN_API void	scan_set (scan_t *scan, void *value)
	set the compiled object of a scanner More...
CT_SCAN_API void	scan_set_context (scan_t *scan, void *value)
	get the context of a scanner More...
CT_NODISCARD CT_PUREFN CT_SCAN_API void *	scan_get_context (const scan_t *scan)
	get the context of a scanner More...
CT_NODISCARD CT_PUREFN CT_SCAN_API text_view_t	scan_source (const scan_t *scan)
	get a text span of the scanners contents More...
CT_NODISCARD CT_PUREFN CT_SCAN_API arena_t *	scan_get_arena (const scan_t *scan)
	get the arena of a scanner More...
CT_NODISCARD	STA_RET_RANGE (0, size) CT_NOALIAS CT_SCAN_API size_t scan_read(scan_t *scan
	read data from a scanner More...
CT_NODISCARD	STA_WRITES (size) void *dst
CT_NODISCARD CT_SCAN_API scan_t *	scan_io (const char *language, io_t *io, arena_t *arena)
	create a scanner from an io source More...
CT_NODISCARD CT_SCAN_API scan_t *	scan_builtin (const char *language, arena_t *arena)
	create a builtin scanner More...
CT_NODISCARD CT_PUREFN CT_SCAN_API bool	scan_is_builtin (const scan_t *scan)
	check if a scanner is the builtin scanner More...

Macro Definition Documentation

CT_SCAN_BUILTIN_NAME

#define CT_SCAN_BUILTIN_NAME   "<builtin>"

the name of all builtin scanners builtin scanners are distinguished by their source language which maps to the source driver/plugin/target

Function Documentation

scan_builtin()

CT_NODISCARD CT_SCAN_API scan_t* scan_builtin	(	const char *	language,
		arena_t *	arena
	)

create a builtin scanner

Parameters

language	the language of the scanner
arena	the allocator to use

Returns

the builtin scanner

Definition at line 33 of file scan.c.

scan_get()

CT_NODISCARD CT_PUREFN CT_SCAN_API void* scan_get

(

scan_t *

scan

)

get the compiled object from a scanner

Parameters

scan	the scanner to get the user data of

Returns

the user data of scan

Definition at line 72 of file scan.c.

scan_get_arena()

CT_NODISCARD CT_PUREFN CT_SCAN_API arena_t* scan_get_arena

(

const scan_t *

scan

)

get the arena of a scanner

Parameters

scan	the scanner to get the arena of

Returns

the arena of scan

Definition at line 113 of file scan.c.

scan_get_context()

CT_NODISCARD CT_PUREFN CT_SCAN_API void* scan_get_context

(

const scan_t *

scan

)

get the context of a scanner

Parameters

scan	the scanner to get the context of

Returns

the context of scan

Definition at line 88 of file scan.c.

scan_io()

CT_NODISCARD CT_SCAN_API scan_t* scan_io	(	const char *	language,
		io_t *	io,
		arena_t *	arena
	)

create a scanner from an io source

Parameters

language	the language of the source
io	the io source to use
arena	the allocator to use

Returns

the created scanner

Definition at line 121 of file scan.c.

scan_is_builtin()

CT_NODISCARD CT_PUREFN CT_SCAN_API bool scan_is_builtin

(

const scan_t *

scan

)

check if a scanner is the builtin scanner

Parameters

scan	the scanner to check

Returns

true if scan is the builtin scanner

Definition at line 41 of file scan.c.

scan_language()

CT_NODISCARD CT_PUREFN CT_SCAN_API const char* scan_language

(

const scan_t *

scan

)

get the source language of a scanner

Parameters

scan	the scanner to get the language of

Returns

the language of scan

Definition at line 48 of file scan.c.

scan_path()

CT_NODISCARD CT_PUREFN CT_SCAN_API const char* scan_path

(

const scan_t *

scan

)

get the path of a scanner

Parameters

scan	the scanner to get the path of

Returns

the path of scan

Definition at line 56 of file scan.c.

scan_set()

CT_SCAN_API void scan_set	(	scan_t *	scan,
		void *	value
	)

set the compiled object of a scanner

Parameters

scan	the scanner to set the user data of
value	the new user data

Definition at line 64 of file scan.c.

scan_set_context()

CT_SCAN_API void scan_set_context	(	scan_t *	scan,
		void *	value
	)

get the context of a scanner

Parameters

scan	the scanner to get the context of
value	the new context

Definition at line 80 of file scan.c.

scan_source()

CT_NODISCARD CT_PUREFN CT_SCAN_API text_view_t scan_source

(

const scan_t *

scan

)

get a text span of the scanners contents

Parameters

scan	the scanner to get the text of

Returns

the text of scan

Definition at line 96 of file scan.c.

STA_RET_RANGE()

CT_NODISCARD STA_RET_RANGE	(	0	,
		size
	)

read data from a scanner

Parameters

scan	the scanner to read from
dst	the destination to read into, must be at least size bytes
size	the number of bytes to read

Returns

the number of bytes read

STA_WRITES()

CT_NODISCARD STA_WRITES

(

size

)

Variable Documentation

size

CT_NODISCARD size_t size

Definition at line 128 of file scan.h.