123456789_123456789_123456789_123456789_123456789_

Class: LibXML::XML::Document

Overview

The Document class provides a tree based API for working with xml documents. You may directly create a document and manipulate it, or create a document from a data source by using an Parser object.

To read a document from a file:

doc = XML::Document.file('my_file')

To use a parser to read a document:

parser = XML::Parser.file('my_file')
doc = parser.parse

To create a document from scratch:

doc = XML::Document.new()
doc.root = XML::Node.new('root_node')
doc.root << XML::Node.new('elem1')
doc.save(filename, :indent => true, :encoding => XML::Encoding::UTF_8)

To write a document to a file:

doc = XML::Document.new()
doc.root = XML::Node.new('root_node')
root = doc.root

root << elem1 = XML::Node.new('elem1')
elem1['attr1'] = 'val1'
elem1['attr2'] = 'val2'

root << elem2 = XML::Node.new('elem2')
elem2['attr1'] = 'val1'
elem2['attr2'] = 'val2'

root << elem3 = XML::Node.new('elem3')
elem3 << elem4 = XML::Node.new('elem4')
elem3 << elem5 = XML::Node.new('elem5')

elem5 << elem6 = XML::Node.new('elem6')
elem6 << 'Content for element 6'

elem3['attr'] = 'baz'

doc.save(filename, :indent => true, :encoding => XML::Encoding::UTF_8)

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

XML::Document.initialize(xml_version = 1.0) ⇒ Document

Initializes a new Document, optionally specifying the ::LibXML::XML version.

[ GitHub ] 

  


# File 'ext/libxml/ruby_xml_document.c', line 106



static VALUE rxml_document_initialize(int argc, VALUE *argv, VALUE self)
{
  xmlDocPtr xdoc;
  VALUE xmlver;

  switch (argc)
  {
  case 0:
    xmlver = rb_str_new2("1.0");
    break;
  case 1:
    rb_scan_args(argc, argv, "01", &xmlver);
    break;
  default:
    rb_raise(rb_eArgError, "wrong number of arguments (need 0 or 1)");
  }

  Check_Type(xmlver, T_STRING);
  xdoc = xmlNewDoc((xmlChar*) StringValuePtr(xmlver));

  // Link the ruby object to the document and the document to the ruby object
  RDATA(self)->data = xdoc;
  xdoc->_private = (void*)self;

  return self;
}


  







Class Method Details



  

    XML::Document.document(document)  ⇒ Document   



  

    

Creates a new document based on the specified document.



Parameters:



document - A preparsed document.


  



  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 14



def self.document(value)
  Parser.document(value).parse
end


  








  

    

      XML::Document.file(path)  ⇒ Document 
      XML::Document.file(path, encoding: XML::Encoding::UTF_8)  
      .options  ⇒ Document 
    

  



  

    

Creates a new document from the specified file or uri.



Parameters:



path - Path to file
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 (|).


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 33



def self.file(path, encoding: nil, options: nil)
  Parser.file(path, encoding: encoding, options: options).parse
end


  








  

    

      XML::Document.io(io)  ⇒ Document 
      XML::Document.io(io, :encoding)  ⇒ XML::Encoding::UTF_8 
    

  



  

    

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 (|).


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 54



def self.io(io, base_uri: nil, encoding: nil, options: nil)
  Parser.io(io, base_uri: base_uri, encoding: encoding, options: options).parse
end


  








  

    

      XML::Document.string(string)  ⇒ Document 
      XML::Document.string(string, encoding: XML::Encoding::UTF_8)  
      .options  
      .base_uri  ⇒ Document 
    

  



  

    

Creates a new document from the specified string.



Parameters:



string - String to parse
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 (|).


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 75



def self.string(value, base_uri: nil, encoding: nil, options: nil)
  Parser.string(value, base_uri: base_uri, encoding: encoding, options: options).parse
end


  







Instance Attribute Details



  

    #child  ⇒ node  (readonly)  



  

    

Get this document’s child node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 419



static VALUE rxml_document_child_get(VALUE self)
{
  xmlDocPtr xdoc;
  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->children == NULL)
    return (Qnil);

  return rxml_node_wrap(xdoc->children);
}


  








  

    #child?  ⇒ Boolean  (readonly)  



  

    

