Class: LibXML::XML::Reader

Inherits:
Object
  • Object
show all
Defined in:
ext/libxml/ruby_xml_reader.c,
lib/libxml/reader.rb,
ext/libxml/ruby_xml_reader.c

Overview

The XML::Reader class provides a simpler, alternative way of parsing an XML document in contrast to XML::Parser or XML::SaxParser. A XML::Reader instance acts like a cursor going forward in a document stream, stopping at each node it encounters. To advance to the next node, simply cadd XML::Reader#read.

The XML::Reader API closely matches the DOM Core specification and supports namespaces, xml:base, entity handling and DTDs.

To summarize, XML::Reader provides a far simpler API to use versus XML::SaxParser and is more memory efficient than using XML::Parser to create a DOM tree.

Example:

parser = XML::Reader.string("<foo><bar>1</bar><bar>2</bar><bar>3</bar></foo>")
reader.read
assert_equal('foo', reader.name)
assert_equal(nil, reader.value)

3.times do |i|
  reader.read
  assert_equal(XML::Reader::TYPE_ELEMENT, reader.node_type)
  assert_equal('bar', reader.name)
  reader.read
  assert_equal(XML::Reader::TYPE_TEXT, reader.node_type)
  assert_equal((i + 1).to_s, reader.value)
  reader.read
  assert_equal(XML::Reader::TYPE_END_ELEMENT, reader.node_type)
end

You can also parse documents (see XML::Reader.document), strings (see XML::Parser.string) and io objects (see XML::Parser.io).

For a more in depth tutorial, albeit in C, see xmlsoft.org/xmlreader.html.

Constant Summary collapse

LOADDTD =

Constants

INT2FIX(XML_PARSER_LOADDTD)
DEFAULTATTRS = 
INT2FIX(XML_PARSER_DEFAULTATTRS)
VALIDATE = 
INT2FIX(XML_PARSER_VALIDATE)
SUBST_ENTITIES = 
INT2FIX(XML_PARSER_SUBST_ENTITIES)
SEVERITY_VALIDITY_WARNING = 
INT2FIX(XML_PARSER_SEVERITY_VALIDITY_WARNING)
SEVERITY_VALIDITY_ERROR = 
INT2FIX(XML_PARSER_SEVERITY_VALIDITY_ERROR)
SEVERITY_WARNING = 
INT2FIX(XML_PARSER_SEVERITY_WARNING)
SEVERITY_ERROR = 
INT2FIX(XML_PARSER_SEVERITY_ERROR)
TYPE_NONE = 
INT2FIX(XML_READER_TYPE_NONE)
TYPE_ELEMENT = 
INT2FIX(XML_READER_TYPE_ELEMENT)
TYPE_ATTRIBUTE = 
INT2FIX(XML_READER_TYPE_ATTRIBUTE)
TYPE_TEXT = 
INT2FIX(XML_READER_TYPE_TEXT)
TYPE_CDATA = 
INT2FIX(XML_READER_TYPE_CDATA)
TYPE_ENTITY_REFERENCE = 
INT2FIX(XML_READER_TYPE_ENTITY_REFERENCE)
TYPE_ENTITY = 
INT2FIX(XML_READER_TYPE_ENTITY)
TYPE_PROCESSING_INSTRUCTION = 
INT2FIX(XML_READER_TYPE_PROCESSING_INSTRUCTION)
TYPE_COMMENT = 
INT2FIX(XML_READER_TYPE_COMMENT)
TYPE_DOCUMENT = 
INT2FIX(XML_READER_TYPE_DOCUMENT)
TYPE_DOCUMENT_TYPE = 
INT2FIX(XML_READER_TYPE_DOCUMENT_TYPE)
TYPE_DOCUMENT_FRAGMENT = 
INT2FIX(XML_READER_TYPE_DOCUMENT_FRAGMENT)
TYPE_NOTATION = 
INT2FIX(XML_READER_TYPE_NOTATION)
TYPE_WHITESPACE = 
INT2FIX(XML_READER_TYPE_WHITESPACE)
TYPE_SIGNIFICANT_WHITESPACE = 
INT2FIX(XML_READER_TYPE_SIGNIFICANT_WHITESPACE)
TYPE_END_ELEMENT = 
INT2FIX(XML_READER_TYPE_END_ELEMENT)
TYPE_END_ENTITY = 
INT2FIX(XML_READER_TYPE_END_ENTITY)
TYPE_XML_DECLARATION = 
INT2FIX(XML_READER_TYPE_XML_DECLARATION)
MODE_INITIAL =

