Struct Program 

pub struct Program {
    pub settings: Option<Settings>,
    pub global_variables: Vec<Variable>,
    pub player_variables: Vec<Variable>,
    pub subroutines: Vec<Subroutine>,
    pub rules: Vec<Rule>,
    /* private fields */
}

A complete Workshop program built from Workshop concepts.

Fields

settings: Option<Settings>

global_variables: Vec<Variable>

player_variables: Vec<Variable>

subroutines: Vec<Subroutine>

rules: Vec<Rule>

Implementations

impl Program

pub fn element_count( &self, catalog: &Catalog, ) -> Result<ElementCountReport, ElementCountError>

Count the canonical Workshop target represented by this program.

impl Program

pub fn new() -> Self

pub fn add_file(&mut self, file: SourceFile) -> FileId

Register a source file and return its public file identity.

pub fn global_variable(&mut self, variable: Variable) -> &mut Self

pub fn player_variable(&mut self, variable: Variable) -> &mut Self

pub fn subroutine(&mut self, subroutine: Subroutine) -> &mut Self

pub fn rule(&mut self, rule: Rule) -> &mut Self

pub fn source(&self, file: FileId) -> Option<&SourceDocument>

Return the retained source document for a parsed file.

pub fn set_rule_span( &mut self, rule: usize, span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored span of a public rule.

pub fn set_condition_span( &mut self, rule: usize, condition: usize, span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored span of a public rule condition value.

pub fn set_action_span( &mut self, rule: usize, action: usize, span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored span of a public action in its linear rule order.

pub fn set_action_argument_span( &mut self, rule: usize, action: usize, argument: usize, span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored span of a direct value argument of a public action.

pub fn set_global_variable_spans( &mut self, variable: usize, span: Option<Span>, name_span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored and identifier spans of a global variable.

pub fn set_player_variable_spans( &mut self, variable: usize, span: Option<Span>, name_span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored and identifier spans of a player variable.

pub fn set_subroutine_spans( &mut self, subroutine: usize, span: Option<Span>, name_span: Option<Span>, ) -> Result<(), SourceMappingError>

Attach the authored and identifier spans of a subroutine.

pub fn rule_span(&self, rule: usize) -> Option<Span>

Return the authored span of a public rule, when source metadata exists.

Attached mappings record the program shape they were attached to. Every span accessor returns None once the public rules, conditions, or actions have been inserted or removed since the mapping was attached.

pub fn condition_span(&self, rule: usize, condition: usize) -> Option<Span>

Return the authored span of a public rule condition value.

pub fn action_span(&self, rule: usize, action: usize) -> Option<Span>

Return the authored span of a public action in its linear rule order.

pub fn action_argument_span( &self, rule: usize, action: usize, argument: usize, ) -> Option<Span>

Return the authored span of a direct value argument of a public action.

pub fn edit_source( &self, span: Span, replacement: impl Into<String>, ) -> Result<SourceEdit, SourceEditError>

Create a checked source edit through the authored source attached to this canonical program.

pub fn validate(&self) -> Result<(), WorkshopError>

Validate the structural invariants of the canonical program.

pub fn semantic_issues(&self, catalog: &Catalog) -> Vec<SemanticIssue>

Report constructs that are structurally preserved but not fully understood by the canonical catalog.

pub fn dump(&self) -> String

Render the program through the canonical Workshop debug representation.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl Default for Program

fn default() -> Self

Returns the “default value” for a type.