12 my $release = '@RELEASE@';
15 die "no command specified\n";
18 while (<main
::DATA
>) { $data_str .= $_; }
20 my $fileinfo = decode_json
($data_str);
22 my $tmpprefix = ".asciidoc-pve-tmp_";
24 my $adoc_source_dir = "/usr/share/pve-doc-generator";
26 # inside pve-docs source dir?
27 if (-f
"attributes.txt" && -f
"pve-admin-guide.adoc") {
28 $adoc_source_dir = "."
31 my $prepared_files = {};
33 my $man_target_html = 0;
37 sub push_environment
{
38 my ($env, $skip) = @_;
40 $skip = 1 if $env_skip;
41 $skip = 0 if !defined($skip);
43 push @$env_stack, [$env, $skip];
51 my $last_stack_entry = pop @$env_stack;
52 die "unable to pop env '$env'" if !defined($last_stack_entry);
54 my ($last_env, $skip) = @$last_stack_entry;
55 die "environment missmatch (${last_env} != $env)\n" if $last_env ne $env;
57 if (!scalar(@$env_stack)) {
60 my (undef, $skip) = @{$env_stack->[-1]};
70 sub replace_wiki_xref
{
71 my ($blockid, $text) = @_;
73 my $link = $fileinfo->{blockid_target
}->{wiki
}->{$blockid};
74 my $reftext = $fileinfo->{reftext
}->{wiki
}->{$blockid};
76 die "unable to resolve wiki link (xref:$blockid)\n"
79 $text = $reftext if !length($text);
81 die "xref: no text for wiki link '$blockid'\n" if !$text;
83 return "$link\[$text\]";
86 sub replace_default_xref
{
87 my ($blockid, $text) = @_;
89 my $link = $fileinfo->{blockid_target
}->{default}->{$blockid};
90 my $reftext = $fileinfo->{reftext
}->{default}->{$blockid};
92 die "unable to resolve chapter link (xref:$blockid)\n"
95 $text = $reftext if !length($text);
97 die "xref: no text for chapter link '$blockid'\n" if !$text;
99 return "$link\[$text\]";
102 sub replace_man_xref
{
103 my ($blockid, $text) = @_;
105 my $link = $fileinfo->{blockid_target
}->{manvolnum
}->{$blockid};
106 my $reftext = $fileinfo->{reftext
}->{manvolnum
}->{$blockid};
108 die "unable to resolve man page link (xref:$blockid)\n"
111 $text = $reftext if !length($text);
113 die "xref: no text for man page link '$blockid'\n" if !$text;
115 my $section = $fileinfo->{mansection
}->{manvolnum
}->{$link};
116 die "link target is not a manual page" if !defined($section);
119 if (0 && $man_target_html) {
121 $target =~ s/\.adoc//;
122 $target .= ".$section";
123 return "link:${target}.html#${blockid}\[$text\]";
126 $command =~ s/\.adoc//;
127 return "\*${text}\* (man \*${command}\*($section))";
132 my ($env, $blockid, $text) = @_;
134 if ($env eq 'wiki') {
135 return replace_wiki_xref
($blockid, $text);
136 } elsif ($env eq 'manvolnum') {
137 return replace_man_xref
($blockid, $text);
138 } elsif ($env eq 'default') {
139 return replace_default_xref
($blockid, $text);
141 die "internal error";
145 sub prepare_adoc_file
{
146 my ($target_env, $filename, $attributes) = @_;
148 return $prepared_files->{$filename} if defined($prepared_files->{$filename});
150 print "PREPARE $filename\n";
152 my $dirname = dirname
($filename);
153 my $basename = basename
($filename);
155 my $outfilename = "$dirname/${tmpprefix}$basename";
157 $prepared_files->{$filename} = $outfilename;
159 my $fh = IO
::File-
>new("$filename", "r") or
160 die "unable to open file '$filename' - $!\n";
162 my $outfh = IO
::File-
>new("$outfilename", "w") or
163 die "unable to open temporary file '$outfilename'\n";
165 while (defined (my $line = <$fh>)) {
167 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
168 my ($not, $env, $text) = ($1, $2, $3);
169 die "unsuported ifdef usage - implement me" if $text;
171 my $skip = !exists($attributes->{$env}) ?
1 : 0;
172 $skip = ($skip ?
0 : 1 ) if $not;
174 push_environment
($env, $skip);
176 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
177 my ($env, $text) = ($1, $2);
178 die "unsuported ifdef usage - implement me" if $text;
179 pop_environment
($env);
185 if ($line =~ m/^include::(\S+)(\[.*\]\s*)$/) {
186 my ($fn, $rest) = ($1, $2);
187 print "INCLUDE: $fn\n";
188 my $new_fn = prepare_adoc_file
($target_env, $fn, $attributes);
190 print $outfh "include::${new_fn}$rest\n";
195 $line =~ s/xref:([^\s\[\]]+)\[([^\]]*)\]/replace_xref(${target_env},$1,$2)/ge;
197 $line =~ s/<<([^\s,\[\]]+)(?:,(.*?))?>>/replace_xref(${target_env},$1,$2)/ge;
199 print $outfh $line . "\n";
205 sub compile_asciidoc
{
211 GetOptions
("outfile=s" => \
$outfile,
212 "verbose" => \
$verbose) or
213 die("Error in command line arguments\n");
215 my $infile = shift(@ARGV) or
216 die "no input file specified\n";
218 scalar(@ARGV) == 0 or
219 die "too many arguments...\n";
221 defined($fileinfo->{titles
}->{$env}) ||
222 die "unknown environment '$env'";
224 my $title = $fileinfo->{titles
}->{$env}->{$infile} or
225 die "unable to get title for '$infile'$env\n";
227 print "compile: $title\n";
231 my $doctype = $fileinfo->{doctype
}->{$env}->{$infile};
233 die "unable to get document type for '$infile'\n"
234 if !defined($doctype);
236 $leveloffset = - $doctype;
243 leveloffset
=> $leveloffset,
246 my $mansection = $fileinfo->{mansection
}->{$env}->{$infile};
248 if ($env eq 'wiki') {
249 } elsif ($env eq 'manvolnum') {
250 die "undefined man section" if !defined($mansection);
251 $attributes->{manvolnum
} = $mansection;
252 } elsif ($env eq 'default') {
253 die "$infile: wrong doctype\n" if $doctype != 0;
254 $attributes->{toc
} = undef;
257 if (!defined($outfile)) {
259 $outfile =~ s/\.adoc$//;
260 if ($env eq 'manvolnum') {
261 if ($man_target_html) {
262 $outfile .= ".$mansection.html";
264 $outfile .= ".$mansection";
271 if (($env eq 'manvolnum') && !$man_target_html) {
273 # asciidoc /etc/asciidoc/docbook-xsl/manpage.xsl skip REFERENCES
274 # section like footnotes, so we cannot use a2x.
275 # We use xmlto instead.
277 my $cmd = ['asciidoc', '-dmanpage', '-bdocbook', '-a', 'docinfo1'];
279 foreach my $key (keys %$attributes) {
280 my $value = $attributes->{$key};
281 if (defined($value)) {
282 push @$cmd, '-a', "$key=$value";
284 push @$cmd, '-a', $key;
288 push @$cmd, '--verbose' if $verbose;
290 my $tmpxmlfile = "${outfile}.xml.tmp";
292 push @$cmd, '--out-file', $tmpxmlfile;
294 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
296 push @$cmd, $new_infile;
298 print "RUN " . join(' ', @$cmd) . "\n";
300 system(@$cmd) == 0 or
303 $cmd = ['xmlto', 'man', $tmpxmlfile];
305 push @$cmd, '-v' if $verbose;
307 print "RUN " . join(' ', @$cmd) . "\n";
309 system(@$cmd) == 0 or
314 $attributes->{icons
} = undef;
315 $attributes->{'data-uri'} = undef;
316 $attributes->{revnumber
} = $release;
318 my $cmd = ['asciidoc'];
320 push @$cmd, '-s' if $env eq 'wiki';
322 foreach my $key (keys %$attributes) {
323 my $value = $attributes->{$key};
324 if (defined($value)) {
325 push @$cmd, '-a', "$key=$value";
327 push @$cmd, '-a', $key;
331 push @$cmd, '--verbose' if $verbose;
333 push @$cmd, '--out-file', $outfile;
335 my $new_infile = prepare_adoc_file
($env, $infile, $attributes);
337 push @$cmd, $new_infile;
339 print "RUN " . join(' ', @$cmd) . "\n";
341 system(@$cmd) == 0 or
346 if ($clicmd eq 'compile-wiki') {
348 eval { compile_asciidoc
('wiki'); };
355 } elsif ($clicmd eq 'compile-chapter') {
357 eval { compile_asciidoc
('default'); };
364 } elsif ($clicmd eq 'compile-man-html') {
366 $man_target_html = 1;
368 eval { compile_asciidoc
('manvolnum'); };
375 } elsif ($clicmd eq 'compile-man') {
377 eval { compile_asciidoc
('manvolnum'); };
386 die "unknown command '$clicmd'\n";