Read states

INT2FIX(XML_TEXTREADER_MODE_INITIAL)
MODE_INTERACTIVE = 
INT2FIX(XML_TEXTREADER_MODE_INTERACTIVE)
MODE_ERROR = 
INT2FIX(XML_TEXTREADER_MODE_ERROR)
MODE_EOF = 
INT2FIX(XML_TEXTREADER_MODE_EOF)
MODE_CLOSED = 
INT2FIX(XML_TEXTREADER_MODE_CLOSED)
MODE_READING = 
INT2FIX(XML_TEXTREADER_MODE_READING)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.data(string, options = nil) ⇒ Object 



23
24
25
26
 
# File 'lib/libxml/reader.rb', line 23

def self.data(string, options = nil)
  warn("XML::Reader.data is deprecated.  Use XML::Reader.string instead")
  self.string(string, options)
end

.XML::Reader.document(doc) ⇒ XML::Reader

Create an new reader for the specified document.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'ext/libxml/ruby_xml_reader.c', line 76

VALUE rxml_reader_document(VALUE klass, VALUE doc)
{
  xmlDocPtr xdoc;
  xmlTextReaderPtr xreader;

  Data_Get_Struct(doc, xmlDoc, xdoc);

  xreader = xmlReaderWalker(xdoc);

  if (xreader == NULL)
    rxml_raise(&xmlLastError);

  return rxml_reader_wrap(xreader);
}

.XML::Reader.file(path) ⇒ XML::Reader .XML::Reader.file(path, : encoding) ⇒ XML::Encoding::UTF_8

Creates a new reader by parsing the specified file or uri.

You may provide an optional hash table to control how the parsing is performed. Valid options are:

encoding - The document encoding, defaults to nil. Valid values
           are the encoding constants defined on XML::Encoding.
options - Controls the execution of the parser, defaults to 0.
          Valid values are the constants defined on
          XML::Parser::Options.  Mutliple options can be combined
          by using Bitwise OR (|).

Overloads:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'ext/libxml/ruby_xml_reader.c', line 108

static VALUE rxml_reader_file(int argc, VALUE *argv, VALUE klass)
{
  xmlTextReaderPtr xreader;
  VALUE path;
  VALUE options;

  const char *xencoding = NULL;
  int xoptions = 0;

  rb_scan_args(argc, argv, "11", &path, &options);
  Check_Type(path, T_STRING);

  if (!NIL_P(options))
  {
    VALUE encoding = Qnil;
    VALUE parserOptions = Qnil;

    Check_Type(options, T_HASH);

    encoding = rb_hash_aref(options, BASE_URI_SYMBOL);
    xencoding = NIL_P(encoding) ? NULL : xmlGetCharEncodingName(NUM2INT(encoding));

    parserOptions = rb_hash_aref(options, OPTIONS_SYMBOL);
    xoptions = NIL_P(parserOptions) ? 0 : NUM2INT(parserOptions);
  }

  xreader = xmlReaderForFile(StringValueCStr(path), xencoding, xoptions);

  if (xreader == NULL)
    rxml_raise(&xmlLastError);

  return rxml_reader_wrap(xreader);
}

.XML::Reader.io(io) ⇒ XML::Reader .XML::Reader.io(io, : encoding) ⇒ XML::Encoding::UTF_8

Creates a new reader by parsing the specified io object.

You may provide an optional hash table to control how the parsing is performed. Valid options are:

