libxml-ruby 0.9.5 → 0.9.6

data/ext/libxml/{ruby_xml_ns.h → ruby_xml_namespaces.h}

@@ -2,11 +2,10 @@
 
 /* Please see the LICENSE file for copyright and distribution information */
 
-#ifndef __rxml_NS__
-#define __rxml_NS__
+#ifndef __RXML_NAMESPACES__
+#define __RXML_NAMESPACES__
 
-extern VALUE cXMLNS;
+extern VALUE cXMLNamespaces;
 
-void ruby_init_xml_ns(void);
-VALUE rxml_ns_wrap(xmlNsPtr ns);
+void ruby_init_xml_namespaces(void);
 #endif

data/ext/libxml/ruby_xml_node.c

@@ -1,7 +1,3 @@
-/* $Id: ruby_xml_node.c 650 2008-11-30 03:40:22Z cfis $ */
-
-/* Please see the LICENSE file for copyright and distribution information */
-
 #include "ruby_libxml.h"
 #include "ruby_xml_node.h"
 
@@ -88,7 +84,7 @@ void rxml_node_mark(xmlNodePtr xnode)
   rxml_node_mark_common(xnode);
 }
 
-VALUE rxml_node_wrap(VALUE class, xmlNodePtr xnode)
+VALUE rxml_node_wrap(VALUE klass, xmlNodePtr xnode)
 {
   VALUE obj;
 
@@ -98,7 +94,7 @@ VALUE rxml_node_wrap(VALUE class, xmlNodePtr xnode)
     return (VALUE) xnode->_private;
   }
 
-  obj = Data_Wrap_Struct(class, rxml_node_mark, rxml_node2_free, xnode);
+  obj = Data_Wrap_Struct(klass, rxml_node_mark, rxml_node2_free, xnode);
 
   xnode->_private = (void*) obj;
   return obj;
@@ -341,6 +337,26 @@ static VALUE rxml_node_content_stripped_get(VALUE self)
   return (result);
 }
 
+/*
+ * call-seq:
+ *    node.debug -> true|false
+ *
+ * Print libxml debugging information to stdout.
+ * Requires that libxml was compiled with debugging enabled.
+*/
+static VALUE rxml_node_debug(VALUE self)
+{
+#ifdef LIBXML_DEBUG_ENABLED
+  xmlNodePtr xnode;
+  Data_Get_Struct(self, xmlNode, xnode);
+  xmlDebugDumpNode(NULL, xnode, 2);
+  return Qtrue;
+#else
+  rb_warn("libxml was compiled without debugging support.")
+  return Qfalse;
+#endif
+}
+
 /*
  * call-seq:
  *    node.first -> XML::Node
@@ -496,46 +512,72 @@ static VALUE rxml_node_doc(VALUE self)
 
 /*
  * call-seq:
- *    node.dump -> (true|nil)
+ *    node.to_s -> "string"
+ *    node.to_s(:indent => true, :encoding => 'UTF-8', :level => 0) -> "string"
  *
- * Dump this node to stdout.
- */
-static VALUE rxml_node_dump(VALUE self)
+ * Converts a node, 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 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::Input::UTF8.  To change it, use one of the
+ * XML::Input encoding constants. */
+
+static VALUE rxml_node_to_s(int argc, VALUE *argv, VALUE self)
 {
+  VALUE options = Qnil;
   xmlNodePtr xnode;
-  xmlBufferPtr buf;
+  xmlCharEncodingHandlerPtr encodingHandler;
+  xmlOutputBufferPtr output;
 
-  Data_Get_Struct(self, xmlNode, xnode);
+  int level = 0;
+  int indent = 1;
+  const char *encoding = "UTF-8";
 
-  if (xnode->doc == NULL)
-    return (Qnil);
+  rb_scan_args(argc, argv, "01", &options);
 
-  buf = xmlBufferCreate();
-  xmlNodeDump(buf, xnode->doc, xnode, 0, 1);
-  xmlBufferDump(stdout, buf);
-  xmlBufferFree(buf);
-  return (Qtrue);
-}
+  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")));
 
