]>
git.proxmox.com Git - pve-docs.git/blob - scan-adoc-refs
2f24f331d77a1fe7e690f4a517328da7e6878b92
14 pvelogo
=> 0, # ignore
20 foreach my $e (keys %$environments) {
21 push @$start_env, $e if $environments->{$e};
24 my $env_stack = [$start_env];
25 my $env_name_stack = [];
27 sub reset_environment_stack
{
28 $env_stack = [$start_env];
32 sub push_environment
{
35 die "undefined environment '$env'\n" if !defined($environments->{$env});
37 # FIXME: this seems wrong (nested env?)?
38 return if !$environments->{$env}; # do not track
42 foreach my $e (@{$env_stack->[-1]}) {
47 die "empty environment" if !scalar($new_env);
48 push @$env_stack, $new_env;
50 push @$env_stack, [$env];
53 push @$env_name_stack, $env;
59 die "undefined environment '$env'\n" if !defined($environments->{$env});
61 return if !$environments->{$env}; # do not track
64 my $res = pop @$env_name_stack;
66 die "environment missmatch ($res != $env)\n" if $res ne $env;
69 sub register_include
{
70 my ($filename, $include_filename, $env_list) = @_;
72 return if $include_filename !~ m/\.adoc$/; # skip attributes.txt
74 foreach my $e (@$env_list) {
75 $fileinfo->{include
}->{$e}->{$filename}->{$include_filename} = 1;
79 sub register_blockid
{
80 my ($filename, $blockid, $reftext, $env_list) = @_;
82 foreach my $e (@$env_list) {
83 my $fn = $fileinfo->{blockid
}->{$e}->{$blockid};
84 die "blockid '$blockid' already defined in $fn"
86 $fileinfo->{blockid
}->{$e}->{$blockid} = $filename;
87 $fileinfo->{reftext
}->{$e}->{$blockid} = $reftext
93 my ($filename, $env, $doctype, $title, $blockid) = @_;
95 # fixme: what about other macros?
96 $title =~ s/\{pve\}/Proxmox VE/g;
97 $title =~ s!http://\S+\[(.*?)\]!$1!g;
99 # register document title (onyl once)
100 if (!defined($fileinfo->{titles
}->{$env}->{$filename})) {
102 $fileinfo->{titles
}->{$env}->{$filename} = $title;
104 if (defined($doctype)) {
105 $fileinfo->{doctype
}->{$env}->{$filename} = $doctype;
107 die "unable to change title (no doctype)"
108 if !defined($fileinfo->{doctype
}->{$env}->{$filename});
110 } elsif (!defined($doctype)) {
111 # change title via :title: attribute
112 $fileinfo->{titles
}->{$env}->{$filename} = $title;
115 if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
116 if ($title =~ m/.*\(([1-8])\)\s*$/) {
117 $fileinfo->{mansection
}->{$env}->{$filename} = $1;
123 if !defined($fileinfo->{blockid
}->{$env}->{$blockid});
124 $fileinfo->{reftitle
}->{$env}->{$blockid} = $title;
131 reset_environment_stack
();
133 # print "SCAN $filename\n";
135 my $fh = IO
::File-
>new("$filename", "r") or
136 die "unable to open file '$filename' - $!\n";
138 my $env_last_line = {};
139 my $env_last_blockid = {};
141 while (defined (my $line = <$fh>)) {
142 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
143 my ($not, $env, $text) = ($1, $2, $3);
144 die "unsuported ifdef usage - implement me" if $text;
145 push_environment
($env, $not);
147 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
148 my ($env, $text) = ($1, $2);
149 die "unsuported ifdef usage - implement me" if $text;
150 pop_environment
($env);
152 } elsif ($line =~ m/^include::(\S+)\[.*\]\s*$/) {
153 register_include
($filename, $1, $env_stack->[-1]);
157 # try to detect titles
158 foreach my $e (@{$env_stack->[-1]}) {
159 if ($line =~ m/^=====+$/) {
160 register_title
($filename, $e, 0, $env_last_line->{$e},
161 $env_last_blockid->{$e});
162 } elsif ($line =~ m/^-----+$/) {
163 register_title
($filename, $e, 1, $env_last_line->{$e},
164 $env_last_blockid->{$e});
165 } elsif ($line =~ m/^~~~~~+$/) {
166 register_title
($filename, $e, 2, $env_last_line->{$e},
167 $env_last_blockid->{$e});
168 } elsif ($line =~ m/^\^\^\^\^\^+$/) {
169 register_title
($filename, $e, 3, $env_last_line->{$e},
170 $env_last_blockid->{$e});
171 } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
172 register_title
($filename, $e, 0, $1, $env_last_blockid->{$e});
173 } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
174 register_title
($filename, $e, 1, $1, $env_last_blockid->{$e});
175 } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) {
176 register_title
($filename, $e, 2, $1, $env_last_blockid->{$e});
177 } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) {
178 register_title
($filename, $e, 3, $1, $env_last_blockid->{$e});
181 $env_last_line->{$e} = $line;
182 chomp $env_last_line->{$e};
185 if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
186 my ($key, $value) = ($1, $2);
187 if ($key eq 'pve-toplevel') {
189 foreach my $e (@{$env_stack->[-1]}) {
190 my $title = $fileinfo->{titles
}->{$e}->{$filename};
191 die "not title for toplevel file '$filename' (env=$e)\n"
193 $fileinfo->{toplevel
}->{$e}->{$filename} = 1;
195 } elsif ($key eq 'title') {
196 foreach my $e (@{$env_stack->[-1]}) {
197 register_title
($filename, $e, undef, $value);
202 if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
204 die "implement me" if $blockid =~m/,/;
206 register_blockid
($filename, $blockid, $reftext, $env_stack->[-1]);
207 foreach my $e (@{$env_stack->[-1]}) {
208 $env_last_blockid->{$e} = $blockid;
212 if ($line =~ m/^\s*$/) {
213 foreach my $e (@{$env_stack->[-1]}) {
214 delete $env_last_blockid->{$e};
219 # bibliography anchors
220 if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
222 die "implement me" if $blockid =~m/,/;
223 register_blockid
($filename, $blockid, "[$blockid]", $env_stack->[-1]);
228 my $scanned_files = {};
229 while (my $filename = shift) {
230 next if $filename !~ m/\.adoc$/; # skip attributes.txt
231 next if $scanned_files->{$filename};
233 scan_adoc_file
($filename);
234 $scanned_files->{$filename} = 1;
237 sub resolve_link_target
{
238 my ($env, $filename) = @_;
240 my $include_hash = $fileinfo->{include
}->{$env};
246 foreach my $fn (keys %$include_hash) {
247 if ($include_hash->{$fn}->{$filename}) {
248 next if ($fn eq 'pve-admin-guide.adoc') &&
249 $fileinfo->{outfile
}->{$env}->{$filename};
261 # try to generate output file mapping
262 foreach my $e (@$start_env) {
263 my $toplevel_hash = $fileinfo->{toplevel
}->{$e};
264 foreach my $fn (sort keys %$toplevel_hash) {
265 my $mansection = $fileinfo->{mansection
}->{manvolnum
}->{$fn};
268 $realfn =~ s/\.adoc$//;
269 if (defined($mansection) && ($mansection == 5)) {
270 $realfn .= ".$mansection";
272 $realfn = "$realfn-plain.html";
273 $fileinfo->{outfile
}->{$e}->{$fn} = $realfn;
274 } elsif ($e eq 'manvolnum') {
276 $realfn =~ s/\.adoc$//;
277 die "toplevel file '$fn' is not marked as manual page!" if !$mansection;
278 $realfn .= ".$mansection";
279 $fileinfo->{outfile
}->{$e}->{$fn} = $realfn;
280 } elsif ($e eq 'default') {
282 $realfn =~ s/\.adoc$//;
283 if (defined($mansection) && ($mansection == 5)) {
284 $realfn .= ".$mansection";
285 $realfn = "$realfn.html";
287 if (($fn ne 'pve-admin-guide.adoc') &&
288 $fileinfo->{doctype
}->{$e}->{$fn} == 0) {
289 $realfn = "chapter-$realfn.html";
291 $realfn = "$realfn.html";
294 $fileinfo->{outfile
}->{$e}->{$fn} = $realfn;
299 # now resolve blockids
300 foreach my $e (@$start_env) {
301 my $blockid_hash = $fileinfo->{blockid
}->{$e};
302 foreach my $blockid (keys %$blockid_hash) {
303 my $fn = resolve_link_target
($e, $blockid_hash->{$blockid});
305 my $title = $fileinfo->{titles
}->{$e}->{$fn};
307 die "found not title for '$fn' in env '$e'" if !$title;
308 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
310 # we do not produce wiki pages for all content
311 #my $realfn = $fileinfo->{outfile}->{$e}->{$fn};
312 #warn "no output file mapping for '$fn' ($e)\n" if !$realfn;
314 } elsif ($e eq 'default') {
315 my $realfn = $fileinfo->{outfile
}->{$e}->{$fn} ||
316 die "no output file mapping for '$fn'\n";
317 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
318 } elsif ($e eq 'manvolnum') {
319 # we do not produce manpages for all content
320 # my $realfn = $fileinfo->{outfile}->{$e}->{$fn} ||
321 # warn "no output file mapping for '$fn'\n";
322 $fileinfo->{blockid_target
}->{$e}->{$blockid} = $fn;
328 print to_json
($fileinfo, { pretty
=> 1, canonical
=> 1 } );