token

type AttrDecoder interface {
	// 解析属性值
	//
	// 接口应该只返回 *core.SyntaxError 作为错误对象。
	DecodeXMLAttr(p *Parser, attr *Attribute) error
}

type AttrEncoder interface {
	// 仅需要返回属性的 XML 表示，不需要包含属性值的引号字符。
	EncodeXMLAttr() (string, error)
}

type Attribute struct {
	core.Range
	Name  Name
	Value String
}

type Base struct {
	core.Range
	UsageKey message.Reference `apidoc:"-"` // 表示对当前元素的一个说明内容的翻译 ID
}

type BaseAttribute struct {
	Base
	AttributeName Name `apidoc:"-"`
}

type BaseTag struct {
	Base
	StartTag Name `apidoc:"-"` // 表示起始标签名
	EndTag   Name `apidoc:"-"` // 表示标签的结束名称，如果是自闭合的标签，此值为空。
}

type CData struct {
	BaseTag
	Value String
}

type Comment struct {
	core.Range
	Value String
}

type Decoder interface {
	// 从 p 中读取内容并实例化到当前对象中
	//
	// 必须要同时从 p 中读取相应的 EndElement 才能返回。
	// end 表示 EndElement.End 的值。
	//
	// NOTE: 如果是自闭合标签，则不会调用该接口。
	//
	// 接口应该只返回 *core.SyntaxError 作为错误对象。
	DecodeXML(p *Parser, start *StartElement) (end *EndElement, err error)
}

type Encoder interface {
	// 仅需要返回元素内容的 XML 编码，不需要包含本身的标签和属性。
	EncodeXML() (string, error)
}

type EndElement struct {
	core.Range
	Name Name
}

type Instruction struct {
	core.Range
	Name       String
	Attributes []*Attribute
}

type Name struct {
	core.Range
	Prefix String
	Local  String
}

type Parser struct {
	*lexer.Lexer
}

type Sanitizer interface {
	// 验证数据是否正确
	//
	// 可以通过 p.NewError 和 p.WithError 返回 *core.SyntaxError 类型的错误
	Sanitize(p *Parser) error
}

type StartElement struct {
	core.Range
	Name       Name
	Attributes []*Attribute
	Close      bool // 是否自闭合
}

type String struct {
	core.Range
	Value string
}

type Tip struct {
	core.Range
	Usage string
}