Milky2018/moon_swash/shape

README
U
Decompose
U
FeatureSetting
U
GlyphId
U
NormalizedCoord
U
Tag
U
UserData
U
VariationSetting
Tr
Codepoint
Tr
TableProvider
T
Action
- ::iterAnalyze::iter
- ::needs_bidi_resolutionAnalyze::needs_bidi_resolution
- ::nextAnalyze::next
- ::set_break_strengthAnalyze::set_break_strength
- ::AttributesAttributes::Attributes
- ::equalAttributes::equal
- ::from_fontAttributes::from_font
- ::has_italic_variationAttributes::has_italic_variation
- ::has_oblique_variationAttributes::has_oblique_variation
- ::has_stretch_variationAttributes::has_stretch_variation
- ::has_variationsAttributes::has_variations
- ::has_weight_variationAttributes::has_weight_variation
- ::not_equalAttributes::not_equal
- ::outputAttributes::output
- ::partsAttributes::parts
- ::stretchAttributes::stretch
- ::styleAttributes::style
- ::synthesizeAttributes::synthesize
- ::to_stringAttributes::to_string
- ::weightAttributes::weight
- ::needs_resolutionBidiClass::needs_resolution
- ::bit_depthBitmapStrike::bit_depth
- ::containsBitmapStrike::contains
- ::ppemBitmapStrike::ppem
- ::ppiBitmapStrike::ppi
- ::find_by_exact_ppemBitmapStrikes::find_by_exact_ppem
- ::find_by_largest_ppemBitmapStrikes::find_by_largest_ppem
- ::find_by_nearest_ppemBitmapStrikes::find_by_nearest_ppem
- ::iterBitmapStrikes::iter
- ::lenBitmapStrikes::len
- ::from_fontBitmapStrikesProxy::from_font
- ::has_alphaBitmapStrikesProxy::has_alpha
- ::has_colorBitmapStrikesProxy::has_color
- ::materialize_alphaBitmapStrikesProxy::materialize_alpha
- ::materialize_colorBitmapStrikesProxy::materialize_color
T
Block
T
Boundary
T
BoundaryState
T
BracketType
- ::CacheKeyCacheKey::CacheKey
- ::valueCacheKey::value
T
Category
- ::CharClusterCharCluster::CharCluster
- ::charsCharCluster::chars
- ::clearCharCluster::clear
- ::infoCharCluster::info
- ::is_emptyCharCluster::is_empty
- ::mapCharCluster::map
- ::mapped_charsCharCluster::mapped_chars
- ::rangeCharCluster::range
- ::user_dataCharCluster::user_data
- ::CharInfoCharInfo::CharInfo
- ::boundaryCharInfo::boundary
- ::categoryCharInfo::category
- ::cluster_breakCharInfo::cluster_break
- ::cluster_classCharInfo::cluster_class
- ::contributes_to_shapingCharInfo::contributes_to_shaping
- ::defaultCharInfo::default
- ::from_charCharInfo::from_char
- ::is_ignorableCharInfo::is_ignorable
- ::is_variation_selectorCharInfo::is_variation_selector
- ::joining_typeCharInfo::joining_type
- ::myanmar_classCharInfo::myanmar_class
- ::propertiesCharInfo::properties
- ::use_classCharInfo::use_class
T
CharStream
- ::enumerateCharmap::enumerate
- ::from_fontCharmap::from_font
- ::mapCharmap::map
- ::proxyCharmap::proxy
- ::from_fontCharmapProxy::from_font
- ::materializeCharmapProxy::materialize
T
Cjk
T
ClusterBreak
- ::ClusterCharClusterChar::ClusterChar
- ::chClusterChar::ch
- ::contributes_to_shapingClusterChar::contributes_to_shaping
- ::dataClusterChar::data
- ::glyph_idClusterChar::glyph_id
- ::is_ignorableClusterChar::is_ignorable
- ::joining_typeClusterChar::joining_type
- ::offsetClusterChar::offset
- ::shape_classClusterChar::shape_class
- ::boundaryClusterInfo::boundary
- ::emojiClusterInfo::emoji
- ::is_boundaryClusterInfo::is_boundary
- ::is_brokenClusterInfo::is_broken
- ::is_emojiClusterInfo::is_emoji
- ::is_whitespaceClusterInfo::is_whitespace
- ::whitespaceClusterInfo::whitespace
- ::getColorPalette::get
- ::indexColorPalette::index
- ::is_emptyColorPalette::is_empty
- ::lenColorPalette::len
- ::nameColorPalette::name
- ::name_idColorPalette::name_id
- ::usabilityColorPalette::usability
- ::from_fontColorPalettes::from_font
- ::iterColorPalettes::iter
- ::lenColorPalettes::len
T
CombiningClass
T
Emoji
- ::is_decodableEncoding::is_decodable
T
Entry
- ::actionFeature::action
- ::nameFeature::name
- ::tagFeature::tag
- ::from_fontFeatures::from_font
- ::iterFeatures::iter
- ::FontCacheFontCache::FontCache
- ::getFontCache::get
- ::dataFontDataRef::data
- ::fontsFontDataRef::fonts
- ::from_dataFontDataRef::from_data
- ::getFontDataRef::get
- ::is_collectionFontDataRef::is_collection
- ::is_emptyFontDataRef::is_empty
- ::lenFontDataRef::len
- ::alpha_strikesFontRef::alpha_strikes
- ::attributesFontRef::attributes
- ::color_palettesFontRef::color_palettes
- ::color_strikesFontRef::color_strikes
- ::dataFontRef::data
- ::featuresFontRef::features
- ::from_indexFontRef::from_index
- ::from_offsetFontRef::from_offset
- ::glyph_metricsFontRef::glyph_metrics
- ::glyph_nameFontRef::glyph_name
- ::headFontRef::head
- ::hheaFontRef::hhea
- ::instancesFontRef::instances
- ::keyFontRef::key
- ::localized_stringsFontRef::localized_strings
- ::maxpFontRef::maxp
- ::metricsFontRef::metrics
- ::offsetFontRef::offset
- ::os2FontRef::os2
- ::postFontRef::post
- ::table_by_tagFontRef::table_by_tag
- ::table_dataFontRef::table_data
- ::table_offsetFontRef::table_offset
- ::variationsFontRef::variations
- ::vheaFontRef::vhea
- ::writing_systemsFontRef::writing_systems
- ::advance_heightGlyphMetrics::advance_height
- ::advance_widthGlyphMetrics::advance_width
- ::glyph_countGlyphMetrics::glyph_count
- ::has_variationsGlyphMetrics::has_variations
- ::has_vertical_metricsGlyphMetrics::has_vertical_metrics
- ::linear_scaleGlyphMetrics::linear_scale
- ::lsbGlyphMetrics::lsb
- ::scaleGlyphMetrics::scale
- ::tsbGlyphMetrics::tsb
- ::units_per_emGlyphMetrics::units_per_em
- ::vertical_originGlyphMetrics::vertical_origin
- ::indexInstance::index
- ::nameInstance::name
- ::name_idInstance::name_id
- ::normalized_coordsInstance::normalized_coords
- ::postscript_nameInstance::postscript_name
- ::postscript_name_idInstance::postscript_name_id
- ::valuesInstance::values
- ::find_by_nameInstances::find_by_name
- ::find_by_postscript_nameInstances::find_by_postscript_name
- ::iterInstances::iter
- ::nextInstances::next
T
JoiningType
- ::cjkLanguage::cjk
- ::from_opentypeLanguage::from_opentype
- ::languageLanguage::language
- ::nameLanguage::name
- ::outputLanguage::output
- ::parseLanguage::parse
- ::regionLanguage::region
- ::scriptLanguage::script
- ::to_opentypeLanguage::to_opentype
- ::to_stringLanguage::to_string
T
LineBreak
- ::charsLocalizedString::chars
- ::idLocalizedString::id
- ::is_decodableLocalizedString::is_decodable
- ::is_unicodeLocalizedString::is_unicode
- ::languageLocalizedString::language
- ::to_stringLocalizedString::to_string
- ::find_by_idLocalizedStrings::find_by_id
- ::iterLocalizedStrings::iter
- ::lenLocalizedStrings::len
- ::linear_scaleMetrics::linear_scale
- ::scaleMetrics::scale
- ::from_fontMetricsProxy::from_font
- ::glyph_countMetricsProxy::glyph_count
- ::materialize_glyph_metricsMetricsProxy::materialize_glyph_metrics
- ::materialize_metricsMetricsProxy::materialize_metrics
- ::units_per_emMetricsProxy::units_per_em
T
MyanmarClass
- ::from_degreesObliqueAngle::from_degrees
- ::from_gradiansObliqueAngle::from_gradians
- ::from_radiansObliqueAngle::from_radians
- ::from_turnsObliqueAngle::from_turns
- ::to_degreesObliqueAngle::to_degrees
- ::ParserParser::Parser
- ::nextParser::next
- ::bidi_classProperties::bidi_class
- ::blockProperties::block
- ::boundaryProperties::boundary
- ::categoryProperties::category
- ::cluster_breakProperties::cluster_break
- ::cluster_classProperties::cluster_class
- ::combining_classProperties::combining_class
- ::contributes_to_shapingProperties::contributes_to_shaping
- ::is_close_bracketProperties::is_close_bracket
- ::is_emojiProperties::is_emoji
- ::is_extended_pictographicProperties::is_extended_pictographic
- ::is_ignorableProperties::is_ignorable
- ::is_open_bracketProperties::is_open_bracket
- ::is_variation_selectorProperties::is_variation_selector
- ::joining_typeProperties::joining_type
- ::line_breakProperties::line_break
- ::myanmar_classProperties::myanmar_class
- ::scriptProperties::script
- ::use_classProperties::use_class
- ::with_boundaryProperties::with_boundary
- ::word_breakProperties::word_break
- ::from_opentypeScript::from_opentype
- ::is_complexScript::is_complex
- ::is_joinedScript::is_joined
- ::nameScript::name
- ::to_opentypeScript::to_opentype
- ::SeenFeaturesSeenFeatures::SeenFeatures
- ::markSeenFeatures::mark
- ::SettingSetting::Setting
- ::parse_featureSetting::parse_feature
- ::parse_feature_listSetting::parse_feature_list
- ::parse_variationSetting::parse_variation
- ::parse_variation_listSetting::parse_variation_list
T
ShapeClass
- ::SourceRangeSourceRange::SourceRange
- ::endSourceRange::end
- ::startSourceRange::start
T
Status
- ::compareStretch::compare
- ::condensedStretch::condensed
- ::equalStretch::equal
- ::expandedStretch::expanded
- ::extra_condensedStretch::extra_condensed
- ::extra_expandedStretch::extra_expanded
- ::from_percentageStretch::from_percentage
- ::is_condensedStretch::is_condensed
- ::is_expandedStretch::is_expanded
- ::is_normalStretch::is_normal
- ::normalStretch::normal
- ::not_equalStretch::not_equal
- ::op_geStretch::op_ge
- ::op_gtStretch::op_gt
- ::op_leStretch::op_le
- ::op_ltStretch::op_lt
- ::outputStretch::output
- ::parseStretch::parse
- ::rawStretch::raw
- ::semi_condensedStretch::semi_condensed
- ::semi_expandedStretch::semi_expanded
- ::to_percentageStretch::to_percentage
- ::to_stringStretch::to_string
- ::ultra_condensedStretch::ultra_condensed
- ::ultra_expandedStretch::ultra_expanded
- ::from_rawStringId::from_raw
- ::to_rawStringId::to_raw
- ::equalStyle::equal
- ::from_degreesStyle::from_degrees
- ::not_equalStyle::not_equal
- ::outputStyle::output
- ::parseStyle::parse
- ::to_degreesStyle::to_degrees
- ::to_stringStyle::to_string
- ::anySynthesis::any
- ::emboldenSynthesis::embolden
- ::equalSynthesis::equal
- ::not_equalSynthesis::not_equal
- ::skewSynthesis::skew
- ::variationsSynthesis::variations
- ::TokenToken::Token
- ::chToken::ch
- ::dataToken::data
- ::defaultToken::default
- ::infoToken::info
- ::lenToken::len
- ::offsetToken::offset
T
Usability
T
UseClass
- ::default_valueVariation::default_value
- ::indexVariation::index
- ::is_hiddenVariation::is_hidden
- ::max_valueVariation::max_value
- ::min_valueVariation::min_value
- ::nameVariation::name
- ::name_idVariation::name_id
- ::normalizeVariation::normalize
- ::tagVariation::tag
- ::find_by_tagVariations::find_by_tag
- ::iterVariations::iter
- ::lenVariations::len
- ::nextVariations::next
- ::normalized_coordsVariations::normalized_coords
- ::from_fontVariationsProxy::from_font
- ::materializeVariationsProxy::materialize
- ::blackWeight::black
- ::boldWeight::bold
- ::compareWeight::compare
- ::equalWeight::equal
- ::extra_boldWeight::extra_bold
- ::extra_lightWeight::extra_light
- ::lightWeight::light
- ::mediumWeight::medium
- ::normalWeight::normal
- ::not_equalWeight::not_equal
- ::op_geWeight::op_ge
- ::op_gtWeight::op_gt
- ::op_leWeight::op_le
- ::op_ltWeight::op_lt
- ::outputWeight::output
- ::parseWeight::parse
- ::semi_boldWeight::semi_bold
- ::thinWeight::thin
- ::to_stringWeight::to_string
- ::is_space_or_nbspWhitespace::is_space_or_nbsp
T
WordBreak
T
WordBreakStrength
- ::featuresWritingSystem::features
- ::languageWritingSystem::language
- ::language_tagWritingSystem::language_tag
- ::scriptWritingSystem::script
- ::script_tagWritingSystem::script_tag
- ::from_fontWritingSystems::from_font
- ::iterWritingSystems::iter
V
COMPOSE1_COUNT
V
MAX_CLUSTER_SIZE
V
UNICODE_VERSION_MAJOR
V
UNICODE_VERSION_MINOR
V
UNICODE_VERSION_PATCH
V
analyze
V
compose_pair
V
decompose
V
decompose_compat
V
desc_from_aat
V
desc_from_at
V
tag_from_bytes
V
tag_from_str_lossy
V
unicode_version

