readSubtreeToPerl( $reader, $flags, \my %ns )

Uses a given XML::LibXML::Reader parser objects to parse a subtree at the current reader position to build a tree formed of nested arrays (see "OUTPUT FORMAT").

reader

A XML::LibXML::Reader object to use as the reader. While building the tree, the reader moves to the next node on the current or higher level.

flags

An integer consisting of 1 bit flags (see constants in the EXPORT section). Use binary or (|) to combine individual flags.

The following flags are NOT implemented yet:

   XCT_USE_QNAMES, XCT_TEXT_AS_STRING, XCT_PRESERVE_PARENT, XCT_MERGE_TEXT_NODES
    

ns

You may pass an empty hash reference that will be populated by a namespace_uri to namespace_index map, that can be used to decode namespace indexes in the resulting data structure (see OUTPUT FORMAT).

readLevelToPerl( $reader, $flags, $ns )

Like "readSubtreeToPerl", but reads the subtree at the current reader position and all its following siblings. It returns an array reference of representations of these subtrees as in the format described in "OUTPUT FORMAT".

Any Node

•

$node->[0] is an integer representing the node type. Use XML::LibXML::Reader node-tye constants, e.g. XML_READER_TYPE_ELEMENT for an element node, XML_READER_TYPE_TEXT for text node, etc.

Document or Document Fragment Nodes

• $node->[1] contains the document encoding
• $node->[2] is an array reference containing similar represention of all the child nodes of the document (fragment).

Note: XML::LibXML::Reader does not document node by default, which means that calling readSubtreeToPerl on a reader object in its initial state only parses the first node in the document (which can be the root element, but also a comment or a processing instruction). Use XCT_DOCUMENT_ROOT flag to force creating a document node in such case.

Element nodes

• $node->[1] is the local name (UTF-8 encoded character string)
• $node->[2] is the namespace index (see NAMESPACES below)
• $node->[3] is undef if the element has no attributes. Otherwise if XCT_ATTRIBUTE_ARRAY flag was used, $node->[3] is an array reference of the form "[ name1, value1, name2, value2, ....]" of attribute names and corresponding values. If XCT_ATTRIBUTE_ARRAY flag was not used, then $node->[3] is a hash reference mapping attribute names to the corresponding attribute values "{ name1="value1, name2=>value2...}>

  The flag XCT_KEEP_NS_DECLS controls whether namespace declarations (xmlns=... or xmlns:prefix=...) are included along with normal attributes or not.

  Note: there is no support for namespaced attributes yet, but the attribute names are stored as QNames, so one can always use XCT_KEEP_NS_DECLS to keep track of namespace prefix declarations and do the resolving manually. Support for namespaced attributes is planned.

• If XTC_LINE_NUMBERS flag was used, $node->[4] contains the line number of the element and $node->[5] contains an array reference containing similar representions of the child nodes of the current node.
• If XTC_LINE_NUMBERS flag was NOT used, $node->[4] contains an array reference of similar representations of the child nodes of the current node.

Text, CDATA, Comment and White-Space Nodes

•

$node->[1] contains the node value (UTF-8 encoded character string)

Unparsed Entity, Processing-Instruction, and Notation Nodes

• $node->[1] contains the local name (there is no support for namespaces on these types of nodes yet)
• $node->[2] contains the node value

Skipping Less-Significant Nodes

White-space (non-significant or significant), processing-instruction and comment nodes can be completely skipped, using the following flags:

   XCT_IGNORE_WS
   XCT_IGNORE_SIGNIFICANT_WS
   XCT_IGNORE_PROCESSING_INSTRUCTIONS
   XCT_IGNORE_COMMENTS

Example

  use XML::CompactTree;
  use XML::LibXML::Reader;
  my $reader = XML::LibXML::Reader->new(location => $ARGV[0]);
  my %ns;
  my $data = XML::CompactTree::readSubtreeToPerl( $reader, XCT_DOCUMENT_ROOT, \%ns );
  $ns_map[$ns{$_}]=$_ for keys %ns;
  my @nodes = ($data);
  while (@nodes) {
    my $node = shift @nodes;
    my $type = $node->[0];
    if ($type == XML_READER_TYPE_ELEMENT) {
      print "element $node->[1] is from ns $node->[2] '$ns_map[$node->[2]]'\n";
      push @nodes, @{$node->[4]}; # queue children
    } elsif ($type == XML_READER_TYPE_DOCUMENT) {
      push @nodes, @{$node->[2]}; # queue children
    }
  }