1 # -*- coding: utf-8 -*-
3 # file lyxpreview2bitmap.py
4 # This file is part of LyX, the document processor.
5 # Licence details can be found in the file COPYING.
8 # with much advice from members of the preview-latex project:
9 # David Kastrup, dak@gnu.org and
10 # Jan-Åke Larsson, jalar@mai.liu.se.
12 # Full author contact details are available in file CREDITS
14 # This script takes a LaTeX file and generates a collection of
15 # png or ppm image files, one per previewed snippet.
18 # * python 2.4 or later (subprocess module);
19 # * A latex executable;
23 # * pngtoppm (if outputing ppm format images).
25 # preview.sty and dvipng are part of the preview-latex project
26 # http://preview-latex.sourceforge.net/
28 # preview.sty can alternatively be obtained from
29 # CTAN/support/preview-latex/
32 # lyxpreview2bitmap.py --bg=faf0e6 0lyxpreview.tex
34 # This script takes one obligatory argument:
36 # <input file>: The name of the .tex file to be converted.
38 # and these optional arguments:
40 # --png, --ppm: The desired output format. Either 'png' or 'ppm'.
41 # --dpi=<res>: A scale factor, used to ascertain the resolution of the
42 # generated image which is then passed to gs.
43 # --fg=<color>: The foreground color as a hexadecimal string, eg '000000'.
44 # --bg=<color>: The background color as a hexadecimal string, eg 'faf0e6'.
45 # --latex=<exe>: The converter for latex files. Default is latex.
46 # --bibtex=<exe>: The converter for bibtex files. Default is bibtex.
47 # --lilypond: Preprocess through lilypond-book. Default is false.
48 # --lilypond-book=<exe>:
49 # The converter for lytex files. Default is lilypond-book.
51 # -d, --debug Show the output from external commands.
52 # -h, --help Show an help screen and exit.
53 # -v, --verbose Show progress messages.
55 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
56 # if executed successfully, leave in DIR:
57 # * a (possibly large) number of image files with names
59 # * a file BASE.metrics, containing info needed by LyX to position
60 # the images correctly on the screen.
62 # What does this script do?
63 # 1) Call latex/pdflatex/xelatex/whatever (CONVERTER parameter)
64 # 2) If the output is a PDF fallback to legacy
65 # 3) Otherwise check each page of the DVI (with dv2dt) looking for
66 # PostScript literals, not well supported by dvipng. Pages
67 # containing them are passed to the legacy method in a new LaTeX file.
68 # 4) Call dvipng on the pages without PS literals
69 # 5) Join metrics info coming from both methods (legacy and dvipng)
70 # and write them to file
72 # dvipng is fast but gives problem in several cases, like with
73 # PSTricks, TikZ and other packages using PostScript literals
74 # for all these cases the legacy route is taken (step 3).
75 # Moreover dvipng can't work with PDF files, so, if the CONVERTER
76 # paramter is pdflatex we have to fallback to legacy route (step 2).
78 from __future__ import print_function
80 import getopt, glob, os, re, shutil, sys
82 from legacy_lyxpreview2ppm import extract_resolution, legacy_conversion_step1
84 from lyxpreview_tools import bibtex_commands, check_latex_log, copyfileobj, \
85 error, filter_pages, find_exe, find_exe_or_terminate, \
86 join_metrics_and_rename, latex_commands, latex_file_re, make_texcolor, \
87 mkstemp, pdflatex_commands, progress, run_command, run_latex, run_tex, \
88 warning, write_metrics_info
93 Usage: %s <options> <input file>
96 --dpi=<res>: Resolution per inch (default: 128)
97 --png, --ppm: Select the output format (default: png)
98 --fg=<color>: Foreground color (default: black, ie '000000')
99 --bg=<color>: Background color (default: white, ie 'ffffff')
100 --latex=<exe>: Specify the executable for latex (default: latex)
101 --bibtex=<exe>: Specify the executable for bibtex (default: bibtex)
102 --lilypond: Preprocess through lilypond-book (default: false)
103 --lilypond-book=<exe>:
104 The executable for lilypond-book (default: lilypond-book)
106 -d, --debug: Show the output from external commands
107 -h, --help: Show this help screen and exit
108 -v, --verbose: Show progress messages
110 The colors are hexadecimal strings, eg 'faf0e6'."""
111 return msg % prog_name
113 # Returns a list of tuples containing page number and ascent fraction
114 # extracted from dvipng output.
115 # Use write_metrics_info to create the .metrics file with this info
116 def extract_metrics_info(dvipng_stdout):
117 # "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
118 # and glyph numbers from mktexpk. The glyph numbers always match
119 # "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
120 page_re = re.compile("\[([0-9]+)[^]]");
121 metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
128 match = page_re.search(dvipng_stdout, pos)
131 page = match.group(1)
133 match = metrics_re.search(dvipng_stdout, pos)
138 # Calculate the 'ascent fraction'.
139 descent = float(match.group(1))
140 ascent = float(match.group(2))
144 # This is an empty image, forbid its display
146 elif ascent >= 0 or descent >= 0:
147 if abs(ascent + descent) > 0.1:
148 frac = ascent / (ascent + descent)
154 results.append((int(page), frac))
155 pos = match.end() + 2
158 error("Failed to extract metrics info from dvipng")
163 def fix_latex_file(latex_file, pdf_output):
164 # python 2 does not allow to declare a string as raw byte so we double
165 # the backslashes and remove the r preffix
166 def_re = re.compile(rb"(\\\\newcommandx|\\\\global\\\\long\\\\def)(\\\\[a-zA-Z]+)")
172 for line in open(latex_file, 'rb').readlines():
173 if not pdf_output and line.startswith(b"\\documentclass"):
175 line += b"\\PassOptionsToPackage{draft}{microtype}\n"
177 match = def_re.match(line)
179 macroname = match.group(2)
180 if macroname in macros:
181 definecmd = match.group(1)
182 if definecmd == b"\\newcommandx":
184 line = line.replace(definecmd, b"\\renewcommandx")
186 macros.append(macroname)
190 copyfileobj(tmp, open(latex_file,"wb"), 1)
195 def convert_to_ppm_format(pngtopnm, basename):
196 png_file_re = re.compile("\.png$")
198 for png_file in glob.glob("%s*.png" % basename):
199 ppm_file = png_file_re.sub(".ppm", png_file)
201 p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
202 p2p_status, p2p_stdout = run_command(p2p_cmd)
204 error("Unable to convert %s to ppm format" % png_file)
206 ppm = open(ppm_file, 'w')
207 ppm.write(p2p_stdout)
210 # Returns a tuple of:
211 # ps_pages: list of page indexes of pages containing PS literals
212 # pdf_pages: list of page indexes of pages requiring running pdflatex
213 # page_count: total number of pages
214 # pages_parameter: parameter for dvipng to exclude pages with PostScript/PDF
215 def find_ps_pages(dvi_file):
217 # FIXME: try with pdflatex
218 if not os.path.isfile(dvi_file):
219 error("No DVI output.")
221 # Check for PostScript specials in the dvi, badly supported by dvipng,
222 # and inclusion of PDF/PNG/JPG files.
223 # This is required for correct rendering of PSTricks and TikZ
224 dv2dt = find_exe_or_terminate(["dv2dt"])
225 dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
227 # The output from dv2dt goes to stdout
228 dv2dt_status, dv2dt_output = run_command(dv2dt_call)
229 psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
230 hyperref_re = re.compile("^special[1-4] [0-9]+ 'ps:.*/DEST pdfmark")
231 pdffile_re = re.compile("^special[1-4] [0-9]+ 'PSfile=.*\\.(pdf|png|jpg|jpeg|PDF|PNG|JPG|JPEG)")
233 # Parse the dtl file looking for PostScript specials and pdflatex files.
234 # Pages using PostScript specials or pdflatex files are recorded in
235 # ps_pages or pdf_pages, respectively, and then used to create a
236 # different LaTeX file for processing in legacy mode.
237 # If hyperref is detected, the corresponding page is recorded in pdf_pages.
245 for line in dv2dt_output.split("\n"):
247 if line.startswith("bop"):
253 if line.startswith("eop") and (page_has_ps or page_has_pdf):
254 # We save in a list all the PostScript/PDF pages
256 ps_pages.append(page_index)
258 pdf_pages.append(page_index)
259 ps_or_pdf_pages.append(page_index)
261 if psliteral_re.match(line) != None:
262 # Literal PostScript special detected!
263 # If hyperref is detected, put this page on the pdf pages list
264 if hyperref_re.match(line) != None:
269 elif pdffile_re.match(line) != None:
270 # Inclusion of pdflatex image file detected!
273 # Create the -pp parameter for dvipng
275 if len(ps_or_pdf_pages) > 0 and len(ps_or_pdf_pages) < page_index:
276 # Don't process Postscript/PDF pages with dvipng by selecting the
277 # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
278 pages_parameter = " -pp "
282 # Use page ranges, as a list of pages could exceed command line
283 # maximum length (especially under Win32)
284 for index in xrange(1, page_index + 1):
285 if (not index in ps_or_pdf_pages) and skip:
286 # We were skipping pages but current page shouldn't be skipped.
287 # Add this page to -pp, it could stay alone or become the
289 pages_parameter += str(index)
290 # Save the starting index to avoid things such as "11-11"
292 # We're not skipping anymore
294 elif (index in ps_or_pdf_pages) and (not skip):
295 # We weren't skipping but current page should be skipped
296 if last != index - 1:
297 # If the start index of the range is the previous page
298 # then it's not a range
299 pages_parameter += "-" + str(index - 1)
302 pages_parameter += ","
306 # Remove the trailing separator
307 pages_parameter = pages_parameter.rstrip(",")
308 # We've to manage the case in which the last page is closing a range
309 if (not index in ps_or_pdf_pages) and (not skip) and (last != index):
310 pages_parameter += "-" + str(index)
312 return (ps_pages, pdf_pages, page_index, pages_parameter)
323 output_format = "png"
324 script_name = argv[0]
326 # Parse and manipulate the command line arguments.
328 (opts, args) = getopt.gnu_getopt(argv[1:], "dhv", ["bibtex=", "bg=",
329 "debug", "dpi=", "fg=", "help", "latex=", "lilypond",
330 "lilypond-book=", "png", "ppm", "verbose"])
331 except getopt.GetoptError as err:
332 error("%s\n%s" % (err, usage(script_name)))
335 for opt, val in opts:
336 if opt in ("-h", "--help"):
337 print(usage(script_name))
339 elif opt == "--bibtex":
343 elif opt in ("-d", "--debug"):
344 import lyxpreview_tools
345 lyxpreview_tools.debug = True
350 error("Cannot convert %s to an integer value" % val)
353 elif opt == "--latex":
355 elif opt == "--lilypond":
357 elif opt == "--lilypond-book":
358 lilypond_book = [val]
359 elif opt in ("--png", "--ppm"):
360 output_format = opt[2:]
361 elif opt in ("-v", "--verbose"):
362 import lyxpreview_tools
363 lyxpreview_tools.verbose = True
365 # Determine input file
367 err = "A single input file is required, %s given" % (len(args) or "none")
368 error("%s\n%s" % (err, usage(script_name)))
371 dir, latex_file = os.path.split(input_path)
374 progress("Starting %s..." % script_name)
375 progress("Output format: %s" % output_format)
376 progress("Foreground color: %s" % fg_color)
377 progress("Background color: %s" % bg_color)
378 progress("Resolution (dpi): %s" % dpi)
379 progress("File to process: %s" % input_path)
381 # Check for the input file
382 if not os.path.exists(input_path):
383 error('File "%s" not found.' % input_path)
387 fg_color_dvipng = make_texcolor(fg_color, False)
388 bg_color_dvipng = make_texcolor(bg_color, False)
390 # External programs used by the script.
391 latex = find_exe_or_terminate(latex or latex_commands)
392 bibtex = find_exe(bibtex or bibtex_commands)
394 lilypond_book = find_exe_or_terminate(lilypond_book or
395 ["lilypond-book --safe"])
397 # These flavors of latex are known to produce pdf output
398 pdf_output = latex in pdflatex_commands
400 progress("Latex command: %s" % latex)
401 progress("Latex produces pdf output: %s" % pdf_output)
402 progress("Bibtex command: %s" % bibtex)
403 progress("Lilypond-book command: %s" % lilypond_book)
404 progress("Preprocess through lilypond-book: %s" % lilypond)
405 progress("Altering the latex file for font size and colors")
407 # Make sure that multiple defined macros and the microtype package
408 # don't cause issues in the latex file.
409 fix_latex_file(latex_file, pdf_output)
412 progress("Preprocess the latex file through %s" % lilypond_book)
414 lilypond_book += " --pdf"
415 lilypond_book += " --latex-program=%s" % latex.split()[0]
417 # Make a copy of the latex file
418 lytex_file = latex_file_re.sub(".lytex", latex_file)
419 shutil.copyfile(latex_file, lytex_file)
421 # Preprocess the latex file through lilypond-book.
422 lytex_status, lytex_stdout = run_tex(lilypond_book, lytex_file)
425 progress("Using the legacy conversion method (PDF support)")
426 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
427 bg_color, latex, pdf_output)
429 # This can go once dvipng becomes widespread.
430 dvipng = find_exe(["dvipng"])
432 progress("Using the legacy conversion method (dvipng not found)")
433 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
434 bg_color, latex, pdf_output)
436 dv2dt = find_exe(["dv2dt"])
438 progress("Using the legacy conversion method (dv2dt not found)")
439 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
440 bg_color, latex, pdf_output)
443 if output_format == "ppm":
444 pngtopnm = find_exe(["pngtopnm"])
446 progress("Using the legacy conversion method (pngtopnm not found)")
447 return legacy_conversion_step1(latex_file, dpi, output_format,
448 fg_color, bg_color, latex, pdf_output)
450 # Compile the latex file.
452 latex_status, latex_stdout = run_latex(latex, latex_file, bibtex)
453 latex_log = latex_file_re.sub(".log", latex_file)
455 progress("Will try to recover from %s failure" % latex)
456 error_pages = check_latex_log(latex_log)
458 # The dvi output file name
459 dvi_file = latex_file_re.sub(".dvi", latex_file)
461 # If there's no DVI output, look for PDF and go to legacy or fail
462 if not os.path.isfile(dvi_file):
463 # No DVI, is there a PDF?
464 pdf_file = latex_file_re.sub(".pdf", latex_file)
465 if os.path.isfile(pdf_file):
466 progress("%s produced a PDF output, fallback to legacy." \
467 % (os.path.basename(latex)))
468 progress("Using the legacy conversion method (PDF support)")
469 return legacy_conversion_step1(latex_file, dpi, output_format,
470 fg_color, bg_color, latex, True)
472 error("No DVI or PDF output. %s failed." \
473 % (os.path.basename(latex)))
475 # Look for PS literals or inclusion of pdflatex files in DVI pages
476 # ps_pages: list of indexes of pages containing PS literals
477 # pdf_pages: list of indexes of pages requiring running pdflatex
478 # page_count: total number of pages
479 # pages_parameter: parameter for dvipng to exclude pages with PostScript
480 (ps_pages, pdf_pages, page_count, pages_parameter) = find_ps_pages(dvi_file)
482 # If all pages need PostScript or pdflatex, directly use the legacy method.
483 if len(ps_pages) == page_count:
484 progress("Using the legacy conversion method (PostScript support)")
485 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
486 bg_color, latex, pdf_output)
487 elif len(pdf_pages) == page_count:
488 progress("Using the legacy conversion method (PDF support)")
489 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
490 bg_color, "pdflatex", True)
492 # Retrieve resolution
493 resolution = extract_resolution(latex_log, dpi)
495 # Run the dvi file through dvipng.
496 dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
497 % (dvipng, resolution, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
498 dvipng_status, dvipng_stdout = run_command(dvipng_call)
501 warning("%s failed to generate images from %s... fallback to legacy method" \
502 % (os.path.basename(dvipng), dvi_file))
503 progress("Using the legacy conversion method (dvipng failed)")
504 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
505 bg_color, latex, pdf_output)
507 # Extract metrics info from dvipng_stdout.
508 metrics_file = latex_file_re.sub(".metrics", latex_file)
509 dvipng_metrics = extract_metrics_info(dvipng_stdout)
511 # If some pages require PostScript pass them to legacy method
512 if len(ps_pages) > 0:
513 # Create a new LaTeX file just for the snippets needing
515 legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
516 filter_pages(latex_file, legacy_latex_file, ps_pages)
518 # Pass the new LaTeX file to the legacy method
519 progress("Pages %s include postscript specials" % ps_pages)
520 progress("Using the legacy conversion method (PostScript support)")
521 legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
522 dpi, output_format, fg_color, bg_color, latex, pdf_output, True)
524 # Now we need to mix metrics data from dvipng and the legacy method
525 original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
526 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
528 # Join metrics from dvipng and legacy, and rename legacy bitmaps
529 join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
530 original_bitmap, destination_bitmap)
532 # If some pages require running pdflatex pass them to legacy method
533 if len(pdf_pages) > 0:
534 # Create a new LaTeX file just for the snippets needing
536 legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
537 filter_pages(latex_file, legacy_latex_file, pdf_pages)
539 # Pass the new LaTeX file to the legacy method
540 progress("Pages %s require processing with pdflatex" % pdf_pages)
541 progress("Using the legacy conversion method (PDF support)")
542 legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
543 dpi, output_format, fg_color, bg_color, "pdflatex", True, True)
545 # Now we need to mix metrics data from dvipng and the legacy method
546 original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
547 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
549 # Join metrics from dvipng and legacy, and rename legacy bitmaps
550 join_metrics_and_rename(dvipng_metrics, legacy_metrics, pdf_pages,
551 original_bitmap, destination_bitmap)
553 # Invalidate metrics for pages that produced errors
554 if len(error_pages) > 0:
556 for index in error_pages:
557 if index not in ps_pages and index not in pdf_pages:
558 dvipng_metrics.pop(index - 1)
559 dvipng_metrics.insert(index - 1, (index, -1.0))
562 warning("Failed to produce %d preview snippet(s)" % error_count)
564 # Convert images to ppm format if necessary.
565 if output_format == "ppm":
566 convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
568 # Actually create the .metrics file
569 write_metrics_info(dvipng_metrics, metrics_file)
571 return (0, dvipng_metrics)
573 if __name__ == "__main__":
574 sys.exit(main(sys.argv)[0])