2 # -*- coding: utf-8 -*-
4 # file lyxpreview2bitmap.py
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # with much advice from members of the preview-latex project:
10 # David Kastrup, dak@gnu.org and
11 # Jan-Åke Larsson, jalar@mai.liu.se.
13 # Full author contact details are available in file CREDITS
15 # This script takes a LaTeX file and generates a collection of
16 # png or ppm image files, one per previewed snippet.
19 # * A latex executable;
22 # * pngtoppm (if outputing ppm format images).
24 # preview.sty and dvipng are part of the preview-latex project
25 # http://preview-latex.sourceforge.net/
27 # preview.sty can alternatively be obtained from
28 # CTAN/support/preview-latex/
31 # lyxpreview2bitmap.py png 0lyxpreview.tex 128 000000 faf0e6
33 # This script takes six arguments:
34 # FORMAT: The desired output format. Either 'png' or 'ppm'.
35 # TEXFILE: the name of the .tex file to be converted.
36 # DPI: a scale factor, used to ascertain the resolution of the
37 # generated image which is then passed to gs.
38 # FG_COLOR: the foreground color as a hexadecimal string, eg '000000'.
39 # BG_COLOR: the background color as a hexadecimal string, eg 'faf0e6'.
40 # CONVERTER: the converter (optional). Default is latex.
42 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
43 # if executed successfully, leave in DIR:
44 # * a (possibly large) number of image files with names
46 # * a file BASE.metrics, containing info needed by LyX to position
47 # the images correctly on the screen.
49 import glob, os, re, string, sys
51 from legacy_lyxpreview2ppm import legacy_conversion, \
52 legacy_conversion_step2, legacy_extract_metrics_info, filter_pages
54 from lyxpreview_tools import copyfileobj, error, find_exe, \
55 find_exe_or_terminate, make_texcolor, mkstemp, run_command, warning, \
56 write_metrics_info, join_metrics_and_rename
59 # Pre-compiled regular expressions.
60 latex_file_re = re.compile("\.tex$")
64 return "Usage: %s <format> <latex file> <dpi> <fg color> <bg color>\n"\
65 "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
68 # Returns a list of tuples containing page number and ascent fraction
69 # extracted from dvipng output.
70 # Use write_metrics_info to create the .metrics file with this info
71 def extract_metrics_info(dvipng_stdout):
72 # "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
73 # and glyph numbers from mktexpk. The glyph numbers always match
74 # "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
75 page_re = re.compile("\[([0-9]+)[^]]");
76 metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
83 match = page_re.search(dvipng_stdout, pos)
88 match = metrics_re.search(dvipng_stdout, pos)
93 # Calculate the 'ascent fraction'.
94 descent = string.atof(match.group(1))
95 ascent = string.atof(match.group(2))
98 if ascent >= 0 or descent >= 0:
99 if abs(ascent + descent) > 0.1:
100 frac = ascent / (ascent + descent)
106 results.append((int(page), frac))
107 pos = match.end() + 2
110 error("Failed to extract metrics info from dvipng")
115 def color_pdf(latex_file, bg_color, fg_color):
116 use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)((pdftex|xetex)\]{preview})")
121 if fg_color != "0.000000,0.000000,0.000000":
122 fg = ' \\AtBeginDocument{\\let\\oldpreview\\preview\\renewcommand\\preview{\\oldpreview\\color[rgb]{%s}}}\n' % (fg_color)
126 for line in open(latex_file, 'r').readlines():
127 match = use_preview_pdf_re.match(line)
132 tmp.write(" \\usepackage{color}\n" \
133 " \\pagecolor[rgb]{%s}\n" \
136 % (bg_color, fg, match.group()))
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 color_pdf! Unable to open "%s"' % latex_file)
143 warning(`sys.exc_type` + ',' + `sys.exc_value`)
146 copyfileobj(tmp, open(latex_file,"wb"), 1)
151 def convert_to_ppm_format(pngtopnm, basename):
152 png_file_re = re.compile("\.png$")
154 for png_file in glob.glob("%s*.png" % basename):
155 ppm_file = png_file_re.sub(".ppm", png_file)
157 p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
158 p2p_status, p2p_stdout = run_command(p2p_cmd)
159 if p2p_status != None:
160 error("Unable to convert %s to ppm format" % png_file)
162 ppm = open(ppm_file, 'w')
163 ppm.write(p2p_stdout)
168 # Parse and manipulate the command line arguments.
169 if len(argv) != 6 and len(argv) != 7:
170 error(usage(argv[0]))
172 output_format = string.lower(argv[1])
174 dir, latex_file = os.path.split(argv[2])
178 dpi = string.atoi(argv[3])
179 fg_color = make_texcolor(argv[4], False)
180 bg_color = make_texcolor(argv[5], False)
182 fg_color_gr = make_texcolor(argv[4], True)
183 bg_color_gr = make_texcolor(argv[5], True)
185 # External programs used by the script.
186 path = string.split(os.environ["PATH"], os.pathsep)
190 latex = find_exe_or_terminate(["latex", "pplatex", "platex", "latex2e"], path)
192 # This can go once dvipng becomes widespread.
193 dvipng = find_exe(["dvipng"], path)
195 # The data is input to legacy_conversion in as similar
196 # as possible a manner to that input to the code used in
198 vec = [ argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex ]
199 return legacy_conversion(vec)
202 if output_format == "ppm":
203 pngtopnm = find_exe_or_terminate(["pngtopnm"], path)
205 # Move color information for PDF into the latex file.
206 if not color_pdf(latex_file, bg_color_gr, fg_color_gr):
207 error("Unable to move color info into the latex file")
209 # Compile the latex file.
210 latex_call = '%s "%s"' % (latex, latex_file)
212 latex_status, latex_stdout = run_command(latex_call)
213 if latex_status != None:
214 warning("%s had problems compiling %s" \
215 % (os.path.basename(latex), latex_file))
217 if latex == "xelatex":
218 warning("Using XeTeX")
219 # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
220 return legacy_conversion_step2(latex_file, dpi, output_format)
222 # The dvi output file name
223 dvi_file = latex_file_re.sub(".dvi", latex_file)
226 # FIXME: try with pdflatex
227 if not os.path.isfile(dvi_file):
228 error("No DVI output.")
230 # Check for PostScript specials in the dvi, badly supported by dvipng
231 # This is required for correct rendering of PSTricks and TikZ
232 dv2dt = find_exe_or_terminate(["dv2dt"], path)
233 dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
235 # The output from dv2dt goes to stdout
236 dv2dt_status, dv2dt_output = run_command(dv2dt_call)
237 psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
239 # Parse the dtl file looking for PostScript specials.
240 # Pages using PostScript specials are recorded in ps_pages and then
241 # used to create a different LaTeX file for processing in legacy mode.
246 for line in dv2dt_output.split("\n"):
248 if line.startswith("bop"):
253 if line.startswith("eop") and page_has_ps:
254 # We save in a list all the PostScript pages
255 ps_pages.append(page_index)
257 if psliteral_re.match(line) != None:
258 # Literal PostScript special detected!
263 if len(ps_pages) == page_index:
264 # All pages need PostScript, so directly use the legacy method.
265 vec = [argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex]
266 return legacy_conversion(vec)
267 elif len(ps_pages) > 0:
268 # Don't process Postscript pages with dvipng by selecting the
269 # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
270 pages_parameter = " -pp "
274 # Use page ranges, as a list of pages could exceed command line
275 # maximum length (especially under Win32)
276 for index in xrange(1, page_index + 1):
277 if (not index in ps_pages) and skip:
278 # We were skipping pages but current page shouldn't be skipped.
279 # Add this page to -pp, it could stay alone or become the
281 pages_parameter += str(index)
282 # Save the starting index to avoid things such as "11-11"
284 # We're not skipping anymore
286 elif (index in ps_pages) and (not skip):
287 # We weren't skipping but current page should be skipped
288 if last != index - 1:
289 # If the start index of the range is the previous page
290 # then it's not a range
291 pages_parameter += "-" + str(index - 1)
294 pages_parameter += ","
298 # Remove the trailing separator
299 pages_parameter = pages_parameter.rstrip(",")
300 # We've to manage the case in which the last page is closing a range
301 if (not index in ps_pages) and (not skip) and (last != index):
302 pages_parameter += "-" + str(index)
304 # Run the dvi file through dvipng.
305 dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
306 % (dvipng, dpi, fg_color, bg_color, pages_parameter, dvi_file)
307 dvipng_status, dvipng_stdout = run_command(dvipng_call)
309 if dvipng_status != None:
310 warning("%s failed to generate images from %s ... looking for PDF" \
311 % (os.path.basename(dvipng), dvi_file))
312 # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
313 return legacy_conversion_step2(latex_file, dpi, output_format)
316 if len(ps_pages) > 0:
317 # Some pages require PostScript.
318 # Create a new LaTeX file just for the snippets needing
320 legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
321 filter_pages(latex_file, legacy_latex_file, ps_pages)
323 # Pass the new LaTeX file to the legacy method
324 vec = [ argv[0], latex_file_re.sub("_legacy.tex", argv[2]), \
325 argv[3], argv[1], argv[4], argv[5], latex ]
326 legacy_metrics = legacy_conversion(vec, True)[1]
328 # Now we need to mix metrics data from dvipng and the legacy method
329 metrics_file = latex_file_re.sub(".metrics", latex_file)
330 dvipng_metrics = extract_metrics_info(dvipng_stdout)
332 original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
333 destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
335 # Join metrics from dvipng and legacy, and rename legacy bitmaps
336 join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
337 original_bitmap, destination_bitmap)
340 # Extract metrics info from dvipng_stdout.
341 # In this case we just used dvipng, so no special metrics
342 # handling is needed.
343 metrics_file = latex_file_re.sub(".metrics", latex_file)
344 dvipng_metrics = extract_metrics_info(dvipng_stdout)
346 # Convert images to ppm format if necessary.
347 if output_format == "ppm":
348 convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
350 # Actually create the .metrics file
351 write_metrics_info(dvipng_metrics, metrics_file)
353 return (0, dvipng_metrics)
355 if __name__ == "__main__":
356 exit(main(sys.argv)[0])