GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — etree/etree.go at v1.8.1 · beevik/etree Expand file tree/ Copy pathetree.goMore file actions 1934 lines (1706 loc) · 52.5 KB / Copy pathetree.goFile metadata and controls1934 lines (1706 loc) · 52.5 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 // Copyright 2015-2019 Brett Vickers. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. // Package etree provides XML services through an Element Tree // abstraction. package etree import ( "bufio" "bytes" "encoding/xml" "errors" "io" "iter" "maps" "os" "slices" "strings" ) const ( // NoIndent is used with the IndentSettings record to remove all // indenting. NoIndent = -1 ) // ErrXML is returned when XML parsing fails due to incorrect formatting. var ErrXML = errors.New("etree: invalid XML format") // ErrMaxDepth is returned when the depth of the XML tree being read exceeds // the maximum depth allowed by ReadSettings.MaxDepth. var ErrMaxDepth = errors.New("etree: XML tree exceeds maximum depth") // cdataPrefix is used to detect CDATA text when ReadSettings.PreserveCData is // true. var cdataPrefix = []byte("<![CDATA[") // ReadSettings determine the default behavior of the Document's ReadFrom* // functions. type ReadSettings struct { // CharsetReader, if non-nil, defines a function to generate // charset-conversion readers, converting from the provided non-UTF-8 // charset into UTF-8. If nil, the ReadFrom* functions will use a // "pass-through" CharsetReader that performs no conversion on the reader's // data regardless of the value of the "charset" encoding string. Default: // nil. CharsetReader func(charset string, input io.Reader) (io.Reader, error) // Permissive allows input containing common mistakes such as missing tags // or attribute values. Default: false. Permissive bool // Preserve CDATA character data blocks when decoding XML (instead of // converting it to normal character text). This entails additional // processing and memory usage during ReadFrom* operations. Default: // false. PreserveCData bool // When an element has two or more attributes with the same name, // preserve them instead of keeping only one. Default: false. PreserveDuplicateAttrs bool // ValidateInput forces all ReadFrom* functions to validate that the // provided input is composed of "well-formed"(*) XML before processing it. // If invalid XML is detected, the ReadFrom* functions return an error. // Because this option requires the input to be processed twice, it incurs a // significant performance penalty. Default: false. // // (*) Note that this definition of "well-formed" is in the context of the // go standard library's encoding/xml package. Go's encoding/xml package // does not, in fact, guarantee well-formed XML as specified by the W3C XML // recommendation. See: https://github.com/golang/go/issues/68299 ValidateInput bool // Entity to be passed to standard xml.Decoder. Default: nil. Entity map[string]string // When Permissive is true, AutoClose indicates a set of elements to // consider closed immediately after they are opened, regardless of // whether an end element is present. Commonly set to xml.HTMLAutoClose. // Default: nil. AutoClose []string // MaxDepth is the maximum depth of the XML tree to parse. If the depth of // the XML tree exceeds this value, all ReadFrom* functions return the // error ErrMaxDepth. If MaxDepth is zero or negative, a depth limit of // 1024 is used. Default: 0 (i.e., a limit of 1024). MaxDepth int } // defaultMaxDepth is the maximum depth of an XML tree parsed by ReadFrom* // functions when ReadSettings.MaxDepth is not set to a positive value. const defaultMaxDepth = 1024 // defaultCharsetReader is used by the xml decoder when the ReadSettings // CharsetReader value is nil. It behaves as a "pass-through", ignoring // the requested charset parameter and skipping conversion altogether. func defaultCharsetReader(charset string, input io.Reader) (io.Reader, error) { return input, nil } // dup creates a duplicate of the ReadSettings object. func (s *ReadSettings) dup() ReadSettings { c := *s c.Entity = maps.Clone(s.Entity) return c } // WriteSettings determine the behavior of the Document's WriteTo* functions. type WriteSettings struct { // CanonicalEndTags forces the production of XML end tags, even for // elements that have no child elements. Default: false. CanonicalEndTags bool // CanonicalText forces the production of XML character references for // text data characters &, <, and >. If false, XML character references // are also produced for " and '. Default: false. CanonicalText bool // CanonicalAttrVal forces the production of XML character references for // attribute value characters &, < and ". If false, XML character // references are also produced for > and '. Ignored when AttrSingleQuote // is true. Default: false. CanonicalAttrVal bool // AttrSingleQuote causes attributes to use single quotes (attr='example') // instead of double quotes (attr = "example") when set to true. Default: // false. AttrSingleQuote bool // UseCRLF causes the document's Indent* functions to use a carriage return // followed by a linefeed ("\r\n") when outputting a newline. If false, // only a linefeed is used ("\n"). Default: false. // // Deprecated: UseCRLF is deprecated. Use IndentSettings.UseCRLF instead. UseCRLF bool } // dup creates a duplicate of the WriteSettings object. func (s *WriteSettings) dup() WriteSettings { return *s } // IndentSettings determine the behavior of the Document's Indent* functions. type IndentSettings struct { // Spaces indicates the number of spaces to insert for each level of // indentation. Set to etree.NoIndent to remove all indentation. Ignored // when UseTabs is true. Default: 4. Spaces int // UseTabs causes tabs to be used instead of spaces when indenting. // Default: false. UseTabs bool // UseCRLF causes newlines to be written as a carriage return followed by // a linefeed ("\r\n"). If false, only a linefeed character is output // for a newline ("\n"). Default: false. UseCRLF bool // PreserveLeafWhitespace causes indent functions to preserve whitespace // within XML elements containing only non-CDATA character data. Default: // false. PreserveLeafWhitespace bool // SuppressTrailingWhitespace suppresses the generation of a trailing // whitespace characters (such as newlines) at the end of the indented // document. Default: false. SuppressTrailingWhitespace bool } // NewIndentSettings creates a default IndentSettings record. func NewIndentSettings() *IndentSettings { return &IndentSettings{ Spaces: 4, UseTabs: false, UseCRLF: false, PreserveLeafWhitespace: false, SuppressTrailingWhitespace: false, } } type indentFunc func(depth int) string func getIndentFunc(s *IndentSettings) indentFunc { if s.UseTabs { if s.UseCRLF { return func(depth int) string { return indentCRLF(depth, indentTabs) } } else { return func(depth int) string { return indentLF(depth, indentTabs) } } } else { if s.Spaces < 0 { return func(depth int) string { return "" } } else if s.UseCRLF { return func(depth int) string { return indentCRLF(depth*s.Spaces, indentSpaces) } } else { return func(depth int) string { return indentLF(depth*s.Spaces, indentSpaces) } } } } // Writer is the interface that wraps the Write* functions called by each token // type's WriteTo function. type Writer interface { io.StringWriter io.ByteWriter io.Writer } // A Token is an interface type used to represent XML elements, character // data, CDATA sections, XML comments, XML directives, and XML processing // instructions. type Token interface { Parent() *Element Index() int Remove() bool WriteTo(w Writer, s *WriteSettings) dup(parent *Element) Token setParent(parent *Element) setIndex(index int) } // A Document is a container holding a complete XML tree. // // A document has a single embedded element, which contains zero or more child // tokens, one of which is usually the root element. The embedded element may // include other children such as processing instruction tokens or character // data tokens. The document's embedded element is never directly serialized; // only its children are. // // A document also contains read and write settings, which influence the way // the document is deserialized, serialized, and indented. type Document struct { Element ReadSettings ReadSettings WriteSettings WriteSettings } // An Element represents an XML element, its attributes, and its child tokens. type Element struct { Space, Tag string // namespace prefix and tag Attr []Attr // key-value attribute pairs Child []Token // child tokens (elements, comments, etc.) parent *Element // parent element index int // token index in parent's children } // An Attr represents a key-value attribute within an XML element. type Attr struct { Space, Key string // The attribute's namespace prefix and key Value string // The attribute value string element *Element // element containing the attribute } // charDataFlags are used with CharData tokens to store additional settings. type charDataFlags uint8 const ( // The CharData contains only whitespace. whitespaceFlag charDataFlags = 1 << iota // The CharData contains a CDATA section. cdataFlag ) // CharData may be used to represent simple text data or a CDATA section // within an XML document. The Data property should never be modified // directly; use the SetData function instead. type CharData struct { Data string // the simple text or CDATA section content parent *Element index int flags charDataFlags } // A Comment represents an XML comment. type Comment struct { Data string // the comment's text parent *Element index int } // A Directive represents an XML directive. type Directive struct { Data string // the directive string parent *Element index int } // A ProcInst represents an XML processing instruction. type ProcInst struct { Target string // the processing instruction target Inst string // the processing instruction value parent *Element index int } // NewDocument creates an XML document without a root element. func NewDocument() *Document { return &Document{ Element: Element{Child: make([]Token, 0)}, } } // NewDocumentWithRoot creates an XML document and sets the element 'e' as its // root element. If the element 'e' is already part of another document, it is // first removed from its existing document. func NewDocumentWithRoot(e *Element) *Document { d := NewDocument() d.SetRoot(e) return d } // Copy returns a recursive, deep copy of the document. func (d *Document) Copy() *Document { return &Document{ Element: *(d.Element.dup(nil).(*Element)), ReadSettings: d.ReadSettings.dup(), WriteSettings: d.WriteSettings.dup(), } } // Root returns the root element of the document. It returns nil if there is // no root element. func (d *Document) Root() *Element { for _, t := range d.Child { if c, ok := t.(*Element); ok { return c } } return nil } // SetRoot replaces the document's root element with the element 'e'. If the // document already has a root element when this function is called, then the // existing root element is unbound from the document. If the element 'e' is // part of another document, then it is unbound from the other document. func (d *Document) SetRoot(e *Element) { if e.parent != nil { e.parent.RemoveChild(e) } // If there is already a root element, replace it. p := &d.Element for i, t := range p.Child { if _, ok := t.(*Element); ok { t.setParent(nil) t.setIndex(-1) p.Child[i] = e e.setParent(p) e.setIndex(i) return } } // No existing root element, so add it. p.addChild(e) } // ReadFrom reads XML from the reader 'r' into this document. The function // returns the number of bytes read and any error encountered. func (d *Document) ReadFrom(r io.Reader) (n int64, err error) { if d.ReadSettings.ValidateInput { b, err := io.ReadAll(r) if err != nil { return 0, err } if err := validateXML(bytes.NewReader(b), d.ReadSettings); err != nil { return 0, err } r = bytes.NewReader(b) } return d.Element.readFrom(r, d.ReadSettings) } // ReadFromFile reads XML from a local file at path 'filepath' into this // document. func (d *Document) ReadFromFile(filepath string) error { f, err := os.Open(filepath) if err != nil { return err } defer f.Close() _, err = d.ReadFrom(f) return err } // ReadFromBytes reads XML from the byte slice 'b' into the this document. func (d *Document) ReadFromBytes(b []byte) error { if d.ReadSettings.ValidateInput { if err := validateXML(bytes.NewReader(b), d.ReadSettings); err != nil { return err } } _, err := d.Element.readFrom(bytes.NewReader(b), d.ReadSettings) return err } // ReadFromString reads XML from the string 's' into this document. func (d *Document) ReadFromString(s string) error { if d.ReadSettings.ValidateInput { if err := validateXML(strings.NewReader(s), d.ReadSettings); err != nil { return err } } _, err := d.Element.readFrom(strings.NewReader(s), d.ReadSettings) return err } // validateXML determines if the data read from the reader 'r' contains // well-formed XML according to the rules set by the go xml package. func validateXML(r io.Reader, settings ReadSettings) error { dec := newDecoder(r, settings) err := dec.Decode(new(interface{})) if err != nil { return err } // If there are any trailing tokens after unmarshalling with Decode(), // then the XML input didn't terminate properly. _, err = dec.Token() if err == io.EOF { return nil } return ErrXML } // newDecoder creates an XML decoder for the reader 'r' configured using // the provided read settings. func newDecoder(r io.Reader, settings ReadSettings) *xml.Decoder { d := xml.NewDecoder(r) d.CharsetReader = settings.CharsetReader if d.CharsetReader == nil { d.CharsetReader = defaultCharsetReader } d.Strict = !settings.Permissive d.Entity = settings.Entity d.AutoClose = settings.AutoClose return d } // WriteTo serializes the document out to the writer 'w'. The function returns // the number of bytes written and any error encountered. func (d *Document) WriteTo(w io.Writer) (n int64, err error) { xw := newXmlWriter(w) b := bufio.NewWriter(xw) for _, c := range d.Child { c.WriteTo(b, &d.WriteSettings) } err, n = b.Flush(), xw.bytes return } // WriteToFile serializes the document out to the file at path 'filepath'. func (d *Document) WriteToFile(filepath string) error { f, err := os.Create(filepath) if err != nil { return err } defer f.Close() _, err = d.WriteTo(f) return err } // WriteToBytes serializes this document into a slice of bytes. func (d *Document) WriteToBytes() (b []byte, err error) { var buf bytes.Buffer if _, err = d.WriteTo(&buf); err != nil { return } return buf.Bytes(), nil } // WriteToString serializes this document into a string. func (d *Document) WriteToString() (s string, err error) { var b []byte if b, err = d.WriteToBytes(); err != nil { return } return string(b), nil } // Indent modifies the document's element tree by inserting character data // tokens containing newlines and spaces for indentation. The amount of // indentation per depth level is given by the 'spaces' parameter. Other than // the number of spaces, default IndentSettings are used. func (d *Document) Indent(spaces int) { s := NewIndentSettings() s.Spaces = spaces d.IndentWithSettings(s) } // IndentTabs modifies the document's element tree by inserting CharData // tokens containing newlines and tabs for indentation. One tab is used per // indentation level. Other than the use of tabs, default IndentSettings // are used. func (d *Document) IndentTabs() { s := NewIndentSettings() s.UseTabs = true d.IndentWithSettings(s) } // IndentWithSettings modifies the document's element tree by inserting // character data tokens containing newlines and indentation. The behavior // of the indentation algorithm is configured by the indent settings. func (d *Document) IndentWithSettings(s *IndentSettings) { // WriteSettings.UseCRLF is deprecated. Until removed from the package, it // overrides IndentSettings.UseCRLF when true. if d.WriteSettings.UseCRLF { s.UseCRLF = true } d.Element.indent(0, getIndentFunc(s), s) if s.SuppressTrailingWhitespace { d.Element.stripTrailingWhitespace() } } // Unindent modifies the document's element tree by removing character data // tokens containing only whitespace. Other than the removal of indentation, // default IndentSettings are used. func (d *Document) Unindent() { s := NewIndentSettings() s.Spaces = NoIndent d.IndentWithSettings(s) } // NewElement creates an unparented element with the specified tag (i.e., // name). The tag may include a namespace prefix followed by a colon. func NewElement(tag string) *Element { space, stag := spaceDecompose(tag) return newElement(space, stag, nil) } // newElement is a helper function that creates an element and binds it to // a parent element if possible. func newElement(space, tag string, parent *Element) *Element { e := &Element{ Space: space, Tag: tag, Attr: make([]Attr, 0), Child: make([]Token, 0), parent: parent, index: -1, } if parent != nil { parent.addChild(e) } return e } // Copy creates a recursive, deep copy of the element and all its attributes // and children. The returned element has no parent but can be parented to a // another element using AddChild, or added to a document with SetRoot or // NewDocumentWithRoot. func (e *Element) Copy() *Element { return e.dup(nil).(*Element) } // FullTag returns the element e's complete tag, including namespace prefix if // present. func (e *Element) FullTag() string { if e.Space == "" { return e.Tag } return e.Space + ":" + e.Tag } // NamespaceURI returns the XML namespace URI associated with the element. If // the element is part of the XML default namespace, NamespaceURI returns the // empty string. func (e *Element) NamespaceURI() string { if e.Space == "" { return e.findDefaultNamespaceURI() } return e.findLocalNamespaceURI(e.Space) } // findLocalNamespaceURI finds the namespace URI corresponding to the // requested prefix. func (e *Element) findLocalNamespaceURI(prefix string) string { for _, a := range e.Attr { if a.Space == "xmlns" && a.Key == prefix { return a.Value } } if e.parent == nil { return "" } return e.parent.findLocalNamespaceURI(prefix) } // findDefaultNamespaceURI finds the default namespace URI of the element. func (e *Element) findDefaultNamespaceURI() string { for _, a := range e.Attr { if a.Space == "" && a.Key == "xmlns" { return a.Value } } if e.parent == nil { return "" } return e.parent.findDefaultNamespaceURI() } // namespacePrefix returns the namespace prefix associated with the element. func (e *Element) namespacePrefix() string { return e.Space } // name returns the tag associated with the element. func (e *Element) name() string { return e.Tag } // ReindexChildren recalculates the index values of the element's child // tokens. This is necessary only if you have manually manipulated the // element's `Child` array. func (e *Element) ReindexChildren() { for i := 0; i < len(e.Child); i++ { e.Child[i].setIndex(i) } } // Text returns all character data immediately following the element's opening // tag. func (e *Element) Text() string { if len(e.Child) == 0 { return "" } var text string var b strings.Builder for _, ch := range e.Child { if cd, ok := ch.(*CharData); ok { if text == "" { text = cd.Data } else { if b.Len() == 0 { b.WriteString(text) } b.WriteString(cd.Data) } } else if _, ok := ch.(*Comment); ok { // ignore } else { break } } if b.Len() > 0 { return b.String() } return text } // SetText replaces all character data immediately following an element's // opening tag with the requested string. func (e *Element) SetText(text string) { e.replaceText(0, text, 0) } // SetCData replaces all character data immediately following an element's // opening tag with a CDATA section. func (e *Element) SetCData(text string) { e.replaceText(0, text, cdataFlag) } // Tail returns all character data immediately following the element's end // tag. func (e *Element) Tail() string { if e.Parent() == nil { return "" } p := e.Parent() i := e.Index() var text string var b strings.Builder for _, ch := range p.Child[i+1:] { if cd, ok := ch.(*CharData); ok { if text == "" { text = cd.Data } else { if b.Len() == 0 { b.WriteString(text) } b.WriteString(cd.Data) } } else { break } } if b.Len() > 0 { return b.String() } return text } // SetTail replaces all character data immediately following the element's end // tag with the requested string. func (e *Element) SetTail(text string) { if e.Parent() == nil { return } p := e.Parent() p.replaceText(e.Index()+1, text, 0) } // replaceText is a helper function that replaces a series of chardata tokens // starting at index i with the requested text. func (e *Element) replaceText(i int, text string, flags charDataFlags) { end := e.findTermCharDataIndex(i) switch { case end == i: if text != "" { // insert a new chardata token at index i cd := newCharData(text, flags, nil) e.InsertChildAt(i, cd) } case end == i+1: if text == "" { // remove the chardata token at index i e.RemoveChildAt(i) } else { // replace the first and only character token at index i cd := e.Child[i].(*CharData) cd.Data, cd.flags = text, flags } default: if text == "" { // remove all chardata tokens starting from index i copy(e.Child[i:], e.Child[end:]) removed := end - i e.Child = e.Child[:len(e.Child)-removed] for j := i; j < len(e.Child); j++ { e.Child[j].setIndex(j) } } else { // replace the first chardata token at index i and remove all // subsequent chardata tokens cd := e.Child[i].(*CharData) cd.Data, cd.flags = text, flags copy(e.Child[i+1:], e.Child[end:]) removed := end - (i + 1) e.Child = e.Child[:len(e.Child)-removed] for j := i + 1; j < len(e.Child); j++ { e.Child[j].setIndex(j) } } } } // findTermCharDataIndex finds the index of the first child token that isn't // a CharData token. It starts from the requested start index. func (e *Element) findTermCharDataIndex(start int) int { for i := start; i < len(e.Child); i++ { if _, ok := e.Child[i].(*CharData); !ok { return i } } return len(e.Child) } // CreateElement creates a new element with the specified tag (i.e., name) and // adds it as the last child of element 'e'. The tag may include a prefix // followed by a colon. func (e *Element) CreateElement(tag string) *Element { space, stag := spaceDecompose(tag) return newElement(space, stag, e) } // CreateChild performs the same task as CreateElement but calls a // continuation function after the child element is created, allowing // additional actions to be performed on the child element before returning. // // This method of element creation is particularly useful when building nested // XML documents from code. For example: // // org := doc.CreateChild("organization", func(e *Element) { // e.CreateComment("Mary") // e.CreateChild("person", func(e *Element) { // e.CreateAttr("name", "Mary") // e.CreateAttr("age", "30") // e.CreateAttr("hair", "brown") // }) // }) func (e *Element) CreateChild(tag string, cont func(e *Element)) *Element { child := e.CreateElement(tag) cont(child) return child } // AddChild adds the token 't' as the last child of the element. If token 't' // was already the child of another element, it is first removed from its // parent element. func (e *Element) AddChild(t Token) { if t.Parent() != nil { t.Parent().RemoveChild(t) } e.addChild(t) } // InsertChild inserts the token 't' into this element's list of children just // before the element's existing child token 'ex'. If the existing element // 'ex' does not appear in this element's list of child tokens, then 't' is // added to the end of this element's list of child tokens. If token 't' is // already the child of another element, it is first removed from the other // element's list of child tokens. // // Deprecated: InsertChild is deprecated. Use InsertChildAt instead. func (e *Element) InsertChild(ex Token, t Token) { if ex == nil || ex.Parent() != e { e.AddChild(t) return } if t.Parent() != nil { t.Parent().RemoveChild(t) } t.setParent(e) i := ex.Index() e.Child = append(e.Child, nil) copy(e.Child[i+1:], e.Child[i:]) e.Child[i] = t for j := i; j < len(e.Child); j++ { e.Child[j].setIndex(j) } } // InsertChildAt inserts the token 't' into this element's list of child // tokens just before the requested 'index'. If the index is greater than or // equal to the length of the list of child tokens, then the token 't' is // added to the end of the list of child tokens. func (e *Element) InsertChildAt(index int, t Token) { if index >= len(e.Child) { e.AddChild(t) return } if t.Parent() != nil { if t.Parent() == e && t.Index() < index { index-- } t.Parent().RemoveChild(t) } t.setParent(e) e.Child = append(e.Child, nil) copy(e.Child[index+1:], e.Child[index:]) e.Child[index] = t for j := index; j < len(e.Child); j++ { e.Child[j].setIndex(j) } } // RemoveChild attempts to remove the token 't' from this element's list of // child tokens. If the token 't' was a child of this element, then it is // removed and returned. Otherwise, nil is returned. func (e *Element) RemoveChild(t Token) Token { if t.Parent() != e { return nil } return e.RemoveChildAt(t.Index()) } // RemoveChildAt removes the child token appearing in slot 'index' of this // element's list of child tokens. The removed child token is then returned. // If the index is out of bounds, no child is removed and nil is returned. func (e *Element) RemoveChildAt(index int) Token { if index >= len(e.Child) { return nil } t := e.Child[index] for j := index + 1; j < len(e.Child); j++ { e.Child[j].setIndex(j - 1) } e.Child = append(e.Child[:index], e.Child[index+1:]...) t.setIndex(-1) t.setParent(nil) return t } // autoClose analyzes the stack's top element and the current token to decide // whether the top element should be closed. func (e *Element) autoClose(stack *stack[*Element], t xml.Token, tags []string) { if stack.empty() { return } top := stack.peek() for _, tag := range tags { if strings.EqualFold(tag, top.FullTag()) { if e, ok := t.(xml.EndElement); !ok || !strings.EqualFold(e.Name.Space, top.Space) || !strings.EqualFold(e.Name.Local, top.Tag) { stack.pop() } break } } } // ReadFrom reads XML from the reader 'ri' and stores the result as a new // child of this element. func (e *Element) readFrom(ri io.Reader, settings ReadSettings) (n int64, err error) { var r xmlReader var pr *xmlPeekReader if settings.PreserveCData { pr = newXmlPeekReader(ri) r = pr } else { r = newXmlSimpleReader(ri) } attrCheck := make(map[xml.Name]int) dec := newDecoder(r, settings) maxDepth := settings.MaxDepth if maxDepth <= 0 { maxDepth = defaultMaxDepth } var stack stack[*Element] stack.push(e) for { if pr != nil { pr.PeekPrepare(dec.InputOffset(), len(cdataPrefix)) } t, err := dec.RawToken() if settings.Permissive && settings.AutoClose != nil { e.autoClose(&stack, t, settings.AutoClose) } switch { case err == io.EOF: if len(stack.data) != 1 { return r.Bytes(), ErrXML } return r.Bytes(), nil case err != nil: return r.Bytes(), err case stack.empty(): return r.Bytes(), ErrXML } top := stack.peek() switch t := t.(type) { case xml.StartElement: if len(stack.data) > maxDepth { return r.Bytes(), ErrMaxDepth } e := newElement(t.Name.Space, t.Name.Local, top) if settings.PreserveDuplicateAttrs || len(t.Attr) < 2 { for _, a := range t.Attr { e.addAttr(a.Name.Space, a.Name.Local, a.Value) } } else { for _, a := range t.Attr { if i, contains := attrCheck[a.Name]; contains { e.Attr[i].Value = a.Value } else { attrCheck[a.Name] = e.addAttr(a.Name.Space, a.Name.Local, a.Value) } } clear(attrCheck) } stack.push(e) case xml.EndElement: if top.Tag != t.Name.Local || top.Space != t.Name.Space { return r.Bytes(), ErrXML } stack.pop() case xml.CharData: data := string(t) var flags charDataFlags if pr != nil { |
| You are visitor 01402622 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |