Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a builder to FontSystem #325

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a builder to FontSystem #325

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e47e899
Add a builder to FontSystem
vbfox Oct 29, 2024
01ed232
Use a more realistic example
vbfox Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 234 additions & 19 deletions src/font/system.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,34 +126,187 @@ impl fmt::Debug for FontSystem {
}
}

/// A builder for [`FontSystem`] with the following default configuration:
///
/// * Use the system locale on `std` or `en-US` on `no_std`
/// * Load system fonts
/// * Use `Fira Mono` as the monospace family
/// * Use `Fira Sans` as the sans-serif family
/// * Use `DejaVu Serif` as the serif family
///
/// # Timing
///
/// When system fonts are loaded (The default under `std`) this function takes some time to
/// run. On the release build, it can take up to a second, while debug builds can take up to
/// ten times longer. For this reason, it should only be built once, and the resulting
/// [`FontSystem`] should be shared.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # macro_rules! include_bytes { ($e:expr) => {[]} }
/// use std::sync::Arc;
/// use cosmic_text::FontSystem;
/// use cosmic_text::fontdb::Source;
///
/// let font = Source::Binary(Arc::new(include_bytes!("Roboto.ttf")));
/// FontSystem::builder()
/// .locale(Some("fr-FR"))
/// .load_font(font)
/// .build();
/// ```
#[derive(Debug)]
pub struct FontSystemBuilder {
locale: Option<String>,
load_system_fonts: bool,
database: Option<fontdb::Database>,
fonts: Vec<fontdb::Source>,
monospace_family: String,
sans_serif_family: String,
serif_family: String,
}

impl FontSystemBuilder {
fn new() -> Self {
FontSystemBuilder {
locale: None,
load_system_fonts: true,
database: None,
fonts: Vec::new(),
monospace_family: String::from("Fira Mono"),
sans_serif_family: String::from("Fira Sans"),
serif_family: String::from("DejaVu Serif"),
}
}

/// Consume the builder and create the [`FontSystem`]
pub fn build(self) -> FontSystem {
FontSystem::new_from_builder(self)
}

/// Specify the locale that will be used for font fallback or [`None`] for the default.
///
/// Default: the system locale on `std` or `en-US` on `no_std`
pub fn locale(mut self, value: Option<impl Into<String>>) -> Self {
self.locale = value.map(|s| s.into());
self
}

/// Enable loading all system fonts
///
/// Default: enabled
#[cfg(feature = "std")]
pub fn load_system_fonts(mut self, enabled: bool) -> Self {
self.load_system_fonts = enabled;
self
}

/// Use the specified font database instead of a new one.
///
/// *Note*: The database will be modified when the [`FontSystem`] is build depending on the
/// configured options. To Start from an unchanged database use
/// [`FontSystem::new_with_locale_and_db`].
///
pub fn database(mut self, value: Option<fontdb::Database>) -> Self {
self.database = value;
self
}

/// Load an additional font
///
/// # Examples
///
/// ```no_run
/// # macro_rules! include_bytes { ($e:expr) => {[]} }
/// use std::sync::Arc;
/// use cosmic_text::FontSystem;
/// use cosmic_text::fontdb::Source;
///
/// FontSystem::builder()
/// .load_font(Source::Binary(Arc::new(include_bytes!("Roboto-Regular.ttf"))))
/// .load_font(Source::File("./Roboto.ttf".into()))
/// .build();
/// ```
pub fn load_font(mut self, source: fontdb::Source) -> Self {
self.fonts.push(source);
self
}

/// Load additional fonts
///
/// # Examples
///
/// ```no_run
/// # macro_rules! include_bytes { ($e:expr) => {[]} }
/// use std::sync::Arc;
/// use cosmic_text::FontSystem;
/// use cosmic_text::fontdb::Source;
///
/// FontSystem::builder()
/// .load_fonts([
/// Source::Binary(Arc::new(include_bytes!("Roboto-Regular.ttf"))),
/// Source::File("./Roboto.ttf".into())
/// ])
/// .build();
/// ```
pub fn load_fonts(mut self, sources: impl IntoIterator<Item = fontdb::Source>) -> Self {
for source in sources.into_iter() {
self.fonts.push(source);
}
self
}

/// Sets the family that will be used by `Family::Monospace`.
///
/// Default: `Fira Mono`
pub fn monospace_family(mut self, value: impl Into<String>) -> Self {
self.monospace_family = value.into();
self
}

/// Sets the family that will be used by `Family::SansSerif`.
///
/// Default: `Fira Sans`
pub fn sans_serif_family(mut self, value: impl Into<String>) -> Self {
self.sans_serif_family = value.into();
self
}

/// Sets the family that will be used by `Family::Serif`.
///
/// Default: `DejaVu Serif`
pub fn serif_family(mut self, value: impl Into<String>) -> Self {
self.serif_family = value.into();
self
}
}

