README
E
BidiError
- ::is_explicitBidiClass::is_explicit
- ::is_isolate_initiatorBidiClass::is_isolate_initiator
- ::is_neutralBidiClass::is_neutral
- ::is_neutral_or_isolateBidiClass::is_neutral_or_isolate
- ::is_strongBidiClass::is_strong
- ::is_strong_rtlBidiClass::is_strong_rtl
- ::is_weakBidiClass::is_weak
- ::is_x9_removedBidiClass::is_x9_removed
T
BidiParagraph
- ::levelDirection::level
V
bidi_class
V
detect_direction
V
direction_from_level
V
get_mirrored
V
process
V
process_with_base_level
V
process_with_direction
V
reorder
V
reorder_string
V
requires_bidi

bidi

Unicode Bidirectional Algorithm for MoonBit

unicode

bidi

uax9

rtl

Download zip

Author

moonbit-community

Version

0.5.0

License

Apache-2.0

Repository

github.com/moonbit-community/tonyfettes-unicode

Last updated

27 days ago

Downloads

#bidi

Unicode Bidirectional Algorithm implementation for MoonBit, targeting UAX #9 and Unicode 16.0.0.

moon add moonbit-community/bidi

See the repository root README for API documentation and examples.

BidiError

source

pub(all) suberror BidiError {
  InvalidIsolate(String)
  StackOverflow
}

Error types for Bidi processing

BidiClass

source

pub(all) enum BidiClass {
  L
  R
  AL
  EN
  ES
  ET
  AN
  CS
  NSM
  BN
  B
  S
  WS
  ON
  LRE
  LRO
  RLE
  RLO
  PDF
  LRI
  RLI
  FSI
  PDI
} derive(Eq)

All 23 Bidi_Class values from UAX #9

impl Show for BidiClass

BidiClass::is_explicit

source

fn BidiClass::is_explicit(self : BidiClass) -> Bool

BidiClass::is_isolate_initiator

source

fn BidiClass::is_isolate_initiator(self : BidiClass) -> Bool

BidiClass::is_neutral

source

fn BidiClass::is_neutral(self : BidiClass) -> Bool

BidiClass::is_neutral_or_isolate

source

fn BidiClass::is_neutral_or_isolate(self : BidiClass) -> Bool

BidiClass::is_strong

source

fn BidiClass::is_strong(self : BidiClass) -> Bool

BidiClass::is_strong_rtl

source

fn BidiClass::is_strong_rtl(self : BidiClass) -> Bool

BidiClass::is_weak

source

fn BidiClass::is_weak(self : BidiClass) -> Bool

BidiClass::is_x9_removed

source

fn BidiClass::is_x9_removed(self : BidiClass) -> Bool

BidiParagraph

source

pub(all) struct BidiParagraph {
  chars : Array[Char]
  original_classes : Array[BidiClass]
  resolved_classes : Array[BidiClass]
  levels : Array[Int]
  base_level : Int
}

Result of bidi processing - a paragraph with resolved levels

Direction

source

pub(all) enum Direction {
  LTR
  RTL
} derive(Eq)

Direction of text

impl Show for Direction

Direction::level

source

fn Direction::level(self : Direction) -> Int

Get embedding level for direction

bidi_class

source

fn bidi_class(c : Char) -> BidiClass

Look up Bidi_Class for a character

detect_direction

source

fn detect_direction(text : String) -> Direction

Detect the base direction of text (P2-P3) Returns the direction of the first strong character, or LTR if no strong character is found

direction_from_level

source

fn direction_from_level(level : Int) -> Direction

Get direction from embedding level

get_mirrored

source

fn get_mirrored(c : Char, level : Int) -> Char

Get the mirrored glyph for a character if in RTL context

process

source

fn process(text : String, direction? : Direction) -> BidiParagraph

Process text according to the Unicode Bidirectional Algorithm If direction is omitted, infer it from the first strong character. Returns a BidiParagraph with resolved embedding levels for each character

process_with_base_level

source

#deprecated("Use process(text, direction=LTR or RTL) instead")
fn process_with_base_level(text : String, base_level : Int) -> BidiParagraph

Process text with explicit base level

process_with_direction

source

#deprecated("Use process(text, direction=direction) instead")
fn process_with_direction(text : String, direction : Direction) -> BidiParagraph

Process text with explicit base direction Use when the paragraph direction is known externally

reorder

source

fn reorder(para : BidiParagraph) -> Array[Int]

Reorder text for display according to resolved levels Returns array of character indices in visual order X9-removed characters (LRE, RLE, LRO, RLO, PDF, BN) are excluded

reorder_string

source

fn reorder_string(para : BidiParagraph) -> String

Reorder text and return the visually-ordered string

requires_bidi

source

fn requires_bidi(text : String) -> Bool

Check if text requires bidi processing Returns false for pure LTR text (optimization)

Source Files

Site source Report issue Packages Build queue Skills Statistics

bidi

#bidi

#BidiError

#BidiClass

#BidiClass::is_explicit

#BidiClass::is_isolate_initiator

#BidiClass::is_neutral

#BidiClass::is_neutral_or_isolate

#BidiClass::is_strong

#BidiClass::is_strong_rtl

#BidiClass::is_weak

#BidiClass::is_x9_removed

#BidiParagraph

#Direction

#Direction::level

#bidi_class

#detect_direction

#direction_from_level

#get_mirrored

#process

#process_with_base_level

#process_with_direction

#reorder

#reorder_string

#requires_bidi

Source Files

BidiError

BidiClass

BidiClass::is_explicit

BidiClass::is_isolate_initiator

BidiClass::is_neutral

BidiClass::is_neutral_or_isolate

BidiClass::is_strong

BidiClass::is_strong_rtl

BidiClass::is_weak

BidiClass::is_x9_removed

BidiParagraph

Direction

Direction::level

bidi_class

detect_direction

direction_from_level

get_mirrored

process

process_with_base_level

process_with_direction

reorder

reorder_string

requires_bidi