libxsl-ruby 0.3.6

data/ext/xml/libxslt.h

@@ -0,0 +1,52 @@
+/* $Id: libxslt.h,v 1.1 2006/03/24 10:54:55 roscopeco Exp $ */
+
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RUBY_LIBXSLT_H__
+#define __RUBY_LIBXSLT_H__
+
+#include <ruby.h>
+#include <rubyio.h>
+#include <libxml/parser.h>
+#include <libxml/debugXML.h>
+#include <libxslt/extra.h>
+#include <libxslt/xslt.h>
+#include <libxslt/xsltInternals.h>
+#include <libxslt/transform.h>
+#include <libxslt/xsltutils.h>
+#include <libexslt/exslt.h>
+
+#include "libxml-ruby/libxml.h"
+#include "libxml-ruby/ruby_xml_document.h"
+#include "ruby_xslt_stylesheet.h"
+#include "ruby_xslt_transform_context.h"
+
+#define RUBY_LIBXSLT_VERSION  "0.3.6"
+#define RUBY_LIBXSLT_VERNUM   036
+#define RUBY_LIBXSLT_VER_MAJ  0
+#define RUBY_LIBXSLT_VER_MIN  3
+#define RUBY_LIBXSLT_VER_MIC  6
+
+#define RUBY_LIBXSLT_SRC_TYPE_NULL    0
+#define RUBY_LIBXSLT_SRC_TYPE_FILE    1
+
+extern VALUE mXML;
+extern VALUE cXMLDocument;
+
+extern VALUE cXSLT;
+extern VALUE eXMLXSLTStylesheetRequireParsedDoc;
+
+typedef struct ruby_xslt {
+  int data_type;
+  void *data;
+  VALUE str;
+  VALUE xml_doc_obj;
+  VALUE ctxt;
+  xsltStylesheetPtr xsp;
+} ruby_xslt;
+
+#if ((RUBY_LIBXML_VER_MAJ != RUBY_LIBXSLT_VER_MAJ) || (RUBY_LIBXML_VER_MIN != RUBY_LIBXSLT_VER_MIN))
+#error "Incompatible LibXML-Ruby headers - please install same major/micro version"
+#endif
+
+#endif

data/ext/xml/ruby_xslt_stylesheet.c

