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 # 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
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 # * A latex executable;
43 # * pnmcrop (optional).
45 # preview.sty is part of the preview-latex project
46 # http://preview-latex.sourceforge.net/
47 # Alternatively, it can be obtained from
48 # CTAN/support/preview-latex/
50 # The script uses the deprecated dvi->ps->ppm conversion route.
51 # If possible, please grab 'dvipng'; it's faster and more robust.
52 # If you have it then this script will not be invoked by
53 # lyxpreview2bitmap.py.
54 # Warning: this legacy support will be removed one day...
56 import glob, os, pipes, re, string, sys
58 from lyxpreview_tools import copyfileobj, error, find_exe, \
59 find_exe_or_terminate, mkstemp, run_command
61 # Pre-compiled regular expression.
62 latex_file_re = re.compile("\.tex$")
66 return "Usage: %s <latex file> <dpi> ppm <fg color> <bg color>\n"\
67 "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
71 def extract_metrics_info(log_file, metrics_file):
72 metrics = open(metrics_file, 'w')
74 log_re = re.compile("Preview: ([ST])")
75 data_re = re.compile("(-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)")
82 for line in open(log_file, 'r').readlines():
83 match = log_re.match(line)
87 snippet = (match.group(1) == 'S')
89 match = data_re.search(line)
91 error("Unexpected data in %s\n%s" % (log_file, line))
94 ascent = string.atoi(match.group(2))
95 descent = string.atoi(match.group(3))
98 if ascent >= 0 and descent >= 0:
99 ascent = float(ascent) + tp_ascent
100 descent = float(descent) - tp_descent
102 if abs(ascent + descent) > 0.1:
103 frac = ascent / (ascent + descent)
106 if frac < 0 or frac > 1:
109 metrics.write("Snippet %s %f\n" % (match.group(1), frac))
112 tp_descent = string.atof(match.group(2))
113 tp_ascent = string.atof(match.group(4))
116 # Unable to open the file, but do nothing here because
117 # the calling function will act on the value of 'success'.
118 warning('Warning in extract_metrics_info! Unable to open "%s"' % log_file)
119 warning(`sys.exc_type` + ',' + `sys.exc_value`)
124 def extract_resolution(log_file, dpi):
125 fontsize_re = re.compile("Preview: Fontsize")
126 magnification_re = re.compile("Preview: Magnification")
127 extract_decimal_re = re.compile("([0-9\.]+)")
128 extract_integer_re = re.compile("([0-9]+)")
131 found_magnification = 0
134 magnification = 1000.0
138 for line in open(log_file, 'r').readlines():
139 if found_fontsize and found_magnification:
142 if not found_fontsize:
143 match = fontsize_re.match(line)
145 match = extract_decimal_re.search(line)
147 error("Unable to parse: %s" % line)
148 fontsize = string.atof(match.group(1))
152 if not found_magnification:
153 match = magnification_re.match(line)
155 match = extract_integer_re.search(line)
157 error("Unable to parse: %s" % line)
158 magnification = string.atof(match.group(1))
159 found_magnification = 1
163 warning('Warning in extract_resolution! Unable to open "%s"' % log_file)
164 warning(`sys.exc_type` + ',' + `sys.exc_value`)
166 # This is safe because both fontsize and magnification have
167 # non-zero default values.
168 return dpi * (10.0 / fontsize) * (1000.0 / magnification)
171 def legacy_latex_file(latex_file, fg_color, bg_color):
172 use_preview_re = re.compile("(\\\\usepackage\[[^]]+)(\]{preview})")
178 for line in open(latex_file, 'r').readlines():
179 match = use_preview_re.match(line)
185 tmp.write("%s,dvips,tightpage%s\n\n" \
186 "\\AtBeginDocument{\\AtBeginDvi{%%\n" \
187 "\\special{!userdict begin/bop-hook{//bop-hook exec\n" \
188 "<%s%s>{255 div}forall setrgbcolor\n" \
189 "clippath fill setrgbcolor}bind def end}}}\n" \
190 % (match.group(1), match.group(2), fg_color, bg_color))
193 # Unable to open the file, but do nothing here because
194 # the calling function will act on the value of 'success'.
195 warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file)
196 warning(`sys.exc_type` + ',' + `sys.exc_value`)
199 copyfileobj(tmp, open(latex_file,"wb"), 1)
204 def crop_files(pnmcrop, basename):
206 t.append('%s -left' % pnmcrop, '--')
207 t.append('%s -right' % pnmcrop, '--')
209 for file in glob.glob("%s*.ppm" % basename):
211 new = t.open(file, "r")
212 copyfileobj(new, tmp)
214 copyfileobj(tmp, open(file,"wb"), 1)
217 def legacy_conversion(argv):
218 # Parse and manipulate the command line arguments.
220 error(usage(argv[0]))
222 dir, latex_file = os.path.split(argv[1])
226 dpi = string.atoi(argv[2])
228 output_format = argv[3]
229 if output_format != "ppm":
230 error("This script will generate ppm format images only.")
235 # External programs used by the script.
236 path = string.split(os.environ["PATH"], os.pathsep)
237 latex = find_exe_or_terminate(["pplatex", "platex", "latex2e", "latex"], path)
238 dvips = find_exe_or_terminate(["dvips"], path)
239 gs = find_exe_or_terminate(["gswin32c", "gs"], path)
240 pnmcrop = find_exe(["pnmcrop"], path)
242 # Move color information into the latex file.
243 if not legacy_latex_file(latex_file, fg_color, bg_color):
244 error("Unable to move color info into the latex file")
246 # Compile the latex file.
247 latex_call = '%s "%s"' % (latex, latex_file)
249 latex_status, latex_stdout = run_command(latex_call)
250 if latex_status != None:
251 error("%s failed to compile %s" \
252 % (os.path.basename(latex), latex_file))
254 # Run the dvi file through dvips.
255 dvi_file = latex_file_re.sub(".dvi", latex_file)
256 ps_file = latex_file_re.sub(".ps", latex_file)
258 dvips_call = '%s -o "%s" "%s"' % (dvips, ps_file, dvi_file)
260 dvips_status, dvips_stdout = run_command(dvips_call)
261 if dvips_status != None:
262 error("Failed: %s %s" % (os.path.basename(dvips), dvi_file))
264 # Extract resolution data for gs from the log file.
265 log_file = latex_file_re.sub(".log", latex_file)
266 resolution = extract_resolution(log_file, dpi)
268 # Older versions of gs have problems with a large degree of
269 # anti-aliasing at high resolutions
274 # Generate the bitmap images
275 gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=pnmraw ' \
276 '-sOutputFile="%s%%d.ppm" ' \
277 '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
279 % (gs, latex_file_re.sub("", latex_file), \
280 alpha, alpha, resolution, ps_file)
282 gs_status, gs_stdout = run_command(gs_call)
283 if gs_status != None:
284 error("Failed: %s %s" % (os.path.basename(gs), ps_file))
288 crop_files(pnmcrop, latex_file_re.sub("", latex_file))
290 # Extract metrics info from the log file.
291 metrics_file = latex_file_re.sub(".metrics", latex_file)
292 if not extract_metrics_info(log_file, metrics_file):
293 error("Failed to extract metrics info from %s" % log_file)
298 if __name__ == "__main__":
299 legacy_conversion(sys.argv)