From 4a99b7afa624662867335325f07b6e36e7d57ad6 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 3 Jan 2009 19:10:19 +0000 Subject: new paper size module for tlmgr2 git-svn-id: svn://tug.org/texlive/trunk@11807 c570f23f-e606-0410-a88d-b1316a301751 --- Master/tlpkg/TeXLive/TLPaper.pm | 665 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 665 insertions(+) create mode 100644 Master/tlpkg/TeXLive/TLPaper.pm (limited to 'Master/tlpkg/TeXLive/TLPaper.pm') diff --git a/Master/tlpkg/TeXLive/TLPaper.pm b/Master/tlpkg/TeXLive/TLPaper.pm new file mode 100644 index 00000000000..51275b94cb5 --- /dev/null +++ b/Master/tlpkg/TeXLive/TLPaper.pm @@ -0,0 +1,665 @@ +# $Id: papersize-setting.pl 11574 2008-12-10 00:06:21Z preining $ +# +# Adjusting and querying paper sizes from various config files +# +# Copyright 2008, 2009 Norbert Preining +# This file is licensed under the GNU General Public License version 2 +# or any later version. +# +# TODO TODO TODO +# if no paperconfig line is found in paper_do_simple it adds to the end of the +# file the new line, but this does not work on context because it +# has an \endinput at the end ... needs to be fixed + +package TeXLive::TLPaper; + +=pod + +=head1 NAME + +C -- paper size setting + +=head1 SYNOPSIS + + use TeXLive::TLPaper; + +=head1 DESCRIPTION + +=over 4 + +=cut + +use TeXLive::TLUtils qw(:DEFAULT dirname merge_into mkdirhier); + +my %paper_sub = ( + "xdvi" => \&paper_xdvi, + "pdftex" => \&paper_pdftex, + "dvips" => \&paper_dvips, + "dvipdfmx" => \&paper_dvipdfmx, + "dvipdfm" => \&paper_dvipdfm, + "context" => \&paper_context, +); + +# Where to write to by default. +my %default_paper_config_path_component = ( + "xdvi" => "xdvi/XDvi", + "pdftex" => "tex/generic/config/pdftexconfig.tex", + "dvips" => "dvips/config/config.ps", + "dvipdfmx" => "dvipdfmx/dvipdfmx.cfg", + "dvipdfm" => "dvipdfm/config/config", + "context" => "tex/context/user/cont-sys.tex", +); + +# Output is done to the components in this hash. +# If a value is undefined, we take the one from %default_... +# +my %paper_config_path_component; + + +my %xdvi_papersize = ( + "a1" => "59.4x84.0cm", + "a1r" => "84.0x59.4cm", + "a2" => "42.0x59.4cm", + "a2r" => "59.4x42.0cm", + "a3" => "29.7x42.0cm", + "a3r" => "42.0x29.7cm", + "a4" => "21.0x29.7cm", + "a4r" => "29.7x21.0cm", + "a5" => "14.85x21.0cm", + "a5r" => "21.0x14.85cm", + "a6" => "10.5x14.85cm", + "a6r" => "14.85x10.5cm", + "a7" => "7.42x10.5cm", + "a7r" => "10.5x7.42cm", + "b1" => "70.6x100.0cm", + "b1r" => "100.0x70.6cm", + "b2" => "50.0x70.6cm", + "b2r" => "70.6x50.0cm", + "b3" => "35.3x50.0cm", + "b3r" => "50.0x35.3cm", + "b4" => "25.0x35.3cm", + "b4r" => "35.3x25.0cm", + "b5" => "17.6x25.0cm", + "b5r" => "25.0x17.6cm", + "b6" => "13.5x17.6cm", + "b6r" => "17.6x13.5cm", + "b7" => "8.8x13.5cm", + "b7r" => "13.5x8.8cm", + "c1" => "64.8x91.6cm", + "c1r" => "91.6x64.8cm", + "c2" => "45.8x64.8cm", + "c2r" => "64.8x45.8cm", + "c3" => "32.4x45.8cm", + "c3r" => "45.8x32.4cm", + "c4" => "22.9x32.4cm", + "c4r" => "32.4x22.9cm", + "c5" => "16.2x22.9cm", + "c5r" => "22.9x16.2cm", + "c6" => "11.46x16.2cm", + "c6r" => "16.2x11.46cm", + "c7" => "8.1x11.46cm", + "c7r" => "11.46x8.1cm", + "foolscap" => "13.5x17.0", + "ledger" => "17.0x11.0", + "legal" => "8.5x14", + "letter" => "8.5x11", + "tabloid" => "11.0x17.0", + "us" => "8.5x11", + "usr" => "11x8.5", +); + +my %pdftex_papersize = ( + "a4" => [ '210 true mm', '297 true mm' ], + "letter" => [ '8.5 true in', '11 true in' ], +); + +my %dvipdfm_papersize = ( + "a3" => 1, + "a4" => 1, + "ledger" => 1, + "legal" => 1, + "letter" => 1, + "tabloid" => 1, +); + + + +=item C + +Call the paper subroutine for C<$prog>, passing args. Return hash of +necessary post-install programs for C to run. + +=cut + +sub do_paper { + my ($prog,$texmfsysconfig,@args) = @_; + my @ret = (); + if (exists $paper_sub{$prog}) { + my $sub = $paper_sub{$prog}; + @ret = &$sub($texmfsysconfig, @args); + } else { + tlwarn("$0: unknown paper program $prog ($texmfsysconfig,@args)\n"); + } + return @ret; +} + + +=item C + +Pass all C<@args> to each paper subroutine in turn, thus setting the +paper size for all supported programs. Return merge of all returned +hashes. + +=cut + +sub paper_all { + my %ret; + for my $p (sort keys %paper_sub) { + merge_into(\%ret, &{$paper_sub{$p}} (@_)); + } + return \%ret; +} + + +# return the config file to look in by running kpsewhich with the +# specified PROGNAME, FORMAT, and @FILENAMES. If no result, give a +# warning and return the empty string. +# +sub find_paper_file { + my ($progname, $format, @filenames) = @_; + my $ret = ""; + + my $cmd; + for my $filename (@filenames) { + $cmd = qq!kpsewhich --progname=$progname --format="$format" $filename!; + chomp($ret = `$cmd`); + if ($ret) { + debug("paper file for $progname ($format) $filename: $ret\n"); + last; + } + } + + tlwarn("$0: found no paper file for $progname (from $cmd)\n") if ! $ret; + return $ret; +} + + +# xdvi format: +# /--- XDvi --- +# |... +# |*paper: +# |... +# \------------ +# +# Reading is done via --progname=xdvi --format='other text files' XDvi +# Writing is done to TEXMFSYSCONFIG/xdvi/XDvi +# +sub paper_xdvi { + my $outtree = shift; + my $newpaper = shift; + + my $inp = &find_paper_file("xdvi", "other text files", "XDvi"); + return () unless $inp; + + my $outcomp = $paper_config_path_component{"xdvi"} + || $default_paper_config_path_component{"xdvi"}; + my $outfile = "$outtree/$outcomp"; + + my @sizes = keys %xdvi_papersize; + return &paper_do_simple($xdvi, "xdvi", '^\*paper: ', '^\*paper:\s+(\w+)\s*$', + sub { + my ($ll,$np) = @_; + $ll =~ s/^\*paper:\s+(\w+)\s*$/\*paper: $np\n/; + return($ll); + }, $outfile, \@sizes, '(undefined)', '*paper: a4', $newpaper); +} + + +# pdftex pdftexconfig.tex format +# /--- pdftexconfig.tex --- +# |... +# |\pdfpagewidth=NNN true +# |\pdfpageheight=NNN true +# |... +# \------------------------ +# +# Reading is done via --progname=pdftex --format='tex' pdftexconfig.tex +# Writing is done to TEXMFSYSCONFIG/tex/generic/config/pdftexconfig.tex +# +sub paper_pdftex { + my $outtree = shift; + my $newpaper = shift; + my %ret; + + my $outcomp = $paper_config_path_component{"pdftex"} + || $default_paper_config_path_component{"pdftex"}; + my $outfile = "$outtree/$outcomp"; + + my $inp = &find_paper_file("pdftex", "tex", "pdftexconfig.tex"); + return () unless $inp; + + open(FOO, "<$inp") || die "$0: open($inp) failed: $!"; + my @lines = ; + close(FOO); + + my ($cpw, $cph); + my ($cpwidx, $cphidx); + my $endinputidx; + # read the lines and the last pdfpageswidth/height wins + for my $idx (0..$#lines) { + my $l = $lines[$idx]; + if ($l =~ m/^\s*\\pdfpagewidth\s*=?\s*(.+)\s*$/) { + $cpw = $1; + $cpwidx = $idx; + next; + } + if ($l =~ m/^\s*\\pdfpageheight\s*=?\s*(.+)\s*$/) { + $cph = $1; + $cphidx = $idx; + next; + } + if ($l =~ m/^\s*\\endinput\s*/) { + $endinputidx = $idx; + next; + } + } + # trying to find the right papersize + # + my $currentpaper; + if (defined($cpw) && defined($cph)) { + for my $pname (keys %pdftex_papersize) { + my ($w, $h) = @{$pdftex_papersize{$pname}}; + if (($w eq $cpw) && ($h eq $cph)) { + $currentpaper = $pname; + last; + } + } + } else { + $currentpaper = "(undefined)"; + } + $currentpaper || ($currentpaper = "$cpw x $cph"); + if (defined($newpaper)) { + if ($newpaper eq "--list") { + info("$currentpaper\n"); + for my $p (keys %pdftex_papersize) { + info("$p\n") unless ($p eq $currentpaper); + } + } elsif ($newpaper eq "--returnlist") { + my @ret = (); + push @ret, "$currentpaper"; + for my $p (keys %pdftex_papersize) { + push @ret, $p unless ($p eq $currentpaper); + } + return @ret; + } else { + my $found = 0; + for my $p (keys %pdftex_papersize) { + if ($p eq $newpaper) { + $found = 1; + last; + } + } + if ($found) { + my $newwline = + '\pdfpagewidth=' . ${$pdftex_papersize{$newpaper}}[0] . "\n"; + my $newhline = + '\pdfpageheight=' . ${$pdftex_papersize{$newpaper}}[1] . "\n"; + if (defined($cpwidx)) { + $lines[$cpwidx] = $newwline; + } else { + if (defined($endinputidx)) { + $lines[$endinputidx] = $newwline . $lines[$endinputidx]; + } else { + $lines[$#lines] = $newwline; + } + } + if (defined($cphidx)) { + $lines[$cphidx] = $newhline; + } else { + if (defined($endinputidx)) { + $lines[$endinputidx] = $newhline . $lines[$endinputidx]; + } else { + $lines[$#lines] = $newwline; + } + } + info("$0: setting paper size for pdftex to $newpaper.\n"); + mkdirhier(dirname($outfile)); + # if we create the outfile we have to call mktexlsr + $ret{"mktexlsr"} = 1 unless (-r $outfile); + if (!open(TMP, ">$outfile")) { + tlwarn("$0: Cannot write to $outfile: $!\n"); + tlwarn("Not setting paper size for pdftex.\n"); + return (); + } + for (@lines) { print TMP; } + close(TMP) || warn "$0: close(>$outfile) failed: $!"; + $ret{"format"} = 1; + } else { + tlwarn("$0: Not a valid paper size for pdftex: $newpaper\n"); + } + } + } else { + info("Current pdftex paper size (from $inp): $currentpaper\n"); + } + return \%ret; +} + + +# dvips config.ps format: +# /--- config.ps --- +# |... +# |stuff not related to paper sizes +# |... +# | +# |% some comments +# |% more comments +# |@ +# |@+ ...definition line +# |@+ ...definition line +# |... more definition lines +# |@+ %%EndPaperSize +# | +# |@ +# |... +# \------------ +# +# the first paper definition is the default +# selecting paper is done like with texconfig which used ed to move the +# selected part between @ $selected_paper .... @ /-1 (the line before the +# next @ line) to the line before the first @ line. +# (what a tricky ed invocation te created there, impressive!!!) +# +# Reading is done via --progname=dvips --format='dvips config' config.ps +# Writing is done to TEXMFSYSCONFIG/dvips/config/config.ps +# +sub paper_dvips { + my $outtree = shift; + my $newpaper = shift; + my %ret; + + my $inp = &find_paper_file("dvips", "dvips config", "config.ps"); + return () unless $inp; + + my $outcomp = $paper_config_path_component{"dvips"} + || $default_paper_config_path_component{"dvips"}; + my $outfile = "$outtree/$outcomp"; + + open(FOO, "<$inp") || die "$0: open($inp) failed: $!"; + my @lines = ; + close(FOO); + + my @papersizes; + my $firstpaperidx; + my %startidx; + my %endidx; + my $in_block = ""; + my $idx = 0; + for my $idx (0 .. $#lines) { + if ($lines[$idx] =~ m/^@ (\w+)/) { + $startidx{$1} = $idx; + $firstpaperidx || ($firstpaperidx = $idx-1); + $in_block = $1; + push @papersizes, $1; + next; + } + # empty lines or comments stop a block + if ($in_block) { + if ($lines[$idx] =~ m/^\s*(%.*)?\s*$/) { + $endidx{$in_block} = $idx-1; + $in_block = ""; + } + next; + } + } + + if (defined($newpaper)) { + if ($newpaper eq "--list") { + for my $p (@papersizes) { + info("$p\n"); # first is already the selected one + } + } elsif ($newpaper eq "--returnlist") { + return(@papersizes); + } else { + my $found = 0; + for my $p (@papersizes) { + if ($p eq $newpaper) { + $found = 1; + last; + } + } + if ($found) { + my @newlines; + for my $idx (0..$#lines) { + if ($idx < $firstpaperidx) { + push @newlines, $lines[$idx]; + next; + } + if ($idx == $firstpaperidx) { + # insert the selected paper definition + push @newlines, @lines[$startidx{$newpaper}..$endidx{$newpaper}]; + push @newlines, $lines[$idx]; + next; + } + if ($idx >= $startidx{$newpaper} && $idx <= $endidx{$newpaper}) { + next; + } + push @newlines, $lines[$idx]; + } + info("$0: setting paper size for dvips to $newpaper.\n"); + mkdirhier(dirname($outfile)); + # if we create the outfile we have to call mktexlsr + $ret{"mktexlsr"} = 1 unless (-r $outfile); + if (!open(TMP, ">$outfile")) { + tlwarn("$0: Cannot write to $outfile: $!\n"); + tlwarn("Not setting paper size for dvips.\n"); + return (); + } + for (@newlines) { print TMP; } + close(TMP) || warn "$0: close(>$outfile) failed: $!"; + } else { + tlwarn("$0: Not a valid paper size for dvips: $newpaper\n"); + } + } + } else { + info("Current dvips paper size (from $inp): $papersizes[0]\n"); + } + return \%ret; +} + + +# dvipdfm(x) format: +# /--- dvipdfm/config, dvipdfmx/dvipdfmx.cfg --- +# |... +# |p +# |... +# \------------ +# +# Reading is done +# for dvipdfm via --progname=dvipdfm --format='other text files' config +# for dvipdfmx via --progname=dvipdfmx --format='other text files' dvipdfmx.cfg +# Writing is done to TEXMFSYSCONFIG/dvipdfm/config/config +# and /dvipdfmx/dvipdfmx.cfg +# +# +sub do_dvipdfm_and_x { + my ($inp,$prog,$outtree,$paplist,$newpaper) = @_; + my $outcomp = $paper_config_path_component{$prog} + || $default_paper_config_path_component{$prog}; + my $outfile = "$outtree/$outcomp"; + return &paper_do_simple($inp, $prog, '^p\s+', '^p\s+(\w+)\s*$', + sub { + my ($ll,$np) = @_; + $ll =~ s/^p\s+(\w+)\s*$/p $np\n/; + return($ll); + }, $outfile, $paplist, '(undefined)', 'p a4', $newpaper); +} + +sub paper_dvipdfm { + my $outtree = shift; + my $newpaper = shift; + + my $inp = &find_paper_file("dvipdfm", "other text files", "config"); + return () unless $inp; + + my @sizes = keys %dvipdfm_papersize; + return &do_dvipdfm_and_x($inp, "dvipdfm", $outtree, \@sizes, $newpaper); +} + +sub paper_dvipdfmx { + my $outtree = shift; + my $newpaper = shift; + + my $inp = &find_paper_file("dvipdfmx", "other text files", "dvipdfmx.cfg"); + return () unless $inp; + + my @sizes = keys %dvipdfm_papersize; + return &do_dvipdfm_and_x($inp, "dvipdfmx", $outtree, \@sizes, $newpaper); +} + + +# context format: +# /--- cont-sys.{tex,rme} +# |... +# |\setuppapersize[letter][letter] +# |... +# \------------ +# +sub paper_context { + my $outtree = shift; + my $newpaper = shift; + + my $outcomp = $paper_config_path_component{"context"} + || $default_paper_config_path_component{"context"}; + my $outfile = "$outtree/$outcomp"; + + my $inp = &find_paper_file("context", "tex", "cont-sys.tex", "cont-sys.rme"); + return () unless $inp; + + my @sizes = keys %pdftex_papersize; + # take care here, the \\\\ are necessary in some places and not in + # some others because there is no intermediate evaluation + return &paper_do_simple($inp, "context", '^\s*\\\\setuppapersize\s*', + '^\s*\\\\setuppapersize\s*\[([^][]*)\].*$', + sub { + my ($ll,$np) = @_; + if ($ll =~ m/^\s*\\setuppapersize\s*/) { + return("\\setuppapersize[$np][$np]\n"); + } else { + return($ll); + } + }, + $outfile, \@sizes, 'a4', '\setuppapersize[a4][a4]', $newpaper); +} + + +# paper_do_simple does the work for single line config files +# (xdvi, dvipdfm, ...) +# arguments: +# $inp, $prog, $firstre, $secondre, $bl, $outp, $paplist, $newpaper +# with +# $inp .. input file location +# $prog .. program name +# $firstre .. re that searches for paper lines +# $secondre .. re that extracts the paper from a paper line +# $bl .. block/sub taking two args, one paper line and the new paper, and +# returns the line with the paper configured, only lines mathing +# $firstre are shipped over to $bl +# $outp .. location of the output file +# $paplist .. ref to an array with the list of admissible paper sizes +# $defaultpaper .. default papersize (arbitrary string) if the $firstre is +# not found in the config file +# $defaultline .. the line to be added at the bottom of the file if +# no line has been found +# $newpaper .. --list, new paper, or undef +sub paper_do_simple { + my ($inp, $prog, $firstre, $secondre, $bl, $outp, $paplist, $defaultpaper, $defaultline, $newpaper) = @_; + + my %ret; + + debug("file used for $prog: $inp\n"); + + open(FOO, "<$inp") or die("cannot open file $inp: $!"); + my @lines = ; + close(FOO); + + my $currentpaper; + my @paperlines = grep (m/$firstre/,@lines); + if (!@paperlines) { + $currentpaper = $defaultpaper; + } else { + if ($#paperlines > 0) { + warn "Strange, more than one paper definiton, using the first one in\n$inp\n"; + } + $currentpaper = $paperlines[0]; + chomp($currentpaper); + $currentpaper =~ s/$secondre/$1/; + } + + # change value + if (defined($newpaper)) { + if ($newpaper eq "--list") { + info("$currentpaper\n"); + for my $p (@$paplist) { + info("$p\n") unless ($p eq $currentpaper); + } + } elsif ($newpaper eq "--returnlist") { + my @ret = (); + push @ret, $currentpaper; + for my $p (@$paplist) { + push @ret, $p unless ($p eq $currentpaper); + } + return(@ret); + } else { + my $found = 0; + for my $p (@$paplist) { + if ($p eq $newpaper) { + $found = 1; + last; + } + } + if ($found) { + my @newlines; + my $foundcfg = 0; + for my $l (@lines) { + if ($l =~ m/$firstre/) { + push @newlines, &$bl($l, $newpaper); + $foundcfg = 1; + } else { + push @newlines, $l; + } + } + # what to do if no default line found??? + if (!$foundcfg) { + push @newlines, &$bl($defaultline, $newpaper); + } + info("$0: setting paper size for $prog to $newpaper.\n"); + mkdirhier(dirname($outp)); + # if we create the outfile we have to call mktexlsr + $ret{"mktexlsr"} = 1 unless (-r $outp); + if (!open(TMP, ">$outp")) { + tlwarn("$0: Cannot write to $outp: $!\n"); + tlwarn("Not setting paper size for $prog.\n"); + return; + } + for (@newlines) { print TMP; } + close(TMP) || warn "$0: close(>$outfile) failed: $!"; + $ret{"format"} = 1 if $prog eq "context"; + } else { + tlwarn("$0: Not a valid paper size for $prog: $newpaper\n"); + } + } + } else { + # return the current value + info("Current $prog paper size (from $inp): $currentpaper\n"); + } + return \%ret; +} + +1; + +### Local Variables: +### perl-indent-level: 2 +### tab-width: 2 +### indent-tabs-mode: nil +### End: +# vim:set tabstop=2 expandtab: # -- cgit v1.2.3