Struct CompilationUnit

pub struct CompilationUnit { /* private fields */ }

CompilationUnit identifies an AS3 compilation unit and contains a source text.

Implementations

impl CompilationUnit

pub fn new(file_path: Option<String>, text: String) -> Rc<Self>

Constructs a source file in unparsed and non verified state.

pub fn file_path(&self) -> Option<String>

File path of the source or None if not a file.

pub fn text(&self) -> &String

Source text.

pub fn compiler_options(&self) -> Option<Rc<dyn Any>>

Compiler options.

pub fn set_compiler_options(&self, options: Option<Rc<dyn Any>>)

Set compiler options.

pub fn invalidated(&self) -> bool

Whether the source contains any errors after parsing and/or verification.

pub fn comments(&self) -> Vec<Rc<Comment>>

The comments present in the source file. To get mutable access to the collection of comments, use the comments_mut() method instead.

pub fn comments_mut(&self) -> RefMut<'_, Vec<Rc<Comment>>>

The comments present in the source file, as a mutable collection.

pub fn add_comment(&self, comment: Rc<Comment>)

Contributes a comment if there is no other comment in the same location.

pub fn diagnostics(&self) -> Vec<Diagnostic>

Diagnostics of the source file after parsing and/or verification.

pub fn nested_diagnostics(&self) -> Vec<Diagnostic>

Diagnostics of the source file after parsing and/or verification, including those of nested compilation units.

pub fn sort_diagnostics(&self)

Sort diagnostics from the compilation unit and any nested compilation units.

pub fn prevent_equal_offset_error(&self, location: &Location) -> bool

Determines whether to skip contributing an error when it occurs at the same offset of another error.

pub fn prevent_equal_offset_warning(&self, location: &Location) -> bool

Determines whether to skip contributing a warning when it occurs at the same offset of another warning.

pub fn included_from(&self) -> Option<Rc<CompilationUnit>>

If this compilation unit is subsequent of an include directive in another compilation unit, returns the compilation unit of that include directive.

pub fn nested_compilation_units(&self) -> Vec<Rc<CompilationUnit>>

pub fn add_nested_compilation_unit(self: &Rc<Self>, unit: Rc<CompilationUnit>)

pub fn add_diagnostic(&self, diagnostic: Diagnostic)

pub fn error_count(&self) -> u32

pub fn warning_count(&self) -> u32

pub fn get_line_number(&self, offset: usize) -> usize

Retrieves line number from an offset. The resulting line number is counted from one.

pub fn get_column(&self, offset: usize) -> usize

Returns the zero based column of an offset.

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

Retrieves offset from line number (counted from one).

pub fn get_line_offset_from_offset(&self, offset: usize) -> usize

Retrieves the offset from the corresponding line of an offset.

pub fn get_line_indent(&self, line: usize) -> usize

Trait Implementations

impl Debug for CompilationUnit

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

Formats the value using the given formatter.

impl Default for CompilationUnit

fn default() -> Self

Returns the “default value” for a type.