OVMS3/OVMS.V3/components/zip/libzip/man/mkdocset.pl

217 lines
5.6 KiB
Perl
Raw Normal View History

#!/usr/bin/env perl
use strict;
my $DOCSETUTIL = '/Applications/Xcode.app/Contents/Developer/usr/bin/docsetutil';
my $BASE_URL = 'http://nih.at/libzip';
my $BUNDLE_ID = 'at.nih.libzip';
my $SRCDIR = $ENV{SRCDIR} // '.';
my @files = @ARGV;
my $docset = 'at.nih.libzip.docset';
my @sh_nodes = qw(zipcmp zipmerge ziptool);
(system('rm', '-rf', $docset) == 0) or die "can't remove old version of docset: $!";
mkdir($docset) or die "can't create docset directory: $!";
mkdir("$docset/Contents") or die "can't create docset directory: $!";
mkdir("$docset/Contents/Resources") or die "can't create docset directory: $!";
mkdir("$docset/Contents/Resources/Documents") or die "can't create docset directory: $!";
my $version = `sed -n 's/#define PACKAGE_VERSION "\\(.*\\)"/\\1/p' ../config.h`;
chomp $version;
my $suffix = '';
$suffix = '-hg' if ($version =~ /[a-z]$/);
my $package_file = "$BUNDLE_ID-$version.xar";
my $download_url = "$BASE_URL/$package_file";
my $feed_url = "$BASE_URL/at.nih.libzip$suffix.atom";
open I, "> $docset/Contents/Info.plist" or die "can't create Info.plist: $!";
print I <<EOF;
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleIdentifier</key>
<string>$BUNDLE_ID.docset</string>
<key>CFBundleName</key>
<string>libzip</string>
<key>DocSetPublisherIdentifier</key>
<string>at.nih</string>
<key>DocSetPublisherName</key>
<string>NiH</string>
<key>NSHumanReadableCopyright</key>
<string>Copyright © 2016 Dieter Baron and Thomas Klausner</string>
<key>CFBundleVersion</key>
<string>$version</string>
<key>DocSetFeedURL</key>
<string>$feed_url</string>
<key>DocSetFeedName</key>
<string>libzip</string>
</dict>
</plist>
EOF
close I;
open N, "> $docset/Contents/Resources/Nodes.xml" or die "can't create Nodes.xml: $!";
my %tl_nodes = (libzip => 1);
for (@sh_nodes) {
$tl_nodes{$_} = 1;
}
my @tokens = ();
print N <<EOF;
<?xml version="1.0" encoding="UTF-8"?>
<DocSetNodes version="1.0">
<TOC>
<Node noindex="1" type="folder">
<Name>libzip package</Name>
<Subnodes>
<Node noindex="1" type="folder">
<Name>Library</Name>
<Path>libzip.html</Path>
<Subnodes>
EOF
my $id = 1001;
for my $html (@files) {
my $name = $html;
$name =~ s/.html//;
if ($tl_nodes{$name}) {
next;
}
process_file($html, 'c', $id++);
}
print N " </Subnodes>\n";
print N " </Node>\n";
print N " <Node noindex=\"1\" type=\"folder\">\n";
print N " <Name>Commands</Name>\n";
print N " <Subnodes>\n";
$id = 2;
for my $name (@sh_nodes) {
process_file("$name.html", 'c', $id++);
}
print N " </Subnodes>\n";
print N " </Node>\n";
print N " </Subnodes>\n";
print N " </Node>\n";
print N " </TOC>\n";
print N "</DocSetNodes>\n";
close N;
link("$SRCDIR/nih-man.css", "$docset/Contents/Resources/Documents/nih-man.css") or die "can't link css file: $!";
copy_html('libzip.html', "$docset/Contents/Resources/Documents/libzip.html");
write_tokens();
system($DOCSETUTIL, 'index', $docset) == 0 or die "can't index docset: $!";
system($DOCSETUTIL, 'validate', $docset) == 0 or die "can't validate docset: $!";
unlink("$docset/Contents/Resources/Nodes.xml");
unlink("$docset/Contents/Resources/Tokens.xml");
system($DOCSETUTIL, 'package', '-output', "at.nih.libzip-$version.xar", '-atom', "at.nih.libzip$suffix.atom", '-download-url', "$BASE_URL/at.nih.libzip-$version.xar", $docset);
sub copy_html {
my ($src, $dst) = @_;
my $content = `cat $src`;
$content =~ s,</head>,<meta name="viewport" content="width=device-width"></head>,;
$content =~ s,../nih-man.css,nih-man.css,;
# remove header and footer
$content =~ s,<table[^>]*class="(heade?r?|foote?r?)".*?</table>,,sg;
$content =~ s,(<div class="sec-body") style="margin-left: 5.00ex;",$1,g;
$content =~ s,(<div class="ssec-head") style="margin-left: -2.00ex;",$1,g;
open X, "> $dst" or die "can't create $dst: $!";
print X $content;
close X;
}
sub process_file {
my ($html, $lang, $id) = @_;
my $name = $html;
$name =~ s/.html//;
my $mdoc = "$SRCDIR/$name.mdoc";
my $description;
my @names = ();
open MD, "< $mdoc" or die "can't open $mdoc: $!";
while (my $line = <MD>) {
if ($line =~ m/^.Nm (.*?)( ,)?$/) {
push @names, $1;
}
elsif ($line =~ m/^.Nd (.*)/) {
$description = $1;
}
elsif ($line =~ m/^.Sh SYNOPSIS/) {
last;
}
}
close MD;
print N " <Node id=\"$id\">\n";
print N " <Name>$name</Name>\n";
print N " <Path>$html</Path>\n";
print N " </Node>\n";
for my $name (@names) {
push @tokens, { type => "//apple_ref/$lang/func",
path => $html,
name => $name,
description => $description,
id => $id };
}
copy_html($html, "$docset/Contents/Resources/Documents/$html");
}
sub write_token {
my ($T, $token) = @_;
print $T " <Token>\n";
print $T " <TokenIdentifier>$token->{type}/$token->{name}</TokenIdentifier>\n";
print $T " <Path>$token->{path}</Path>\n";
print $T " <Abstract>$token->{description}</Abstract>\n";
print $T " <NodeRef refid=\"$token->{id}\" />\n";
print $T " </Token>\n";
}
sub write_tokens {
open my $T, "> $docset/Contents/Resources/Tokens.xml" or die "can't create Tokens.xml: $!";
print $T "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
print $T "<Tokens version=\"1.0\">\n";
for my $token (sort { $a->{name} cmp $b->{name} } @tokens) {
write_token($T, $token);
}
print $T "</Tokens>\n";
close $T;
}