5 # Add here the pages of the documentation generated by a @page doxygen macro
6 my @extra_files = qw(html/index.html html/pages.html html/modules.html html/annotated.html html/functions.html
7 html/functions_vars.html index.php
8 html/GRAS_tut.html html/tracing.html html/installSimgrid.html html/bindings.html
9 html/options.html html/use.html html/pls.html html/FAQ.html);
12 map {push @extra_files, "html/GRAS_tut_$_.html"} qw (intro
13 tour tour_install tour_setup tour_simpleexchange tour_args tour_callbacks tour_globals
14 tour_logs tour_timers tour_exceptions tour_rpc);
17 map {push @extra_files, "html/GRAS_ex_$_.html"} qw (ping mmrpc token timer);
20 $debug{'parse'} = 0; # show how we parse the module tree
21 $debug{'input'} = 0; # display the resulting tree
22 $debug{'handle'}= 0; # Be verbose on the post-processing
23 $debug{'rename'}= 0; # do not overwrite the files (allows several debuging runs without rerunning doxygen)
27 ### Get the module definitions
30 open IN, "html/modules.html" || die "Cannot parse html/modules.html. Did you really run doxygen?\n";
34 last if /group__SimGrid__API.html/;
42 # $current->{'label'}="ROOT";
43 # push @{$top->{'down'}},$current;
44 # print "Push $current '".($current->{'label'})."' as child of $top '".($top->{'label'})."'\n" if $debug{'parse'};
46 $top->{'label'}="ROOT";
47 print "Create ROOT $top\n" if $debug{'parse'};
51 # Read the whole data to postprocess it a bit
56 $in =~ s/<ul>/\n<ul>\n/sg;
57 foreach $_ (split(/\n/,$in)) {
58 next unless length($_);
59 next if ($_ =~ m|^</li>$|);
60 print " Seen '$_'\n" if $debug{'parse'};
62 print "DOWN: $current '$current->{'label'}' -> " if $debug{'parse'};
63 $current = $current->{'down'}[scalar @{$current->{'down'}} - 1];
64 print "$current '$current->{'label'}'\n" if $debug{'parse'};
68 $current = $current->{'up'};
69 print "UP to $current '$current->{'label'}'\n" if $debug{'parse'};
76 m|href="([^"]*)">([^<]*)</a>|; #"
79 $entry->{'file'} = $1;
80 $entry->{'label'} = $2;
81 $entry->{'up'} = $current;
82 push @{$current->{'down'}},$entry;
83 print "Push file:$1 label:'$2' as child of $current '$current->{'label'}'\n" if $debug{'parse'};
84 push @allfiles,"html/$1";
88 # Check each file for extra information (short name, extra childs)
92 if (defined($current->{'file'})) {
93 open IN, "html/$current->{'file'}";
95 if (/DOXYGEN_NAVBAR_LABEL/) {
96 if (/DOXYGEN_NAVBAR_LABEL="([^"]*)"/) {#"
97 print "Extra info from $current->{'file'}: label=$1, not $current->{'label'}\n" if $debug{'parse'};
98 $current->{'label'}=$1;
100 die "Malformated DOXYGEN_NAVBAR_LABEL line in $current->{'file'}";
103 if (/DOXYGEN_NAVBAR_CHILD/) {
104 if (/DOXYGEN_NAVBAR_CHILD *"([^"]*)"=([^ ]*)/) {#"
106 $entry->{'label'} = $1;
107 $entry->{'file'} = $2;
108 chomp($entry->{'file'});
109 $entry->{'up'} = $current;
110 push @{$current->{'down'}},$entry;
111 print "Extra info from $current->{'file'}: New child $entry->{'label'}=$entry->{'file'}\n" if $debug{'parse'};
113 die "Malformated DOXYGEN_NAVBAR_CHILD line in $current->{'file'}";
119 foreach my $entry (@{$current->{'down'}}) {
130 print "$current: ".$current->{'label'}." ($current->{'file'})\n";
131 foreach my $entry (@{$current->{'down'}}) {
132 display($entry,$level+1);
136 display($top,0) if $debug{'input'};
139 ### Generate the navbar
142 # the root deserves some special handling
143 open IN,"html/modules.html" || die;
144 open OUT,">html/modules.new.html" || die;
146 while ($line = <IN>) {
147 last if $line =~ /<h1>SimGrid Modules</;
151 print OUT "<div class=\"tabs\">\n <ul class=\"tablist\">\n";
152 foreach $current (@{ ${$top->{'down'}}[0]->{'down'} }) {
153 print OUT " <li><a href=\"$current->{'file'}\"><span>$current->{'label'}</span></a></li>\n";
155 print OUT " </ul></div>\n";
163 rename("html/modules.new.html","html/modules.html") unless $debug{'rename'};
165 # the publication pages deserves some special handling too
166 my %pub_tabs = ("publis.html" =>"Reference publications",
167 "publis_core.html" =>"Other publication about SimGrid",
168 "publis_extern.html"=>"External papers using SimGrid",
169 "publis_intra.html"=>"Internal papers using SimGrid");
171 my @pub_titles = ("publis.html", "publis_core.html", "publis_extern.html", "publis_intra.html");
174 my $newname = $oldname;
175 $newname =~ s/\.html$/.new.html/;
177 # print "Handle_pub($oldname -> $newname)\n";
179 open IN,"html/$oldname" || die "Cannot open $oldname";
180 open OUT,">html/$newname" || die "Cannot open $newname";
182 while ($line = <IN>) {
183 last if $line =~ /<h1>/;
187 print OUT "<div class=\"tabs\">\n<ul class=\"tablist\">\n";
188 foreach my $page (@pub_titles) {
189 print OUT " <li".($page eq $oldname? " class=\"current\"":"" )."> <a href=\"$page\"><span>".($pub_tabs{$page})."</span></a></li>\n";
192 print OUT " </ul></div>\n";
194 while ($line = <IN>) {
199 rename("html/$newname","html/$oldname") unless $debug{'rename'};
201 map {handle_pub($_)} @pub_titles;
204 # Operate the recursion
209 print "Handle $current->{'file'} at level $level\n" if $debug{'handle'};
211 # we generate the tabs bottom up begining from where we are in the tree
212 # and display them top down, as it should in a file
214 my $found_div_tabs=0;
216 if (defined ($current->{'label'}) and $current->{'label'} ne 'ROOT') {
217 # print "handle $current->{'file'}, at level $level\n";
219 my $iterator = $current;
221 while ($lvl_it >= 0) {
222 my $father = $iterator->{'up'};
223 $tabs[$lvl_it] = "<div class=\"tabs2\">\n<ul class=\"tablist\">\n";
224 foreach my $bro (@{$father->{'down'}}) {
225 $tabs[$lvl_it] .= " <li".($bro==$iterator?" class=\"current\"":"")."> <a href=\"$bro->{'file'}\"><span>$bro->{'label'}</span></a></li>\n";
227 $tabs[$lvl_it] .= " </ul></div>\n";
231 if (defined $current->{'down'}) { # there's some kid. Display them too
232 $tabs[$level+1] = "<div class=\"tabs2\">\n <ul class=\"tablist\">\n";
233 foreach my $kid (@{$current->{'down'}}) {
234 $tabs[$level+1] .= " <li> <a href=\"$kid->{'file'}\"><span>$kid->{'label'}</span></a></li>\n";
236 $tabs[$level+1] .= " </ul></div>\n";
240 open FROM,"html/$current->{'file'}" || die;
241 my $newname="html/$current->{'file'}";
242 $newname =~ s/.html/.handlepage.html/;
243 open TO,">$newname" || die;
244 # print "XXX Deal with html/$current->{'file'} -> $newname\n";
247 # add "current" to the module API granfather page
248 s|<li><a href="modules.html"><span>[^<]*</span></a></li>|<li class="current"><a href="modules.html"><span>Modules API</span></a></li>|;
249 # print "++Write $_";
250 $found_div_tabs=1 if m/div.*class="tabs"/;
252 last if ((m|</div>|)&&($found_div_tabs));
255 print TO "\n<!-- POST-PROCESSED TABS -->\n";
261 print TO "\n<!-- END OF POST-PROCESSED TABS -->\n";
263 if ($current->{'file'} =~ m/^class/) {
270 if (m/POST-PROCESSED TABS/) {
272 last if (m/END OF POST-PROCESSED TABS/);
277 if (m/The documentation for/) {
286 rename("$newname","html/$current->{'file'}") unless $debug{'rename'};
290 foreach my $entry (@{$current->{'down'}}) {
291 handle_page($entry,$level+1);
296 ### Launch the modules navbar reworking
298 handle_page($top,-1);# skip roots (we have 2 roots) in level counting
301 ### Add the modules navbar reworking to the modules.html file
303 sub add_tabs_to_module_html {
304 my $found_div_tabs=0;
305 my $module_tabs = "<div class=\"tabs2\">\n<ul class=\"tablist\">\n";
306 foreach my $entry (@{$top->{'down'}}) {
307 $module_tabs .= " <li> <a href=\"$entry->{'file'}\"><span>$entry->{'label'}</span></a></li>\n";
309 $module_tabs .= " </ul></div>\n";
311 my $oldname = "html/modules.html";
312 open FROM,$oldname || die;
313 my $newname=$oldname;
314 $newname =~ s/.html/.handlepage.html/;
315 open TO,">$newname" || die;
317 $found_div_tabs=1 if m/div.*class="tabs"/;
319 last if ((m|</div>|)&&($found_div_tabs));
322 print TO "\n<!-- POST-PROCESSED TABS -->\n";
323 print TO $module_tabs;
324 print TO "\n<!-- END OF POST-PROCESSED TABS -->\n";
331 rename($newname, $oldname) unless $debug{'rename'};
336 add_tabs_to_module_html;
339 ### Post-processsing common to all pages
341 map {push @allfiles,$_} @extra_files;
342 print "All files: ".(join(", ",@allfiles))."\n" if $debug{'parse'};
345 foreach my $file (@allfiles) {
346 $file =~ s/.html/.handlepage.html/ if $debug{'rename'}; # Take right name if debugging
348 open FROM,"$file" || die;
349 my $outfile = "$file";
350 $outfile =~ s/.(html|php)$/.new.$1/;
351 open TO,">$outfile" || die;
352 # print "POSTPROCESSING $file (tmp=$outfile)\n";
354 # Add the simgrid css, just in case
355 print TO '<link href="simgrid.css" rel="stylesheet" type="text/css">'."\n"
359 if($file =~ /^html\/index\..*/){
360 $_ =~ s/<li class="current">/<li>/g;
361 $_ =~ s/<li><a href="index.html">/<li class="current"><a href="index.html">/g;
363 $_ =~ s/<li class="current"><a href="pages.html">/<li><a href="pages.html">/g;
365 if($file =~ /^html\/pages\..*/){
366 $_ =~ s/<li><a href="pages.html">/<li class="current"><a href="pages.html">/g;
370 if($file =~ /^html\/publis.*/){
371 $_ =~ s/<div class="header">/<div>/g;
372 $_ =~ s/<div class="headertitle">/<div>/g;
375 # Add the FAQ PUBLIS PEOPLE HISTORY and CONTRIB to the top navbar.
376 if( $_ =~ /<div.*class="tabs">/){
379 if( $_ =~ /<\/div>/){
382 if( $_ =~ /<\/ul>/ && $tabs){
384 $tmp_buff .= ' <li><a href="use.html"><span>Using SimGrid</span></a></li>'."\n";
385 $tmp_buff .= ' <li><a href="http://gforge.inria.fr/projects/simgrid"><span>Forge</span></a></li>'."\n";
386 $tmp_buff .= ' <li><a href="http://simgrid.gforge.inria.fr/"><span>Website</span></a></li>'."\n";
387 $tmp_buff .= ' <li><a href="pages.html"><span>Documentation index</span></a></li>'."\n";
388 $tmp_buff .= ' <li><a href="FAQ.html"><span>FAQ</span></a></li>'."\n";
392 # Rework the navbar and add menu for use.html
393 # Fix the current "button" of buggy Doxygen tabs
394 if($file =~ /^html\/use.*/
395 || $file =~ /^html\/installSimgrid.*/
396 || $file =~ /^html\/options.*/
397 || $file =~ /^html\/tracing.*/
398 || $file =~ /^html\/bindings.*/
399 || $file =~ /^html\/pls.*/
400 || $file =~ /^html\/modules.*/
401 || $file =~ /^html\/annotated.*/
402 || $file =~ /^html\/group__.*/
403 || $file =~ /^html\/functions.*/)
405 $tmp_buff .= ' <div class="tabs_group_use">'."\n";
406 $tmp_buff .= ' <ul class="tablist">'."\n";
407 $tmp_buff .= ' <li><a href="installSimgrid.html"><span>Install SimGrid</span></a></li>'."\n";
408 $tmp_buff .= ' <li><a href="modules.html"><span>Modules API</span></a></li>'."\n";
409 $tmp_buff .= ' <li><a href="annotated.html"><span>Data Structures</span></a></li>'."\n";
410 $tmp_buff .= ' <li><a href="options.html"><span>Options & configurations</span></a></li>'."\n";
411 $tmp_buff .= ' <li><a href="tracing.html"><span>Tracing Simulations</span></a></li>'."\n";
412 $tmp_buff .= ' <li><a href="bindings.html"><span>Bindings</span></a></li>'."\n";
413 $tmp_buff .= ' <li><a href="pls.html"><span>Packet level simulation</span></a></li>'."\n";
414 $tmp_buff .= ' </ul></div>'."\n";
415 $tmp_buff .= ' </div>'."\n";
417 my $filename = $file;
418 $filename =~ s/html\///g;
419 $filename =~ s/\.html//g;
420 $filename =~ s/publis_.*/publis/g;
421 $tmp_buff =~ s/<li class="current">/<li>/g;
422 $tmp_buff =~ s/<li><a href="$filename.html">/<li class="current"><a href="$filename.html">/g;
423 $tmp_buff =~ s/<li><a href="use.html">/<li class="current"><a href="use.html">/g;
428 # Fix the current "button" of buggy Doxygen tabs
429 if($file =~ /^html\/pages.*/
430 || $file =~ /^html\/FAQ.*/)
432 my $filename = $file;
433 $filename =~ s/html\///g;
434 $filename =~ s/\.html//g;
435 $tmp_buff =~ s/<li class="current">/<li>/g;
436 $tmp_buff =~ s/<li><a href="$filename.html">/<li class="current"><a href="$filename.html">/g;
438 if($file =~ /^html\/group__.*/)
440 $tmp_buff =~ s/<li><a href="modules.html">/<li class="current"><a href="modules.html">/g;
442 if($file =~ /^html\/functions.*/)
444 $tmp_buff =~ s/<li><a href="annotated.html">/<li class="current"><a href="annotated.html">/g;
451 s|<span>Modules</span>|<span>Modules API</span>|g;
452 s|<li.*><a href="pages.html"><span>Related Pages</span></a></li>\n||g;
453 s|<li class="current"><a href="modules.html"><span>Modules API</span></a></li>\n||g;
454 s|<li class="current"><a href="modules.html"><span>Modules API</span></a></li>\n||g;
455 if($file =~ /^html\/group__.*/)
457 s|<li><a href="use.html">|<li class="current"><a href="use.html">|g;
458 s|<li><a href="modules.html"><span>Modules API</span></a></li>\n|<li class="current"><a href="modules.html"><span>Modules API</span></a></li>\n|g;
462 s|<li><a href="modules.html"><span>Modules API</span></a></li>\n||g;
464 s|<li><a href="annotated.html"><span>Data Structures</span></a></li>\n||g;
465 s|<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>\n||g;
466 s|Related Pages<|Documentation index<|g;
472 rename("$outfile", "$file") unless $debug{'rename'};