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
|
# encoding: UTF-8
module LibXML
module XML
class Document
# call-seq:
# XML::Document.document(document) -> XML::Document
#
# Creates a new document based on the specified document.
#
# Parameters:
#
# document - A preparsed document.
def self.document(value)
Parser.document(value).parse
end
# call-seq:
# XML::Document.file(path) -> XML::Document
# XML::Document.file(path, :encoding => XML::Encoding::UTF_8,
# :options => XML::Parser::Options::NOENT) -> XML::Document
#
# Creates a new document from the specified file or uri.
#
# You may provide an optional hash table to control how the
# parsing is performed. Valid options are:
#
# encoding - The document encoding, defaults to nil. Valid values
# are the encoding constants defined on XML::Encoding.
# options - Parser options. Valid values are the constants defined on
# XML::Parser::Options. Mutliple options can be combined
# by using Bitwise OR (|).
def self.file(value, options = {})
Parser.file(value, options).parse
end
# call-seq:
# XML::Document.io(io) -> XML::Document
# XML::Document.io(io, :encoding => XML::Encoding::UTF_8,
# :options => XML::Parser::Options::NOENT
# :base_uri="http://libxml.org") -> XML::Document
#
# Creates a new document from the specified io object.
#
# Parameters:
#
# io - io object that contains the xml to parser
# base_uri - The base url for the parsed document.
# encoding - The document encoding, defaults to nil. Valid values
# are the encoding constants defined on XML::Encoding.
# options - Parser options. Valid values are the constants defined on
# XML::Parser::Options. Mutliple options can be combined
# by using Bitwise OR (|).
def self.io(value, options = {})
Parser.io(value, options).parse
end
# call-seq:
# XML::Document.string(string) -> XML::Document
# XML::Document.string(string, :encoding => XML::Encoding::UTF_8,
# :options => XML::Parser::Options::NOENT
# :base_uri="http://libxml.org") -> XML::Document
#
# Creates a new document from the specified string.
#
# You may provide an optional hash table to control how the
# parsing is performed. Valid options are:
#
# base_uri - The base url for the parsed document.
# encoding - The document encoding, defaults to nil. Valid values
# are the encoding constants defined on XML::Encoding.
# options - Parser options. Valid values are the constants defined on
# XML::Parser::Options. Mutliple options can be combined
# by using Bitwise OR (|).
def self.string(value, options = {})
Parser.string(value, options).parse
end
# Returns a new XML::XPathContext for the document.
#
# call-seq:
# document.context(namespaces=nil) -> XPath::Context
#
# Namespaces is an optional array of XML::NS objects
def context(nslist = nil)
context = XPath::Context.new(self)
context.node = self.root
context.register_namespaces_from_node(self.root)
context.register_namespaces(nslist) if nslist
context
end
# Return the nodes matching the specified xpath expression,
# optionally using the specified namespace. For more
# information about working with namespaces, please refer
# to the XML::XPath documentation.
#
# call-seq:
# document.find(xpath, nslist=nil) -> XML::XPath::Object
#
# Parameters:
# * xpath - The xpath expression as a string
# * namespaces - An optional list of namespaces (see XML::XPath for information).
#
# document.find('/foo', 'xlink:http://www.w3.org/1999/xlink')
#
# IMPORTANT - The returned XML::Node::Set must be freed before
# its associated document. In a running Ruby program this will
# happen automatically via Ruby's mark and sweep garbage collector.
# However, if the program exits, Ruby does not guarantee the order
# in which objects are freed
# (see http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-core/17700).
# As a result, the associated document may be freed before the node
# list, which will cause a segmentation fault.
# To avoid this, use the following (non-ruby like) coding style:
#
# nodes = doc.find('/header')
# nodes.each do |node|
# ... do stuff ...
# end
# # nodes = nil # GC.start
def find(xpath, nslist = nil)
self.context(nslist).find(xpath)
end
# Return the first node matching the specified xpath expression.
# For more information, please refer to the documentation
# for XML::Document#find.
def find_first(xpath, nslist = nil)
find(xpath, nslist).first
end
# Returns this node's type name
def node_type_name
case node_type
when XML::Node::DOCUMENT_NODE
'document_xml'
when XML::Node::DOCB_DOCUMENT_NODE
'document_docbook'
when XML::Node::HTML_DOCUMENT_NODE
'document_html'
else
raise(UnknownType, "Unknown node type: %n", node.node_type);
end
end
# :enddoc:
# Specifies if this is an document node
def document?
node_type == XML::Node::DOCUMENT_NODE
end
# Specifies if this is an docbook node
def docbook_doc?
node_type == XML::Node::DOCB_DOCUMENT_NODE
end
# Specifies if this is an html node
def html_doc?
node_type == XML::Node::HTML_DOCUMENT_NODE
end
def dump
warn('Document#dump is deprecated. Use Document#to_s instead.')
self.to_s
end
def format_dump
warn('Document#format_dump is deprecated. Use Document#to_s instead.')
self.to_s
end
def debug_dump
warn('Document#debug_dump is deprecated. Use Document#debug instead.')
self.debug
end
def debug_dump_head
warn('Document#debug_dump_head is deprecated. Use Document#debug instead.')
self.debug
end
def debug_format_dump
warn('Document#debug_format_dump is deprecated. Use Document#to_s instead.')
self.to_s
end
def reader
warn('Document#reader is deprecated. Use XML::Reader.document(self) instead.')
XML::Reader.document(self)
end
end
end
end
|
