ldml

Documentation

Overview

Package ldml parses LDML documents containing either language-dependent data or supplementary data.

Note that this is not a full implementation.

Current features: * Parsing ldml>identity (incomplete). * Parsing ldml>rbnf rules.

TODO: ability to merge two documents with inheritance

see https://unicode.org/reports/tr35/#5-xml-format

Index

• Constants
• type Alias
• type DocType
• type Document
  • func Parse(ldml []byte) (document Document, err error)
• type Ldml
• type Numbers
• type PluralRule
• type PluralRules
• type Plurals
• type RbnfRule
  • func (r RbnfRule) IcuStyle() string
• type RbnfRuleset
  • func (rs RbnfRuleset) IsPrivate() bool
• type RbnfRulesetGrouping
• type String
  • func (s String) String() string
• type Supplemental
• type Symbols
• type TODO

Constants

const (
	DocTypeLdml         = DocType("ldml")
	DocTypeSupplemental = DocType("supplementalData")
)

Types

type Alias

type Alias struct {
	Source string `xml:"source,attr"`
	Path   string `xml:"path,attr"`
}

type DocType

type DocType string

type Document

type Document struct {
	Type DocType

	// One of the following, discriminated by Type...
	Ldml         Ldml
	Supplemental Supplemental
	LdmlBCP47    TODO // `xml:"ldmlBCP47"`
	Keyboard     TODO // `xml:"keyboard"`
	Platform     TODO // `xml:"platform"`
}

func Parse

func Parse(ldml []byte) (document Document, err error)

Parse returns a Document parsed from an (XML-based) LDML or LDML Supplemental Data document.

type Ldml

type Ldml struct {
	XMLName              xml.Name              `xml:"ldml"`
	Language             String                `xml:"identity>language"`
	Script               String                `xml:"identity>script"`
	Region               String                `xml:"identity>territory"`
	Variant              String                `xml:"identity>variant"`
	RbnfRulesetGroupings []RbnfRulesetGrouping `xml:"rbnf>rulesetGrouping"`
	Numbers              Numbers               `xml:"numbers"`
}

type Numbers

type Numbers struct {
	Symbols           []Symbols `xml:"symbols"`
	DecimalFormats    TODO
	ScientificFormats TODO
	PercentFormats    TODO
	CurrencyFormats   TODO
	Currencies        TODO
}

type PluralRule

type PluralRule struct {
	Count   string `xml:"count,attr"`
	Content string `xml:",chardata"`
}

type PluralRules

type PluralRules struct {
	Locales string       `xml:"locales,attr"`
	Rules   []PluralRule `xml:"pluralRule"`
}

type Plurals

type Plurals struct {
	Type   string        `xml:"type,attr"`
	Rules  []PluralRules `xml:"pluralRules"`
	Ranges []TODO        `xml:"pluralRanges"`
}

type RbnfRule

type RbnfRule struct {
	Value   string `xml:"value,attr"`
	Radix   string `xml:"radix,attr"`
	Content string `xml:",chardata"`
}

func (RbnfRule) IcuStyle

func (r RbnfRule) IcuStyle() string

IcuStyle returns a rule formatted in the way described by the International Components for Unicode (ICU) software implementations ([ICU4C RuleBasedNumberFormat]) and ([ICU4J RuleBasedNumberFormat]), for example "name: body;".

ICU4C RuleBasedNumberFormat: https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1RuleBasedNumberFormat.html ICU4J RuleBasedNumberFormat: https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/text/RuleBasedNumberFormat.html

type RbnfRuleset

type RbnfRuleset struct {
	Type   string     `xml:"type,attr"`
	Rules  []RbnfRule `xml:"rbnfrule"`
	Access string     `xml:"access,attr"`
}

func (RbnfRuleset) IsPrivate

func (rs RbnfRuleset) IsPrivate() bool

type RbnfRulesetGrouping

type RbnfRulesetGrouping struct {
	Type     string        `xml:"type,attr"`
	Rulesets []RbnfRuleset `xml:"ruleset"`
}

type String

type String struct {
	Type string `xml:"type,attr"`
}

func (String) String

func (s String) String() string

type Supplemental

type Supplemental struct {
	XMLName xml.Name `xml:"supplementalData"`
	Plurals Plurals  `xml:"plurals"`
}

type Symbols

type Symbols struct {
	Alias                  Alias  `xml:"alias"`
	NumberSystem           string `xml:"numberSystem,attr"`
	Decimal                string `xml:"decimal"`
	Group                  string `xml:"group"`
	List                   string `xml:"list"`
	PercentSign            string `xml:"percentSign"`
	PlusSign               string `xml:"plusSign"`
	MinusSign              string `xml:"minusSign"`
	ApproximatelySign      string `xml:"approximatelySign"`
	Exponential            string `xml:"exponential"`
	SuperscriptingExponent string `xml:"superscriptingExponent"`
	PerMille               string `xml:"perMille"`
	Infinity               string `xml:"infinity"`
	NaN                    string `xml:"nan"`
	CurrencyDecimal        string `xml:"currencyDecimal"`
	CurrencyGroup          string `xml:"currencyGroup"`
}

type TODO

type TODO struct{}