4 # file useSystemFonts.pl
5 # 1.) Copies lyx-files to another location
7 # 2a.) searches for relative references to files and
8 # replaces them with absolute ones
9 # 2b.) In order to be able to compile with luatex or xetex
10 # changes default fonts to use non-tex-fonts instead
12 # Syntax: perl useSystemFonts.pl sourceFile destFile format
13 # Each param represents a path to a file
14 # sourceFile: full path to a lyx file
15 # destFile: destination path
16 # Each subdocument will be copied into a subdirectory of dirname(destFile)
17 # format: any string of the form '[a-zA-Z0-9]+', e.g. pdf5
19 # This file is free software; you can redistribute it and/or
20 # modify it under the terms of the GNU General Public
21 # License as published by the Free Software Foundation; either
22 # version 2 of the License, or (at your option) any later version.
24 # This software is distributed in the hope that it will be useful,
25 # but WITHOUT ANY WARRANTY; without even the implied warranty of
26 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 # General Public License for more details.
29 # You should have received a copy of the GNU General Public
30 # License along with this software; if not, write to the Free Software
31 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 # Copyright (c) 2013 Kornel Benko <kornel@lyx.org>
34 # (c) 2013 Scott Kostyshak <skotysh@lyx.org>
40 my $p = File::Spec->rel2abs( __FILE__ );
41 $p =~ s/[\/\\]?[^\/\\]+$//;
47 use File::Temp qw/ :POSIX /;
51 sub printCopiedDocuments($);
52 sub interpretedCopy($$$$);
53 sub copyFoundSubdocuments($);
55 sub isrelativeFix($$$);
57 sub createTemporaryFileName($$);
58 sub copyJobPending($$);
60 sub addFileCopyJob($$$$);
66 # convert lyx file to be compilable with xetex
68 my ($source, $dest, $format, $fontT, $encodingT, $languageFile, $rest) = @ARGV;
69 my %encodings = (); # Encoding with TeX fonts, depending on language tag
71 diestack("Too many arguments") if (defined($rest));
72 diestack("Sourcefilename not defined") if (! defined($source));
73 diestack("Destfilename not defined") if (! defined($dest));
74 diestack("Format (e.g. pdf4) not defined") if (! defined($format));
75 diestack("Font type (e.g. texF) not defined") if (! defined($fontT));
76 diestack("Encoding (e.g. ascii) not defined") if (! defined($encodingT));
78 $source = File::Spec->rel2abs($source);
79 $dest = File::Spec->rel2abs($dest);
83 if ($source =~ /\/([a-z][a-z](_[A-Z][A-Z])?)[\/_]/) {
87 my $inputEncoding = undef;
88 if ($fontT eq "systemF") {
89 if ($lang =~ /^(ru|uk|sk|el)$/) {
90 $font{roman} = "DejaVu Serif";
91 $font{sans} = "DejaVu Sans";
92 $font{typewriter} = "DejaVu Sans Mono";
94 elsif ($lang =~ /^(he)$/) {
95 $font{roman} = "FreeSans";
96 $font{sans} = "FreeSans";
97 $font{typewriter} = "FreeSans";
99 elsif ($lang eq "fa") {
100 $font{roman} = "FreeFarsi";
101 $font{sans} = "FreeFarsi";
102 $font{typewriter} = "FreeFarsi Monospace";
104 elsif ($lang eq "zh_CN") {
105 $font{roman} = "WenQuanYi Micro Hei";
106 $font{sans} = "WenQuanYi Micro Hei";
107 $font{typewriter} = "WenQuanYi Micro Hei";
109 elsif ($lang eq "ko" ) {
110 $font{roman} = "NanumGothic"; # NanumMyeongjo, NanumGothic Eco, NanumGothicCoding
111 $font{sans} = "NanumGothic";
112 $font{typewriter} = "NanumGothic";
114 elsif ($lang eq "ar" ) {
115 # available in 'fonts-sil-scheherazade' package
116 $font{roman} = "Scheherazade";
117 $font{sans} = "Scheherazade";
118 $font{typewriter} = "Scheherazade";
121 # default system fonts
122 $font{roman} = "FreeSerif";
123 $font{sans} = "FreeSans";
124 $font{typewriter} = "FreeMono";
127 elsif ($encodingT ne "default") {
128 # set input encoding to the requested value
130 "search" => '.*', # this will be substituted from '\inputencoding'-line
134 elsif (0) { # set to '1' to enable setting of inputencoding
137 if (defined($languageFile)) {
138 # The 2 lines below does not seem to have any effect
139 #&getlangs($languageFile, \%encoding);
140 #&simplifylangs(\%encoding);
142 if ($format =~ /^(pdf4)$/) { # xelatex
143 # set input encoding to 'ascii' always
145 "search" => '.*', # this will be substituted from '\inputencoding'-line
149 elsif ($format =~ /^(dvi3|pdf5)$/) { # (dvi)?lualatex
150 # when to set input encoding to 'ascii'?
151 if (defined($encoding{$lang})) {
153 "search" => '.*', # this will be substituted from '\inputencoding'-line
154 "out" => $encoding{$lang},
160 my $sourcedir = dirname($source);
161 my $destdir = dirname($dest);
163 diestack("could not make dir \"$destdir\"") if (! mkpath $destdir);
166 my $destdirOfSubdocuments;
168 my ($name, $pat, $suffix) = fileparse($source, qr/\.[^.]*/);
169 my $ext = $format . "_$lang";
170 $destdirOfSubdocuments = "$destdir/tmp_$ext" . "_$name"; # Global var, something TODO here
173 if(-d $destdirOfSubdocuments) {
174 rmtree($destdirOfSubdocuments);
176 mkpath($destdirOfSubdocuments); # for possibly included files
178 my %IncludedFiles = ();
180 "copy_only" => "copyonly",
181 "interpret" => "interpret");
183 addNewJob($source, $dest, "interpret", {}, \%IncludedFiles);
185 copyFoundSubdocuments(\%IncludedFiles);
187 #printCopiedDocuments(\%IncludedFiles);
190 ###########################################################
192 sub printCopiedDocuments($)
195 for my $k (keys %{$rFiles}) {
196 my $rJob = $rFiles->{$k};
197 for my $j ( values %type2hash) {
198 if (defined($rJob->{$j})) {
199 print "$j: $k->$rJob->{$j}, " . $rJob->{$j . "copied"} . "\n";
205 sub interpretedCopy($$$$)
207 my ($source, $dest, $destdirOfSubdocuments, $rFiles) = @_;
208 my $sourcedir = dirname($source);
211 diestack("could not read \"$source\"") if (!open(FI, $source));
212 diestack("could not write \"$dest\"") if (! open(FO, '>', $dest));
214 initLyxStack(\%font, $fontT, $inputEncoding);
217 my @path_errors = ();
218 while (my $l = <FI>) {
222 my $rStatus = checkLyxLine($l);
223 if ($rStatus->{found}) {
224 my $rF = $rStatus->{result};
225 if ($rStatus->{"filetype"} eq "replace_only") {
226 # e.g. if no files involved (font chage etc)
227 $l = join('', @{$rF});
230 my $filelist = $rStatus->{filelist};
231 my $fidx = $rStatus->{fileidx};
232 my $separator = $rStatus->{"separator"};
233 my $foundrelative = 0;
234 for my $f (@{$filelist}) {
235 my @isrel = isrelative($f,
241 if ($rStatus->{"filetype"} eq "prefix_only") {
242 $f = getNewNameOf("$sourcedir/$f", $rFiles);
245 my ($newname, $res1);
246 ($newname, $res1) = addFileCopyJob("$sourcedir/$f$ext",
247 "$destdirOfSubdocuments",
248 $rStatus->{"filetype"},
250 print "Added ($res1) file \"$sourcedir/$f$ext\" to be copied to \"$newname\"\n";
252 $newname =~ s/$ext$//;
260 # Non relative (e.g. with absolute path) file should exist
261 if ($rStatus->{"filetype"} eq "interpret") {
262 # filetype::interpret should be interpreted by lyx or latex and therefore emit error
263 # We prinnt a warning instead
264 print "WARNING: Interpreted file \"$f\" not found, at \"$source:$fi_line_no\"\n";
266 elsif ($rStatus->{"filetype"} eq "prefix_only") {
267 # filetype::prefix_only should be interpreted by latex
268 print "WARNING: Prefixed file \"$f\" not found, at \"$source:$fi_line_no\"\n";
271 # Collect the path-error-messages
272 push(@path_errors, "File \"$f(" . $rStatus->{"filetype"} . ")\" not found, at \"$source:$fi_line_no\"");
277 if ($foundrelative) {
278 $rF->[$fidx] = join($separator, @{$filelist});
279 $l = join('', @{$rF});
287 if (@path_errors > 0) {
288 for my $entry (@path_errors) {
289 print "ERROR: $entry\n";
291 diestack("Aborted because of path errors in \"$source\"");
298 sub copyFoundSubdocuments($)
306 for my $filename (keys %{$rFiles}) {
307 next if (! copyJobPending($filename, $rFiles));
308 $copylist{$filename} = 1;
310 for my $f (keys %copylist) {
311 # Second loop needed, because here $rFiles may change
312 my ($res1, @destfiles) = copyJob($f, $rFiles);
314 for my $destfile (@destfiles) {
315 print "res1 = $res1 for \"$f\" to be copied to $destfile\n";
318 } while($res > 0); # loop, while $rFiles changed
323 my ($source, $rFiles) = @_;
324 my $sourcedir = dirname($source);
328 for my $k (values %type2hash) {
329 if ($rFiles->{$source}->{$k}) {
330 if (! $rFiles->{$source}->{$k . "copied"}) {
331 $rFiles->{$source}->{$k . "copied"} = 1;
332 my $dest = $rFiles->{$source}->{$k};
334 if ($k eq "copyonly") {
335 diestack("Could not copy \"$source\" to \"$dest\"") if (! cp($source, $dest));
338 interpretedCopy($source, $dest, $destdirOfSubdocuments, $rFiles);
348 sub isrelativeFix($$$)
350 my ($f, $sourcedir, $ext) = @_;
352 return(1, $ext) if (-e "$sourcedir/$f$ext");
358 my ($f, $sourcedir, $ext) = @_;
360 if (ref($ext) eq "ARRAY") {
361 for my $ext2 (@{$ext}) {
362 my @res = isrelativeFix($f, $sourcedir, $ext2);
370 return(isrelativeFix($f, $sourcedir, $ext));
374 sub createTemporaryFileName($$)
376 my ($source, $destdir) = @_;
378 # get the basename to be used for the template
379 my ($name, $path, $suffix) = fileparse($source, qr/\.[^.]*/);
380 #print "source = $source, name = $name, path = $path, suffix = $suffix\n";
381 my $template = "xx_$name" . "_";
382 my $fname = File::Temp::tempnam($destdir, $template);
384 # Append extension from source
391 # Check, if file not copied yet
392 sub copyJobPending($$)
394 my ($f, $rFiles) = @_;
395 for my $t (values %type2hash) {
396 if (defined($rFiles->{$f}->{$t})) {
397 return 1 if (! $rFiles->{$f}->{$t . "copied"});
405 my ($source, $newname, $hashname, $rJob, $rFiles) = @_;
407 $rJob->{$hashname} = $newname;
408 $rJob->{$hashname . "copied"} = 0;
409 $rFiles->{$source} = $rJob;
412 sub addFileCopyJob($$$$)
414 my ($source, $destdirOfSubdocuments, $filetype, $rFiles) = @_;
415 my ($res, $newname) = (0, undef);
416 my $rJob = $rFiles->{$source};
418 my $hashname = $type2hash{$filetype};
419 if (! defined($hashname)) {
420 diestack("unknown filetype \"$filetype\"");
422 if (!defined($rJob->{$hashname})) {
424 createTemporaryFileName($source, $destdirOfSubdocuments),
425 "$hashname", $rJob, $rFiles);
428 $newname = $rJob->{$hashname};
429 return($newname, $res);
434 my ($f, $rFiles) = @_;
437 if (defined($rFiles->{$f})) {
438 for my $t (values %type2hash) {
439 if (defined($rFiles->{$f}->{$t})) {
440 $resultf = $rFiles->{$f}->{$t};
450 my ($languagefile, $rencoding) = @_;
452 if (open(FI, $languagefile)) {
453 while (my $l = <FI>) {
454 if ($l =~ /^Language/) {
455 my ($lng, $enc) = &getLangEntry();
457 $rencoding->{$lng} = $enc;
467 my ($rencoding) = @_;
473 for my $k (reverse sort keys %{$rencoding}) {
474 my @tag = split('_', $k);
475 if ($tag[0] eq $base) {
477 if ($rencoding->{$k} ne $enc) {
482 # new base, check that old base was OK
485 $rencoding->{$base} = $enc;
486 push(@klist2, @klist);
491 $enc = $rencoding->{$k};
496 # close handling for last entry too
498 $rencoding->{$base} = $enc;
499 push(@klist2, @klist);
502 for my $k (@klist2) {
503 delete($rencoding->{$k});
509 my ($lng, $enc) = (undef, undef);
510 while (my $l = <FI>) {
512 if ($l =~ /^\s*Encoding\s+([^ ]+)\s*$/) {
515 elsif ($l =~ /^\s*LangCode\s+([^ ]+)\s*$/) {
518 elsif ($l =~ /^\s*End\s*$/) {
522 if (defined($lng) && defined($enc)) {
526 return(undef, undef);