shell theme: add glass-workbench as a second compiled-in theme
Phase 5 of the shell theme system (THEME_SYSTEM_PLAN.md §11): a second
builtin, demo 02's flush edge-to-edge bar with pill workspaces, a plain
date+time clock, and cpu/ram chips instead of the media widget.
- bread-theme/assets/shell/glass-workbench/: theme.toml + CSS template,
faithful to bos-ui-demos/02-glass-workbench.html. Accent maps to the
`green` palette token (flat, not a gradient) rather than a hex literal,
so pywal theming still works.
- builtin.rs: generalized from a single hardcoded liquid-motion constant
pair to a small BuiltinTheme registry (builtin::ALL / builtin::find),
so mod.rs's discovery/list()/resolve_builtin no longer special-case one
id. liquid-motion stays the pinned fallback in resolve_builtin().
- manifest.rs: KNOWN_MODULES gains "cpu"/"ram".
- types.rs: new Tokens::bar_border() ("full" default vs "bottom") so a
flush bar can ask for a single hairline instead of an island's full
border.
- Tests: builtin loads, appears in list() alongside liquid-motion, and its
window spec is the flush/edge shape (36px, zero margin, radius 0).
cargo test -p bread-theme --lib: 63 passing (59 prior + 4 new).
This commit is contained in:
Breadway
parent
53a6c59f2d
commit
96fa79c1d4
6 changed files with 467 additions and 40 deletions
|
|
@ -1,23 +1,77 @@
|
|||
//! The one compiled-in theme (plan §11 phase 1: "**One** built-in manifest
|
||||
//! (`liquid-motion`) describing the bar as it exists today"). Both files are
|
||||
//! plain data, not Rust — `theme.toml` is the manifest text a user override
|
||||
//! would otherwise supply, and `liquid-motion.css` is the CSS template
|
||||
//! `ShellTheme::css` substitutes tokens into (see that method's doc comment
|
||||
//! for why this template is a representative subset of `breadbar::theme::
|
||||
//! load_css`'s full stylesheet rather than a byte-for-byte copy of it).
|
||||
//! The compiled-in themes (plan §11 phase 1/5: "**One** built-in manifest
|
||||
//! (`liquid-motion`) describing the bar as it exists today", extended in
|
||||
//! Phase 5 with `glass-workbench`, demo 02). Every file here is plain data,
|
||||
//! not Rust — each `theme.toml` is the manifest text a user override would
|
||||
//! otherwise supply, and each `<id>.css` is the CSS template `ShellTheme::css`
|
||||
//! substitutes tokens into (see that method's doc comment for why this
|
||||
//! template is a representative subset of `breadbar::theme::load_css`'s
|
||||
//! full stylesheet rather than a byte-for-byte copy of it).
|
||||
//!
|
||||
//! Both are read with `include_str!` so a broken build can't ship without
|
||||
//! them, and so [`super::builtin`] never touches the filesystem — it must
|
||||
//! work identically whether or not `$XDG_CONFIG_HOME` exists at all.
|
||||
//! All are read with `include_str!` so a broken build can't ship without
|
||||
//! them, and so [`super`] never touches the filesystem for a builtin — it
|
||||
//! must work identically whether or not `$XDG_CONFIG_HOME` exists at all.
|
||||
|
||||
pub const LIQUID_MOTION_ID: &str = "liquid-motion";
|
||||
|
||||
pub const LIQUID_MOTION_TOML: &str = include_str!(concat!(
|
||||
const LIQUID_MOTION_TOML: &str = include_str!(concat!(
|
||||
env!("CARGO_MANIFEST_DIR"),
|
||||
"/assets/shell/liquid-motion/theme.toml"
|
||||
));
|
||||
|
||||
pub const LIQUID_MOTION_CSS: &str = include_str!(concat!(
|
||||
const LIQUID_MOTION_CSS: &str = include_str!(concat!(
|
||||
env!("CARGO_MANIFEST_DIR"),
|
||||
"/assets/shell/liquid-motion/liquid-motion.css"
|
||||
));
|
||||
|
||||
pub const GLASS_WORKBENCH_ID: &str = "glass-workbench";
|
||||
|
||||
const GLASS_WORKBENCH_TOML: &str = include_str!(concat!(
|
||||
env!("CARGO_MANIFEST_DIR"),
|
||||
"/assets/shell/glass-workbench/theme.toml"
|
||||
));
|
||||
|
||||
const GLASS_WORKBENCH_CSS: &str = include_str!(concat!(
|
||||
env!("CARGO_MANIFEST_DIR"),
|
||||
"/assets/shell/glass-workbench/glass-workbench.css"
|
||||
));
|
||||
|
||||
/// One compiled-in theme's identity plus its two `include_str!`ed assets.
|
||||
/// `id`/`name` are also duplicated inside `toml`'s own `id =`/`name =`
|
||||
/// fields — kept here too so [`all`]/[`find`] can list/look up a builtin
|
||||
/// without parsing TOML first (`super::list`'s builtin fallback entry, and
|
||||
/// `super::find_source`'s existence check, both run before any manifest
|
||||
/// parsing happens).
|
||||
pub struct BuiltinTheme {
|
||||
pub id: &'static str,
|
||||
pub name: &'static str,
|
||||
pub toml: &'static str,
|
||||
pub css: &'static str,
|
||||
}
|
||||
|
||||
/// Every compiled-in theme, in the order [`super::list`] should present
|
||||
/// them. Adding a third builtin is one entry here plus its two asset files
|
||||
/// — nothing else in `mod.rs` names a specific builtin id except the always-
|
||||
/// -safe fallback ([`LIQUID_MOTION_ID`], deliberately still hardcoded at
|
||||
/// its one call site in `super::resolve_builtin` — see that function's doc
|
||||
/// comment for why that one reference must NOT become "whichever builtin is
|
||||
/// listed first").
|
||||
pub const ALL: &[BuiltinTheme] = &[
|
||||
BuiltinTheme {
|
||||
id: LIQUID_MOTION_ID,
|
||||
name: "Liquid Motion",
|
||||
toml: LIQUID_MOTION_TOML,
|
||||
css: LIQUID_MOTION_CSS,
|
||||
},
|
||||
BuiltinTheme {
|
||||
id: GLASS_WORKBENCH_ID,
|
||||
name: "Glass Workbench",
|
||||
toml: GLASS_WORKBENCH_TOML,
|
||||
css: GLASS_WORKBENCH_CSS,
|
||||
},
|
||||
];
|
||||
|
||||
/// Looks up a compiled-in theme by id — `None` means "not a builtin",
|
||||
/// exactly like a miss in the user/system theme directories.
|
||||
pub fn find(id: &str) -> Option<&'static BuiltinTheme> {
|
||||
ALL.iter().find(|t| t.id == id)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@ const KNOWN_MODULES: &[&str] = &[
|
|||
"control",
|
||||
"launcher_entry",
|
||||
"launcher_results",
|
||||
// `02-glass-workbench` (plan §11 phase 5): plain right-side stat chips,
|
||||
// reusing the same `AppInput::StatsUpdate` data the control panel's
|
||||
// sys-grid already receives — see breadbar's `bar::slots` module docs.
|
||||
"cpu",
|
||||
"ram",
|
||||
];
|
||||
|
||||
pub(super) fn validate_module_name(theme_id: &str, slot: &str, module: &str) -> anyhow::Result<()> {
|
||||
|
|
|
|||
|
|
@ -175,7 +175,10 @@ fn system_theme_path(id: &str) -> PathBuf {
|
|||
enum Source {
|
||||
User(PathBuf),
|
||||
System(PathBuf),
|
||||
Builtin,
|
||||
/// Carries the id rather than being a bare unit variant now that there's
|
||||
/// more than one compiled-in theme — [`read_source`]/[`css_template_for`]
|
||||
/// need to know *which* builtin's assets to hand back.
|
||||
Builtin(String),
|
||||
}
|
||||
|
||||
fn find_source(id: &str) -> Option<Source> {
|
||||
|
|
@ -187,8 +190,8 @@ fn find_source(id: &str) -> Option<Source> {
|
|||
if system.is_file() {
|
||||
return Some(Source::System(system));
|
||||
}
|
||||
if id == builtin::LIQUID_MOTION_ID {
|
||||
return Some(Source::Builtin);
|
||||
if builtin::find(id).is_some() {
|
||||
return Some(Source::Builtin(id.to_string()));
|
||||
}
|
||||
None
|
||||
}
|
||||
|
|
@ -202,16 +205,19 @@ fn read_source(src: &Source) -> anyhow::Result<(String, Option<PathBuf>)> {
|
|||
std::fs::read_to_string(p).with_context(|| format!("reading {}", p.display()))?;
|
||||
Ok((text, p.parent().map(|d| d.to_path_buf())))
|
||||
}
|
||||
Source::Builtin => Ok((builtin::LIQUID_MOTION_TOML.to_string(), None)),
|
||||
Source::Builtin(id) => {
|
||||
let toml = builtin::find(id)
|
||||
.map(|t| t.toml.to_string())
|
||||
.unwrap_or_default();
|
||||
Ok((toml, None))
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn css_template_for(id: &str) -> String {
|
||||
if id == builtin::LIQUID_MOTION_ID {
|
||||
builtin::LIQUID_MOTION_CSS.to_string()
|
||||
} else {
|
||||
String::new()
|
||||
}
|
||||
builtin::find(id)
|
||||
.map(|t| t.css.to_string())
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
/// The fallible primitive: look up `id` through discovery, apply one level
|
||||
|
|
@ -278,25 +284,27 @@ fn resolve_theme(id: &str, extends_depth: u8) -> anyhow::Result<ShellTheme> {
|
|||
}
|
||||
|
||||
/// Bypasses discovery entirely and resolves straight from the compiled-in
|
||||
/// `LIQUID_MOTION_TOML`/`LIQUID_MOTION_CSS` constants — used as [`load`]'s
|
||||
/// fallback specifically *because* it cannot be affected by a broken user
|
||||
/// override file at the same id (unlike calling `load_named("liquid-motion")`
|
||||
/// again, which would hit that same broken file first via discovery and
|
||||
/// fail identically).
|
||||
/// `liquid-motion` assets — used as [`load`]'s fallback specifically
|
||||
/// *because* it cannot be affected by a broken user override file at the
|
||||
/// same id (unlike calling `load_named("liquid-motion")` again, which would
|
||||
/// hit that same broken file first via discovery and fail identically).
|
||||
/// Deliberately always `liquid-motion`, not "whichever theme was active" or
|
||||
/// "the first entry in `builtin::ALL`" — this is the one theme every other
|
||||
/// fallback path in this module bottoms out at, so its identity has to stay
|
||||
/// pinned regardless of how many more builtins `glass-workbench` grows
|
||||
/// siblings.
|
||||
fn resolve_builtin() -> ShellTheme {
|
||||
let value: toml::Value = toml::from_str(builtin::LIQUID_MOTION_TOML)
|
||||
.expect("compiled-in builtin theme.toml must parse");
|
||||
let asset = builtin::find(builtin::LIQUID_MOTION_ID)
|
||||
.expect("liquid-motion must always be present in builtin::ALL");
|
||||
let value: toml::Value =
|
||||
toml::from_str(asset.toml).expect("compiled-in builtin theme.toml must parse");
|
||||
let raw: RawManifest = value
|
||||
.try_into()
|
||||
.expect("compiled-in builtin theme.toml must satisfy the manifest schema");
|
||||
manifest::validate_slots(&raw, builtin::LIQUID_MOTION_ID)
|
||||
.expect("compiled-in builtin theme.toml must use only known module names");
|
||||
raw.resolve(
|
||||
builtin::LIQUID_MOTION_ID,
|
||||
builtin::LIQUID_MOTION_CSS.to_string(),
|
||||
None,
|
||||
)
|
||||
.expect("compiled-in builtin theme.toml must resolve")
|
||||
raw.resolve(builtin::LIQUID_MOTION_ID, asset.css.to_string(), None)
|
||||
.expect("compiled-in builtin theme.toml must resolve")
|
||||
}
|
||||
|
||||
static FALLBACK_LOGGED: std::sync::Once = std::sync::Once::new();
|
||||
|
|
@ -390,12 +398,14 @@ pub fn list() -> Vec<ThemeSummary> {
|
|||
&mut out,
|
||||
&mut seen,
|
||||
);
|
||||
if seen.insert(builtin::LIQUID_MOTION_ID.to_string()) {
|
||||
out.push(ThemeSummary {
|
||||
id: builtin::LIQUID_MOTION_ID.to_string(),
|
||||
name: "Liquid Motion".to_string(),
|
||||
source: ThemeSource::Builtin,
|
||||
});
|
||||
for b in builtin::ALL {
|
||||
if seen.insert(b.id.to_string()) {
|
||||
out.push(ThemeSummary {
|
||||
id: b.id.to_string(),
|
||||
name: b.name.to_string(),
|
||||
source: ThemeSource::Builtin,
|
||||
});
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
|
@ -618,6 +628,99 @@ mod tests {
|
|||
}
|
||||
}
|
||||
|
||||
// ---- glass-workbench builtin (plan §11 phase 5) -----------------------
|
||||
|
||||
#[test]
|
||||
fn glass_workbench_loads_and_appears_in_list() {
|
||||
let theme = load_named(builtin::GLASS_WORKBENCH_ID)
|
||||
.expect("glass-workbench builtin should resolve");
|
||||
assert_eq!(theme.id(), "glass-workbench");
|
||||
assert_eq!(theme.name(), "Glass Workbench");
|
||||
|
||||
let summaries = list();
|
||||
assert!(
|
||||
summaries
|
||||
.iter()
|
||||
.any(|s| s.id == "glass-workbench" && s.source == ThemeSource::Builtin),
|
||||
"glass-workbench missing from list(): {summaries:?}"
|
||||
);
|
||||
// Both builtins must be listed side by side — Phase 5 must not have
|
||||
// dropped liquid-motion in the process of adding a second theme.
|
||||
assert!(summaries
|
||||
.iter()
|
||||
.any(|s| s.id == "liquid-motion" && s.source == ThemeSource::Builtin));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn glass_workbench_window_is_flush_edge_to_edge_not_a_floating_island() {
|
||||
let theme =
|
||||
load_named(builtin::GLASS_WORKBENCH_ID).expect("glass-workbench should resolve");
|
||||
let w = theme.window();
|
||||
assert_eq!(w.anchors, vec!["top", "left", "right"]);
|
||||
assert!(matches!(w.width, Width::Fill));
|
||||
assert_eq!(w.height, 36);
|
||||
assert_eq!(
|
||||
w.margin,
|
||||
Margin {
|
||||
top: 0,
|
||||
left: 0,
|
||||
right: 0,
|
||||
bottom: 0
|
||||
},
|
||||
"flush bar must have no margin on any edge"
|
||||
);
|
||||
assert_eq!(
|
||||
theme.tokens().radius_bar(),
|
||||
0,
|
||||
"flush edge-to-edge bar must have square corners"
|
||||
);
|
||||
assert_eq!(
|
||||
theme.tokens().bar_border(),
|
||||
"bottom",
|
||||
"flush bar draws only a bottom hairline, not liquid-motion's full border"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn glass_workbench_modules_are_pill_and_plain_with_no_media_slot() {
|
||||
let theme =
|
||||
load_named(builtin::GLASS_WORKBENCH_ID).expect("glass-workbench should resolve");
|
||||
assert!(matches!(
|
||||
theme.modules().workspaces.style,
|
||||
WorkspaceStyle::Pill
|
||||
));
|
||||
assert!(matches!(theme.modules().clock.style, ClockStyle::Plain));
|
||||
assert!(theme.modules().clock.show_date);
|
||||
assert_eq!(theme.slots().centre, vec!["clock"]);
|
||||
assert!(
|
||||
!theme.slots().centre.contains(&"media".to_string()),
|
||||
"demo 02 has no media widget"
|
||||
);
|
||||
assert_eq!(
|
||||
theme.slots().right,
|
||||
vec!["cpu", "ram", "wifi", "battery", "control"]
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn glass_workbench_accent_is_flat_and_a_palette_token_not_hex() {
|
||||
let theme =
|
||||
load_named(builtin::GLASS_WORKBENCH_ID).expect("glass-workbench should resolve");
|
||||
let t = theme.tokens();
|
||||
assert_eq!(t.accent_from(), "green");
|
||||
assert_eq!(t.accent_to(), "green");
|
||||
let css = theme.css(&crate::Palette::default());
|
||||
assert!(
|
||||
css.contains("@green"),
|
||||
"accent_from/accent_to must resolve to the @green palette token, not a hex literal:\n{css}"
|
||||
);
|
||||
assert!(
|
||||
!css.contains("#7a9a88"),
|
||||
"the demo's sage hex must never leak into the manifest — pywal theming depends on \
|
||||
this staying a palette token name:\n{css}"
|
||||
);
|
||||
}
|
||||
|
||||
// ---- extends merge ------------------------------------------------
|
||||
|
||||
#[test]
|
||||
|
|
|
|||
|
|
@ -348,6 +348,16 @@ impl Tokens {
|
|||
pub fn icon_px(&self) -> i64 {
|
||||
self.int_or("icon_px", 24)
|
||||
}
|
||||
/// Not in the plan §4 schema. `"full"` (default, liquid-motion's island)
|
||||
/// draws a border on all four edges; `"bottom"` (glass-workbench's flush
|
||||
/// edge-to-edge bar, plan §1) draws only the bottom hairline the demo's
|
||||
/// `.bar { border-bottom: 1px solid #ffffff12 }` calls for — a floating
|
||||
/// island's full border would otherwise render as a stray top/side line
|
||||
/// flush against the screen edge. See [`Tokens`] doc; consumed by
|
||||
/// `breadbar::theme::load_css`, not by [`crate::shell::ShellTheme::css`].
|
||||
pub fn bar_border(&self) -> String {
|
||||
self.str_or("bar_border", "full")
|
||||
}
|
||||
|
||||
/// Replace every `{name}` occurrence in `template` with that token's
|
||||
/// [`TokenValue::as_css`] form. Longest names are substituted first
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue