Skip to main content

rusty_rich/
theme.rs

1//! Theme system — equivalent to Rich's `theme.py`.
2//!
3//! A Theme maps style names (like "repr.number", "repr.str") to Style values,
4//! allowing customizable color schemes for different renderable types.
5
6use std::collections::HashMap;
7
8use crate::style::Style;
9
10// ---------------------------------------------------------------------------
11// Theme
12// ---------------------------------------------------------------------------
13
14/// A set of named styles that can be applied to themed output.
15#[derive(Debug, Clone)]
16pub struct Theme {
17    /// Mapping from style name → Style.
18    pub styles: HashMap<String, Style>,
19    /// Optional inherited base theme.
20    pub inherit: Option<Box<Theme>>,
21}
22
23impl Theme {
24    /// Create a new empty theme.
25    pub fn new() -> Self {
26        Self {
27            styles: HashMap::new(),
28            inherit: None,
29        }
30    }
31
32    /// Create a theme that inherits from another.
33    pub fn with_inherit(inherit: Theme) -> Self {
34        Self {
35            styles: HashMap::new(),
36            inherit: Some(Box::new(inherit)),
37        }
38    }
39
40    /// Look up a style by name. Falls back to the inherited theme.
41    pub fn get(&self, name: &str) -> Option<&Style> {
42        self.styles
43            .get(name)
44            .or_else(|| self.inherit.as_ref().and_then(|i| i.get(name)))
45    }
46
47    /// Set a named style.
48    pub fn set(&mut self, name: impl Into<String>, style: Style) {
49        self.styles.insert(name.into(), style);
50    }
51
52    /// Merge another theme's styles into this one.
53    pub fn merge(&mut self, other: &Theme) {
54        for (name, style) in &other.styles {
55            self.styles.entry(name.clone()).or_insert_with(|| style.clone());
56        }
57    }
58}
59
60impl Default for Theme {
61    fn default() -> Self {
62        Self::new()
63    }
64}
65
66// ---------------------------------------------------------------------------
67// ThemeStack
68// ---------------------------------------------------------------------------
69
70/// A stack of themes — when looking up a style, themes are checked from
71/// top to bottom until a match is found.
72#[derive(Debug, Clone)]
73pub struct ThemeStack {
74    themes: Vec<Theme>,
75}
76
77impl ThemeStack {
78    pub fn new() -> Self {
79        Self { themes: Vec::new() }
80    }
81
82    pub fn push(&mut self, theme: Theme) {
83        self.themes.push(theme);
84    }
85
86    pub fn pop(&mut self) -> Option<Theme> {
87        self.themes.pop()
88    }
89
90    /// Look up a style name across the stack (top-down).
91    pub fn get(&self, name: &str) -> Option<Style> {
92        for theme in self.themes.iter().rev() {
93            if let Some(s) = theme.get(name) {
94                return Some(s.clone());
95            }
96        }
97        None
98    }
99}
100
101// ---------------------------------------------------------------------------
102// Default themes
103// ---------------------------------------------------------------------------
104
105/// Built-in theme style names used by various Rich renderables.
106pub mod names {
107    // repr / pretty
108    pub const REPR_NUMBER: &str = "repr.number";
109    pub const REPR_STR: &str = "repr.str";
110    pub const REPR_BOOL_TRUE: &str = "repr.bool_true";
111    pub const REPR_BOOL_FALSE: &str = "repr.bool_false";
112    pub const REPR_NONE: &str = "repr.none";
113    pub const REPR_URL: &str = "repr.url";
114    pub const REPR_PATH: &str = "repr.path";
115    pub const REPR_IPV4: &str = "repr.ipv4";
116    pub const REPR_IPV6: &str = "repr.ipv6";
117    pub const REPR_ELLIPSIS: &str = "repr.ellipsis";
118    pub const REPR_ATTRIB_NAME: &str = "repr.attrib_name";
119    pub const REPR_ATTRIB_VALUE: &str = "repr.attrib_value";
120    pub const REPR_TAG_NAME: &str = "repr.tag_name";
121    pub const REPR_TAG_CONTENTS: &str = "repr.tag_contents";
122    pub const REPR_TAG_PUNCTUATION: &str = "repr.tag_punctuation";
123    pub const REPR_BRACE: &str = "repr.brace";
124    pub const REPR_CALL: &str = "repr.call";
125    pub const REPR_COMMA: &str = "repr.comma";
126    pub const REPR_BOOL: &str = "repr.bool";
127    pub const REPR_ERROR: &str = "repr.error";
128
129    // table
130    pub const TABLE_HEADER: &str = "table.header";
131    pub const TABLE_CELL: &str = "table.cell";
132    pub const TABLE_ROW: &str = "table.row";
133    pub const TABLE_FOOTER: &str = "table.footer";
134    pub const TABLE_TITLE: &str = "table.title";
135    pub const TABLE_CAPTION: &str = "table.caption";
136    pub const TABLE_BORDER: &str = "table.border";
137
138    // logging
139    pub const LOGGING_KEYWORD: &str = "logging.keyword";
140    pub const LOGGING_LEVEL_DEBUG: &str = "logging.level.debug";
141    pub const LOGGING_LEVEL_INFO: &str = "logging.level.info";
142    pub const LOGGING_LEVEL_WARNING: &str = "logging.level.warning";
143    pub const LOGGING_LEVEL_ERROR: &str = "logging.level.error";
144    pub const LOGGING_LEVEL_CRITICAL: &str = "logging.level.critical";
145    pub const LOGGING_LEVEL_NOTSET: &str = "logging.level.notset";
146
147    // traceback
148    pub const TRACEBACK_BORDER: &str = "traceback.border";
149    pub const TRACEBACK_TITLE: &str = "traceback.title";
150    pub const TRACEBACK_ERROR: &str = "traceback.error";
151    pub const TRACEBACK_ERROR_MARK: &str = "traceback.error_mark";
152    pub const TRACEBACK_FILENAME: &str = "traceback.filename";
153    pub const TRACEBACK_LINE_NO: &str = "traceback.line_no";
154    pub const TRACEBACK_LOCALS_HEADER: &str = "traceback.locals_header";
155    pub const TRACEBACK_LOCALS_KEY: &str = "traceback.locals_key";
156    pub const TRACEBACK_LOCALS_VALUE: &str = "traceback.locals_value";
157    pub const TRACEBACK_EXC_TYPE: &str = "traceback.exc_type";
158    pub const TRACEBACK_EXC_VALUE: &str = "traceback.exc_value";
159
160    // general
161    pub const RULE_LINE: &str = "rule.line";
162    pub const RULE_TEXT: &str = "rule.text";
163    pub const BAR_COMPLETE: &str = "bar.complete";
164    pub const BAR_FINISHED: &str = "bar.finished";
165    pub const BAR_PULSE: &str = "bar.pulse";
166    pub const BAR_REMAINING: &str = "bar.remaining";
167    pub const PROGRESS_DESCRIPTION: &str = "progress.description";
168    pub const PROGRESS_PERCENTAGE: &str = "progress.percentage";
169    pub const PROGRESS_REMAINING: &str = "progress.remaining";
170    pub const PROGRESS_ELAPSED: &str = "progress.elapsed";
171    pub const PROGRESS_DATA: &str = "progress.data";
172    pub const PROGRESS_DOWNLOAD: &str = "progress.download";
173    pub const PROGRESS_TRANSFER: &str = "progress.transfer";
174    pub const PROGRESS_FILESIZE: &str = "progress.filesize";
175    pub const PROGRESS_TOTAL: &str = "progress.total";
176    pub const TREE: &str = "tree";
177    pub const TREE_LINE: &str = "tree.line";
178    pub const MARKDOWN_H1: &str = "markdown.h1";
179    pub const MARKDOWN_H2: &str = "markdown.h2";
180    pub const MARKDOWN_CODE: &str = "markdown.code";
181    pub const MARKDOWN_LINK: &str = "markdown.link";
182    pub const MARKDOWN_ITEM: &str = "markdown.item";
183    pub const MARKDOWN_H3: &str = "markdown.h3";
184    pub const MARKDOWN_H4: &str = "markdown.h4";
185    pub const MARKDOWN_H5: &str = "markdown.h5";
186    pub const MARKDOWN_H6: &str = "markdown.h6";
187    pub const MARKDOWN_H7: &str = "markdown.h7";
188    pub const MARKDOWN_PARAGRAPH: &str = "markdown.paragraph";
189    pub const MARKDOWN_BLOCKQUOTE: &str = "markdown.blockquote";
190    pub const MARKDOWN_LIST: &str = "markdown.list";
191    pub const MARKDOWN_ITEM_BULLET: &str = "markdown.item.bullet";
192    pub const MARKDOWN_ITEM_NUMBER: &str = "markdown.item.number";
193    pub const MARKDOWN_TABLE: &str = "markdown.table";
194    pub const MARKDOWN_TABLE_HEADER: &str = "markdown.table.header";
195    pub const MARKDOWN_CODE_BLOCK: &str = "markdown.code.block";
196    pub const MARKDOWN_CODE_INLINE: &str = "markdown.code.inline";
197    pub const MARKDOWN_HR: &str = "markdown.hr";
198    pub const JSON_KEY: &str = "json.key";
199    pub const JSON_STR: &str = "json.str";
200    pub const JSON_NUMBER: &str = "json.number";
201    pub const JSON_BOOL: &str = "json.bool";
202    pub const JSON_NULL: &str = "json.null";
203    pub const JSON_BOOL_TRUE: &str = "json.bool_true";
204    pub const JSON_BOOL_FALSE: &str = "json.bool_false";
205    pub const JSON_BRACE: &str = "json.brace";
206
207    // status
208    pub const STATUS_SPINNER: &str = "status.spinner";
209    pub const STATUS_MESSAGE: &str = "status.message";
210
211    // prompt
212    pub const PROMPT: &str = "prompt";
213    pub const PROMPT_CHOICES: &str = "prompt.choices";
214    pub const PROMPT_DEFAULT: &str = "prompt.default";
215
216    // syntax highlighting (via syntect)
217    pub const SYNTAX_COMMENT: &str = "syntax.comment";
218    pub const SYNTAX_KEYWORD: &str = "syntax.keyword";
219    pub const SYNTAX_STRING: &str = "syntax.string";
220    pub const SYNTAX_NUMBER: &str = "syntax.number";
221    pub const SYNTAX_FUNCTION: &str = "syntax.function";
222    pub const SYNTAX_TYPE: &str = "syntax.type";
223}
224
225/// Create the default Rich-like theme.
226pub fn default_theme() -> Theme {
227    let mut t = Theme::new();
228    use crate::color::Color;
229    use crate::style::Style;
230
231    // repr styles
232    t.set(names::REPR_NUMBER, Style::new().color(Color::parse("cyan").unwrap()).bold(true));
233    t.set(names::REPR_STR, Style::new().color(Color::parse("green").unwrap()));
234    t.set(names::REPR_BOOL_TRUE, Style::new().color(Color::parse("bright_green").unwrap()).bold(true));
235    t.set(names::REPR_BOOL_FALSE, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
236    t.set(names::REPR_NONE, Style::new().color(Color::parse("bright_yellow").unwrap()).dim(true));
237    t.set(names::REPR_URL, Style::new().color(Color::parse("bright_blue").unwrap()).underline(true));
238    t.set(names::REPR_PATH, Style::new().color(Color::parse("magenta").unwrap()));
239    t.set(names::REPR_ATTRIB_NAME, Style::new().color(Color::parse("bright_cyan").unwrap()));
240    t.set(names::REPR_ATTRIB_VALUE, Style::new().color(Color::parse("white").unwrap()));
241    t.set(names::REPR_ELLIPSIS, Style::new().dim(true).color(Color::parse("white").unwrap()));
242    t.set(names::REPR_IPV4, Style::new().color(Color::parse("bright_blue").unwrap()).bold(true));
243    t.set(names::REPR_IPV6, Style::new().color(Color::parse("bright_magenta").unwrap()).bold(true));
244    t.set(names::REPR_TAG_NAME, Style::new().color(Color::parse("bright_blue").unwrap()).bold(true));
245    t.set(names::REPR_TAG_CONTENTS, Style::new().color(Color::parse("white").unwrap()));
246    t.set(names::REPR_TAG_PUNCTUATION, Style::new().color(Color::parse("bright_black").unwrap()));
247    t.set(names::REPR_BRACE, Style::new().color(Color::parse("bright_black").unwrap()));
248    t.set(names::REPR_CALL, Style::new().color(Color::parse("bright_cyan").unwrap()));
249    t.set(names::REPR_COMMA, Style::new().color(Color::parse("bright_black").unwrap()));
250    t.set(names::REPR_BOOL, Style::new().color(Color::parse("bright_yellow").unwrap()).bold(true));
251    t.set(names::REPR_ERROR, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
252
253    // table styles
254    t.set(names::TABLE_HEADER, Style::new().bold(true).color(Color::parse("white").unwrap()));
255    t.set(names::TABLE_FOOTER, Style::new().bold(true));
256    t.set(names::TABLE_TITLE, Style::new().bold(true));
257    t.set(names::TABLE_CAPTION, Style::new().dim(true));
258    t.set(names::TABLE_BORDER, Style::new().color(Color::parse("bright_black").unwrap()));
259    t.set(names::TABLE_CELL, Style::new().color(Color::parse("white").unwrap()));
260    t.set(names::TABLE_ROW, Style::new().color(Color::parse("white").unwrap()));
261
262    // rule
263    t.set(names::RULE_LINE, Style::new().color(Color::parse("bright_black").unwrap()));
264    t.set(names::RULE_TEXT, Style::new().bold(true));
265
266    // tree
267    t.set(names::TREE, Style::new().color(Color::parse("white").unwrap()));
268    t.set(names::TREE_LINE, Style::new().color(Color::parse("bright_black").unwrap()));
269
270    // progress
271    t.set(names::BAR_COMPLETE, Style::new().color(Color::parse("green").unwrap()));
272    t.set(names::BAR_FINISHED, Style::new().color(Color::parse("bright_green").unwrap()));
273    t.set(names::BAR_PULSE, Style::new().color(Color::parse("bright_cyan").unwrap()));
274    t.set(names::PROGRESS_DESCRIPTION, Style::new().color(Color::parse("white").unwrap()));
275    t.set(names::PROGRESS_PERCENTAGE, Style::new().color(Color::parse("cyan").unwrap()));
276    t.set(names::PROGRESS_REMAINING, Style::new().color(Color::parse("bright_black").unwrap()));
277    t.set(names::PROGRESS_ELAPSED, Style::new().color(Color::parse("cyan").unwrap()));
278    t.set(names::PROGRESS_DATA, Style::new().color(Color::parse("bright_blue").unwrap()));
279    t.set(names::PROGRESS_DOWNLOAD, Style::new().color(Color::parse("bright_cyan").unwrap()));
280    t.set(names::PROGRESS_TRANSFER, Style::new().color(Color::parse("bright_magenta").unwrap()));
281    t.set(names::PROGRESS_FILESIZE, Style::new().color(Color::parse("bright_green").unwrap()));
282    t.set(names::PROGRESS_TOTAL, Style::new().color(Color::parse("bright_blue").unwrap()));
283    t.set(names::BAR_REMAINING, Style::new().color(Color::parse("bright_black").unwrap()));
284
285    // markdown
286    t.set(names::MARKDOWN_H1, Style::new().bold(true).color(Color::parse("bright_cyan").unwrap()));
287    t.set(names::MARKDOWN_H2, Style::new().bold(true).color(Color::parse("cyan").unwrap()));
288    t.set(names::MARKDOWN_CODE, Style::new().color(Color::parse("bright_yellow").unwrap()).bgcolor(Color::parse("black").unwrap()));
289    t.set(names::MARKDOWN_LINK, Style::new().color(Color::parse("bright_blue").unwrap()).underline(true));
290    t.set(names::MARKDOWN_H3, Style::new().bold(true).color(Color::parse("yellow").unwrap()));
291    t.set(names::MARKDOWN_H4, Style::new().bold(true).color(Color::parse("green").unwrap()));
292    t.set(names::MARKDOWN_H5, Style::new().bold(true).color(Color::parse("blue").unwrap()));
293    t.set(names::MARKDOWN_H6, Style::new().bold(true).color(Color::parse("bright_black").unwrap()));
294    t.set(names::MARKDOWN_H7, Style::new().dim(true).color(Color::parse("bright_black").unwrap()));
295    t.set(names::MARKDOWN_PARAGRAPH, Style::new().color(Color::parse("white").unwrap()));
296    t.set(names::MARKDOWN_BLOCKQUOTE, Style::new().color(Color::parse("bright_black").unwrap()));
297    t.set(names::MARKDOWN_LIST, Style::new().color(Color::parse("white").unwrap()));
298    t.set(names::MARKDOWN_ITEM, Style::new().color(Color::parse("cyan").unwrap()));
299    t.set(names::MARKDOWN_ITEM_BULLET, Style::new().color(Color::parse("cyan").unwrap()));
300    t.set(names::MARKDOWN_ITEM_NUMBER, Style::new().color(Color::parse("cyan").unwrap()));
301    t.set(names::MARKDOWN_TABLE, Style::new().color(Color::parse("white").unwrap()));
302    t.set(names::MARKDOWN_TABLE_HEADER, Style::new().bold(true).color(Color::parse("white").unwrap()));
303    t.set(names::MARKDOWN_CODE_BLOCK, Style::new().color(Color::parse("bright_yellow").unwrap()).bgcolor(Color::parse("black").unwrap()));
304    t.set(names::MARKDOWN_CODE_INLINE, Style::new().color(Color::parse("bright_yellow").unwrap()));
305    t.set(names::MARKDOWN_HR, Style::new().color(Color::parse("bright_black").unwrap()));
306
307    // json
308    t.set(names::JSON_KEY, Style::new().color(Color::parse("cyan").unwrap()));
309    t.set(names::JSON_STR, Style::new().color(Color::parse("green").unwrap()));
310    t.set(names::JSON_NUMBER, Style::new().color(Color::parse("bright_blue").unwrap()).bold(true));
311    t.set(names::JSON_BOOL, Style::new().color(Color::parse("bright_yellow").unwrap()).bold(true));
312    t.set(names::JSON_NULL, Style::new().color(Color::parse("bright_red").unwrap()).dim(true));
313    t.set(names::JSON_BOOL_TRUE, Style::new().color(Color::parse("bright_green").unwrap()).bold(true));
314    t.set(names::JSON_BOOL_FALSE, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
315    t.set(names::JSON_BRACE, Style::new().color(Color::parse("bright_black").unwrap()));
316
317    // traceback
318    t.set(names::TRACEBACK_BORDER, Style::new().color(Color::parse("red").unwrap()));
319    t.set(names::TRACEBACK_TITLE, Style::new().bold(true));
320    t.set(names::TRACEBACK_ERROR, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
321    t.set(names::TRACEBACK_ERROR_MARK, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
322    t.set(names::TRACEBACK_FILENAME, Style::new().color(Color::parse("cyan").unwrap()));
323    t.set(names::TRACEBACK_LINE_NO, Style::new().color(Color::parse("bright_black").unwrap()));
324    t.set(names::TRACEBACK_LOCALS_HEADER, Style::new().bold(true));
325    t.set(names::TRACEBACK_LOCALS_KEY, Style::new().color(Color::parse("bright_cyan").unwrap()));
326    t.set(names::TRACEBACK_LOCALS_VALUE, Style::new().color(Color::parse("white").unwrap()));
327    t.set(names::TRACEBACK_EXC_TYPE, Style::new().color(Color::parse("bright_red").unwrap()).bold(true));
328    t.set(names::TRACEBACK_EXC_VALUE, Style::new().color(Color::parse("white").unwrap()));
329
330    // logging extras
331    t.set(names::LOGGING_KEYWORD, Style::new().color(Color::parse("bright_yellow").unwrap()).bold(true));
332    t.set(names::LOGGING_LEVEL_NOTSET, Style::new().dim(true).color(Color::parse("white").unwrap()));
333
334    // status & prompt
335    t.set(names::STATUS_SPINNER, Style::new().color(Color::parse("bright_cyan").unwrap()));
336    t.set(names::STATUS_MESSAGE, Style::new().color(Color::parse("white").unwrap()));
337    t.set(names::PROMPT, Style::new().color(Color::parse("bright_cyan").unwrap()));
338    t.set(names::PROMPT_CHOICES, Style::new().color(Color::parse("cyan").unwrap()));
339    t.set(names::PROMPT_DEFAULT, Style::new().color(Color::parse("bright_black").unwrap()));
340
341    t
342}