summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/scripts/pst2pdf/pst2pdf
blob: 6b6ab98542969a7bf2fc6036618fa842efddf3b7 (plain)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
eval '(exit $?0)' && eval 'exec perl -S $0 ${1+"$@"}' && eval 'exec perl -S $0 $argv:q'
  if 0;

use strict;				# to be sure, that all is safe ... :-)

# v. 0.11				simplify the use of PSTricks with pdf
# 2011-01-18	(c) Herbert Voss <hvoss@tug.org> 
# $Id: pst2pdf.pl 239 2010-01-01 17:23:13Z herbert $
# Thanks to Pablo Gonzales Luengo
#
# This program 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.
#
# This program 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 this program; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA  02111-1307  USA
#
use File::Path;                         # creating/removing dirs
use File::Copy;                         # copying files
use File::Basename;			# scan argument
use IO::File;                           # simple IO operation
use Getopt::Long;			# read parameter

#----------------------- User part begin ------------------------
my $imageDir = "images";		# where to save the images
my @imageType = ("eps","pdf");		# all image types
my $machine = "Linux";
if ($^O eq 'MSWin32') { $machine = "Windows"; }
else                  { push (@imageType, "png"); }
my $Iext = ".pdf";			# leave empty, if not a special one
my $tempDir = ".";			# temporary directory
my $verbose = 1;			# 0 or 1, logfile  
my $clear = 0;				# 0 or 1, clears all temporary files
my $DPI = 75;				# very low value for the png's
my $Iscale = 1;				# for \includegraphics
my $noImages = 0;			# 1->create no images
my $runBibTeX = 0;			# 1->runs bibtex
my $runBiber = 0;			# 1->runs biber and sets $runBibTeX=0
#----------------------- User part end ---------------------------

@ARGV == 0 && die "file name expected!\n";

my @SuffixList = (".tex","",".ltx");			# possible extensions
my ($name,$path,$ext) = fileparse($ARGV[0],@SuffixList);
if ( $ext eq "" ) { $ext = ".tex"; }			# me need the extension as well
my $TeXfile = "$path$name$ext";
my $Logfile = "$tempDir/$name.plog";			# our own log file
open (LOGfile, ">$Logfile") or die "cannot open $Logfile!";

my $result = GetOptions ("DPI=i"      => \$DPI,      	# numeric
                         "Iscale=f"   => \$Iscale,   	# real
                         "imageDir=s" => \$imageDir, 	# string
                         "tempDir=s"  => \$tempDir,  	# string
                         "Iext=s"     => \$Iext,     	# string
                         "clear"      => \$clear,    	# flag
                         "noImages"   => \$noImages, 	# flag
                         "runBibTeX"  => \$runBibTeX, 	# flag
                         "runBiber"   => \$runBiber, 	# flag
                         "verbose"    => \$verbose); 	# flag

LOG ("Parameters:"); 
LOG ("==> imageDir = $imageDir"); 
LOG ("==> Iext     = $Iext"); 
LOG ("==> DPI      = $DPI"); 
LOG ("==> Iscale   = $Iscale"); 
LOG ("==> tempDir  = $tempDir"); 
LOG ("==> verbose  = $verbose"); 
LOG ("==> clear    = $clear"); 
LOG ("==> noImages = $noImages"); 
LOG ("==> runBibTeX= $runBibTeX"); 
LOG ("==> runBiber = $runBiber"); 

if ($runBibTeX && $runBiber) {
  LOG ("!!! you cannot run BibTeX and Biber at the same document ...");
  LOG ("!!! Assuming to run Biber");
  $runBibTeX = 0;
}

my $imgNo = 0;				# internal image counter
my $pstExaLoaded = 0;			# Document loads pst-exa