base_uri - The base url for the parsed document.
encoding - The document encoding, defaults to nil. Valid values
           are the encoding constants defined on XML::Encoding.
options - Controls the execution of the parser, defaults to 0.
          Valid values are the constants defined on
          XML::Parser::Options.  Mutliple options can be combined
          by using Bitwise OR (|).

Overloads:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'ext/libxml/ruby_xml_reader.c', line 160

static VALUE rxml_reader_io(int argc, VALUE *argv, VALUE klass)
{
  xmlTextReaderPtr xreader;
  VALUE result;
  VALUE io;
  VALUE options;
  char *xbaseurl = NULL;
  const char *xencoding = NULL;
  int xoptions = 0;

  rb_scan_args(argc, argv, "11", &io, &options);

  if (!NIL_P(options))
  {
    VALUE baseurl = Qnil;
    VALUE encoding = Qnil;
    VALUE parserOptions = Qnil;

    Check_Type(options, T_HASH);

    baseurl = rb_hash_aref(options, BASE_URI_SYMBOL);
    xbaseurl = NIL_P(baseurl) ? NULL : StringValueCStr(baseurl);

    encoding = rb_hash_aref(options, ENCODING_SYMBOL);
    xencoding = NIL_P(encoding) ? NULL : xmlGetCharEncodingName(NUM2INT(encoding));

    parserOptions = rb_hash_aref(options, OPTIONS_SYMBOL);
    xoptions = NIL_P(parserOptions) ? 0 : NUM2INT(parserOptions);
  }
  
  xreader = xmlReaderForIO((xmlInputReadCallback) rxml_read_callback, NULL,
                           (void *) io, 
                           xbaseurl, xencoding, xoptions);

  if (xreader == NULL)
    rxml_raise(&xmlLastError);

  result = rxml_reader_wrap(xreader);

  /* Attach io object to parser so it won't get freed.*/
  rb_ivar_set(result, IO_ATTR, io);

  return result;
}

.XML::Reader.string(io) ⇒ XML::Reader .XML::Reader.string(io, : encoding) ⇒ XML::Encoding::UTF_8

Creates a new reader by parsing the specified string.

You may provide an optional hash table to control how the parsing is performed. Valid options are:

base_uri - The base url for the parsed document.
encoding - The document encoding, defaults to nil. Valid values
           are the encoding constants defined on XML::Encoding.
options - Controls the execution of the parser, defaults to 0.
          Valid values are the constants defined on
          XML::Parser::Options.  Mutliple options can be combined
          by using Bitwise OR (|).

Overloads:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'ext/libxml/ruby_xml_reader.c', line 223

static VALUE rxml_reader_string(int argc, VALUE *argv, VALUE klass)
{
  xmlTextReaderPtr xreader;
  VALUE string;
  VALUE options;
  char *xbaseurl = NULL;
  const char *xencoding = NULL;
  int xoptions = 0;

  rb_scan_args(argc, argv, "11", &string, &options);
  Check_Type(string, T_STRING);

  if (!NIL_P(options))
  {
    VALUE baseurl = Qnil;
    VALUE encoding = Qnil;
    VALUE parserOptions = Qnil;

    int foo;
    Check_Type(options, T_HASH);

    baseurl = rb_hash_aref(options, BASE_URI_SYMBOL);
    xbaseurl = NIL_P(baseurl) ? NULL : StringValueCStr(baseurl);

    encoding = rb_hash_aref(options, ENCODING_SYMBOL);
    xencoding = NIL_P(encoding) ? NULL : xmlGetCharEncodingName(NUM2INT(encoding));
      
    parserOptions = rb_hash_aref(options, OPTIONS_SYMBOL);
    xoptions = NIL_P(parserOptions) ? 0 : NUM2INT(parserOptions);
  }
  
  xreader = xmlReaderForMemory(StringValueCStr(string), RSTRING_LEN(string), 
                               xbaseurl, xencoding, xoptions);

  if (xreader == NULL)
    rxml_raise(&xmlLastError);

  return rxml_reader_wrap(xreader);
}

