//! Shaping types shared by all shapers. Port of `font/shape.zig`.
//!
//! The shaper implementation for the Linux backend is HarfBuzz
//! (`crate::shaper::harfbuzz::Shaper`), for the macOS backend CoreText
//! (`crate::shaper::coretext::Shaper`).

#[cfg(font_coretext_shaper)]
pub use crate::shaper::coretext;
#[cfg(font_coretext_shaper)]
pub use crate::shaper::coretext::{ShapeError, ShapeRunError, Shaper};
pub use crate::shaper::feature::{DEFAULT_FEATURES, Feature, FeatureList};
#[cfg(font_harfbuzz)]
pub use crate::shaper::harfbuzz;
/// Shaper implementation for our compile options (backend
/// `fontconfig_freetype`, `coretext_freetype`, `coretext_harfbuzz` =>
/// HarfBuzz; `coretext` => CoreText; `coretext_noshape` => no-op).
#[cfg(font_harfbuzz)]
pub use crate::shaper::harfbuzz::{ShapeError, ShapeRunError, Shaper};
#[cfg(font_noshape)]
pub use crate::shaper::noop::{ShapeError, ShapeRunError, Shaper};
/// Shaper implementation for the `web_canvas` backend (wasm32).
#[cfg(target_arch = "wasm32")]
pub use crate::shaper::web_canvas::Shaper;
#[cfg(not(target_arch = "wasm32"))]
pub use crate::shaper::{
    cache::Cache,
    noop,
    run::{RunIterator, RunIteratorHook, RunOptions, TextRun},
};

/// A cell is a single single within a terminal that should be rendered
/// for a shaping call. Note all terminal cells may be present; only
/// cells that have a glyph that needs to be rendered.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct Cell {
    /// The X position of this shaper cell relative to the offset of the
    /// run. Because runs are always within a single row, it is expected
    /// that the caller can reconstruct the full position of the cell by
    /// using the known Y position of the cell and adding the X position
    /// to the run offset.
    pub x: u16,

    /// An additional offset to apply to the rendering.
    pub x_offset: i16,
    pub y_offset: i16,

    /// The glyph index for this cell. The font index to use alongside
    /// this cell is available in the text run. This glyph index is only
    /// valid for a given GroupCache and FontIndex that was used to create
    /// the runs.
    pub glyph_index: u32,
}

/// Options for shapers.
#[derive(Debug, Clone, Default)]
pub struct Options {
    /// Font features to use when shaping.
    ///
    /// Note: eventually, this will move to font.Face probably as we may
    /// want to support per-face feature configuration. For now, we only
    /// support applying features globally.
    pub features: Vec<String>,
}