LOG ("Running on [$path][$name][$ext]"); 
open (FILE, "<$TeXfile") or die "cannot open source file $TeXfile!";	# the source
if ( !$noImages ) {
  if (-d $imageDir) { LOG ("$imageDir exists") }
  else { mkdir("$imageDir", 0744) || die "cannot mkdir $imageDir: $!";
    LOG ("Imagedir created"); }

  LOG ("go to savePreamble ... "); 
  savePreamble($name);
  LOG ("done!\n go to runFile ..."); 
  runFile($name);
  LOG ("done!"); 
  close FILE;						# close source file
}# !noImages


LOG ("runpdfTeX ... "); 
runpdfTeX("$path$name",$name);
LOG ("all finished ... :-)"); 
close LOGfile;
if ( $clear ) {
  unlink "$path$name.aux";
  unlink "$path$name.log";
  unlink "$path$name.preamble";
  unlink "$path$name-tmp.aux";
  unlink "$path$name-tmp.dvi";
  unlink "$path$name-tmp.log";
  unlink "$path$name-tmp.pdf";
  unlink "$path$name-tmp.ps";
  unlink "$path$name-tmp.tex";
}

sub savePreamble {			# create a preamble file
# if we have a \input command inside the preamble, it doesn't hurt, we need
# it anyway for the postscript files and the pdf one.
  my $filename = pop;			# get the file name
  LOG ("----- Start Preamble -----"); 
  open (FILEp, ">$tempDir/$filename.preamble") 
    or die "cannot open preamble file $tempDir/$filename.preamble!";
  while (<FILE>) {			# read all until \begin{document}
    $pstExaLoaded = index($_,"usepackage{pst-exa}"); 
    my $i = index($_,"begin{document}");
    if ($i > 0) { 
      if ($i > 1) { print FILEp substr($_,0,--$i); }	# write all until \begin{document}
      print FILEp "\n\\usepackage{pst-exa}\n";
      close(FILEp);  					# close preamble
      LOG ("----- Close Preamble ------"); 
      return; 
    } else { 
      print FILEp "$_"; 				# write into preamble
      LOG ("$_"); 
    }
  }
  close(FILEp);
  if ( $verbose ) { LOG("<-----Preamble<----"); }
  return;
}

