tinymist-world 0.15.0-rc2

//! The font searcher to run the compiler in the system environment.

use std::borrow::Cow;
use std::path::{Path, PathBuf};

use fontdb::Database;
use rayon::iter::{IntoParallelIterator, ParallelIterator};
use tinymist_std::error::prelude::*;
use tinymist_vfs::system::LazyFile;
use typst::diag::{FileError, FileResult};
use typst::foundations::Bytes;
use typst::text::FontInfo;

use super::memory::MemoryFontSearcher;
use super::{FontResolverImpl, FontSlot, LazyBufferFontLoader};
use crate::config::CompileFontOpts;
use crate::debug_loc::{DataSource, FsDataSource};

/// Searches for fonts in the system.
#[derive(Debug)]
pub struct SystemFontSearcher {
    /// The base font searcher.
    base: MemoryFontSearcher,
    /// Records user-specific font path when loading from directory or file for
    /// debug.
    pub font_paths: Vec<PathBuf>,
    /// Stores font data loaded from file
    db: Database,
}

impl SystemFontSearcher {
    /// Creates a new searcher.
    pub fn new() -> Self {
        Self {
            base: MemoryFontSearcher::default(),
            font_paths: vec![],
            db: Database::new(),
        }
    }

    /// Builds a font resolver.
    pub fn build(self) -> FontResolverImpl {
        self.base.build().with_font_paths(self.font_paths)
    }
}

impl SystemFontSearcher {
    /// Resolves fonts from given options.
    pub fn resolve_opts(&mut self, opts: CompileFontOpts) -> Result<()> {
        // Note: the order of adding fonts is important.
        // See: https://github.com/typst/typst/blob/9c7f31870b4e1bf37df79ebbe1df9a56df83d878/src/font/book.rs#L151-L154
        // Source1: add the fonts specified by the user.
        for path in opts.font_paths {
            if path.is_dir() {
                self.search_dir(&path);
            } else {
                let _ = self.search_file(&path);
            }
        }

        // Source2: add the fonts from system paths.
        if !opts.no_system_fonts {
            self.search_system();
        }

        // Flush font db before adding fonts in memory
        self.flush();

        // Source3: add the fonts in memory.
        self.add_memory_fonts(opts.with_embedded_fonts.into_par_iter().map(|font_data| {
            match font_data {
                Cow::Borrowed(data) => Bytes::new(data),
                Cow::Owned(data) => Bytes::new(data),
            }
        }));

        Ok(())
    }

    /// Flushes the searcher, needed before adding fonts in memory.
    pub fn flush(&mut self) {
        use fontdb::Source;

        let face = self.db.faces().collect::<Vec<_>>();
        let info = face.into_par_iter().flat_map(|face| {
            let path = match &face.source {
                Source::File(path) | Source::SharedFile(path, _) => path,
                // We never add binary sources to the database, so there
                // shouln't be any.
                Source::Binary(_) => unreachable!(),
            };

            let info = self.db.with_face_data(face.id, FontInfo::new)??;
            let slot = FontSlot::new(LazyBufferFontLoader::new(
                LazyFile::new(path.clone()),
                face.index,
            ))
            .with_describe(DataSource::Fs(FsDataSource {
                path: path.to_str().unwrap_or_default().to_owned(),
            }));

            Some((info, slot))
        });

        self.base.extend(info.collect::<Vec<_>>());
        self.db = Database::new();
    }

    /// Adds an in-memory font to the searcher.
    pub fn add_memory_font(&mut self, data: Bytes) {
        if !self.db.is_empty() {
            panic!("dirty font search state, please flush the searcher before adding memory fonts");
        }

        self.base.add_memory_font(data);
    }

    /// Adds in-memory fonts to the searcher.
    pub fn add_memory_fonts(&mut self, data: impl ParallelIterator<Item = Bytes>) {
        if !self.db.is_empty() {
            panic!("dirty font search state, please flush the searcher before adding memory fonts");
        }

        self.base.add_memory_fonts(data);
    }

    /// Searches for fonts in the system and adds them to the searcher.
    pub fn search_system(&mut self) {
        self.db.load_system_fonts();
    }

    /// Records a path to the searcher.
    fn record_path(&mut self, path: &Path) {
        self.font_paths.push(if !path.is_relative() {
            path.to_owned()
        } else {
            let current_dir = std::env::current_dir();
            match current_dir {
                Ok(current_dir) => current_dir.join(path),
                Err(_) => path.to_owned(),
            }
        });
    }

    /// Searches for all fonts in a directory recursively.
    pub fn search_dir(&mut self, path: impl AsRef<Path>) {
        self.record_path(path.as_ref());

        self.db.load_fonts_dir(path);
    }

    /// Indexes the fonts in the file at the given path.
    pub fn search_file(&mut self, path: impl AsRef<Path>) -> FileResult<()> {
        self.record_path(path.as_ref());

        self.db
            .load_font_file(path.as_ref())
            .map_err(|e| FileError::from_io(e, path.as_ref()))
    }
}

impl Default for SystemFontSearcher {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {

    #[test]
    fn edit_fonts() {
        use clap::Parser as _;

        use crate::args::CompileOnceArgs;

        let args = CompileOnceArgs::parse_from(["tinymist", "main.typ"]);
        let mut verse = args
            .resolve_system()
            .expect("failed to resolve system universe");

        // todo: a good way to edit fonts
        let new_fonts = verse.font_resolver.clone();

        verse.increment_revision(|verse| verse.set_fonts(new_fonts));
    }
}