2 # -*- coding: utf-8 -*-
4 # file legacy_lyxpreview2ppm.py
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS
11 # with much advice from members of the preview-latex project:
12 # David Kastrup, dak@gnu.org and
13 # Jan-Åke Larsson, jalar@mai.liu.se.
14 # and with much help testing the code under Windows from
15 # Paul A. Rubin, rubin@msu.edu.
17 # This script takes a LaTeX file and generates a collection of
18 # png or ppm image files, one per previewed snippet.
20 # legacy_lyxpreview2bitmap.py 0lyxpreview.tex 128 ppm 000000 faf0e6
22 # This script takes five arguments:
23 # TEXFILE: the name of the .tex file to be converted.
24 # SCALEFACTOR: a scale factor, used to ascertain the resolution of the
25 # generated image which is then passed to gs.
26 # OUTPUTFORMAT: the format of the output bitmap image files.
27 # This particular script can produce only "ppm" format output.
28 # FG_COLOR: the foreground color as a hexadecimal string, eg '000000'.
29 # BG_COLOR: the background color as a hexadecimal string, eg 'faf0e6'.
31 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
32 # if executed successfully, leave in DIR:
33 # * a (possibly large) number of image files with names
34 # like BASE[0-9]+.(ppm|png)
35 # * a file BASE.metrics, containing info needed by LyX to position
36 # the images correctly on the screen.
38 # The script uses several external programs and files:
39 # * python 2.4 or later (subprocess module);
40 # * A latex executable;
44 # * pdflatex (optional);
45 # * pnmcrop (optional).
47 # preview.sty is part of the preview-latex project
48 # http://preview-latex.sourceforge.net/
49 # Alternatively, it can be obtained from
50 # CTAN/support/preview-latex/
52 # What does this script do?
54 # 0) Process command-line arguments
55 # [legacy_conversion_step1]
56 # 1) Call latex to create a DVI file from LaTeX
57 # [legacy_conversion_step2]
58 # 2) Call dvips to create one PS file for each DVI page
59 # [legacy_conversion_step3]
60 # 3) If dvips fails look for PDF and call gs to produce bitmaps
61 # 4) Otherwise call gs on each PostScript file to produce bitmaps
62 # [legacy_conversion_pdflatex]
63 # 5) Keep track of pages on which gs failed and pass them to pdflatex
64 # 6) Call gs on the PDF output from pdflatex to produce bitmaps
65 # 7) Extract and write to file (or return to lyxpreview2bitmap)
66 # metrics from both methods (standard and pdflatex)
68 # The script uses the old dvi->ps->png conversion route,
69 # which is good when using PSTricks, TikZ or other packages involving
70 # PostScript literals (steps 1, 2, 4).
71 # This script also generates bitmaps from PDF created by a call to
72 # lyxpreview2bitmap.py passing "pdflatex" to the CONVERTER parameter
74 # Finally, there's also has a fallback method based on pdflatex, which
75 # is required in certain cases, if hyperref is active for instance,
77 # If possible, dvipng should be used, as it's much faster.
79 import glob, os, pipes, re, string, sys
81 from lyxpreview_tools import copyfileobj, error, filter_pages, find_exe, \
82 find_exe_or_terminate, join_metrics_and_rename, latex_commands, \
83 latex_file_re, make_texcolor, mkstemp, pdflatex_commands, progress, \
84 run_command, run_latex, warning, write_metrics_info
88 return "Usage: %s <latex file> <dpi> ppm <fg color> <bg color>\n" \
89 "\twhere the colors are hexadecimal strings, eg 'faf0e6'" \
92 # Returns a list of tuples containing page number and ascent fraction
93 # extracted from dvipng output.
94 # Use write_metrics_info to create the .metrics file with this info
95 def legacy_extract_metrics_info(log_file):
97 log_re = re.compile("Preview: ([ST])")
98 data_re = re.compile("(-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)")
106 for line in open(log_file, 'r').readlines():
107 match = log_re.match(line)
111 snippet = (match.group(1) == 'S')
113 match = data_re.search(line)
115 error("Unexpected data in %s\n%s" % (log_file, line))
118 ascent = string.atoi(match.group(2))
119 descent = string.atoi(match.group(3))
122 if ascent >= 0 and descent >= 0:
123 ascent = float(ascent) + tp_ascent
124 descent = float(descent) - tp_descent
126 if abs(ascent + descent) > 0.1:
127 frac = ascent / (ascent + descent)
130 if frac < 0 or frac > 1:
133 results.append((int(match.group(1)), frac))
136 tp_descent = string.atof(match.group(2))
137 tp_ascent = string.atof(match.group(4))
140 # Unable to open the file, but do nothing here because
141 # the calling function will act on the value of 'success'.
142 warning('Warning in legacy_extract_metrics_info! Unable to open "%s"' % log_file)
143 warning(`sys.exc_type` + ',' + `sys.exc_value`)
146 error("Failed to extract metrics info from %s" % log_file)
150 def extract_resolution(log_file, dpi):
151 fontsize_re = re.compile("Preview: Fontsize")
152 magnification_re = re.compile("Preview: Magnification")
153 extract_decimal_re = re.compile("([0-9\.]+)")
154 extract_integer_re = re.compile("([0-9]+)")
157 found_magnification = 0
160 magnification = 1000.0
164 for line in open(log_file, 'r').readlines():
165 if found_fontsize and found_magnification:
168 if not found_fontsize:
169 match = fontsize_re.match(line)
171 match = extract_decimal_re.search(line)
173 error("Unable to parse: %s" % line)
174 fontsize = string.atof(match.group(1))
178 if not found_magnification:
179 match = magnification_re.match(line)
181 match = extract_integer_re.search(line)
183 error("Unable to parse: %s" % line)
184 magnification = string.atof(match.group(1))
185 found_magnification = 1
189 warning('Warning in extract_resolution! Unable to open "%s"' % log_file)
190 warning(`sys.exc_type` + ',' + `sys.exc_value`)
192 # This is safe because both fontsize and magnification have
193 # non-zero default values.
194 return dpi * (10.0 / fontsize) * (1000.0 / magnification)
197 def legacy_latex_file(latex_file, fg_color, bg_color):
198 use_preview_re = re.compile(r"\s*\\usepackage\[([^]]+)\]{preview}")
199 fg_color_gr = make_texcolor(fg_color, True)
200 bg_color_gr = make_texcolor(bg_color, True)
206 f = open(latex_file, 'r')
208 # Unable to open the file, but do nothing here because
209 # the calling function will act on the value of 'success'.
210 warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file)
211 warning(`sys.exc_type` + ',' + `sys.exc_value`)
213 for line in f.readlines():
217 match = use_preview_re.match(line)
222 # Package order: color should be loaded before preview
223 # Preview options: add the options lyx and tightpage
226 \definecolor{fg}{rgb}{%s}
227 \definecolor{bg}{rgb}{%s}
229 \usepackage[%s,lyx,tightpage]{preview}
231 \g@addto@macro\preview{\begingroup\color{bg}\special{ps::clippath fill}\color{fg}}
232 \g@addto@macro\endpreview{\endgroup}
234 """ % (fg_color_gr, bg_color_gr, match.group(1)))
237 copyfileobj(tmp, open(latex_file,"wb"), 1)
242 def crop_files(pnmcrop, basename):
244 t.append('%s -left' % pnmcrop, '--')
245 t.append('%s -right' % pnmcrop, '--')
247 for file in glob.glob("%s*.ppm" % basename):
249 new = t.open(file, "r")
250 copyfileobj(new, tmp)
252 copyfileobj(tmp, open(file,"wb"), 1)
255 def legacy_conversion(argv, skipMetrics = False):
256 # Parse and manipulate the command line arguments.
260 error(usage(argv[0]))
264 dir, latex_file = os.path.split(argv[1])
268 dpi = string.atoi(argv[2])
270 output_format = argv[3]
275 # External programs used by the script.
276 latex = find_exe_or_terminate(latex or latex_commands)
278 pdf_output = latex in pdflatex_commands
280 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
281 bg_color, latex, pdf_output, skipMetrics)
284 # Add color info to the latex file, since ghostscript doesn't
285 # have the option to set foreground and background colors on
286 # the command line. Run the resulting file through latex.
287 def legacy_conversion_step1(latex_file, dpi, output_format, fg_color, bg_color,
288 latex, pdf_output = False, skipMetrics = False):
290 # Move color information, lyx and tightpage options into the latex file.
291 if not legacy_latex_file(latex_file, fg_color, bg_color):
292 error("""Unable to move the color information, and the lyx and tightpage
293 options of preview-latex, into the latex file""")
295 # Compile the latex file.
296 latex_status, latex_stdout = run_latex(latex, latex_file)
299 return legacy_conversion_step3(latex_file, dpi, output_format, True, skipMetrics)
301 return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics)
303 # Creates a new LaTeX file from the original with pages specified in
304 # failed_pages, pass it through pdflatex and updates the metrics
305 # from the standard legacy route
306 def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs,
307 gs_device, gs_ext, alpha, resolution, output_format):
309 # Search for pdflatex executable
310 pdflatex = find_exe(["pdflatex"])
312 warning("Can't find pdflatex. Some pages failed with all the possible routes.")
314 # Create a new LaTeX file from the original but only with failed pages
315 pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file)
316 filter_pages(latex_file, pdf_latex_file, failed_pages)
319 pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file)
321 pdf_file = latex_file_re.sub(".pdf", pdf_latex_file)
323 # GhostScript call to produce bitmaps
324 gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
325 '-sOutputFile="%s%%d.%s" ' \
326 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
328 % (gs, gs_device, latex_file_re.sub("", pdf_latex_file), \
329 gs_ext, alpha, alpha, resolution, pdf_file)
330 gs_status, gs_stdout = run_command(gs_call)
333 warning("Some pages failed with all the possible routes")
336 pdf_log_file = latex_file_re.sub(".log", pdf_latex_file)
337 pdf_metrics = legacy_extract_metrics_info(pdf_log_file)
339 original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file)
340 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
342 # Join the metrics with the those from dvips and rename the bitmap images
343 join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages,
344 original_bitmap, destination_bitmap)
347 # The file has been processed through latex and we expect dvi output.
348 # Run dvips, taking note whether it was successful.
349 def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False):
350 # External programs used by the script.
351 dvips = find_exe_or_terminate(["dvips"])
353 # Run the dvi file through dvips.
354 dvi_file = latex_file_re.sub(".dvi", latex_file)
355 ps_file = latex_file_re.sub(".ps", latex_file)
357 dvips_call = '%s -i -o "%s" "%s"' % (dvips, ps_file, dvi_file)
360 dvips_status, dvips_stdout = run_command(dvips_call)
362 warning('Failed: %s %s ... looking for PDF' \
363 % (os.path.basename(dvips), dvi_file))
366 return legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics)
369 # Either latex and dvips have been run and we have a ps file, or
370 # pdflatex has been run and we have a pdf file. Proceed with gs.
371 def legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics = False):
372 # External programs used by the script.
373 gs = find_exe_or_terminate(["gswin32c", "gswin64c", "gs"])
374 pnmcrop = find_exe(["pnmcrop"])
377 pdf_file = latex_file_re.sub(".pdf", latex_file)
378 ps_file = latex_file_re.sub(".ps", latex_file)
380 # Extract resolution data for gs from the log file.
381 log_file = latex_file_re.sub(".log", latex_file)
382 resolution = extract_resolution(log_file, dpi)
384 # Older versions of gs have problems with a large degree of
385 # anti-aliasing at high resolutions
392 if output_format == "ppm":
396 # Extract the metrics from the log file
397 legacy_metrics = legacy_extract_metrics_info(log_file)
399 # List of pages which failed to produce a correct output
402 # Generate the bitmap images
404 # dvips failed, maybe there's a PDF, try to produce bitmaps
405 gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
406 '-sOutputFile="%s%%d.%s" ' \
407 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
409 % (gs, gs_device, latex_file_re.sub("", latex_file), \
410 gs_ext, alpha, alpha, resolution, pdf_file)
412 gs_status, gs_stdout = run_command(gs_call)
414 error("Failed: %s %s" % (os.path.basename(gs), ps_file))
416 # Model for calling gs on each file
417 gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
418 '-sOutputFile="%s%%d.%s" ' \
419 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
421 % (gs, gs_device, latex_file_re.sub("", latex_file), \
422 gs_ext, alpha, alpha, resolution)
425 # Collect all the PostScript files (like *.001, *.002, ...)
426 ps_files = glob.glob("%s.[0-9][0-9][0-9]" % latex_file_re.sub("", latex_file))
429 # Call GhostScript for each file
430 for file in ps_files:
432 progress("Processing page %s, file %s" % (i, file))
433 gs_status, gs_stdout = run_command(gs_call % (i, file))
435 # gs failed, keep track of this
436 warning("Ghostscript failed on page %s, file %s" % (i, file))
437 failed_pages.append(i)
439 # Pass failed pages to pdflatex
440 if len(failed_pages) > 0:
441 legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs,
442 gs_device, gs_ext, alpha, resolution, output_format)
446 crop_files(pnmcrop, latex_file_re.sub("", latex_file))
448 # Allow to skip .metrics creation for custom management
449 # (see the dvipng method)
451 # Extract metrics info from the log file.
452 metrics_file = latex_file_re.sub(".metrics", latex_file)
453 write_metrics_info(legacy_metrics, metrics_file)
455 return (0, legacy_metrics)
458 if __name__ == "__main__":
459 sys.exit(legacy_conversion(sys.argv)[0])