sub searchPS {					# search the PostScript parts
  my @PS = ();					# single PS sequence
  my @PStotal = ();				# all PS sequences as list of arrays
  my $depth = -1;				# counts nested macros
  my $type = -1;				# -1-> none; 1->PST; 2->PS; 
  my $EndDocument = 0;				# ignore all after \end{document}
  my $iVerb = 0;				# test for verbatim or lstlisting environment, must be ignored
  while (<FILE>) {				# scan the input file
    if (!$EndDocument) {
    chomp;					# delete EOL character
    my $line = $_; 				# save line
    if ( !$iVerb ) { 
      $iVerb = ((index($line,"begin{verbatim}") > 0) or (index($line,"begin{lstlisting}") > 0)); 
    } 						# do nothing until \end{verbatim}
    if ( !$iVerb ) {
      my $iPS = index($line,"begin{postscript}");
      my $iPST = index($line,"begin{pspicture*}");
      if ($iPST < 0) { $iPST = index($line,"begin{pspicture}"); }	# alternative 
      if ($iPST < 0) { $iPST = index($line,"pspicture"); }	# alternative \pspicture...
      if (($iPS > 0) && ( $type == 1 )){ print "postscript environment must be of outer level!\n"; exit 1; }
      if ( $type < 0 ) {			# no active environment
        if ($iPS > 0) { 			# we have \begin{postscript}
          $type = 2; 			
          $line = substr($line,$iPS-1);		# add rest of the line
  	  LOG("PS-Zeile: $line");
        } 				
        elsif ( $iPST > 0 ) { 			# we have \begin{pspicture} or \pspicture
          $type = 1; 
	  $depth++;  
          $line = substr($line,$iPST-1);	# add all unitl pspicture
	  LOG("PST-Zeile: $line");
        }
      }
#	we have now \begin{pspicture} or \begin{postscript}
      if ($type > 0) {				# start Scan, we have an environment
        LOG ("searchPS: set \$type=$type"); 
        $iPST = index($line,"end{pspicture*}");
        if ($iPST < 0) { $iPST = index($line,"end{pspicture}"); }	# alternative
        if ($iPST < 0) { $iPST = index($line,"endpspicture"); }	# alternative \endpspicture...
        $iPS = index($line,"end{postscript}");	
        if ($iPST > 0) {			# test, we can have postscript and pspicture in one line
          if ( $type < 2) {			# found end of pspicture environment 
            LOG ("searchPS: $line"); 
	    $depth--; 
	    if ($depth < 0) { 
	      $type = -1; 
	      if (index($line,"endpspicture") > 0) 		# add line, depends to type
	           { push @PS,substr($line,0,$iPST+12); }	# \endpspicture
	      elsif (index($line,"pspicture*") > 0)
 	              { push @PS,substr($line,0,$iPST+15); }	# \end{pspicture} 
	      else { push @PS,substr($line,0,$iPST+14); }	# \end{pspicture} 
              LOG ("searchPS: set \$type=$type"); 
              push @PStotal,[@PS];	# add PS sequence
              LOG ("---->PS---->\n@PS\n<----PS<----"); 
	      @PS = ();			# start new PS sequence
	    }				# no pspicture env left
	  } else { push @PS,$line; }	# pspicture inside postscript
        } elsif ($iPS > 0) { 		# must be type=1 -> stop Scan
          LOG ("searchPS: $line"); 
	  $type = -1;
    	  push @PS,substr($line,0,$iPS+15);# add line
          LOG ("searchPS: set \$type=$type"); 
          push @PStotal,[@PS];		# add PS sequence
          LOG ("---->PS---->\n@PS\n<----PS<----"); 
	  @PS = ();			# start new PS sequence
        } else { push @PS,$line; }		# add line
      }
      my $i = index($line,"end{document}");
      if ($i > 0) { $EndDocument++; LOG("EndDocument in searchPS"); }
    } # if ( $iVerb )
    if (( index($line,"end{verbatim}") > 0 ) or ( index($line,"end{lstlisting}") > 0 )) { $iVerb = 0; }
  }}
  if ( $verbose ) { 
    LOG("---->PStotal---->");
    for my $aref ( @PStotal ) { 
      my @a = @$aref;
      my $i = 0;
      foreach ( @a ) { LOG ($a[$i]); $i++; }
    }
    LOG ("<----PStotal<----"); 
  }
  close(FILE);
  return @PStotal;			# return all PS sequences
}

sub runTeX {
  my $filename = pop;
  system("latex $filename"); # or die "Error in the LaTeX run from file $filename!";
  system("dvips $filename"); # or die "Error in the dvips run from file $filename!";
  system("ps2pdf $filename.ps");# or die "Error in the ps2pdf run from file $filename!";
  copy("$filename.tex", "$imageDir/$filename-$imgNo.tex") or die "Cannot copy Source file!";;
  for my $Itype ( @imageType ) {
    if ($Itype eq "pdf") { system("pdfcrop $filename.pdf $imageDir/$filename-$imgNo.pdf");  }
    if ($Itype eq "png") { 
      system("pdftoppm -f 1 -l 1 -r $DPI $imageDir/$filename-$imgNo.pdf $imageDir/"); 
      system("convert $imageDir/-1.ppm  $imageDir/$filename-$imgNo.png"); 
      system("rm $imageDir/-1.ppm"); 
    }
    if ($Itype eq "jpg") { 
      system("pdftoppm -f 1 -l 1 -r $DPI $imageDir/$filename-$imgNo.pdf $imageDir/"); 
      system("convert $imageDir/-1.ppm  $imageDir/$filename-$imgNo.jpg"); 
      system("rm $imageDir/-1.ppm"); 
    }
    if ($Itype eq "eps") { system("pdftops -f 1 -l 1 -eps $imageDir/$filename-$imgNo.pdf $imageDir/$filename-$imgNo.eps"); }
  }
  $imgNo++;
}