Determine whether this document has a child node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 436



static VALUE rxml_document_child_q(VALUE self)
{
  xmlDocPtr xdoc;
  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->children == NULL)
    return (Qfalse);
  else
    return (Qtrue);
}


  








  

    #compression  ⇒ Numeric  (rw)  



  

    

Obtain this document’s compression mode identifier.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 336



static VALUE rxml_document_compression_get(VALUE self)
{
#ifdef HAVE_ZLIB_H
  xmlDocPtr xdoc;

  int compmode;
  Data_Get_Struct(self, xmlDoc, xdoc);

  compmode = xmlGetDocCompressMode(xdoc);
  if (compmode == -1)
  return(Qnil);
  else
  return(INT2NUM(compmode));
#else
  rb_warn("libxml not compiled with zlib support");
  return (Qfalse);
#endif
}


  








  

    #compression=(num)   (rw)  



  

    

Set this document’s compression mode.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 361



static VALUE rxml_document_compression_set(VALUE self, VALUE num)
{
#ifdef HAVE_ZLIB_H
  xmlDocPtr xdoc;

  int compmode;
  Check_Type(num, T_FIXNUM);
  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc == NULL)
  {
    return(Qnil);
  }
  else
  {
    xmlSetDocCompressMode(xdoc, NUM2INT(num));

    compmode = xmlGetDocCompressMode(xdoc);
    if (compmode == -1)
    return(Qnil);
    else
    return(INT2NUM(compmode));
  }
#else
  rb_warn("libxml compiled without zlib support");
  return (Qfalse);
#endif
}


  








  

    #compression?  ⇒ Boolean  (rw)  



  

    

Determine whether this document is compressed.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 396



static VALUE rxml_document_compression_q(VALUE self)
{
#ifdef HAVE_ZLIB_H
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->compression != -1)
  return(Qtrue);
  else
  return(Qfalse);
#else
  rb_warn("libxml compiled without zlib support");
  return (Qfalse);
#endif
}


  








  

    #docbook_doc?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  



  

    

Specifies if this is an docbook node


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 154



def docbook_doc?
  node_type == XML::Node::DOCB_DOCUMENT_NODE
end


  








  

    #document?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  



  

    

Specifies if this is an document node


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 149



def document?
  node_type == XML::Node::DOCUMENT_NODE
end


  








  

    #encoding  ⇒ XML::Encoding::UTF_8  (rw)  



  

    

Returns the ::LibXML encoding constant specified by this document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 474



static VALUE rxml_document_encoding_get(VALUE self)
{
  xmlDocPtr xdoc;
  const char *xencoding;
  Data_Get_Struct(self, xmlDoc, xdoc);

  xencoding = (const char*)xdoc->encoding;
  return INT2NUM(xmlParseCharEncoding(xencoding));
}


  








  

    #encoding=(XML::Encoding::UTF_8)   (rw)  



  

    

Set the encoding for this document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 508



static VALUE rxml_document_encoding_set(VALUE self, VALUE encoding)
{
  xmlDocPtr xdoc;
  const char* xencoding = xmlGetCharEncodingName((xmlCharEncoding)NUM2INT(encoding));

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->encoding != NULL)
    xmlFree((xmlChar *) xdoc->encoding);

  xdoc->encoding = xmlStrdup((xmlChar *)xencoding);
  return self;
}


  








  

    #html_doc?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  



  

    

Specifies if this is an html node


  





  


  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 159



def html_doc?
  node_type == XML::Node::HTML_DOCUMENT_NODE
end


  








  

    #last  ⇒ node  (readonly)  



  

    

Obtain the last node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 556



static VALUE rxml_document_last_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->last == NULL)
    return (Qnil);

  return rxml_node_wrap(xdoc->last);
}


  








  

    #last?  ⇒ Boolean  (readonly)  



  

    

Determine whether there is a last node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 574



static VALUE rxml_document_last_q(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->last == NULL)
    return (Qfalse);
  else
    return (Qtrue);
}


  








  

    #next  ⇒ node  (readonly)  



  

    

Obtain the next node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 592



