crustal 0.3.6

A library for generating C/C++ code.
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

// C/C++ Code Generator For Rust
//
//
// MIT License
//
// Copyright (c) 2021, 2022 Reto Achermann
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

//! # Cgen Rust Library
//!
//! The Cgen Rust library provides a builder API for generating C code.

use std::fmt::{self, Write};

use crate::{Formatter, Scope};

/// defines a comment block
#[derive(Debug, Clone)]
pub struct IfDef {
    /// the symbol to be defined
    sym: String,

    /// the then branch
    then: Scope,

    /// sets this ifdef to be a guard
    is_guard: bool,

    /// the other branch
    other: Option<Scope>,
}

impl IfDef {
    /// creates a new comment
    pub fn new(sym: &str) -> Self {
        Self {
            sym: sym.to_string(),
            then: Scope::new(),
            is_guard: false,
            other: None,
        }
    }

    /// obtains the scope to the then block
    pub fn then_scope(&mut self) -> &mut Scope {
        &mut self.then
    }

    /// obtains the scope to the other block
    pub fn other_scope(&mut self) -> &mut Scope {
        &mut self.then
    }

    pub fn guard(&mut self) -> &mut Self {
        self.is_guard = true;
        self
    }

    // formats the ifdef block
    pub fn do_fmt(&self, fmt: &mut Formatter<'_>, only_decls: bool) -> fmt::Result {
        writeln!(fmt, "\n")?;
        if self.is_guard {
            writeln!(fmt, "#ifndef {}", self.sym)?;
            writeln!(fmt, "#define {} 1", self.sym)?;
        } else {
            writeln!(fmt, "#ifdef {}", self.sym)?;
        }
        self.then.do_fmt(fmt, only_decls)?;
        if let Some(b) = &self.other {
            writeln!(fmt, "#else // !{}", self.sym)?;
            b.do_fmt(fmt, only_decls)?;
        }
        writeln!(fmt, "\n#endif // {}", self.sym)
    }

    pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        self.do_fmt(fmt, false)
    }
}