-/*
- * call-seq:
- *    node.debug_dump -> (true|nil)
- *
- * Dump this node to stdout, including any debugging
- * information.
- */
-static VALUE rxml_node_debug_dump(VALUE self)
-{
-  xmlNodePtr xnode;
-  Data_Get_Struct(self, xmlNode, xnode);
+    if (rindent == Qfalse)
+      indent = 0;
 
-  if (xnode->doc == NULL)
-    return (Qnil);
+    if (rlevel != Qnil)
+      level = NUM2INT(rlevel);
 
-  xmlElemDump(stdout, xnode->doc, xnode);
-  return (Qtrue);
+    if (rencoding != Qnil)
+      encoding = RSTRING_PTR(rxml_input_encoding_to_s(cXMLInput, rencoding));
+  }
+
+  encodingHandler = xmlFindCharEncodingHandler(encoding);
+  output = xmlAllocOutputBuffer(encodingHandler);
+
+  Data_Get_Struct(self, xmlNode, xnode);
+  xmlNodeDumpOutput(output, xnode->doc, xnode, level, indent, encoding);
+  xmlOutputBufferFlush(output);
+
+  if (output->conv)
+    return rb_str_new2((const char*) output->conv->content);
+  else
+    return rb_str_new2((const char*) output->buffer->content);
 }
 
