Struct SourceFile 

pub struct SourceFile {
    pub doc: Option<DocBlock>,
    pub name: QualifiedName,
    pub statements: StatementList,
    pub source: String,
    pub hash: u64,
    /* private fields */
}

µcad source file

Fields

doc: Option<DocBlock>

Documentation.

name: QualifiedName

Qualified name of the file if loaded from externals

statements: StatementList

Root code body.

source: String

Source file string, TODO: might be a &’a str in the future

hash: u64

Hash of the source file

This hash is calculated from the source code itself This is used to map SrcRef -> SourceFile

Implementations

impl SourceFile

pub fn load(path: impl AsRef<Path> + Debug) -> ParseResult<Rc<Self>>

Load µcad source file from given path

pub fn load_with_name( path: impl AsRef<Path> + Debug, name: QualifiedName, ) -> ParseResult<Rc<Self>>

Load µcad source file from given path

pub fn load_from_str( name: Option<&str>, path: impl AsRef<Path>, source_str: &str, ) -> ParseResult<Rc<Self>>

Create SourceFile from string The hash of the result will be of crate::from_str!().

pub fn name_from_path(path: impl AsRef<Path>) -> QualifiedName

Get the source file name from path.

impl SourceFile

pub fn symbolize( &self, visibility: Visibility, context: &mut ResolveContext, ) -> ResolveResult<Symbol>

Create symbol from definition.

impl SourceFile

pub fn new( doc: Option<DocBlock>, statements: StatementList, source: String, hash: u64, ) -> Self

Create new source file from existing source.

pub fn filename(&self) -> PathBuf

Return filename of loaded file or <no file>

pub fn set_filename(&mut self, path: impl AsRef<Path>)

Return filename of loaded file or <no file>

pub fn filename_as_str(&self) -> &str

Return filename of loaded file or <no file>

pub fn id(&self) -> Identifier

Return the module name from the file name

pub fn get_line(&self, line: usize) -> Option<&str>

get a specific line

• line: line number beginning at 0

pub fn get_code(&self, src_ref: &SrcRef) -> &str

get a specific line

• line: line number beginning at 0

pub fn num_lines(&self) -> usize

return number of source code lines

pub fn set_name(&mut self, name: QualifiedName)

Set file name.

Trait Implementations

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFile

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

Formats the value using the given formatter.

impl Default for SourceFile

fn default() -> SourceFile

Returns the “default value” for a type.

impl Display for SourceFile

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

Formats the value using the given formatter.

impl Doc for SourceFile

fn doc(&self) -> Option<DocBlock>

Return documentation

impl Parse for SourceFile

fn parse(pair: Pair<'_>) -> ParseResult<Self>

impl SrcReferrer for SourceFile

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl TreeDisplay for SourceFile

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

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.

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

Display as tree starting at depth 0.

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

Display as tree starting at given depth in debug mode

fn write_tree(&self, f: &mut impl Write) -> Result<()>

Display as tree starting at depth 0 into a file