workshop-rs 0.1.16

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

//! The neutral settings carrier.
//!
//! A typed, non-serde tree for custom-game-settings blocks shared by
//! validation and emission. The tree is a carrier: settings are carried and
//! emitted, never interpreted by lowering/analysis. The fixture-evidenced
//! emission table lives in [`table`].
//!
//! Extracted from the Wright-authored `wright-ir` crate; see
//! [`docs/provenance.md`](https://github.com/wrightkit/workshop-rs/blob/main/docs/provenance.md).

pub(crate) mod reconciliation;
pub mod schema;
pub mod table;

pub use schema::{
    Applicability, EffectiveNumber, NumericBounds, NumericBoundsError, SettingDefinition,
    SettingEvidenceKind, SettingId, SettingIdentity, SettingOccurrence, SettingOperationError,
    SettingPresentation, SettingProvenance, SettingScope, SettingTarget, SettingTargetKind,
    SettingValue, SettingValueDomain, TeamId, definition, definitions, definitions_by_id,
};

use crate::source::Span;

/// A settings block: `settings { ... }` with its typed children.
#[derive(Debug, Clone)]
pub struct Settings {
    pub span: Option<Span>,
    pub children: Vec<SettingsNode>,
}

/// One member of a settings group.
#[derive(Debug, Clone)]
pub enum SettingsNode {
    /// User-authored mode data under `settings.workshop`.
    Workshop {
        children: Vec<SettingsNode>,
        span: Option<Span>,
    },
    Group {
        name: String,
        children: Vec<SettingsNode>,
        span: Option<Span>,
    },
    Number {
        name: String,
        value: f64,
        span: Option<Span>,
    },
    Bool {
        name: String,
        value: bool,
        span: Option<Span>,
    },
    /// A presence-only Workshop extension setting (for example `Beam Effects`).
    Flag { name: String, span: Option<Span> },
    String {
        name: String,
        value: String,
        span: Option<Span>,
    },
    List {
        name: String,
        elements: Vec<SettingsListElement>,
        span: Option<Span>,
    },
    /// A syntactically valid settings member whose semantic catalog entry is
    /// not yet declared. The raw value is carried explicitly so parsing does
    /// not fabricate a type or silently discard project settings.
    Raw {
        name: String,
        value: String,
        span: Option<Span>,
    },
}

/// One element of a settings list (corpus lists are all strings).
#[derive(Debug, Clone)]
pub struct SettingsListElement {
    pub value: String,
    pub span: Option<Span>,
}

impl SettingsNode {
    /// The source span of this node, if any.
    pub fn span(&self) -> Option<Span> {
        match self {
            SettingsNode::Workshop { span, .. }
            | SettingsNode::Group { span, .. }
            | SettingsNode::Number { span, .. }
            | SettingsNode::Bool { span, .. }
            | SettingsNode::Flag { span, .. }
            | SettingsNode::String { span, .. }
            | SettingsNode::List { span, .. }
            | SettingsNode::Raw { span, .. } => *span,
        }
    }

    /// The key name of this node.
    pub fn name(&self) -> &str {
        match self {
            SettingsNode::Workshop { .. } => "workshop",
            SettingsNode::Group { name, .. }
            | SettingsNode::Number { name, .. }
            | SettingsNode::Bool { name, .. }
            | SettingsNode::Flag { name, .. }
            | SettingsNode::String { name, .. }
            | SettingsNode::List { name, .. }
            | SettingsNode::Raw { name, .. } => name,
        }
    }
}