chloro-core 0.7.5

Core functionality for chloro - a minimal Rust code formatter
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! A trait-based printer to reduce repetitive formatting patterns.

use ra_ap_syntax::ast::{AstNode, AstToken, HasAttrs, HasDocComments, HasVisibility};

use crate::formatter::write_indent;

/// Extension trait for String buffers used in formatting.
pub trait Printer {
    /// Write indentation followed by text and a newline.
    fn line(&mut self, indent: usize, text: &str);

    /// Write indentation only.
    fn indent(&mut self, indent: usize);

    /// Write text followed by a newline.
    fn newline(&mut self, text: &str);

    /// Write a blank line.
    fn blank(&mut self);

    /// Write doc comments from a node that implements HasDocComments.
    fn doc_comments<T: HasDocComments>(&mut self, item: &T, indent: usize);

    /// Write attributes from a node that implements HasAttrs.
    fn attrs<T: HasAttrs>(&mut self, item: &T, indent: usize);

    /// Write visibility if present, followed by a space.
    fn visibility<T: HasVisibility>(&mut self, item: &T);

    /// Write doc comments, attributes, indentation, and visibility - the common preamble.
    fn item_preamble<T: HasDocComments + HasAttrs + HasVisibility>(
        &mut self,
        item: &T,
        indent: usize,
    );

    /// Open a brace block: ` {\n`
    fn open_brace(&mut self);

    /// Open a brace block on new line (after where clause): `\n` + indent + `{\n`
    fn open_brace_newline(&mut self, indent: usize);

    /// Close a brace block: indent + `}`
    fn close_brace(&mut self, indent: usize);

    /// Close a brace block with newline: indent + `}\n`
    fn close_brace_ln(&mut self, indent: usize);
}

impl Printer for String {
    fn line(&mut self, indent: usize, text: &str) {
        write_indent(self, indent);
        self.push_str(text);
        self.push('\n');
    }

    fn indent(&mut self, indent: usize) {
        write_indent(self, indent);
    }

    fn newline(&mut self, text: &str) {
        self.push_str(text);
        self.push('\n');
    }

    fn blank(&mut self) {
        self.push('\n');
    }

    fn doc_comments<T: HasDocComments>(&mut self, item: &T, indent: usize) {
        for doc in item.doc_comments() {
            self.line(indent, doc.text().trim());
        }
    }

    fn attrs<T: HasAttrs>(&mut self, item: &T, indent: usize) {
        for attr in item.attrs() {
            self.line(indent, &attr.syntax().text().to_string());
        }
    }

    fn visibility<T: HasVisibility>(&mut self, item: &T) {
        if let Some(vis) = item.visibility() {
            self.push_str(&vis.syntax().text().to_string());
            self.push(' ');
        }
    }

    fn item_preamble<T: HasDocComments + HasAttrs + HasVisibility>(
        &mut self,
        item: &T,
        indent: usize,
    ) {
        self.doc_comments(item, indent);
        self.attrs(item, indent);
        write_indent(self, indent);
        self.visibility(item);
    }

    fn open_brace(&mut self) {
        self.push_str(" {\n");
    }

    fn open_brace_newline(&mut self, indent: usize) {
        self.push('\n');
        write_indent(self, indent);
        self.push_str("{\n");
    }

    fn close_brace(&mut self, indent: usize) {
        write_indent(self, indent);
        self.push('}');
    }

    fn close_brace_ln(&mut self, indent: usize) {
        write_indent(self, indent);
        self.push_str("}\n");
    }
}

/// Collect attributes as a prefix string (for expressions).
pub fn expr_attrs_prefix<T: HasAttrs>(node: &T) -> String {
    let mut result = String::new();
    for attr in node.attrs() {
        result.push_str(&attr.syntax().text().to_string());
        result.push(' ');
    }
    result
}