Struct midenc_session::Session

pub struct Session {
    pub name: String,
    pub options: Options,
    pub source_manager: Arc<dyn SourceManager>,
    pub diagnostics: Arc<DiagnosticsHandler>,
    pub inputs: Vec<InputFile>,
    pub output_files: OutputFiles,
    pub statistics: Statistics,
}

This struct provides access to all of the metadata and configuration needed during a single compilation session.

Fields

name: String

The name of this session

options: Options

Configuration for the current compiler session

source_manager: Arc<dyn SourceManager>

The current source manager

diagnostics: Arc<DiagnosticsHandler>

The current diagnostics handler

inputs: Vec<InputFile>

The inputs being compiled

output_files: OutputFiles

The outputs to be produced by the compiler during compilation

statistics: Statistics

Statistics gathered from the current compiler session

Implementations

impl Session

pub fn new<I>( inputs: I, output_dir: Option<PathBuf>, output_file: Option<OutputFile>, target_dir: PathBuf, options: Options, emitter: Option<Arc<dyn Emitter>>, source_manager: Arc<dyn SourceManager>, ) -> Self

where I: IntoIterator<Item = InputFile>,

pub fn with_project_type(self, ty: ProjectType) -> Self

pub fn get_flag(&self, name: &str) -> bool

Get the value of a custom flag with action FlagAction::SetTrue or FlagAction::SetFalse

pub fn get_flag_count(&self, name: &str) -> usize

Get the count of a specific custom flag with action FlagAction::Count

pub fn get_flag_value<T>(&self, name: &str) -> Option<&T>

where T: Any + Clone + Send + Sync + 'static,

Get the value of a specific custom flag

pub fn get_flag_values<T>(&self, name: &str) -> Option<ValuesRef<'_, T>>

where T: Any + Clone + Send + Sync + 'static,

Iterate over values of a specific custom flag

pub fn matches(&self) -> &ArgMatches

Get the remaining clap::ArgMatches left after parsing the base session configuration

pub fn name(&self) -> &str

The name of this session (used as the name of the project, output file, etc.)

pub fn out_file(&self) -> OutputFile

Get the OutputFile to write the assembled MAST output to

pub fn parse_only(&self) -> bool

Returns true if the compiler should exit after parsing the input

pub fn analyze_only(&self) -> bool

Returns true if the compiler should exit after performing semantic analysis

pub fn rewrite_only(&self) -> bool

Returns true if the compiler should exit after applying rewrites to the IR

pub fn should_link(&self) -> bool

Returns true if an OutputType that requires linking + assembly was requested

pub fn should_codegen(&self) -> bool

Returns true if an OutputType that requires generating Miden Assembly was requested

pub fn should_assemble(&self) -> bool

Returns true if an OutputType that requires assembling MAST was requested

pub fn should_emit(&self, ty: OutputType) -> bool

Returns true if the given OutputType should be emitted as an output

pub fn should_print_ir(&self, pass: &str) -> bool

Returns true if IR should be printed to stdout, after executing a pass named pass

pub fn should_print_cfg(&self, pass: &str) -> bool

Returns true if CFG should be printed to stdout, after executing a pass named pass

pub fn print(&self, ir: impl Emit, pass: &str) -> Result<()>

Print the given emittable IR to stdout, as produced by a pass with name pass

pub fn emit_to(&self, ty: OutputType, name: Option<Symbol>) -> Option<PathBuf>

Get the path to emit the given OutputType to

pub fn emit<E: Emit>(&self, mode: OutputMode, item: &E) -> Result<()>

Emit an item to stdout/file system depending on the current configuration

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.