Spaces:
Sleeping
Sleeping
require 5; | |
package Pod::Simple::Methody; | |
use strict; | |
use Pod::Simple (); | |
use vars qw(@ISA $VERSION); | |
$VERSION = '3.42'; | |
@ISA = ('Pod::Simple'); | |
# Yes, we could use named variables, but I want this to be impose | |
# as little an additional performance hit as possible. | |
sub _handle_element_start { | |
$_[1] =~ tr/-:./__/; | |
( $_[0]->can( 'start_' . $_[1] ) | |
|| return | |
)->( | |
$_[0], $_[2] | |
); | |
} | |
sub _handle_text { | |
( $_[0]->can( 'handle_text' ) | |
|| return | |
)->( | |
@_ | |
); | |
} | |
sub _handle_element_end { | |
$_[1] =~ tr/-:./__/; | |
( $_[0]->can( 'end_' . $_[1] ) | |
|| return | |
)->( | |
$_[0], $_[2] | |
); | |
} | |
1; | |
__END__ | |
=head1 NAME | |
Pod::Simple::Methody -- turn Pod::Simple events into method calls | |
=head1 SYNOPSIS | |
require 5; | |
use strict; | |
package SomePodFormatter; | |
use base qw(Pod::Simple::Methody); | |
sub handle_text { | |
my($self, $text) = @_; | |
... | |
} | |
sub start_head1 { | |
my($self, $attrs) = @_; | |
... | |
} | |
sub end_head1 { | |
my($self) = @_; | |
... | |
} | |
...and start_/end_ methods for whatever other events you want to catch. | |
=head1 DESCRIPTION | |
This class is of | |
interest to people writing Pod formatters based on Pod::Simple. | |
This class (which is very small -- read the source) overrides | |
Pod::Simple's _handle_element_start, _handle_text, and | |
_handle_element_end methods so that parser events are turned into method | |
calls. (Otherwise, this is a subclass of L<Pod::Simple> and inherits all | |
its methods.) | |
You can use this class as the base class for a Pod formatter/processor. | |
=head1 METHOD CALLING | |
When Pod::Simple sees a "=head1 Hi there", for example, it basically does | |
this: | |
$parser->_handle_element_start( "head1", \%attributes ); | |
$parser->_handle_text( "Hi there" ); | |
$parser->_handle_element_end( "head1" ); | |
But if you subclass Pod::Simple::Methody, it will instead do this | |
when it sees a "=head1 Hi there": | |
$parser->start_head1( \%attributes ) if $parser->can('start_head1'); | |
$parser->handle_text( "Hi there" ) if $parser->can('handle_text'); | |
$parser->end_head1() if $parser->can('end_head1'); | |
If Pod::Simple sends an event where the element name has a dash, | |
period, or colon, the corresponding method name will have a underscore | |
in its place. For example, "foo.bar:baz" becomes start_foo_bar_baz | |
and end_foo_bar_baz. | |
See the source for Pod::Simple::Text for an example of using this class. | |
=head1 SEE ALSO | |
L<Pod::Simple>, L<Pod::Simple::Subclassing> | |
=head1 SUPPORT | |
Questions or discussion about POD and Pod::Simple should be sent to the | |
pod-people@perl.org mail list. Send an empty email to | |
pod-people-subscribe@perl.org to subscribe. | |
This module is managed in an open GitHub repository, | |
L<https://github.com/perl-pod/pod-simple/>. Feel free to fork and contribute, or | |
to clone L<git://github.com/perl-pod/pod-simple.git> and send patches! | |
Patches against Pod::Simple are welcome. Please send bug reports to | |
<bug-pod-simple@rt.cpan.org>. | |
=head1 COPYRIGHT AND DISCLAIMERS | |
Copyright (c) 2002 Sean M. Burke. | |
This library is free software; you can redistribute it and/or modify it | |
under the same terms as Perl itself. | |
This program is distributed in the hope that it will be useful, but | |
without any warranty; without even the implied warranty of | |
merchantability or fitness for a particular purpose. | |
=head1 AUTHOR | |
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. | |
But don't bother him, he's retired. | |
Pod::Simple is maintained by: | |
=over | |
=item * Allison Randal C<allison@perl.org> | |
=item * Hans Dieter Pearcey C<hdp@cpan.org> | |
=item * David E. Wheeler C<dwheeler@cpan.org> | |
=back | |
=cut | |