Struct tengwar::characters::glyph::Glyph

pub struct Glyph<P: Policy = Standard> {

    pub base: Option<char>,
    pub tehta: Option<Tehta>,
    pub tehta_alt: bool,
    pub tehta_first: bool,
    pub tehta_hidden: bool,
    pub vowels: VowelStyle,
    pub rince: bool,
    pub rince_final: bool,
    pub nasal: bool,
    pub labial: bool,
    pub palatal: bool,
    pub nuquerna: bool,
    pub long_cons: bool,
    pub dot_inner: bool,
    pub dot_under: bool,
    pub ligate_short: bool,
    pub ligate_zwj: u8,
    pub _p: PhantomData<P>,
}

A single base tengwa, and all of its modifications. This includes the tehta marking, flags for additional diacritics, flags for consonant and vowel length, and information on vowel and ligature behavior.

Fields

base: Option<char>

A base character.

tehta: Option<Tehta>

The primary diacritical marking over the base character.

tehta_alt: bool

Indicates whether the Tehta should use its alternate “long” form.

tehta_first: bool

Indicates whether a tehta with an extended carrier should be printed before the glyph.

tehta_hidden: bool

vowels: VowelStyle

The pattern of behavior followed by the tehta, if there is one.

rince: bool

Indicates whether the glyph has a sa-rincë attached.

rince_final: bool

Indicates whether the glyph may use a more ornate rincë. This will have no effect if rince is not true.

nasal: bool

A nasalized consonant is typically represented by an overbar.

labial: bool

A labialized consonant is represented by an additional diacritic.

palatal: bool

A palatalized vowel is represented by an additional diacritic.

nuquerna: bool

Try to use a “nuquerna” variant of the base character.

long_cons: bool

A lengthened consonant is typically represented by an underbar.

dot_inner: bool

Indicates whether a dot should be placed inside the base character. This is occasionally used, when vowel tehtar may be elided, to indicate the explicit lack of a vowel.

dot_under: bool

Indicates whether a dot should be placed below the base character. This is used in many English modes to indicate a “silent” E.

ligate_short: bool

Indicates that this glyph should use the ligating short carrier, if it is applicable.

ligate_zwj: u8

Indicates whether this glyph should try to use ZWJ ligation.

_p: PhantomData<P>

Phantom field to carry the Policy parameter.

Implementations

impl<P: Policy> Glyph<P>

Public: Construction and modification.

pub const fn new() -> Self

Define a new empty glyph.

pub const fn new_both(base: char, tehta: Tehta) -> Self

Define a glyph with both a base char and a Tehta.

pub const fn new_base(base: char) -> Self

Define a glyph with only a base char.

pub const fn new_tehta(tehta: Tehta) -> Self

Define a glyph with only a Tehta.

pub const fn new_tehta_alt(tehta: Tehta) -> Self

Define a glyph with only an alternate Tehta.

pub const fn new_vowel(tehta: Tehta, alt: bool) -> Self

Define a glyph with only a Tehta. It may be marked as Alternate.

pub const fn change_policy<Q: Policy>(&self) -> Glyph<Q>

Switch the glyph to use a different Policy implementor.

pub const fn with_tengwa(self, tengwa: char) -> Self

Change the base char.

pub const fn with_tehta(self, tehta: Tehta) -> Self

Change the Tehta to be used.

pub const fn with_tehta_alt(self, enabled: bool) -> Self

Mark this glyph as using the alternate form of its Tehta.

pub const fn with_underline(self, enabled: bool) -> Self

Mark this glyph as being underlined.

pub const fn with_labial(self, enabled: bool) -> Self

Mark this glyph as being labialized. It will be rendered with a wavy overbar.

pub const fn with_nasal(self, enabled: bool) -> Self

Mark this glyph as being nasalized. It will be rendered overlined.

pub const fn with_palatal(self, enabled: bool) -> Self

Mark this glyph as being palatalized. It will be rendered with a pair of dots below it.

pub const fn with_rince(self, enabled: bool) -> Self

Mark this glyph as being followed by a sibilant. It may be rendered with a flourish.

pub fn integrate_consonant(&mut self, other: Self)

Update this glyph with the consonant attributes of another glyph.

pub fn integrate_vowel(&mut self, other: Self)

Update this glyph with the vowel attributes of another glyph.

pub fn replace_base(&mut self, old: char, new: char) -> bool

If the base char matches a specific value, change it to another.

pub fn replace_tehta(&mut self, old: Tehta, new: Tehta) -> bool

If the Tehta matches a specific value, change it to another.

pub fn set_alt_a(&mut self) -> bool

Switch the A-tehta to its alternate form.

impl<P: Policy> Glyph<P>

Public: Information and logic.

pub fn base_nuq(&self) -> char

Determine the base character to be used for this glyph. If one is not set, an appropriate “carrier” mark will be returned instead.

pub const fn base(&self) -> char

Determine the base character to be used for this glyph. If one is not set, an appropriate “carrier” mark will be returned instead.

This method does not apply a Nuquerna variant.

pub const fn tengwa(&self) -> Option<Tengwa<'static>>

Return a Tengwa representing the base char, if there is one.

pub fn parts(&self) -> Parts<'static>

Return Parts representing the final visual composition of the glyph.

pub fn can_take_rince(&self) -> bool

Determine whether a rincë may be added to this glyph. Returns false if a rincë is already set.

pub fn ignoring_nuquerna(&self) -> bool

Determine whether the base character has a nuquerna variant, but is set to not use it.

pub const fn is_empty(&self) -> bool

Determine whether is glyph has no basic forms at all.

pub const fn is_short_carrier(&self) -> bool

Determine whether this glyph will use Telco as its base.

pub fn ligates_with<Q: Policy>(&self, other: &Glyph<Q>) -> bool

Determine whether the base char of this glyph is permitted to ligate with another glyph using a zero-width joiner.

pub fn ligates_with_ara(&self) -> bool

Determine whether the base char of this glyph is permitted to ligate with Ára using a zero-width joiner.

pub fn telco_ligates(&self) -> bool

Determine whether Telco is permitted to ligate with the base char of this glyph using a zero-width joiner.

pub fn choose_rince(&self) -> Rince

Choose the correct form of Sa-Rincë.

pub fn carries_tehta(&self) -> bool

pub fn tehta_char(&self) -> Option<TehtaChar>

Resolve the position and identity of the tehta.

pub fn tehta_is_a(&self) -> bool

Return true if the glyph carries the A-tehta.

Trait Implementations

impl<P: Clone + Policy> Clone for Glyph<P>

fn clone(&self) -> Glyph<P>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: Debug + Policy> Debug for Glyph<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: Default + Policy> Default for Glyph<P>

fn default() -> Glyph<P>

Returns the “default value” for a type.

impl<P: Policy> Display for Glyph<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: Policy> From<Tehta> for Glyph<P>

fn from(tehta: Tehta) -> Self

Converts to this type from the input type.

impl<P: Policy> From<Tengwa<'_>> for Glyph<P>

fn from(tengwa: Tengwa<'_>) -> Self

Converts to this type from the input type.

impl<P: Policy> From<char> for Glyph<P>

fn from(cons: char) -> Self

Converts to this type from the input type.

impl<P: Copy + Policy> Copy for Glyph<P>