The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

JDEGUEST / HTML-Object-v0.5.1 / lib / HTML / Object / XPath / Root.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
—
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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

              
##----------------------------------------------------------------------------
## HTML Object - ~/lib/HTML/Object/XPath/Root.pm
## Version v0.2.0
## Copyright(c) 2021 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <jack@deguest.jp>
## Created 2021/12/04
## Modified 2022/09/18
## All rights reserved
## 
## 
## This program is free software; you can redistribute  it  and/or  modify  it
## under the same terms as Perl itself.
##----------------------------------------------------------------------------
package HTML::Object::XPath::Root;
BEGIN
{
    use strict;
    use warnings;
    use parent qw( Module::Generic );
    use vars qw( $BASE_CLASS $DEBUG $VERSION );
    our $BASE_CLASS = 'HTML::Object::XPath';
    our $DEBUG = 0;
    our $VERSION = 'v0.2.0';
};
use strict;
use warnings;
sub new
{
    my $this = shift( @_ );
    my $str  = shift( @_ );
    return( bless( \$str => ( ref( $this ) || $this ) ) );
}
sub as_string { return; }
sub as_xml { return( "<Root/>\n" ); }
sub evaluate
{
    my $self = shift( @_ );
    my $nodeset = shift( @_ );
     
    # must only ever occur on 1 node
    die "Can't go to root on > 1 node!" unless $nodeset->size == 1;
    # return( $self->error( "Can't go to root on > 1 node!" ) ) unless( $nodeset->size == 1 );
     
    my $newset = $self->new_nodeset;
    # $newset->push($nodeset->get_node(1)->getRootNode());
    my $node = $nodeset->get_node(1);
    # $node->debug(4);
    my $rootNode = $node->getRootNode();
    $newset->push( $rootNode );
    return( $newset );
}
sub new_nodeset { return( shift->_class_for( 'NodeSet' )->new( @_ ) ); }
sub _class_for
{
    my( $self, $mod ) = @_;
    eval( "require ${BASE_CLASS}\::${mod};" );
    die( $@ ) if( $@ );
    # ${"${BASE_CLASS}\::${mod}\::DEBUG"} = $DEBUG;
    eval( "\$${BASE_CLASS}\::${mod}\::DEBUG = " . ( $DEBUG // 0 ) );
    return( "${BASE_CLASS}::${mod}" );
}
1;
# NOTE: POD
__END__
=encoding utf-8
=head1 NAME
HTML::Object::XPath::Root - HTML Object
=head1 SYNOPSIS
    use HTML::Object::XPath::Root;
    my $root = HTML::Object::XPath::Root->new || 
        die( HTML::Object::XPath::Root->error, "\n" );
=head1 VERSION
    v0.2.0
=head1 DESCRIPTION
This module represents a root element, which is the top element.
=head1 CONSTRUCTOR
=head2 new
Provided with a string, and this returns a new L<HTML::Object::XPath::Root> object.
=head1 METHODS
=head2 as_string
Returns C<undef> in scalar context and an empty list in list context.
=head2 as_xml
Returns C<<Root/>>
=head2 evaluate
Provided with a L<node set|HTML::Object::XPath::NodeSet> object and this the first element in the node set, get its root node and return a new L<set|HTML::Object::XPath::NodeSet> with the node as its sole element.
=head2 new_nodeset
Returns a new L<HTML::Object::XPath::NodeSet> passing it whatever argument was provided.
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 SEE ALSO
L<HTML::Object::XPath>, L<HTML::Object::XPath::Boolean>, L<HTML::Object::XPath::Expr>, L<HTML::Object::XPath::Function>, L<HTML::Object::XPath::Literal>, L<HTML::Object::XPath::LocationPath>, L<HTML::Object::XPath::NodeSet>, L<HTML::Object::XPath::Number>, L<HTML::Object::XPath::Root>, L<HTML::Object::XPath::Step>, L<HTML::Object::XPath::Variable>
=head1 COPYRIGHT & LICENSE
Copyright(c) 2021 DEGUEST Pte. Ltd.
All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
=cut