Struct TestContext 

pub struct TestContext { /* private fields */ }

A TestContext provides common functionality for all tests which interact with an Assembler.

It is used by constructing it with TestContext::default(), which will initialize the diagnostic reporting infrastructure, and construct a default Assembler instance for you. You can then optionally customize the context, or start invoking any of its test helpers.

Some of the assertion macros defined above require a TestContext, so be aware of that.

Implementations

impl TestContext

pub fn new() -> Self

pub fn source_manager(&self) -> Arc<dyn SourceManager>

pub fn parse_forms(&self, source: Arc<SourceFile>) -> Result<Vec<Form>, Report>

Parse the given source file into a vector of top-level Forms.

This does not run semantic analysis, or construct a Module from the parsed forms, and is largely intended for low-level testing of the parser.

pub fn parse_program(&self, source: impl Parse) -> Result<Box<Module>, Report>

Parse the given source file into an executable Module.

This runs semantic analysis, and the returned module is guaranteed to be syntactically valid.

pub fn parse_kernel(&self, source: impl Parse) -> Result<Box<Module>, Report>

Parse the given source file into a kernel Module.

This runs semantic analysis, and the returned module is guaranteed to be syntactically valid.

pub fn parse_module(&self, source: impl Parse) -> Result<Box<Module>, Report>

Parse the given source file into an anonymous library Module.

This runs semantic analysis, and the returned module is guaranteed to be syntactically valid.

pub fn parse_module_with_path( &self, path: impl AsRef<Path>, source: impl Parse, ) -> Result<Box<Module>, Report>

Parse the given source file into a library Module with the given fully-qualified path.

pub fn add_module(&mut self, module: impl Parse) -> Result<(), Report>

Add module to the Assembler constructed by this context, making it available to other modules.

pub fn add_module_from_source( &mut self, path: impl AsRef<Path>, source: impl Parse, ) -> Result<(), Report>

Add a module to the Assembler constructed by this context, with the fully-qualified name path, by parsing it from the provided source file.

This will fail if the module cannot be parsed, fails semantic analysis, or conflicts with a previously added module within the assembler.

pub fn add_library( &mut self, library: impl AsRef<Library>, ) -> Result<(), Report>

Add the modules of library to the Assembler constructed by this context.

pub fn assemble(&self, source: impl Parse) -> Result<Program, Report>

Compile a [Program] from source using the Assembler constructed by this context.

NOTE: Any modules added by, e.g. add_module, will be available to the executable module represented in source.

pub fn assemble_library( &self, modules: impl IntoIterator<Item = Box<Module>>, ) -> Result<Library, Report>

Compile a Library from modules using the Assembler constructed by this context.

NOTE: Any modules added by, e.g. add_module, will be available to the library

pub fn assemble_module( &self, _path: impl AsRef<Path>, _module: impl Parse, ) -> Result<Vec<Word>, Report>

Compile a module from source, with the fully-qualified name path, to MAST, returning the MAST roots of all the exported procedures of that module.

Trait Implementations

impl Default for TestContext

fn default() -> Self

Returns the “default value” for a type.