.walker(doc) ⇒ Object

:enddoc:



18
19
20
21
 
# File 'lib/libxml/reader.rb', line 18

def self.walker(doc)
  warn("XML::Reader.walker is deprecated.  Use XML::Reader.document instead")
  self.document(doc)
end

Instance Method Details

#[](key) ⇒ Object

Provide the value of the attribute with the specified index (if key is an integer) or with the specified name (if key is a string) relative to the containing element, as a string.



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'ext/libxml/ruby_xml_reader.c', line 804

static VALUE rxml_reader_attribute(VALUE self, VALUE key)
{
  xmlTextReaderPtr reader;
  xmlChar *attr;
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);


  if (TYPE(key) == T_FIXNUM)
  {
    attr = xmlTextReaderGetAttributeNo(xReader, FIX2INT(key));
  }
  else
  {
    attr = xmlTextReaderGetAttribute(xReader, (const xmlChar *) StringValueCStr(key));
  }
  return (attr == NULL ? Qnil : rxml_str_new2(attr, xencoding));
}

#attribute_count ⇒ Object

Provide the number of attributes of the current node.



614
615
616
617
 
# File 'ext/libxml/ruby_xml_reader.c', line 614

static VALUE rxml_reader_attr_count(VALUE self)
{
  return INT2FIX(xmlTextReaderAttributeCount(rxml_text_reader_get(self)));
}

#base_uri ⇒ Object

Determine the base URI of the node.



651
652
653
654
655
656
657
658
 
# File 'ext/libxml/ruby_xml_reader.c', line 651