static VALUE rxml_document_next_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->next == NULL)
    return (Qnil);

  return rxml_node_wrap(xdoc->next);
}


  








  

    #next?  ⇒ Boolean  (readonly)  



  

    

Determine whether there is a next node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 610



static VALUE rxml_document_next_q(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->next == NULL)
    return (Qfalse);
  else
    return (Qtrue);
}


  








  

    #parent  ⇒ node  (readonly)  



  

    

Obtain the parent node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 641



static VALUE rxml_document_parent_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->parent == NULL)
    return (Qnil);

  return rxml_node_wrap(xdoc->parent);
}


  








  

    #parent?  ⇒ Boolean  (readonly)  



  

    

Determine whether there is a parent node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 659



static VALUE rxml_document_parent_q(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->parent == NULL)
    return (Qfalse);
  else
    return (Qtrue);
}


  








  

    #prev  ⇒ node  (readonly)  



  

    

Obtain the previous node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 677



static VALUE rxml_document_prev_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->prev == NULL)
    return (Qnil);

  return rxml_node_wrap(xdoc->prev);
}


  








  

    #prev?  ⇒ Boolean  (readonly)  



  

    

Determine whether there is a previous node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 695



static VALUE rxml_document_prev_q(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);

  if (xdoc->prev == NULL)
    return (Qfalse);
  else
    return (Qtrue);
}


  








  

    #root  ⇒ node  (rw)  



  

    

Obtain the root node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 713



static VALUE rxml_document_root_get(VALUE self)
{
  xmlDocPtr xdoc;
  xmlNodePtr root;

  Data_Get_Struct(self, xmlDoc, xdoc);
  root = xmlDocGetRootElement(xdoc);

  if (root == NULL)
    return (Qnil);

  return rxml_node_wrap(root);
}


  








  

    #root=(node)   (rw)  



  

    

Set the root node.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 733



static VALUE rxml_document_root_set(VALUE self, VALUE node)
{
  xmlDocPtr xdoc;
  xmlNodePtr xnode;

  if (rb_obj_is_kind_of(node, cXMLNode) == Qfalse)
    rb_raise(rb_eTypeError, "must pass an XML::Node type object");

  Data_Get_Struct(self, xmlDoc, xdoc);
  Data_Get_Struct(node, xmlNode, xnode);

  if (xnode->doc != NULL && xnode->doc != xdoc)
    rb_raise(eXMLError, "Nodes belong to different documents.  You must first import the node by calling LibXML::XML::Document.import");

  xmlDocSetRootElement(xdoc, xnode);

  // Ruby no longer manages this nodes memory
  rxml_node_unmanage(xnode, node);

  return node;
}


  








  

    #standalone?  ⇒ Boolean  (readonly)  



  

    

Determine whether this is a standalone document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 822



static VALUE rxml_document_standalone_q(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);
  if (xdoc->standalone)
    return (Qtrue);
  else
    return (Qfalse);
}


  








  

    #xhtml?  ⇒ Boolean  (readonly)  



  

    

Determine whether this is an XHTML document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 928



static VALUE rxml_document_xhtml_q(VALUE self)
{
  xmlDocPtr xdoc;
	xmlDtdPtr xdtd;
  Data_Get_Struct(self, xmlDoc, xdoc);
	xdtd = xmlGetIntSubset(xdoc);
  if (xdtd != NULL && xmlIsXHTML(xdtd->SystemID, xdtd->ExternalID) > 0)
    return (Qtrue);
  else
    return (Qfalse);
}


  







Instance Method Details



  

    #canonicalize(*args)  
  

  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 183