sub runFile {
  my $filename = pop;
  my @PSarray = searchPS();
  if ( $verbose ) { 
    LOG("---->PSarray---->");
    for my $aref ( @PSarray ) { 
      my @a = @$aref;
      my $i = 0;
      foreach ( @a ) { print LOG $a[$i]."\n"; $i++; }
    }
    LOG("<----PSarray<----"); 
    my $no = @PSarray;
    LOG("PS: ".$no." PS sequence(s)"); 
  }
  for my $aref ( @PSarray ) {
    my @PS = @$aref;
    open (FILEp, "<$tempDir/$filename.preamble") or die "cannot open $tempDir/$filename.preamble!";
    open (FILEsub, ">$tempDir/$filename-tmp.tex") or die "cannot open $tempDir/$filename-tmp.tex!";
    #print FILEsub "\\RequirePackage{listings}\n";
    while (<FILEp>) { print FILEsub $_; }
    print FILEsub "\\pagestyle{empty}\n";
    print FILEsub "\\newenvironment{postscript}{}{}\n";
    print FILEsub "\\providecommand\\IncludeGraphics[2][]{}\n";
    print FILEsub "\\begin{document}\n";
    if ( $verbose ) { LOG("\@PS: $_"); }
    foreach ( @PS ) { print FILEsub "$_\n"; }
    print FILEsub "\\end{document}\n";
    close (FILEsub);
    close (FILEp);
    runTeX("$tempDir/$filename-tmp");
  }
}

