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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
package Config::Grammar::Document;
# This is a helper class for Config::Grammar implementing the logic
# of its documentation-generating methods.
#
# This code is placed here instead of Config::Grammar in order to make
# the main module leaner. These methods are only used in special cases.
# Note that the installation of this module is optional: if you don't install
# it, the make...() methods just won't work.
sub _describevar {
my $tree = shift;
my $var = shift;
my $mandatory = ( $tree->{_mandatory} and
grep {$_ eq $var} @{$tree->{_mandatory}} ) ?
" I<(mandatory setting)>" : "";
my @doc;
push @doc, "=item B<$var>".$mandatory;
push @doc, $tree->{$var}{_doc} if $tree->{$var}{_doc} ;
my $inherited = ( $tree->{_inherited} and
grep {$_ eq $var} @{$tree->{_inherited}});
push @doc, "This variable I<inherits> its value from the parent section if nothing is specified here."
if $inherited;
push @doc, "Default value: $var = $tree->{$var}{_default}"
if ($tree->{$var}{_default});
push @doc, "Example: $var = $tree->{$var}{_example}"
if ($tree->{$var}{_example});
return @doc;
}
sub _genpod($$$);
sub _genpod($$$)
{
my ($tree, $level, $doc) = @_;
if ($tree->{_vars}){
push @{$doc}, "The following variables can be set in this section:";
push @{$doc}, "=over";
foreach my $var (@{$tree->{_vars}}){
push @{$doc}, _describevar($tree, $var);
}
push @{$doc}, "=back";
}
if ($tree->{_text}){
push @{$doc}, ($tree->{_text}{_doc} or "Unspecified Text content");
if ($tree->{_text}{_example}){
my $ex = $tree->{_text}{_example};
chomp $ex;
$ex = map {" $_"} split /\n/, $ex;
push @{$doc}, "Example:\n\n$ex\n";
}
}
if ($tree->{_table}){
push @{$doc}, ($tree->{_table}{_doc} or
"This section can contain a table ".
"with the following structure:" );
push @{$doc}, "=over";
for (my $i=0;$i < $tree->{_table}{_columns}; $i++){
push @{$doc}, "=item column $i";
push @{$doc}, ($tree->{_table}{$i}{_doc} or
"Unspecific Content");
push @{$doc}, "Example: $tree->{_table}{$i}{_example}"
if ($tree->{_table}{$i}{_example})
}
push @{$doc}, "=back";
}
if ($tree->{_sections}){
if ($level > 0) {
push @{$doc}, "The following sections are valid on level $level:";
push @{$doc}, "=over";
}
foreach my $section (@{$tree->{_sections}}){
my $mandatory = ( $tree->{_mandatory} and
grep {$_ eq $section} @{$tree->{_mandatory}} ) ?
" I<(mandatory section)>" : "";
push @{$doc}, ($level > 0) ?
"=item B<".("+" x $level)."$section>$mandatory" :
"=head2 *** $section ***$mandatory";
if ($tree eq $tree->{$section}) {
push @{$doc}, "This subsection has the same syntax as its parent.";
next;
}
push @{$doc}, ($tree->{$section}{_doc})
if $tree->{$section}{_doc};
_genpod($tree->{$section},$level+1,$doc);
}
push @{$doc}, "=back" if $level > 0
}
};
sub makepod($) {
my $self = shift;
my $tree = $self->{grammar};
my @doc;
_genpod($tree,0,\@doc);
return join("\n\n", @doc)."\n";
}
sub _gentmpl($$$@);
sub _gentmpl($$$@){
my $tree = shift;
my $complete = shift;
my $level = shift;
my $doc = shift;
my @start = @_;
if (scalar @start ) {
my $section = shift @start;
my $secex ='';
my $prefix = '';
$prefix = "# " unless $tree->{_mandatory} and
grep {$_ eq $section} @{$tree->{_mandatory}};
if ($tree->{$section}{_example}) {
$secex = " # ( ex. $tree->{$section}{_example} )";
}
if($complete) {
push @{$doc}, $prefix.
(($level > 0) ? ("+" x $level)."$section" : "*** $section ***").$secex;
} else {
my $minsection=$section =~ m|^/| ? "" : $section;
push @{$doc},(($level > 0) ? ("+" x $level)."$minsection" : "*** $minsection ***");
}
my $match;
foreach my $s (@{$tree->{_sections}}){
if ($s =~ m|^/.+/$| and $section =~ /$s/ or $s eq $section) {
_gentmpl ($tree->{$s},$complete,$level+1,$doc,@start)
unless $tree eq $tree->{$s};
$match = 1;
}
}
push @{$doc}, "# Section $section is not a valid choice"
unless $match;
} else {
if ($tree->{_vars}){
foreach my $var (@{$tree->{_vars}}){
my $mandatory= ($tree->{_mandatory} and
grep {$_ eq $var} @{$tree->{_mandatory}});
if($complete) {
push @{$doc}, "# $var = ".
($tree->{$var}{_example} || ' * no example *');
push @{$doc}, "$var=" if $mandatory;
} else {
push @{$doc}, ($mandatory?"":"# ")."$var=";
next unless $tree->{_mandatory} and
grep {$_ eq $var} @{$tree->{_mandatory}};
}
}
}
if ($tree->{_text} and $complete){
if ($tree->{_text}{_example}){
my $ex = $tree->{_text}{_example};
chomp $ex;
$ex = map {"# $_"} split /\n/, $ex;
push @{$doc}, "$ex\n";
}
}
if ($tree->{_table} and $complete){
my $table = "# table\n#";
for (my $i=0;$i < $tree->{_table}{_columns}; $i++){
$table .= ' "'.($tree->{_table}{$i}{_example} || "C$i").'"';
}
push @{$doc}, $table;
}
if ($tree->{_sections}){
foreach my $section (@{$tree->{_sections}}){
my $opt = "";
unless( $tree->{_mandatory} and
grep {$_ eq $section} @{$tree->{_mandatory}} ) {
$opt="\n# optional section\n" if $complete;
}
my $prefix = '';
$prefix = "# " unless $tree->{_mandatory} and
grep {$_ eq $section} @{$tree->{_mandatory}};
my $secex ="";
if ($section =~ m|^/.+/$| && $tree->{$section}{_example}) {
$secex = " # ( ex. $tree->{$section}{_example} )"
if $complete;
}
if($complete) {
push @{$doc}, $prefix.
(($level > 0) ? ("+" x $level)."$section" : "*** $section ***").
$secex;
} else {
my $minsection=$section =~ m|^/| ? "" : $section;
push @{$doc},(($level > 0) ? ("+" x $level)."$minsection" : "*** $minsection ***");
}
_gentmpl ($tree->{$section},$complete,$level+1,$doc,@start)
unless $tree eq $tree->{$section};
}
}
}
};
sub maketmpl ($@) {
my $self = shift;
my @start = @_;
my $tree = $self->{grammar};
my @tmpl;
_gentmpl $tree,1,0,\@tmpl,@start;
return join("\n", @tmpl)."\n";
}
sub makemintmpl ($@) {
my $self = shift;
my @start = @_;
my $tree = $self->{grammar};
my @tmpl;
_gentmpl $tree,0,0,\@tmpl,@start;
return join("\n", @tmpl)."\n";
}
1;
|