static VALUE
rxml_document_canonicalize(int argc, VALUE *argv, VALUE self)
{
  VALUE result = Qnil;
  xmlDocPtr xdoc;
  xmlChar *buffer = NULL;
  VALUE option_hash = Qnil;
  VALUE o_nodes = Qnil;

  // :comments option
  int comments = 0;
  // :mode option
  int c14n_mode = XML_C14N_1_0;
  // :inclusive_ns_prefixes option (ARRAY)

  xmlChar * inc_ns_prefixes_ptr[C14N_NS_LIMIT];

  // :nodes option (ARRAY)
  xmlNodePtr  node_ptr_array[C14N_NODESET_LIMIT];
  xmlNodeSet nodeset = {
    0, C14N_NODESET_LIMIT, NULL
  };

  /* At least one NULL value must be defined in the array or the extension will
   * segfault when using XML_C14N_EXCLUSIVE_1_0 mode.
   * API docs: "list of inclusive namespace prefixes ended with a NULL"
   */
  inc_ns_prefixes_ptr[0] = NULL;

  rb_scan_args(argc, argv, "01", &option_hash);
  // Do stuff if ruby hash passed as argument
  if (!NIL_P(option_hash)) 
  {
	VALUE o_comments = Qnil;
	VALUE o_mode = Qnil;
	VALUE o_i_ns_prefixes = Qnil;
		
    Check_Type(option_hash, T_HASH);

    o_comments = rb_hash_aref(option_hash, ID2SYM(rb_intern("comments")));
    comments = (RTEST(o_comments) ? 1 : 0);

    o_mode = rb_hash_aref(option_hash, ID2SYM(rb_intern("mode")));
    if (!NIL_P(o_mode)) 
	{
      Check_Type(o_mode, T_FIXNUM);
      c14n_mode = NUM2INT(o_mode);
      //TODO: clean this up
      //if (c14n_mode > 2) { c14n_mode = 0; }
      //mode_int = (NUM2INT(o_mode) > 2 ? 0 : NUM2INT(o_mode));
    }

    o_i_ns_prefixes = rb_hash_aref(option_hash, ID2SYM(rb_intern("inclusive_ns_prefixes")));
    if (!NIL_P(o_i_ns_prefixes)) 
	{
      int i;
      int p = 0; //pointer array index
      VALUE *list_in = NULL;
      long list_size = 0;

	  Check_Type(o_i_ns_prefixes, T_ARRAY);
      list_in = RARRAY_PTR(o_i_ns_prefixes);
      list_size = RARRAY_LEN(o_i_ns_prefixes);

      if (list_size > 0) 
	  {
        for(i=0; i < list_size; ++i) {
          if (p >= C14N_NS_LIMIT) { break; }

          if (RTEST(list_in[i])) 
		  {
            if (TYPE(list_in[i]) == T_STRING) 
			{
              inc_ns_prefixes_ptr[p] = (xmlChar *)StringValueCStr(list_in[i]);
              p++;
            }
          }
        }
      }

      // ensure p is not out of bound
      p = (p >= C14N_NS_LIMIT ? (C14N_NS_LIMIT-1) : p);

      // API docs: "list of inclusive namespace prefixes ended with a NULL"
      // Set last element to NULL
      inc_ns_prefixes_ptr[p] = NULL;
    }
    //o_ns_prefixes will free at end of block

    o_nodes = rb_hash_aref(option_hash, ID2SYM(rb_intern("nodes")));
    if (!NIL_P(o_nodes)) 
	{
      int i;
      int p = 0; // index of pointer array
      VALUE * list_in = NULL;
      long node_list_size = 0;

	  if (CLASS_OF(o_nodes) == cXMLXPathObject)
	  {
		  o_nodes = rb_funcall(o_nodes, rb_intern("to_a"), 0);
	  }
	  else
	  {
		  Check_Type(o_nodes, T_ARRAY);
	  }
      list_in = RARRAY_PTR(o_nodes);
      node_list_size = RARRAY_LEN(o_nodes);

      for (i=0; i < node_list_size; ++i)
	  {
        if (p >= C14N_NODESET_LIMIT) { break; }

        if (RTEST(list_in[i])) 
		{
          xmlNodePtr node_ptr;
          Data_Get_Struct(list_in[i], xmlNode, node_ptr);
          node_ptr_array[p] = node_ptr;
          p++;
        }
      }

      // Need to set values in nodeset struct
      nodeset.nodeNr = (node_list_size > C14N_NODESET_LIMIT ?
                        C14N_NODESET_LIMIT :
                        (int)node_list_size);
      nodeset.nodeTab = node_ptr_array;
    }
  }//option_hash

  Data_Get_Struct(self, xmlDoc, xdoc);
  xmlC14NDocDumpMemory(xdoc,
                       (nodeset.nodeNr == 0 ? NULL : &nodeset),
                       c14n_mode,
                       inc_ns_prefixes_ptr,
                       comments,
                       &buffer);

  if (buffer)
  {
    result = rxml_new_cstr( buffer, NULL);
    xmlFree(buffer);
  }

  return result;
}


  








  

    #context(namespaces = nil)  ⇒ XPath::Context   



  

    

