Class: LibXML::XML::Node
- Inherits:
-
Object
- Object
- LibXML::XML::Node
- Includes:
- Enumerable
- Defined in:
- ext/libxml/ruby_xml_node.c,
lib/libxml/node.rb,
lib/libxml/properties.rb,
ext/libxml/ruby_xml_node.c
Overview
Nodes are the primary objects that make up an XML document. The node class represents most node types that are found in an XML document (but not LibXML::XML::Attributes, see LibXML::XML::Attr). It exposes libxml’s full API for creating, querying moving and deleting node objects. Many of these methods are documented in the DOM Level 3 specification found at: www.w3.org/TR/DOM-Level-3-Core/.
Constant Summary collapse
- SPACE_DEFAULT =
INT2NUM(0)
- SPACE_PRESERVE =
INT2NUM(1)
- SPACE_NOT_INHERIT =
INT2NUM(-1)
- XLINK_ACTUATE_AUTO =
INT2NUM(1)
- XLINK_ACTUATE_NONE =
INT2NUM(0)
- XLINK_ACTUATE_ONREQUEST =
INT2NUM(2)
- XLINK_SHOW_EMBED =
INT2NUM(2)
- XLINK_SHOW_NEW =
INT2NUM(1)
- XLINK_SHOW_NONE =
INT2NUM(0)
- XLINK_SHOW_REPLACE =
INT2NUM(3)
- XLINK_TYPE_EXTENDED =
INT2NUM(2)
- XLINK_TYPE_EXTENDED_SET =
INT2NUM(3)
- XLINK_TYPE_NONE =
INT2NUM(0)
- XLINK_TYPE_SIMPLE =
INT2NUM(1)
- ELEMENT_NODE =
INT2FIX(XML_ELEMENT_NODE)
- ATTRIBUTE_NODE =
INT2FIX(XML_ATTRIBUTE_NODE)
- TEXT_NODE =
INT2FIX(XML_TEXT_NODE)
- CDATA_SECTION_NODE =
INT2FIX(XML_CDATA_SECTION_NODE)
- ENTITY_REF_NODE =
INT2FIX(XML_ENTITY_REF_NODE)
- ENTITY_NODE =
INT2FIX(XML_ENTITY_NODE)
- PI_NODE =
INT2FIX(XML_PI_NODE)
- COMMENT_NODE =
INT2FIX(XML_COMMENT_NODE)
- DOCUMENT_NODE =
INT2FIX(XML_DOCUMENT_NODE)
- DOCUMENT_TYPE_NODE =
INT2FIX(XML_DOCUMENT_TYPE_NODE)
- DOCUMENT_FRAG_NODE =
INT2FIX(XML_DOCUMENT_FRAG_NODE)
- NOTATION_NODE =
INT2FIX(XML_NOTATION_NODE)
- HTML_DOCUMENT_NODE =
INT2FIX(XML_HTML_DOCUMENT_NODE)
- DTD_NODE =
INT2FIX(XML_DTD_NODE)
- ELEMENT_DECL =
INT2FIX(XML_ELEMENT_DECL)
- ATTRIBUTE_DECL =
INT2FIX(XML_ATTRIBUTE_DECL)
- ENTITY_DECL =
INT2FIX(XML_ENTITY_DECL)
- NAMESPACE_DECL =
INT2FIX(XML_NAMESPACE_DECL)
- XINCLUDE_START =
INT2FIX(XML_XINCLUDE_START)
- XINCLUDE_END =
INT2FIX(XML_XINCLUDE_END)
- DOCB_DOCUMENT_NODE =
Qnil
Class Method Summary collapse
-
.XML::Node.new_cdata(content = nil) ⇒ XML::Node
Create a new #CDATA node, optionally setting the node’s content.
-
.XML::Node.new_comment(content = nil) ⇒ XML::Node
Create a new comment node, optionally setting the node’s content.
-
.XML::Node.new_pi(name, content = nil) ⇒ XML::Node
Create a new pi node, optionally setting the node’s content.
-
.XML::Node.new_text(content) ⇒ XML::Node
Create a new text node.
Instance Method Summary collapse
-
#<<(obj) ⇒ Object
Add the specified text or XML::Node as a new child node to the current node.
-
#[](name) ⇒ Object
Obtain the named property.
-
#[]=("name") ⇒ Object
Set the named property.
-
#attribute? ⇒ Boolean
Specifies if this is an attribute node.
-
#attribute_decl? ⇒ Boolean
Specifies if this is an attribute declaration node.
-
#attributes ⇒ Object
Returns the XML::Attributes for this node.
-
#attributes? ⇒ Boolean
Determines whether this node has attributes.
- #base ⇒ Object
- #base=(value) ⇒ Object
-
#base_uri ⇒ Object
Obtain this node’s base URI.
-
#base_uri=(uri) ⇒ Object
Set this node’s base URI.
-
#empty? ⇒ Boolean
Determine whether this node is an empty or whitespace only text-node.
-
#cdata? ⇒ Boolean
Specifies if this is an CDATA node.
- #child=(node) ⇒ Object
-
#child_add(node) ⇒ Object
— Deprecated DOM Manipulation —.
-
#children ⇒ Object
Returns this node’s children as an array.
-
#clone ⇒ Object
Create a shallow copy of the node.
-
#comment? ⇒ Boolean
Specifies if this is an comment node.
-
#content ⇒ Object
Obtain this node’s content as a string.
-
#content=(content) ⇒ Object
Set this node’s content to the specified string.
-
#content_stripped ⇒ Object
Obtain this node’s stripped content.
-
#context(nslist = nil) ⇒ Object
call-seq: node.context(namespaces=nil) -> XPath::Context.
-
#copy ⇒ XML::Node
Creates a copy of this node.
-
#debug ⇒ Object
Print libxml debugging information to stdout.
-
#doc ⇒ Object
Obtain the XML::Document this node belongs to.
-
#docbook_doc? ⇒ Boolean
Specifies if this is an docbook node.
-
#doctype? ⇒ Boolean
Specifies if this is an doctype node.
-
#document? ⇒ Boolean
Specifies if this is an document node.
-
#dtd? ⇒ Boolean
Specifies if this is an DTD node.
-
#dump ⇒ Object
— Deprecated Output — :stopdoc:.
-
#dup ⇒ Object
:call-seq: node.dup -> XML::Node.
-
#each ⇒ XML::Node
(also: #each_child)
Iterates over this node’s children, including text nodes, element nodes, etc.
-
#each_attr ⇒ Object
——- Traversal —————- Iterates over this node’s attributes.
-
#each_element ⇒ Object
Iterates over this node’s child elements (nodes that have a node_type == ELEMENT_NODE).
-
#element? ⇒ Boolean
Specifies if this is an element node.
-
#element_decl? ⇒ Boolean
Specifies if this is an element declaration node.
-
#empty? ⇒ Boolean
Determine whether this node is an empty or whitespace only text-node.
-
#entity? ⇒ Boolean
Specifies if this is an entity node.
-
#entity_ref? ⇒ Boolean
Specifies if this is an entity reference node.
-
#eql?(other_node) ⇒ Boolean
(also: #==)
Test equality between the two nodes.
-
#find(xpath, nslist = nil) ⇒ Object
call-seq: node.find(namespaces=nil) -> XPath::XPathObject.
-
#find_first(xpath, nslist = nil) ⇒ Object
call-seq: node.find_first(namespaces=nil) -> XML::Node.
-
#first ⇒ XML::Node
(also: #child)
Returns this node’s first child node if any.
-
#first? ⇒ Boolean
(also: #child?, #children?)
Determines whether this node has a first node.
-
#fragment? ⇒ Boolean
Specifies if this is a fragment node.
-
#html_doc? ⇒ Boolean
Specifies if this is a html document node.
-
#XML::Node.initialize(name, content = nil, namespace = nil) ⇒ XML::Node
constructor
Creates a new element with the specified name, content and namespace.
-
#inner_xml(options = Hash.new) ⇒ Object
call-seq: node.inner_xml -> “string” node.inner_xml(:indent => true, :encoding => ‘UTF-8’, :level => 0) -> “string”.
-
#lang ⇒ Object
Obtain the language set for this node, if any.
-
#lang=(lang) ⇒ Object
Set the language for this node.
-
#last ⇒ XML::Node
Obtain the last child node of this node, if any.
-
#last? ⇒ Boolean
Determines whether this node has a last node.
-
#line_num ⇒ Numeric
Obtain the line number (in the XML document) that this node was read from.
-
#name ⇒ Object
Obtain this node’s name.
-
#name=(name) ⇒ Object
Set this node’s name.
-
#namespace ⇒ Object
— Deprecated Namespaces —.
- #namespace=(value) ⇒ Object
-
#namespace? ⇒ Boolean
Specifies if this is a namespace node (not if it has a namepsace).
- #namespace_node ⇒ Object
-
#namespaces ⇒ Object
call-seq: node.namespacess -> XML::Namespaces Returns this node’s XML::Namespaces object, which is used to access the namespaces associated with this node.
-
#next ⇒ XML::Node
Returns the next sibling node if one exists.
-
#next=(node) ⇒ Object
Adds the specified node as the next sibling of the current node.
-
#next? ⇒ Boolean
Determines whether this node has a next node.
-
#type ⇒ Numeric
Obtain this node’s type identifier.
-
#node_type_name ⇒ Object
Returns this node’s type name.
-
#notation? ⇒ Boolean
Specifies if this is a notation node.
- #ns ⇒ Object
- #ns? ⇒ Boolean
- #ns_def ⇒ Object
- #ns_def? ⇒ Boolean
-
#output_escaping=(value) ⇒ Object
Controls whether this text node or the immediate text node children of an element or attribute node escapes their output.
-
#output_escaping? ⇒ Boolean
Determine whether this node escapes it’s output or not.
-
#parent ⇒ XML::Node
Obtain this node’s parent node, if any.
-
#parent? ⇒ Boolean
Determines whether this node has a parent node.
-
#path ⇒ Object
Obtain this node’s path.
-
#pi? ⇒ Boolean
Specifies if this is a processiong instruction node.
-
#pointer ⇒ XML::NodeSet
Evaluates an XPointer expression relative to this node.
-
#prev ⇒ XML::Node
Obtain the previous sibling, if any.
-
#prev=(node) ⇒ Object
Adds the specified node as the previous sibling of the current node.
-
#prev? ⇒ Boolean
Determines whether this node has a previous node.
- #properties ⇒ Object
- #properties? ⇒ Boolean
- #property(name) ⇒ Object
-
#remove! ⇒ Object
Removes this node and its children from the document tree by setting its document, parent and siblings to nil.
- #search_href(href) ⇒ Object
- #search_ns(prefix) ⇒ Object
-
#sibling=(node) ⇒ Object
Adds the specified node as the end of the current node’s list of siblings.
-
#space_preserve ⇒ Object
Determine whether this node preserves whitespace.
-
#space_preserve=(true) ⇒ Object
Control whether this node preserves whitespace.
-
#text? ⇒ Boolean
Specifies if this is a text node.
-
#to_s(*args) ⇒ Object
Converts a node, and all of its children, to a string representation.
-
#xinclude_end? ⇒ Boolean
Specifies if this is an xinclude end node.
-
#xinclude_start? ⇒ Boolean
Specifies if this is an xinclude start node.
-
#xlink? ⇒ Boolean
Determine whether this node is an xlink node.
-
#xlink_type ⇒ Numeric
Obtain the type identifier for this xlink, if applicable.
-
#xlink_type_name ⇒ Object
Obtain the type name for this xlink, if applicable.
Constructor Details
#XML::Node.initialize(name, content = nil, namespace = nil) ⇒ XML::Node
Creates a new element with the specified name, content and namespace. The content and namespace may be nil.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 253
static VALUE rxml_node_initialize(int argc, VALUE *argv, VALUE self)
{
VALUE name;
VALUE content;
VALUE ns;
xmlNodePtr xnode = NULL;
xmlNsPtr xns = NULL;
rb_scan_args(argc, argv, "12", &name, &content, &ns);
name = rb_obj_as_string(name);
if (!NIL_P(ns))
Data_Get_Struct(ns, xmlNs, xns);
xnode = xmlNewNode(xns, (xmlChar*) StringValuePtr(name));
if (xnode == NULL)
rxml_raise(&xmlLastError);
/* Link the Ruby object to the libxml object and vice-versa. */
rxml_register_node(xnode, self);
DATA_PTR(self) = xnode;
if (!NIL_P(content))
rxml_node_content_set(self, content);
return self;
}
|
Class Method Details
.XML::Node.new_cdata(content = nil) ⇒ XML::Node
Create a new #CDATA node, optionally setting the node’s content.
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'ext/libxml/ruby_xml_node.c', line 132
static VALUE rxml_node_new_cdata(int argc, VALUE *argv, VALUE klass)
{
VALUE content = Qnil;
xmlNodePtr xnode;
rb_scan_args(argc, argv, "01", &content);
if (NIL_P(content))
{
xnode = xmlNewCDataBlock(NULL, NULL, 0);
}
else
{
content = rb_obj_as_string(content);
xnode = xmlNewCDataBlock(NULL, (xmlChar*) StringValuePtr(content), (int)RSTRING_LEN(content));
}
if (xnode == NULL)
rxml_raise(&xmlLastError);
return rxml_node_wrap(xnode);
}
|
.XML::Node.new_comment(content = nil) ⇒ XML::Node
Create a new comment node, optionally setting the node’s content.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'ext/libxml/ruby_xml_node.c', line 163
static VALUE rxml_node_new_comment(int argc, VALUE *argv, VALUE klass)
{
VALUE content = Qnil;
xmlNodePtr xnode;
rb_scan_args(argc, argv, "01", &content);
if (NIL_P(content))
{
xnode = xmlNewComment(NULL);
}
else
{
content = rb_obj_as_string(content);
xnode = xmlNewComment((xmlChar*) StringValueCStr(content));
}
if (xnode == NULL)
rxml_raise(&xmlLastError);
return rxml_node_wrap(xnode);
}
|
.XML::Node.new_pi(name, content = nil) ⇒ XML::Node
Create a new pi node, optionally setting the node’s content.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 194
static VALUE rxml_node_new_pi(int argc, VALUE *argv, VALUE klass)
{
VALUE name = Qnil;
VALUE content = Qnil;
xmlNodePtr xnode;
rb_scan_args(argc, argv, "11", &name, &content);
if (NIL_P(name))
{
rb_raise(rb_eRuntimeError, "You must provide me with a name for a PI.");
}
name = rb_obj_as_string(name);
if (NIL_P(content))
{
xnode = xmlNewPI((xmlChar*) StringValuePtr(name), NULL);
}
else
{
content = rb_obj_as_string(content);
xnode = xmlNewPI((xmlChar*) StringValuePtr(name), (xmlChar*) StringValueCStr(content));
}
if (xnode == NULL)
rxml_raise(&xmlLastError);
return rxml_node_wrap(xnode);
}
|
.XML::Node.new_text(content) ⇒ XML::Node
Create a new text node.
230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'ext/libxml/ruby_xml_node.c', line 230
static VALUE rxml_node_new_text(VALUE klass, VALUE content)
{
xmlNodePtr xnode;
Check_Type(content, T_STRING);
content = rb_obj_as_string(content);
xnode = xmlNewText((xmlChar*) StringValueCStr(content));
if (xnode == NULL)
rxml_raise(&xmlLastError);
return rxml_node_wrap(xnode);
}
|
Instance Method Details
#<<("Some text") ⇒ Object #<<(node) ⇒ Object
Add the specified text or XML::Node as a new child node to the current node.
If the specified argument is a string, it should be a raw string that contains unescaped XML special characters. Entity references are not supported.
The method will return the current node.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 487
static VALUE rxml_node_content_add(VALUE self, VALUE obj)
{
xmlNodePtr xnode;
VALUE str;
xnode = rxml_get_xnode(self);
/* XXX This should only be legal for a CDATA type node, I think,
* resulting in a merge of content, as if a string were passed
* danj 070827
*/
if (rb_obj_is_kind_of(obj, cXMLNode))
{
rxml_node_modify_dom(self, obj, xmlAddChild);
}
else
{
str = rb_obj_as_string(obj);
if (NIL_P(str) || TYPE(str) != T_STRING)
rb_raise(rb_eTypeError, "invalid argument: must be string or XML::Node");
xmlNodeAddContent(xnode, (xmlChar*) StringValuePtr(str));
}
return self;
}
|
#property("name") ⇒ Object #[]("name") ⇒ Object
Obtain the named property.
1099 1100 1101 1102 1103 |
# File 'ext/libxml/ruby_xml_node.c', line 1099
static VALUE rxml_node_attribute_get(VALUE self, VALUE name)
{
VALUE attributes = rxml_node_attributes_get(self);
return rxml_attributes_attribute_get(attributes, name);
}
|
#[]=("name") ⇒ Object
Set the named property.
1111 1112 1113 1114 1115 |
# File 'ext/libxml/ruby_xml_node.c', line 1111
static VALUE rxml_node_property_set(VALUE self, VALUE name, VALUE value)
{
VALUE attributes = rxml_node_attributes_get(self);
return rxml_attributes_attribute_set(attributes, name, value);
}
|
#attribute? ⇒ Boolean
Specifies if this is an attribute node
207 208 209 |
# File 'lib/libxml/node.rb', line 207 def attribute? node_type == ATTRIBUTE_NODE end |
#attribute_decl? ⇒ Boolean
Specifies if this is an attribute declaration node
212 213 214 |
# File 'lib/libxml/node.rb', line 212 def attribute_decl? node_type == ATTRIBUTE_DECL end |
#attributes ⇒ Object
Returns the XML::Attributes for this node.
1084 1085 1086 1087 1088 1089 1090 |
# File 'ext/libxml/ruby_xml_node.c', line 1084
static VALUE rxml_node_attributes_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
return rxml_attributes_new(xnode);
}
|
#attributes? ⇒ Boolean
Determines whether this node has attributes
9 10 11 |
# File 'lib/libxml/node.rb', line 9 def attributes? attributes.length > 0 end |
#base ⇒ Object
366 367 368 369 |
# File 'lib/libxml/node.rb', line 366 def base warn('Node#base is deprecated. Use Node#base_uri.') self.base_uri end |
#base=(value) ⇒ Object
371 372 373 374 |
# File 'lib/libxml/node.rb', line 371 def base=(value) warn('Node#base= is deprecated. Use Node#base_uri=.') self.base_uri = value end |
#base_uri ⇒ Object
Obtain this node’s base URI.
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'ext/libxml/ruby_xml_node.c', line 321
static VALUE rxml_node_base_uri_get(VALUE self)
{
xmlNodePtr xnode;
xmlChar* base_uri;
VALUE result = Qnil;
xnode = rxml_get_xnode(self);
if (xnode->doc == NULL)
return (result);
base_uri = xmlNodeGetBase(xnode->doc, xnode);
if (base_uri)
{
result = rxml_new_cstr( base_uri, NULL);
xmlFree(base_uri);
}
return (result);
}
|
#base_uri=(uri) ⇒ Object
Set this node’s base URI.
350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'ext/libxml/ruby_xml_node.c', line 350
static VALUE rxml_node_base_uri_set(VALUE self, VALUE uri)
{
xmlNodePtr xnode;
Check_Type(uri, T_STRING);
xnode = rxml_get_xnode(self);
if (xnode->doc == NULL)
return (Qnil);
xmlNodeSetBase(xnode, (xmlChar*) StringValuePtr(uri));
return (Qtrue);
}
|
#empty? ⇒ Boolean
Determine whether this node is an empty or whitespace only text-node.
671 672 673 674 675 676 677 678 679 |
# File 'ext/libxml/ruby_xml_node.c', line 671
static VALUE rxml_node_empty_q(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode == NULL)
return (Qnil);
return ((xmlIsBlankNode(xnode) == 1) ? Qtrue : Qfalse);
}
|
#cdata? ⇒ Boolean
Specifies if this is an CDATA node
217 218 219 |
# File 'lib/libxml/node.rb', line 217 def cdata? node_type == CDATA_SECTION_NODE end |
#child=(node) ⇒ Object
325 326 327 328 |
# File 'lib/libxml/node.rb', line 325 def child=(node) warn('Node#child= is deprecated. Use Node#<< instead.') self << node end |
#child_add(node) ⇒ Object
— Deprecated DOM Manipulation —
320 321 322 323 |
# File 'lib/libxml/node.rb', line 320 def child_add(node) warn('Node#child_add is deprecated. Use Node#<< instead.') self << node end |
#children ⇒ Object
Returns this node’s children as an array.
131 132 133 |
# File 'lib/libxml/node.rb', line 131 def children entries end |
#clone ⇒ Object
Create a shallow copy of the node. To create a deep copy call Node#copy(true)
15 16 17 |
# File 'lib/libxml/node.rb', line 15 def clone copy(false) end |
#comment? ⇒ Boolean
Specifies if this is an comment node
222 223 224 |
# File 'lib/libxml/node.rb', line 222 def comment? node_type == COMMENT_NODE end |
#content ⇒ Object
Obtain this node’s content as a string.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'ext/libxml/ruby_xml_node.c', line 369
static VALUE rxml_node_content_get(VALUE self)
{
xmlNodePtr xnode;
xmlChar *content;
VALUE result = Qnil;
xnode = rxml_get_xnode(self);
content = xmlNodeGetContent(xnode);
if (content)
{
result = rxml_new_cstr(content, NULL);
xmlFree(content);
}
return result;
}
|
#content=(content) ⇒ Object
Set this node’s content to the specified string.
392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'ext/libxml/ruby_xml_node.c', line 392
static VALUE rxml_node_content_set(VALUE self, VALUE content)
{
xmlNodePtr xnode;
xmlChar* encoded_content;
Check_Type(content, T_STRING);
xnode = rxml_get_xnode(self);
encoded_content = xmlEncodeSpecialChars(xnode->doc, (xmlChar*) StringValuePtr(content));
xmlNodeSetContent(xnode, encoded_content);
xmlFree(encoded_content);
return (Qtrue);
}
|
#content_stripped ⇒ Object
Obtain this node’s stripped content.
Deprecated: Stripped content can be obtained via the content
method.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 |
# File 'ext/libxml/ruby_xml_node.c', line 414
static VALUE rxml_node_content_stripped_get(VALUE self)
{
xmlNodePtr xnode;
xmlChar* content;
VALUE result = Qnil;
xnode = rxml_get_xnode(self);
if (!xnode->content)
return result;
content = xmlNodeGetContent(xnode);
if (content)
{
result = rxml_new_cstr( content, NULL);
xmlFree(content);
}
return (result);
}
|
#context(nslist = nil) ⇒ Object
call-seq:
node.context(namespaces=nil) -> XPath::Context
Returns a new XML::XPathContext for the current node.
Namespaces is an optional array of XML::NS objects
53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/libxml/node.rb', line 53 def context(nslist = nil) if not self.doc raise(TypeError, "A node must belong to a document before a xpath context can be created") end context = XPath::Context.new(self.doc) context.node = self context.register_namespaces_from_node(self) context.register_namespaces_from_node(self.doc.root) context.register_namespaces(nslist) if nslist context end |
#copy ⇒ XML::Node
Creates a copy of this node. To create a shallow copy set the deep parameter to false. To create a deep copy set the deep parameter to true.
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 |
# File 'ext/libxml/ruby_xml_node.c', line 1321
static VALUE rxml_node_copy(VALUE self, VALUE deep)
{
xmlNodePtr xnode;
xmlNodePtr xcopy;
int recursive = (deep == Qnil || deep == Qfalse) ? 0 : 1;
xnode = rxml_get_xnode(self);
xcopy = xmlCopyNode(xnode, recursive);
if (xcopy)
return rxml_node_wrap(xcopy);
else
return Qnil;
}
|
#debug ⇒ Object
Print libxml debugging information to stdout. Requires that libxml was compiled with debugging enabled.
441 442 443 444 445 446 447 448 449 450 451 452 |
# File 'ext/libxml/ruby_xml_node.c', line 441
static VALUE rxml_node_debug(VALUE self)
{
#ifdef LIBXML_DEBUG_ENABLED
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
xmlDebugDumpNode(NULL, xnode, 2);
return Qtrue;
#else
rb_warn("libxml was compiled without debugging support.");
return Qfalse;
#endif
}
|
#doc ⇒ Object
Obtain the XML::Document this node belongs to.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 519
static VALUE rxml_node_doc(VALUE self)
{
xmlDocPtr xdoc = NULL;
xmlNodePtr xnode = rxml_get_xnode(self);
switch (xnode->type)
{
case XML_DOCUMENT_NODE:
#ifdef LIBXML_DOCB_ENABLED
case XML_DOCB_DOCUMENT_NODE:
#endif
case XML_HTML_DOCUMENT_NODE:
case XML_NAMESPACE_DECL:
break;
case XML_ATTRIBUTE_NODE:
xdoc = (xmlDocPtr)((xmlAttrPtr) xnode->doc);
break;
default:
xdoc = xnode->doc;
}
if (xdoc == NULL)
return (Qnil);
return rxml_lookup_doc(xdoc);
}
|
#docbook_doc? ⇒ Boolean
Specifies if this is an docbook node
227 228 229 |
# File 'lib/libxml/node.rb', line 227 def docbook_doc? node_type == DOCB_DOCUMENT_NODE end |
#doctype? ⇒ Boolean
Specifies if this is an doctype node
232 233 234 |
# File 'lib/libxml/node.rb', line 232 def doctype? node_type == DOCUMENT_TYPE_NODE end |
#document? ⇒ Boolean
Specifies if this is an document node
237 238 239 |
# File 'lib/libxml/node.rb', line 237 def document? node_type == DOCUMENT_NODE end |
#dtd? ⇒ Boolean
Specifies if this is an DTD node
242 243 244 |
# File 'lib/libxml/node.rb', line 242 def dtd? node_type == DTD_NODE end |
#dump ⇒ Object
— Deprecated Output — :stopdoc:
314 315 316 317 |
# File 'lib/libxml/node.rb', line 314 def dump warn('Node#dump is deprecated. Use Node#to_s instead.') self.to_s end |
#dup ⇒ Object
:call-seq:
node.dup -> XML::Node
Create a shallow copy of the node. To create a deep copy call Node#copy(true)
43 44 45 |
# File 'lib/libxml/node.rb', line 43 def dup copy(false) end |
#each ⇒ XML::Node Also known as: each_child
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 |
# File 'ext/libxml/ruby_xml_node.c', line 645
static VALUE rxml_node_each(VALUE self)
{
xmlNodePtr xnode;
xmlNodePtr xcurrent;
xnode = rxml_get_xnode(self);
xcurrent = xnode->children;
while (xcurrent)
{
/* The user could remove this node, so first stache
away the next node. */
xmlNodePtr xnext = xcurrent->next;
rb_yield(rxml_node_wrap(xcurrent));
xcurrent = xnext;
}
return Qnil;
}
|
#each_attr ⇒ Object
103 104 105 106 107 |
# File 'lib/libxml/node.rb', line 103 def each_attr attributes.each do |attr| yield(attr) end end |
#each_element ⇒ Object
114 115 116 117 118 |
# File 'lib/libxml/node.rb', line 114 def each_element each do |node| yield(node) if node.node_type == ELEMENT_NODE end end |
#element? ⇒ Boolean
Specifies if this is an element node
247 248 249 |
# File 'lib/libxml/node.rb', line 247 def element? node_type == ELEMENT_NODE end |
#element_decl? ⇒ Boolean
Specifies if this is an element declaration node
257 258 259 |
# File 'lib/libxml/node.rb', line 257 def element_decl? node_type == ELEMENT_DECL end |
#empty? ⇒ Boolean
Determine whether this node is an empty or whitespace only text-node.
671 672 673 674 675 676 677 678 679 |
# File 'ext/libxml/ruby_xml_node.c', line 671
static VALUE rxml_node_empty_q(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode == NULL)
return (Qnil);
return ((xmlIsBlankNode(xnode) == 1) ? Qtrue : Qfalse);
}
|
#entity? ⇒ Boolean
Specifies if this is an entity node
252 253 254 |
# File 'lib/libxml/node.rb', line 252 def entity? node_type == ENTITY_NODE end |
#entity_ref? ⇒ Boolean
Specifies if this is an entity reference node
262 263 264 |
# File 'lib/libxml/node.rb', line 262 def entity_ref? node_type == ENTITY_REF_NODE end |
#eql?(other_node) ⇒ Boolean Also known as: ==
Test equality between the two nodes. Two nodes are equal if they are the same node or have the same XML representation.
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 |
# File 'ext/libxml/ruby_xml_node.c', line 688
static VALUE rxml_node_eql_q(VALUE self, VALUE other)
{
if(self == other)
{
return Qtrue;
}
else if (NIL_P(other))
{
return Qfalse;
}
else
{
VALUE self_xml;
VALUE other_xml;
if (rb_obj_is_kind_of(other, cXMLNode) == Qfalse)
rb_raise(rb_eTypeError, "Nodes can only be compared against other nodes");
self_xml = rxml_node_to_s(0, NULL, self);
other_xml = rxml_node_to_s(0, NULL, other);
return(rb_funcall(self_xml, rb_intern("=="), 1, other_xml));
}
}
|
#find(xpath, nslist = nil) ⇒ Object
call-seq:
node.find(namespaces=nil) -> XPath::XPathObject
Return nodes matching the specified xpath expression. For more information, please refer to the documentation for XML::Document#find.
Namespaces is an optional array of XML::NS objects
74 75 76 |
# File 'lib/libxml/node.rb', line 74 def find(xpath, nslist = nil) self.context(nslist).find(xpath) end |
#find_first(xpath, nslist = nil) ⇒ Object
call-seq:
node.find_first(namespaces=nil) -> XML::Node
Return the first node matching the specified xpath expression. For more information, please refer to the documentation for the #find method.
84 85 86 |
# File 'lib/libxml/node.rb', line 84 def find_first(xpath, nslist = nil) find(xpath, nslist).first end |
#first ⇒ XML::Node Also known as: child
Returns this node’s first child node if any.
460 461 462 463 464 465 466 467 468 469 470 |
# File 'ext/libxml/ruby_xml_node.c', line 460
static VALUE rxml_node_first_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode->children)
return (rxml_node_wrap(xnode->children));
else
return (Qnil);
}
|
#first? ⇒ Boolean Also known as: child?, children?
Determines whether this node has a first node
126 127 128 |
# File 'lib/libxml/node.rb', line 126 def first? not first.nil? end |
#fragment? ⇒ Boolean
Specifies if this is a fragment node
267 268 269 |
# File 'lib/libxml/node.rb', line 267 def fragment? node_type == DOCUMENT_FRAG_NODE end |
#html_doc? ⇒ Boolean
Specifies if this is a html document node
272 273 274 |
# File 'lib/libxml/node.rb', line 272 def html_doc? node_type == HTML_DOCUMENT_NODE end |
#inner_xml(options = Hash.new) ⇒ Object
call-seq:
node.inner_xml -> "string"
node.inner_xml(:indent => true, :encoding => 'UTF-8', :level => 0) -> "string"
Converts a node’s children, to a string representation. To include the node, use XML::Node#to_s. For more information about the supported options, see XML::Node#to_s.
26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/libxml/node.rb', line 26 def inner_xml( = Hash.new) io = nil self.each do |node| xml = node.to_s() # Create the string IO here since we now know the encoding io = create_string_io(xml) unless io io << xml end io ? io.string : nil end |
#lang ⇒ Object
Obtain the language set for this node, if any. This is set in XML via the xml:lang attribute.
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 |
# File 'ext/libxml/ruby_xml_node.c', line 719
static VALUE rxml_node_lang_get(VALUE self)
{
xmlNodePtr xnode;
xmlChar *lang;
VALUE result = Qnil;
xnode = rxml_get_xnode(self);
lang = xmlNodeGetLang(xnode);
if (lang)
{
result = rxml_new_cstr( lang, NULL);
xmlFree(lang);
}
return (result);
}
|
#lang=(lang) ⇒ Object
Set the language for this node. This affects the value of the xml:lang attribute.
746 747 748 749 750 751 752 753 754 755 |
# File 'ext/libxml/ruby_xml_node.c', line 746
static VALUE rxml_node_lang_set(VALUE self, VALUE lang)
{
xmlNodePtr xnode;
Check_Type(lang, T_STRING);
xnode = rxml_get_xnode(self);
xmlNodeSetLang(xnode, (xmlChar*) StringValuePtr(lang));
return (Qtrue);
}
|
#last ⇒ XML::Node
Obtain the last child node of this node, if any.
763 764 765 766 767 768 769 770 771 772 773 |
# File 'ext/libxml/ruby_xml_node.c', line 763
static VALUE rxml_node_last_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode->last)
return (rxml_node_wrap(xnode->last));
else
return (Qnil);
}
|
#last? ⇒ Boolean
Determines whether this node has a last node
146 147 148 |
# File 'lib/libxml/node.rb', line 146 def last? not last.nil? end |
#line_num ⇒ Numeric
Obtain the line number (in the XML document) that this node was read from. If default_line_numbers
is set false (the default), this method returns zero.
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 |
# File 'ext/libxml/ruby_xml_node.c', line 783
static VALUE rxml_node_line_num(VALUE self)
{
xmlNodePtr xnode;
long line_num;
xnode = rxml_get_xnode(self);
if (!xmlLineNumbersDefaultValue)
rb_warn(
"Line numbers were not retained: use XML::Parser::default_line_numbers=true");
line_num = xmlGetLineNo(xnode);
if (line_num == -1)
return (Qnil);
else
return (INT2NUM((long) line_num));
}
|
#name ⇒ Object
Obtain this node’s name.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 879
static VALUE rxml_node_name_get(VALUE self)
{
xmlNodePtr xnode;
const xmlChar *name;
xnode = rxml_get_xnode(self);
switch (xnode->type)
{
case XML_DOCUMENT_NODE:
#ifdef LIBXML_DOCB_ENABLED
case XML_DOCB_DOCUMENT_NODE:
#endif
case XML_HTML_DOCUMENT_NODE:
{
xmlDocPtr doc = (xmlDocPtr) xnode;
name = doc->URL;
break;
}
case XML_ATTRIBUTE_NODE:
{
xmlAttrPtr attr = (xmlAttrPtr) xnode;
name = attr->name;
break;
}
case XML_NAMESPACE_DECL:
{
xmlNsPtr ns = (xmlNsPtr) xnode;
name = ns->prefix;
break;
}
default:
name = xnode->name;
break;
}
if (xnode->name == NULL)
return (Qnil);
else
return (rxml_new_cstr( name, NULL));
}
|
#name=(name) ⇒ Object
Set this node’s name.
927 928 929 930 931 932 933 934 935 936 937 938 939 940 |
# File 'ext/libxml/ruby_xml_node.c', line 927
static VALUE rxml_node_name_set(VALUE self, VALUE name)
{
xmlNodePtr xnode;
const xmlChar *xname;
Check_Type(name, T_STRING);
xnode = rxml_get_xnode(self);
xname = (const xmlChar*)StringValuePtr(name);
/* Note: calling xmlNodeSetName() for a text node is ignored by libXML. */
xmlNodeSetName(xnode, xname);
return (Qtrue);
}
|
#namespace ⇒ Object
— Deprecated Namespaces —
331 332 333 334 |
# File 'lib/libxml/node.rb', line 331 def namespace warn('Node#namespace is deprecated. Use Node#namespaces instead.') self.namespaces.entries end |
#namespace=(value) ⇒ Object
336 337 338 339 |
# File 'lib/libxml/node.rb', line 336 def namespace=(value) warn('Node#namespace= is deprecated. Use Node#namespaces.namespace= instead.') self.namespaces.namespace = value end |
#namespace? ⇒ Boolean
Specifies if this is a namespace node (not if it has a namepsace)
278 279 280 |
# File 'lib/libxml/node.rb', line 278 def namespace? node_type == NAMESPACE_DECL end |
#namespace_node ⇒ Object
341 342 343 344 |
# File 'lib/libxml/node.rb', line 341 def namespace_node warn('Node#namespace_node is deprecated. Use Node#namespaces.namespace instead.') self.namespaces.namespace end |
#namespaces ⇒ Object
call-seq:
node.namespacess -> XML::Namespaces
Returns this node’s XML::Namespaces object, which is used to access the namespaces associated with this node.
94 95 96 |
# File 'lib/libxml/node.rb', line 94 def namespaces @namespaces ||= XML::Namespaces.new(self) end |
#next ⇒ XML::Node
Returns the next sibling node if one exists.
948 949 950 951 952 953 954 955 956 957 958 |
# File 'ext/libxml/ruby_xml_node.c', line 948
static VALUE rxml_node_next_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode->next)
return (rxml_node_wrap(xnode->next));
else
return (Qnil);
}
|
#next=(node) ⇒ Object
Adds the specified node as the next sibling of the current node. If the node already exists in the document, it is first removed from its existing context. Any adjacent text nodes will be merged together, meaning the returned node may be different than the original node.
970 971 972 973 |
# File 'ext/libxml/ruby_xml_node.c', line 970
static VALUE rxml_node_next_set(VALUE self, VALUE next)
{
return rxml_node_modify_dom(self, next, xmlAddNextSibling);
}
|
#next? ⇒ Boolean
Determines whether this node has a next node
136 137 138 |
# File 'lib/libxml/node.rb', line 136 def next? not self.next.nil? end |
#type ⇒ Numeric
Obtain this node’s type identifier.
1304 1305 1306 1307 1308 1309 |
# File 'ext/libxml/ruby_xml_node.c', line 1304
static VALUE rxml_node_type(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
return (INT2NUM(xnode->type));
}
|
#node_type_name ⇒ Object
Returns this node’s type name
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 |
# File 'lib/libxml/node.rb', line 154 def node_type_name case node_type # Most common choices first when ATTRIBUTE_NODE 'attribute' when DOCUMENT_NODE 'document_xml' when ELEMENT_NODE 'element' when TEXT_NODE 'text' # Now the rest when ATTRIBUTE_DECL 'attribute_decl' when CDATA_SECTION_NODE 'cdata' when COMMENT_NODE 'comment' when DOCB_DOCUMENT_NODE 'document_docbook' when DOCUMENT_FRAG_NODE 'fragment' when DOCUMENT_TYPE_NODE 'doctype' when DTD_NODE 'dtd' when ELEMENT_DECL 'elem_decl' when ENTITY_DECL 'entity_decl' when ENTITY_NODE 'entity' when ENTITY_REF_NODE 'entity_ref' when HTML_DOCUMENT_NODE 'document_html' when NAMESPACE_DECL 'namespace' when NOTATION_NODE 'notation' when PI_NODE 'pi' when XINCLUDE_START 'xinclude_start' when XINCLUDE_END 'xinclude_end' else raise(UnknownType, "Unknown node type: %n", node.node_type); end end |
#notation? ⇒ Boolean
Specifies if this is a notation node
283 284 285 |
# File 'lib/libxml/node.rb', line 283 def notation? node_type == NOTATION_NODE end |
#ns ⇒ Object
346 347 348 349 |
# File 'lib/libxml/node.rb', line 346 def ns warn('Node#ns is deprecated. Use Node#namespaces.namespace instead.') self.namespaces.namespace end |
#ns? ⇒ Boolean
351 352 353 354 |
# File 'lib/libxml/node.rb', line 351 def ns? warn('Node#ns? is deprecated. Use !Node#namespaces.namespace.nil? instead.') !self.namespaces.namespace.nil? end |
#ns_def ⇒ Object
356 357 358 359 |
# File 'lib/libxml/node.rb', line 356 def ns_def warn('Node#ns_def is deprecated. Use Node#namespaces.definitions instead.') self.namespaces.definitions end |
#ns_def? ⇒ Boolean
361 362 363 364 |
# File 'lib/libxml/node.rb', line 361 def ns_def? warn('Node#ns_def? is deprecated. Use !Node#namespaces.definitions.nil? instead.') !self.namespaces.definitions.nil? end |
#output_escaping=(true) ⇒ Object #output_escaping=(true) ⇒ Object #output_escaping=(true) ⇒ Object
Controls whether this text node or the immediate text node children of an element or attribute node escapes their output. Any other type of node will simply ignore this operation.
Text nodes which are added to an element or attribute node will be affected by any previous setting of this property.
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 |
# File 'ext/libxml/ruby_xml_node.c', line 1239
static VALUE rxml_node_output_escaping_set(VALUE self, VALUE value)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
switch (xnode->type) {
case XML_TEXT_NODE:
xnode->name = (value != Qfalse && value != Qnil) ? xmlStringText : xmlStringTextNoenc;
break;
case XML_ELEMENT_NODE:
case XML_ATTRIBUTE_NODE:
{
const xmlChar *name = (value != Qfalse && value != Qnil) ? xmlStringText : xmlStringTextNoenc;
xmlNodePtr tmp;
for (tmp = xnode->children; tmp; tmp = tmp->next)
if (tmp->type == XML_TEXT_NODE)
tmp->name = name;
}
break;
default:
return Qnil;
}
return (value!=Qfalse && value!=Qnil) ? Qtrue : Qfalse;
}
|
#output_escaping? ⇒ Boolean #output_escaping? ⇒ Boolean #output_escaping? ⇒ Boolean #output_escaping? ⇒ Boolean
Determine whether this node escapes it’s output or not.
Text nodes return only true
or false
. Element and attribute nodes examine their immediate text node children to determine the value. Any other type of node always returns nil
.
If an element or attribute node has at least one immediate child text node and all the immediate text node children have the same output_escaping?
value, that value is returned. Otherwise, nil
is returned.
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 |
# File 'ext/libxml/ruby_xml_node.c', line 1192
static VALUE rxml_node_output_escaping_q(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
switch (xnode->type) {
case XML_TEXT_NODE:
return xnode->name==xmlStringTextNoenc ? Qfalse : Qtrue;
case XML_ELEMENT_NODE:
case XML_ATTRIBUTE_NODE:
{
xmlNodePtr tmp = xnode->children;
const xmlChar *match = NULL;
/* Find the first text node and use it as the reference. */
while (tmp && tmp->type != XML_TEXT_NODE)
tmp = tmp->next;
if (! tmp)
return Qnil;
match = tmp->name;
/* Walk the remaining text nodes until we run out or one doesn't match. */
while (tmp && (tmp->type != XML_TEXT_NODE || match == tmp->name))
tmp = tmp->next;
/* We're left with either the mismatched node or the aggregate result. */
return tmp ? Qnil : (match==xmlStringTextNoenc ? Qfalse : Qtrue);
}
break;
default:
return Qnil;
}
}
|
#parent ⇒ XML::Node
Obtain this node’s parent node, if any.
981 982 983 984 985 986 987 988 989 990 991 |
# File 'ext/libxml/ruby_xml_node.c', line 981
static VALUE rxml_node_parent_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (xnode->parent)
return (rxml_node_wrap(xnode->parent));
else
return (Qnil);
}
|
#parent? ⇒ Boolean
Determines whether this node has a parent node
121 122 123 |
# File 'lib/libxml/node.rb', line 121 def parent? not parent.nil? end |
#path ⇒ Object
Obtain this node’s path.
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 |
# File 'ext/libxml/ruby_xml_node.c', line 999
static VALUE rxml_node_path(VALUE self)
{
xmlNodePtr xnode;
xmlChar *path;
xnode = rxml_get_xnode(self);
path = xmlGetNodePath(xnode);
if (path == NULL)
return (Qnil);
else
return (rxml_new_cstr( path, NULL));
}
|
#pi? ⇒ Boolean
Specifies if this is a processiong instruction node
288 289 290 |
# File 'lib/libxml/node.rb', line 288 def pi? node_type == PI_NODE end |
#pointer ⇒ XML::NodeSet
Evaluates an XPointer expression relative to this node.
1019 1020 1021 1022 |
# File 'ext/libxml/ruby_xml_node.c', line 1019
static VALUE rxml_node_pointer(VALUE self, VALUE xptr_str)
{
return (rxml_xpointer_point2(self, xptr_str));
}
|
#prev ⇒ XML::Node
Obtain the previous sibling, if any.
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 |
# File 'ext/libxml/ruby_xml_node.c', line 1030
static VALUE rxml_node_prev_get(VALUE self)
{
xmlNodePtr xnode;
xmlNodePtr node;
xnode = rxml_get_xnode(self);
switch (xnode->type)
{
case XML_DOCUMENT_NODE:
#ifdef LIBXML_DOCB_ENABLED
case XML_DOCB_DOCUMENT_NODE:
#endif
case XML_HTML_DOCUMENT_NODE:
case XML_NAMESPACE_DECL:
node = NULL;
break;
case XML_ATTRIBUTE_NODE:
{
xmlAttrPtr attr = (xmlAttrPtr) xnode;
node = (xmlNodePtr) attr->prev;
}
break;
default:
node = xnode->prev;
break;
}
if (node == NULL)
return (Qnil);
else
return (rxml_node_wrap(node));
}
|
#prev=(node) ⇒ Object
Adds the specified node as the previous sibling of the current node. If the node already exists in the document, it is first removed from its existing context. Any adjacent text nodes will be merged together, meaning the returned node may be different than the original node.
1073 1074 1075 1076 |
# File 'ext/libxml/ruby_xml_node.c', line 1073
static VALUE rxml_node_prev_set(VALUE self, VALUE prev)
{
return rxml_node_modify_dom(self, prev, xmlAddPrevSibling);
}
|
#prev? ⇒ Boolean
Determines whether this node has a previous node
141 142 143 |
# File 'lib/libxml/node.rb', line 141 def prev? not prev.nil? end |
#properties ⇒ Object
11 12 13 14 |
# File 'lib/libxml/properties.rb', line 11 def properties warn('Node#properties is deprecated. Use Node#attributes instead.') self.attributes end |
#properties? ⇒ Boolean
16 17 18 19 |
# File 'lib/libxml/properties.rb', line 16 def properties? warn('Node#properties? is deprecated. Use Node#attributes? instead.') self.attributes? end |
#property(name) ⇒ Object
6 7 8 9 |
# File 'lib/libxml/properties.rb', line 6 def property(name) warn('Node#properties is deprecated. Use Node#[] instead.') self[name] end |
#remove! ⇒ Object
Removes this node and its children from the document tree by setting its document, parent and siblings to nil. You can add the returned node back into a document. Otherwise, the node will be freed once any references to it go out of scope.
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 |
# File 'ext/libxml/ruby_xml_node.c', line 1126
static VALUE rxml_node_remove_ex(VALUE self)
{
xmlNodePtr xnode, xresult;
xnode = rxml_get_xnode(self);
/* First unlink the node from its parent. */
xmlUnlinkNode(xnode);
/* Now copy the node we want to remove and make the
current Ruby object point to it. We do this because
a node has a number of dependencies on its parent
document - its name (if using a dictionary), entities,
namespaces, etc. For a node to live on its own, it
needs to get its own copies of this information.*/
xresult = xmlDocCopyNode(xnode, NULL, 1);
/* This ruby node object no longer points at the node.*/
rxml_unregister_node(xnode);
RDATA(self)->data = NULL;
/* Now free the original node. This will call the deregister node
callback which would reset the mark and free function except for
the fact we already removed it from the private hashtable above */
xmlFreeNode(xnode);
/* Now wrap the new node */
RDATA(self)->data = xresult;
rxml_register_node(xresult, self);
/* Now return the removed node so the user can
do something with it.*/
return self;
}
|
#search_href(href) ⇒ Object
381 382 383 384 |
# File 'lib/libxml/node.rb', line 381 def search_href(href) warn('Node#search_href is deprecated. Use Node#namespaces.find_by_href instead.') self.namespaces.find_by_href(href) end |
#search_ns(prefix) ⇒ Object
376 377 378 379 |
# File 'lib/libxml/node.rb', line 376 def search_ns(prefix) warn('Node#search_ns is deprecated. Use Node#namespaces.find_by_prefix instead.') self.namespaces.find_by_prefix(prefix) end |
#sibling=(node) ⇒ Object
Adds the specified node as the end of the current node’s list of siblings. If the node already exists in the document, it is first removed from its existing context. Any adjacent text nodes will be merged together, meaning the returned node may be different than the original node.
1170 1171 1172 1173 |
# File 'ext/libxml/ruby_xml_node.c', line 1170
static VALUE rxml_node_sibling_set(VALUE self, VALUE sibling)
{
return rxml_node_modify_dom(self, sibling, xmlAddSibling);
}
|
#space_preserve ⇒ Object
Determine whether this node preserves whitespace.
1271 1272 1273 1274 1275 1276 1277 |
# File 'ext/libxml/ruby_xml_node.c', line 1271
static VALUE rxml_node_space_preserve_get(VALUE self)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
return (INT2NUM(xmlNodeGetSpacePreserve(xnode)));
}
|
#space_preserve=(true) ⇒ Object
Control whether this node preserves whitespace.
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 |
# File 'ext/libxml/ruby_xml_node.c', line 1285
static VALUE rxml_node_space_preserve_set(VALUE self, VALUE value)
{
xmlNodePtr xnode;
xnode = rxml_get_xnode(self);
if (value == Qfalse)
xmlNodeSetSpacePreserve(xnode, 0);
else
xmlNodeSetSpacePreserve(xnode, 1);
return (Qnil);
}
|
#text? ⇒ Boolean
Specifies if this is a text node
293 294 295 |
# File 'lib/libxml/node.rb', line 293 def text? node_type == TEXT_NODE end |
#to_s ⇒ Object #to_s(: indent) ⇒ true
Converts a node, and all of its children, to a string representation. To include only the node’s children, use the the XML::Node#inner_xml method.
You may provide an optional hash table to control how the string is generated. Valid options are:
:indent - Specifies if the string should be indented. The default value is true. Note that indentation is only added if both :indent is true and XML.indent_tree_output is true. If :indent is set to false, then both indentation and line feeds are removed from the result.
:level - Specifies the indentation level. The amount of indentation is equal to the (level * number_spaces) + number_spaces, where libxml defaults the number of spaces to 2. Thus a level of 0 results in 2 spaces, level 1 results in 4 spaces, level 2 results in 6 spaces, etc.
:encoding - Specifies the output encoding of the string. It defaults to XML::Encoding::UTF8. To change it, use one of the XML::Encoding encoding constants.
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 |
# File 'ext/libxml/ruby_xml_node.c', line 572
static VALUE rxml_node_to_s(int argc, VALUE *argv, VALUE self)
{
VALUE result = Qnil;
VALUE options = Qnil;
xmlNodePtr xnode;
xmlCharEncodingHandlerPtr encodingHandler;
xmlOutputBufferPtr output;
int level = 0;
int indent = 1;
const xmlChar *xencoding = (const xmlChar*)"UTF-8";
rb_scan_args(argc, argv, "01", &options);
if (!NIL_P(options))
{
VALUE rencoding, rindent, rlevel;
Check_Type(options, T_HASH);
rencoding = rb_hash_aref(options, ID2SYM(rb_intern("encoding")));
rindent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));
rlevel = rb_hash_aref(options, ID2SYM(rb_intern("level")));
if (rindent == Qfalse)
indent = 0;
if (rlevel != Qnil)
level = NUM2INT(rlevel);
if (rencoding != Qnil)
{
xencoding = (const xmlChar*)xmlGetCharEncodingName((xmlCharEncoding)NUM2INT(rencoding));
if (!xencoding)
rb_raise(rb_eArgError, "Unknown encoding value: %d", NUM2INT(rencoding));
}
}
encodingHandler = xmlFindCharEncodingHandler((const char*)xencoding);
output = xmlAllocOutputBuffer(encodingHandler);
xnode = rxml_get_xnode(self);
xmlNodeDumpOutput(output, xnode->doc, xnode, level, indent, (const char*)xencoding);
xmlOutputBufferFlush(output);
#ifdef LIBXML2_NEW_BUFFER
if (output->conv)
result = rxml_new_cstr(xmlBufContent(output->conv), xencoding);
else
result = rxml_new_cstr(xmlBufContent(output->buffer), xencoding);
#else
if (output->conv)
result = rxml_new_cstr(xmlBufferContent(output->conv), xencoding);
else
result = rxml_new_cstr(xmlBufferContent(output->buffer), xencoding);
#endif
xmlOutputBufferClose(output);
return result;
}
|
#xinclude_end? ⇒ Boolean
Specifies if this is an xinclude end node
298 299 300 |
# File 'lib/libxml/node.rb', line 298 def xinclude_end? node_type == XINCLUDE_END end |
#xinclude_start? ⇒ Boolean
Specifies if this is an xinclude start node
303 304 305 |
# File 'lib/libxml/node.rb', line 303 def xinclude_start? node_type == XINCLUDE_START end |
#xlink? ⇒ Boolean
Determine whether this node is an xlink node.
806 807 808 809 810 811 812 813 814 815 816 817 818 |
# File 'ext/libxml/ruby_xml_node.c', line 806
static VALUE rxml_node_xlink_q(VALUE self)
{
xmlNodePtr xnode;
xlinkType xlt;
xnode = rxml_get_xnode(self);
xlt = xlinkIsLink(xnode->doc, xnode);
if (xlt == XLINK_TYPE_NONE)
return (Qfalse);
else
return (Qtrue);
}
|
#xlink_type ⇒ Numeric
Obtain the type identifier for this xlink, if applicable. If this is not an xlink node (see xlink?
), will return nil.
828 829 830 831 832 833 834 835 836 837 838 839 840 |
# File 'ext/libxml/ruby_xml_node.c', line 828
static VALUE rxml_node_xlink_type(VALUE self)
{
xmlNodePtr xnode;
xlinkType xlt;
xnode = rxml_get_xnode(self);
xlt = xlinkIsLink(xnode->doc, xnode);
if (xlt == XLINK_TYPE_NONE)
return (Qnil);
else
return (INT2NUM(xlt));
}
|
#xlink_type_name ⇒ Object
Obtain the type name for this xlink, if applicable. If this is not an xlink node (see xlink?
), will return nil.
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 |
# File 'ext/libxml/ruby_xml_node.c', line 850
static VALUE rxml_node_xlink_type_name(VALUE self)
{
xmlNodePtr xnode;
xlinkType xlt;
xnode = rxml_get_xnode(self);
xlt = xlinkIsLink(xnode->doc, xnode);
switch (xlt)
{
case XLINK_TYPE_NONE:
return (Qnil);
case XLINK_TYPE_SIMPLE:
return (rxml_new_cstr((const xmlChar*)"simple", NULL));
case XLINK_TYPE_EXTENDED:
return (rxml_new_cstr((const xmlChar*)"extended", NULL));
case XLINK_TYPE_EXTENDED_SET:
return (rxml_new_cstr((const xmlChar*)"extended_set", NULL));
default:
rb_fatal("Unknowng xlink type, %d", xlt);
}
}
|