ox 2.3.0 → 2.4.0

data/ext/ox/ox.c

@@ -14,7 +14,8 @@
 #include "sax.h"
 
 /* maximum to allocate on the stack, arbitrary limit */
-#define SMALL_XML	4096
+#define SMALL_XML		4096
+#define WITH_CACHE_TESTS	0
 
 typedef struct _YesNoOpt {
     VALUE	sym;
@@ -74,6 +75,10 @@ ID	ox_tv_usec_id;
 ID	ox_value_id;
 
 VALUE	ox_encoding_sym;
+VALUE	ox_version_sym;
+VALUE	ox_standalone_sym;
+VALUE	ox_indent_sym;
+VALUE	ox_size_sym;
 
 VALUE	ox_empty_string;
 VALUE	ox_zero_fixnum;
@@ -105,7 +110,6 @@ static VALUE	circular_sym;
 static VALUE	convert_special_sym;
 static VALUE	effort_sym;
 static VALUE	generic_sym;
-static VALUE	indent_sym;
 static VALUE	invalid_replace_sym;
 static VALUE	limited_sym;
 static VALUE	mode_sym;
@@ -223,23 +227,23 @@ defuse_bom(char *xml, Options options) {
 /* call-seq: ox_default_options() => Hash
  *
  * Returns the default load and dump options as a Hash. The options are
- * - indent: [Fixnum] number of spaces to indent each element in an XML document
- * - trace: [Fixnum] trace level where 0 is silent
- * - encoding: [String] character encoding for the XML file
- * - with_dtd: [true|false|nil] include DTD in the dump
- * - with_instruct: [true|false|nil] include instructions in the dump
- * - with_xml: [true|false|nil] include XML prolog in the dump
- * - circular: [true|false|nil] support circular references while dumping
- * - xsd_date: [true|false|nil] use XSD date format instead of decimal format
- * - mode: [:object|:generic|:limited|nil] load method to use for XML
- * - effort: [:strict|:tolerant|:auto_define] set the tolerance level for loading
- * - symbolize_keys: [true|false|nil] symbolize element attribute keys or leave as Strings
- * - skip: [:skip_none|:skip_return|:skip_white] determines how to handle white space in text
- * - smart: [true|false|nil] flag indicating the SAX parser uses hints if available (use with html)
- * - convert_special: [true|false|nil] flag indicating special characters like < are converted with the SAX parser
- * - invalid_replace: [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
- * - strip_namespace: [String|true|false] false or "" results in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
- * @return [Hash] all current option settings.
+ * - _:indent_ [Fixnum] number of spaces to indent each element in an XML document
+ * - _:trace_ [Fixnum] trace level where 0 is silent
+ * - _:encoding_ [String] character encoding for the XML file
+ * - _:with_dtd_ [true|false|nil] include DTD in the dump
+ * - _:with_instruct_ [true|false|nil] include instructions in the dump
+ * - _:with_xml_ [true|false|nil] include XML prolog in the dump
+ * - _:circular_ [true|false|nil] support circular references while dumping
+ * - _:xsd_date_ [true|false|nil] use XSD date format instead of decimal format
+ * - _:mode_ [:object|:generic|:limited|nil] load method to use for XML
+ * - _:effort_ [:strict|:tolerant|:auto_define] set the tolerance level for loading
+ * - _:symbolize_keys_ [true|false|nil] symbolize element attribute keys or leave as Strings
+ * - _:skip_ [:skip_none|:skip_return|:skip_white] determines how to handle white space in text
+ * - _:smart_ [true|false|nil] flag indicating the SAX parser uses hints if available (use with html)
+ * - _:convert_special_ [true|false|nil] flag indicating special characters like < are converted with the SAX parser
+ * - _:invalid_replace_ [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
+ * - _:strip_namespace_ [String|true|false] false or "" results in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * *return* [Hash] all current option settings.
  *
  * Note that an indent of less than zero will result in a tight one line output
  * unless the text in the XML fields contain new line characters.
@@ -250,7 +254,7 @@ get_def_opts(VALUE self) {
     int		elen = (int)strlen(ox_default_options.encoding);
 
     rb_hash_aset(opts, ox_encoding_sym, (0 == elen) ? Qnil : rb_str_new(ox_default_options.encoding, elen));
-    rb_hash_aset(opts, indent_sym, INT2FIX(ox_default_options.indent));
+    rb_hash_aset(opts, ox_indent_sym, INT2FIX(ox_default_options.indent));
     rb_hash_aset(opts, trace_sym, INT2FIX(ox_default_options.trace));
     rb_hash_aset(opts, with_dtd_sym, (Yes == ox_default_options.with_dtd) ? Qtrue : ((No == ox_default_options.with_dtd) ? Qfalse : Qnil));
     rb_hash_aset(opts, with_xml_sym, (Yes == ox_default_options.with_xml) ? Qtrue : ((No == ox_default_options.with_xml) ? Qfalse : Qnil));
@@ -298,22 +302,22 @@ get_def_opts(VALUE self) {
 /* call-seq: ox_default_options=(opts)
  *
  * Sets the default options for load and dump.
- * @param [Hash] opts options to change
- * @param [Fixnum] :indent number of spaces to indent each element in an XML document
- * @param [Fixnum] :trace trace level where 0 is silent
- * @param [String] :encoding character encoding for the XML file
- * @param [true|false|nil] :with_dtd include DTD in the dump
- * @param [true|false|nil] :with_instruct include instructions in the dump
- * @param [true|false|nil] :with_xml include XML prolog in the dump
- * @param [true|false|nil] :circular support circular references while dumping
- * @param [true|false|nil] :xsd_date use XSD date format instead of decimal format
- * @param [:object|:generic|:limited|nil] :mode load method to use for XML
- * @param [:strict|:tolerant|:auto_define] :effort set the tolerance level for loading
- * @param [true|false|nil] :symbolize_keys symbolize element attribute keys or leave as Strings
- * @param [:skip_none|:skip_return|:skip_white] determines how to handle white space in text
- * @param [nil|String] :invalid_replace replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
- * @param [nil|String|true|false] :strip_namespace "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
- * @return [nil]
+ * - +opts+ [Hash] opts options to change
+ *   - _:indent_ [Fixnum] number of spaces to indent each element in an XML document
+ *   - _:trace_ [Fixnum] trace level where 0 is silent
+ *   - _:encoding_ [String] character encoding for the XML file
+ *   - _:with_dtd_ [true|false|nil] include DTD in the dump
+ *   - _:with_instruct_ [true|false|nil] include instructions in the dump
+ *   - _:with_xml_ [true|false|nil] include XML prolog in the dump
+ *   - _:circular_ [true|false|nil] support circular references while dumping
+ *   - _:xsd_date_ [true|false|nil] use XSD date format instead of decimal format
+ *   - _:mode_ [:object|:generic|:limited|nil] load method to use for XML
+ *   - _:effort_ [:strict|:tolerant|:auto_define] set the tolerance level for loading
+ *   - _:symbolize_keys_ [true|false|nil] symbolize element attribute keys or leave as Strings
+ *   - _skip_ [:skip_none|:skip_return|:skip_white] determines how to handle white space in text
+ *   - _:invalid_replace_ [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
+ *   - _:strip_namespace_ [nil|String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * *return* [nil]
  */
 static VALUE
 set_def_opts(VALUE self, VALUE opts) {
@@ -346,7 +350,7 @@ set_def_opts(VALUE self, VALUE opts) {
 #endif
     }
 
-    v = rb_hash_aref(opts, indent_sym);
+    v = rb_hash_aref(opts, ox_indent_sym);
     if (Qnil != v) {
 	Check_Type(v, T_FIXNUM);
 	ox_default_options.indent = FIX2INT(v);
@@ -467,8 +471,8 @@ set_def_opts(VALUE self, VALUE opts) {
  * optimized XML formated String. For other formats use the more generic
  * Ox.load() method.  Raises an exception if the XML is malformed or the
  * classes specified in the file are not valid.
- * @param [String] xml XML String in optimized Object format.
- * @return [Object] deserialized Object.
+ * - +xml+ [String] XML String in optimized Object format.
+ * *return* [Object] deserialized Object.
  */
 static VALUE
 to_obj(VALUE self, VALUE ruby_xml) {
@@ -509,9 +513,10 @@ to_obj(VALUE self, VALUE ruby_xml) {
 /* call-seq: parse(xml) => Ox::Document or Ox::Element
  *
  * Parses and XML document String into an Ox::Document or Ox::Element.
- * @param [String] xml XML String
- * @return [Ox::Document or Ox::Element] parsed XML document.
- * @raise [Exception] if the XML is malformed.
+ * - +xml+ [String] xml XML String
+ * *return* [Ox::Document or Ox::Element] parsed XML document.
+ *
+ * _raise_ [Exception] if the XML is malformed.
  */
 static VALUE
 to_gen(VALUE self, VALUE ruby_xml) {
@@ -694,20 +699,20 @@ load(char *xml, int argc, VALUE *argv, VALUE self, VALUE encoding, Err err) {
  * on the completion of each complete top level entity with that entity as it's
  * only argument.
  *
- * @param [String] xml XML String
- * @param [Hash] options load options
- * @param [:object|:generic|:limited] :mode format expected
- *  - *:object* - object format
- *  - *:generic* - read as a generic XML file
- *  - *:limited* - read as a generic XML file but with callbacks on text and elements events only
- * @param [:strict|:tolerant|:auto_define] :effort effort to use when an undefined class is encountered, default: :strict
- *  - *:strict* - raise an NameError for missing classes and modules
- *  - *:tolerant* - return nil for missing classes and modules
- *  - *:auto_define* - auto define missing classes and modules
- * @param [Fixnum] :trace trace level as a Fixnum, default: 0 (silent)
- * @param [true|false|nil] :symbolize_keys symbolize element attribute keys or leave as Strings
- * @param [nil|String] :invalid_replace replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
- * @param [String|true|false] :strip_namespace "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * - +xml+ [String] XML String
+ * - +options+ [Hash] load options
+ *   - *:mode* [:object|:generic|:limited] format expected
+ *     - _:object_ - object format
+ *     - _:generic_ - read as a generic XML file
+ *     - _:limited_ - read as a generic XML file but with callbacks on text and elements events only
+ *   - *:effort* [:strict|:tolerant|:auto_define] effort to use when an undefined class is encountered, default: :strict
+ *     - _:strict_ - raise an NameError for missing classes and modules
+ *     - _:tolerant_ - return nil for missing classes and modules
+ *     - _:auto_define_ - auto define missing classes and modules
+ *   - *:trace* [Fixnum] trace level as a Fixnum, default: 0 (silent)
+ *   - *:symbolize_keys* [true|false|nil] symbolize element attribute keys or leave as Strings
+ *   - *:invalid_replace* [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
+ *   - *:strip_namespace* [String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
  */
 static VALUE
 load_str(int argc, VALUE *argv, VALUE self) {
@@ -753,20 +758,20 @@ load_str(int argc, VALUE *argv, VALUE self) {
  * Parses and XML document from a file into an Ox::Document, or Ox::Element,
  * or Object depending on the options.	Raises an exception if the XML is
  * malformed or the classes specified are not valid.
- * @param [String] file_path file path to read the XML document from
- * @param [Hash] options load options
- * @param [:object|:generic|:limited] :mode format expected
- *  - *:object* - object format
- *  - *:generic* - read as a generic XML file
- *  - *:limited* - read as a generic XML file but with callbacks on text and elements events only
- * @param [:strict|:tolerant|:auto_define] :effort effort to use when an undefined class is encountered, default: :strict
- *  - *:strict* - raise an NameError for missing classes and modules
- *  - *:tolerant* - return nil for missing classes and modules
- *  - *:auto_define* - auto define missing classes and modules
- * @param [Fixnum] :trace trace level as a Fixnum, default: 0 (silent)
- * @param [true|false|nil] :symbolize_keys symbolize element attribute keys or leave as Strings
- * @param [nil|String] :invalid_replace replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
- * @param [String|true|false] :strip_namespace "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * - +file_path+ [String] file path to read the XML document from
+ * - +options+ [Hash] load options
+ *   - *:mode* [:object|:generic|:limited] format expected
+ *     - _:object_ - object format
+ *     - _:generic_ - read as a generic XML file
+ *     - _:limited_ - read as a generic XML file but with callbacks on text and elements events only
+ *   - *:effort* [:strict|:tolerant|:auto_define] effort to use when an undefined class is encountered, default: :strict
+ *     - _:strict_ - raise an NameError for missing classes and modules
+ *     - _:tolerant_ - return nil for missing classes and modules
+ *     - _:auto_define_ - auto define missing classes and modules
+ *   - *:trace* [Fixnum] trace level as a Fixnum, default: 0 (silent)
+ *   - *:symbolize_keys* [true|false|nil] symbolize element attribute keys or leave as Strings
+ *   - *:invalid_replace* [nil|String] replacement string for invalid XML characters on dump. nil indicates include anyway as hex. A string, limited to 10 characters will replace the invalid character with the replace.
+ *   - *:strip_namespace* [String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
  */
 static VALUE
 load_file(int argc, VALUE *argv, VALUE self) {
@@ -812,14 +817,14 @@ load_file(int argc, VALUE *argv, VALUE self) {
  *
  * Parses an IO stream or file containing an XML document. Raises an exception
  * if the XML is malformed or the classes specified are not valid.
- * @param [Ox::Sax] handler SAX (responds to OX::Sax methods) like handler
- * @param [IO|String] io IO Object to read from
- * @param [Hash] options parse options
- * @param [true|false] :convert_special flag indicating special characters like < are converted
- * @param [true|false] :symbolize flag indicating the parser symbolize element and attribute names
- * @param [true|false] :smart flag indicating the parser uses hints if available (use with html)
- * @param [:skip_return|:skip_white] :skip flag indicating the parser skips \r or collpase white space into a single space. Default (skip nothing)
- * @param [nil|String|true|false] :strip_namespace "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
+ * - +handler+ [Ox::Sax] SAX (responds to OX::Sax methods) like handler
+ * - +io+ [IO|String] IO Object to read from
+ * - +options+ [Hash] options parse options
+ *   - *:convert_special* [true|false] flag indicating special characters like < are converted
+ *   - *:symbolize* [true|false] flag indicating the parser symbolize element and attribute names
+ *   - *:smart* [true|false] flag indicating the parser uses hints if available (use with html)
+ *   - *:skip* [:skip_return|:skip_white] flag indicating the parser skips \r or collpase white space into a single space. Default (skip nothing)
+ *   - *:strip_namespace* [nil|String|true|false] "" or false result in no namespace stripping. A string of "*" or true will strip all namespaces. Any other non-empty string indicates that matching namespaces will be stripped.
  */
 static VALUE
 sax_parse(int argc, VALUE *argv, VALUE self) {
@@ -896,7 +901,7 @@ parse_dump_options(VALUE ropts, Options copts) {
     if (rb_cHash == rb_obj_class(ropts)) {
 	VALUE	v;
 	
-	if (Qnil != (v = rb_hash_lookup(ropts, indent_sym))) {
+	if (Qnil != (v = rb_hash_lookup(ropts, ox_indent_sym))) {
 	    if (rb_cFixnum != rb_obj_class(v)) {
 		rb_raise(ox_parse_error_class, ":indent must be a Fixnum.\n");
 	    }
@@ -964,14 +969,14 @@ parse_dump_options(VALUE ropts, Options copts) {
 /* call-seq: dump(obj, options) => xml-string
  *
  * Dumps an Object (obj) to a string.
- * @param [Object] obj Object to serialize as an XML document String
- * @param [Hash] options formating options
- * @param [Fixnum] :indent format expected
- * @param [true|false] :xsd_date use XSD date format if true, default: false
- * @param [true|false] :circular allow circular references, default: false
- * @param [:strict|:tolerant] :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
- *  - *:strict* - raise an NotImplementedError if an undumpable object is encountered
- *  - *:tolerant* - replaces undumplable objects with nil
+ * - +obj+ [Object] Object to serialize as an XML document String
+ * - +options+ [Hash] formating options
+ *   - *:indent* [Fixnum] format expected
+ *   - *:xsd_date* [true|false] use XSD date format if true, default: false
+ *   - *:circular* [true|false] allow circular references, default: false
+ *   - *:strict|:tolerant]* [ :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
+ *     - _:strict_ - raise an NotImplementedError if an undumpable object is encountered
+ *     - _:tolerant_ - replaces undumplable objects with nil
  *
  * Note that an indent of less than zero will result in a tight one line output
  * unless the text in the XML fields contain new line characters.
@@ -1006,15 +1011,15 @@ dump(int argc, VALUE *argv, VALUE self) {
 /* call-seq: to_file(file_path, obj, options)
  *
  * Dumps an Object to the specified file.
- * @param [String] file_path file path to write the XML document to
- * @param [Object] obj Object to serialize as an XML document String
- * @param [Hash] options formating options
- * @param [Fixnum] :indent format expected
- * @param [true|false] :xsd_date use XSD date format if true, default: false
- * @param [true|false] :circular allow circular references, default: false
- * @param [:strict|:tolerant] :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
- *  - *:strict* - raise an NotImplementedError if an undumpable object is encountered
- *  - *:tolerant* - replaces undumplable objects with nil
+ * - +file_path+ [String] file path to write the XML document to
+ * - +obj+ [Object] Object to serialize as an XML document String
+ * - +options+ [Hash] formating options
+ *   - *:indent* [Fixnum] format expected
+ *   - *:xsd_date* [true|false] use XSD date format if true, default: false
+ *   - *:circular* [true|false] allow circular references, default: false
+ *   - *:strict|:tolerant]* [ :effort effort to use when an undumpable object (e.g., IO) is encountered, default: :strict
+ *     - _:strict_ - raise an NotImplementedError if an undumpable object is encountered
+ *     - _:tolerant_ - replaces undumplable objects with nil
  *
  * Note that an indent of less than zero will result in a tight one line output
  * unless the text in the XML fields contain new line characters.
@@ -1032,6 +1037,7 @@ to_file(int argc, VALUE *argv, VALUE self) {
     return Qnil;
 }
 
+#if WITH_CACHE_TESTS
 extern void	ox_cache_test(void);
 
 static VALUE
@@ -1047,6 +1053,7 @@ cache8_test(VALUE self) {
     ox_cache8_test();
     return Qnil;
 }
+#endif
 
 void Init_ox() {
     Ox = rb_define_module("Ox");
@@ -1065,6 +1072,8 @@ void Init_ox() {
     rb_define_module_function(Ox, "load_file", load_file, -1);
     rb_define_module_function(Ox, "to_file", to_file, -1);
 
+    ox_init_builder(Ox);
+    
     rb_require("time");
     rb_require("date");
     rb_require("bigdecimal");
@@ -1148,7 +1157,8 @@ void Init_ox() {
     convert_special_sym = ID2SYM(rb_intern("convert_special")); rb_gc_register_address(&convert_special_sym);
     effort_sym = ID2SYM(rb_intern("effort"));			rb_gc_register_address(&effort_sym);
     generic_sym = ID2SYM(rb_intern("generic"));			rb_gc_register_address(&generic_sym);
-    indent_sym = ID2SYM(rb_intern("indent"));			rb_gc_register_address(&indent_sym);
+    ox_indent_sym = ID2SYM(rb_intern("indent"));		rb_gc_register_address(&ox_indent_sym);
+    ox_size_sym = ID2SYM(rb_intern("size"));			rb_gc_register_address(&ox_size_sym);
     invalid_replace_sym = ID2SYM(rb_intern("invalid_replace"));	rb_gc_register_address(&invalid_replace_sym);
     limited_sym = ID2SYM(rb_intern("limited"));			rb_gc_register_address(&limited_sym);
     mode_sym = ID2SYM(rb_intern("mode"));			rb_gc_register_address(&mode_sym);
@@ -1156,6 +1166,8 @@ void Init_ox() {
     opt_format_sym = ID2SYM(rb_intern("opt_format"));		rb_gc_register_address(&opt_format_sym);
     optimized_sym = ID2SYM(rb_intern("optimized"));		rb_gc_register_address(&optimized_sym);
     ox_encoding_sym = ID2SYM(rb_intern("encoding"));		rb_gc_register_address(&ox_encoding_sym);
+    ox_version_sym = ID2SYM(rb_intern("version"));		rb_gc_register_address(&ox_version_sym);
+    ox_standalone_sym = ID2SYM(rb_intern("standalone"));	rb_gc_register_address(&ox_standalone_sym);
     skip_none_sym = ID2SYM(rb_intern("skip_none"));		rb_gc_register_address(&skip_none_sym);
     skip_return_sym = ID2SYM(rb_intern("skip_return"));		rb_gc_register_address(&skip_return_sym);
     skip_sym = ID2SYM(rb_intern("skip"));			rb_gc_register_address(&skip_sym);
@@ -1191,12 +1203,17 @@ void Init_ox() {
 
     ox_sax_define();
 
-    rb_define_module_function(Ox, "cache_test", cache_test, 0);
-    rb_define_module_function(Ox, "cache8_test", cache8_test, 0);
+#if WITH_CACHE_TESTS
+    // space added to stop yardoc from trying to document
+    rb_define _module_function(Ox, "cache_test", cache_test, 0);
+    rb_define _module_function(Ox, "cache8_test", cache8_test, 0);
+#endif
+    
 #if HAS_ENCODING_SUPPORT
     ox_utf8_encoding = rb_enc_find("UTF-8");
 #elif HAS_PRIVATE_ENCODING
-    ox_utf8_encoding = rb_str_new2("UTF-8");			rb_gc_register_address(&ox_utf8_encoding);
+    ox_utf8_encoding = rb_str_new2("UTF-8");
+    rb_gc_register_address(&ox_utf8_encoding);
 #endif
 }
 

data/ext/ox/ox.h

@@ -227,15 +227,20 @@ extern VALUE		ox_utf8_encoding;
 extern void		*ox_utf8_encoding;
 #endif
 
-extern VALUE	ox_bigdecimal_class;
-extern VALUE	ox_date_class;
 extern VALUE	ox_empty_string;
 extern VALUE	ox_encoding_sym;
+extern VALUE	ox_indent_sym;
+extern VALUE	ox_size_sym;
+extern VALUE	ox_standalone_sym;
+extern VALUE	ox_sym_bank; // Array
+extern VALUE	ox_version_sym;
+extern VALUE	ox_zero_fixnum;
+
+extern VALUE	ox_bigdecimal_class;
+extern VALUE	ox_date_class;
 extern VALUE	ox_stringio_class;
 extern VALUE	ox_struct_class;
 extern VALUE	ox_time_class;
-extern VALUE	ox_zero_fixnum;
-extern VALUE	ox_sym_bank; // Array
 
 extern VALUE	ox_document_clas;
 extern VALUE	ox_element_clas;
@@ -250,6 +255,8 @@ extern Cache	ox_symbol_cache;
 extern Cache	ox_class_cache;
 extern Cache	ox_attr_cache;
 
+extern void	ox_init_builder(VALUE ox);
+
 #if defined(__cplusplus)
 #if 0
 { /* satisfy cc-mode */

data/ext/ox/sax_as.c

@@ -110,6 +110,10 @@ parse_xsd_time(const char *text) {
 #endif
 }
 
+/* call-seq: as_s()
+ *
+ * *return* value as an String.
+ */
 static VALUE
 sax_value_as_s(VALUE self) {
     SaxDrive	dr = DATA_PTR(self);
@@ -144,6 +148,10 @@ sax_value_as_s(VALUE self) {
     return rs;
 }
 
+/* call-seq: as_sym()
+ *
+ * *return* value as an Symbol.
+ */
 static VALUE
 sax_value_as_sym(VALUE self) {
     SaxDrive	dr = DATA_PTR(self);
@@ -154,6 +162,10 @@ sax_value_as_sym(VALUE self) {
     return str2sym(dr, dr->buf.str, 0);
 }
 
+/* call-seq: as_f()
+ *
+ * *return* value as an Float.
+ */
 static VALUE
 sax_value_as_f(VALUE self) {
     SaxDrive	dr = DATA_PTR(self);
@@ -164,6 +176,10 @@ sax_value_as_f(VALUE self) {
     return rb_float_new(strtod(dr->buf.str, 0));
 }
 
+/* call-seq: as_i()
+ *
+ * *return* value as an Fixnum.
+ */
 static VALUE
 sax_value_as_i(VALUE self) {
     SaxDrive	dr = DATA_PTR(self);
@@ -193,6 +209,10 @@ sax_value_as_i(VALUE self) {
     return LONG2NUM(n);
 }
 
+/* call-seq: as_time()
+ *
+ * *return* value as an Time.
+ */
 static VALUE
 sax_value_as_time(VALUE self) {
     SaxDrive	dr = DATA_PTR(self);
@@ -213,18 +233,35 @@ sax_value_as_time(VALUE self) {
     return t;
 }
 
+/* call-seq: as_bool()
+ *
+ * *return* value as an boolean.
+ */
 static VALUE
 sax_value_as_bool(VALUE self) {
     return (0 == strcasecmp("true", ((SaxDrive)DATA_PTR(self))->buf.str)) ? Qtrue : Qfalse;
 }
 
+/* call-seq: empty()
+ *
+ * *return* true if the value is empty.
+ */
 static VALUE
 sax_value_empty(VALUE self) {
     return ('\0' == *((SaxDrive)DATA_PTR(self))->buf.str) ? Qtrue : Qfalse;
 }
 
+/* Document-class: Ox::Sax::Value
+ *
+ * Values in the SAX callbacks. They can be converted to various different
+ * types. with the _as_x()_ methods.
+ */
 void
 ox_sax_define() {
+#if 0
+    ox = rb_define_module("Ox");
+    sax_module = rb_define_class_under(ox, "Sax", rb_cObject);
+#endif
     VALUE	sax_module = rb_const_get_at(Ox, rb_intern("Sax"));
 
     ox_sax_value_class = rb_define_class_under(sax_module, "Value", rb_cObject);