Returns a new XML::XPathContext for the document.



Namespaces is an optional array of XML::NS objects


  



  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 85



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


  








  

    #debug  ⇒ Boolean   



  

    

Print libxml debugging information to stdout. Requires that libxml was compiled with debugging enabled.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 455



static VALUE rxml_document_debug(VALUE self)
{
#ifdef LIBXML_DEBUG_ENABLED
  xmlDocPtr xdoc;
  Data_Get_Struct(self, xmlDoc, xdoc);
  xmlDebugDumpDocument(NULL, xdoc);
  return Qtrue;
#else
  rb_warn("libxml was compiled without debugging support.");
  return Qfalse;
#endif
}


  








  

    #debug_dump  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 173



def debug_dump
  warn('Document#debug_dump is deprecated.  Use Document#debug instead.')
  self.debug
end


  








  

    #debug_dump_head  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 178



def debug_dump_head
  warn('Document#debug_dump_head is deprecated.  Use Document#debug instead.')
  self.debug
end


  








  

    #debug_format_dump  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 183



def debug_format_dump
  warn('Document#debug_format_dump is deprecated.  Use Document#to_s instead.')
  self.to_s
end


  








  

    #dump  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 163



def dump
  warn('Document#dump is deprecated.  Use Document#to_s instead.')
  self.to_s
end


  








  

    #find(xpath, nslist = nil)  ⇒ XML::XPath::Object   



  

    

Return the nodes matching the specified xpath expression, optionally using the specified namespace.  For more information about working with namespaces, please refer to the XPath documentation.



Parameters:


  • 

    xpath - The xpath expression as a string
    

  • 

    namespaces - An optional list of namespaces (see 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 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


  



  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 122



def find(xpath, nslist = nil)
  self.context(nslist).find(xpath)
end


  








  

    #find_first(xpath, nslist = nil)  
  



  

    

Return the first node matching the specified xpath expression. For more information, please refer to the documentation for #find.


  



  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 129



def find_first(xpath, nslist = nil)
  find(xpath, nslist).first
end


  








  

    #format_dump  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 168



def format_dump
  warn('Document#format_dump is deprecated.  Use Document#to_s instead.')
  self.to_s
end


  








  

    #import(node)  ⇒ XML::Node   



  

    

Creates a copy of the node that can be inserted into the current document.



IMPORTANT - The returned node MUST be inserted into the document. This is because the returned node refereces internal ::LibXML data structures owned by the document.  Therefore, if the document is is freed before the the node is freed a segmentation fault will occur.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 534



static VALUE rxml_document_import(VALUE self, VALUE node)
{
  xmlDocPtr xdoc;
  xmlNodePtr xnode, xresult;

  Data_Get_Struct(self, xmlDoc, xdoc);
  Data_Get_Struct(node, xmlNode, xnode);

  xresult = xmlDocCopyNode(xnode, xdoc, 1);

  if (xresult == NULL)
    rxml_raise(xmlGetLastError());

  return rxml_node_wrap(xresult);
}


  








  

    #type  ⇒ Numeric   



  

    

Obtain this node’s type identifier.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 628



static VALUE rxml_document_node_type(VALUE self)
{
  xmlNodePtr xnode;
  Data_Get_Struct(self, xmlNode, xnode);
  return (INT2NUM(xnode->type));
}


  








  

    #node_type_name  
  



  

    

Returns this node’s type name


  



  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 134



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


  








  

    #order_elements!    



  

    

Call this routine to speed up XPath computation on static documents. This stamps all the element nodes with the document order.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 978



static VALUE rxml_document_order_elements(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);
  return LONG2FIX(xmlXPathOrderDocElems(xdoc));
}


  








  

    #rb_encoding  ⇒ Encoding   



  

    

Returns the Ruby encoding specified by this document (available on Ruby 1.9.x and higher).


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 492



