Class: REXML::Document

Inherits:
Element show all
Defined in:
lib/rexml/document.rb

Overview

Represents a full XML document, including PIs, a doctype, etc. A Document has a single child that can be accessed by root(). Note that if you want to have an XML declaration written for a document you create, you must add one; REXML documents do not write a default

Constant Summary collapse

DECLARATION =

DEPRECATED Use: mydoc << XMLDecl.default

XMLDecl.default
@@entity_expansion_limit = 
10_000

Constants inherited from Element

Element::UNDEFINED

Constants included from Namespace

Namespace::NAMESPLIT

Constants included from XMLTokens

XMLTokens::NAME, XMLTokens::NAMECHAR, XMLTokens::NAME_STR, XMLTokens::NCNAME_STR, XMLTokens::NMTOKEN, XMLTokens::NMTOKENS, XMLTokens::REFERENCE

Instance Attribute Summary collapse

Attributes inherited from Element

#attributes, #context, #elements

Attributes included from Namespace

#prefix

Attributes inherited from Child

#parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Element

#add_attribute, #add_attributes, #add_namespace, #add_text, #attribute, #cdatas, #comments, #delete_attribute, #delete_element, #delete_namespace, #document, #each_element, #each_element_with_attribute, #each_element_with_text, #get_elements, #get_text, #has_attributes?, #has_elements?, #has_text?, #ignore_whitespace_nodes, #inspect, #instructions, #namespace, #namespaces, #next_element, #prefixes, #previous_element, #raw, #root_node, #text, #text=, #texts, #whitespace, #xpath

Methods included from Namespace

#fully_expanded_name, #has_name?

Methods inherited from Parent

#[], #[]=, #deep_clone, #delete, #delete_at, #delete_if, #each, #each_index, #index, #insert_after, #insert_before, #parent?, #replace_child, #size, #to_a, #unshift

Methods inherited from Child

#bytes, #document, #next_sibling=, #previous_sibling=, #remove, #replace_with

Methods included from Node

#each_recursive, #find_first_recursive, #indent, #index_in_parent, #next_sibling_node, #parent?, #previous_sibling_node, #to_s

Constructor Details

#initialize(source = nil, context = {}) ⇒ Document

Strings are expected to be valid XML documents. IOs are expected to be sources of valid XML documents. this should be a Hash.

Parameters:

  • context (defaults to: {}) —

    if supplied, contains the context of the document;



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rexml/document.rb', line 34

def initialize( source = nil, context = {} )
    @entity_expansion_count = 0
	super()
	@context = context
	return if source.nil?
	if source.kind_of? Document
		@context = source.context
		super source
	else
		build(  source )
	end
end

Instance Attribute Details

#entity_expansion_count ⇒ Object (readonly)

Returns the value of attribute entity_expansion_count



216
217
218
 
# File 'lib/rexml/document.rb', line 216

def entity_expansion_count
  @entity_expansion_count
end

Class Method Details

.entity_expansion_limit ⇒ Object

Get the entity expansion limit. By default the limit is set to 10000.



212
213
214
 
# File 'lib/rexml/document.rb', line 212

def Document::entity_expansion_limit
  return @@entity_expansion_limit
end

.entity_expansion_limit=(val) ⇒ Object

Set the entity expansion limit. By default the limit is set to 10000.



207
208
209
 
# File 'lib/rexml/document.rb', line 207

def Document::entity_expansion_limit=( val )
  @@entity_expansion_limit = val
end

.parse_stream(source, listener) ⇒ Object 



200
201
202
 
# File 'lib/rexml/document.rb', line 200

def Document::parse_stream( source, listener )
	Parsers::StreamParser.new( source, listener ).parse
end

Instance Method Details

#add(child) ⇒ Object Also known as: <<

We override this, because XMLDecls and DocTypes must go at the start of the document



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
 
# File 'lib/rexml/document.rb', line 67

def add( child )
	if child.kind_of? XMLDecl
		@children.unshift child
      child.parent = self
	elsif child.kind_of? DocType
      # Find first Element or DocType node and insert the decl right 
      # before it.  If there is no such node, just insert the child at the
      # end.  If there is a child and it is an DocType, then replace it.
      insert_before_index = 0
      @children.find { |x| 
        insert_before_index += 1
        x.kind_of?(Element) || x.kind_of?(DocType)
      }
      if @children[ insert_before_index ] # Not null = not end of list
        if @children[ insert_before_index ].kind_of DocType
          @children[ insert_before_index ] = child
        else
          @children[ index_before_index-1, 0 ] = child
        end
      else  # Insert at end of list
        @children[insert_before_index] = child
      end
		child.parent = self
	else
		rv = super
		raise "attempted adding second root element to document" if @elements.size > 1
		rv
	end
end

