workshop-rs 1.7.0

Canonical multi-locale Overwatch Workshop semantic core: catalog, parser, WIR, validation, emitter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use crate::catalog::{Catalog, Kind};
use crate::core::error::{Result, WorkshopError};
use crate::wir;

pub(crate) fn validate_action(
    program: &wir::Program,
    catalog: &Catalog,
    action_id: wir::ActionId,
    tolerate_residuals: bool,
) -> Result<()> {
    let Some(action) = program.actions.get(action_id) else {
        return Ok(());
    };
    match action {
        wir::Action::Call { name, args, span } => {
            let Some(entry) = catalog.entry(Kind::Action, name) else {
                // A catalog-unknown call is a completeness residual reported
                // by `semantic_issues`; its signature is unknowable, but its
                // argument values are still validated so a nested known
                // violation is not masked.
                if tolerate_residuals {
                    for arg in args {
                        crate::values::validate::validate_value(
                            program,
                            catalog,
                            *arg,
                            tolerate_residuals,
                        )?;
                    }
                    return Ok(());
                }
                return Err(WorkshopError::unknown(
                    "action",
                    name.clone(),
                    crate::catalog::Locale::new("en-US"),
                    *span,
                )
                .with_candidates(crate::core::suggest::nearest(
                    name,
                    catalog.canonical_spellings(Kind::Action, catalog.primary_locale()),
                    crate::core::suggest::CANDIDATE_LIMIT,
                )));
            };
            crate::values::validate::validate_call_signature(entry, args, *span, program, catalog)?;
            for arg in args {
                crate::values::validate::validate_value(
                    program,
                    catalog,
                    *arg,
                    tolerate_residuals,
                )?;
            }
        }
        wir::Action::SetGlobalVariable { value, .. }
        | wir::Action::ModifyGlobalVariable { value, .. } => {
            crate::values::validate::validate_value(program, catalog, *value, tolerate_residuals)?;
        }
        wir::Action::SetPlayerVariable { player, value, .. }
        | wir::Action::ModifyPlayerVariable { player, value, .. } => {
            crate::values::validate::validate_value(program, catalog, *player, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *value, tolerate_residuals)?;
        }
        wir::Action::AssignMember {
            target,
            value,
            span,
            ..
        } => {
            if !is_member_assignment_target(program, *target) {
                return Err(WorkshopError::malformed(
                    "AssignMember target must be a memberAccess value".to_string(),
                    *span,
                ));
            }
            crate::values::validate::validate_value(program, catalog, *target, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *value, tolerate_residuals)?;
        }
        wir::Action::If {
            branches,
            else_body,
            ..
        } => {
            for branch in branches {
                crate::values::validate::validate_value(
                    program,
                    catalog,
                    branch.condition,
                    tolerate_residuals,
                )?;
                for action in &branch.body {
                    validate_action(program, catalog, *action, tolerate_residuals)?;
                }
            }
            if let Some(else_body) = else_body {
                for action in else_body {
                    validate_action(program, catalog, *action, tolerate_residuals)?;
                }
            }
        }
        wir::Action::While {
            condition, body, ..
        } => {
            crate::values::validate::validate_value(
                program,
                catalog,
                *condition,
                tolerate_residuals,
            )?;
            for action in body {
                validate_action(program, catalog, *action, tolerate_residuals)?;
            }
        }
        wir::Action::ForGlobalVariable {
            start,
            stop,
            step,
            body,
            ..
        } => {
            crate::values::validate::validate_value(program, catalog, *start, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *stop, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *step, tolerate_residuals)?;
            for action in body {
                validate_action(program, catalog, *action, tolerate_residuals)?;
            }
        }
        wir::Action::ForPlayerVariable {
            player,
            start,
            stop,
            step,
            body,
            ..
        } => {
            crate::values::validate::validate_value(program, catalog, *player, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *start, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *stop, tolerate_residuals)?;
            crate::values::validate::validate_value(program, catalog, *step, tolerate_residuals)?;
            for action in body {
                validate_action(program, catalog, *action, tolerate_residuals)?;
            }
        }
        wir::Action::Disabled { action, .. } => {
            validate_action(program, catalog, *action, tolerate_residuals)?;
        }
        wir::Action::CallSubroutine { .. } => {}
    }
    Ok(())
}

pub(crate) fn is_member_assignment_target(program: &wir::Program, target: wir::ValueId) -> bool {
    match program.values.get(target) {
        Some(wir::ValueNode {
            value: wir::Value::Call { name, args },
            ..
        }) if name == "memberAccess" => (2..=3).contains(&args.len()),
        _ => false,
    }
}