static VALUE rxml_document_rb_encoding_get(VALUE self)
{
  xmlDocPtr xdoc;
  rb_encoding* rbencoding;
  Data_Get_Struct(self, xmlDoc, xdoc);

  rbencoding = rxml_xml_encoding_to_rb_encoding(mXMLEncoding, xmlParseCharEncoding((const char*)xdoc->encoding));
  return rb_enc_from_encoding(rbencoding);
}


  








  

    #reader  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/libxml/document.rb', line 188



def reader
  warn('Document#reader is deprecated.  Use XML::Reader.document(self) instead.')
  XML::Reader.document(self)
end


  








  

    

      #save(filename)  ⇒ Integer 
      #save(filename, :indent)  ⇒ true, :encoding 
    

  



  

    

Saves a document to a file.  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 LibXML::XML.indent_tree_output is true.  If :indent is set to false, then both indentation and line feeds are removed from the result.



:encoding - Specifies the output encoding of the string.  It defaults to the original encoding of the document (see #encoding.  To override the orginal encoding, use one of the Encoding encoding constants.


  





  


  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 772



static VALUE rxml_document_save(int argc, VALUE *argv, VALUE self)
{
  VALUE options = Qnil;
  VALUE filename = Qnil;
  xmlDocPtr xdoc;
  int indent = 1;
  const char *xfilename;
  const xmlChar *xencoding;
  int length;

  rb_scan_args(argc, argv, "11", &filename, &options);

  Check_Type(filename, T_STRING);
  xfilename = StringValuePtr(filename);

  Data_Get_Struct(self, xmlDoc, xdoc);
  xencoding = xdoc->encoding;

  if (!NIL_P(options))
  {
    VALUE rencoding, rindent;
    Check_Type(options, T_HASH);
    rencoding = rb_hash_aref(options, ID2SYM(rb_intern("encoding")));
    rindent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));

    if (rindent == Qfalse)
      indent = 0;

    if (rencoding != Qnil)
    {
      xencoding = (const xmlChar*)xmlGetCharEncodingName((xmlCharEncoding)NUM2INT(rencoding));
      if (!xencoding)
        rb_raise(rb_eArgError, "Unknown encoding value: %d", NUM2INT(rencoding));
    }
  }

  length = xmlSaveFormatFileEnc(xfilename, xdoc, (const char*)xencoding, indent);

  if (length == -1)
    rxml_raise(xmlGetLastError());

  return (INT2NUM(length));
}


  








  

    

      #to_s  ⇒ "string" 
      #to_s(:indent)  ⇒ true, :encoding 
    

  



  

    

Converts a document, and all of its children, to a string representation. 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 LibXML::XML.indent_tree_output is true.  If :indent is set to false, then both indentation and line feeds are removed from the result.



:encoding - Specifies the output encoding of the string.  It defaults to XML::Encoding::UTF8.  To change it, use one of the Encoding encoding constants.


  





  


  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 850



static VALUE rxml_document_to_s(int argc, VALUE *argv, VALUE self)
{
  VALUE result;
  VALUE options = Qnil;
  xmlDocPtr xdoc;
  int indent = 1;
  const xmlChar *xencoding = (const xmlChar*) "UTF-8";
  xmlChar *buffer;
  int length;

  rb_scan_args(argc, argv, "01", &options);

  if (!NIL_P(options))
  {
    VALUE rencoding, rindent;
    Check_Type(options, T_HASH);
    rencoding = rb_hash_aref(options, ID2SYM(rb_intern("encoding")));
    rindent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));

    if (rindent == Qfalse)
      indent = 0;

    if (rencoding != Qnil)
    {
      xencoding = (const xmlChar*)xmlGetCharEncodingName((xmlCharEncoding)NUM2INT(rencoding));
      if (!xencoding)
        rb_raise(rb_eArgError, "Unknown encoding value: %d", NUM2INT(rencoding));
    }
  }

  Data_Get_Struct(self, xmlDoc, xdoc);
  xmlDocDumpFormatMemoryEnc(xdoc, &buffer, &length, (const char*)xencoding, indent);

  result = rxml_new_cstr(buffer, xencoding);
  xmlFree(buffer);
  return result;
}


  








  

    #url  ⇒ "url"   



  

    

