4 # gtk-doc - GTK DocBook documentation generator.
5 # Copyright (C) 1998 Damon Chaplin
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.
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.
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.
22 #############################################################################
23 # Script : gtkdoc-fixxref
24 # Description : This fixes cross-references in the HTML documentation.
25 #############################################################################
31 push @INC, '@PACKAGE_DATA_DIR@';
32 require "gtkdoc-common.pl";
36 # name of documentation module
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@",
60 gtkdoc-fixxref version @VERSION@ - fix cross references in html files
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
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
75 # This contains all the entities and their relative URLs.
77 # This hold the path entries we already scanned
80 # failing link targets we don't warn about even once
99 if ($HTML_DIR =~ m%(.*?)/share/gtk-doc/html%) {
101 @TRACE@("Path prefix: $path_prefix");
104 if (!defined $MODULE_DIR) {
105 $MODULE_DIR="$HTML_DIR/$MODULE";
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`;
114 $dir = $dir . "/share/gtk-doc/html";
115 if (-d $dir && $dir ne $HTML_DIR) {
116 @TRACE@("Scanning GLib directory: $dir");
117 if ($dir !~ m%^\Q$path_prefix\E/%) {
118 &ScanIndices ($dir, 1);
120 &ScanIndices ($dir, 0);
122 push (@VisitedPaths, $dir);
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 @TRACE@("Scanning GNOME2_PATH directory: $dir");
130 if ($dir !~ m%^\Q$path_prefix\E/%) {
131 &ScanIndices ($dir, 1);
133 &ScanIndices ($dir, 0);
135 push (@VisitedPaths, $dir);
137 # ubuntu started to compress this as index.sgml.gz :/
138 # https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138
142 @TRACE@("Scanning HTML_DIR directory: $HTML_DIR");
143 &ScanIndices ($HTML_DIR, 0);
144 push (@VisitedPaths, $HTML_DIR);
145 @TRACE@("Scanning HTML_DIR directory: $MODULE_DIR");
146 &ScanIndices ($MODULE_DIR, 0);
147 push (@VisitedPaths, $MODULE_DIR);
149 # check all extra dirs, but skip already scanned dirs or subdirs of those
150 foreach my $dir (@EXTRA_DIRS) {
154 foreach $vdir (@VisitedPaths) {
155 if ($dir eq $vdir || $dir =~ m%^\Q$vdir\E/%) {
156 @TRACE@("Skipping EXTRA_DIR directory: $dir");
161 @TRACE@("Scanning EXTRA_DIR directory: $dir");
162 push (@VisitedPaths, $dir);
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);
170 &ScanIndices ($dir, 0);
174 if (defined($MODULE)) {
175 open (INPUT, "$MODULE-sections.txt")
176 || die "Can't open $MODULE-sections.txt: $!";
182 } elsif (m/^<SECTION>/) {
184 } elsif (m/^<SUBSECTION\s*(.*)>/i) {
186 } elsif (m/^<SUBSECTION>/) {
188 } elsif (m/^<TITLE>(.*)<\/TITLE>/) {
190 } elsif (m/^<FILE>(.*)<\/FILE>/) {
192 } elsif (m/^<INCLUDE>(.*)<\/INCLUDE>/) {
194 } elsif (m/^<\/SECTION>/) {
196 } elsif (m/^(\S+)/) {
197 my $symbol=CreateValidSGMLID($1);
199 if ($subsection eq "Standard" || $subsection eq "Private") {
200 $NoLinks{$symbol} = 1;
207 &FixCrossReferences ($MODULE_DIR);
210 my ($scan_dir, $use_absolute_links) = @_;
212 @TRACE@("Scanning source directory: $scan_dir absolute: $use_absolute_links");
214 # This array holds any subdirectories found.
217 opendir (HTMLDIR, $scan_dir) || return;
219 foreach $file (readdir (HTMLDIR)) {
220 if ($file eq '.' || $file eq '..') {
222 } elsif (-d "$scan_dir/$file") {
223 push (@subdirs, $file);
224 } elsif ($file eq "index.sgml") {
225 &ScanIndex ("$scan_dir/$file", $use_absolute_links);
227 # ubuntu started to compress this as index.sgml.gz :/
228 # https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138
232 # Now recursively scan the subdirectories.
234 foreach $dir (@subdirs) {
235 &ScanIndices ("$scan_dir/$dir", $use_absolute_links);
240 my ($file, $use_absolute_links) = @_;
242 # Determine the absolute directory, to be added to links in index.sgml
243 # if we need to use an absolute link.
244 # $file will be something like /opt/gnome/share/gtk-doc/html/gtk/index.sgml
245 # We want the part up to 'html' since the links in index.sgml include
248 if ($use_absolute_links) {
249 # For uninstalled index.sgml files we'd need to map the path to where it
250 # will be installed to
251 if ($file !~ /\.\//) {
252 $file =~ /(.*\/)(.*?)\/index\.sgml/;
256 @TRACE@("Scanning index file=$file, absolute=$use_absolute_links, dir=$dir");
258 open (INDEXFILE, $file)
259 || die "Can't open $file: $!";
260 while (<INDEXFILE>) {
261 if (m/^<ANCHOR\s+id\s*=\s*"([^"]*)"\s+href\s*=\s*"([^"]*)"\s*>/) {
262 @TRACE@("Found id: $1 href: $2");
263 $Links{$1} = "$dir$2";
270 sub FixCrossReferences {
273 opendir (HTMLDIR, $scan_dir)
274 || die "Can't open HTML directory $scan_dir: $!";
276 foreach $file (readdir (HTMLDIR)) {
277 if ($file eq '.' || $file eq '..') {
279 } elsif ($file =~ m/.html?$/) {
280 &FixHTMLFile ("$scan_dir/$file");
289 @TRACE@("Fixing file: $file");
291 open (HTMLFILE, $file)
292 || die "Can't open $file: $!";
294 my $entire_file = <HTMLFILE>;
297 if ("@HIGHLIGHT@" ne "") {
298 # FIXME: ideally we'd pass a clue about the example language to the highligher
299 # unfortunately the "language" attribute is not appearing in the html output
300 # we could patch the customization to have <code class="xxx"> inside of <pre>
301 if ("@HIGHLIGHT@" =~ m%/vim$%) {
302 $entire_file =~ s%<div class=\"(example-contents|informalexample)\"><pre class=\"programlisting\">(.*?)</pre></div>%&HighlightSourceVim($1,$2);%gse;
305 $entire_file =~ s%<div class=\"(example-contents|informalexample)\"><pre class=\"programlisting\">(.*?)</pre></div>%&HighlightSource($1,$2);%gse;
307 # this just broke existing GTKDOCLINK tags
308 # <GTKDOCLINK HREF="GST-PAD-SINK:CAPS">GST_PAD_SINK</GTKDOCLINK>
309 $entire_file =~ s%\<GTKDOCLINK\s+HREF=\"(.*?)\"\>(.*?)\</GTKDOCLINK\>%\<GTKDOCLINK\ HREF=\"$1\"\>$2\</GTKDOCLINK\>%gs;
311 # from the highlighter we get all the functions marked up
312 # now we could turn them into GTKDOCLINK items
313 $entire_file =~ s%(<span class=\"function\">)(.*?)(</span>)%&MakeGtkDocLink($1,$2,$3);%gse;
314 # we could also try the first item in stuff marked up as 'normal'
315 $entire_file =~ s%(<span class=\"normal\">\s*)(.+?)((\s+.+?)?\s*</span>)%&MakeGtkDocLink($1,$2,$3);%gse;
318 my @lines = split(/\n/, $entire_file);
319 for (my $i=0; $i<$#lines; $i++) {
320 $lines[$i] =~ s%<GTKDOCLINK\s+HREF="([^"]*)"\s*>(.*?)</GTKDOCLINK\s*>% &MakeXRef($file,$i+1,$1,$2); %ge;
321 #if ($lines[$i] =~ m/GTKDOCLINK/) {
322 # print "make xref failed for line: ",$lines[$i], "\n";
325 $entire_file = join("\n",@lines);
327 open (NEWFILE, ">$file.new")
328 || die "Can't open $file: $!";
329 print NEWFILE $entire_file;
333 || die "Can't delete $file: $!";
334 rename ("$file.new", $file)
335 || die "Can't rename $file.new: $!";
339 my ($file, $line, $id, $text) = @_;
341 my $href = $Links{$id};
343 # this is a workaround for some inconsistency we have with CreateValidSGMLID
344 if (!$href && $id =~ m/:/) {
347 $href = $Links{$tid};
349 # poor mans plural support
350 if (!$href && $id =~ m/s$/) {
353 $href = $Links{$tid};
357 # if it is a link to same module, remove path to make it work
359 if (defined($MODULE) && $href =~ m%^\.\./$MODULE/(.*)$%) {
361 @TRACE@(" Fixing link to uninstalled doc: $id, $href, $text");
363 @TRACE@(" Fixing link: $id, $href, $text");
365 return "<a href=\"$href\">$text</a>";
368 @TRACE@(" no link for: $id, $text");
370 # don't warn multiple times and also skip blacklisted (ctypes)
371 $warn = 0 if exists $NoLinks{$id};
372 # if it's a function, don't warn if it does not contain a "_"
373 # (transformed to "-")
374 # - gnome coding style would use '_'
375 # - will avoid wrong warnings for ansi c functions
376 $warn = 0 if ($text =~ m/ class=\"function\"/ && $id !~ m/-/);
377 # if it's a 'return value', don't warn (implicitly created link)
378 $warn = 0 if ($text =~ m/ class=\"returnvalue\"/);
379 # if it's a 'type', don't warn if it starts with lowercase
380 # - gnome coding style would use CamelCase
381 $warn = 0 if ($text =~ m/ class=\"type\"/ && ($id =~ m/^[a-z]/));
382 # don't warn for self links
383 $warn = 0 if ($text eq $id);
386 &LogWarning ($file, $line, "no link for: '$id' -> ($text).");
395 my ($pre,$symbol,$post) = @_;
397 my $id=CreateValidSGMLID($symbol);
399 # these are implicitely created links in highlighed sources
400 # we don't want warnings for those if the links cannot be resolved.
403 #return "<span class=\"$type\"><GTKDOCLINK HREF=\"$id\">$symbol</GTKDOCLINK></span>";
404 return "$pre<GTKDOCLINK HREF=\"$id\">$symbol</GTKDOCLINK>$post";
408 sub HighlightSource {
409 my ($type, $source) = @_;
411 # chop of leading and trailing empty lines
412 $source =~ s/^\s*\n+//gs;
413 $source =~ s/[\s\n]+$//gs;
415 $source =~ m/^(\s*)/;
416 $source =~ s/^$1//gms;
417 # avoid double entity replacement
418 $source =~ s/</</g;
419 $source =~ s/>/>/g;
420 $source =~ s/&/&/g;
422 # write source to a temp file
423 # FIXME: use .c for now to hint the language to the highlighter
424 my $temp_source_file="$MODULE_DIR/_temp_src.$$.c";
425 open (NEWFILE, ">$temp_source_file") || die "Can't open $temp_source_file: $!";
426 print NEWFILE $source;
429 @TRACE@(" running @HIGHLIGHT@ @HIGHLIGHT_OPTIONS@$temp_source_file ");
432 my $highlighted_source=`@HIGHLIGHT@ @HIGHLIGHT_OPTIONS@$temp_source_file`;
433 if ("@HIGHLIGHT@" =~ m%/source-highlight$%) {
434 $highlighted_source =~ s%^<\!-- .*? -->%%gs;
435 $highlighted_source =~ s%<pre><tt>(.*?)</tt></pre>%$1%gs;
437 elsif ("@HIGHLIGHT@" =~ m%/highlight$%) {
438 # need to rewrite the stylesheet classes
439 $highlighted_source =~ s%<span class="gtkdoc com">%<span class="comment">%gs;
440 $highlighted_source =~ s%<span class="gtkdoc dir">%<span class="preproc">%gs;
441 $highlighted_source =~ s%<span class="gtkdoc kwd">%<span class="function">%gs;
442 $highlighted_source =~ s%<span class="gtkdoc kwa">%<span class="keyword">%gs;
443 $highlighted_source =~ s%<span class="gtkdoc line">%<span class="linenum">%gs;
444 $highlighted_source =~ s%<span class="gtkdoc num">%<span class="number">%gs;
445 $highlighted_source =~ s%<span class="gtkdoc str">%<span class="string">%gs;
446 $highlighted_source =~ s%<span class="gtkdoc sym">%<span class="symbol">%gs;
448 # $highlighted_source =~ s%</span>(.+)<span%</span><span class="normal">$1</span><span%gs;
451 unlink ($temp_source_file)
452 || die "Can't delete $temp_source_file: $!";
454 return &HighlightSourcePostprocess($type, $highlighted_source);
457 sub HighlightSourceVim {
458 my ($type, $source) = @_;
460 # chop of leading and trailing empty lines
461 $source =~ s/^[\s\n]+//gs;
462 $source =~ s/[\s\n]+$//gs;
463 # avoid double entity replacement
464 $source =~ s/</</g;
465 $source =~ s/>/>/g;
466 $source =~ s/&/&/g;
468 # write source to a temp file
469 my $temp_source_file="$MODULE_DIR/_temp_src.$$.h";
470 open (NEWFILE, ">$temp_source_file") || die "Can't open $temp_source_file: $!";
471 print NEWFILE $source;
475 system "echo 'let html_number_lines=0|let html_use_css=1|let html_use_xhtml=1|syn on|e $temp_source_file|run! syntax/2html.vim|w! $temp_source_file.html|qa!' | @HIGHLIGHT@ -n -e -u NONE -T xterm >/dev/null";
477 my $highlighted_source;
480 open (NEWFILE, "<$temp_source_file.html");
481 $highlighted_source = <NEWFILE>;
484 $highlighted_source =~ s#.*<pre\b[^>]*>\n##s;
485 $highlighted_source =~ s#</pre>.*##s;
487 # need to rewrite the stylesheet classes
488 # FIXME: Vim has somewhat different syntax groups
489 $highlighted_source =~ s%<span class="Comment">%<span class="comment">%gs;
490 $highlighted_source =~ s%<span class="PreProc">%<span class="preproc">%gs;
491 $highlighted_source =~ s%<span class="Statement">%<span class="keyword">%gs;
492 $highlighted_source =~ s%<span class="Identifier">%<span class="function">%gs;
493 $highlighted_source =~ s%<span class="Constant">%<span class="number">%gs;
494 $highlighted_source =~ s%<span class="Special">%<span class="symbol">%gs;
495 $highlighted_source =~ s%<span class="Type">%<span class="type">%gs;
498 unlink ($temp_source_file)
499 || die "Can't delete $temp_source_file: $!";
500 unlink ("$temp_source_file.html")
501 || die "Can't delete $temp_source_file.html: $!";
503 return &HighlightSourcePostprocess($type, $highlighted_source);
506 sub HighlightSourcePostprocess {
507 my ($type, $highlighted_source) = @_;
509 # chop of leading and trailing empty lines
510 $highlighted_source =~ s/^[\s\n]+//gs;
511 $highlighted_source =~ s/[\s\n]+$//gs;
513 # turn common urls in comments into links
514 $highlighted_source =~ s%<span class="url">(.*?)</span>%<span class="url"><a href="$1">$1</a></span>%gs;
516 # we do own line-numbering
518 my $line_count = () = $highlighted_source =~ /\n/gs;
519 for (my $i=1; $i < ($line_count+2); $i++) {
520 $source_lines.="$i\n";
522 $source_lines =~ s/\n\Z//;
526 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
529 <td class="listing_lines" align="right"><pre>$source_lines</pre></td>
530 <td class="listing_code"><pre class="programlisting">$highlighted_source</pre></td>