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 import getopt, glob, os, re, shutil, string, sys
80 from legacy_lyxpreview2ppm import legacy_conversion_step1
82 from lyxpreview_tools import bibtex_commands, check_latex_log, copyfileobj, \
83 error, filter_pages, find_exe, find_exe_or_terminate, \
84 join_metrics_and_rename, latex_commands, latex_file_re, make_texcolor, \
85 mkstemp, pdflatex_commands, progress, run_command, run_latex, run_tex, \
86 warning, write_metrics_info
91 Usage: %s <options> <input file>
94 --dpi=<res>: Resolution per inch (default: 128)
95 --png, --ppm: Select the output format (default: png)
96 --fg=<color>: Foreground color (default: black, ie '000000')
97 --bg=<color>: Background color (default: white, ie 'ffffff')
98 --latex=<exe>: Specify the executable for latex (default: latex)
99 --bibtex=<exe>: Specify the executable for bibtex (default: bibtex)
100 --lilypond: Preprocess through lilypond-book (default: false)
101 --lilypond-book=<exe>:
102 The executable for lilypond-book (default: lilypond-book)
104 -d, --debug: Show the output from external commands
105 -h, --help: Show this help screen and exit
106 -v, --verbose: Show progress messages
108 The colors are hexadecimal strings, eg 'faf0e6'."""
109 return msg % prog_name
111 # Returns a list of tuples containing page number and ascent fraction
112 # extracted from dvipng output.
113 # Use write_metrics_info to create the .metrics file with this info
114 def extract_metrics_info(dvipng_stdout):
115 # "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
116 # and glyph numbers from mktexpk. The glyph numbers always match
117 # "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
118 page_re = re.compile("\[([0-9]+)[^]]");
119 metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
126 match = page_re.search(dvipng_stdout, pos)
129 page = match.group(1)
131 match = metrics_re.search(dvipng_stdout, pos)
136 # Calculate the 'ascent fraction'.
137 descent = string.atof(match.group(1))
138 ascent = string.atof(match.group(2))
142 # This is an empty image, forbid its display
144 elif ascent >= 0 or descent >= 0:
145 if abs(ascent + descent) > 0.1:
146 frac = ascent / (ascent + descent)
152 results.append((int(page), frac))
153 pos = match.end() + 2
156 error("Failed to extract metrics info from dvipng")
161 def fix_latex_file(latex_file, pdf_output):
162 documentclass_re = re.compile("(\\\\documentclass\[)(1[012]pt,?)(.+)")
163 def_re = re.compile(r"(\\newcommandx|\\global\\long\\def)(\\[a-zA-Z]+)(.+)")
164 usepackage_re = re.compile("\\\\usepackage")
165 userpreamble_re = re.compile("User specified LaTeX commands")
166 enduserpreamble_re = re.compile("\\\\makeatother")
174 for line in open(latex_file, 'r').readlines():
175 match = documentclass_re.match(line)
178 tmp.write("%s%s\n" % (match.group(1), match.group(3)))
181 if not pdf_output and not usepkg:
182 if userpreamble_re.search(line) != None:
184 elif enduserpreamble_re.search(line) != None:
186 if usepackage_re.match(line) != None and in_user_preamble:
189 tmp.write("\\def\\t@a{microtype}\n")
190 tmp.write("\\let\\oldusepkg\\usepackage\n")
191 tmp.write("\\def\\usepackage{\\@ifnextchar[\\@usepkg{\\@usepkg[]}}\n")
192 tmp.write("\\def\\@usepkg[#1]#2{\\@ifnextchar[")
193 tmp.write("{\\@@usepkg[#1]{#2}}{\\@@usepkg[#1]{#2}[]}}\n")
194 tmp.write("\\def\@@usepkg[#1]#2[#3]{\\def\\t@b{#2}")
195 tmp.write("\\ifx\\t@a\\t@b\\else\\oldusepkg[#1]{#2}[#3]\\fi}\n")
199 match = def_re.match(line)
204 macroname = match.group(2)
205 if not macroname in macros:
206 macros.append(macroname)
210 definecmd = match.group(1)
211 if definecmd == "\\global\\long\\def":
215 tmp.write("\\renewcommandx%s%s\n" % (match.group(2), match.group(3)))
218 copyfileobj(tmp, open(latex_file,"wb"), 1)
223 def convert_to_ppm_format(pngtopnm, basename):
224 png_file_re = re.compile("\.png$")
226 for png_file in glob.glob("%s*.png" % basename):
227 ppm_file = png_file_re.sub(".ppm", png_file)
229 p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
230 p2p_status, p2p_stdout = run_command(p2p_cmd)
232 error("Unable to convert %s to ppm format" % png_file)
234 ppm = open(ppm_file, 'w')
235 ppm.write(p2p_stdout)
238 # Returns a tuple of:
239 # ps_pages: list of page indexes of pages containing PS literals
240 # pdf_pages: list of page indexes of pages requiring running pdflatex
241 # page_count: total number of pages
242 # pages_parameter: parameter for dvipng to exclude pages with PostScript/PDF
243 def find_ps_pages(dvi_file):
245 # FIXME: try with pdflatex
246 if not os.path.isfile(dvi_file):
247 error("No DVI output.")
249 # Check for PostScript specials in the dvi, badly supported by dvipng,
250 # and inclusion of PDF/PNG/JPG files.
251 # This is required for correct rendering of PSTricks and TikZ
252 dv2dt = find_exe_or_terminate(["dv2dt"])
253 dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
255 # The output from dv2dt goes to stdout
256 dv2dt_status, dv2dt_output = run_command(dv2dt_call)
257 psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
258 hyperref_re = re.compile("^special[1-4] [0-9]+ 'ps:.*/DEST pdfmark")
259 pdffile_re = re.compile("^special[1-4] [0-9]+ 'PSfile=.*\\.(pdf|png|jpg|jpeg|PDF|PNG|JPG|JPEG)")
261 # Parse the dtl file looking for PostScript specials and pdflatex files.
262 # Pages using PostScript specials or pdflatex files are recorded in
263 # ps_pages or pdf_pages, respectively, and then used to create a
264 # different LaTeX file for processing in legacy mode.
265 # If hyperref is detected, the corresponding page is recorded in pdf_pages.
273 for line in dv2dt_output.split("\n"):
275 if line.startswith("bop"):
281 if line.startswith("eop") and (page_has_ps or page_has_pdf):
282 # We save in a list all the PostScript/PDF pages
284 ps_pages.append(page_index)
286 pdf_pages.append(page_index)
287 ps_or_pdf_pages.append(page_index)
289 if psliteral_re.match(line) != None:
290 # Literal PostScript special detected!
291 # If hyperref is detected, put this page on the pdf pages list
292 if hyperref_re.match(line) != None:
297 elif pdffile_re.match(line) != None:
298 # Inclusion of pdflatex image file detected!
301 # Create the -pp parameter for dvipng
303 if len(ps_or_pdf_pages) > 0 and len(ps_or_pdf_pages) < page_index:
304 # Don't process Postscript/PDF pages with dvipng by selecting the
305 # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
306 pages_parameter = " -pp "
310 # Use page ranges, as a list of pages could exceed command line
311 # maximum length (especially under Win32)
312 for index in xrange(1, page_index + 1):
313 if (not index in ps_or_pdf_pages) and skip:
314 # We were skipping pages but current page shouldn't be skipped.
315 # Add this page to -pp, it could stay alone or become the
317 pages_parameter += str(index)
318 # Save the starting index to avoid things such as "11-11"
320 # We're not skipping anymore
322 elif (index in ps_or_pdf_pages) and (not skip):
323 # We weren't skipping but current page should be skipped
324 if last != index - 1:
325 # If the start index of the range is the previous page
326 # then it's not a range
327 pages_parameter += "-" + str(index - 1)
330 pages_parameter += ","
334 # Remove the trailing separator
335 pages_parameter = pages_parameter.rstrip(",")
336 # We've to manage the case in which the last page is closing a range
337 if (not index in ps_or_pdf_pages) and (not skip) and (last != index):
338 pages_parameter += "-" + str(index)
340 return (ps_pages, pdf_pages, page_index, pages_parameter)
351 output_format = "png"
352 script_name = argv[0]
354 # Parse and manipulate the command line arguments.
356 (opts, args) = getopt.gnu_getopt(argv[1:], "dhv", ["bibtex=", "bg=",
357 "debug", "dpi=", "fg=", "help", "latex=", "lilypond",
358 "lilypond-book=", "png", "ppm", "verbose"])
359 except getopt.GetoptError, err:
360 error("%s\n%s" % (err, usage(script_name)))
363 for opt, val in opts:
364 if opt in ("-h", "--help"):
365 print usage(script_name)
367 elif opt == "--bibtex":
371 elif opt in ("-d", "--debug"):
372 import lyxpreview_tools
373 lyxpreview_tools.debug = True
376 dpi = string.atoi(val)
378 error("Cannot convert %s to an integer value" % val)
381 elif opt == "--latex":
383 elif opt == "--lilypond":
385 elif opt == "--lilypond-book":
386 lilypond_book = [val]
387 elif opt in ("--png", "--ppm"):
388 output_format = opt[2:]
389 elif opt in ("-v", "--verbose"):
390 import lyxpreview_tools
391 lyxpreview_tools.verbose = True
393 # Determine input file
395 err = "A single input file is required, %s given" % (len(args) or "none")
396 error("%s\n%s" % (err, usage(script_name)))
399 dir, latex_file = os.path.split(input_path)
402 progress("Starting %s..." % script_name)
403 progress("Output format: %s" % output_format)
404 progress("Foreground color: %s" % fg_color)
405 progress("Background color: %s" % bg_color)
406 progress("Resolution (dpi): %s" % dpi)
407 progress("File to process: %s" % input_path)
409 # Check for the input file
410 if not os.path.exists(input_path):
411 error('File "%s" not found.' % input_path)
415 fg_color_dvipng = make_texcolor(fg_color, False)
416 bg_color_dvipng = make_texcolor(bg_color, False)
418 # External programs used by the script.
419 latex = find_exe_or_terminate(latex or latex_commands)
420 bibtex = find_exe(bibtex or bibtex_commands)
422 lilypond_book = find_exe_or_terminate(lilypond_book or
423 ["lilypond-book --safe"])
425 # These flavors of latex are known to produce pdf output
426 pdf_output = latex in pdflatex_commands
428 progress("Latex command: %s" % latex)
429 progress("Latex produces pdf output: %s" % pdf_output)
430 progress("Bibtex command: %s" % bibtex)
431 progress("Lilypond-book command: %s" % lilypond_book)
432 progress("Preprocess through lilypond-book: %s" % lilypond)
433 progress("Altering the latex file for font size and colors")
435 # Omit font size specification in latex file and make sure that multiple
436 # defined macros and the microtype package don't cause issues.
437 fix_latex_file(latex_file, pdf_output)
440 progress("Preprocess the latex file through %s" % lilypond_book)
442 lilypond_book += " --pdf"
443 lilypond_book += " --latex-program=%s" % latex.split()[0]
445 # Make a copy of the latex file
446 lytex_file = latex_file_re.sub(".lytex", latex_file)
447 shutil.copyfile(latex_file, lytex_file)
449 # Preprocess the latex file through lilypond-book.
450 lytex_status, lytex_stdout = run_tex(lilypond_book, lytex_file)
453 progress("Using the legacy conversion method (PDF support)")
454 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
455 bg_color, latex, pdf_output)
457 # This can go once dvipng becomes widespread.
458 dvipng = find_exe(["dvipng"])
460 progress("Using the legacy conversion method (dvipng not found)")
461 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
462 bg_color, latex, pdf_output)
464 dv2dt = find_exe(["dv2dt"])
466 progress("Using the legacy conversion method (dv2dt not found)")
467 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
468 bg_color, latex, pdf_output)
471 if output_format == "ppm":
472 pngtopnm = find_exe(["pngtopnm"])
474 progress("Using the legacy conversion method (pngtopnm not found)")
475 return legacy_conversion_step1(latex_file, dpi, output_format,
476 fg_color, bg_color, latex, pdf_output)
478 # Compile the latex file.
480 latex_status, latex_stdout = run_latex(latex, latex_file, bibtex)
482 progress("Will try to recover from %s failure" % latex)
483 error_pages = check_latex_log(latex_file_re.sub(".log", latex_file))
485 # The dvi output file name
486 dvi_file = latex_file_re.sub(".dvi", latex_file)
488 # If there's no DVI output, look for PDF and go to legacy or fail
489 if not os.path.isfile(dvi_file):
490 # No DVI, is there a PDF?
491 pdf_file = latex_file_re.sub(".pdf", latex_file)
492 if os.path.isfile(pdf_file):
493 progress("%s produced a PDF output, fallback to legacy." \
494 % (os.path.basename(latex)))
495 progress("Using the legacy conversion method (PDF support)")
496 return legacy_conversion_step1(latex_file, dpi, output_format,
497 fg_color, bg_color, latex, True)
499 error("No DVI or PDF output. %s failed." \
500 % (os.path.basename(latex)))
502 # Look for PS literals or inclusion of pdflatex files in DVI pages
503 # ps_pages: list of indexes of pages containing PS literals
504 # pdf_pages: list of indexes of pages requiring running pdflatex
505 # page_count: total number of pages
506 # pages_parameter: parameter for dvipng to exclude pages with PostScript
507 (ps_pages, pdf_pages, page_count, pages_parameter) = find_ps_pages(dvi_file)
509 # If all pages need PostScript or pdflatex, directly use the legacy method.
510 if len(ps_pages) == page_count:
511 progress("Using the legacy conversion method (PostScript support)")
512 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
513 bg_color, latex, pdf_output)
514 elif len(pdf_pages) == page_count:
515 progress("Using the legacy conversion method (PDF support)")
516 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
517 bg_color, "pdflatex", True)
519 # Run the dvi file through dvipng.
520 dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
521 % (dvipng, dpi, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
522 dvipng_status, dvipng_stdout = run_command(dvipng_call)
525 warning("%s failed to generate images from %s... fallback to legacy method" \
526 % (os.path.basename(dvipng), dvi_file))
527 progress("Using the legacy conversion method (dvipng failed)")
528 return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
529 bg_color, latex, pdf_output)
531 # Extract metrics info from dvipng_stdout.
532 metrics_file = latex_file_re.sub(".metrics", latex_file)
533 dvipng_metrics = extract_metrics_info(dvipng_stdout)
535 # If some pages require PostScript pass them to legacy method
536 if len(ps_pages) > 0:
537 # Create a new LaTeX file just for the snippets needing
539 legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
540 filter_pages(latex_file, legacy_latex_file, ps_pages)
542 # Pass the new LaTeX file to the legacy method
543 progress("Pages %s include postscript specials" % ps_pages)
544 progress("Using the legacy conversion method (PostScript support)")
545 legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
546 dpi, output_format, fg_color, bg_color, latex, pdf_output, True)
548 # Now we need to mix metrics data from dvipng and the legacy method
549 original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
550 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
552 # Join metrics from dvipng and legacy, and rename legacy bitmaps
553 join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
554 original_bitmap, destination_bitmap)
556 # If some pages require running pdflatex pass them to legacy method
557 if len(pdf_pages) > 0:
558 # Create a new LaTeX file just for the snippets needing
560 legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
561 filter_pages(latex_file, legacy_latex_file, pdf_pages)
563 # Pass the new LaTeX file to the legacy method
564 progress("Pages %s require processing with pdflatex" % pdf_pages)
565 progress("Using the legacy conversion method (PDF support)")
566 legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
567 dpi, output_format, fg_color, bg_color, "pdflatex", True, True)
569 # Now we need to mix metrics data from dvipng and the legacy method
570 original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
571 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
573 # Join metrics from dvipng and legacy, and rename legacy bitmaps
574 join_metrics_and_rename(dvipng_metrics, legacy_metrics, pdf_pages,
575 original_bitmap, destination_bitmap)
577 # Invalidate metrics for pages that produced errors
578 if len(error_pages) > 0:
580 for index in error_pages:
581 if index not in ps_pages and index not in pdf_pages:
582 dvipng_metrics.pop(index - 1)
583 dvipng_metrics.insert(index - 1, (index, -1.0))
586 warning("Failed to produce %d preview snippet(s)" % error_count)
588 # Convert images to ppm format if necessary.
589 if output_format == "ppm":
590 convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
592 # Actually create the .metrics file
593 write_metrics_info(dvipng_metrics, metrics_file)
595 return (0, dvipng_metrics)
597 if __name__ == "__main__":
598 sys.exit(main(sys.argv)[0])