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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
use strict;
use warnings;
package Pod::Elemental::Selectors;
{
$Pod::Elemental::Selectors::VERSION = '0.102362';
}
# ABSTRACT: predicates for selecting elements
use Moose::Autobox 0.10;
use Sub::Exporter -setup => {
exports => [ qw(s_blank s_flat s_node s_command) ],
};
sub s_blank {
my $code = sub {
my $para = shift;
return $para->isa('Pod::Elemental::Element::Generic::Blank');
};
return @_ ? $code->(@_) : $code;
}
sub s_flat {
my $code = sub {
my $para = shift;
return $para->does('Pod::Elemental::Flat');
};
return @_ ? $code->(@_) : $code;
}
sub s_node {
my $code = sub {
my $para = shift;
return $para->does('Pod::Elemental::Node');
};
return @_ ? $code->(@_) : $code;
}
sub s_command {
my $command = shift;
my $code = sub {
my $para = shift;
return unless $para->does('Pod::Elemental::Command');
return 1 unless defined $command;
my $alts = ref $command ? $command : [ $command ];
return $para->command eq $alts->any;
};
return @_ ? $code->(@_) : $code;
}
1;
__END__
=pod
=head1 NAME
Pod::Elemental::Selectors - predicates for selecting elements
=head1 VERSION
version 0.102362
=head1 OVERVIEW
Pod::Elemental::Selectors provides a number of routines to check for
Pod::Elemental paragraphs with given qualities.
=head1 SELECTORS
Selectors are predicates: they examine paragraphs and return either true or
false. All the selectors have (by default) names like: C<s_whatever>. They
expect zero or more parameters to affect the selection. If these parameters
are given, but no paragraph, a callback will be returned that will expect a
paragraph. If a paragraph is given, the selector will return immediately.
For example, the C<s_command> selector expects a parameter that can be the name
of the command desired. Both of the following uses are valid:
# create and use a callback:
my $selector = s_command('head1');
my @headers = grep { $selector->($_) } @paragraphs;
# just check a paragraph right now:
if ( s_command('head1', $paragraph) ) { ... }
The selectors can be imported individually or as the C<-all> group, and can be
renamed with L<Sub::Exporter> features. (Selectors cannot I<yet> be curried by
Sub::Exporter.)
=head2 s_blank
my $callback = s_blank;
if( s_blank($para) ) { ... }
C<s_blank> tests whether a paragraph is a Generic::Blank element.
=head2 s_flat
my $callback = s_flat;
if( s_flat($para) ) { ... }
C<s_flat> tests whether a paragraph does Pod::Elemental::Flat -- in other
words, is content-only.
=head2 s_node
my $callback = s_node;
if( s_node($para) ) { ... }
C<s_node> tests whether a paragraph does Pod::Elemental::Node -- in other
words, whether it may have children.
=head2 s_command
my $callback = s_command;
my $callback = s_command( $command_name);
my $callback = s_command(\@command_names);
if( s_command(undef, \$para) ) { ... }
if( s_command( $command_name, \$para) ) { ... }
if( s_command(\@command_names, \$para) ) { ... }
C<s_command> tests whether a paragraph does Pod::Elemental::Command. If a
command name (or a reference to an array of command names) is given, the tested
paragraph's command must match one of the given command names.
=head1 AUTHOR
Ricardo SIGNES <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