sub runpdfTeX() {
  my ($name,$pdfname) = @_;
  open (PDF, ">$tempDir/$pdfname-pdf.tex") or die "cannot open $tempDir/$pdfname-pdf.tex!";
  open (FILE, "<$name.tex") or die "cannot open $name!";
  print PDF "\\RequirePackage{graphicx}\n";
  #if ($pstExaLoaded < 1) {
   print PDF "\\let\\IncludeGraphics\\includegraphics\n"; #}
#  print PDF "\\setkeys{Gin}{scale=0.25}\n";
#  print PDF "\\providecommand\\psset[1]{}\n";
  print PDF "\\graphicspath{{$imageDir/}}\n"; #uncomment
  my $ignore = 0;
  my $IMGno = 0;
  my $depth = -1;
  my $type = -1;
  my $EndDocument = 0;			# ignore all after \end{document}
  my $iVerb = 0;
  while (<FILE>) {			# scan the input file
    if ( !$iVerb ) { 
      $iVerb = ((index($_,"begin{verbatim}") > 0) or (index($_,"begin{lstlisting}") > 0)); 
    } # do nothing until \end{verbatim}|| \end{lstlisting}
    if ( !$iVerb ) {
      my $i = index($_,"end{document}");
      if ($i > 0) { print PDF $_; $EndDocument++; LOG("EndDocument in runpdfTeX"); }
      if ( !$EndDocument ) {
        my $iPS = index($_,"begin{postscript}");
        if ( $iPS > 0 ) { 
          $type = 2; 
          $ignore = 1; 
          if ($iPS > 1) { print PDF substr($_,0,--$iPS); }	# add preceeding text
         print PDF "\\IncludeGraphics[scale=$Iscale]{$pdfname-tmp-$IMGno$Iext}"; #change name x pdfname
          $IMGno++;
        }		# postscript env
        if ( $type < 2 ) {
          my $iPST = index($_,"begin{pspicture*}");
          if ($iPST < 0) { $iPST = index($_,"begin{pspicture}"); }	# alternative ...
          if ($iPST < 0) { $iPST = index($_,"\\pspicture"); }	# alternative \endpspicture...
          if ( $iPST >= 0 ) {	 			# start Scan
            $ignore = 1;
            $type = 1; 
            $depth++; 					# pspicture env
	    LOG("Increase depth: $depth");
	    if ( $depth == 0 ) {
              if ($iPST > 1) { print PDF substr($_,0,--$iPST); }# add preceeding text
         #     print PDF "\\IncludeGraphics[scale=$Iscale]{$imageDir/$pdfname-tmp-$IMGno$Iext}"; #change name x pdfname
              print PDF "\\IncludeGraphics[scale=$Iscale]{$pdfname-tmp-$IMGno$Iext}"; 	# use \graphicspath
              $IMGno++;
	      LOG("Increase Image counter: $IMGno");
            }
          }
        }
        if ( !$ignore ) { print PDF "$_"; }			# default line
        if ( $type == 2 ) {					# postscript env
          my $iPS = index($_,"end{postscript}");
          if ($iPS > 0) {
            print PDF substr($_,$iPS+15);			# rest of line
            $ignore = 0; 
            $type=-1;
          }							# end Scan
        } elsif ( $type == 1 ) {				# pspicture env
          my $iPST = index($_,"end{pspicture*}");
          if ($iPST < 0) { $iPST = index($_,"end{pspicture}"); }# alternative ...
          if ($iPST < 0) { $iPST = index($_,"endpspicture"); }	# alternative \endpspicture...
          if ($iPST > 0) {		 			# end Scan
	    if (index($_,"endpspicture") > 0) 		# add rest of line, depends to type
	       { print PDF substr($_,$iPST+12); }	# \endpspicture
	    elsif (index($_,"pspicture*") > 0)
	            { print PDF substr($_,$iPST+15); }	# \end{pspicture*} 
	    else    { print PDF substr($_,$iPST+14); }	# \end{pspicture}
            $depth--; 
	    LOG("Decrease depth: $depth");
            if ($depth < 0) { $ignore = 0; }
          }
        }
      } # if ( !$EndDocument ) 
    } else { print PDF $_; } # if ( $iVerb )
    if (( index($_,"end{verbatim}") > 0 ) or ( index($_,"end{lstlisting}") > 0 )) { $iVerb = 0; }
  } # while (<FILE>)
  close (FILE);
  close (PDF);
  my $runAgain = 0;
  system("pdflatex $tempDir/$pdfname-pdf");
  if (-e "$tempDir/$pdfname-pdf.idx") { system("makeindex $tempDir/$pdfname-pdf.idx"); $runAgain++; }
  if ($runBibTeX && -e "$tempDir/$pdfname-pdf.aux") { system("bibtex $tempDir/$pdfname-pdf");  $runAgain++; }
  if ($runBiber && -e "$tempDir/$pdfname-pdf.bcf") { system("biber $tempDir/$pdfname-pdf");  $runAgain++; }
  if ($runAgain) { system("pdflatex $tempDir/$pdfname-pdf"); }
  if ( $clear ) {
    unlink "$tempDir/$pdfname-pdf.log";
    unlink "$tempDir/$pdfname-pdf.aux";
  }
}

sub LOG() { 
  if ( $verbose ) { print LOGfile "@_\n"; } 
}

__END__

=head1 NAME

B<pst2pdf> - run a TeX source, and convert all PS-related part as single images
    (pdf and/or eps and/or png and/or ...) and then runs pdflatex.

=head1 SYNOPSIS

  pst2pdf.pl <texfile[,tex]>  [Options]

TODO

=head1 DESCRIPTION

runs latex and pdflatex on the TeX source file

=head1 OPTIONS

=over

=item --imageDir      - the dir for the created images 

=item --Iext=<.ext>   - the extension for \includegraphics, can be empty 

=item --DPI=<int>     - the dots per inch for a cretaed png file

=item --Iscale=<real> - the value for \scale= in \includegraphics 

=item --tempDir=<dir> - temporary directory for the temp files

=item --verbose       - long log

=item --clear         - delete all temp files

=item --noImages      - create no images, build only pdf

=item --runBibTeX     - run bibtex on the aux file, if exists

=item --runBiber      - run biber on the bcf file, if exists

=back

=head1 AUTHORS

Herbert Voss <hvoss@tug.org>

=head1 COPYRIGHT

Copyright (c) 2007-2011  Herbert Voss <hvoss@tug.org>

This program 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.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA