cairo_lang_parser/
colored_printer.rs

1use cairo_lang_syntax::node::SyntaxNode;
2use cairo_lang_syntax::node::green::GreenNodeDetails;
3use cairo_lang_syntax::node::kind::SyntaxKind;
4use colored::{ColoredString, Colorize};
5use salsa::Database;
6
7struct ColoredPrinter<'a> {
8    db: &'a dyn Database,
9    /// Whether to also print empty and missing tokens/nodes
10    verbose: bool,
11    result: String,
12}
13impl ColoredPrinter<'_> {
14    fn print(&mut self, syntax_node: &SyntaxNode<'_>) {
15        let node = syntax_node.green_node(self.db);
16        match &node.details {
17            GreenNodeDetails::Token(text) => {
18                if self.verbose && node.kind == SyntaxKind::TokenMissing {
19                    self.result.push_str(&format!("{}", "<m>".red()));
20                } else {
21                    self.result.push_str(&set_color(text.long(self.db), node.kind).to_string());
22                }
23            }
24            GreenNodeDetails::Node { .. } => {
25                if self.verbose && is_missing_kind(node.kind) {
26                    self.result.push_str(&format!("{}", "<m>".red()));
27                } else if self.verbose && is_empty_kind(node.kind) {
28                    self.result.push_str(&format!("{}", "<e>".red()));
29                } else {
30                    for child in syntax_node.get_children(self.db).iter() {
31                        self.print(child);
32                    }
33                }
34            }
35        }
36    }
37}
38
39// TODO(yuval): autogenerate both.
40fn is_missing_kind(kind: SyntaxKind) -> bool {
41    matches!(kind, SyntaxKind::ExprMissing | SyntaxKind::StatementMissing)
42}
43
44// TODO(yuval): Move to SyntaxKind.
45pub fn is_empty_kind(kind: SyntaxKind) -> bool {
46    matches!(
47        kind,
48        SyntaxKind::OptionStructArgExprEmpty
49            | SyntaxKind::OptionTypeClauseEmpty
50            | SyntaxKind::OptionReturnTypeClauseEmpty
51            | SyntaxKind::OptionTerminalSemicolonEmpty
52            | SyntaxKind::OptionTerminalColonColonEmpty
53            | SyntaxKind::OptionWrappedGenericParamListEmpty
54    )
55}
56
57fn set_color(text: &str, kind: SyntaxKind) -> ColoredString {
58    // TODO(yuval): use tags on SyntaxKind
59    match kind {
60        SyntaxKind::TokenIdentifier => text.truecolor(255, 255, 100), // Yellow
61        SyntaxKind::TokenPlus
62        | SyntaxKind::TokenMinus
63        | SyntaxKind::TokenMul
64        | SyntaxKind::TokenDiv
65        | SyntaxKind::TokenMod
66        | SyntaxKind::TokenDot => text.bright_magenta(),
67        SyntaxKind::TokenLiteralNumber
68        | SyntaxKind::TokenFalse
69        | SyntaxKind::TokenTrue
70        | SyntaxKind::TokenShortString
71        | SyntaxKind::TokenString => text.bright_cyan(),
72        SyntaxKind::TokenExtern
73        | SyntaxKind::TokenType
74        | SyntaxKind::TokenFunction
75        | SyntaxKind::TokenModule
76        | SyntaxKind::TokenEnum
77        | SyntaxKind::TokenStruct
78        | SyntaxKind::TokenTrait
79        | SyntaxKind::TokenImpl => text.bright_blue(),
80        SyntaxKind::TokenOf
81        | SyntaxKind::TokenLet
82        | SyntaxKind::TokenReturn
83        | SyntaxKind::TokenMatch
84        | SyntaxKind::TokenIf
85        | SyntaxKind::TokenElse
86        | SyntaxKind::TokenUse
87        | SyntaxKind::TokenImplicits
88        | SyntaxKind::TokenRef
89        | SyntaxKind::TokenMut
90        | SyntaxKind::TokenNoPanic => text.bright_blue(),
91        SyntaxKind::TokenArrow
92        | SyntaxKind::TokenMatchArrow
93        | SyntaxKind::TokenColon
94        | SyntaxKind::TokenColonColon
95        | SyntaxKind::TokenDotDot
96        | SyntaxKind::TokenDotDotEq
97        | SyntaxKind::TokenSemicolon
98        | SyntaxKind::TokenAnd
99        | SyntaxKind::TokenAndAnd
100        | SyntaxKind::TokenOr
101        | SyntaxKind::TokenOrOr
102        | SyntaxKind::TokenXor
103        | SyntaxKind::TokenNot
104        | SyntaxKind::TokenQuestionMark
105        | SyntaxKind::TokenUnderscore
106        | SyntaxKind::TokenHash => text.truecolor(255, 180, 255), // Pink
107        SyntaxKind::TokenEq
108        | SyntaxKind::TokenEqEq
109        | SyntaxKind::TokenGE
110        | SyntaxKind::TokenGT
111        | SyntaxKind::TokenLE
112        | SyntaxKind::TokenLT
113        | SyntaxKind::TokenNeq => {
114            text.truecolor(255, 165, 0) // Orange
115        }
116        SyntaxKind::TokenLBrace
117        | SyntaxKind::TokenRBrace
118        | SyntaxKind::TokenLBrack
119        | SyntaxKind::TokenRBrack
120        | SyntaxKind::TokenLParen
121        | SyntaxKind::TokenRParen
122        | SyntaxKind::TokenComma => text.clear(),
123        SyntaxKind::TokenEndOfFile => text.clear(),
124        SyntaxKind::TokenBadCharacters => text.red(),
125        SyntaxKind::TokenMissing => text.clear(),
126        SyntaxKind::TokenSkipped => text.on_red(), // red background
127        SyntaxKind::TokenSingleLineComment
128        | SyntaxKind::TokenWhitespace
129        | SyntaxKind::TokenNewline
130        | SyntaxKind::TokenEmpty => text.clear(),
131        // TODO(yuval): Can this be made exhaustive?
132        _ => panic!("Unexpected syntax kind: {kind:?}"),
133    }
134}
135
136pub fn print_colored(db: &dyn Database, syntax_root: &SyntaxNode<'_>, verbose: bool) -> String {
137    let mut printer = ColoredPrinter { db, verbose, result: Default::default() };
138    printer.print(syntax_root);
139    printer.result
140}
cairo_lang_parser/colored_printer.rs

cairo_lang_parser/
colored_printer.rs
