]> git.proxmox.com Git - pve-docs.git/blobdiff - scan-adoc-refs
asciidoc-pve.in: implement new command print-links-json
[pve-docs.git] / scan-adoc-refs
index a4e46d1885a111245b00856e8260d96ff46b9b84..216b244b74f5a6a99da73723e9cb1a946ecc0716 100755 (executable)
@@ -14,12 +14,6 @@ my $environments = {
     pvelogo => 0, # ignore
 };
 
-my $resolve_skip_files = {
-    default => {},
-    wiki => { 'pve-admin-guide.adoc' => 1 },
-    manvolnum => {},
-};
-
 my $fileinfo = {};
 
 my $start_env = [];
@@ -40,8 +34,9 @@ sub push_environment {
 
     die "undefined environment '$env'\n" if !defined($environments->{$env});
 
+    # FIXME: this seems wrong  (nested env?)?
     return if !$environments->{$env}; # do not track
-    
+
     if ($not) {
        my $new_env = [];
        foreach my $e (@{$env_stack->[-1]}) {
@@ -54,7 +49,7 @@ sub push_environment {
     } else {
        push @$env_stack, [$env];
     }
-    
+
     push @$env_name_stack, $env;
 }
 
@@ -62,12 +57,12 @@ sub pop_environment {
     my ($env) = @_;
 
     die "undefined environment '$env'\n" if !defined($environments->{$env});
-   
+
     return if !$environments->{$env}; # do not track
 
     pop @$env_stack;
     my $res = pop @$env_name_stack;
-    
+
     die "environment missmatch ($res != $env)\n" if $res ne $env;
 }
 
@@ -82,13 +77,48 @@ sub register_include {
 }
 
 sub register_blockid {
-    my ($filename, $blockid, $env_list) = @_;
+    my ($filename, $blockid, $reftext, $env_list) = @_;
 
     foreach my $e (@$env_list) {
        my $fn = $fileinfo->{blockid}->{$e}->{$blockid};
-       die "blockid '$blockid' already defined in $fn" 
+       die "blockid '$blockid' already defined in $fn"
            if defined($fn);
        $fileinfo->{blockid}->{$e}->{$blockid} = $filename;
+       $fileinfo->{reftext}->{$e}->{$blockid} = $reftext
+           if defined($reftext);
+    }
+}
+
+sub register_title {
+    my ($filename, $env, $doctype, $title, $blockid) = @_;
+
+    # fixme: what about other macros?
+    $title =~ s/\{pve\}/Proxmox VE/g;
+    $title =~ s!http://\S+\[(.*?)\]!$1!g;
+
+    # register document title (onyl once)
+    if (!defined($fileinfo->{titles}->{$env}->{$filename})) {
+
+       $fileinfo->{titles}->{$env}->{$filename} = $title;
+
+       if (defined($doctype)) {
+           $fileinfo->{doctype}->{$env}->{$filename} = $doctype;
+       } else {
+           die "unable to change title (no doctype)"
+               if !defined($fileinfo->{doctype}->{$env}->{$filename});
+       }
+
+       if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) {
+           if ($title =~ m/.*\(([1-8])\)\s*$/) {
+               $fileinfo->{mansection}->{$env}->{$filename} = $1;
+           }
+       }
+    }
+
+    if ($blockid) {
+       die "internal error"
+           if !defined($fileinfo->{blockid}->{$env}->{$blockid});
+       $fileinfo->{reftitle}->{$env}->{$blockid} = $title;
     }
 }
 
@@ -96,17 +126,18 @@ sub scan_adoc_file {
     my ($filename) = @_;
 
     reset_environment_stack();
-    
+
     # print "SCAN $filename\n";
 
     my $fh = IO::File->new("$filename", "r") or
        die "unable to open file '$filename' - $!\n";
 
     my $env_last_line = {};
-    
+    my $env_last_blockid = {};
+
     while (defined (my $line = <$fh>)) {
        if ($line =~ m/^if(n?)def::(\S+)\[(.*)\]\s*$/) {
-           my ($not, $env, $text) = ($1, $2);
+           my ($not, $env, $text) = ($1, $2, $3);
            die "unsuported ifdef usage - implement me" if $text;
            push_environment($env, $not);
            next;
@@ -122,28 +153,73 @@ sub scan_adoc_file {
 
        # try to detect titles
        foreach my $e (@{$env_stack->[-1]}) {
-           my $title = $fileinfo->{titles}->{$e}->{$filename};
-           next if defined($title);
-
-           if (($line =~ m/^=====+/) || ($line =~ m/^-----+/)) {
-               $fileinfo->{titles}->{$e}->{$filename} = $env_last_line->{$e};
+           if ($line =~ m/^=====+$/) {
+               register_title($filename, $e, 0, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^-----+$/) {
+               register_title($filename, $e, 1, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^~~~~~+$/) {
+               register_title($filename, $e, 2, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^\^\^\^\^\^+$/) {
+               register_title($filename, $e, 3, $env_last_line->{$e},
+                              $env_last_blockid->{$e});
+           } elsif ($line =~ m/^= +(\S.*?)( +=)?$/) {
+               register_title($filename, $e, 0, $1, $env_last_blockid->{$e});
+           } elsif ($line =~ m/^== +(\S.*?)( +==)?$/) {
+               register_title($filename, $e, 1, $1, $env_last_blockid->{$e});
+           } elsif ($line =~ m/^=== +(\S.*?)( +===)?$/) {
+               register_title($filename, $e, 2, $1, $env_last_blockid->{$e});
+           } elsif ($line =~ m/^==== +(\S.*?)( +====)?$/) {
+               register_title($filename, $e, 3, $1, $env_last_blockid->{$e});
            }
+
            $env_last_line->{$e} = $line;
            chomp $env_last_line->{$e};
        }
-       
-       # fixme: also scan <<>>
-       
-       while ($line =~ m/xref:([^\s\[\]]+)\[([^\]]*)\]/g) {
-           # print "$filename xref:$1 [$2]\n";
+
+       if ($line =~ m/^:(\S+?):\s*(.*\S)?\s*$/) {
+           my ($key, $value) = ($1, $2);
+           if ($key eq 'pve-toplevel') {
+
+               foreach my $e (@{$env_stack->[-1]}) {
+                   my $title = $fileinfo->{titles}->{$e}->{$filename};
+                   die "not title for toplevel file '$filename' (env=$e)\n"
+                       if !defined($title);
+                   $fileinfo->{toplevel}->{$e}->{$filename} = 1;
+               }
+           } elsif ($key eq 'title') {
+               foreach my $e (@{$env_stack->[-1]}) {
+                   register_title($filename, $e, undef, $value);
+               }
+           }
        }
 
        if ($line =~ m/^\[\[(.*)\]\]\s*$/) {
            my $blockid = $1;
            die "implement me" if $blockid =~m/,/;
-           register_blockid($filename, $blockid, $env_stack->[-1]);
+           my $reftext = '';
+           register_blockid($filename, $blockid, $reftext, $env_stack->[-1]);
+           foreach my $e (@{$env_stack->[-1]}) {
+               $env_last_blockid->{$e} = $blockid;
+           }
+       }
+
+       if ($line =~ m/^\s*$/) {
+           foreach my $e (@{$env_stack->[-1]}) {
+               delete $env_last_blockid->{$e};
+           }
+       }
+
+       # fixme: "anchor:"
+       # bibliography anchors
+       if ($line =~ m/\[\[\[([^\]]*)\]\]\]/) {
+           my $blockid = $1;
+           die "implement me" if $blockid =~m/,/;
+           register_blockid($filename, $blockid, "&#91;$blockid&#93;", $env_stack->[-1]);
        }
-    } 
+    }
 }
 
 my $scanned_files = {};
@@ -165,7 +241,7 @@ sub resolve_link_target {
     while ($repeat) {
        $repeat = 0;
        foreach my $fn (keys %$include_hash) {
-           next if $resolve_skip_files->{$env}->{$fn};
+           next if $fn eq 'pve-admin-guide.adoc';
            if ($include_hash->{$fn}->{$filename}) {
                $filename = $fn;
                $repeat = 1;
@@ -173,7 +249,7 @@ sub resolve_link_target {
            }
        }
     }
-    
+
     return $filename;
 }
 
@@ -185,9 +261,12 @@ foreach my $e (@$start_env) {
        if ($e eq 'wiki') {
            my $title = $fileinfo->{titles}->{$e}->{$fn};
            $title =~ s/\s/_/g;
-           $title =~ s/\{pve\}/Proxmox VE/g;
            die "found not title for '$fn' in env '$e'" if !$title;
            $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid";
+       } elsif ($e eq 'default') {
+           my $realfn = "chapter-$fn";
+           $realfn =~ s/\.adoc/.html/;
+           $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid";
        } else {
            $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn;
        }
@@ -195,5 +274,4 @@ foreach my $e (@$start_env) {
 }
 
 
-print to_json($fileinfo, { pretty => 1 } );
-
+print to_json($fileinfo, { pretty => 1,  canonical => 1 } );