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

//! # instruction
//!
//! The instruction type.
//!

#[cfg(test)]
#[path = "./instruction_test.rs"]
mod instruction_test;

/// Defines common instruction capabilities
pub trait InstructionOperations {
    /// Returns true if this instruction has some actionable command to run
    fn is_actionable(&self) -> bool;
}

/// Preprocess instruction
#[derive(Debug, Clone, Default)]
pub struct PreProcessInstruction {
    /// The command name
    pub command: Option<String>,
    /// The command arguments
    pub arguments: Option<Vec<String>>,
}

impl PreProcessInstruction {
    /// Creates and returns a new instance.
    pub fn new() -> PreProcessInstruction {
        Default::default()
    }
}

impl InstructionOperations for PreProcessInstruction {
    /// Returns true if this instruction has some actionable command to run
    fn is_actionable(&self) -> bool {
        return self.command.is_some();
    }
}

/// Runtime script instruction
#[derive(Debug, Clone, Default)]
pub struct ScriptInstruction {
    /// The label tag
    pub label: Option<String>,
    /// The command output variable name
    pub output: Option<String>,
    /// The command name
    pub command: Option<String>,
    /// The command arguments
    pub arguments: Option<Vec<String>>,
}

impl ScriptInstruction {
    /// Creates and returns a new instance.
    pub fn new() -> ScriptInstruction {
        Default::default()
    }
}

impl InstructionOperations for ScriptInstruction {
    /// Returns true if this instruction has some actionable command to run
    fn is_actionable(&self) -> bool {
        return self.command.is_some();
    }
}

/// Instruction Type - script, preprocess
#[derive(Debug, Clone)]
pub enum InstructionType {
    /// Empty instruction
    Empty,
    /// Preprocess instruction
    PreProcess(PreProcessInstruction),
    /// Runtime script instruction
    Script(ScriptInstruction),
}

/// Meta information for all instruction types
#[derive(Debug, Clone, Default)]
pub struct InstructionMetaInfo {
    /// The line number
    pub line: Option<usize>,
    /// The source file/url/...
    pub source: Option<String>,
}

impl InstructionMetaInfo {
    /// Creates and returns a new instance.
    pub fn new() -> InstructionMetaInfo {
        Default::default()
    }
}

/// Instruction data
#[derive(Debug, Clone)]
pub struct Instruction {
    /// Meta info
    pub meta_info: InstructionMetaInfo,
    /// The instruction
    pub instruction_type: InstructionType,
}

impl InstructionOperations for Instruction {
    /// Returns true if this instruction has some actionable command to run
    fn is_actionable(&self) -> bool {
        match self.instruction_type {
            InstructionType::Empty => false,
            InstructionType::PreProcess(ref value) => value.is_actionable(),
            InstructionType::Script(ref value) => value.is_actionable(),
        }
    }
}