package unicodedata

Import Path
	github.com/go-text/typesetting/internal/unicodedata (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	    combining_classes.go
	    decomposition.go
	    east_asian_width.go
	    emojis.go
	    general_category.go
	    grapheme_break.go
	    indic_conjunct_break.go
	    line_break.go
	    mirroring.go
	  d unicode.go
		Package unicodedata provides additional lookup functions for unicode
		properties, not covered by the standard package unicode.

	    vertical_orientation.go
	    word_break.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type GeneralCategory uint8 (basic type)
		GeneralCategory is an enum storing the Unicode General Category of a rune.

		Methods (total 2)
			( GeneralCategory) IsLetter() bool
				IsLetter returns true for Lowercase_Letter, Modifier_Letter, Other_Letter, Titlecase_Letter, Uppercase_Letter

			( GeneralCategory) IsMark() bool
				IsMark returns true for Spacing_Mark, Enclosing_Mark, Nonspacing_Mark

		As Outputs Of (at least one exported)
			func LookupGeneralCategory(r rune) GeneralCategory
		As Types Of (total 30)
			const Cc
			const Cf
			const Co
			const Cs
			const Ll
			const Lm
			const Lo
			const Lt
			const Lu
			const Mc
			const Me
			const Mn
			const Nd
			const Nl
			const No
			const Pc
			const Pd
			const Pe
			const Pf
			const Pi
			const Po
			const Ps
			const Sc
			const Sk
			const Sm
			const So
			const Unassigned
			const Zl
			const Zp
			const Zs

	 type GraphemeBreak uint16 (basic type)
		GraphemeBreak is a flag storing the Unicode Grapheme Cluster Break Property.
		
		See https://unicode.org/reports/tr29/#Grapheme_Cluster_Break_Property_Values

		As Outputs Of (at least one exported)
			func LookupGraphemeBreak(ch rune) GraphemeBreak
		As Types Of (total 13)
			const GB_Control
			const GB_CR
			const GB_Extend
			const GB_L
			const GB_LF
			const GB_LV
			const GB_LVT
			const GB_Prepend
			const GB_Regional_Indicator
			const GB_SpacingMark
			const GB_T
			const GB_V
			const GB_ZWJ

	 type IndicConjunctBreak uint8 (basic type)
		IndicConjunctBreak is a flag storing the Indic_Conjunct_Break property used for UAX29, rule GB9c.

		As Outputs Of (at least one exported)
			func LookupIndicConjunctBreak(r rune) IndicConjunctBreak
		As Types Of (total 3)
			const ICBConsonant
			const ICBExtend
			const ICBLinker

	 type LineBreak uint64 (basic type)
		LineBreak is a flag storing the Unicode Line Break Property.
		
		See https://unicode.org/reports/tr14/#Properties

		As Outputs Of (at least one exported)
			func LookupLineBreak(ch rune) LineBreak
		As Types Of (total 48)
			const LB_AI
			const LB_AK
			const LB_AL
			const LB_AP
			const LB_AS
			const LB_B2
			const LB_BA
			const LB_BB
			const LB_BK
			const LB_CB
			const LB_CJ
			const LB_CL
			const LB_CM
			const LB_CP
			const LB_CR
			const LB_EB
			const LB_EM
			const LB_EX
			const LB_GL
			const LB_H2
			const LB_H3
			const LB_HH
			const LB_HL
			const LB_HY
			const LB_ID
			const LB_IN
			const LB_IS
			const LB_JL
			const LB_JT
			const LB_JV
			const LB_LF
			const LB_NL
			const LB_NS
			const LB_NU
			const LB_OP
			const LB_PO
			const LB_PR
			const LB_QU
			const LB_RI
			const LB_SA
			const LB_SG
			const LB_SP
			const LB_SY
			const LB_VF
			const LB_VI
			const LB_WJ
			const LB_ZW
			const LB_ZWJ

	 type ScriptVerticalOrientation (struct)
		ScriptVerticalOrientation provides the glyph oriention
		to use for vertical text.

		Methods (only one)
			( ScriptVerticalOrientation) Orientation(r rune) (isSideways bool)
				Orientation returns the prefered orientation
				for the given rune.
				If the rune does not belong to this script, the default orientation of this script
				is returned (regardless of the actual script of the given rune).

		As Outputs Of (at least one exported)
			func LookupVerticalOrientation(s language.Script) ScriptVerticalOrientation

	 type WordBreak uint16 (basic type)
		WordBreak is a flag storing the Unicode Word Break Property.
		
		See https://unicode.org/reports/tr29/#Table_Word_Break_Property_Values

		As Outputs Of (at least one exported)
			func LookupWordBreak(ch rune) WordBreak
		As Types Of (total 14)
			const WB_ALetter
			const WB_Double_Quote
			const WB_ExtendFormat
			const WB_ExtendNumLet
			const WB_Hebrew_Letter
			const WB_Katakana
			const WB_MidLetter
			const WB_MidNum
			const WB_MidNumLet
			const WB_NewlineCRLF
			const WB_Numeric
			const WB_Regional_Indicator
			const WB_Single_Quote
			const WB_WSegSpace


Package-Level Functions (total 13)

	 func Compose(a, b rune) (rune, bool)
		Compose composes a sequence of two input Unicode code
		points by canonical equivalence, returning the composed code, if successful.
		It returns `false` otherwise

	 func Decompose(ab rune) (a, b rune, ok bool)
		Decompose decomposes an input Unicode code point,
		returning the two decomposed code points, if successful.
		It returns `false` otherwise.

	 func IsExtendedPictographic(ch rune) bool
	 func IsLargeEastAsian(ch rune) bool
		IsLargeEastAsian matches runes with East_Asian_Width property of
		F, W or H, and is used for UAX14, rule LB30.

	 func IsWord(ch rune) bool
		IsWord returns true for all the runes we may found in a word,
		that is either a Number (Nd, Nl, No) or a rune with the Alphabetic property

	 func LookupCombiningClass(ch rune) uint8
		LookupCombiningClass returns the class used for the Canonical Ordering Algorithm in the Unicode Standard,
		defaulting to 0.
		
		From http://www.unicode.org/reports/tr44/#Canonical_Combining_Class:
		"This property could be considered either an enumerated property or a numeric property:
		the principal use of the property is in terms of the numeric values.
		For the property value names associated with different numeric values,
		see DerivedCombiningClass.txt and Canonical Combining Class Values."

	 func LookupGeneralCategory(r rune) GeneralCategory
		LookupGeneralCategory returns the unicode general categorie of the rune,
		or [Unassigned] if not found.

	 func LookupGraphemeBreak(ch rune) GraphemeBreak
		LookupGraphemeBreak returns the grapheme break property for the rune, or 0.

	 func LookupIndicConjunctBreak(r rune) IndicConjunctBreak
		LookupIndicConjunctBreak return the value of the Indic_Conjunct_Break,
		or zero.

	 func LookupLineBreak(ch rune) LineBreak
		LookupLineBreak returns the break class for the rune,
		or 0 (the XX, Unknown class)

	 func LookupMirrorChar(ch rune) rune
		LookupMirrorChar finds the mirrored equivalent of a character as defined in
		the file BidiMirroring.txt of the Unicode Character Database available at
		http://www.unicode.org/Public/UNIDATA/BidiMirroring.txt.
		
		If the input character is declared as a mirroring character in the
		Unicode standard and has a mirrored equivalent, it is returned.
		Otherwise the input character itself is returned

	 func LookupVerticalOrientation(s language.Script) ScriptVerticalOrientation
		LookupVerticalOrientation returns the prefered orientation
		for the given script.

	 func LookupWordBreak(ch rune) WordBreak
		LookupWordBreak returns the word break property for the rune, or 0.


Package-Level Constants (total 117)

	const Cc GeneralCategory = 1 // Control
	const Cf GeneralCategory = 2 // Format
	const Co GeneralCategory = 3 // Private_Use
	const Cs GeneralCategory = 4 // Surrogate
	const GB_Control GraphemeBreak = 2
	const GB_CR GraphemeBreak = 1
	const GB_Extend GraphemeBreak = 4
	const GB_L GraphemeBreak = 8
	const GB_LF GraphemeBreak = 16
	const GB_LV GraphemeBreak = 32
	const GB_LVT GraphemeBreak = 64
	const GB_Prepend GraphemeBreak = 128
	const GB_Regional_Indicator GraphemeBreak = 256
	const GB_SpacingMark GraphemeBreak = 512
	const GB_T GraphemeBreak = 1024
	const GB_V GraphemeBreak = 2048
	const GB_ZWJ GraphemeBreak = 4096
	const HangulLBase = 4352
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulLCount = 19
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulNCount = 588
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulSBase = 44032
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulSCount = 11172
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulTBase = 4519
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulTCount = 28
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulVBase = 4449
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const HangulVCount = 21
		Algorithmic hangul syllables [de]composition, used
		in Compose and Decompose, but also exported for additional shaper
		processing.

	const ICBConsonant IndicConjunctBreak = 2
	const ICBExtend IndicConjunctBreak = 4
	const ICBLinker IndicConjunctBreak = 1
	const LB_AI LineBreak = 1 // Ambiguous
	const LB_AK LineBreak = 2 // Aksara
	const LB_AL LineBreak = 4 // Alphabetic
	const LB_AP LineBreak = 8 // Aksara_Prebase
	const LB_AS LineBreak = 16 // Aksara_Start
	const LB_B2 LineBreak = 32 // Break_Both
	const LB_BA LineBreak = 64 // Break_After
	const LB_BB LineBreak = 128 // Break_Before
	const LB_BK LineBreak = 256 // Mandatory_Break
	const LB_CB LineBreak = 512 // Contingent_Break
	const LB_CJ LineBreak = 1024 // Conditional_Japanese_Starter
	const LB_CL LineBreak = 2048 // Close_Punctuation
	const LB_CM LineBreak = 4096 // Combining_Mark
	const LB_CP LineBreak = 8192 // Close_Parenthesis
	const LB_CR LineBreak = 16384 // Carriage_Return
	const LB_EB LineBreak = 32768 // E_Base
	const LB_EM LineBreak = 65536 // E_Modifier
	const LB_EX LineBreak = 131072 // Exclamation
	const LB_GL LineBreak = 262144 // Glue
	const LB_H2 LineBreak = 524288 // H2
	const LB_H3 LineBreak = 1048576 // H3
	const LB_HH LineBreak = 2097152 // Unambiguous_Hyphen
	const LB_HL LineBreak = 4194304 // Hebrew_Letter
	const LB_HY LineBreak = 8388608 // Hyphen
	const LB_ID LineBreak = 16777216 // Ideographic
	const LB_IN LineBreak = 33554432 // Inseparable
	const LB_IS LineBreak = 67108864 // Infix_Numeric
	const LB_JL LineBreak = 134217728 // JL
	const LB_JT LineBreak = 268435456 // JT
	const LB_JV LineBreak = 536870912 // JV
	const LB_LF LineBreak = 1073741824 // Line_Feed
	const LB_NL LineBreak = 2147483648 // Next_Line
	const LB_NS LineBreak = 4294967296 // Nonstarter
	const LB_NU LineBreak = 8589934592 // Numeric
	const LB_OP LineBreak = 17179869184 // Open_Punctuation
	const LB_PO LineBreak = 34359738368 // Postfix_Numeric
	const LB_PR LineBreak = 68719476736 // Prefix_Numeric
	const LB_QU LineBreak = 137438953472 // Quotation
	const LB_RI LineBreak = 274877906944 // Regional_Indicator
	const LB_SA LineBreak = 549755813888 // Complex_Context
	const LB_SG LineBreak = 1099511627776 // Surrogate
	const LB_SP LineBreak = 2199023255552 // Space
	const LB_SY LineBreak = 4398046511104 // Break_Symbols
	const LB_VF LineBreak = 8796093022208 // Virama_Final
	const LB_VI LineBreak = 17592186044416 // Virama
	const LB_WJ LineBreak = 35184372088832 // Word_Joiner
	const LB_ZW LineBreak = 70368744177664 // ZWSpace
	const LB_ZWJ LineBreak = 140737488355328 // ZWJ
	const Ll GeneralCategory = 5 // Lowercase_Letter
	const Lm GeneralCategory = 6 // Modifier_Letter
	const Lo GeneralCategory = 7 // Other_Letter
	const Lt GeneralCategory = 8 // Titlecase_Letter
	const Lu GeneralCategory = 9 // Uppercase_Letter
	const Mc GeneralCategory = 10 // Spacing_Mark
	const Me GeneralCategory = 11 // Enclosing_Mark
	const Mn GeneralCategory = 12 // Nonspacing_Mark
	const Nd GeneralCategory = 13 // Decimal_Number
	const Nl GeneralCategory = 14 // Letter_Number
	const No GeneralCategory = 15 // Other_Number
	const Pc GeneralCategory = 16 // Connector_Punctuation
	const Pd GeneralCategory = 17 // Dash_Punctuation
	const Pe GeneralCategory = 18 // Close_Punctuation
	const Pf GeneralCategory = 19 // Final_Punctuation
	const Pi GeneralCategory = 20 // Initial_Punctuation
	const Po GeneralCategory = 21 // Other_Punctuation
	const Ps GeneralCategory = 22 // Open_Punctuation
	const Sc GeneralCategory = 23 // Currency_Symbol
	const Sk GeneralCategory = 24 // Modifier_Symbol
	const Sm GeneralCategory = 25 // Math_Symbol
	const So GeneralCategory = 26 // Other_Symbol
	const Unassigned GeneralCategory = 0
	const WB_ALetter WordBreak = 1
	const WB_Double_Quote WordBreak = 2
	const WB_ExtendFormat WordBreak = 4
	const WB_ExtendNumLet WordBreak = 8
	const WB_Hebrew_Letter WordBreak = 16
	const WB_Katakana WordBreak = 32
	const WB_MidLetter WordBreak = 64
	const WB_MidNum WordBreak = 128
	const WB_MidNumLet WordBreak = 256
	const WB_NewlineCRLF WordBreak = 512
	const WB_Numeric WordBreak = 1024
	const WB_Regional_Indicator WordBreak = 2048
	const WB_Single_Quote WordBreak = 4096
	const WB_WSegSpace WordBreak = 8192
	const Zl GeneralCategory = 27 // Line_Separator
	const Zp GeneralCategory = 28 // Paragraph_Separator
	const Zs GeneralCategory = 29 // Space_Separator

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.