xml

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Example (Read) 
package main

import (
	"fmt"
	"log"

	"github.com/adnsv/srw/xml"
)

func main() {
	//ShowTokens(example2)
	parse(example01)
}

func parse(buf string) {
	cc := xml.Open(buf)
	if cc.NextTag() {
		fmt.Printf("root: %s", cc.Name())
		cc.HandleTag(func(attrs xml.AttributeList, content *xml.Content) error {
			for _, a := range attrs {
				fmt.Printf(" %s=%s", a.Name, a.Value)
			}
			handleContent(content)
			return nil
		})
		fmt.Printf("\ndone\n")
	}
}

func handleContent(content *xml.Content) {
	for content.Next() {
		switch content.Kind() {
		case xml.XmlDecl:
			fmt.Printf(`<?xml version="1.0" encoding="UTF-8"?>`)
		case xml.Tag:
			n := content.Name()
			if n == "id" || n == "caption" {
				v := content.ChildStringContent()
				fmt.Printf("- %s=%s", n, v)
				continue
			}
			fmt.Printf("<%s", n)
			content.HandleTag(func(attrs xml.AttributeList, chilcontent *xml.Content) error {
				for _, a := range attrs {
					fmt.Printf(" %s=%s", a.Name, a.Value)
				}
				if chilcontent == nil {
					fmt.Printf("/>")
				} else {
					fmt.Print(">")
					handleContent(chilcontent)
					fmt.Printf("</%s>", n)
				}
				return nil
			})
		case xml.SData:
			fmt.Printf("%s", content.Value())
		case xml.CData:
			fmt.Printf("<![CDATA[%s]]>", content.Value())
		case xml.Comment:
			fmt.Printf("<!--%s-->", content.Value())
		case xml.PI:
			fmt.Printf("<?%s %s?>", content.Name(), content.Value())
		default:
			fmt.Printf("<unknown>")
		}
	}
}

func ShowTokens(buf string) {
	err := xml.ParseTokens(buf, func(t *xml.Token) error {
		switch t.Kind {
		case xml.EOF:
			fmt.Printf("\n[EOF]\n")
			return nil
		case xml.Err:
			return t.Error
		case xml.XmlDecl:
			fmt.Printf("XMLDECL[%s]", t.Raw)
		case xml.Tag:
			fmt.Printf("%s<TAG:%s", t.WhitePrefix, t.Name)
		case xml.BeginContent:
			fmt.Printf("[")
		case xml.CloseEmptyTag:
			fmt.Printf(">")
		case xml.EndContent:
			fmt.Printf("]>")
		case xml.Attrib:
			fmt.Printf(" %s=%s", t.Name, t.Value)
		case xml.SData:
			fmt.Printf("%s", t.Value)
		case xml.CData:
			fmt.Printf("<CDATA:[%s]>", t.Value)
		case xml.Comment:
			fmt.Printf("%s<COMMENT:%s>", t.WhitePrefix, t.Value)
		case xml.PI:
			fmt.Printf("%s<PI:%s %s>", t.WhitePrefix, t.Name, t.Value)
		}
		return nil
	})
	fmt.Printf("\n")
	if err != nil {
		log.Fatal(err)
	}
}

const example01 = `<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 25.2.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
	 width="375.6px" height="233.2px" viewBox="0 0 375.6 233.2" style="enable-background:new 0 0 375.6 233.2;" xml:space="preserve"
	>
<style type="text/css">
	.st0{fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
	.st1{fill:none;stroke:#000000;stroke-width:0.25;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:10;}
	.st2{fill:#304499;stroke:#FFFFFF;stroke-width:0.5;stroke-miterlimit:10;}
	.st3{fill:#FFFFFF;stroke:#304499;stroke-width:0.3502;stroke-miterlimit:10;}
	.st4{fill:#010101;}
	.st5{font-family:'ArialMT';}
	.st6{font-size:8px;}
</style>
<path class="st0" d="M325.7,53.3c0.7-2.8,2.6-4.9,5.2-5.4"/>
<line class="st0" x1="317.1" y1="137.6" x2="341" y2="72.6"/>
<path class="st0" d="M327.3,153.5c0.2-0.5,0.1-1-0.2-1.5"/>
<line class="st0" x1="53.6" y1="168.3" x2="51.9" y2="168"/>
<path class="st1" d="M105,12.3c1.2,1.9,1.4,4.1,0.6,6.1"/>
<line class="st1" x1="18.6" y1="179.9" x2="27.6" y2="191.9"/>
<text transform="matrix(1 0 0 1 349.3292 195.6429)" class="st4 st5 st6">2</text>
</svg>
`

