UnicodeVersion is the Unicode version from which the tables in this package are derived.
const UnicodeVersion = "15.0.0"
func AppendReverse(out, in []byte) []byte
AppendReverse reverses the order of characters of in, appends them to out, and returns the result. Modifiers will still follow the runes they modify. Brackets are replaced with their counterparts.
func ReverseString(s string) string
ReverseString reverses the order of characters in s and returns a new string. Modifiers will still follow the runes they modify. Brackets are replaced with their counterparts.
Class is the Unicode BiDi class. Each rune has a single class.
type Class uint
const (
L Class = iota // LeftToRight
R // RightToLeft
EN // EuropeanNumber
ES // EuropeanSeparator
ET // EuropeanTerminator
AN // ArabicNumber
CS // CommonSeparator
B // ParagraphSeparator
S // SegmentSeparator
WS // WhiteSpace
ON // OtherNeutral
BN // BoundaryNeutral
NSM // NonspacingMark
AL // ArabicLetter
Control // Control LRO - PDI
LRO // LeftToRightOverride
RLO // RightToLeftOverride
LRE // LeftToRightEmbedding
RLE // RightToLeftEmbedding
PDF // PopDirectionalFormat
LRI // LeftToRightIsolate
RLI // RightToLeftIsolate
FSI // FirstStrongIsolate
PDI // PopDirectionalIsolate
)
A Direction indicates the overall flow of text.
type Direction int
const (
// LeftToRight indicates the text contains no right-to-left characters and
// that either there are some left-to-right characters or the option
// DefaultDirection(LeftToRight) was passed.
LeftToRight Direction = iota
// RightToLeft indicates the text contains no left-to-right characters and
// that either there are some right-to-left characters or the option
// DefaultDirection(RightToLeft) was passed.
RightToLeft
// Mixed indicates text contains both left-to-right and right-to-left
// characters.
Mixed
// Neutral means that text contains no left-to-right and right-to-left
// characters and that no default direction has been set.
Neutral
)
An Option is an option for Bidi processing.
type Option func(*options)
func DefaultDirection(d Direction) Option
DefaultDirection sets the default direction for a Paragraph. The direction is overridden if the text contains directional characters.
An Ordering holds the computed visual order of runs of a Paragraph. Calling SetBytes or SetString on the originating Paragraph invalidates an Ordering. The methods of an Ordering should only be called by one goroutine at a time.
type Ordering struct {
// contains filtered or unexported fields
}
func (o *Ordering) Direction() Direction
Direction reports the directionality of the runs.
The direction may be LeftToRight, RightToLeft, Mixed, or Neutral.
func (o *Ordering) NumRuns() int
NumRuns returns the number of runs.
func (o *Ordering) Run(i int) Run
Run returns the ith run within the ordering.
A Paragraph holds a single Paragraph for Bidi processing.
type Paragraph struct {
// contains filtered or unexported fields
}
func (p *Paragraph) Direction() Direction
Direction returns the direction of the text of this paragraph.
The direction may be LeftToRight, RightToLeft, Mixed, or Neutral.
func (p *Paragraph) IsLeftToRight() bool
IsLeftToRight reports whether the principle direction of rendering for this paragraphs is left-to-right. If this returns false, the principle direction of rendering is right-to-left.
func (p *Paragraph) Line(start, end int) (Ordering, error)
Line computes the visual ordering of runs for a single line starting and ending at the given positions in the original text.
func (p *Paragraph) Order() (Ordering, error)
Order computes the visual ordering of all the runs in a Paragraph.
func (p *Paragraph) RunAt(pos int) Run
RunAt reports the Run at the given position of the input text.
This method can be used for computing line breaks on paragraphs.
func (p *Paragraph) SetBytes(b []byte, opts ...Option) (n int, err error)
SetBytes configures p for the given paragraph text. It replaces text previously set by SetBytes or SetString. If b contains a paragraph separator it will only process the first paragraph and report the number of bytes consumed from b including this separator. Error may be non-nil if options are given.
func (p *Paragraph) SetString(s string, opts ...Option) (n int, err error)
SetString configures s for the given paragraph text. It replaces text previously set by SetBytes or SetString. If s contains a paragraph separator it will only process the first paragraph and report the number of bytes consumed from s including this separator. Error may be non-nil if options are given.
Properties provides access to BiDi properties of runes.
type Properties struct {
// contains filtered or unexported fields
}
func Lookup(s []byte) (p Properties, sz int)
Lookup returns properties for the first rune in s and the width in bytes of its encoding. The size will be 0 if s does not hold enough bytes to complete the encoding.
func LookupRune(r rune) (p Properties, size int)
LookupRune returns properties for r.
func LookupString(s string) (p Properties, sz int)
LookupString returns properties for the first rune in s and the width in bytes of its encoding. The size will be 0 if s does not hold enough bytes to complete the encoding.
func (p Properties) Class() Class
Class returns the Bidi class for p.
func (p Properties) IsBracket() bool
IsBracket reports whether the rune is a bracket.
func (p Properties) IsOpeningBracket() bool
IsOpeningBracket reports whether the rune is an opening bracket. IsBracket must return true.
A Run is a continuous sequence of characters of a single direction.
type Run struct {
// contains filtered or unexported fields
}
func (r *Run) Bytes() []byte
Bytes returns the text of the run in its original order.
func (r *Run) Direction() Direction
Direction reports the direction of the run.
func (r *Run) Pos() (start, end int)
Pos returns the position of the Run within the text passed to SetBytes or SetString of the originating Paragraph value.
func (r *Run) String() string
String returns the text of the run in its original order.