Milky2018/moon_swash/shape does not have a README file

CharCluster

using @Milky2018/moon_swash { type CharCluster }

Character cluster; output from the parser and input to the shaper.

ClusterChar

source

using @Milky2018/moon_swash { type ClusterChar }

Character output from the cluster parser.

ClusterInfo

source

using @Milky2018/moon_swash { type ClusterInfo }

Information about a cluster including content properties and boundary analysis.

Epoch

source

type Epoch = UInt64

Shaping caches (font metadata + feature store).

Ported from upstream swash/src/shape/cache.rs.

FeatureBit

source

type FeatureBit = UInt16

OpenType GSUB/GPOS shaping (AT).

Ported from upstream swash/src/shape/at.rs.

GlyphId

source

type GlyphId = UInt16

JoiningType

source

using @Milky2018/moon_swash { type JoiningType }

ShapeClass

source

using @Milky2018/moon_swash { type ShapeClass }

Shaping class of a character.

SourceRange

source

using @Milky2018/moon_swash { type SourceRange }

Source range of a cluster in code units.

Tag

source

type Tag = UInt

Mapping complex text to a sequence of positioned glyphs.

This package is a strict port of upstream swash/src/shape/*.

UserData

source

type UserData = UInt

Selector

source

pub(open) trait Selector {
  fn select_font(Self, cluster : @Milky2018/moon_swash.CharCluster
CharCluster) -> SelectedFont?
}

Trait for types that can select appropriate fonts for character clusters.

ShapeOptions

source

pub(open) trait ShapeOptions {
  fn script(Self) -> @Milky2018/moon_swash.Script
Script
  fn language(Self) -> @Milky2018/moon_swash.Language
Language?
  fn direction(Self) -> Direction
  fn size(Self) -> Double
  fn features(Self) -> Iter[@Milky2018/moon_swash.Setting
Setting[UInt16]]
  fn variations(Self) -> Iter[@Milky2018/moon_swash.Setting
Setting[Double]]
  fn insert_dotted_circles(Self) -> Bool
}

Trait for types that specify shaping options.

Buffer

source

pub struct Buffer {
  glyphs : Array[GlyphData]
  positions : Array[PositionData]
  infos : Array[(@Milky2018/moon_swash.ClusterInfo
ClusterInfo, Bool, UInt)]
  ranges : Array[@Milky2018/moon_swash.SourceRange
SourceRange]
  shaped_glyphs : Array[Glyph]
  is_rtl : Bool
  dotted_circle : UInt16?
  has_cursive : Bool
  has_marks : Bool
  reversed : Bool
  next_cluster : UInt
  skip_state : SkipState
  sub_args : Array[UInt16]
  pos_args : Array[UInt16]
}

Buffer::Buffer

source

fn Buffer::Buffer() -> Buffer

Buffer::_push_hangul

source

fn Buffer::_push_hangul(self : Buffer, cluster : @Milky2018/moon_swash.CharCluster
CharCluster) -> IndexRange

Buffer::clear

source

fn Buffer::clear(self : Buffer) -> Unit

Buffer::clear_flags

source

fn Buffer::clear_flags(self : Buffer, flags : UInt16, range : IndexRange?) -> Unit

Buffer::default

source

fn Buffer::default() -> Buffer

Buffer::ensure_order

source

fn Buffer::ensure_order(self : Buffer, reversed : Bool) -> Unit

Buffer::glyphs

source

fn Buffer::glyphs(self : Buffer) -> ArrayView[GlyphData]

Buffer::len

source

fn Buffer::len(self : Buffer) -> Int

Buffer::multiply

source

fn Buffer::multiply(self : Buffer, index : Int, count : Int) -> Unit

Buffer::position

source

fn Buffer::position(self : Buffer, index : Int, x : Double, y : Double, xadvance : Double, _yadvance : Double) -> Unit

Buffer::position_cursive

source

fn Buffer::position_cursive(self : Buffer, index : Int, next : Int, _x : Double, y : Double) -> Unit

Buffer::position_mark

source

fn Buffer::position_mark(self : Buffer, index : Int, base : Int, dx : Double, dy : Double) -> Unit

Buffer::positions

source

fn Buffer::positions(self : Buffer) -> ArrayView[PositionData]

Buffer::push

source

fn Buffer::push(self : Buffer, cluster : @Milky2018/moon_swash.CharCluster
CharCluster) -> IndexRange

Buffer::push_order

source

fn Buffer::push_order(self : Buffer, cluster : @Milky2018/moon_swash.CharCluster
CharCluster, order : ArrayView[Int]) -> IndexRange

Buffer::ranges

source

fn Buffer::ranges(self : Buffer) -> ArrayView[@Milky2018/moon_swash.SourceRange
SourceRange]

Buffer::set_join_masks

source

fn Buffer::set_join_masks(self : Buffer) -> Unit

Buffer::setup_positions

source

fn Buffer::setup_positions(self : Buffer, was_morx : Bool) -> Unit

Buffer::substitute

source

fn Buffer::substitute(self : Buffer, index : Int, id : UInt16) -> Unit

Buffer::substitute_ligature

source

fn Buffer::substitute_ligature(self : Buffer, index : Int, id : UInt16, components : ArrayView[Int]) -> Unit

Buffer::substitute_multiple

source

fn Buffer::substitute_multiple(self : Buffer, index : Int, ids : ArrayView[UInt16]) -> Unit

ContextState

source

type ContextState

CoverageBuilder

source

type CoverageBuilder

Builds a compact coverage cache used to cheaply skip lookups.

Format matches upstream swash/src/shape/at.rs: [min, max, bitset words (u16)], keyed by base index into FeatureStore.coverage.

Direction

source

pub(all) enum Direction {
  LeftToRight
  RightToLeft
}

Text direction.

impl Eq for Direction

Direction::equal

source

fn Direction::equal(self : Direction, other : Direction) -> Bool

Direction::not_equal

source

fn Direction::not_equal(x : Direction, y : Direction) -> Bool

Engine

source

pub struct Engine {
  data : Bytes
  gdef : @Milky2018/moon_swash/internal.Gdef
Gdef
  gsub : StageOffsets
  gpos : StageOffsets
  morx : UInt
  kerx : UInt
  ankr : UInt
  kern : UInt
  storage : Storage
  coords : ArrayView[Int]
  script : @Milky2018/moon_swash.Script
Script
  tags : (UInt, UInt, UInt, UInt)
  sub_mode : SubMode
  pos_mode : PosMode
  use_ot : Bool
  mode : EngineMode
}

Engine::Engine

source

fn Engine::Engine(metadata : EngineMetadata, font_data : Bytes, coords : ArrayView[Int], script : @Milky2018/moon_swash.Script
Script, language : @Milky2018/moon_swash.Language
Language?) -> Engine

Engine::collect_features

source

fn Engine::collect_features(self : Engine, builder : FeatureStoreBuilder, store : @moonbitlang/core/ref.Ref
Ref[FeatureStore]) -> Unit

Builds a feature store for the current engine configuration.

Engine::collect_selectors

source

fn Engine::collect_selectors(self : Engine, features : ArrayView[@Milky2018/moon_swash.Setting
Setting[UInt16]], selectors : Array[(UInt16, UInt16)]) -> Unit

Converts feature settings into a sorted collection of AAT selectors.

Engine::gpos

source

fn Engine::gpos(self : Engine, store : FeatureStore, feature_mask : FeatureMask, buffer : Buffer, buffer_range : IndexRange?) -> Bool

Applies the GPOS features to the specified range of the buffer.

Engine::gsub

source

fn Engine::gsub(self : Engine, store : FeatureStore, feature_mask : FeatureMask, buffer : Buffer, buffer_range : IndexRange?) -> Bool

Applies the GSUB features to the specified range of the buffer.

Engine::has_feature_vars

source

fn Engine::has_feature_vars(self : Engine) -> Bool

Returns true if feature variations are supported.

Engine::kern

source

fn Engine::kern(self : Engine, buffer : Buffer) -> Unit

Applies the kerning table.

Engine::kerx

source

fn Engine::kerx(self : Engine, buffer : Buffer, disable_kern : Bool) -> Unit

Applies the extended kerning table.

Engine::morx

source

fn Engine::morx(self : Engine, buffer : Buffer, selectors : ArrayView[(UInt16, UInt16)]) -> Unit

Applies the extended metamorphosis table.

Engine::set_classes

source

fn Engine::set_classes(self : Engine, buffer : Buffer, range : IndexRange?) -> Unit

Sets glyph and mark classes for the specified range of the buffer.

Engine::tags

source

fn Engine::tags(self : Engine) -> (UInt, UInt, UInt, UInt)

OpenType shaping.

EngineMetadata

source

pub struct EngineMetadata {
  gdef : UInt
  gsub : UInt
  gpos : UInt
  morx : UInt
  kerx : UInt
  ankr : UInt
  kern : UInt
  sub_mode : SubMode
  pos_mode : PosMode
}

Metadata for creating a shaping engine.

EngineMetadata::from_font

source

fn EngineMetadata::from_font(font : @Milky2018/moon_swash.FontRef
FontRef) -> EngineMetadata

EngineMode

source

pub(all) enum EngineMode {
  Simple
  Myanmar
  Complex
}

impl Eq for EngineMode

EngineMode::equal

source

fn EngineMode::equal(self : EngineMode, other : EngineMode) -> Bool

EngineMode::not_equal

source

fn EngineMode::not_equal(x : EngineMode, y : EngineMode) -> Bool

FeatureGroups

source

pub struct FeatureGroups {
  default : FeatureMask
  reph : UInt16?
  pref : UInt16?
  stage1 : FeatureMask
  stage2 : FeatureMask
  basic : FeatureMask
  position : FeatureMask
  vert : FeatureMask
  rtl : FeatureMask
}

Masks or bits for specific feature groups.

FeatureGroups::default

source

fn FeatureGroups::default() -> FeatureGroups

FeatureMask

source

pub struct FeatureMask {
  b0 : UInt64
  b1 : UInt64
  b2 : UInt64
  b3 : UInt64
}

Feature mask: up to 256 feature bits packed into 4x u64 words.

FeatureMask::clear

source

fn FeatureMask::clear(self : FeatureMask, bit : UInt16) -> Unit

FeatureMask::default

source

fn FeatureMask::default() -> FeatureMask

FeatureMask::has

source

fn FeatureMask::has(self : FeatureMask, bit : UInt16) -> Bool

FeatureMask::is_empty

source

fn FeatureMask::is_empty(self : FeatureMask) -> Bool

FeatureMask::or

source

fn FeatureMask::or(self : FeatureMask, other : FeatureMask) -> FeatureMask

Returns the union of two masks.

FeatureMask::or_assign

source

fn FeatureMask::or_assign(self : FeatureMask, other : FeatureMask) -> Unit

Mutating OR assignment.

FeatureMask::set

source

fn FeatureMask::set(self : FeatureMask, bit : UInt16) -> Unit

FeatureStore

source

pub struct FeatureStore {
  sub_features : Array[(UInt, UInt16)]
  pos_features : Array[(UInt, UInt16)]
  lookups : Array[@Milky2018/moon_swash/internal.LookupData
LookupData]
  subtables : Array[@Milky2018/moon_swash/internal.SubtableData
SubtableData]
  coverage : Array[UInt16]
  pos_start : Int
  sub_count : Int
  truncated : Bool
  groups : FeatureGroups
}

Cache of features, lookups and subtables for a particular script/language pair.

Only the feature-group plumbing is ported in this step; lookup application is implemented as part of the AT shaper task.

FeatureStore::clear

source

fn FeatureStore::clear(self : FeatureStore) -> Unit

FeatureStore::custom_masks

source

fn FeatureStore::custom_masks(self : FeatureStore, features : ArrayView[@Milky2018/moon_swash.Setting
Setting[UInt16]], sub_args : Array[UInt16], pos_args : Array[UInt16], dir : Direction) -> (FeatureMask, FeatureMask)

Returns new basic and position masks based on the specified custom features.

FeatureStore::default

source

fn FeatureStore::default() -> FeatureStore

FeatureStore::groups

source

fn FeatureStore::groups(self : FeatureStore, script : @Milky2018/moon_swash.Script
Script) -> FeatureGroups

Computes feature groups for a script based on available features.

FeatureStore::pos_bit

source

fn FeatureStore::pos_bit(self : FeatureStore, feature : UInt) -> UInt16?

FeatureStore::sub_bit

source

fn FeatureStore::sub_bit(self : FeatureStore, feature : UInt) -> UInt16?

FeatureStoreBuilder

source

pub struct FeatureStoreBuilder {
  indices : Array[(UInt16, UInt16, Byte)]
  coverage : CoverageBuilder
  next_bit : UInt16
}

Builder for a feature cache.

FeatureStoreBuilder::build

source

fn FeatureStoreBuilder::build(self : FeatureStoreBuilder, store : @moonbitlang/core/ref.Ref
Ref[FeatureStore], data : Bytes, coords : ArrayView[Int], gdef : @Milky2018/moon_swash/internal.Gdef
Gdef, gsub : StageOffsets, gpos : StageOffsets) -> Unit

FeatureStoreBuilder::default

source

fn FeatureStoreBuilder::default() -> FeatureStoreBuilder

FontEntry

source

pub struct FontEntry {
  metrics : @Milky2018/moon_swash.MetricsProxy
MetricsProxy
  charmap : @Milky2018/moon_swash.CharmapProxy
CharmapProxy
  coord_count : UInt16
  metadata : EngineMetadata
}

FontEntry::FontEntry

source

fn FontEntry::FontEntry(font : @Milky2018/moon_swash.FontRef
FontRef) -> FontEntry

Glyph

source

pub struct Glyph {
  id : UInt16
  info : GlyphInfo
  x : Double
  y : Double
  advance : Double
  data : UInt
}

Glyph identifier and positioning information as a result of shaping.

Glyph::advance

source

fn Glyph::advance(self : Glyph) -> Double

Glyph::data

source

fn Glyph::data(self : Glyph) -> UInt

Glyph::default

source

fn Glyph::default() -> Glyph

Glyph::id

source

fn Glyph::id(self : Glyph) -> UInt16

Glyph::info

source

fn Glyph::info(self : Glyph) -> GlyphInfo

Glyph::x

source

fn Glyph::x(self : Glyph) -> Double

Glyph::y

source

fn Glyph::y(self : Glyph) -> Double

GlyphCluster

source

pub struct GlyphCluster {
  source : @Milky2018/moon_swash.SourceRange
SourceRange
  info : @Milky2018/moon_swash.ClusterInfo
ClusterInfo
  glyphs : ArrayView[Glyph]
  components : ArrayView[@Milky2018/moon_swash.SourceRange
SourceRange]
  data : UInt
}

Collection of glyphs and associated metadata corresponding to one or more source clusters.

GlyphCluster::advance

source

fn GlyphCluster::advance(self : GlyphCluster) -> Double

Computes the full advance width or height of the cluster.

GlyphCluster::components

source

fn GlyphCluster::components(self : GlyphCluster) -> ArrayView[@Milky2018/moon_swash.SourceRange
SourceRange]

GlyphCluster::data

source

fn GlyphCluster::data(self : GlyphCluster) -> UInt

GlyphCluster::glyphs

source

fn GlyphCluster::glyphs(self : GlyphCluster) -> ArrayView[Glyph]

GlyphCluster::info

source

fn GlyphCluster::info(self : GlyphCluster) -> @Milky2018/moon_swash.ClusterInfo
ClusterInfo

GlyphCluster::is_complex

source

fn GlyphCluster::is_complex(self : GlyphCluster) -> Bool

Returns true if the cluster is complex-- that is if it contains more than one glyph. This will be true for clusters containing marks and is also commonly true for syllabic languages such as those in the Indic family.

GlyphCluster::is_empty

source

fn GlyphCluster::is_empty(self : GlyphCluster) -> Bool

Returns true if the cluster is empty. Empty clusters still represent characters in the source text, but contain no glyphs. This will be true, for example, with newline sequences (\n or \r\n) as well as other control characters.

GlyphCluster::is_ligature

source

fn GlyphCluster::is_ligature(self : GlyphCluster) -> Bool

Returns true if the cluster corresponds to multiple source clusters. Note that a ligature cluster can also be complex.

GlyphCluster::is_simple

source

fn GlyphCluster::is_simple(self : GlyphCluster) -> Bool

Returns true if the cluster contains a single glyph. Note that a simple cluster can also be a ligature.

GlyphCluster::source

source

fn GlyphCluster::source(self : GlyphCluster) -> @Milky2018/moon_swash.SourceRange
SourceRange

GlyphData

source

pub struct GlyphData {
  id : UInt16
  flags : UInt16
  class : Byte
  char_class : @Milky2018/moon_swash.ShapeClass
ShapeClass
  mark_type : Byte
  joining_type : Byte
  mask : Byte
  skip : Bool
  component : Byte
  cluster : UInt
  data : UInt
}

Per glyph shaping data.

GlyphData::cluster

source

fn GlyphData::cluster(self : GlyphData) -> UInt

GlyphData::default

source

fn GlyphData::default() -> GlyphData

GlyphData::flags

source

fn GlyphData::flags(self : GlyphData) -> UInt16

GlyphData::id

source

fn GlyphData::id(self : GlyphData) -> UInt16

GlyphData::is_component

source

fn GlyphData::is_component(self : GlyphData) -> Bool

GlyphInfo

source

pub struct GlyphInfo {
  bits : UInt16
}

Information for a glyph.

GlyphInfo::GlyphInfo

source

fn GlyphInfo::GlyphInfo(bits : UInt16) -> GlyphInfo

GlyphInfo::default

source

fn GlyphInfo::default() -> GlyphInfo

GlyphInfo::is_mark

source

fn GlyphInfo::is_mark(self : GlyphInfo) -> Bool

Returns true if the glyph is an attached mark.

IndexRange

source

pub struct IndexRange {
  start : Int
  end : Int
}

IndexRange::IndexRange

source

fn IndexRange::IndexRange(start : Int, end : Int) -> IndexRange

IndexRange::end

source

fn IndexRange::end(self : IndexRange) -> Int

IndexRange::start

source

fn IndexRange::start(self : IndexRange) -> Int

LookupState

source

type LookupState

Lookup cursor state for nested lookups.

PosMode

source

pub(all) enum PosMode {
  None
  Gpos
  Kerx
  Kern
}

impl Eq for PosMode

PosMode::equal

source

fn PosMode::equal(self : PosMode, other : PosMode) -> Bool

PosMode::not_equal

source

fn PosMode::not_equal(x : PosMode, y : PosMode) -> Bool

PositionData

source

pub struct PositionData {
  base : Byte
  flags : UInt16
  x : Double
  y : Double
  advance : Double
}

Per glyph shaping position data.

PositionData::default

source

fn PositionData::default() -> PositionData

SelectedFont

source

pub struct SelectedFont {
  font : @Milky2018/moon_swash.FontRef
FontRef
  id_override : (UInt64, UInt64)?
  synthesis : @Milky2018/moon_swash.Synthesis
Synthesis?
}

Font selected for a cluster.

Note: upstream uses a trait with an associated type returned by the selector. MoonBit traits do not support associated types, so we use a concrete carrier struct for the selected font.

SelectedFont::SelectedFont

source

fn SelectedFont::SelectedFont(font : @Milky2018/moon_swash.FontRef
FontRef) -> SelectedFont

Creates a selected font wrapper.

SelectedFont::font

source

fn SelectedFont::font(self : SelectedFont) -> @Milky2018/moon_swash.FontRef
FontRef

Returns the underlying font.

SelectedFont::id_override

source

fn SelectedFont::id_override(self : SelectedFont) -> (UInt64, UInt64)?

Returns an optional override for cache identifier (id0, id1).

SelectedFont::synthesis

source

fn SelectedFont::synthesis(self : SelectedFont) -> @Milky2018/moon_swash.Synthesis
Synthesis?

Returns an optional synthesis state for the font.

SelectedFont::with_id_override

source

fn SelectedFont::with_id_override(self : SelectedFont, id : (UInt64, UInt64)) -> SelectedFont

Returns a copy with an explicit cache id override.

SelectedFont::with_synthesis

source

fn SelectedFont::with_synthesis(self : SelectedFont, syn : @Milky2018/moon_swash.Synthesis
Synthesis) -> SelectedFont

Returns a copy with a synthesis state attached.

ShapeContext

source

pub struct ShapeContext {
  inner : @moonbitlang/core/ref.Ref
Ref[ContextState]
}

Context that manages transient buffers for shaping.

This is intentionally minimal for ro7.1: caches and engines are introduced in later shaping tasks.

ShapeContext::ShapeContext

source

fn ShapeContext::ShapeContext() -> ShapeContext

Creates a new shaping context.

ShapeContext::builder

source

fn ShapeContext::builder(self : ShapeContext, font : @Milky2018/moon_swash.FontRef
FontRef) -> ShaperBuilder

Creates a new builder for constructing a shaper with this context.

ShapeContext::builder_with_id

source

fn ShapeContext::builder_with_id(self : ShapeContext, font : @Milky2018/moon_swash.FontRef
FontRef, id : (UInt64, UInt64)) -> ShaperBuilder

Creates a new builder for constructing a shaper with this context.

ShapeContext::with_max_entries

source

fn ShapeContext::with_max_entries(max_entries : Int) -> ShapeContext

Creates a new shaping context with the specified maximum number of cache entries.

Shaper

source

pub struct Shaper {
  cx : @moonbitlang/core/ref.Ref
Ref[ContextState]
  font : @Milky2018/moon_swash.FontRef
FontRef
  id0 : UInt64
  id1 : UInt64
  font_entry : @moonbitlang/core/ref.Ref
Ref[FontEntry]
  charmap : @Milky2018/moon_swash.Charmap
Charmap
  size : Double
  script : @Milky2018/moon_swash.Script
Script
  language : @Milky2018/moon_swash.Language
Language?
  direction : Direction
  retain_ignorables : Bool
  joined : Bool
  engine : Engine
  store : @moonbitlang/core/ref.Ref
Ref[FeatureStore]?
  sub_mask : FeatureMask
  pos_mask : FeatureMask
}

Maps character clusters to (eventually) positioned glyph clusters.

In ro7.1 this shaper only collects clusters into the underlying Buffer.

Shaper::add_cluster

source

fn Shaper::add_cluster(self : Shaper, cluster : @Milky2018/moon_swash.CharCluster
CharCluster) -> Unit

Adds a character cluster to the shaper.

Shaper::add_str

source

fn Shaper::add_str(self : Shaper, s : String) -> Unit

Adds a string to the shaper.

Shaper::metrics

source

fn Shaper::metrics(self : Shaper) -> @Milky2018/moon_swash.Metrics
Metrics

Returns the current font metrics in use by the shaper.

Shaper::normalized_coords

source

fn Shaper::normalized_coords(self : Shaper) -> ArrayView[Int]

Returns the current normalized variation coordinates in use by the shaper.

Shaper::shape_with

source

fn Shaper::shape_with(self : Shaper, f : (GlyphCluster) -> Unit) -> Unit

Shapes the text and invokes the specified closure with each resulting glyph cluster.

ShaperBuilder

source

pub struct ShaperBuilder {
  cx : @moonbitlang/core/ref.Ref
Ref[ContextState]
  font : @Milky2018/moon_swash.FontRef
FontRef
  id0 : UInt64
  id1 : UInt64
  size : Double
  script : @Milky2018/moon_swash.Script
Script
  language : @Milky2018/moon_swash.Language
Language?
  direction : Direction
  font_entry : @moonbitlang/core/ref.Ref
Ref[FontEntry]
  charmap : @Milky2018/moon_swash.Charmap
Charmap
  dotted_circle : UInt16?
  retain_ignorables : Bool
}

Builder for configuring a shaper.

ShaperBuilder::build

source

fn ShaperBuilder::build(self : ShaperBuilder) -> Shaper

Builds a shaper for the current configuration.

ShaperBuilder::direction

source

fn ShaperBuilder::direction(self : ShaperBuilder, direction : Direction) -> ShaperBuilder

Specifies the text direction. The default value is Direction::LeftToRight.

ShaperBuilder::features

source

fn ShaperBuilder::features(self : ShaperBuilder, settings : Iter[@Milky2018/moon_swash.Setting
Setting[UInt16]]) -> ShaperBuilder

Adds feature settings to the shaper.

ShaperBuilder::insert_dotted_circles

source

fn ShaperBuilder::insert_dotted_circles(self : ShaperBuilder, yes : Bool) -> ShaperBuilder

Specifies whether to insert dotted circles for broken clusters. The default value is false.

ShaperBuilder::language

source

fn ShaperBuilder::language(self : ShaperBuilder, language : @Milky2018/moon_swash.Language
Language?) -> ShaperBuilder

Specifies the language. The default value is None.

ShaperBuilder::retain_ignorables

source

fn ShaperBuilder::retain_ignorables(self : ShaperBuilder, yes : Bool) -> ShaperBuilder

Specifies whether characters defined as default ignorable should be retained by the shaper. The default is false.

ShaperBuilder::script

source

fn ShaperBuilder::script(self : ShaperBuilder, script : @Milky2018/moon_swash.Script
Script) -> ShaperBuilder

Specifies the script. The default value is Script::Latin.

ShaperBuilder::size

source

fn ShaperBuilder::size(self : ShaperBuilder, ppem : Double) -> ShaperBuilder

Specifies the font size in pixels per em. The default value is 0 which will produce glyphs with offsets and advances in font units.

ShaperBuilder::variations

source

fn ShaperBuilder::variations(self : ShaperBuilder, settings : Iter[@Milky2018/moon_swash.Setting
Setting[Double]]) -> ShaperBuilder

Adds variation settings to the shaper.

SimpleShapeOptions

source

pub struct SimpleShapeOptions {
  script : @Milky2018/moon_swash.Script
Script
  language : @Milky2018/moon_swash.Language
Language?
  direction : Direction
  size : Double
  features : Array[@Milky2018/moon_swash.Setting
Setting[UInt16]]
  variations : Array[@Milky2018/moon_swash.Setting
Setting[Double]]
  insert_dotted_circles : Bool
}

Simple implementation of the shape options trait.

impl ShapeOptions for SimpleShapeOptions

fn direction(self : SimpleShapeOptions) -> Direction

source

fn features(self : SimpleShapeOptions) -> Iter[@Milky2018/moon_swash.Setting
Setting[UInt16]]

source

fn insert_dotted_circles(self : SimpleShapeOptions) -> Bool

source

fn language(self : SimpleShapeOptions) -> @Milky2018/moon_swash.Language
Language?

source

fn script(self : SimpleShapeOptions) -> @Milky2018/moon_swash.Script
Script

source

fn size(self : SimpleShapeOptions) -> Double

source

fn variations(self : SimpleShapeOptions) -> Iter[@Milky2018/moon_swash.Setting
Setting[Double]]

source

SimpleShapeOptions::default

source

fn SimpleShapeOptions::default() -> SimpleShapeOptions

SimpleShapeOptions::direction

source

fn SimpleShapeOptions::direction(self : SimpleShapeOptions) -> Direction

SimpleShapeOptions::features

source

fn SimpleShapeOptions::features(self : SimpleShapeOptions) -> Iter[@Milky2018/moon_swash.Setting
Setting[UInt16]]

SimpleShapeOptions::insert_dotted_circles

source

fn SimpleShapeOptions::insert_dotted_circles(self : SimpleShapeOptions) -> Bool

SimpleShapeOptions::language

source

fn SimpleShapeOptions::language(self : SimpleShapeOptions) -> @Milky2018/moon_swash.Language
Language?

SimpleShapeOptions::script

source

fn SimpleShapeOptions::script(self : SimpleShapeOptions) -> @Milky2018/moon_swash.Script
Script

SimpleShapeOptions::size

source

fn SimpleShapeOptions::size(self : SimpleShapeOptions) -> Double

SimpleShapeOptions::variations

source

fn SimpleShapeOptions::variations(self : SimpleShapeOptions) -> Iter[@Milky2018/moon_swash.Setting
Setting[Double]]

SkipState

source

pub struct SkipState {
  flags : Byte
  mask : Byte
  mark_check : Byte
  mark_class : Byte
  mark_set : UInt
}

SkipState::default

source

fn SkipState::default() -> SkipState

StageOffsets

source

pub struct StageOffsets {
  base : UInt
  lang : UInt
  vars : UInt
}

Offsets for a particular layout stage.

StageOffsets::default

source

fn StageOffsets::default() -> StageOffsets

StageOffsets::from_layout

source

fn StageOffsets::from_layout(data : Bytes, base : UInt, script : UInt, language : UInt?) -> (StageOffsets, (UInt, UInt))?

Storage

source

pub struct Storage {
  stack : Array[LookupState]
  ids : Array[UInt16]
  indices : Array[Int]
}

Scratch storage used by the OT lookup application engine.

Storage::default

source

fn Storage::default() -> Storage

SubMode

source

pub(all) enum SubMode {
  None
  Gsub
  Morx
}

impl Eq for SubMode

SubMode::equal

source

fn SubMode::equal(self : SubMode, other : SubMode) -> Bool

SubMode::not_equal

source

fn SubMode::not_equal(x : SubMode, y : SubMode) -> Bool

COMPONENT

source

let COMPONENT : UInt16

CURSIVE_ATTACH

source

let CURSIVE_ATTACH : UInt16

IGNORABLE

source

let IGNORABLE : UInt16

LIGATED

source

let LIGATED : UInt16

MARK_ATTACH

source

let MARK_ATTACH : UInt16

MAX_CLUSTER_SIZE

source

let MAX_CLUSTER_SIZE : Int

SUBSTITUTED

source

let SUBSTITUTED : UInt16

Glyph flags.

apply

source

fn apply(stage : Byte, data : Bytes, base : UInt, coords : ArrayView[Int], gdef : @Milky2018/moon_swash/internal.Gdef
Gdef, storage : Storage, store : FeatureStore, feature_mask : FeatureMask, buffer : Buffer, buffer_range : IndexRange?) -> Bool?

Applies lookups for either substitutions (stage=0) or positioning (stage=1).

This is ported from upstream swash/src/shape/at.rs (apply) and is completed as part of ro7.2.3.

apply_kern

source

fn apply_kern(data : Bytes, kern : UInt, buffer : Buffer) -> Unit

apply_kerx

source

fn apply_kerx(data : Bytes, kerx : UInt, ankr : UInt, buffer : Buffer, disable_kern : Bool) -> Unit

apply_morx

source

fn apply_morx(data : Bytes, morx : UInt, buffer : Buffer, selectors : ArrayView[(UInt16, UInt16)]) -> Unit

feature_bit_to_mask

source

fn feature_bit_to_mask(bit : UInt16?) -> FeatureMask

reorder_complex

source

fn reorder_complex(glyphs : Array[GlyphData], buf : Array[GlyphData], order : Array[Int]) -> Unit

reorder_myanmar

source

fn reorder_myanmar(chars : ArrayView[@Milky2018/moon_swash.ClusterChar
ClusterChar], order : Array[Int]) -> Unit

shape

source

fn[S : Selector, O : ShapeOptions] shape(context : ShapeContext, selector : S, options : O, tokens : Iter[@Milky2018/moon_swash.Token
Token], f : (SelectedFont, Shaper) -> Unit) -> Unit

Shapes a run of text (provided as a Token iterator) using the specified selector to assign per-cluster fonts.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#CharCluster

#ClusterChar

#ClusterInfo

#Epoch

#FeatureBit

#GlyphId

#JoiningType

#ShapeClass

#SourceRange

#Tag

#UserData

#Selector

#ShapeOptions

#Buffer

#Buffer::Buffer

#Buffer::_push_hangul

#Buffer::clear

#Buffer::clear_flags

#Buffer::default

#Buffer::ensure_order

#Buffer::glyphs

#Buffer::len

#Buffer::multiply

#Buffer::position

#Buffer::position_cursive

#Buffer::position_mark

#Buffer::positions

#Buffer::push

#Buffer::push_order

#Buffer::ranges

#Buffer::set_join_masks

#Buffer::setup_positions

#Buffer::substitute

#Buffer::substitute_ligature

#Buffer::substitute_multiple

#ContextState

#CoverageBuilder

#Direction

#Direction::equal

#Direction::not_equal

#Engine

#Engine::Engine

#Engine::collect_features

#Engine::collect_selectors

#Engine::gpos

#Engine::gsub

#Engine::has_feature_vars

#Engine::kern

#Engine::kerx

#Engine::morx

#Engine::set_classes

#Engine::tags

#EngineMetadata

#EngineMetadata::from_font

#EngineMode

#EngineMode::equal

#EngineMode::not_equal

#FeatureGroups

#FeatureGroups::default

#FeatureMask

#FeatureMask::clear

#FeatureMask::default

#FeatureMask::has

#FeatureMask::is_empty

#FeatureMask::or

#FeatureMask::or_assign

#FeatureMask::set

#FeatureStore

#FeatureStore::clear

#FeatureStore::custom_masks

#FeatureStore::default

#FeatureStore::groups

#FeatureStore::pos_bit

#FeatureStore::sub_bit

#FeatureStoreBuilder

#FeatureStoreBuilder::build

#FeatureStoreBuilder::default

#FontEntry

#FontEntry::FontEntry

#Glyph

CharCluster

ClusterChar

ClusterInfo

Epoch

FeatureBit

GlyphId

JoiningType

ShapeClass

SourceRange

Tag

UserData

Selector

ShapeOptions

Buffer

Buffer::Buffer

Buffer::_push_hangul

Buffer::clear

Buffer::clear_flags

Buffer::default

Buffer::ensure_order

Buffer::glyphs

Buffer::len

Buffer::multiply

Buffer::position

Buffer::position_cursive

Buffer::position_mark

Buffer::positions

Buffer::push

Buffer::push_order

Buffer::ranges

Buffer::set_join_masks

Buffer::setup_positions

Buffer::substitute

Buffer::substitute_ligature

Buffer::substitute_multiple

ContextState

CoverageBuilder

Direction

Direction::equal

Direction::not_equal

Engine

Engine::Engine

Engine::collect_features

Engine::collect_selectors

Engine::gpos

Engine::gsub

Engine::has_feature_vars

Engine::kern

Engine::kerx

Engine::morx

Engine::set_classes

Engine::tags

EngineMetadata

EngineMetadata::from_font

EngineMode

EngineMode::equal

EngineMode::not_equal

FeatureGroups

FeatureGroups::default

FeatureMask

FeatureMask::clear

FeatureMask::default

FeatureMask::has

FeatureMask::is_empty

FeatureMask::or

FeatureMask::or_assign

FeatureMask::set

FeatureStore

FeatureStore::clear

FeatureStore::custom_masks

FeatureStore::default

FeatureStore::groups

FeatureStore::pos_bit

FeatureStore::sub_bit

FeatureStoreBuilder

FeatureStoreBuilder::build

FeatureStoreBuilder::default

FontEntry

FontEntry::FontEntry

Glyph