/*
const example02 = `<?xml version="1.0" encoding="UTF-8"?>
<DocumentElement param="value">
	<!-- comment -->
	<FirstElement>
		&#xb6; Some Text
	</FirstElement>
	<?some_pi some_attr="some_value"?>
	<SecondElement param2="something">
		Pre-Text <Inline>Inlined text</Inline> Post-text.
	</SecondElement>
</DocumentElement>
<?another_pi some_attr="some_value"?>
`

const example03 = `<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">
<svg version="1.1" baseProfile="tiny" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="25.2px" height="25.2px" viewBox="0 0 25.2 25.2" xml:space="preserve">
	<path fill="#231F20" d="M12.601,0.9c6.451,0,11.7,5.249,11.7,11.7c0,6.451-5.249,11.701-11.7,11.701S0.9,19.051,0.9,12.6
	C0.9,6.149,6.149,0.9,12.601,0.9 M12.601,0C5.642,0,0,5.641,0,12.6c0,6.958,5.642,12.6,12.601,12.6s12.6-5.642,12.6-12.6
	C25.2,5.641,19.56,0,12.601,0L12.601,0z" />
	<polygon points="19.801,11.16 19.801,14.04 9.9,14.04 9.9,16.2 4.5,12.6 9.9,9 9.9,11.16 " />
</svg>`
*/

Output:
Example (Write) 
package main

import (
	"bytes"
	"fmt"

	"github.com/adnsv/srw/xml"
)

func main() {

	out := &bytes.Buffer{}
	w := xml.NewWriter(out, xml.WriterConfig{Indent: xml.Indent2Spaces})

	s := "Hello, "

	w.OTag("hello")
	w.Attr("attr", 42)
	w.Attr("attr2", true)
	w.BeginContent()
	w.Write(s)
	w.Write("World!")
	w.Write(' ')
	w.Write([]string{"a", "b", "c"})
	w.CTag()

	fmt.Println(out.String())
}

Output:

Index

Examples

Constants

View Source 
const (
	ErrCodeOk = ErrCode(iota)
	ErrCustom
	ErrCodeUnexpectedEOF
	ErrCodeUnexpectedContent
	ErrCodeUnterminatedQStr
	ErrCodeUnterminatedCDATA
	ErrCodeUnsupportedFeature
	ErrCodeExpectedAttrName
	ErrCodeExpectedEQ
	ErrCodeExpectedQStr
	ErrCodeExpectedOTag
	ErrCodeInvalidSchema
	ErrCodeInvalidXmlDecl
	ErrMismatchingTag
	ErrCodeMissingRoot
	ErrUnterminatedComment
	ErrInvalidComment
	ErrUnterminatedPI
)
View Source 
const (
	EOF           // end of file (buffer)
	Err           // error
	XmlDecl       // <?xml version="1.0" encoding="UTF-8"?>
	DocTypeDecl   // <!DOCTYPE ... >
	Tag           // <identifier
	CloseEmptyTag // />
	BeginContent  // >
	EndContent    // </identifier>
	Attrib        // identifier="qstring" or identifier='qstring'
	SData         // content string data
	CData         // cdata tag content
	Comment       // <!-- comment -->
	PI            // <?name value?>
)
View Source 
const (
	IndentTabs    = Indent(0)
	Indent2Spaces = Indent(2)
	Indent4Spaces = Indent(4)
	IndentNone    = Indent(-1)
)

Variables

View Source 
var ErrNoMoreContent = errors.New("no more content available")

Functions

func NewError 

func NewError(ec ErrCode, buf string, offset int) error

func ParseTokens 

func ParseTokens(buf string, ontoken func(t *Token) error) error

Types

type AttributeList 

type AttributeList []*Token

func (AttributeList) Attr 

func (aa AttributeList) Attr(name string) (string, bool)

type Content 

type Content struct {
	// contains filtered or unexported fields
}

func Open 

func Open(buf string) *Content

func (*Content) ChildStringContent 

func (ci *Content) ChildStringContent() RawString

ChildStringContent extracts subnode string content

If subnode is empty, or its content is not a simple string, this function returns empty string.

This is useful for parsing <tag>string-content</tag> nodes

func (*Content) Err 

func (ci *Content) Err() error

func (*Content) HandleTag 