Obtain this document’s source URL, if any.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 894



static VALUE rxml_document_url_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);
  if (xdoc->URL == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr( xdoc->URL, NULL));
}


  








  

    #validate(dtd)  ⇒ Boolean   



  

    

Validate this document against the specified XML::DTD. If the document is valid the method returns true.  Otherwise an exception is raised with validation information.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 1060



static VALUE rxml_document_validate_dtd(VALUE self, VALUE dtd)
{
  xmlValidCtxt ctxt;
  xmlDocPtr xdoc;
  xmlDtdPtr xdtd;

  Data_Get_Struct(self, xmlDoc, xdoc);
  Data_Get_Struct(dtd, xmlDtd, xdtd);

  /* Setup context */
  memset(&ctxt, 0, sizeof(xmlValidCtxt));

  if (xmlValidateDtd(&ctxt, xdoc, xdtd))
  {
    return Qtrue;
  }
  else
  {
    rxml_raise(xmlGetLastError());
    return Qfalse;
  }
}


  








  

    #validate_relaxng(relaxng)    



  

    

Validate this document against the specified RelaxNG. If the document is valid the method returns true.  Otherwise an exception is raised with validation information.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 1027



static VALUE rxml_document_validate_relaxng(VALUE self, VALUE relaxng)
{
  xmlRelaxNGValidCtxtPtr vptr;
  xmlDocPtr xdoc;
  xmlRelaxNGPtr xrelaxng;
  int is_invalid;

  Data_Get_Struct(self, xmlDoc, xdoc);
  Data_Get_Struct(relaxng, xmlRelaxNG, xrelaxng);

  vptr = xmlRelaxNGNewValidCtxt(xrelaxng);

  is_invalid = xmlRelaxNGValidateDoc(vptr, xdoc);
  xmlRelaxNGFreeValidCtxt(vptr);
  if (is_invalid)
  {
    rxml_raise(xmlGetLastError());
    return Qfalse;
  }
  else
  {
    return Qtrue;
  }
}


  








  

    #validate_schema(schema)    



  

    

Validate this document against the specified Schema. If the document is valid the method returns true.  Otherwise an exception is raised with validation information.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 994



static VALUE rxml_document_validate_schema(VALUE self, VALUE schema)
{
  xmlSchemaValidCtxtPtr vptr;
  xmlDocPtr xdoc;
  xmlSchemaPtr xschema;
  int is_invalid;

  Data_Get_Struct(self, xmlDoc, xdoc);
  Data_Get_Struct(schema, xmlSchema, xschema);

  vptr = xmlSchemaNewValidCtxt(xschema);

  is_invalid = xmlSchemaValidateDoc(vptr, xdoc);
  xmlSchemaFreeValidCtxt(vptr);
  if (is_invalid)
  {
    rxml_raise(xmlGetLastError());
    return Qfalse;
  }
  else
  {
    return Qtrue;
  }
}


  








  

    #version  ⇒ "version"   



  

    

Obtain the ::LibXML::XML version specified by this document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 911



static VALUE rxml_document_version_get(VALUE self)
{
  xmlDocPtr xdoc;

  Data_Get_Struct(self, xmlDoc, xdoc);
  if (xdoc->version == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr( xdoc->version, NULL));
}


  








  

    #xinclude  ⇒ Numeric   



  

    

Process xinclude directives in this document.


  



  [ GitHub ]


  

  


# File 'ext/libxml/ruby_xml_document.c', line 946



static VALUE rxml_document_xinclude(VALUE self)
{
#ifdef LIBXML_XINCLUDE_ENABLED
  xmlDocPtr xdoc;

  int ret;

  Data_Get_Struct(self, xmlDoc, xdoc);
  ret = xmlXIncludeProcess(xdoc);
  if (ret >= 0)
  {
    return(INT2NUM(ret));
  }
  else
  {
    rxml_raise(xmlGetLastError());
    return Qnil;
  }
#else
  rb_warn(
      "libxml was compiled without XInclude support.  Please recompile libxml and ruby-libxml");
  return (Qfalse);
#endif
}