Struct midenc_codegen_masm::Library

pub struct Library {
    pub segments: DataSegmentTable,
    /* private fields */
}

A Library represents a set of modules and its dependencies, which are compiled/assembled together into a single artifact, and then linked into a Program for execution at a later time.

Modules are stored in a Library in a B-tree map, keyed by the module name. This is done to make accessing modules by name efficient, and to ensure a stable ordering for compiled programs when emitted as text.

Fields

segments: DataSegmentTable

The data segment table for this program

Implementations

impl Library

pub fn empty() -> Self

Create a new, empty Library

pub fn new<M>(segments: DataSegmentTable, modules: M) -> Self

where M: IntoIterator<Item = Box<Module>>,

Create a new Library initialized from a DataSegmentTable and a set of Modules.

You should generally prefer to use Library::from_hir, but this constructor allows you to manually produce a MASM program from its constituent parts.

pub fn from_hir( program: &Program, globals: &GlobalVariableAnalysis<Program>, ) -> Self

Create a new Library initialized from an hir::Program.

The resulting Library will have the following:

• Data segments described by the original hir::Program

None of the HIR modules will have been added yet

pub fn link_kernel(&mut self, kernel: KernelLibrary)

Link this Library against the given kernel during assembly

pub fn link_library(&mut self, library: CompiledLibrary)

Link this Library against the given library during assembly

pub fn link_libraries(&self) -> &[CompiledLibrary]

Get the set of CompiledLibrary this library links against

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

Freezes this library, preventing further modifications

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

Get an iterator over the modules in this library

pub fn unwrap_frozen_modules(&self) -> &FrozenModuleTree

Access the frozen module tree of this library, and panic if not frozen

pub fn insert(&mut self, module: Box<Module>)

Insert a module into this library.

The insertion order is not preserved - modules are ordered by name.

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

pub fn get<Q>(&self, name: &Q) -> Option<&Module>

where Q: ?Sized + Ord, Ident: Borrow<Q>,

Get a reference to a module in this library by name

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

where Ident: PartialEq<N>,

Returns true if this library contains a Module named name

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

Write this Library to the given output directory.

pub fn assemble( &self, session: &Session, ) -> Result<Arc<CompiledLibrary>, Report>

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Library

fn default() -> Library

Returns the “default value” for a type.

impl Display for Library

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

Formats the value using the given formatter.

impl Emit for Library

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