static VALUE rxml_reader_base_uri(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstBaseUri(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#byte_consumed ⇒ Object

This method provides the current index of the parser used by the reader, relative to the start of the current entity.



873
874
875
876
877
 
# File 'ext/libxml/ruby_xml_reader.c', line 873

static VALUE
rxml_reader_byte_consumed(VALUE self)
{
  return INT2NUM(xmlTextReaderByteConsumed(rxml_text_reader_get(self)));
}

#close ⇒ Object

This method releases any resources allocated by the current instance changes the state to Closed and close any underlying input.



270
271
272
273
 
# File 'ext/libxml/ruby_xml_reader.c', line 270

static VALUE rxml_reader_close(VALUE self)
{
  return INT2FIX(xmlTextReaderClose(rxml_text_reader_get(self)));
}

#column_number ⇒ Numeric

Provide the column number of the current parsing point.

Returns:

  • (Numeric) 


887
888
889
890
891
 
# File 'ext/libxml/ruby_xml_reader.c', line 887

static VALUE
rxml_reader_column_number(VALUE self)
{
  return INT2NUM(xmlTextReaderGetParserColumnNumber(rxml_text_reader_get(self)));
}

#default? ⇒ Boolean

Return whether an Attribute node was generated from the default value defined in the DTD or schema.

Returns:

  • (Boolean) 


913
914
915
916
 
# File 'ext/libxml/ruby_xml_reader.c', line 913

static VALUE rxml_reader_default(VALUE self)
{
  return xmlTextReaderIsDefault(rxml_text_reader_get(self)) ? Qtrue : Qfalse;
}

#depth ⇒ Object

Get the depth of the node in the tree.



711
712
713
714
 
# File 'ext/libxml/ruby_xml_reader.c', line 711

static VALUE rxml_reader_depth(VALUE self)
{
  return INT2FIX(xmlTextReaderDepth(rxml_text_reader_get(self)));
}

#empty_element? ⇒ Boolean

Check if the current node is empty.

Returns:

  • (Boolean) 


937
938
939
940
941
 
# File 'ext/libxml/ruby_xml_reader.c', line 937

static VALUE rxml_reader_empty_element(VALUE self)
{
  return xmlTextReaderIsEmptyElement(rxml_text_reader_get(self)) ? Qtrue
      : Qfalse;
}

#encoding ⇒ XML::Encoding::UTF_8

Returns the encoding of the document being read. Note you first have to read data from the reader for encoding to return a value

reader = XML::Reader.file(XML_FILE)
assert_nil(reader.encoding)
reader.read
assert_equal(XML::Encoding::UTF_8, reader.encoding)

In addition, libxml always appears to return nil for the encoding when parsing strings.

Returns:



635
636
637
638
639
640
641
642
643
 
# File 'ext/libxml/ruby_xml_reader.c', line 635

static VALUE rxml_reader_encoding(VALUE self)
{
  xmlTextReaderPtr xreader = rxml_text_reader_get(self);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xreader);
  if (xencoding)
    return INT2NUM(xmlParseCharEncoding(xencoding));
  else
    return INT2NUM(XML_CHAR_ENCODING_NONE);
}

#expand ⇒ Object

Read the contents of the current node and the full subtree. It then makes the subtree available until the next read call.

Return an XML::Node object, or nil in case of error.



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'ext/libxml/ruby_xml_reader.c', line 848

static VALUE rxml_reader_expand(VALUE self)
{
  xmlNodePtr node, nodec;
  xmlTextReaderPtr reader = rxml_text_reader_get(self);
  node = xmlTextReaderExpand(reader);

  if (!node)
    return Qnil;
  else {
    nodec = xmlCopyNode(node, 1);
    if (!nodec)
      return Qnil;
    else
      return rxml_node_wrap(nodec);
  }
}

#has_attributes? ⇒ Boolean

Get whether the node has attributes.

Returns:

  • (Boolean) 


779
780
781
782
783
 
# File 'ext/libxml/ruby_xml_reader.c', line 779

static VALUE rxml_reader_has_attributes(VALUE self)
{
  return xmlTextReaderHasAttributes(rxml_text_reader_get(self)) ? Qtrue
      : Qfalse;
}

#has_value? ⇒ Boolean

Get whether the node can have a text value.

Returns:

  • (Boolean) 


791
792
793
794
 
# File 'ext/libxml/ruby_xml_reader.c', line 791

static VALUE rxml_reader_has_value(VALUE self)
{
  return xmlTextReaderHasValue(rxml_text_reader_get(self)) ? Qtrue : Qfalse;
}

#line_number ⇒ Numeric

Provide the line number of the current parsing point.

Returns:

  • (Numeric) 


899
900
901
902
903
 
# File 'ext/libxml/ruby_xml_reader.c', line 899

static VALUE
rxml_reader_line_number(VALUE self)
{
  return INT2NUM(xmlTextReaderGetParserLineNumber(rxml_text_reader_get(self)));
}

#local_name ⇒ Object

Return the local name of the node.



599
600
601
602
603
604
605
606
 
# File 'ext/libxml/ruby_xml_reader.c', line 599

static VALUE rxml_reader_local_name(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstLocalName(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#lookup_namespace(prefix) ⇒ Object

Resolve a namespace prefix in the scope of the current element. To return the default namespace, specify nil as prefix.



830
831
832
833
834
835
836
837
 
# File 'ext/libxml/ruby_xml_reader.c', line 830

static VALUE rxml_reader_lookup_namespace(VALUE self, VALUE prefix)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderLookupNamespace(xReader, (const xmlChar *) StringValueCStr(prefix));
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#move_to_attribute(val) ⇒ Object

Move the position of the current instance to the attribute with the specified index (if val is an integer) or name (if val is a string) relative to the containing element.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'ext/libxml/ruby_xml_reader.c', line 283

static VALUE rxml_reader_move_to_attr(VALUE self, VALUE val)
{
  xmlTextReaderPtr xreader;
  int ret;

  xreader = rxml_text_reader_get(self);

  if (TYPE(val) == T_FIXNUM)
  {
    ret = xmlTextReaderMoveToAttributeNo(xreader, FIX2INT(val));
  }
  else
  {
    ret = xmlTextReaderMoveToAttribute(xreader,
        (const xmlChar *) StringValueCStr(val));
  }

  return INT2FIX(ret);
}

#move_to_element ⇒ Object

Move the position of the current instance to the node that contains the current attribute node.



334
335
336
337
 
# File 'ext/libxml/ruby_xml_reader.c', line 334

static VALUE rxml_reader_move_to_element(VALUE self)
{
  return INT2FIX(xmlTextReaderMoveToElement(rxml_text_reader_get(self)));
}

#move_to_first_attribute ⇒ Object

Move the position of the current instance to the first attribute associated with the current node.



310
311
312
313
 
# File 'ext/libxml/ruby_xml_reader.c', line 310

static VALUE rxml_reader_move_to_first_attr(VALUE self)
{
  return INT2FIX(xmlTextReaderMoveToFirstAttribute(rxml_text_reader_get(self)));
}

#move_to_next_attribute ⇒ Object

Move the position of the current instance to the next attribute associated with the current node.



322
323
324
325
 
# File 'ext/libxml/ruby_xml_reader.c', line 322

static VALUE rxml_reader_move_to_next_attr(VALUE self)
{
  return INT2FIX(xmlTextReaderMoveToNextAttribute(rxml_text_reader_get(self)));
}

#name ⇒ Object

Return the qualified name of the node.



584
585
586
587
588
589
590
591
 
# File 'ext/libxml/ruby_xml_reader.c', line 584

static VALUE rxml_reader_name(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstName(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#namespace_declaration? ⇒ Boolean

Determine whether the current node is a namespace declaration rather than a regular attribute.

Returns:

  • (Boolean) 


925
926
927
928
929
 
# File 'ext/libxml/ruby_xml_reader.c', line 925

static VALUE rxml_reader_namespace_declaration(VALUE self)
{
  return xmlTextReaderIsNamespaceDecl(rxml_text_reader_get(self)) ? Qtrue
      : Qfalse;
}

#namespace_uri ⇒ Object

Determine the namespace URI of the node.



666
667
668
669
670
671
672
673
 
# File 'ext/libxml/ruby_xml_reader.c', line 666

static VALUE rxml_reader_namespace_uri(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstNamespaceUri(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#next ⇒ Object

Skip to the node following the current one in document order while avoiding the subtree if any.



346
347
348
349
 
# File 'ext/libxml/ruby_xml_reader.c', line 346

static VALUE rxml_reader_next(VALUE self)
{
  return INT2FIX(xmlTextReaderNext(rxml_text_reader_get(self)));
}

#next_sibling ⇒ Object

Skip to the node following the current one in document order while avoiding the subtree if any. Currently implemented only for Readers built on a document.



359
360
361
362
 
# File 'ext/libxml/ruby_xml_reader.c', line 359

static VALUE rxml_reader_next_sibling(VALUE self)
{
  return INT2FIX(xmlTextReaderNextSibling(rxml_text_reader_get(self)));
}

#node ⇒ XML::Node

Returns the reader’s current node. It will return nil if Reader#read has not yet been called. WARNING - Using this method is dangerous because the the node may be destroyed on the next #read.

Returns:



373
374
375
376
377
378
 
# File 'ext/libxml/ruby_xml_reader.c', line 373

static VALUE rxml_reader_node(VALUE self)
{
  xmlTextReaderPtr xreader = rxml_text_reader_get(self);
  xmlNodePtr xnode = xmlTextReaderCurrentNode(xreader);
  return xnode ? rxml_node_wrap(xnode) : Qnil;
}

#node_type ⇒ Object

Get the node type of the current node. Reference: dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html



387
388
389
390
 
# File 'ext/libxml/ruby_xml_reader.c', line 387

static VALUE rxml_reader_node_type(VALUE self)
{
  return INT2FIX(xmlTextReaderNodeType(rxml_text_reader_get(self)));
}

#normalization ⇒ Object

The value indicating whether to normalize white space and attribute values. Since attribute value and end of line normalizations are a MUST in the XML specification only the value true is accepted. The broken bahaviour of accepting out of range character entities like &#0; is of course not supported either.

Return 1 or -1 in case of error.



404
405
406
407
 
# File 'ext/libxml/ruby_xml_reader.c', line 404

static VALUE rxml_reader_normalization(VALUE self)
{
  return INT2FIX(xmlTextReaderNormalization(rxml_text_reader_get(self)));
}

#prefix ⇒ Object

Get a shorthand reference to the namespace associated with the node.



696
697
698
699
700
701
702
703
 
# File 'ext/libxml/ruby_xml_reader.c', line 696

static VALUE rxml_reader_prefix(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstPrefix(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#quote_char ⇒ String

Get the quotation mark character used to enclose the value of an attribute, as an integer value (and -1 in case of error).

Returns:

  • (String) 


723
724
725
726
 
# File 'ext/libxml/ruby_xml_reader.c', line 723

static VALUE rxml_reader_quote_char(VALUE self)
{
  return INT2FIX(xmlTextReaderQuoteChar(rxml_text_reader_get(self)));
}

#read ⇒ Object

Causes the reader to move to the next node in the stream, exposing its properties.

Returns true if a node was successfully read or false if there are no more nodes to read. On errors, an exception is raised.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'ext/libxml/ruby_xml_reader.c', line 417

static VALUE rxml_reader_read(VALUE self)
{
  int result = xmlTextReaderRead(rxml_text_reader_get(self));
  switch(result)
  {
    case -1:
      rxml_raise(&xmlLastError);
      return Qnil;
      break;
    case 0:
      return Qfalse;
    case 1:
      return Qtrue;
    default:
      rb_raise(rb_eRuntimeError,
               "xmlTextReaderRead did not return -1, 0 or 1.  Return value was: %d", result);
  }
}

#read_attribute_value ⇒ Object

Parse an attribute value into one or more Text and EntityReference nodes.

Return 1 in case of success, 0 if the reader was not positionned on an attribute node or all the attribute values have been read, or -1 in case of error.



446
447
448
449
 
# File 'ext/libxml/ruby_xml_reader.c', line 446

static VALUE rxml_reader_read_attr_value(VALUE self)
{
  return INT2FIX(xmlTextReaderReadAttributeValue(rxml_text_reader_get(self)));
}

#read_inner_xml ⇒ Object

Read the contents of the current node, including child nodes and markup.

Return a string containing the XML content, or nil if the current node is neither an element nor attribute, or has no child nodes.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'ext/libxml/ruby_xml_reader.c', line 460

static VALUE rxml_reader_read_inner_xml(VALUE self)
{
  VALUE result = Qnil;
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);

  xmlChar *xml = xmlTextReaderReadInnerXml(xReader);

  if (xml != NULL)
  {
    const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);
    result = rxml_str_new2((const char*) xml, xencoding);
    xmlFree(xml);
  }

  return result;
}

#read_outer_xml ⇒ Object

Read the contents of the current node, including child nodes and markup.

Return a string containing the XML content, or nil if the current node is neither an element nor attribute, or has no child nodes.



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'ext/libxml/ruby_xml_reader.c', line 486

static VALUE rxml_reader_read_outer_xml(VALUE self)
{
  VALUE result = Qnil;
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);

  xmlChar *xml = xmlTextReaderReadOuterXml(xReader);

  if (xml != NULL)
  {
    const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);
    result = rxml_str_new2((const char*) xml, xencoding);
    xmlFree(xml);
  }

  return result;
}

#read_state ⇒ Object

Get the read state of the reader.



509
510
511
512
 
# File 'ext/libxml/ruby_xml_reader.c', line 509

static VALUE rxml_reader_read_state(VALUE self)
{
  return INT2FIX(xmlTextReaderReadState(rxml_text_reader_get(self)));
}

#read_string ⇒ String

Read the contents of an element or a text node as a string.

Return a string containing the contents of the Element or Text node, or nil if the reader is positioned on any other type of node.

Returns:

  • (String) 


523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'ext/libxml/ruby_xml_reader.c', line 523

static VALUE rxml_reader_read_string(VALUE self)
{
  VALUE result = Qnil;
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);

  xmlChar *xml = xmlTextReaderReadString(xReader);

  if (xml != NULL)
  {
    const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);
    result = rxml_str_new2((const char*) xml, xencoding);
    xmlFree(xml);
  }

  return result;
}

#relax_ng_validate(rng) ⇒ Object

Use RelaxNG to validate the document as it is processed. Activation is only possible before the first read. If rng is nil, the RelaxNG validation is desactivated.

Return 0 in case the RelaxNG validation could be (des)activated and -1 in case of error.



551
552
553
554
555
 
# File 'ext/libxml/ruby_xml_reader.c', line 551

static VALUE rxml_reader_relax_ng_validate(VALUE self, VALUE rng)
{
  char *xrng = NIL_P(rng) ? NULL : StringValueCStr(rng);
  return INT2FIX(xmlTextReaderRelaxNGValidate(rxml_text_reader_get(self), xrng));
}

#reset_error_handler ⇒ Object 



6
7
8
9
 
# File 'lib/libxml/reader.rb', line 6

def reset_error_handler
  warn('reset_error_handler is deprecated.  Use Error.reset_handler instead')
  Error.reset_handler
end

#schema_validate(schema) ⇒ Object

Use W3C XSD schema to validate the document as it is processed. Activation is only possible before the first read. If schema is nil, then XML Schema validation is desactivated.

Return 0 in case the schemas validation could be (de)activated and -1 in case of error.



569
570
571
572
573
574
575
 
# File 'ext/libxml/ruby_xml_reader.c', line 569

static VALUE
rxml_reader_schema_validate(VALUE self, VALUE xsd)
{
  char *xxsd = NIL_P(xsd) ? NULL : StringValueCStr(xsd);
  int status = xmlTextReaderSchemaValidate(rxml_text_reader_get(self), xxsd);
  return INT2FIX(status);
}

#set_error_handler(&block) ⇒ Object 



11
12
13
14
 
# File 'lib/libxml/reader.rb', line 11

def set_error_handler(&block)
  warn('set_error_handler is deprecated.  Use Error.set_handler instead')
  Error.set_handler(&block)
end

#standalone ⇒ Object

Determine the standalone status of the document being read.

Return 1 if the document was declared to be standalone, 0 if it was declared to be not standalone, or -1 if the document did not specify its standalone status or in case of error.



738
739
740
741
 
# File 'ext/libxml/ruby_xml_reader.c', line 738

static VALUE rxml_reader_standalone(VALUE self)
{
  return INT2FIX(xmlTextReaderStandalone(rxml_text_reader_get(self)));
}

#valid? ⇒ Boolean

Retrieve the validity status from the parser context.

Returns:

  • (Boolean) 


949
950
951
952
 
# File 'ext/libxml/ruby_xml_reader.c', line 949

static VALUE rxml_reader_valid(VALUE self)
{
  return xmlTextReaderIsValid(rxml_text_reader_get(self)) ? Qtrue : Qfalse;
}

#value ⇒ Object

Provide the text value of the node if present.



681
682
683
684
685
686
687
688
 
# File 'ext/libxml/ruby_xml_reader.c', line 681

static VALUE rxml_reader_value(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstValue(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#xml_lang ⇒ Object

Get the xml:lang scope within which the node resides.



749
750
751
752
753
754
755
756
 
# File 'ext/libxml/ruby_xml_reader.c', line 749

static VALUE rxml_reader_xml_lang(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstXmlLang(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}

#xml_version ⇒ Object

Determine the XML version of the document being read.



764
765
766
767
768
769
770
771
 
# File 'ext/libxml/ruby_xml_reader.c', line 764

static VALUE rxml_reader_xml_version(VALUE self)
{
  xmlTextReaderPtr xReader = rxml_text_reader_get(self);
  const xmlChar *result = xmlTextReaderConstXmlVersion(xReader);
  const xmlChar *xencoding = xmlTextReaderConstEncoding(xReader);

  return (result == NULL ? Qnil : rxml_str_new2(result, xencoding));
}