@@ -1,9 +1,28 @@ -= FastXml, a simple fast xml library using libxml and libxslt += FastXml +a simple fast xml library using libxml and libxslt with an hpricot-like api == Overview -FastXml is: +FastXml: -# not standalone, it *requires libxml* and *libxslt* -# it attempts to provide the speediest xml parsing library available for ruby -# it provides an hpricot-like syntax for xml parsing and xslt processing + 1) is not standalone, it *requires libxml* and *libxslt* + 2) attempts to provide the speediest xml parsing library available for ruby + 3) provides an hpricot-like syntax for xml parsing and xslt processing + +== Example + doc = FastXml( open( 'test.xml ) ) + puts doc.root.name + puts doc.root.content + + doc.root.children.each do |node| + puts "%s => %s" % [ node.name, node.content ] + end + + (doc/"/node").each { |node| puts node.inspect } #xpath search + doc.search( "//node" ).each { |node| puts node.inspect } + + +== Copyright & Licensing +Copyright Mark Guzman 2007-2008 + +Please see the LICENSE file for more details. The short version is it's under the same terms as Ruby. README @@ -25,9 +25,7 @@ ID s_readlines; ID s_to_s; void Init_fastxml() -{ - VALUE rb_mFastXmlIncludeDoc, rb_mFastXmlIncludeNode, rb_mFastXmlIncludeNodeList; - +{ if (xmlHasFeature(XML_WITH_TREE) == 0) rb_raise( rb_eRuntimeError, "libxml not built with tree support" ); @@ -40,12 +38,7 @@ void Init_fastxml() xmlInitParser(); xmlXPathInit(); rb_mFastXml = rb_define_module( "FastXml" ); - VALUE rb_mFastXmlInclude = rb_define_module_under( rb_mFastXml, "Include" ); rb_define_const( rb_mFastXml, "LIBXML_VERSION", rb_str_new2( LIBXML_DOTTED_VERSION ) ); - - rb_mFastXmlIncludeDoc = rb_define_module_under( rb_mFastXmlInclude, "Doc" ); - rb_mFastXmlIncludeNode = rb_define_module_under( rb_mFastXmlInclude, "Node" ); - rb_mFastXmlIncludeNodeList = rb_define_module_under( rb_mFastXmlInclude, "NodeList" ); /* setting symbols */ rb_sValidateDtd = ID2SYM( rb_intern("validate") ); @@ -65,13 +58,8 @@ void Init_fastxml() Init_fastxml_attrlist(); /* pull in the ruby side of things */ - rb_require( "lib/fastxml_lib" ); - rb_require( "lib/fastxml_helpers" ); - - /* now let's merge those include modules into the main classes */ - rb_include_module( rb_cFastXmlDoc, rb_mFastXmlIncludeDoc ); - rb_include_module( rb_cFastXmlNode, rb_mFastXmlIncludeNode ); - rb_include_module( rb_cFastXmlNodeList, rb_mFastXmlIncludeNodeList ); + rb_require( "lib/fastxml_lib" ); // ruby-side methods for the FastXml classes + rb_require( "lib/fastxml_helpers" ); // FastXml and FastHtml methods } ext/fastxml.c @@ -30,7 +30,7 @@ module FastXml::Common #:nodoc: all alias :to_s :display end -module FastXml::Include::Doc #:nodoc: +class FastXml::Doc include FastXml::Common def doc? @@ -54,14 +54,14 @@ module FastXml::Include::Doc #:nodoc: end end -module FastXml::Include::Node #:nodoc: +class FastXml::Node include FastXml::Common def doc? false end end -module FastXml::Include::NodeList #:nodoc: +class FastXml::NodeList def [](idx) self.entry(idx) end lib/fastxml_lib.rb a07cd646109e84174fa21b208e7ff9425d77a22b Mark Guzman segfault@hasno.info http://github.com/segfault/fastxml/commit/4c4a11e66dacdbc8c795a50b906915457c94d973 4c4a11e66dacdbc8c795a50b906915457c94d973 2008-06-15T21:39:34-07:00 2008-06-15T21:39:34-07:00 refactored away the Include modules, so that we get documentation of the ruby-side code alongside the c code updated the readme to mention licensing and copyright along with a usage example 40fabdee15b7de452112af533976baf2b8a99a07 Mark Guzman segfault@hasno.info