para

head

XML tree navigator for L<XML::Document> / L<XML::Element> trees produced by
L<Qwiratry::Format::XML>.


Adapts the community L<XML> object model to Qwiratry's tree navigation protocol:


item

Descendant walks (C<< ⪪⪪ >>) are owned by the query evaluator; this navigator
only supplies one-step shape operations.


use XML::Document;
use XML::Element;
use Qwiratry::Query::Selector;
use Qwiratry::Tree::Navigator::Base;

class Qwiratry::Tree::Navigator::XML does Qwiratry::Tree::Navigator::Base {

	

	method supported-types(--> List) {
		(XML::Document, XML::Element)
	}

	# Return True when C<$node> is an element whose name matches C<$selector>.
	method !element-name-matches(Mu $node, Mu $selector --> Bool) {
		$node ~~ XML::Element or return False;
		self!selector.matches($selector, %(name => $node.name))
	}

	# Filter C<$node>'s structural children by name / type / callable selectors.
	# Uses a name-bearing hash so L<Qwiratry::Query::Selector> can match element
	# names (it only reads C<name>/C<tag>/C<type> from Associative nodes).
	method !filter-xml-children(Mu $node, Mu $selector, Int :$limit --> List) {
		my $sel = self!selector;
		my @out;
		for self.tree-children($node) -> $child {
			my $matched = do {
				if $sel.is-type-object($selector) {
					$child ~~ $selector
				}
				elsif $selector ~~ Callable {
					?$selector($child)
				}
				elsif $selector ~~ Str | Regex {
					self!element-name-matches($child, $selector)
				}
				elsif $selector ~~ List {
					$selector.grep({
						self!element-name-matches($child, $_)
						|| ($sel.is-type-object($_) && $child ~~ $_)
						|| ($_ ~~ Callable && ?$_($child))
					}).so
				}
				else {
					False
				}
			};
			next unless $matched;
			@out.push($child);
			last if $limit.defined && @out.elems >= $limit;
		}
		@out.list
	}

	

	multi method tree-children(XML::Document:D $node --> List) {
		($node.root,).list
	}

	multi method tree-children(XML::Element:D $node --> List) {
		$node.nodes.list
	}

	

String selectors follow element-child names (not attributes). Wildcards
	return every structural child, including text and comment nodes.


	multi method tree-child-results(XML::Document:D $node, List $selector, Int :$limit --> List) {
		self!fan-out-child-results($node, $selector, |%(:$limit if $limit.defined))
	}

	multi method tree-child-results(
		XML::Document:D $node,
		Mu $selector where { Qwiratry::Query::Selector.instance.is-wildcard($_) },
		Int :$limit --> List
	) {
		self!apply-limit(self.tree-children($node), $limit)
	}

	multi method tree-child-results(XML::Document:D $node, Mu $selector, Int :$limit --> List) {
		self!filter-xml-children($node, $selector, |%(:$limit if $limit.defined))
	}

	multi method tree-child-results(XML::Element:D $node, List $selector, Int :$limit --> List) {
		self!fan-out-child-results($node, $selector, |%(:$limit if $limit.defined))
	}

	multi method tree-child-results(
		XML::Element:D $node,
		Mu $selector where { Qwiratry::Query::Selector.instance.is-wildcard($_) },
		Int :$limit --> List
	) {
		self!apply-limit(self.tree-children($node), $limit)
	}

	multi method tree-child-results(XML::Element:D $node, Mu $selector, Int :$limit --> List) {
		self!filter-xml-children($node, $selector, |%(:$limit if $limit.defined))
	}

	

	multi method tree-attributes(XML::Element:D $node --> Associative) {
		$node.attribs
	}

	multi method tree-attributes(XML::Document:D $node --> Associative) {
		my %attrs;
		%attrs<version> = $node.version if $node.version.defined;
		%attrs<encoding> = $node.encoding if $node.encoding.defined;
		%attrs
	}

	

	multi method tree-attribute-value(XML::Element:D $node, Mu $key --> Mu) {
		my $name = self!selector.normalize-key($key);
		return $node.attribs{$name} if $node.attribs{$name}:exists;
		Nil
	}

	multi method tree-attribute-value(XML::Document:D $node, Mu $key --> Mu) {
		my $name = self!selector.normalize-key($key);
		my %attrs = self.tree-attributes($node);
		return %attrs{$name} if %attrs{$name}:exists;
		Nil
	}
}


root

User-visible changes by release


Changelog


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


XML

Overview

`supported-types()`

`tree-children`

`tree-child-results`

`tree-attributes`

`tree-attribute-value`

Qwiratry::Format::XML v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation