File: doc-install.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 (222 lines) | stat: -rw-r--r-- 6,854 bytes parent folder | download | duplicates (57)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
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);

# Globals
my $message_prefix;
my %tags_hash;
my $book_base;
my $perm_mode;
my $target_dir;
my $target_nodir = '';
my $expand_glob  = '';
my $verbose      = '';

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

  return $basename;
}

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

  print <<"EOF";
Usage: perl $script_name [OPTION]... [-T] SOURCE DEST
  or:  perl $script_name [OPTION]... SOURCE... DIRECTORY
  or:  perl $script_name [OPTION]... -t DIRECTORY SOURCE...

Copy SOURCE to DEST or multiple SOURCE files to the existing DIRECTORY,
while setting permission modes.  For HTML files, translate references to
external documentation.

Mandatory arguments to long options are mandatory for short options, too.
      --book-base=BASEPATH          use reference BASEPATH for Devhelp book
  -l, --tag-base=TAGFILE\@BASEPATH   use BASEPATH for references from TAGFILE
  -m, --mode=MODE                   override file permission MODE (octal)
  -t, --target-directory=DIRECTORY  copy all SOURCE arguments into DIRECTORY
  -T, --no-target-directory         treat DEST as normal file
      --glob                        expand SOURCE as filename glob pattern
  -v, --verbose                     enable informational messages
  -?, --help                        display this help and exit
EOF
  exit;
}

sub notice (@)
{
  print($message_prefix, @_, "\n") if ($verbose);
}

sub warning (@)
{
  print STDERR ($message_prefix, @_, "\n");
}

sub error (@)
{
  warning(@_);
  exit 1;
}

# Copy file to destination while translating references on the fly.
# Sniff the content for the file type, as it is always read in anyway.
sub install_file ($$$)
{
  my ($in_name, $out_name, $basename) = @_;
  my ($in, $out, $buf);
  {
    local $/; # slurp mode: read entire file into buffer

    open($in, '<', $in_name) and binmode($in) and defined($buf = <$in>) and close($in)
      or error('Failed to read ', $basename, ': ', $!);
  }

  if (%tags_hash and $buf =~ m/\A(?> \s*)(?> (?> <[?!][^<]+ )* )<html[>\s]/sx)
  {
    my $count = 0;
    my $total = $buf =~
      s!(?<= \s) doxygen="((?> [^:"]+)):((?> [^"]*))" # doxygen="(TAGFILE):(BASEPATH)"
        (?> \s+) ((?> href|src) =") \2 ((?> [^"]*)")  # (href|src=")BASEPATH(RELPATH")
       ! $3 . ((exists $tags_hash{$1}) ? (++$count, $tags_hash{$1}) : $2) . $4
       !egsx;
    my $change = $total ? "rewrote $count of $total"
                        : 'no';
    notice('Translating ', $basename, ' (', $change, ' references)');
  }
  elsif (defined($book_base) and $buf =~ m/\A(?> \s*)(?> (?> <[?!][^<]+ )* )<book\s/sx)
  {
    # Substitute new value for attribute "base" of element <book>
    my $change = $buf =~ s/(<book \s [^<>]*? \b base=") (?> [^"]*) (?= ")/$1$book_base/sx
                 ? 'rewrote base path'
                 : 'base path not set';
    notice('Translating ', $basename, ' (', $change, ')');
  }
  else
  {
    notice('Copying ', $basename);
  }

  # Avoid inheriting permissions of existing file
  unlink($out_name);

  open($out, '>', $out_name) and binmode($out) and print $out ($buf) and close($out)
    or error('Failed to write ', $basename, ': ', $!);

  chmod($perm_mode, $out_name)
    or warning('Failed to set ', $basename, ' permissions: ', $!);
}

# Split TAGFILE@BASEPATH argument into key/value pair
sub split_key_value ($)
{
  my ($mapping) = @_;
  my ($name, $path) = split(m'@', $mapping, 2);

  error('Invalid base path mapping: ', $mapping) unless (defined($name) and $name ne '');

  if (defined $path)
  {
    notice('Using base path ', $path, ' for tag file ', $name);
    return ($name, $path);
  }
  notice('Not changing base path for tag file ', $name);
  return ();
}

# Define line leader of log messages
$message_prefix = path_basename($0);
$message_prefix =~ s/\.[^.]*$//s if (defined $message_prefix);
$message_prefix = ($message_prefix || 'doc-install') . ': ';

# Process command-line options
{
  my @tags = ();
  my $mode = '0644';

  GetOptions('book-base=s'           => \$book_base,
             'tag-base|l=s'          => \@tags,
             'mode|m=s'              => \$mode,
             'target-directory|t=s'  => \$target_dir,
             'no-target-directory|T' => \$target_nodir,
             'glob'                  => \$expand_glob,
             'verbose|v'             => \$verbose,
             'help|?'                => \&exit_help)
    or exit 2;

  error('Invalid permission mode: ', $mode) unless ($mode =~ m/^[0-7]+$/s);

  $perm_mode = oct($mode);
  %tags_hash = map(split_key_value($_), @tags);
}
notice('Using base path ', $book_base, ' for Devhelp book') if (defined $book_base);

if ($target_nodir)
{
  error('Conflicting target directory options') if (defined $target_dir);
  error('Source and destination filenames expected') unless ($#ARGV == 1);
  error('Filename globbing requires target directory') if ($expand_glob);

  install_file($ARGV[0], $ARGV[1], path_basename($ARGV[1]));
  exit;
}

unless (defined $target_dir)
{
  if (!$expand_glob and $#ARGV == 1)
  {
    my $basename = path_basename($ARGV[1]);

    if (defined($basename) and $basename ne '')
    {
      install_file($ARGV[0], $ARGV[1], $basename);
      exit;
    }
  }
  $target_dir = pop(@ARGV);
}
error('No target directory specified') unless (defined($target_dir) and $target_dir ne '');

@ARGV = map(bsd_glob($_, GLOB_NOSORT), @ARGV) if ($expand_glob);
my %basename_hash = ();

foreach my $in_name (@ARGV)
{
  my $basename = path_basename($in_name);

  # If there are multiple files with the same base name in the list, only
  # the first one will be installed.  This behavior makes it very easy to
  # implement a VPATH search for each individual file.
  unless (exists $basename_hash{$basename})
  {
    $basename_hash{$basename} = undef;
    my $out_name = File::Spec->catfile($target_dir, $basename);
    install_file($in_name, $out_name, $basename);
  }
}
exit;