The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

MALLEN / Pod-Perldoc-3.28 / lib / Pod / Perldoc / BaseTo.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

              
package Pod::Perldoc::BaseTo;
use strict;
use warnings;
use vars qw($VERSION);
$VERSION = '3.28';
use Carp                  qw(croak carp);
use Config                qw(%Config);
use File::Spec::Functions qw(catfile);
sub is_pageable        { '' }
sub write_with_binmode {  1 }
sub output_extension   { 'txt' }  # override in subclass!
# sub new { my $self = shift; ...  }
# sub parse_from_file( my($class, $in, $out) = ...; ... }
#sub new { return bless {}, ref($_[0]) || $_[0] }
# this is also in Perldoc.pm, but why look there when you're a
# subclass of this?
sub TRUE  () {1}
sub FALSE () {return}
BEGIN {
 *is_vms     = $^O eq 'VMS'      ? \&TRUE : \&FALSE unless defined &is_vms;
 *is_mswin32 = $^O eq 'MSWin32'  ? \&TRUE : \&FALSE unless defined &is_mswin32;
 *is_dos     = $^O eq 'dos'      ? \&TRUE : \&FALSE unless defined &is_dos;
 *is_os2     = $^O eq 'os2'      ? \&TRUE : \&FALSE unless defined &is_os2;
 *is_cygwin  = $^O eq 'cygwin'   ? \&TRUE : \&FALSE unless defined &is_cygwin;
 *is_linux   = $^O eq 'linux'    ? \&TRUE : \&FALSE unless defined &is_linux;
 *is_hpux    = $^O =~ m/hpux/    ? \&TRUE : \&FALSE unless defined &is_hpux;
 *is_openbsd = $^O =~ m/openbsd/ ? \&TRUE : \&FALSE unless defined &is_openbsd;
 *is_freebsd = $^O =~ m/freebsd/ ? \&TRUE : \&FALSE unless defined &is_freebsd;
 *is_bitrig = $^O =~ m/bitrig/ ? \&TRUE : \&FALSE unless defined &is_bitrig;
}
sub _perldoc_elem {
  my($self, $name) = splice @_,0,2;
  if(@_) {
    $self->{$name} = $_[0];
  } else {
    $self->{$name};
  }
}
sub debugging {
        my( $self, @messages ) = @_;
    ( defined(&Pod::Perldoc::DEBUG) and &Pod::Perldoc::DEBUG() )
        }
sub debug {
        my( $self, @messages ) = @_;
        return unless $self->debugging;
        print STDERR map { "DEBUG $_" } @messages;
        }
sub warn {
        my( $self, @messages ) = @_;
        carp join "\n", @messages, '';
        }
sub die {
        my( $self, @messages ) = @_;
        croak join "\n", @messages, '';
        }
sub _get_path_components {
        my( $self ) = @_;
        my @paths = split /\Q$Config{path_sep}/, $ENV{PATH};
        return @paths;
        }
sub _find_executable_in_path {
        my( $self, $program ) = @_;
        my @found = ();
        foreach my $dir ( $self->_get_path_components ) {
                my $binary = catfile( $dir, $program );
                $self->debug( "Looking for $binary\n" );
                next unless -e $binary;
                unless( -x $binary ) {
                        $self->warn( "Found $binary but it's not executable. Skipping.\n" );
                        next;
                        }
                $self->debug( "Found $binary\n" );
                push @found, $binary;
                }
        return @found;
        }
1;
__END__
=head1 NAME
Pod::Perldoc::BaseTo - Base for Pod::Perldoc formatters
=head1 SYNOPSIS
    package Pod::Perldoc::ToMyFormat;
    use parent qw( Pod::Perldoc::BaseTo );
    ...
=head1 DESCRIPTION
This package is meant as a base of Pod::Perldoc formatters,
like L<Pod::Perldoc::ToText>, L<Pod::Perldoc::ToMan>, etc.
It provides default implementations for the methods
    is_pageable
    write_with_binmode
    output_extension
    _perldoc_elem
The concrete formatter must implement
    new
    parse_from_file
=head1 SEE ALSO
L<perldoc>
=head1 COPYRIGHT AND DISCLAIMERS
Copyright (c) 2002-2007 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
Current maintainer: Mark Allen C<< <mallen@cpan.org> >>
Past contributions from:
brian d foy C<< <bdfoy@cpan.org> >>
Adriano R. Ferreira C<< <ferreira@cpan.org> >>,
Sean M. Burke C<< <sburke@cpan.org> >>
=cut