Struct midenc_codegen_masm::Module

pub struct Module {
    pub span: SourceSpan,
    pub kind: ModuleKind,
    pub id: Ident,
    pub name: LibraryPath,
    pub docs: Option<String>,
    pub imports: ModuleImportInfo,
    /* private fields */
}

This represents a single compiled Miden Assembly module in a form that is designed to integrate well with the rest of our IR. You can think of this as an intermediate representation corresponding to the Miden Assembly AST, i.e. miden_assembly::ast::Module.

Functions are stored in a Module in a linked list, so as to allow precise ordering of functions in the module body. We typically access all of the functions in a given module, so O(1) access to a specific function is not of primary importance.

Fields

span: SourceSpan

kind: ModuleKind

The kind of this module, e.g. kernel or library

id: Ident

The name of this module, e.g. std::math::u64

name: LibraryPath

docs: Option<String>

The module-scoped documentation for this module

imports: ModuleImportInfo

The modules to import, along with their local aliases

Implementations

impl Module

pub fn new(name: LibraryPath, kind: ModuleKind) -> Self

Create a new, empty Module with the given name and kind.

pub fn parse( kind: ModuleKind, path: LibraryPath, source: Arc<SourceFile>, ) -> Result<Self, Report>

Parse a Module from source using the given ModuleKind and LibraryPath

pub fn is_kernel(&self) -> bool

Returns true if this module is a kernel module

pub fn is_executable(&self) -> bool

Returns true if this module is an executable module

pub fn entrypoint(&self) -> Option<FunctionIdent>

If this module contains a function marked with the entrypoint attribute, return the fully-qualified name of that function

pub fn contains(&self, name: Ident) -> bool

Returns true if this module contains a Function name

pub fn from_ast(ast: &Module, span: SourceSpan) -> Self

pub fn freeze(self: Box<Self>) -> Arc<Module>

Freezes this program, preventing further modifications

pub fn functions(&self) -> impl Iterator<Item = &Function> + '_

Get an iterator over the functions in this module

pub fn unwrap_frozen_functions(&self) -> &FrozenFunctionList

Access the frozen functions list of this module, and panic if not frozen

pub fn push_back(&mut self, function: Box<Function>)

Append a function to the end of this module

NOTE: This function will panic if the module has been frozen

pub fn to_ast(&self, tracing_enabled: bool) -> Result<Module, Report>

Convert this module into its miden_assembly::ast::Module representation.

pub fn write_to_directory<P: AsRef<Path>>( &self, dir: P, session: &Session, ) -> Result<()>

Write this module to a new file under dir, assuming dir is the root directory for a program.

For example, if this module is named std::math::u64, then it will be written to <dir>/std/math/u64.masm

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for Module

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Emit for Module

fn name(&self) -> Option<Symbol>

The name of this item, if applicable

fn output_type(&self, _mode: OutputMode) -> OutputType

The output type associated with this item and the given mode

fn write_to<W: Write>( &self, writer: W, mode: OutputMode, session: &Session, ) -> Result<()>

Write this item to the given std::io::Write handle, using mode to determine the output type

fn write_to_stdout(&self, session: &Session) -> Result<(), Error>

Write this item to standard output, inferring the best OutputMode based on whether or not stdout is a tty or not

fn write_to_file( &self, path: &Path, mode: OutputMode, session: &Session, ) -> Result<(), Error>

Write this item to the given file path, using mode to determine the output type

impl PrettyPrint for Module

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

fn pretty_print(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Pretty-print this object to the given core::fmt::Formatter.