]>
git.proxmox.com Git - pve-docs.git/blob - scan-adoc-refs
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});
111 if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
112 if ($title =~ m/.*\(([1-8])\)\s*$/) {
113 $fileinfo->{mansection
}->{$env}->{$filename} = $1;
120 if !defined($fileinfo->{blockid
}->{$env}->{$blockid});
121 $fileinfo->{reftitle
}->{$env}->{$blockid} = $title;
128 reset_environment_stack
();
130 # print "SCAN $filename\n";
132 my $fh = IO
::File-
>new("$filename", "r") or
133 die "unable to open file '$filename' - $!\n";
135 my $env_last_line = {};
136 my $env_last_blockid = {};
138 while (defined (my $line = <$fh>)) {
139 if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
140 my ($not, $env, $text) = ($1, $2, $3);
141 die "unsuported ifdef usage - implement me" if $text;
142 push_environment
($env, $not);
144 } elsif ($line =~ m/^endif::(\S+)\[(.*)\]\s*$/) {
145 my ($env, $text) = ($1, $2);
146 die "unsuported ifdef usage - implement me" if $text;
147 pop_environment
($env);
149 } elsif ($line =~ m/^include::(\S+)\[.*\]\s*$/) {
150 register_include
($filename, $1, $env_stack->[-1]);
154 # try to detect titles
155 foreach my $e (@{$env_stack->[-1]}) {
156 if ($line =~ m/^=====+$/) {
157 register_title
($filename, $e, 0, $env_last_line->{$e},
158 $env_last_blockid->{$e});
159 } elsif ($line =~ m/^-----+$/) {
160 register_title
($filename, $e, 1, $env_last_line->{$e},
161 $env_last_blockid->{$e});
162 } elsif ($line =~ m/^~~~~~+$/) {
163 register_title
($filename, $e, 2, $env_last_line->{$e},
164 $env_last_blockid->{$e});
165 } elsif ($line =~ m/^\^\^\^\^\^+$/) {
166 register_title
($filename, $e, 3, $env_last_line->{$e},
167 $env_last_blockid->{$e});
168 } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
169 register_title
($filename, $e, 0, $1, $env_last_blockid->{$e});
170 } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
171 register_title
($filename, $e, 1, $1, $env_last_blockid->{$e});
172 } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) {
173 register_title
($filename, $e, 2, $1, $env_last_blockid->{$e});
174 } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) {
175 register_title
($filename, $e, 3, $1, $env_last_blockid->{$e});
178 $env_last_line->{$e} = $line;
179 chomp $env_last_line->{$e};
182 if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
183 my ($key, $value) = ($1, $2);
184 if ($key eq 'pve-toplevel') {
186 foreach my $e (@{$env_stack->[-1]}) {
187 my $title = $fileinfo->{titles
}->{$e}->{$filename};
188 die "not title for toplevel file '$filename' (env=$e)\n"
190 $fileinfo->{toplevel
}->{$e}->{$filename} = 1;
192 } elsif ($key eq 'title') {
193 foreach my $e (@{$env_stack->[-1]}) {
194 register_title
($filename, $e, undef, $value);
199 if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
201 die "implement me" if $blockid =~m/,/;
203 register_blockid
($filename, $blockid, $reftext, $env_stack->[-1]);
204 foreach my $e (@{$env_stack->[-1]}) {
205 $env_last_blockid->{$e} = $blockid;
209 if ($line =~ m/^\s*$/) {
210 foreach my $e (@{$env_stack->[-1]}) {
211 delete $env_last_blockid->{$e};
216 # bibliography anchors
217 if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
219 die "implement me" if $blockid =~m/,/;
220 register_blockid
($filename, $blockid, "[$blockid]", $env_stack->[-1]);
225 my $scanned_files = {};
226 while (my $filename = shift) {
227 next if $filename !~ m/\.adoc$/; # skip attributes.txt
228 next if $scanned_files->{$filename};
230 scan_adoc_file
($filename);
231 $scanned_files->{$filename} = 1;
234 sub resolve_link_target
{
235 my ($env, $filename) = @_;
237 my $include_hash = $fileinfo->{include
}->{$env};
243 foreach my $fn (keys %$include_hash) {
244 next if $fn eq 'pve-admin-guide.adoc';
245 if ($include_hash->{$fn}->{$filename}) {
256 # now resolve blockids
257 foreach my $e (@$start_env) {
258 my $blockid_hash = $fileinfo->{blockid
}->{$e};
259 foreach my $blockid (keys %$blockid_hash) {
260 my $fn = resolve_link_target
($e, $blockid_hash->{$blockid});
262 my $title = $fileinfo->{titles
}->{$e}->{$fn};
264 die "found not title for '$fn' in env '$e'" if !$title;
265 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
266 } elsif ($e eq 'default') {
268 $realfn =~ s/\.adoc//;
269 if (($realfn eq 'datacenter.cfg') || ($realfn eq 'qm.conf') || ($realfn eq 'pct.conf')) {
272 $realfn = "chapter-$realfn";
275 $fileinfo->{blockid_target
}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
277 $fileinfo->{blockid_target
}->{$e}->{$blockid} = $fn;
283 print to_json
($fileinfo, { pretty
=> 1, canonical
=> 1 } );