Skip to main content

Compiler

Struct Compiler 

Source
pub struct Compiler {
    pub program_name: Option<String>,
    pub statements_before_dce: u32,
    pub statements_after_dce: u32,
    /* private fields */
}
Expand description

The primary entry point of the Leo compiler.

Fields§

§program_name: Option<String>

The program name,

§statements_before_dce: u32

How many statements were in the AST before DCE?

§statements_after_dce: u32

How many statements were in the AST after DCE?

Implementations§

Source§

impl Compiler

Source

pub fn network(&self) -> NetworkName

Source

pub fn parse_program( &mut self, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<()>

Parses the given source into a program AST and stores it in the compiler state.

The source file and any provided module sources are first registered in the session source map so spans can be resolved correctly. The parser then constructs the program AST from the main source and its modules.

After parsing, this verifies that the program scope name matches the expected program name (from program.json or the test filename). The resulting AST is stored in self.state.ast, and optionally written to disk if configured.

Source

pub fn parse_and_return_program( &mut self, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<Program>

Simple wrapper around parse_program that also returns a program AST.

Source

pub fn parse_and_return_library( &mut self, library_name: &str, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<Library>

Simple wrapper around parse_library that also returns a library AST.

Source

pub fn parse_library( &mut self, library_name: Symbol, source: &str, filename: FileName, modules: &[(&str, FileName)], ) -> Result<()>

Parses a library source (and its submodules) into a library AST.

All source strings are registered in the session source map so span information can be resolved correctly. The resulting AST is stored in self.state.ast.

Source

pub fn new( expected_program_name: Option<String>, is_test: bool, handler: Handler, node_builder: Rc<NodeBuilder>, output_directory: PathBuf, compiler_options: Option<CompilerOptions>, import_stubs: IndexMap<Symbol, Stub>, network: NetworkName, ) -> Self

Returns a new Leo compiler.

Source

pub fn do_pass<P: Pass>(&mut self, input: P::Input) -> Result<P::Output>

Source

pub fn frontend_passes(&mut self) -> Result<()>

Runs all frontend passes: NameValidation through StaticAnalyzing.

Source

pub fn intermediate_passes( &mut self, ) -> Result<(Program, IndexMap<String, Program>)>

Runs the compiler stages.

Returns the generated ABIs (primary and imports), which are captured immediately after monomorphisation to ensure all types are resolved, but not yet lowered.

Source

pub fn compile( &mut self, source: &str, filename: FileName, modules: &Vec<(&str, FileName)>, ) -> Result<Compiled>

Compiles a program from a given source string and a list of module sources.

§Arguments
  • source - The main source code as a string slice.
  • filename - The name of the main source file.
  • modules - A vector of tuples where each tuple contains:
    • A module source as a string slice.
    • Its associated FileName.
§Returns
  • Ok(CompiledPrograms) containing the generated bytecode and ABI if compilation succeeds.
  • Err(CompilerError) if any stage of the pipeline fails.
Source

pub fn compile_from_directory( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Compiled>

Compiles a program from a source file and its associated module files in the same directory tree.

Source

pub fn compile_from_directory_with_file_source( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Compiled>

Compiles a program from a source file using the given file source.

Source

pub fn parse_program_from_directory( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Program>

Parses a program from a source file and its associated module files in the same directory tree.

Source

pub fn parse_program_from_directory_with_file_source( &mut self, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Program>

Parses a program from a source file using the given file source.

Source

pub fn parse_library_from_directory( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, ) -> Result<Library>

Parses a program from a source file and its associated module files in the same directory tree.

Source

pub fn parse_library_from_directory_with_file_source( &mut self, library_name: Symbol, entry_file_path: impl AsRef<Path>, source_directory: impl AsRef<Path>, file_source: &impl FileSource, ) -> Result<Library>

Parses a library from a source file.

Source

pub fn add_import_stubs(&mut self) -> Result<()>

Resolves and registers all import stubs for the current program.

This method performs a graph traversal over the program’s import relationships to:

  1. Establish parent–child relationships between stubs based on imports.
  2. Collect all reachable stubs in traversal order.
  3. Store the explored stubs back into self.state.ast.ast.stubs.

The traversal starts from the imports of the main program and recursively follows their transitive dependencies. Any missing stub during traversal results in an error.

§Returns
  • Ok(()) if all imports are successfully resolved and stubs are collected.
  • Err(CompilerError) if any imported program cannot be found.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more