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
|
package Markdent::Role::FilterHandler;
use strict;
use warnings;
use namespace::autoclean;
our $VERSION = '0.40';
use Markdent::Types;
use Moose::Role;
with 'Markdent::Role::Handler';
requires 'filter_event';
has handler => (
is => 'ro',
does => t('HandlerObject'),
required => 1,
);
sub handle_event {
my $self = shift;
my $event = shift;
my $new_event = $self->filter_event($event);
$self->handler->handle_event($new_event)
if $new_event;
}
1;
# ABSTRACT: A role for handlers which act as filters
__END__
=pod
=encoding UTF-8
=head1 NAME
Markdent::Role::FilterHandler - A role for handlers which act as filters
=head1 VERSION
version 0.40
=head1 DESCRIPTION
This role implements behavior and interface for filtering handlers. A filter
handler takes events and does something to some of them, and then passes them
on to another handler.
=head1 REQUIRED METHODS
=over 4
=item * $handler->filter_event($event)
This method will always be called with a single object which does the
L<Markdent::Role::Event> role.
If this method returns a single event, it will be passed on to the next
handler. If it does not return an event, the event is dropped from the stream.
=back
=head1 ATTRIBUTES
This role provides the following attributes:
=head2 handler
This is a read-only attribute. It is an object which does the
L<Markdent::Role::Handler> role.
This is the handler to which the filter passes events after filtering.
=head1 BUGS
See L<Markdent> for bug reporting details.
Bugs may be submitted at L<https://github.com/houseabsolute/Markdent/issues>.
I am also usually active on IRC as 'autarch' on C<irc://irc.perl.org>.
=head1 SOURCE
The source code repository for Markdent can be found at L<https://github.com/houseabsolute/Markdent>.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021 by Dave Rolsky.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
The full text of the license can be found in the
F<LICENSE> file included with this distribution.
=cut
|
