module LibXML::XML
Constants
- LIBXML_VERSION
Constants
- VERNUM
- VERSION
- XML_NAMESPACE
Public Class Methods
Dump all the global catalog content stdout.
static VALUE rxml_catalog_dump(VALUE self) { xmlCatalogDump(stdout); return (Qtrue); }
Remove the specified resource catalog.
static VALUE rxml_catalog_remove(VALUE self, VALUE cat) { Check_Type(cat, T_STRING); xmlCatalogRemove((xmlChar *) StringValuePtr(cat)); return (Qtrue); }
Check LIBXML version matches version the bindings were compiled to. Throws an exception if not.
static VALUE rxml_check_lib_versions(VALUE klass) { xmlCheckVersion(LIBXML_VERSION); return (Qtrue); }
Determine whether included-entity debugging is enabled. (Requires Libxml to be compiled with debugging support)
static VALUE rxml_debug_entities_get(VALUE klass) { #ifdef LIBXML_DEBUG_ENABLED if (xmlParserDebugEntities) return(Qtrue); else return(Qfalse); #else rb_warn("libxml was compiled with debugging turned off"); return (Qfalse); #endif }
Enable or disable included-entity debugging. (Requires Libxml to be compiled with debugging support)
static VALUE rxml_debug_entities_set(VALUE klass, VALUE bool) { #ifdef LIBXML_DEBUG_ENABLED if (TYPE(bool) == T_FALSE) { xmlParserDebugEntities = 0; return(Qfalse); } else { xmlParserDebugEntities = 1; return(Qtrue); } #else rb_warn("libxml was compiled with debugging turned off"); #endif }
Determine whether parsers use Zlib compression by default (requires libxml to be compiled with Zlib support).
static VALUE rxml_default_compression_get(VALUE klass) { #ifdef HAVE_ZLIB_H return(INT2FIX(xmlGetCompressMode())); #else rb_warn("libxml was compiled without zlib support"); return (Qfalse); #endif }
Controls whether parsers use Zlib compression by default (requires libxml to be compiled with Zlib support).
static VALUE rxml_default_compression_set(VALUE klass, VALUE num) { #ifdef HAVE_ZLIB_H Check_Type(num, T_FIXNUM); xmlSetCompressMode(FIX2INT(num)); return(num); #else rb_warn("libxml was compiled without zlib support"); return (Qfalse); #endif }
Determine whether parsers retain whitespace by default.
static VALUE rxml_default_keep_blanks_get(VALUE klass) { if (xmlKeepBlanksDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers retain whitespace by default.
static VALUE rxml_default_keep_blanks_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_FALSE) { xmlKeepBlanksDefaultValue = 0; return (Qfalse); } else if (TYPE(bool) == T_TRUE) { xmlKeepBlanksDefaultValue = 1; return (Qtrue); } else { rb_raise(rb_eArgError, "Invalid argument, must be a boolean"); } }
Determine whether parsers retain line-numbers by default.
static VALUE rxml_default_line_numbers_get(VALUE klass) { if (xmlLineNumbersDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers retain line-numbers by default.
static VALUE rxml_default_line_numbers_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_FALSE) { xmlLineNumbersDefault(0); return (Qfalse); } else { xmlLineNumbersDefault(1); return (Qtrue); } }
Determine whether parsers load external DTDs by default.
static VALUE rxml_default_load_external_dtd_get(VALUE klass) { if (xmlLoadExtDtdDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers load external DTDs by default.
static VALUE rxml_default_load_external_dtd_set(VALUE klass, VALUE bool) { if (bool == Qfalse) { xmlLoadExtDtdDefaultValue = 0; return (Qfalse); } else { xmlLoadExtDtdDefaultValue = 1; return (Qtrue); } }
Returns an integer that summarize libxml2's default options.
static VALUE rxml_default_options_get(VALUE klass) { int options = rxml_libxml_default_options(); return INT2NUM(options); }
Determine whether parsers are pedantic by default.
static VALUE rxml_default_pedantic_parser_get(VALUE klass) { if (xmlPedanticParserDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers are pedantic by default.
static VALUE rxml_default_pedantic_parser_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_FALSE) { xmlPedanticParserDefault(0); return (Qfalse); } else { xmlPedanticParserDefault(1); return (Qtrue); } }
Determine whether parsers perform inline entity substitution (for external entities) by default.
static VALUE rxml_default_substitute_entities_get(VALUE klass) { if (xmlSubstituteEntitiesDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers perform inline entity substitution (for external entities) by default.
static VALUE rxml_default_substitute_entities_set(VALUE klass, VALUE bool) { if (bool == Qfalse) { xmlSubstituteEntitiesDefault(0); return (Qfalse); } else { xmlSubstituteEntitiesDefault(1); return (Qtrue); } }
Obtain the default string used by parsers to indent the XML tree for output.
static VALUE rxml_default_tree_indent_string_get(VALUE klass) { if (xmlTreeIndentString == NULL) return (Qnil); else return (rb_str_new2(xmlTreeIndentString)); }
Set the default string used by parsers to indent the XML tree for output.
static VALUE rxml_default_tree_indent_string_set(VALUE klass, VALUE string) { Check_Type(string, T_STRING); xmlTreeIndentString = xmlStrdup((xmlChar *)StringValuePtr(string)); return (string); }
Determine whether parsers perform XML validation by default.
static VALUE rxml_default_validity_checking_get(VALUE klass) { if (xmlDoValidityCheckingDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers perform XML validation by default.
static VALUE rxml_default_validity_checking_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_FALSE) { xmlDoValidityCheckingDefaultValue = 0; return (Qfalse); } else { xmlDoValidityCheckingDefaultValue = 1; return (Qtrue); } }
Determine whether parsers output warnings by default.
static VALUE rxml_default_warnings_get(VALUE klass) { if (xmlGetWarningsDefaultValue) return (Qtrue); else return (Qfalse); }
Controls whether parsers output warnings by default.
static VALUE rxml_default_warnings_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_FALSE) { xmlGetWarningsDefaultValue = 0; return (Qfalse); } else { xmlGetWarningsDefaultValue = 1; return (Qtrue); } }
Determine whether libxml regexp automata support is enabled.
static VALUE rxml_enabled_automata_q(VALUE klass) { #ifdef LIBXML_AUTOMATA_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml 'canonical XML' support is enabled. See “Canonical XML” (www.w3.org/TR/xml-c14n)
static VALUE rxml_enabled_c14n_q(VALUE klass) { #ifdef LIBXML_C14N_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml resource catalog support is enabled.
static VALUE rxml_enabled_catalog_q(VALUE klass) { #ifdef LIBXML_CATALOG_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml debugging support is enabled.
static VALUE rxml_enabled_debug_q(VALUE klass) { #ifdef LIBXML_DEBUG_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml docbook support is enabled.
static VALUE rxml_enabled_docbook_q(VALUE klass) { #ifdef LIBXML_DOCB_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml ftp client support is enabled.
static VALUE rxml_enabled_ftp_q(VALUE klass) { #ifdef LIBXML_FTP_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml html support is enabled.
static VALUE rxml_enabled_html_q(VALUE klass) { #ifdef LIBXML_HTML_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml http client support is enabled.
static VALUE rxml_enabled_http_q(VALUE klass) { #ifdef LIBXML_HTTP_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml iconv support is enabled.
static VALUE rxml_enabled_iconv_q(VALUE klass) { #ifdef LIBXML_ICONV_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml memory location debugging support is enabled.
static VALUE rxml_enabled_memory_debug_location_q(VALUE klass) { #ifdef DEBUG_MEMORY_LOCATION return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml regular expression support is enabled.
static VALUE rxml_enabled_regexp_q(VALUE klass) { #ifdef LIBXML_REGEXP_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml schema support is enabled.
static VALUE rxml_enabled_schemas_q(VALUE klass) { #ifdef LIBXML_SCHEMAS_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether thread-safe semantics support for libxml is enabled and is used by this ruby extension. Threading support in libxml uses pthread on Unix-like systems and Win32 threads on Windows.
static VALUE rxml_enabled_thread_q(VALUE klass) { /* This won't be defined unless this code is compiled with _REENTRANT or __MT__ * defined or the compiler is in C99 mode. * * Note the relevant portion libxml/xmlversion.h on a thread-enabled build: * * #if defined(_REENTRANT) || defined(__MT__) || \ * (defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0 >= 199506L)) * #define LIBXML_THREAD_ENABLED * #endif * */ #ifdef LIBXML_THREAD_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml unicode support is enabled.
static VALUE rxml_enabled_unicode_q(VALUE klass) { #ifdef LIBXML_UNICODE_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml xinclude support is enabled.
static VALUE rxml_enabled_xinclude_q(VALUE klass) { #ifdef LIBXML_XINCLUDE_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml xpath support is enabled.
static VALUE rxml_enabled_xpath_q(VALUE klass) { #ifdef LIBXML_XPATH_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml xpointer support is enabled.
static VALUE rxml_enabled_xpointer_q(VALUE klass) { #ifdef LIBXML_XPTR_ENABLED return(Qtrue); #else return (Qfalse); #endif }
Determine whether libxml zlib support is enabled.
static VALUE rxml_enabled_zlib_q(VALUE klass) { #ifdef HAVE_ZLIB_H return(Qtrue); #else return (Qfalse); #endif }
Obtains an array of strings representing features supported (and enabled) by the installed libxml.
static VALUE rxml_features(VALUE klass) { VALUE arr, str; int i, len = MAX_LIBXML_FEATURES_LEN; char **list = NULL; list = ALLOC_N(char *,MAX_LIBXML_FEATURES_LEN); MEMZERO(list, char *, MAX_LIBXML_FEATURES_LEN); arr = rb_ary_new(); if (xmlGetFeaturesList(&len, (const char **) list) == -1) return Qnil; for (i = 0; i < len; i++) { str = rb_str_new2((const char *) list[i]); rb_gc_unregister_address(&str); rb_ary_push(arr, str); } if (len == MAX_LIBXML_FEATURES_LEN) rb_warn( "Please contact libxml-devel@rubyforge.org and ask to have the \"MAX_LIBXML_FEATURES_LEN increased\" because you could possibly be seeing an incomplete list"); ruby_xfree(list); return (arr); }
Determines whether XML output will be indented
(using the string supplied to default_indent_tree_string
)
static VALUE rxml_indent_tree_output_get(VALUE klass) { if (xmlIndentTreeOutput) return (Qtrue); else return (Qfalse); }
Controls whether XML output will be indented (using
the string supplied to default_indent_tree_string
)
static VALUE rxml_indent_tree_output_set(VALUE klass, VALUE bool) { if (TYPE(bool) == T_TRUE) { xmlIndentTreeOutput = 1; return (Qtrue); } else if (TYPE(bool) == T_FALSE) { xmlIndentTreeOutput = 0; return (Qfalse); } else { rb_raise(rb_eArgError, "Invalid argument, must be boolean"); } }
Perform a parser memory dump (requires memory debugging support in libxml).
static VALUE rxml_memory_dump(VALUE self) { #ifdef DEBUG_MEMORY_LOCATION xmlMemoryDump(); return(Qtrue); #else rb_warn("libxml was compiled without memory debugging support"); return (Qfalse); #endif }
Perform a parser memory dump (requires memory debugging support in libxml).
static VALUE rxml_memory_used(VALUE self) { #ifdef DEBUG_MEMORY_LOCATION return(INT2NUM(xmlMemUsed())); #else rb_warn("libxml was compiled without memory debugging support"); return (Qfalse); #endif }