Struct Compiler 

pub struct Compiler {
    pub(crate) storage: Storage<Self>,
    pub(crate) inputs: Arc<Mutex<Inputs>>,
    pub(crate) vfs: Arc<dyn VirtualFileSystem>,
    pub(crate) debug_tx: Option<Sender<DebugEvent>>,
}

Fields

storage: Storage<Self>

inputs: Arc<Mutex<Inputs>>

Extra information about our inputs that the rest of Dada compiler doesn’t have to know (e.g., they’re URL etc).

This is behind a mutex but we have an invariant that we only modify things in the mutex if we have &mut access to the compiler.

vfs: Arc<dyn VirtualFileSystem>

Mediates all access to the file system.

debug_tx: Option<Sender<DebugEvent>>

Directory where debug logs are written.

Implementations

impl Compiler

pub fn new( vfs: impl VirtualFileSystem, debug_tx: Option<Sender<DebugEvent>>, ) -> Self

pub fn fork(&self) -> Fork<Self>

Create a “fork” of the compiler that has only &self access. This is meant to be used from another thread.

pub fn load_source_file( &mut self, source_url: &(impl ToUrl + ?Sized), ) -> Fallible<SourceFile>

Load the contents of source_url and then open it with those contents.

pub fn open_source_file( &mut self, source_url: &(impl ToUrl + ?Sized), contents: Result<String, String>, ) -> Fallible<SourceFile>

“Open” a source file with the given contents. This will find an existing SourceFile if one exists and update its content. If none exists, a new SourceFile will be created and the containing crate will be added.

pub fn get_previously_opened_source_file( &mut self, source_url: &(impl ToUrl + ?Sized), ) -> Fallible<SourceFile>

Get the SourceFile for the given path. Errors if no source file was opened yet.

pub fn add_crate_containing_source_file( &mut self, source_url: &Url, ) -> Fallible<Krate>

Given a .dada file, finds the enclosing crate and adds it into the list of crates. Given some path a/b/c.dada, we decide that c is a submodule of a/b if there exists a a/b.dada; otherwise, c is considered a crate of its own.

pub fn add_crate_with_root_path(&mut self, root_url: &Url) -> Fallible<Krate>

Add a crate that is rooted in the given dada file. The crate is named after the file name.

pub fn codegen_main_fn(&self, source_file: SourceFile) -> &Option<Vec<u8>>

Codegen the main function of a source file.

pub fn check_all(&self, source_file: SourceFile) -> Vec<&Diagnostic>

Compute all diagnostics for a source file.

pub fn probe_variable_type(&self, span: AbsoluteSpan) -> Option<String>

Return type of the variable found at the given span or None if there is no variable there.

pub fn probe_expression_type(&self, span: AbsoluteSpan) -> Option<String>

Return type of the variable found at the given span or None if there is no variable there.

pub fn probe_ast(&self, span: AbsoluteSpan) -> Option<String>

Return compact AST representation of the expression at the given span.

pub(crate) fn deduplicated(diagnostics: Vec<&Diagnostic>) -> Vec<&Diagnostic>

pub fn fn_asts(&self, source_file: SourceFile) -> String

pub fn root(&self) -> CompilationRoot

Access the [CompilationRoot], from which all crates and sources can be reached.

pub(crate) fn add_crate( &mut self, crate_name: String, new_source: impl Into<KrateSource>, ) -> Fallible<Krate>

Add a crate named crate_name sourced at source into our list.

We can never have two crates with the same name. If a crate k named crate_name already exists, we check if k has the same source. If so, the existing crate is returned. Otherwise, an error results.

pub(crate) fn get_source_file(&self, url: &Url) -> Option<SourceFile>

If there is a source file registered at path, return it. Else return None.

pub(crate) fn get_or_create_source_file(&self, url: &Url) -> SourceFile

Get or create a source-file at a given path.

Trait Implementations

impl Clone for Compiler

fn clone(&self) -> Compiler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Database for Compiler

fn salsa_event(&self, event: &dyn Fn() -> Event)

This function is invoked by the salsa runtime at various points during execution. You can customize what happens by implementing the [UserData][] trait. By default, the event is logged at level debug using tracing facade.

fn trigger_lru_eviction(&mut self)

Enforces current LRU limits, evicting entries if necessary.

fn synthetic_write(&mut self, durability: Durability)

A “synthetic write” causes the system to act as though some input of durability durability has changed, triggering a new revision. This is mostly useful for profiling scenarios.

fn report_untracked_read(&self)

Reports that the query depends on some state unknown to salsa.

fn ingredient_debug_name( &self, ingredient_index: IngredientIndex, ) -> Cow<'_, str>

Return the “debug name” (i.e., the struct name, etc) for an “ingredient”, which are the fine-grained components we use to track data. This is intended for debugging and the contents of the returned string are not semver-guaranteed.

fn unwind_if_revision_cancelled(&self)

Starts unwinding the stack if the current revision is cancelled.

fn attach<R>(&self, op: impl FnOnce(&Self) -> R) -> R

where Self: Sized,

Execute op with the database in thread-local storage for debug print-outs.

impl Db for Compiler

fn url_display(&self, url: &Url) -> String

Convert the url into a string suitable for showing the user.

fn root(&self) -> CompilationRoot

Access the [CompilationRoot], from which all crates and sources can be reached.

fn source_file<'db>( &'db self, krate: Krate, modules: &[Identifier<'db>], ) -> SourceFile

Load a source-file from the given directory. The modules is a list of parent modules that translates to a file path.

fn debug_tx(&self) -> Option<Sender<DebugEvent>>

Controls whether type-checking and other parts of the compiler will dump debug logs. If None is returned, no debugging output is emitted. If Some is returned, it should supply a directory where .json files will be created. The dada_debug crate will monitor this directory and serve up the information for use in debugging.

impl HasStorage for Compiler

fn storage(&self) -> &Storage<Self>

fn storage_mut(&mut self) -> &mut Storage<Self>

impl Db for Compiler