ShiChengxu/moonlayout/layout

ShiChengxu/moonlayout/layout does not have a README file

Alignment

using @ShiChengxu/moonlayout/align { type Alignment }

Horizontal alignment in monospace display columns.

BreakKind

source

using @ShiChengxu/moonlayout/wrap { type BreakKind }

Reason a line ended. Forced is an emergency grapheme boundary; End is EOF.

BreakPolicy

source

using @ShiChengxu/moonlayout/wrap { type BreakPolicy }

Preferred boundaries. Word/Sentence intersect UAX #14; Grapheme allows every grapheme boundary. Emergency splitting still applies when a unit is too long.

Line

source

using @ShiChengxu/moonlayout/wrap { type Line }

Exact source range [start,end) in UTF-8 bytes, with a lossless source copy. text is trimmed/expanded content; aligned_text is the final display string. width measures aligned_text. Wrapping initially sets aligned_text = text.

OptimalOptions

source

using @ShiChengxu/moonlayout/wrap { type OptimalOptions }

Per internal ASCII space: maximum added cells (stretch) and removed cells (shrink, capped at one). Negative settings become zero. Penalties are capped to keep costs finite. This is a simplified paragraph optimizer, not TeX.

WrapAlgorithm

source

using @ShiChengxu/moonlayout/wrap { type WrapAlgorithm }

Greedy fills each line; Optimal minimizes paragraph badness.

LayoutStyle

source

pub(all) struct LayoutStyle {
  max_width : Int
  alignment : @ShiChengxu/moonlayout/align.Alignment
Alignment
  ambiguous_wide : Bool
  wrap_algorithm : @ShiChengxu/moonlayout/wrap.WrapAlgorithm
WrapAlgorithm
  break_policy : @ShiChengxu/moonlayout/wrap.BreakPolicy
BreakPolicy
  tab_width : Int
  optimal : @ShiChengxu/moonlayout/wrap.OptimalOptions
OptimalOptions
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Logical paragraph layout configuration. Optional integrations live in their own package.

LayoutStyle::equal

source

fn LayoutStyle::equal(LayoutStyle, LayoutStyle) -> Bool

LayoutStyle::new

source

fn LayoutStyle::new(max_width : Int, alignment? : @ShiChengxu/moonlayout/align.Alignment
Alignment, ambiguous_wide? : Bool, wrap_algorithm? : @ShiChengxu/moonlayout/wrap.WrapAlgorithm
WrapAlgorithm, break_policy? : @ShiChengxu/moonlayout/wrap.BreakPolicy
BreakPolicy, tab_width? : Int, optimal? : @ShiChengxu/moonlayout/wrap.OptimalOptions
OptimalOptions) -> LayoutStyle

Construct a layout style (greedy by default). Nonpositive widths normalize to one column.

LayoutStyle::not_equal

source

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

LayoutStyle::to_repr

source

fn LayoutStyle::to_repr(LayoutStyle) -> @moonbitlang/core/debug.Repr
Repr

layout

source

fn layout(text : String, style : LayoutStyle) -> Array[@ShiChengxu/moonlayout/wrap.Line
Line]

Layout a logical paragraph into lines with source ranges and aligned text.

layout_hyphenated

source

fn[H : @ShiChengxu/moonlayout/hyphen.Hyphenator
Hyphenator] layout_hyphenated(text : String, style : LayoutStyle, hyphenator : H) -> Array[@ShiChengxu/moonlayout/wrap.Line
Line]