gockl

README

gockl

gockl is a minimal XML processor for Go that does not to fuck with your markup.

Supported & tested Go versions are: 1.2 – 1.23.

Usage

Transparently decode XML string input and re-encode to string output without affecting the underlying structure of the original file:

buf := bytes.Buffer{}
z := gockl.New(input)

for {
	t, err := z.Next()
	if err != nil {
		break
	}

	if el, ok := t.(gockl.ElementToken); ok {
		log.Println(el.Name())
	}
	buf.WriteString(t.Raw())
}

output := buf.String()

Why?

• To ease creating XML document diffs, if only minor changes to a document are done
• To not run into over-escaping of text data in encoding/xml: https://github.com/golang/go/issues/9204
• To not run into broken namespace handling: https://github.com/golang/go/issues/9519
• To not run into errors when parsing DOCTYPEs with subsets: https://github.com/golang/go/issues/10158

License

MIT/X11.

Documentation

Index

• type Attribute
• type CDATAToken
  • func (t CDATAToken) Raw() string
• type CommentToken
  • func (t CommentToken) Raw() string
• type DirectiveToken
  • func (t DirectiveToken) Raw() string
• type ElementToken
• type EmptyElementToken
  • func (t EmptyElementToken) Attribute(name string) (string, bool)
  • func (t EmptyElementToken) Attributes() []Attribute
  • func (t EmptyElementToken) Name() string
  • func (t EmptyElementToken) Raw() string
• type EndElementToken
  • func (t EndElementToken) Name() string
  • func (t EndElementToken) Raw() string
• type ProcInstToken
  • func (t ProcInstToken) Raw() string
• type StartElementToken
  • func (t StartElementToken) Attribute(name string) (string, bool)
  • func (t StartElementToken) Attributes() []Attribute
  • func (t StartElementToken) Name() string
  • func (t StartElementToken) Raw() string
• type StartOrEmptyElementToken
• type TextToken
  • func (t TextToken) Raw() string
• type Token
• type Tokenizer
  • func New(input string) *Tokenizer
  • func (me *Tokenizer) Next() (Token, error)

Types

type Attribute

type Attribute struct {
	Name    string
	Content string
}

type CDATAToken

type CDATAToken string

func (CDATAToken) Raw

func (t CDATAToken) Raw() string

type CommentToken

type CommentToken string

func (CommentToken) Raw

func (t CommentToken) Raw() string

type DirectiveToken

type DirectiveToken string

func (DirectiveToken) Raw

func (t DirectiveToken) Raw() string

type ElementToken

type ElementToken interface {
	Token
	Name() string
}

type EmptyElementToken

type EmptyElementToken string

func (EmptyElementToken) Attribute

func (t EmptyElementToken) Attribute(name string) (string, bool)

func (EmptyElementToken) Attributes

func (t EmptyElementToken) Attributes() []Attribute

func (EmptyElementToken) Name

func (t EmptyElementToken) Name() string

func (EmptyElementToken) Raw

func (t EmptyElementToken) Raw() string

type EndElementToken

type EndElementToken string

func (EndElementToken) Name

func (t EndElementToken) Name() string

func (EndElementToken) Raw

func (t EndElementToken) Raw() string

type ProcInstToken

type ProcInstToken string

func (ProcInstToken) Raw

func (t ProcInstToken) Raw() string

type StartElementToken

type StartElementToken string

func (StartElementToken) Attribute

func (t StartElementToken) Attribute(name string) (string, bool)

func (StartElementToken) Attributes

func (t StartElementToken) Attributes() []Attribute

func (StartElementToken) Name

func (t StartElementToken) Name() string

func (StartElementToken) Raw

func (t StartElementToken) Raw() string

type StartOrEmptyElementToken

type StartOrEmptyElementToken interface {
	ElementToken
	Attributes() []Attribute
	Attribute(name string) (string, bool)
}

type TextToken

type TextToken string

func (TextToken) Raw

func (t TextToken) Raw() string

type Token

type Token interface {
	Raw() string
}

type Tokenizer

type Tokenizer struct {
	Input    string
	Position int
}

func New

func New(input string) *Tokenizer

func (*Tokenizer) Next

func (me *Tokenizer) Next() (Token, error)