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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
#-*- perl -*-
#
# Copyright (C) 2000,2001 Ken'ichi Fukamachi
# All rights reserved.
#
# $FML: DocViewer.pm,v 1.11 2001/12/22 13:24:32 fukachan Exp $
#
package FML::Process::DocViewer;
use vars qw($debug @ISA @EXPORT @EXPORT_OK);
use strict;
use Carp;
use FML::Process::Kernel;
use FML::Log qw(Log LogWarn LogError);
use FML::Config;
@ISA = qw(FML::Process::Kernel);
=head1 NAME
FML::Process::DocViewer -- perldoc wrapper for fml modules
=head1 SYNOPSIS
use FML::Process::DocViewer;
$curproc = new FML::Process::DocViewer;
$curproc->run();
=head1 DESCRIPTION
FML::Process::DocViewer is the main routine of C<fmldoc> program.
It wraps C<perldoc>.
See C<FML::Process::Flow> for program flow.
=head1 METHODS
=head2 C<new($args)>
standard constructor.
It inherits C<FML::Process::Kernel>.
=head2 C<prepare($args)>
dummy.
=cut
# Descriptions: constructor
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: FML::Process::DocViewer object
sub new
{
my ($self, $args) = @_;
my $type = ref($self) || $self;
my $curproc = new FML::Process::Kernel $args;
return bless $curproc, $type;
}
# Descriptions: dummy
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub prepare { ; }
# Descriptions: check @ARGV and show help if needed
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: may exit.
# longjmp() to help() if appropriate.
# Return Value: none
sub verify_request
{
my ($curproc, $args) = @_;
my $argv = $curproc->command_line_argv();
if (length(@$argv) == 0) {
$curproc->help();
exit(0);
}
}
=head2 C<run($args)>
the main top level dispatcher.
It kicks off internal function C<_fmlconf($args)> for
C<fmlconf($args)>.
=cut
# Descriptions: just a switch, call _fmldoc()
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub run
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $myname = $curproc->myname();
my $argv = $curproc->command_line_argv();
$curproc->_fmldoc($args);
}
# Descriptions: fmldoc wrapper / top level dispacher
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub _fmldoc
{
my ($curproc, $args) = @_;
my $config = $curproc->{ config };
my $myname = $curproc->myname();
my $argv = $curproc->command_line_argv();
my (@opts);
push(@opts, '-v') if $args->{ options }->{ v };
push(@opts, '-t') if $args->{ options }->{ t };
push(@opts, '-u') if $args->{ options }->{ u };
push(@opts, '-m') if $args->{ options }->{ m };
push(@opts, '-l') if $args->{ options }->{ l };
# add path for perl executatbles e.g. /usr/local/bin
eval q{
use Config;
$ENV{'PATH'} .= ":". $Config{ scriptdir };
exec 'perldoc', @opts, @$argv;
};
croak($@);
}
=head2 help()
show help.
=cut
# Descriptions: show help
# Arguments: none
# Side Effects: none
# Return Value: none
sub help
{
my $name = $0;
eval {
use File::Basename;
$name = basename($0);
};
print <<"_EOF_";
Usage: $name MODULE
For example,
$name FML::Process::Kernel
_EOF_
}
# dummy to avoid the error ( undefined function )
sub AUTOLOAD
{
;
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
FML::Process::DocViewer appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
