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
97
98
99
100
101
102
103
104
105
106

// 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.

//! # Comment
//!
//! The documentation modules provides a way to add general comments to the
//! generated code. This can either be some heading comment, or standard inline
//! comments. Not this will create simple comments, as opposed to document comments
//! for which there is the `Doc` module.

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

use crate::formatter::Formatter;

/// defines a comment block
#[derive(Debug, Clone)]
pub struct Comment {
    /// the comment string
    comment: String,

    /// defines whether the comment is a heading
    is_heading: bool,
}

impl Comment {
    /// creates a new, empty comment
    pub fn new() -> Self {
        Comment::with_string(String::new())
    }

    /// creates a new comment with a given string
    pub fn with_string(comment: String) -> Self {
        Self {
            comment,
            is_heading: false,
        }
    }

    /// creates a new comment with a given str ref
    pub fn with_str(comment: &str) -> Self {
        Self::with_string(String::from(comment))
    }

    /// creates a new heading comment
    pub fn new_heading(comment: &str) -> Self {
        Self {
            comment: comment.to_string(),
            is_heading: false,
        }
    }

    /// converts the comment into a heading comment
    pub fn set_heading(&mut self) -> &mut Self {
        self.is_heading = true;
        self
    }

    /// pushes the heading separator
    fn push_heading(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        if self.is_heading {
            for _ in 0..(100 - fmt.get_indent()) {
                write!(fmt, "/")?;
            }
            writeln!(fmt)?;
        }
        Ok(())
    }

    // formats the comment block
    pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        // writeln!(fmt)?;
        self.push_heading(fmt)?;
        for line in self.comment.lines() {
            writeln!(fmt, "// {line}")?;
        }
        self.push_heading(fmt)
    }
}

impl Default for Comment {
    fn default() -> Self {
        Self::new()
    }
}