+
 /*
  * call-seq:
  *    node.each -> XML::Node
@@ -579,7 +621,6 @@ static VALUE rxml_node_empty_q(VALUE self)
   return ((xmlIsBlankNode(xnode) == 1) ? Qtrue : Qfalse);
 }
 
-static VALUE rxml_node_to_s(VALUE self);
 
 /*
  * call-seq:
@@ -593,7 +634,7 @@ if(self == other)
 {
   return Qtrue;
 }
-else if NIL_P(other)
+else if (NIL_P(other))
 {
   return Qfalse;
 }
@@ -605,8 +646,8 @@ else
   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(self);
-  other_xml = rxml_node_to_s(other);
+  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));
 }
 }
@@ -836,134 +877,6 @@ static VALUE rxml_node_name_set(VALUE self, VALUE name)
   return (Qtrue);
 }
 
-/*
- * call-seq:
- *    node.namespace -> [namespace, ..., namespace]
- *
- * Obtain an array of +XML::NS+ objects representing
- * this node's xmlns attributes
- */
-static VALUE rxml_node_namespace_get(VALUE self)
-{
-  xmlNodePtr xnode;
-  xmlNsPtr *nsList, *cur;
-  VALUE arr, ns;
-
-  Data_Get_Struct(self, xmlNode, xnode);
-  if (xnode == NULL)
-    return (Qnil);
-
-  nsList = xmlGetNsList(xnode->doc, xnode);
-
-  if (nsList == NULL)
-    return (Qnil);
-
-  arr = rb_ary_new();
-  for (cur = nsList; *cur != NULL; cur++)
-  {
-    ns = rxml_ns_wrap(*cur);
-    if (ns == Qnil)
-      continue;
-    else
-      rb_ary_push(arr, ns);
-  }
-  xmlFree(nsList);
-
-  return (arr);
-}
-
-/*
- * call-seq:
- *    node.namespace_node -> namespace.
- *
- * Obtain this node's namespace node.
- */
-static VALUE rxml_node_namespace_get_node(VALUE self)
-{
-  xmlNodePtr xnode;
-
-  Data_Get_Struct(self, xmlNode, xnode);
-  if (xnode->ns == NULL)
-    return (Qnil);
-  else
-    return rxml_ns_wrap(xnode->ns);
-}
-
-// TODO namespace_set can take varargs (in fact, must if used
-//      with strings), but I cannot see how you can call
-//      that version, apart from with 'send'
-//
-//      Would sure be nice to support foo.namespace['foo'] = 'bar'
-//      but maybe that's not practical...
-
-/*
- * call-seq:
- *    node.namespace = namespace
- *
- * Add the specified XML::NS object to this node's xmlns attributes.
- */
-static VALUE rxml_node_namespace_set(int argc, VALUE *argv, VALUE self)
-{
-  VALUE rns, rprefix;
-  xmlNodePtr xnode;
-  xmlNsPtr xns;
-  char *cp, *href;
-
-  Data_Get_Struct(self, xmlNode, xnode);
-  switch (argc)
-  {
-  case 1:
-    rns = argv[0];
-    if (TYPE(rns) == T_STRING)
-    {
-      cp = strchr(StringValuePtr(rns), (int) ':');
-      if (cp == NULL)
-      {
-        rprefix = rns;
-        href = NULL;
-      }
-      else
-      {
-        rprefix = rb_str_new(StringValuePtr(rns), (int) ((long) cp
-            - (long) StringValuePtr(rns)));
-        href = &cp[1]; /* skip the : */
-      }
-    }
-    else if (rb_obj_is_kind_of(rns, cXMLNS) == Qtrue)
-    {
-      Data_Get_Struct(self, xmlNs, xns);
-      xmlSetNs(xnode, xns);
-      return (rns);
-    }
-    else
-      rb_raise(rb_eTypeError, "must pass a string or an XML::Ns object");
-
-    /* Fall through to next case because when argc == 1, we need to
-     * manually setup the additional args unless the arg passed is of
-     * cXMLNS type */
-  case 2:
-    /* Don't want this code run in the fall through case */
-    if (argc == 2)
-    {
-      rprefix = argv[0];
-      href = StringValuePtr(argv[1]);
-    }
-
-    xns = xmlNewNs(xnode, (xmlChar*) href, (xmlChar*) StringValuePtr(rprefix));
-    if (xns == NULL)
-      rxml_raise(&xmlLastError);
-    else
-      return rxml_ns_wrap(xns);
-    break;
-
-  default:
-    rb_raise(rb_eArgError, "wrong number of arguments (1 or 2)");
-  }
-
-  /* can't get here */
-  return (Qnil);
-}
-
 /*
  * call-seq:
  *    node.next -> XML::Node
@@ -1005,55 +918,6 @@ static VALUE rxml_node_next_set(VALUE self, VALUE rnode)
   return (rxml_node_wrap(cXMLNode, ret));
 }
 
-/*
- * call-seq:
- *    node.ns? -> (true|false)
- *
- * Determine whether this node has a namespace.
- */
-static VALUE rxml_node_ns_q(VALUE self)
-{
-  xmlNodePtr xnode;
-  Data_Get_Struct(self, xmlNode, xnode);
-  if (xnode->ns == NULL)
-    return (Qfalse);
-  else
-    return (Qtrue);
-}
-
-/*
- * call-seq:
- *    node.ns_def? -> (true|false)
- *
- * Obtain an array of +XML::NS+ objects representing
- * this node's xmlns attributes
- */
-static VALUE rxml_node_ns_def_q(VALUE self)
-{
-  xmlNodePtr xnode;
-  Data_Get_Struct(self, xmlNode, xnode);
-  if (xnode->nsDef == NULL)
-    return (Qfalse);
-  else
-    return (Qtrue);
-}
-
-/*
- * call-seq:
- *    node.ns_def -> namespace
- *
- * Obtain this node's default namespace.
- */
-static VALUE rxml_node_ns_def_get(VALUE self)
-{
-  xmlNodePtr xnode;
-  Data_Get_Struct(self, xmlNode, xnode);
-  if (xnode->nsDef == NULL)
-    return (Qnil);
-  else
-    return (rxml_ns_wrap(xnode->nsDef));
-}
-
 /*
  * call-seq:
  *    node.parent -> XML::Node
@@ -1230,38 +1094,6 @@ static VALUE rxml_node_remove_ex(VALUE self)
   return self;
 }
 
-/*
- * call-seq:
- *    node.search_href -> namespace
- *
- * Search for a namespace by href.
- */
-static VALUE rxml_node_search_href(VALUE self, VALUE href)
-{
-  xmlNodePtr xnode;
-
-  Check_Type(href, T_STRING);
-  Data_Get_Struct(self, xmlNode, xnode);
-  return (rxml_ns_wrap(xmlSearchNsByHref(xnode->doc, xnode,
-      (xmlChar*) StringValuePtr(href))));
-}
-
-/*
- * call-seq:
- *    node.search_ns -> namespace
- *
- * Search for a namespace by namespace.
- */
-static VALUE rxml_node_search_ns(VALUE self, VALUE ns)
-{
-  xmlNodePtr xnode;
-
-  Check_Type(ns, T_STRING);
-  Data_Get_Struct(self, xmlNode, xnode);
-  return (rxml_ns_wrap(xmlSearchNs(xnode->doc, xnode,
-      (xmlChar*) StringValuePtr(ns))));
-}
-
 /*
  * call-seq:
  *    node.sibling(node) -> XML::Node
@@ -1324,28 +1156,6 @@ static VALUE rxml_node_space_preserve_set(VALUE self, VALUE bool)
   return (Qnil);
 }
 
-/*
- * call-seq:
- *    node.to_s -> "string"
- *
- * Coerce this node to a string representation of
- * it's XML.
- */
-static VALUE rxml_node_to_s(VALUE self)
-{
-  xmlNodePtr xnode;
-  xmlBufferPtr buf;
-  VALUE result;
-
-  Data_Get_Struct(self, xmlNode, xnode);
-  buf = xmlBufferCreate();
-  xmlNodeDump(buf, xnode->doc, xnode, 0, 1);
-  result = rb_str_new2((const char*) buf->content);
-
-  xmlBufferFree(buf);
-  return result;
-}
-
 /*
  * call-seq:
  *    node.type -> num
@@ -1430,20 +1240,16 @@ void ruby_init_xml_node(void)
   rb_define_const(cXMLNode, "ELEMENT_NODE", INT2FIX(XML_ELEMENT_NODE));
   rb_define_const(cXMLNode, "ATTRIBUTE_NODE", INT2FIX(XML_ATTRIBUTE_NODE));
   rb_define_const(cXMLNode, "TEXT_NODE", INT2FIX(XML_TEXT_NODE));
-  rb_define_const(cXMLNode, "CDATA_SECTION_NODE", INT2FIX(
-      XML_CDATA_SECTION_NODE));
+  rb_define_const(cXMLNode, "CDATA_SECTION_NODE", INT2FIX(XML_CDATA_SECTION_NODE));
   rb_define_const(cXMLNode, "ENTITY_REF_NODE", INT2FIX(XML_ENTITY_REF_NODE));
   rb_define_const(cXMLNode, "ENTITY_NODE", INT2FIX(XML_ENTITY_NODE));
   rb_define_const(cXMLNode, "PI_NODE", INT2FIX(XML_PI_NODE));
   rb_define_const(cXMLNode, "COMMENT_NODE", INT2FIX(XML_COMMENT_NODE));
   rb_define_const(cXMLNode, "DOCUMENT_NODE", INT2FIX(XML_DOCUMENT_NODE));
-  rb_define_const(cXMLNode, "DOCUMENT_TYPE_NODE", INT2FIX(
-      XML_DOCUMENT_TYPE_NODE));
-  rb_define_const(cXMLNode, "DOCUMENT_FRAG_NODE", INT2FIX(
-      XML_DOCUMENT_FRAG_NODE));
+  rb_define_const(cXMLNode, "DOCUMENT_TYPE_NODE", INT2FIX(XML_DOCUMENT_TYPE_NODE));
+  rb_define_const(cXMLNode, "DOCUMENT_FRAG_NODE", INT2FIX(XML_DOCUMENT_FRAG_NODE));
   rb_define_const(cXMLNode, "NOTATION_NODE", INT2FIX(XML_NOTATION_NODE));
-  rb_define_const(cXMLNode, "HTML_DOCUMENT_NODE", INT2FIX(
-      XML_HTML_DOCUMENT_NODE));
+  rb_define_const(cXMLNode, "HTML_DOCUMENT_NODE", INT2FIX(XML_HTML_DOCUMENT_NODE));
   rb_define_const(cXMLNode, "DTD_NODE", INT2FIX(XML_DTD_NODE));
   rb_define_const(cXMLNode, "ELEMENT_DECL", INT2FIX(XML_ELEMENT_DECL));
   rb_define_const(cXMLNode, "ATTRIBUTE_DECL", INT2FIX(XML_ATTRIBUTE_DECL));
@@ -1493,11 +1299,9 @@ void ruby_init_xml_node(void)
   rb_define_method(cXMLNode, "copy", rxml_node_copy, 1);
   rb_define_method(cXMLNode, "content", rxml_node_content_get, 0);
   rb_define_method(cXMLNode, "content=", rxml_node_content_set, 1);
-  rb_define_method(cXMLNode, "content_stripped",
-      rxml_node_content_stripped_get, 0);
+  rb_define_method(cXMLNode, "content_stripped", rxml_node_content_stripped_get, 0);
+  rb_define_method(cXMLNode, "debug", rxml_node_debug, 0);
   rb_define_method(cXMLNode, "doc", rxml_node_doc, 0);
-  rb_define_method(cXMLNode, "dump", rxml_node_dump, 0);
-  rb_define_method(cXMLNode, "debug_dump", rxml_node_debug_dump, 0);
   rb_define_method(cXMLNode, "empty?", rxml_node_empty_q, 0);
   rb_define_method(cXMLNode, "eql?", rxml_node_eql_q, 1);
   rb_define_method(cXMLNode, "lang", rxml_node_lang_get, 0);
@@ -1505,25 +1309,16 @@ void ruby_init_xml_node(void)
   rb_define_method(cXMLNode, "line_num", rxml_node_line_num, 0);
   rb_define_method(cXMLNode, "name", rxml_node_name_get, 0);
   rb_define_method(cXMLNode, "name=", rxml_node_name_set, 1);
-  rb_define_method(cXMLNode, "namespace", rxml_node_namespace_get, 0);
-  rb_define_method(cXMLNode, "namespace_node", rxml_node_namespace_get_node, 0);
-  rb_define_method(cXMLNode, "namespace=", rxml_node_namespace_set, -1);
   rb_define_method(cXMLNode, "node_type", rxml_node_type, 0);
-  rb_define_method(cXMLNode, "ns", rxml_node_namespace_get, 0);
-  rb_define_method(cXMLNode, "ns?", rxml_node_ns_q, 0);
-  rb_define_method(cXMLNode, "ns_def?", rxml_node_ns_def_q, 0);
-  rb_define_method(cXMLNode, "ns_def", rxml_node_ns_def_get, 0);
   rb_define_method(cXMLNode, "path", rxml_node_path, 0);
   rb_define_method(cXMLNode, "pointer", rxml_node_pointer, 1);
   rb_define_method(cXMLNode, "remove!", rxml_node_remove_ex, 0);
-  rb_define_method(cXMLNode, "search_ns", rxml_node_search_ns, 1);
-  rb_define_method(cXMLNode, "search_href", rxml_node_search_href, 1);
   rb_define_method(cXMLNode, "space_preserve", rxml_node_space_preserve_get, 0);
   rb_define_method(cXMLNode, "space_preserve=", rxml_node_space_preserve_set, 1);
-  rb_define_method(cXMLNode, "to_s", rxml_node_to_s, 0);
+  rb_define_method(cXMLNode, "to_s", rxml_node_to_s, -1);
   rb_define_method(cXMLNode, "xlink?", rxml_node_xlink_q, 0);
   rb_define_method(cXMLNode, "xlink_type", rxml_node_xlink_type, 0);
   rb_define_method(cXMLNode, "xlink_type_name", rxml_node_xlink_type_name, 0);
 
   rb_define_alias(cXMLNode, "==", "eql?");
-}
+}