ninja-writer 0.3.1

Simple and ergonomic library for writing Ninja build files
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

//! Statment implementations

use alloc::boxed::Box;
use alloc::string::String;
use alloc::vec::Vec;
use core::ops::Deref;

use crate::util::{AddOnlyVec, RefCounted};
use crate::{Build, Pool, Rule, Variable};

/// A top-level ninja statement
#[derive(Debug)]
pub enum Stmt {
    /// A Comment (`# <comment>`)
    Comment(String),

    /// A rule declaration
    ///
    /// See <https://ninja-build.org/manual.html#_rules>
    Rule(Rule),

    /// A build edge
    ///
    /// See <https://ninja-build.org/manual.html#_build_statements>
    Build(Box<Build>),

    /// A variable declaration
    ///
    /// See <https://ninja-build.org/manual.html#_variables>
    Variable(Variable),

    /// A default statement
    ///
    /// See <https://ninja-build.org/manual.html#_default_target_statements>
    Default(Vec<String>),
    /// A subninja statement
    ///
    /// See <https://ninja-build.org/manual.html#ref_scope>
    Subninja(String),

    /// An include statement (like subninja, but doesn't create a new scope)
    ///
    /// See <https://ninja-build.org/manual.html#ref_scope>
    Include(String),

    /// A pool declaration
    ///
    /// See <https://ninja-build.org/manual.html#ref_pool>
    Pool(Pool),
}

impl Stmt {
    /// Get the ordinal for this statement type
    pub fn ordinal(&self) -> usize {
        match self {
            Self::Comment(_) => 0,
            Self::Rule(_) => 1,
            Self::Build(_) => 2,
            Self::Variable(_) => 3,
            Self::Default(_) => 4,
            Self::Subninja(_) => 5,
            Self::Include(_) => 6,
            Self::Pool(_) => 7,
        }
    }

    pub fn is_same_type(&self, other: &Self) -> bool {
        self.ordinal() == other.ordinal()
    }
}

/// A reference to a statement in a list that can be used to get the statement,
/// as well as add new statements to the list.
#[derive(Debug)]
pub struct StmtRef {
    /// The list this statement is in
    pub(crate) list: RefCounted<AddOnlyVec<RefCounted<Stmt>>>,
    /// The statement
    pub(crate) stmt: RefCounted<Stmt>,
}
impl StmtRef {
    /// Add a new statment to the list this statement is in
    pub fn add(&self, stmt: Stmt) -> StmtRef {
        StmtRef {
            stmt: self.list.add_rc(stmt),
            list: RefCounted::clone(&self.list),
        }
    }
}
impl Clone for StmtRef {
    fn clone(&self) -> Self {
        Self {
            list: RefCounted::clone(&self.list),
            stmt: RefCounted::clone(&self.stmt),
        }
    }
}
impl Deref for StmtRef {
    type Target = RefCounted<Stmt>;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.stmt
    }
}

impl AsRef<Stmt> for StmtRef {
    #[inline]
    fn as_ref(&self) -> &Stmt {
        self.deref()
    }
}