impl FontSystem {
const FONT_MATCHES_CACHE_SIZE_LIMIT: usize = 256;
/// Create a new [`FontSystem`], that allows access to any installed system fonts

/// Create a new [`FontSystem`], that allows access to any installed system fonts.
///
/// # Timing
///
/// This function takes some time to run. On the release build, it can take up to a second,
/// while debug builds can take up to ten times longer. For this reason, it should only be
/// called once, and the resulting [`FontSystem`] should be shared.
pub fn new() -> Self {
Self::new_with_fonts(core::iter::empty())
Self::builder().build()
}

/// Create a new [`FontSystem`] with a pre-specified set of fonts.
/// Create a new [`FontSystem`] with a pre-specified set of fonts and access to any installed
/// system fonts.
///
/// # Timing
///
/// This function takes some time to run. On the release build, it can take up to a second,
/// while debug builds can take up to ten times longer. For this reason, it should only be
/// called once, and the resulting [`FontSystem`] should be shared.
pub fn new_with_fonts(fonts: impl IntoIterator<Item = fontdb::Source>) -> Self {
let locale = Self::get_locale();
log::debug!("Locale: {}", locale);

let mut db = fontdb::Database::new();

//TODO: configurable default fonts
db.set_monospace_family("Fira Mono");
db.set_sans_serif_family("Fira Sans");
db.set_serif_family("DejaVu Serif");

Self::load_fonts(&mut db, fonts.into_iter());

Self::new_with_locale_and_db(locale, db)
Self::builder().load_fonts(fonts).build()
}

/// Create a new [`FontSystem`] with a pre-specified locale and font database.
Expand Down Expand Up @@ -197,6 +350,58 @@ impl FontSystem {
ret
}

/// Create builder for [`FontSystem`] with the following default configuration:
///
/// * Use the system locale on `std` or `en-US` on `no_std`
/// * Load system fonts
/// * Use `Fira Mono` as the monospace family
/// * Use `Fira Sans` as the sans-serif family
/// * Use `DejaVu Serif` as the serif family
///
/// # Timing
///
/// When system fonts are loaded (The default under `std`) this function takes some time to
/// run. On the release build, it can take up to a second, while debug builds can take up to
/// ten times longer. For this reason, it should only be built once, and the resulting
/// [`FontSystem`] should be shared.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// # macro_rules! include_bytes { ($e:expr) => {[]} }
/// use std::sync::Arc;
/// use cosmic_text::FontSystem;
/// use cosmic_text::fontdb::Source;
///
/// let font = Source::Binary(Arc::new(include_bytes!("Roboto.ttf")));
/// FontSystem::builder()
/// .locale(Some("fr-FR"))
/// .load_font(font)
/// .build();
/// ```
pub fn builder() -> FontSystemBuilder {
FontSystemBuilder::new()
}

fn new_from_builder(builder: FontSystemBuilder) -> FontSystem {
let locale = builder.locale.unwrap_or_else(|| Self::get_locale());
let mut db = builder.database.unwrap_or_else(|| fontdb::Database::new());

db.set_monospace_family(builder.monospace_family);
db.set_sans_serif_family(builder.sans_serif_family);
db.set_serif_family(builder.serif_family);

Self::load_fonts(
&mut db,
builder.fonts.into_iter(),
builder.load_system_fonts,
);

Self::new_with_locale_and_db(locale, db)
}

/// Get the locale.
pub fn locale(&self) -> &str {
&self.locale
Expand Down Expand Up @@ -373,11 +578,17 @@ impl FontSystem {
}

#[cfg(feature = "std")]
fn load_fonts(db: &mut fontdb::Database, fonts: impl Iterator<Item = fontdb::Source>) {
fn load_fonts(
db: &mut fontdb::Database,
fonts: impl Iterator<Item = fontdb::Source>,
load_system_fonts: bool,
) {
#[cfg(not(target_arch = "wasm32"))]
let now = std::time::Instant::now();

db.load_system_fonts();
if load_system_fonts {
db.load_system_fonts();
}

for source in fonts {
db.load_font_source(source);
Expand All @@ -392,7 +603,11 @@ impl FontSystem {
}

#[cfg(not(feature = "std"))]
fn load_fonts(db: &mut fontdb::Database, fonts: impl Iterator<Item = fontdb::Source>) {
fn load_fonts(
db: &mut fontdb::Database,
fonts: impl Iterator<Item = fontdb::Source>,
_load_system_fonts: bool,
) {
for source in fonts {
db.load_font_source(source);
}
Expand Down
Loading