1 # -*- coding: utf-8 -*-
3 # file legacy_lyxpreview2ppm.py
4 # This file is part of LyX, the document processor.
5 # Licence details can be found in the file COPYING.
8 # Full author contact details are available in file CREDITS
10 # with much advice from members of the preview-latex project:
11 # David Kastrup, dak@gnu.org and
12 # Jan-Åke Larsson, jalar@mai.liu.se.
13 # and with much help testing the code under Windows from
14 # Paul A. Rubin, rubin@msu.edu.
16 # This script takes a LaTeX file and generates a collection of
17 # png or ppm image files, one per previewed snippet.
19 # legacy_lyxpreview2bitmap.py 0lyxpreview.tex 128 ppm 000000 faf0e6
21 # This script takes five arguments:
22 # TEXFILE: the name of the .tex file to be converted.
23 # SCALEFACTOR: a scale factor, used to ascertain the resolution of the
24 # generated image which is then passed to gs.
25 # OUTPUTFORMAT: the format of the output bitmap image files.
26 # This particular script can produce only "ppm" format output.
27 # FG_COLOR: the foreground color as a hexadecimal string, eg '000000'.
28 # BG_COLOR: the background color as a hexadecimal string, eg 'faf0e6'.
30 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
31 # if executed successfully, leave in DIR:
32 # * a (possibly large) number of image files with names
33 # like BASE[0-9]+.(ppm|png)
34 # * a file BASE.metrics, containing info needed by LyX to position
35 # the images correctly on the screen.
37 # The script uses several external programs and files:
38 # * python 2.4 or later (subprocess module);
39 # * A latex executable;
43 # * pdflatex (optional);
44 # * pnmcrop (optional).
45 # * pdftocairo (optional).
46 # * epstopdf (optional).
48 # preview.sty is part of the preview-latex project
49 # http://preview-latex.sourceforge.net/
50 # Alternatively, it can be obtained from
51 # CTAN/support/preview-latex/
53 # What does this script do?
55 # 0) Process command-line arguments
56 # [legacy_conversion_step1]
57 # 1) Call latex to create a DVI file from LaTeX
58 # [legacy_conversion_step2]
59 # 2) Call dvips to create one PS file for each DVI page
60 # [legacy_conversion_step3]
61 # 3) If dvips fails look for PDF and call pdftocairo or gs to produce bitmaps
62 # 4) Otherwise call pdftocairo or gs on each PostScript file to produce bitmaps
63 # [legacy_conversion_pdflatex]
64 # 5) Keep track of pages on which gs failed and pass them to pdflatex
65 # 6) Call pdftocairo or gs on the PDF output from pdflatex to produce bitmaps
66 # 7) Extract and write to file (or return to lyxpreview2bitmap)
67 # metrics from both methods (standard and pdflatex)
69 # The script uses the old dvi->ps->png conversion route,
70 # which is good when using PSTricks, TikZ or other packages involving
71 # PostScript literals (steps 1, 2, 4).
72 # This script also generates bitmaps from PDF created by a call to
73 # lyxpreview2bitmap.py passing "pdflatex" to the CONVERTER parameter
75 # Finally, there's also has a fallback method based on pdflatex, which
76 # is required in certain cases, if hyperref is active for instance,
78 # If possible, dvipng should be used, as it's much faster.
79 # If possible, the script will use pdftocairo instead of gs,
80 # as it's much faster and gives better results.
82 import glob, os, pipes, re, sys, tempfile
84 from lyxpreview_tools import check_latex_log, copyfileobj, error, filter_pages,\
85 find_exe, find_exe_or_terminate, join_metrics_and_rename, latex_commands, \
86 latex_file_re, make_texcolor, pdflatex_commands, progress, \
87 run_command, run_latex, warning, write_metrics_info
91 return "Usage: %s <latex file> <dpi> ppm <fg color> <bg color>\n" \
92 "\twhere the colors are hexadecimal strings, eg 'faf0e6'" \
95 # Returns a list of tuples containing page number and ascent fraction
96 # extracted from dvipng output.
97 # Use write_metrics_info to create the .metrics file with this info
98 def legacy_extract_metrics_info(log_file):
100 log_re = re.compile(b"Preview: ([ST])")
101 data_re = re.compile(b"(-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)")
109 for line in open(log_file, 'rb').readlines():
110 match = log_re.match(line)
114 snippet = (match.group(1) == b'S')
116 match = data_re.search(line)
118 error("Unexpected data in %s\n%s" % (log_file, line))
121 ascent = float(match.group(2))
122 descent = float(match.group(3))
125 if ascent == 0 and descent == 0:
126 # This is an empty image, forbid its display
128 elif ascent >= 0 or descent >= 0:
129 ascent = ascent + tp_ascent
130 descent = descent - tp_descent
132 if abs(ascent + descent) > 0.1:
133 frac = ascent / (ascent + descent)
136 if frac < 0 or frac > 1:
139 results.append((int(match.group(1)), frac))
142 tp_descent = float(match.group(2))
143 tp_ascent = float(match.group(4))
146 # Unable to open the file, but do nothing here because
147 # the calling function will act on the value of 'success'.
148 warning('Warning in legacy_extract_metrics_info! Unable to open "%s"' % log_file)
149 warning(repr(sys.exc_info()[0]) + ',' + repr(sys.exc_info()[1]))
152 error("Failed to extract metrics info from %s" % log_file)
156 def extract_resolution(log_file, dpi):
157 fontsize_re = re.compile(b"Preview: Fontsize")
158 magnification_re = re.compile(b"Preview: Magnification")
159 extract_decimal_re = re.compile(b"([0-9\.]+)")
160 extract_integer_re = re.compile(b"([0-9]+)")
163 found_magnification = 0
166 magnification = 1000.0
170 for line in open(log_file, 'rb').readlines():
171 if found_fontsize and found_magnification:
174 if not found_fontsize:
175 match = fontsize_re.match(line)
177 match = extract_decimal_re.search(line)
179 error("Unable to parse: %s" % line)
180 fontsize = float(match.group(1))
184 if not found_magnification:
185 match = magnification_re.match(line)
187 match = extract_integer_re.search(line)
189 error("Unable to parse: %s" % line)
190 magnification = float(match.group(1))
191 found_magnification = 1
195 warning('Warning in extract_resolution! Unable to open "%s"' % log_file)
196 warning(repr(sys.exc_info()[0]) + ',' + repr(sys.exc_info()[1]))
198 # This is safe because both fontsize and magnification have
199 # non-zero default values.
200 return dpi * (10.0 / fontsize) * (1000.0 / magnification)
203 def legacy_latex_file(latex_file, fg_color, bg_color):
204 use_polyglossia_re = re.compile(b"\\s*\\\\usepackage{polyglossia}")
205 use_preview_re = re.compile(b"\\s*\\\\usepackage\\[([^]]+)\\]{preview}")
206 fg_color_gr = make_texcolor(fg_color, True)
207 bg_color_gr = make_texcolor(bg_color, True)
209 tmp = tempfile.TemporaryFile()
213 f = open(latex_file, 'rb')
215 # Unable to open the file, but do nothing here because
216 # the calling function will act on the value of 'success'.
217 warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file)
218 warning(repr(sys.exc_info()[0]) + ',' + repr(sys.exc_info()[1]))
221 for line in f.readlines():
225 match = use_preview_re.match(line)
226 polymatch = use_polyglossia_re.match(line)
228 # * if polyglossia is used, we need to load color before that
229 # (also, we do not have to load lmodern)
230 # * else, color should be loaded before preview
232 if polymatch == None:
238 \\definecolor{fg}{rgb}{%s}
239 \\definecolor{bg}{rgb}{%s}
241 \\usepackage{polyglossia}
242 """ % (fg_color_gr, bg_color_gr))
246 # Preview options: add the options lyx and tightpage
247 previewopts = match.group(1)
251 \\definecolor{fg}{rgb}{%s}
252 \\definecolor{bg}{rgb}{%s}
254 \\usepackage[%s,tightpage]{preview}
258 \\IfFileExists{lmodern.sty}{\\usepackage{lmodern}}{\\usepackage{ae,aecompl}}
260 \\g@addto@macro\\preview{\\begingroup\\color{bg}\\special{ps::clippath fill}\\color{fg}}
261 \\g@addto@macro\\endpreview{\\endgroup}
263 """ % (fg_color_gr, bg_color_gr, previewopts))
266 \\usepackage[%s,tightpage]{preview}
268 \\g@addto@macro\\preview{\\begingroup\\color{bg}\\special{ps::clippath fill}\\color{fg}}
269 \\g@addto@macro\\endpreview{\\endgroup}
273 copyfileobj(tmp, open(latex_file,"wb"), 1)
278 def crop_files(pnmcrop, basename):
280 t.append('%s -left' % pnmcrop, '--')
281 t.append('%s -right' % pnmcrop, '--')
283 for file in glob.glob("%s*.ppm" % basename):
284 tmp = tempfile.TemporaryFile()
285 new = t.open(file, "r")
286 copyfileobj(new, tmp)
288 copyfileobj(tmp, open(file,"wb"), 1)
291 def legacy_conversion(argv, skipMetrics = False):
292 # Parse and manipulate the command line arguments.
296 error(usage(argv[0]))
300 dir, latex_file = os.path.split(argv[1])
306 output_format = argv[3]
311 # External programs used by the script.
312 latex = find_exe_or_terminate(latex or latex_commands)
314 pdf_output = latex in pdflatex_commands
316 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
317 bg_color, latex, pdf_output, skipMetrics)
320 # Add color info to the latex file, since ghostscript doesn't
321 # have the option to set foreground and background colors on
322 # the command line. Run the resulting file through latex.
323 def legacy_conversion_step1(latex_file, dpi, output_format, fg_color, bg_color,
324 latex, pdf_output = False, skipMetrics = False):
326 # Move color information, lyx and tightpage options into the latex file.
327 if not legacy_latex_file(latex_file, fg_color, bg_color):
328 error("""Unable to move the color information, and the lyx and tightpage
329 options of preview-latex, into the latex file""")
331 # Compile the latex file.
332 latex_status, latex_stdout = run_latex(latex, latex_file)
334 progress("Will try to recover from %s failure" % latex)
337 return legacy_conversion_step3(latex_file, dpi, output_format, True, skipMetrics)
339 return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics)
341 # Creates a new LaTeX file from the original with pages specified in
342 # failed_pages, pass it through pdflatex and updates the metrics
343 # from the standard legacy route
344 def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics,
345 use_pdftocairo, conv, gs_device, gs_ext, alpha, resolution, output_format):
349 # Search for pdflatex executable
350 pdflatex = find_exe(["pdflatex"])
352 warning("Can't find pdflatex. Some pages failed with all the possible routes.")
355 # Create a new LaTeX file from the original but only with failed pages
356 pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file)
357 filter_pages(latex_file, pdf_latex_file, failed_pages)
361 pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file)
363 error_pages = check_latex_log(latex_file_re.sub(".log", pdf_latex_file))
365 pdf_file = latex_file_re.sub(".pdf", pdf_latex_file)
366 latex_file_root = latex_file_re.sub("", pdf_latex_file)
368 # Converter call to produce bitmaps
370 conv_call = '%s -png -transp -r %d "%s" "%s"' \
371 % (conv, resolution, pdf_file, latex_file_root)
372 conv_status, conv_stdout = run_command(conv_call)
374 seqnum_re = re.compile("-([0-9]+)")
375 for name in glob.glob("%s-*.png" % latex_file_root):
376 match = seqnum_re.search(name)
378 new_name = seqnum_re.sub(str(int(match.group(1))), name)
379 os.rename(name, new_name)
381 conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
382 '-sOutputFile="%s%%d.%s" ' \
383 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
385 % (conv, gs_device, latex_file_root, \
386 gs_ext, alpha, alpha, resolution, pdf_file)
387 conv_status, conv_stdout = run_command(conv_call)
391 warning("Some pages failed with all the possible routes")
395 pdf_log_file = latex_file_re.sub(".log", pdf_latex_file)
396 pdf_metrics = legacy_extract_metrics_info(pdf_log_file)
398 # Invalidate metrics for pages that produced errors
399 if len(error_pages) > 0:
400 for index in error_pages:
401 pdf_metrics.pop(index - 1)
402 pdf_metrics.insert(index - 1, (index, -1.0))
405 original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file)
406 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
408 # Join the metrics with the those from dvips and rename the bitmap images
409 join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages,
410 original_bitmap, destination_bitmap)
415 # The file has been processed through latex and we expect dvi output.
416 # Run dvips, taking note whether it was successful.
417 def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False):
418 # External programs used by the script.
419 dvips = find_exe_or_terminate(["dvips"])
421 # Run the dvi file through dvips.
422 dvi_file = latex_file_re.sub(".dvi", latex_file)
423 ps_file = latex_file_re.sub(".ps", latex_file)
425 dvips_call = '%s -i -o "%s" "%s"' % (dvips, ps_file, dvi_file)
428 dvips_status, dvips_stdout = run_command(dvips_call)
430 warning('Failed: %s %s ... looking for PDF' \
431 % (os.path.basename(dvips), dvi_file))
434 return legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics)
437 # Either latex and dvips have been run and we have a ps file, or
438 # pdflatex has been run and we have a pdf file. Proceed with pdftocairo or gs.
439 def legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics = False):
440 # External programs used by the script.
441 gs = find_exe_or_terminate(["gswin32c", "gswin64c", "gs"])
442 pnmcrop = find_exe(["pnmcrop"])
443 pdftocairo = find_exe(["pdftocairo"])
444 epstopdf = find_exe(["epstopdf"])
445 use_pdftocairo = pdftocairo != None and output_format == "png"
446 if use_pdftocairo and os.name == 'nt':
447 # On Windows, check for png support (see #10718)
448 conv_status, conv_stdout = run_command("%s --help" % pdftocairo)
449 use_pdftocairo = '-png' in conv_stdout
456 pdf_file = latex_file_re.sub(".pdf", latex_file)
457 ps_file = latex_file_re.sub(".ps", latex_file)
459 # The latex file name without extension
460 latex_file_root = latex_file_re.sub("", latex_file)
462 # Extract resolution data for the converter from the log file.
463 log_file = latex_file_re.sub(".log", latex_file)
464 resolution = extract_resolution(log_file, dpi)
466 # Check whether some pages produced errors
467 error_pages = check_latex_log(log_file)
469 # Older versions of gs have problems with a large degree of
470 # anti-aliasing at high resolutions
477 if output_format == "ppm":
481 # Extract the metrics from the log file
482 legacy_metrics = legacy_extract_metrics_info(log_file)
484 # List of pages which failed to produce a correct output
487 # Generate the bitmap images
489 # dvips failed, maybe there's a PDF, try to produce bitmaps
491 conv_call = '%s -png -transp -r %d "%s" "%s"' \
492 % (pdftocairo, resolution, pdf_file, latex_file_root)
494 conv_status, conv_stdout = run_command(conv_call)
496 seqnum_re = re.compile("-([0-9]+)")
497 for name in glob.glob("%s-*.png" % latex_file_root):
498 match = seqnum_re.search(name)
500 new_name = seqnum_re.sub(str(int(match.group(1))), name)
501 os.rename(name, new_name)
503 conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
504 '-sOutputFile="%s%%d.%s" ' \
505 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
507 % (gs, gs_device, latex_file_root, \
508 gs_ext, alpha, alpha, resolution, pdf_file)
510 conv_status, conv_stdout = run_command(conv_call)
513 error("Failed: %s %s" % (os.path.basename(conv), pdf_file))
515 # Model for calling the converter on each file
516 if use_pdftocairo and epstopdf != None:
517 conv_call = '%s -png -transp -singlefile -r %d "%%s" "%s%%d"' \
518 % (pdftocairo, resolution, latex_file_root)
520 conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
521 '-sOutputFile="%s%%d.%s" ' \
522 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
524 % (gs, gs_device, latex_file_root, \
525 gs_ext, alpha, alpha, resolution)
528 # Collect all the PostScript files (like *.001, *.002, ...)
529 ps_files = glob.glob("%s.[0-9][0-9][0-9]" % latex_file_root)
532 # Call the converter for each file
533 for file in ps_files:
535 progress("Processing page %s, file %s" % (i, file))
536 if use_pdftocairo and epstopdf != None:
537 conv_name = "epstopdf"
538 conv_status, conv_stdout = run_command("%s --outfile=%s.pdf %s"
539 % (epstopdf, file, file))
541 conv_name = "pdftocairo"
543 conv_status, conv_stdout = run_command(conv_call % (file, i))
545 conv_name = "ghostscript"
546 conv_status, conv_stdout = run_command(conv_call % (i, file))
549 # The converter failed, keep track of this
550 warning("%s failed on page %s, file %s" % (conv_name, i, file))
551 failed_pages.append(i)
553 # Pass failed pages to pdflatex
554 if len(failed_pages) > 0:
555 warning("Now trying to obtain failed previews through pdflatex")
556 error_count = legacy_conversion_pdflatex(latex_file, failed_pages,
557 legacy_metrics, use_pdftocairo, conv, gs_device, gs_ext, alpha,
558 resolution, output_format)
562 # Invalidate metrics for pages that produced errors
563 if len(error_pages) > 0:
564 for index in error_pages:
565 if index not in failed_pages:
566 legacy_metrics.pop(index - 1)
567 legacy_metrics.insert(index - 1, (index, -1.0))
570 # Crop the ppm images
571 if pnmcrop != None and output_format == "ppm":
572 crop_files(pnmcrop, latex_file_root)
574 # Allow to skip .metrics creation for custom management
575 # (see the dvipng method)
577 # Extract metrics info from the log file.
578 metrics_file = latex_file_re.sub(".metrics", latex_file)
579 write_metrics_info(legacy_metrics, metrics_file)
581 warning("Failed to produce %d preview snippet(s)" % error_count)
583 return (0, legacy_metrics)
586 if __name__ == "__main__":
587 sys.exit(legacy_conversion(sys.argv)[0])