func (ci *Content) HandleTag(callback func(attrs AttributeList, content *Content) error)

func (*Content) IsCData 

func (ci *Content) IsCData() bool

func (*Content) IsComment 

func (ci *Content) IsComment() bool

func (*Content) IsPI 

func (ci *Content) IsPI() bool

func (*Content) IsSData 

func (ci *Content) IsSData() bool

func (*Content) IsTag 

func (ci *Content) IsTag() bool

func (*Content) IsXmlDecl 

func (ci *Content) IsXmlDecl() bool

func (*Content) Kind 

func (ci *Content) Kind() TokenKind

func (*Content) MakeError 

func (ci *Content) MakeError(prefix, msg string) error

func (*Content) Name 

func (ci *Content) Name() NameString

func (*Content) Next 

func (ci *Content) Next() (ok bool)

func (*Content) NextTag 

func (ci *Content) NextTag() bool

func (*Content) Raw 

func (ci *Content) Raw() (whitePrefix, tokenStr string)

func (*Content) Value 

func (ci *Content) Value() RawString

type ContentHandler 

type ContentHandler = func(t *Token) error

type ErrCode 

type ErrCode int

func (ErrCode) Failed 

func (ec ErrCode) Failed() bool

func (ErrCode) String 

func (ec ErrCode) String() string

func (ErrCode) Succeeded 

func (ec ErrCode) Succeeded() bool

type Indent 

type Indent int

type Marshaler 

type Marshaler interface {
	MarshalXG(w *Writer) error
}

type NameString 

type NameString string

func (NameString) Raw 

func (ns NameString) Raw() string

type RawString 

type RawString string

func ScrambleAttr 

func ScrambleAttr(s string) RawString

func ScrambleContent 

func ScrambleContent(s string) RawString

func (RawString) Raw 

func (rs RawString) Raw() string

func (RawString) Unscrambled 

func (rs RawString) Unscrambled() string

type TagHandler 

type TagHandler func(tag *Token, attrs AttributeList, content *Content) error

type Token 

type Token struct {
	Kind        TokenKind
	Error       error
	Name        NameString
	Value       RawString
	WhitePrefix string
	Raw         string
	SrcPos      int
}

func (*Token) IsDone 

func (t *Token) IsDone() bool

func (*Token) IsError 

func (t *Token) IsError() bool

type TokenKind 

type TokenKind int

func (TokenKind) String 

func (t TokenKind) String() string

type UnsupportedTypeError 

type UnsupportedTypeError struct {
	Type reflect.Type
}

UnsupportedTypeError is returned when Marshal encounters a type that cannot be converted into XML.

func (*UnsupportedTypeError) Error 

func (e *UnsupportedTypeError) Error() string

type Writer 

type Writer struct {
	WriterConfig
	// contains filtered or unexported fields
}

func NewWriter 

func NewWriter(out io.Writer, config WriterConfig) *Writer

func (*Writer) Attr 

func (w *Writer) Attr(name NameString, value interface{}) *Writer

func (*Writer) BOM 

func (w *Writer) BOM()

func (*Writer) BeginContent 

func (w *Writer) BeginContent()

func (*Writer) CTag 

func (w *Writer) CTag() *Writer

func (*Writer) Comment 

func (w *Writer) Comment(s string) *Writer

func (*Writer) IndentLevel 

func (w *Writer) IndentLevel() int

func (*Writer) IndentStr 

func (w *Writer) IndentStr() string

func (*Writer) OTag 

func (w *Writer) OTag(name NameString) *Writer

func (*Writer) OptAttr 

func (w *Writer) OptAttr(name NameString, value interface{}) *Writer

func (*Writer) OptRawAttr 

func (w *Writer) OptRawAttr(name NameString, value RawString) *Writer

func (*Writer) OptStringAttr 

func (w *Writer) OptStringAttr(name NameString, value string) *Writer

func (*Writer) RawAttr 

func (w *Writer) RawAttr(name NameString, value RawString) *Writer

func (*Writer) RawString 

func (w *Writer) RawString(s RawString) *Writer

func (*Writer) String 

func (w *Writer) String(s string) *Writer

func (*Writer) StringAttr 

func (w *Writer) StringAttr(name NameString, value string) *Writer

func (*Writer) Write 

func (w *Writer) Write(v interface{}) *Writer

func (*Writer) XmlDecl 

func (w *Writer) XmlDecl()

type WriterConfig 

type WriterConfig struct {
	Indent    Indent
	IndentAll bool // force indent all tags
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.