@@ -0,0 +1,298 @@
+/* $Id: ruby_xslt_stylesheet.c,v 1.1 2006/03/24 10:54:55 roscopeco Exp $ */
+
+/* See the LICENSE file for copyright and distribution information. */
+
+#include "libxslt.h"
+#include "ruby_xslt_stylesheet.h"
+
+VALUE cXSLTStylesheet;
+
+/* call-seq: 
+ *   sheet.apply => (true|false)
+ * 
+ * Apply this stylesheet transformation to the source
+ * document.
+ */
+VALUE
+ruby_xslt_stylesheet_apply(int argc, VALUE *argv, VALUE self) {
+  ruby_xslt_stylesheet *xss;
+  ruby_xml_document *rxd;
+  const char **params;
+  VALUE parameter, tmp;
+  int i, len;
+
+  Data_Get_Struct(self, ruby_xslt_stylesheet, xss);
+
+  if (NIL_P(xss->xml_doc_obj))
+    rb_raise(rb_eArgError, "Need a document object");
+
+  Data_Get_Struct(xss->xml_doc_obj, ruby_xml_document, rxd);
+
+  params = NULL;
+
+  switch(argc) {
+  case 0:
+    break;
+  case 1:
+    parameter = argv[0];
+#if RUBY_VERSION_CODE >= 180
+    if (TYPE(parameter) == T_HASH) {
+      /* Convert parameter to an array */
+      parameter = rb_hash_to_a(parameter);
+    }
+#endif
+
+    if (TYPE(parameter) == T_ARRAY) {
+      /* A hash is better than an array, but we can live with an array of arrays */
+      len = RARRAY(parameter)->len;
+      params = (void *)ALLOC_N(char *, (len * 2) + 2);
+      for (i=0; i < RARRAY(parameter)->len; i++) {
+	tmp = RARRAY(parameter)->ptr[i];
+
+	Check_Type(tmp, T_ARRAY);
+	Check_Type(RARRAY(tmp)->ptr[0], T_STRING);
+	Check_Type(RARRAY(tmp)->ptr[1], T_STRING);
+
+	params[2*i] = RSTRING(RARRAY(tmp)->ptr[0])->ptr;
+	params[2*i+1] = RSTRING(RARRAY(tmp)->ptr[1])->ptr;
+      }
+      params[2*i] = params[2*i+1] = 0;
+    } else {
+      /* I should test to see if the object responds to to_a and to_h before calling this, but oh well */
+      rb_raise(rb_eTypeError, "xslt_stylesheet_appy: expecting a hash or an array of arrays as a parameter");
+    }
+
+    break;
+  default:
+    rb_raise(rb_eArgError, "wrong number of arguments (0 or 1)");
+  }
+
+  xss->parsed = ruby_xml_document_new(cXMLDocument,
+				      xsltApplyStylesheet(xss->xsp,
+							  rxd->doc, params));
+
+  if (params) {
+    free(params);
+  }
+
+  if (xss->parsed == Qnil)
+    return(Qfalse);
+  else
+    return(Qtrue);
+}
+
+
+/* call-seq: 
+ *   sheet.debug(to = $stdout) => (true|false)
+ * 
+ * Output a debug dump of this stylesheet to the specified output
+ * stream (an instance of IO, defaults to $stdout). Requires
+ * libxml/libxslt be compiled with debugging enabled. If this
+ * is not the case, a warning is triggered and the method returns
+ * false.
+ */
+VALUE
+ruby_xslt_stylesheet_debug(int argc, VALUE *argv, VALUE self) {
+#ifdef LIBXML_DEBUG_ENABLED
+  OpenFile *fptr;
+  VALUE io;
+  FILE *out;
+  ruby_xml_document *parsed;
+  ruby_xslt_stylesheet *xss;
+
+  Data_Get_Struct(self, ruby_xslt_stylesheet, xss);
+  if (NIL_P(xss->parsed))
+    rb_raise(eXMLXSLTStylesheetRequireParsedDoc, "must have a parsed XML result");
+
+  switch (argc) {
+  case 0:
+    io = rb_stdout;
+    break;
+  case 1:
+    io = argv[0];
+    if (rb_obj_is_kind_of(io, rb_cIO) == Qfalse)
+      rb_raise(rb_eTypeError, "need an IO object");
+    break;
+  default:
+    rb_raise(rb_eArgError, "wrong number of arguments (0 or 1)");
+  }
+
+  Data_Get_Struct(xss->parsed, ruby_xml_document, parsed);
+  if (parsed->doc == NULL)
+    return(Qnil);
+
+  GetOpenFile(io, fptr);
+  rb_io_check_writable(fptr);
+  out = GetWriteFile(fptr);
+  xmlDebugDumpDocument(out, parsed->doc);
+  return(Qtrue);
+#else
+  rb_warn("libxml/libxslt was compiled without debugging support.  Please recompile libxml/libxslt and their Ruby modules");
+  return(Qfalse);
+#endif
+}
+
+
+void
+ruby_xslt_stylesheet_free(ruby_xslt_stylesheet *xss) {
+  if (xss->xsp != NULL) {
+    xsltFreeStylesheet(xss->xsp);
+    xss->xsp = NULL;
+  }
+
+  free(xss);
+}
+
+
+void
+ruby_xslt_stylesheet_mark(ruby_xslt_stylesheet *xss) {
+  if (!NIL_P(xss->parsed))      rb_gc_mark(xss->parsed);
+  if (!NIL_P(xss->xml_doc_obj)) rb_gc_mark(xss->xml_doc_obj);
+
+  switch (xss->data_type) {
+  case RUBY_LIBXSLT_SRC_TYPE_FILE:
+    if (xss->data != NULL)
+      rb_gc_mark((VALUE)xss->data);
+    break;
+  }
+}
+
+
+VALUE
+ruby_xslt_stylesheet_new(VALUE class, xsltStylesheetPtr xsp) {
+  ruby_xslt_stylesheet *xss;
+
+  xss = ALLOC(ruby_xslt_stylesheet);
+  xss->xsp = xsp;
+  xss->xml_doc_obj = Qnil;
+  xss->parsed = Qnil;
+  xss->data_type = RUBY_LIBXSLT_SRC_TYPE_NULL;
+  xss->data = NULL;
+
+  return(Data_Wrap_Struct(cXSLTStylesheet, ruby_xslt_stylesheet_mark,
+			  ruby_xslt_stylesheet_free, xss));
+}
+
+// TODO should this automatically apply the sheet if not already,
+//      given that we're unlikely to do much else with it?
+
+/* call-seq: 
+ *   sheet.print(to = $stdout) => number_of_bytes
+ * 
+ * Output the result of the transform to the specified output
+ * stream (an IO instance, defaults to $stdout). You *must* call
+ * +apply+ before this method or an exception will be raised.
+ */
+VALUE
+ruby_xslt_stylesheet_print(int argc, VALUE *argv, VALUE self) {
+  OpenFile *fptr;
+  VALUE io;
+  FILE *out;
+  ruby_xml_document *parsed;
+  ruby_xslt_stylesheet *xss;
+  int bytes;
+
+  Data_Get_Struct(self, ruby_xslt_stylesheet, xss);
+  if (NIL_P(xss->parsed))
+    rb_raise(eXMLXSLTStylesheetRequireParsedDoc, "must have a parsed XML result");
+
+  switch (argc) {
+  case 0:
+    io = rb_stdout;
+    break;
+  case 1:
+    io = argv[0];
+    if (rb_obj_is_kind_of(io, rb_cIO) == Qfalse)
+      rb_raise(rb_eTypeError, "need an IO object");
+    break;
+  default:
+    rb_raise(rb_eArgError, "wrong number of arguments (0 or 1)");
+  }
+
+  Data_Get_Struct(xss->parsed, ruby_xml_document, parsed);
+  if (parsed->doc == NULL)
+    return(Qnil);
+
+  GetOpenFile(io, fptr);
+  rb_io_check_writable(fptr);
+  out = GetWriteFile(fptr);
+  bytes = xsltSaveResultToFile(out, parsed->doc, xss->xsp);
+
+  return(INT2NUM(bytes));
+}
+
+// TODO this, too. Either way, to_s probably should have prereqs
+//      like this, for one thing it makes IRB use tricky...
+
+/* call-seq: 
+ *   sheet.to_s => "result"
+ * 
+ * Obtain the result of the transform as a string. You *must* call
+ * +apply+ before this method or an exception will be raised.
+ */
+VALUE
+ruby_xslt_stylesheet_to_s(VALUE self) {
+  ruby_xml_document *parsed;
+  ruby_xslt_stylesheet *xss;
+  xmlChar *str;
+  int len;
+
+  Data_Get_Struct(self, ruby_xslt_stylesheet, xss);
+  if (NIL_P(xss->parsed))
+    rb_raise(eXMLXSLTStylesheetRequireParsedDoc, "must have a parsed XML result");
+  Data_Get_Struct(xss->parsed, ruby_xml_document, parsed);
+  if (parsed->doc == NULL)
+    return(Qnil);
+
+  xsltSaveResultToString(&str, &len, parsed->doc, xss->xsp);
+  if (str == NULL)
+    return(Qnil);
+  else
+    return(rb_str_new((const char*)str,len));
+}
+
+
+
+/* call-seq: 
+ *   sheet.save(io) => true
+ * 
+ * Save the result of the transform to the supplied open
+ * file (an IO instance). You *must* call +apply+ before 
+ * this method or an exception will be raised.
+ */
+VALUE
+ruby_xslt_stylesheet_save(VALUE self, VALUE io) {
+  ruby_xml_document *parsed;
+  ruby_xslt_stylesheet *xss;
+  OpenFile *fptr;
+
+  if (rb_obj_is_kind_of(io, rb_cIO) == Qfalse)
+    rb_raise(rb_eArgError, "Only accept IO objects for saving");
+
+  GetOpenFile(io, fptr);
+
+  Data_Get_Struct(self, ruby_xslt_stylesheet, xss);
+  Data_Get_Struct(xss->parsed, ruby_xml_document, parsed);
+
+  xsltSaveResultToFile(fptr->f, parsed->doc, xss->xsp);
+
+  return(Qtrue);
+}
+
+#ifdef RDOC_NEVER_DEFINED
+  mXML = rb_define_module("XML");
+  cXSLT = rb_define_class_under(mXML, "XSLT", rb_cObject);
+#endif
+
+void
+ruby_init_xslt_stylesheet(void) {
+  cXSLTStylesheet = rb_define_class_under(cXSLT, "Stylesheet", rb_cObject);
+  eXMLXSLTStylesheetRequireParsedDoc =
+    rb_define_class_under(cXSLTStylesheet, "RequireParsedDoc", rb_eException);
+
+  rb_define_method(cXSLTStylesheet, "apply", ruby_xslt_stylesheet_apply, -1);
+  rb_define_method(cXSLTStylesheet, "debug", ruby_xslt_stylesheet_debug, -1);
+  rb_define_method(cXSLTStylesheet, "print", ruby_xslt_stylesheet_print, -1);
+  rb_define_method(cXSLTStylesheet, "to_s", ruby_xslt_stylesheet_to_s, 0);
+  rb_define_method(cXSLTStylesheet, "save", ruby_xslt_stylesheet_save, 1);
+}

