File: doc-postprocess.pl

package info (click to toggle)
gtkmm3.0 3.24.0-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 22,680 kB
  • sloc: xml: 121,333; cpp: 8,531; sh: 4,250; makefile: 262; perl: 236
file content (126 lines) | stat: -rw-r--r-- 3,118 bytes parent folder | download | duplicates (28)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
package main;

# Copyright (c) 2009  Openismus GmbH  <http://www.openismus.com/>
#
# This file is part of mm-common.
#
# mm-common is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation, either version 2 of the License,
# or (at your option) any later version.
#
# mm-common is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with mm-common.  If not, see <http://www.gnu.org/licenses/>.

use strict;
use warnings;
use bytes;
use File::Glob qw(:glob);
use File::Spec;
use Getopt::Long qw(:config no_getopt_compat no_ignore_case require_order bundling);

sub path_basename ($)
{
  my ($path) = @_;
  my $basename = File::Spec->splitpath($path);

  return $basename;
}

sub exit_help ()
{
  my $script_name = path_basename($0) || 'doc-postprocess.pl';

  print <<"EOF";
Usage: perl $script_name [OPTION]... [PATTERN]...

Post-process the Doxygen-generated HTML files matching PATTERN.

Options:
  -?, --help                        display this help and exit
EOF
  exit;
}

sub error (@)
{
  my $script_name = path_basename($0);
  $script_name =~ s/\.[^.]*$//s if (defined $script_name);

  print STDERR ($script_name || 'doc-postprocess', ': ', @_, "\n");
  exit 1;
}

GetOptions('help|?' => \&exit_help)
  or exit 2;

foreach my $filename (map(bsd_glob($_, GLOB_NOSORT), @ARGV))
{
  my @buf;
  my $file;

  open($file, '<', $filename) and (@buf = <$file>) and close($file)
    or error('Failed to read ', path_basename($filename), ': ', $!);

  foreach (@buf)
  {
    if (/<a class="el"/)
    {
      # return value
      s/ &amp;&nbsp; */&amp;&#160;/;
      s/ \*&nbsp; */*&#160;/;

      # parameters
      s/ &amp;/&amp;/g;
      s/&amp;\b/&amp; /g;
      s/ \*/*/g;
      s/\*\b/* /g;

      # templates
      s/\btemplate&lt;/template &lt;/;
    }
    elsif (/<td class="md(?:name)?"/)
    {
      # left parenthesis
      s/\(&nbsp; */(/;

      # return value
      s/ &amp; /&amp; /g;
      s/ \* /* /g;

      # parameters
      s/ &amp;&nbsp; */&amp;&#160;/g;
      s/ \*&nbsp; */*&#160;/g;

      # templates
      s/\btemplate&lt;/template &lt;/;
    }
    else
    {
      # template decls
      s/^(<h\d>|)template&lt;/$1template &lt;/;
    }

    # For some reason, recent versions of Doxygen output the full path to
    # referenced tag files.  This is bad since it breaks doc-install.pl,
    # and also because it leaks local path names into source tarballs.
    # Thus, strip the directory prefix here.
    s| doxygen="[^":]*/([^":]+\.tag):| doxygen="$1:|g;

    s/&copy;/&#169;/g;
    s/&mdash;/&#8212;/g;
    s/&ndash;/&#8211;/g;
    s/ *&nbsp; */&#160;/g;
  }

  # write the whole buffer back
  open($file, '>', $filename) and print $file (@buf) and close($file)
    or error('Failed to write ', path_basename($filename), ': ', $!);
}

exit;