gtkdoc-fixxref.in

   1 #!@PERL@ -w
   2 # -*- cperl -*-
   3 #
   4 # gtk-doc - GTK DocBook documentation generator.
   5 # Copyright (C) 1998  Damon Chaplin
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20 #
  21
  22 #############################################################################
  23 # Script      : gtkdoc-fixxref
  24 # Description : This fixes cross-references in the HTML documentation.
  25 #############################################################################
  26
  27 use strict;
  28 use bytes;
  29 use Getopt::Long;
  30
  31 push @INC, '@PACKAGE_DATA_DIR@';
  32 require "gtkdoc-common.pl";
  33
  34 # Options
  35
  36 # name of documentation module
  37 my $MODULE;
  38 my $MODULE_DIR;
  39 my $HTML_DIR = "";
  40 my @EXTRA_DIRS;
  41 my $PRINT_VERSION;
  42 my $PRINT_HELP;
  43
  44 my %optctl = ('module' => \$MODULE,
  45               'module-dir' => \$MODULE_DIR,
  46               'html-dir' => \$HTML_DIR,
  47               'extra-dir' => \@EXTRA_DIRS,
  48               'version' => \$PRINT_VERSION,
  49               'help' => \$PRINT_HELP);
  50 GetOptions(\%optctl, "module=s", "module-dir=s", "html-dir:s", "extra-dir=s@",
  51         "version", "help");
  52
  53 if ($PRINT_VERSION) {
  54     print "@VERSION@\n";
  55     exit 0;
  56 }
  57
  58 if ($PRINT_HELP) {
  59         print <<EOF;
  60 gtkdoc-fixxref version @VERSION@ - fix cross references in html files
  61
  62 --module=MODULE_NAME    Name of the doc module being parsed
  63 --module-dir=MODULE_DIR The directory which contains the generated HTML
  64 --html-dir=HTML_DIR     The directory where gtk-doc generated documentation is
  65                         installed
  66 --extra-dir=EXTRA_DIR   Directories to recursively scan for indices (index.sgml)
  67                         in addition to HTML_DIR
  68                         May be used more than once for multiple directories
  69 --version               Print the version of this program
  70 --help                  Print this help
  71 EOF
  72     exit 0;
  73 }
  74
  75 # This contains all the entities and their relative URLs.
  76 my %Links;
  77 # This hold the path entries we already scanned
  78 my @VisitedPaths;
  79
  80 # failing link targets we don't warn about even once
  81 my %NoLinks = (
  82     'char'  => 1,
  83     'double'  => 1,
  84     'float'  => 1,
  85     'int'  => 1,
  86     'long'  => 1,
  87     'main'  => 1,
  88     'signed'  => 1,
  89     'unsigned'  => 1,
  90     'va-list' => 1,
  91     'void'  => 1,
  92     'GBoxed' => 1,
  93     'GEnum' => 1,
  94     'GFlags' => 1,
  95     'GInterface' => 1
  96     );
  97
  98 my $path_prefix="";
  99 if ($HTML_DIR =~ m%(.*?)/share/gtk-doc/html%) {
 100     $path_prefix=$1;
 101     #print "Path prefix: $path_prefix\n";
 102 }
 103
 104 if (!defined $MODULE_DIR) {
 105   $MODULE_DIR="$HTML_DIR/$MODULE";
 106 }
 107
 108 my $dir;
 109
 110 # We scan the directory containing GLib and any directories in GNOME2_PATH
 111 # first, but these will be overriden by any later scans.
 112 $dir = `pkg-config --variable=prefix glib-2.0`;
 113 $dir =~ s/\s+$//;
 114 $dir = $dir . "/share/gtk-doc/html";
 115 if (-d $dir && $dir ne $HTML_DIR) {
 116     #print "Scanning GLib directory: $dir\n";
 117     if ($dir !~ m%^\Q$path_prefix\E/%) {
 118         &ScanIndices ($dir, 1);
 119     } else {
 120         &ScanIndices ($dir, 0);
 121     }
 122     push (@VisitedPaths, $dir);
 123 }
 124
 125 if (defined ($ENV{"GNOME2_PATH"})) {
 126     foreach $dir (split (/:/, $ENV{"GNOME2_PATH"})) {
 127         $dir = $dir . "/share/gtk-doc/html";
 128         if (-d $dir && $dir ne $HTML_DIR) {
 129             #print "Scanning GNOME2_PATH directory: $dir\n";
 130             if ($dir !~ m%^\Q$path_prefix\E/%) {
 131                 &ScanIndices ($dir, 1);
 132             } else {
 133                 &ScanIndices ($dir, 0);
 134             }
 135             push (@VisitedPaths, $dir);
 136         }
 137         # ubuntu started to compress this as index.sgml.gz :/
 138         # https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138
 139     }
 140 }
 141
 142 #print "Scanning HTML_DIR directory: $HTML_DIR\n";
 143 &ScanIndices ($HTML_DIR, 0);
 144 push (@VisitedPaths, $HTML_DIR);
 145 #print "Scanning HTML_DIR directory: $MODULE_DIR\n";
 146 &ScanIndices ($MODULE_DIR, 0);
 147 push (@VisitedPaths, $MODULE_DIR);
 148
 149 # check all extra dirs, but skip already scanned dirs or subdirs of those
 150 foreach my $dir (@EXTRA_DIRS) {
 151     my $vdir;
 152     my $skip = 0;
 153
 154     foreach $vdir (@VisitedPaths) {
 155         if ($dir eq $vdir || $dir =~ m%^\Q$vdir\E/%) {
 156             #print "Skipping EXTRA_DIR directory: $dir\n";
 157             $skip=1;
 158         }
 159     }
 160     next if $skip;
 161     #print "Scanning EXTRA_DIR directory: $dir\n";
 162     push (@VisitedPaths, $dir);
 163
 164     # If the --extra-dir option is not relative and is not sharing the same
 165     # prefix as the target directory of the docs, we need to use absolute
 166     # directories for the links
 167     if ($dir !~m/^\.\./ &&  $dir !~ m%\Q$path_prefix\E/%) {
 168         &ScanIndices ($dir, 1);
 169     } else {
 170         &ScanIndices ($dir, 0);
 171     }
 172 }
 173
 174 if (defined($MODULE)) {
 175     open (INPUT, "$MODULE-sections.txt")
 176             || die "Can't open $MODULE-sections.txt: $!";
 177     my $subsection = "";
 178     while (<INPUT>) {
 179         if (m/^#/) {
 180             next;
 181
 182         } elsif (m/^<SECTION>/) {
 183             $subsection = "";
 184         } elsif (m/^<SUBSECTION\s*(.*)>/i) {
 185             $subsection = $1;
 186         } elsif (m/^<SUBSECTION>/) {
 187             next;
 188         } elsif (m/^<TITLE>(.*)<\/TITLE>/) {
 189             next;
 190         } elsif (m/^<FILE>(.*)<\/FILE>/) {
 191             next;
 192         } elsif (m/^<INCLUDE>(.*)<\/INCLUDE>/) {
 193             next;
 194         } elsif (m/^<\/SECTION>/) {
 195             next;
 196         } elsif (m/^(\S+)/) {
 197             my $symbol=CreateValidSGMLID($1);
 198
 199             if ($subsection eq "Standard" || $subsection eq "Private") {
 200                 $NoLinks{$symbol} = 1;
 201             }
 202         }
 203     }
 204     close (INPUT);
 205 }
 206
 207 &FixCrossReferences ($MODULE_DIR);
 208
 209 sub ScanIndices {
 210     my ($scan_dir, $use_absolute_links) = @_;
 211
 212     #print "Scanning source directory: $scan_dir absolute: $use_absolute_links\n";
 213
 214     # This array holds any subdirectories found.
 215     my (@subdirs) = ();
 216
 217     opendir (HTMLDIR, $scan_dir) || return;
 218     my $file;
 219     foreach $file (readdir (HTMLDIR)) {
 220         if ($file eq '.' || $file eq '..') {
 221             next;
 222         } elsif (-d "$scan_dir/$file") {
 223             push (@subdirs, $file);
 224         } elsif ($file eq "index.sgml") {
 225             &ScanIndex ("$scan_dir/$file", $use_absolute_links);
 226         }
 227         # ubuntu started to compress this as index.sgml.gz :/
 228         # https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138
 229     }
 230     closedir (HTMLDIR);
 231
 232     # Now recursively scan the subdirectories.
 233     my $dir;
 234     foreach $dir (@subdirs) {
 235         &ScanIndices ("$scan_dir/$dir", $use_absolute_links);
 236     }
 237 }
 238
 239 sub ScanIndex {
 240     my ($file, $use_absolute_links) = @_;
 241     #print "Scanning index file: $file absolute: $use_absolute_links\n";
 242
 243     # Determine the absolute directory, to be added to links in index.sgml
 244     # if we need to use an absolute link.
 245     # $file will be something like /opt/gnome/share/gtk-doc/html/gtk/index.sgml
 246     # We want the part up to 'html' since the links in index.sgml include
 247     # the rest.
 248     my $dir = "../";
 249     if ($use_absolute_links) {
 250         $file =~ /(.*\/)(.*?)\/index\.sgml/;
 251         $dir = $1;
 252     }
 253
 254     open (INDEXFILE, $file)
 255         || die "Can't open $file: $!";
 256     while (<INDEXFILE>) {
 257         if (m/^<ANCHOR\s+id\s*=\s*"([^"]*)"\s+href\s*=\s*"([^"]*)"\s*>/) {
 258             #print "Found id: $1 href: $2\n";
 259             $Links{$1} = "$dir$2";
 260         }
 261     }
 262     close (INDEXFILE);
 263 }
 264
 265
 266 sub FixCrossReferences {
 267     my ($scan_dir) = @_;
 268
 269     opendir (HTMLDIR, $scan_dir)
 270         || die "Can't open HTML directory $scan_dir: $!";
 271     my $file;
 272     foreach $file (readdir (HTMLDIR)) {
 273         if ($file eq '.' || $file eq '..') {
 274             next;
 275         } elsif ($file =~ m/.html?$/) {
 276             &FixHTMLFile ("$scan_dir/$file");
 277         }
 278     }
 279     closedir (HTMLDIR);
 280 }
 281
 282
 283 sub FixHTMLFile {
 284     my ($file) = @_;
 285     #print "Fixing file: $file\n";
 286
 287     open (HTMLFILE, $file)
 288         || die "Can't open $file: $!";
 289     undef $/;
 290     my $entire_file = <HTMLFILE>;
 291     close (HTMLFILE);
 292
 293     if ("@HIGHLIGHT@" ne "") {
 294         if ("@HIGHLIGHT@" =~ m%/vim$%) {
 295             $entire_file =~ s%<div class=\"(example-contents|informalexample)\"><pre class=\"programlisting\">(.*?)</pre></div>%&HighlightSourceVim($1,$2);%gse;
 296         }
 297         else {
 298             $entire_file =~ s%<div class=\"(example-contents|informalexample)\"><pre class=\"programlisting\">(.*?)</pre></div>%&HighlightSource($1,$2);%gse;
 299         }
 300         # this just broke existing GTKDOCLINK tags
 301         # &lt;GTKDOCLINK HREF=&quot;GST-PAD-SINK:CAPS&quot;&gt;GST_PAD_SINK&lt;/GTKDOCLINK&gt;
 302         $entire_file =~ s%\&lt;GTKDOCLINK\s+HREF=\&quot;(.*?)\&quot;\&gt;(.*?)\&lt;/GTKDOCLINK\&gt;%\<GTKDOCLINK\ HREF=\"$1\"\>$2\</GTKDOCLINK\>%gs;
 303
 304         # from the highlighter we get all the functions marked up
 305         # now we could turn them into GTKDOCLINK items
 306         $entire_file =~ s%(<span class=\"function\">)(.*?)(</span>)%&MakeGtkDocLink($1,$2,$3);%gse;
 307         # we could also try the first item in stuff marked up as 'normal'
 308         $entire_file =~ s%(<span class=\"normal\">\s*)(.+?)((\s+.+?)?\s*</span>)%&MakeGtkDocLink($1,$2,$3);%gse;
 309     }
 310
 311     my @lines = split(/\n/, $entire_file);
 312     for (my $i=0; $i<$#lines; $i++) {
 313         $lines[$i] =~ s%<GTKDOCLINK\s+HREF="([^"]*)"\s*>(.*?)</GTKDOCLINK\s*>% &MakeXRef($file,$i+1,$1,$2); %ge;
 314         #if ($lines[$i] =~ m/GTKDOCLINK/) {
 315         #    print "make xref failed for line: ",$lines[$i], "\n";
 316         #}
 317     }
 318     $entire_file = join("\n",@lines);
 319
 320     open (NEWFILE, ">$file.new")
 321         || die "Can't open $file: $!";
 322     print NEWFILE $entire_file;
 323     close (NEWFILE);
 324
 325     unlink ($file)
 326         || die "Can't delete $file: $!";
 327     rename ("$file.new", $file)
 328         || die "Can't rename $file.new: $!";
 329 }
 330
 331 sub MakeXRef {
 332     my ($file, $line, $id, $text) = @_;
 333
 334     my $href = $Links{$id};
 335
 336     # this is a workaround for some inconsitency we have with CreateValidSGMLID
 337     if (!$href && $id =~ m/:/) {
 338         my $tid = $id;
 339         $tid =~ s/:/--/g;
 340         $href = $Links{$tid};
 341     }
 342     # poor mans plural support
 343     if (!$href && $id =~ m/s$/) {
 344         my $tid = $id;
 345         $tid =~ s/s$//g;
 346         $href = $Links{$tid};
 347     }
 348
 349     if ($href) {
 350         # if it is a link to same module, remove path to make it work
 351         # uninstalled
 352         if (defined($MODULE) && $href =~ m%^\.\./$MODULE/(.*)$%) {
 353             $href=$1;
 354         }
 355         #print "  Fixing link: $id, $href, $text\n";
 356         return "<a href=\"$href\">$text</a>";
 357     } else {
 358         my $warn = 1;
 359         #print "  no link for: $id, $text\n";
 360
 361         # don't warn multiple times and also skip blacklisted (ctypes)
 362         $warn = 0 if exists $NoLinks{$id};
 363         # if it's a function, don't warn if it does not contain a "_"
 364         # (transformed to "-")
 365         # - gnome coding style would use '_'
 366         # - will avoid wrong warnings for ansi c functions
 367         $warn = 0 if ($text =~ m/ class=\"function\"/ && $id !~ m/-/);
 368         # if it's a 'return value', don't warn (implicitly created link)
 369         $warn = 0 if ($text =~ m/ class=\"returnvalue\"/);
 370         # if it's a 'type', don't warn if it starts with lowercase
 371         # - gnome coding style would use CamelCase
 372         $warn = 0 if ($text =~ m/ class=\"type\"/ && ($id =~ m/^[a-z]/));
 373
 374         if ($warn == 1) {
 375           &LogWarning ($file, $line, "no link for: '$id' -> ($text).");
 376           $NoLinks{$id} = 1;
 377         }
 378         return $text;
 379     }
 380 }
 381
 382
 383 sub MakeGtkDocLink {
 384     my ($pre,$symbol,$post) = @_;
 385
 386     my $id=CreateValidSGMLID($symbol);
 387
 388     # these are implicitely created links in highlighed sources
 389     # we don't want warnings for those if the links cannot be resolved.
 390     $NoLinks{$id} = 1;
 391
 392     #return "<span class=\"$type\"><GTKDOCLINK HREF=\"$id\">$symbol</GTKDOCLINK></span>";
 393     return "$pre<GTKDOCLINK HREF=\"$id\">$symbol</GTKDOCLINK>$post";
 394 }
 395
 396
 397 sub HighlightSource {
 398     my ($type, $source) = @_;
 399
 400     # chop of leading and trailing empty lines
 401     $source =~ s/^\s*\n+//gs;
 402     $source =~ s/[\s\n]+$//gs;
 403     # cut common indent
 404     $source =~ m/^(\s*)/;
 405     $source =~ s/^$1//gms;
 406     # avoid double entity replacement
 407     $source =~ s/&lt;/</g;
 408     $source =~ s/&gt;/>/g;
 409     $source =~ s/&amp;/&/g;
 410
 411     # write source to a temp file
 412     # FIXME: use .c for now to hint the language to the highlighter
 413     my $temp_source_file="$MODULE_DIR/_temp_src.$$.c";
 414     open (NEWFILE, ">$temp_source_file") || die "Can't open $temp_source_file: $!";
 415     print NEWFILE $source;
 416     close (NEWFILE);
 417
 418     #print" running @HIGHLIGHT@ @HIGHLIGHT_OPTIONS@$temp_source_file \n";
 419
 420     # format source
 421     my $highlighted_source=`@HIGHLIGHT@ @HIGHLIGHT_OPTIONS@$temp_source_file`;
 422     if ("@HIGHLIGHT@" =~ m%/source-highlight$%) {
 423         $highlighted_source =~ s%^<\!-- .*? -->%%gs;
 424         $highlighted_source =~ s%<pre><tt>(.*?)</tt></pre>%$1%gs;
 425     }
 426     elsif ("@HIGHLIGHT@" =~ m%/highlight$%) {
 427         # need to rewrite the stylesheet classes
 428         $highlighted_source =~ s%<span class="gtkdoc com">%<span class="comment">%gs;
 429         $highlighted_source =~ s%<span class="gtkdoc dir">%<span class="preproc">%gs;
 430         $highlighted_source =~ s%<span class="gtkdoc kwd">%<span class="function">%gs;
 431         $highlighted_source =~ s%<span class="gtkdoc kwa">%<span class="keyword">%gs;
 432         $highlighted_source =~ s%<span class="gtkdoc line">%<span class="linenum">%gs;
 433         $highlighted_source =~ s%<span class="gtkdoc num">%<span class="number">%gs;
 434         $highlighted_source =~ s%<span class="gtkdoc str">%<span class="string">%gs;
 435         $highlighted_source =~ s%<span class="gtkdoc sym">%<span class="symbol">%gs;
 436         # maybe also do
 437         # $highlighted_source =~ s%</span>(.+)<span%</span><span class="normal">$1</span><span%gs;
 438     }
 439     # remove temp file
 440     unlink ($temp_source_file)
 441         || die "Can't delete $temp_source_file: $!";
 442
 443     return &HighlightSourcePostprocess($type, $highlighted_source);
 444 }
 445
 446 sub HighlightSourceVim {
 447     my ($type, $source) = @_;
 448
 449     # chop of leading and trailing empty lines
 450     $source =~ s/^[\s\n]+//gs;
 451     $source =~ s/[\s\n]+$//gs;
 452     # avoid double entity replacement
 453     $source =~ s/&lt;/</g;
 454     $source =~ s/&gt;/>/g;
 455     $source =~ s/&amp;/&/g;
 456
 457     # write source to a temp file
 458     my $temp_source_file="$MODULE_DIR/_temp_src.$$.h";
 459     open (NEWFILE, ">$temp_source_file") || die "Can't open $temp_source_file: $!";
 460     print NEWFILE $source;
 461     close (NEWFILE);
 462
 463     # format source
 464     system "echo 'let html_number_lines=0|let html_use_css=1|let use_xhtml=1|syn on|e $temp_source_file|run! syntax/2html.vim|wa!|qa!' | @HIGHLIGHT@ -n -e -u /dev/null -T xterm >/dev/null";
 465
 466     my $highlighted_source;
 467     {
 468         local $/;
 469         open (NEWFILE, "<$temp_source_file.html");
 470         $highlighted_source = <NEWFILE>;
 471         close (NEWFILE);
 472     }
 473     $highlighted_source =~ s#.*<pre>\n##s;
 474     $highlighted_source =~ s#</pre>.*##s;
 475
 476     # need to rewrite the stylesheet classes
 477     # FIXME: Vim has somewhat different syntax groups
 478     $highlighted_source =~ s%<span class="Comment">%<span class="comment">%gs;
 479     $highlighted_source =~ s%<span class="PreProc">%<span class="preproc">%gs;
 480     $highlighted_source =~ s%<span class="Statement">%<span class="keyword">%gs;
 481     $highlighted_source =~ s%<span class="Identifier">%<span class="function">%gs;
 482     $highlighted_source =~ s%<span class="Constant">%<span class="number">%gs;
 483     $highlighted_source =~ s%<span class="Special">%<span class="symbol">%gs;
 484     $highlighted_source =~ s%<span class="Type">%<span class="type">%gs;
 485
 486     # remove temp files
 487     unlink ($temp_source_file)
 488         || die "Can't delete $temp_source_file: $!";
 489     unlink ("$temp_source_file.html")
 490         || die "Can't delete $temp_source_file.html: $!";
 491
 492     return &HighlightSourcePostprocess($type, $highlighted_source);
 493 }
 494
 495 sub HighlightSourcePostprocess {
 496     my ($type, $highlighted_source) = @_;
 497
 498     # chop of leading and trailing empty lines
 499     $highlighted_source =~ s/^[\s\n]+//gs;
 500     $highlighted_source =~ s/[\s\n]+$//gs;
 501
 502     # turn common urls in comments into links
 503     $highlighted_source =~ s%<span class="url">(.*?)</span>%<span class="url"><a href="$1">$1</a></span>%gs;
 504
 505     # we do own line-numbering
 506     my $source_lines="";
 507     my $line_count = () = $highlighted_source =~ /\n/gs;
 508     for (my $i=1; $i < ($line_count+2); $i++) {
 509         $source_lines.="$i\n";
 510     }
 511     $source_lines =~ s/\n\Z//;
 512
 513     return <<END_OF_HTML
 514 <div class="$type">
 515   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 516     <tbody>
 517       <tr>
 518         <td class="listing_lines" align="right"><pre>$source_lines</pre></td>
 519         <td class="listing_code"><pre class="programlisting">$highlighted_source</pre></td>
 520       </tr>
 521     </tbody>
 522   </table>
 523 </div>
 524 END_OF_HTML
 525 }
 526