data/ext/xml/ruby_xslt_stylesheet.h

@@ -0,0 +1,21 @@
+/* $Id: ruby_xslt_stylesheet.h,v 1.1 2006/03/24 10:54:55 roscopeco Exp $ */
+
+/* Please see the LICENSE file for copyright and distribution information. */
+
+#ifndef __RUBY_LIBXSLT_STYLESHEET__
+#define __RUBY_LIBXSLT_STYLESHEET__
+
+extern VALUE cXSLTStylesheet;
+
+typedef struct ruby_xslt_stylesheet {
+  int data_type;
+  void *data;
+  VALUE parsed;      /* XML::Document # parsed xml document after xsl apply */
+  VALUE xml_doc_obj; /* XML::Document */
+  xsltStylesheetPtr xsp;
+} ruby_xslt_stylesheet;
+
+void ruby_init_xslt_stylesheet(void);
+VALUE ruby_xslt_stylesheet_new(VALUE class, xsltStylesheetPtr xsp);
+
+#endif /* __RUBY_LIBXSLT_STYLESHEET__ */

data/ext/xml/ruby_xslt_transform_context.c

@@ -0,0 +1,63 @@
+/* $Id: ruby_xslt_transform_context.c,v 1.1 2006/03/24 10:54:55 roscopeco Exp $ */
+
+/* Please see the LICENSE file for copyright and distribution information */
+
+#include "libxslt.h"
+#include "ruby_xslt_transform_context.h"
+#include "libxml-ruby/libxml.h"
+
+VALUE cXSLTTransformContext;
+
+void
+ruby_xslt_transform_context_free(ruby_xslt_transform_context *rxtc) {
+  if (rxtc->ctxt != NULL) {
+    xsltFreeTransformContext(rxtc->ctxt);
+    rxtc->ctxt = NULL;
+  }
+  free(rxtc);
+}
+
+void
+ruby_xslt_transform_context_mark(ruby_xslt_transform_context *rxtc) {
+  if (rxtc == NULL) return;
+  if (!NIL_P(rxtc->xslt)) rb_gc_mark(rxtc->xslt);
+}
+
+
+VALUE
+ruby_xslt_transform_context_new(VALUE class, VALUE xslt,
+				      xsltTransformContextPtr ctxt) {
+  ruby_xslt_transform_context *rxtc;
+  rxtc = ALLOC(ruby_xslt_transform_context);
+  ruby_xml_parser_count++;
+  rxtc->ctxt = ctxt;
+  rxtc->xslt = xslt;
+   //fprintf(stderr,"ruby_xslt_transform_context_new 2\n");
+   //if (class == Qfalse)
+    //fprintf(stderr,"ruby_xslt_transform_context_new: EEEEK!\n");
+  return(Data_Wrap_Struct(class, ruby_xslt_transform_context_mark,
+			  ruby_xslt_transform_context_free, rxtc));
+}
+
+
+VALUE
+ruby_xslt_transform_context_new2(VALUE class, VALUE xslt) {
+  return(ruby_xslt_transform_context_new(class, xslt, NULL));
+}
+
+
+VALUE
+ruby_xslt_transform_context_new3(VALUE xslt) {
+  return(ruby_xslt_transform_context_new2(cXSLTTransformContext, xslt));
+}
+
+#ifdef RDOC_NEVER_DEFINED
+  mXML = rb_define_module("XML");
+  cXSLT = rb_define_class_under(mXML, "XSLT", rb_cObject);
+#endif
+
+void
+ruby_init_xslt_transform_context(void) {
+  cXSLTTransformContext =
+    rb_define_class_under(cXSLT, "TransformContext", rb_cObject);
+}

data/ext/xml/ruby_xslt_transform_context.h

@@ -0,0 +1,22 @@
+/* $Id: ruby_xslt_transform_context.h,v 1.1 2006/03/24 10:54:55 roscopeco Exp $ */
+
+/* Please see the LICENSE file for copyright and distribution information */
+
+#ifndef __RUBY_XSLT_TRANSFORM_CONTEXT__
+#define __RUBY_XSLT_TRANSFORM_CONTEXT__
+
+extern VALUE cXSLTTransformContext;
+
+typedef struct ruby_xslt_transform_context {
+  xsltTransformContextPtr ctxt;
+  VALUE xslt;
+} ruby_xslt_transform_context;
+
+void ruby_init_xslt_transform_context(void);
+void ruby_xslt_transform_context_free(ruby_xslt_transform_context *ctxt);
+void ruby_xslt_transform_context_mark(ruby_xslt_transform_context *ctxt);
+VALUE ruby_xslt_transform_context_new(VALUE class, VALUE xslt, xsltTransformContextPtr ctxt);
+VALUE ruby_xslt_transform_context_new2(VALUE class, VALUE xslt);
+VALUE ruby_xslt_transform_context_new3(VALUE xslt);
+
+#endif