#add_element(arg = nil, arg2 = nil) ⇒ Object 



98
99
100
101
102
 
# File 'lib/rexml/document.rb', line 98

def add_element(arg=nil, arg2=nil)
	rv = super
	raise "attempted adding second root element to document" if @elements.size > 1
	rv
end

#clone ⇒ Object

Should be obvious



52
53
54
 
# File 'lib/rexml/document.rb', line 52

def clone
	Document.new self
end

#doctype ⇒ Object

and nil otherwise.

Returns:

  • the DocType child of the document, if one exists,



114
115
116
 
# File 'lib/rexml/document.rb', line 114

def doctype
	@children.find { |item| item.kind_of? DocType }
end

#encoding ⇒ Object

If no XMLDecl has been set, returns the default encoding.

Returns:

  • the XMLDecl encoding of this document as a String.



134
135
136
 
# File 'lib/rexml/document.rb', line 134

def encoding
	xml_decl().encoding
end

#expanded_name ⇒ Object Also known as: name

According to the XML spec, a root node has no expanded name



57
58
59
60
61
 
# File 'lib/rexml/document.rb', line 57

def expanded_name
	''
	#d = doc_type
	#d ? d.name : "UNDEFINED"
end

#node_type ⇒ Object 



47
48
49
 
# File 'lib/rexml/document.rb', line 47

def node_type
  :document
end

#record_entity_expansion ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/rexml/document.rb', line 218

def record_entity_expansion
  @entity_expansion_count += 1
  if @entity_expansion_count > @@entity_expansion_limit
    raise "number of entity expansions exceeded, processing aborted."
  end
end

#root ⇒ Object

has no children.

Returns:

  • the root Element of the document, or nil if this document



106
107
108
109
110
 
# File 'lib/rexml/document.rb', line 106

def root
    elements[1]
    #self
    #@children.find { |item| item.kind_of? Element }
end

#stand_alone? ⇒ Boolean

If no XMLDecl has been set, returns the default setting.

Returns:

  • (Boolean) —

    the XMLDecl standalone value of this document as a String.



140
141
142
 
# File 'lib/rexml/document.rb', line 140

def stand_alone?
	xml_decl().stand_alone?
end

#version ⇒ Object

If no XMLDecl has been set, returns the default version.

Returns:

  • the XMLDecl version of this document as a String.



128
129
130
 
# File 'lib/rexml/document.rb', line 128

def version
	xml_decl().version
end

#write(output = $stdout, indent = 1, trans = false, ie_hack = false) ⇒ Object

Write the XML tree out, optionally with indent. This writes out the entire XML document, including XML declarations, doctype declarations, and processing instructions (if any are given).

A controversial point is whether Document should always write the XML declaration (<?xml version='1.0'?>) whether or not one is given by the user (or source document). REXML does not write one if one was not specified, because it adds unneccessary bandwidth to applications such as XML-RPC.

See also the classes in the rexml/formatters package for the proper way to change the default formatting of XML output

Examples

Document.new("<a><b/></a>").serialize

output_string = ""
tr = Transitive.new( output_string )
Document.new("<a><b/></a>").serialize( tr )
output

output an object which supports '<< string'; this is where the document will be written.

indent

An integer. If -1, no indenting will be used; otherwise, the indentation will be twice this number of spaces, and children will be indented an additional amount. For a value of 3, every item will be indented 3 more levels, or 6 more spaces (2 * 3). Defaults to -1

trans

If transitive is true and indent is >= 0, then the output will be pretty-printed in such a way that the added whitespace does not affect the absolute value of the document -- that is, it leaves the value and number of Text nodes in the document unchanged.

ie_hack

Internet Explorer is the worst piece of crap to have ever been written, with the possible exception of Windows itself. Since IE is unable to parse proper XML, we have to provide a hack to generate XML that IE's limited abilities can handle. This hack inserts a space before the /> on empty tags. Defaults to false



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/rexml/document.rb', line 183

def write( output=$stdout, indent=-1, trans=false, ie_hack=false )
    if xml_decl.encoding != "UTF-8" && !output.kind_of?(Output)
      output = Output.new( output, xml_decl.encoding )
    end
    formatter = if indent > -1
        if trans
          REXML::Formatters::Transitive.new( indent, ie_hack )
        else
          REXML::Formatters::Pretty.new( indent, ie_hack )
        end
      else
        REXML::Formatters::Default.new( ie_hack )
      end
    formatter.write( self, output )
end

#xml_decl ⇒ Object

set, the default declaration is returned.

Returns:

  • the XMLDecl of this document; if no XMLDecl has been



120
121
122
123
124
 
# File 'lib/rexml/document.rb', line 120

def xml_decl
	rv = @children[0]
    return rv if rv.kind_of? XMLDecl
    rv = @children.unshift(XMLDecl.default)[0]
end