lib/scripts/lyxpreview2bitmap.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file lyxpreview2bitmap.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Angus Leeming
   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.
  12
  13 # Full author contact details are available in file CREDITS
  14
  15 # This script takes a LaTeX file and generates a collection of
  16 # png or ppm image files, one per previewed snippet.
  17
  18 # Pre-requisites:
  19 # * A latex executable;
  20 # * preview.sty;
  21 # * dvipng;
  22 # * dv2dt;
  23 # * pngtoppm (if outputing ppm format images).
  24
  25 # preview.sty and dvipng are part of the preview-latex project
  26 # http://preview-latex.sourceforge.net/
  27
  28 # preview.sty can alternatively be obtained from
  29 # CTAN/support/preview-latex/
  30
  31 # Example usage:
  32 # lyxpreview2bitmap.py png 0lyxpreview.tex 128 000000 faf0e6
  33
  34 # This script takes six arguments:
  35 # FORMAT:   The desired output format. Either 'png' or 'ppm'.
  36 # TEXFILE:  the name of the .tex file to be converted.
  37 # DPI:      a scale factor, used to ascertain the resolution of the
  38 #           generated image which is then passed to gs.
  39 # FG_COLOR: the foreground color as a hexadecimal string, eg '000000'.
  40 # BG_COLOR: the background color as a hexadecimal string, eg 'faf0e6'.
  41 # CONVERTER: the converter (optional). Default is latex.
  42
  43 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
  44 # if executed successfully, leave in DIR:
  45 # * a (possibly large) number of image files with names
  46 #   like BASE[0-9]+.png
  47 # * a file BASE.metrics, containing info needed by LyX to position
  48 #   the images correctly on the screen.
  49
  50 # What does this script do?
  51 # 1) Call latex/pdflatex/xelatex/whatever (CONVERTER parameter)
  52 # 2) If the output is a PDF fallback to legacy
  53 # 3) Otherwise check each page of the DVI (with dv2dt) looking for
  54 #    PostScript literals, not well supported by dvipng. Pages
  55 #    containing them are passed to the legacy method in a new LaTeX file.
  56 # 4) Call dvipng on the pages without PS literals
  57 # 5) Join metrics info coming from both methods (legacy and dvipng)
  58 #    and write them to file
  59
  60 # dvipng is fast but gives problem in several cases, like with
  61 # PSTricks, TikZ and other packages using PostScript literals
  62 # for all these cases the legacy route is taken (step 3).
  63 # Moreover dvipng can't work with PDF files, so, if the CONVERTER
  64 # paramter is pdflatex we have to fallback to legacy route (step 2).
  65
  66 import glob, os, re, string, sys
  67
  68 from legacy_lyxpreview2ppm import legacy_conversion, \
  69      legacy_conversion_step2, legacy_extract_metrics_info, filter_pages
  70
  71 from lyxpreview_tools import copyfileobj, error, find_exe, \
  72      find_exe_or_terminate, make_texcolor, mkstemp, run_command, warning, \
  73      write_metrics_info, join_metrics_and_rename
  74
  75
  76 # Pre-compiled regular expressions.
  77 latex_file_re = re.compile("\.tex$")
  78
  79 # PATH environment variable
  80 path  = string.split(os.environ["PATH"], os.pathsep)
  81
  82 def usage(prog_name):
  83     return "Usage: %s <format> <latex file> <dpi> <fg color> <bg color>\n"\
  84            "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
  85            % prog_name
  86
  87 # Returns a list of tuples containing page number and ascent fraction
  88 # extracted from dvipng output.
  89 # Use write_metrics_info to create the .metrics file with this info
  90 def extract_metrics_info(dvipng_stdout):
  91     # "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
  92     # and glyph numbers from mktexpk. The glyph numbers always match
  93     # "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
  94     page_re = re.compile("\[([0-9]+)[^]]");
  95     metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
  96
  97     success = 0
  98     page = ""
  99     pos = 0
 100     results = []
 101     while 1:
 102         match = page_re.search(dvipng_stdout, pos)
 103         if match == None:
 104             break
 105         page = match.group(1)
 106         pos = match.end()
 107         match = metrics_re.search(dvipng_stdout, pos)
 108         if match == None:
 109             break
 110         success = 1
 111
 112         # Calculate the 'ascent fraction'.
 113         descent = string.atof(match.group(1))
 114         ascent  = string.atof(match.group(2))
 115
 116         frac = 0.5
 117         if ascent >= 0 or descent >= 0:
 118             if abs(ascent + descent) > 0.1:
 119                 frac = ascent / (ascent + descent)
 120
 121             # Sanity check
 122             if frac < 0:
 123                 frac = 0.5
 124
 125         results.append((int(page), frac))
 126         pos = match.end() + 2
 127
 128     if success == 0:
 129         error("Failed to extract metrics info from dvipng")
 130
 131     return results
 132
 133
 134 def color_pdf(latex_file, bg_color, fg_color):
 135     use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)((pdftex|xetex)\]{preview})")
 136
 137     tmp = mkstemp()
 138
 139     fg = ""
 140     if fg_color != "0.000000,0.000000,0.000000":
 141         fg = '  \\AtBeginDocument{\\let\\oldpreview\\preview\\renewcommand\\preview{\\oldpreview\\color[rgb]{%s}}}\n' % (fg_color)
 142
 143     success = 0
 144     try:
 145         for line in open(latex_file, 'r').readlines():
 146             match = use_preview_pdf_re.match(line)
 147             if match == None:
 148                 tmp.write(line)
 149                 continue
 150             success = 1
 151             tmp.write("  \\usepackage{color}\n" \
 152                   "  \\pagecolor[rgb]{%s}\n" \
 153                   "%s" \
 154                   "%s\n" \
 155                   % (bg_color, fg, match.group()))
 156             continue
 157
 158     except:
 159         # Unable to open the file, but do nothing here because
 160         # the calling function will act on the value of 'success'.
 161         warning('Warning in color_pdf! Unable to open "%s"' % latex_file)
 162         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 163
 164     if success:
 165         copyfileobj(tmp, open(latex_file,"wb"), 1)
 166
 167     return success
 168
 169
 170 def convert_to_ppm_format(pngtopnm, basename):
 171     png_file_re = re.compile("\.png$")
 172
 173     for png_file in glob.glob("%s*.png" % basename):
 174         ppm_file = png_file_re.sub(".ppm", png_file)
 175
 176         p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
 177         p2p_status, p2p_stdout = run_command(p2p_cmd)
 178         if p2p_status != None:
 179             error("Unable to convert %s to ppm format" % png_file)
 180
 181         ppm = open(ppm_file, 'w')
 182         ppm.write(p2p_stdout)
 183         os.remove(png_file)
 184
 185 # Returns a tuple of:
 186 # ps_pages: list of page indexes of pages containing PS literals
 187 # page_count: total number of pages
 188 # pages_parameter: parameter for dvipng to exclude pages with PostScript
 189 def find_ps_pages(dvi_file):
 190     # latex failed
 191     # FIXME: try with pdflatex
 192     if not os.path.isfile(dvi_file):
 193         error("No DVI output.")
 194
 195     # Check for PostScript specials in the dvi, badly supported by dvipng
 196     # This is required for correct rendering of PSTricks and TikZ
 197     dv2dt = find_exe_or_terminate(["dv2dt"], path)
 198     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
 199
 200     # The output from dv2dt goes to stdout
 201     dv2dt_status, dv2dt_output = run_command(dv2dt_call)
 202     psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
 203
 204     # Parse the dtl file looking for PostScript specials.
 205     # Pages using PostScript specials are recorded in ps_pages and then
 206     # used to create a different LaTeX file for processing in legacy mode.
 207     page_has_ps = False
 208     page_index = 0
 209     ps_pages = []
 210
 211     for line in dv2dt_output.split("\n"):
 212         # New page
 213         if line.startswith("bop"):
 214             page_has_ps = False
 215             page_index += 1
 216
 217         # End of page
 218         if line.startswith("eop") and page_has_ps:
 219             # We save in a list all the PostScript pages
 220             ps_pages.append(page_index)
 221
 222         if psliteral_re.match(line) != None:
 223             # Literal PostScript special detected!
 224             page_has_ps = True
 225
 226     # Create the -pp parameter for dvipng
 227     pages_parameter = ""
 228     if len(ps_pages) > 0 and len(ps_pages) < page_index:
 229         # Don't process Postscript pages with dvipng by selecting the
 230         # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
 231         pages_parameter = " -pp "
 232         skip = True
 233         last = -1
 234
 235         # Use page ranges, as a list of pages could exceed command line
 236         # maximum length (especially under Win32)
 237         for index in xrange(1, page_index + 1):
 238             if (not index in ps_pages) and skip:
 239                 # We were skipping pages but current page shouldn't be skipped.
 240                 # Add this page to -pp, it could stay alone or become the
 241                 # start of a range.
 242                 pages_parameter += str(index)
 243                 # Save the starting index to avoid things such as "11-11"
 244                 last = index
 245                 # We're not skipping anymore
 246                 skip = False
 247             elif (index in ps_pages) and (not skip):
 248                 # We weren't skipping but current page should be skipped
 249                 if last != index - 1:
 250                     # If the start index of the range is the previous page
 251                     # then it's not a range
 252                     pages_parameter += "-" + str(index - 1)
 253
 254                 # Add a separator
 255                 pages_parameter += ","
 256                 # Now we're skipping
 257                 skip = True
 258
 259         # Remove the trailing separator
 260         pages_parameter = pages_parameter.rstrip(",")
 261         # We've to manage the case in which the last page is closing a range
 262         if (not index in ps_pages) and (not skip) and (last != index):
 263                 pages_parameter += "-" + str(index)
 264
 265     return (ps_pages, page_index, pages_parameter)
 266
 267 def main(argv):
 268     # Parse and manipulate the command line arguments.
 269     if len(argv) != 6 and len(argv) != 7:
 270         error(usage(argv[0]))
 271
 272     output_format = string.lower(argv[1])
 273
 274     dir, latex_file = os.path.split(argv[2])
 275     if len(dir) != 0:
 276         os.chdir(dir)
 277
 278     dpi = string.atoi(argv[3])
 279     fg_color = make_texcolor(argv[4], False)
 280     bg_color = make_texcolor(argv[5], False)
 281
 282     fg_color_gr = make_texcolor(argv[4], True)
 283     bg_color_gr = make_texcolor(argv[5], True)
 284
 285     # External programs used by the script.
 286     if len(argv) == 7:
 287         latex = argv[6]
 288     else:
 289         latex = find_exe_or_terminate(["latex", "pplatex", "platex", "latex2e"], path)
 290
 291     # This can go once dvipng becomes widespread.
 292     dvipng = find_exe(["dvipng"], path)
 293     if dvipng == None:
 294         # The data is input to legacy_conversion in as similar
 295         # as possible a manner to that input to the code used in
 296         # LyX 1.3.x.
 297         vec = [ argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex ]
 298         return legacy_conversion(vec)
 299
 300     pngtopnm = ""
 301     if output_format == "ppm":
 302         pngtopnm = find_exe_or_terminate(["pngtopnm"], path)
 303
 304     # Move color information for PDF into the latex file.
 305     if not color_pdf(latex_file, bg_color_gr, fg_color_gr):
 306         error("Unable to move color info into the latex file")
 307
 308     # Compile the latex file.
 309     latex_call = '%s "%s"' % (latex, latex_file)
 310
 311     latex_status, latex_stdout = run_command(latex_call)
 312     if latex_status != None:
 313         warning("%s had problems compiling %s" \
 314               % (os.path.basename(latex), latex_file))
 315
 316     if latex == "xelatex":
 317         warning("Using XeTeX")
 318         # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
 319         return legacy_conversion_step2(latex_file, dpi, output_format)
 320
 321     # The dvi output file name
 322     dvi_file = latex_file_re.sub(".dvi", latex_file)
 323
 324     # If there's no DVI output, look for PDF and go to legacy or fail
 325     if not os.path.isfile(dvi_file):
 326         # No DVI, is there a PDF?
 327         pdf_file = latex_file_re.sub(".pdf", latex_file)
 328         if os.path.isfile(pdf_file):
 329             warning("%s produced a PDF output, fallback to legacy." % \
 330                 (os.path.basename(latex)))
 331             return legacy_conversion_step2(latex_file, dpi, output_format)
 332         else:
 333             error("No DVI or PDF output. %s failed." \
 334                 % (os.path.basename(latex)))
 335
 336     # Look for PS literals in DVI pages
 337     # ps_pages: list of page indexes of pages containing PS literals
 338     # page_count: total number of pages
 339     # pages_parameter: parameter for dvipng to exclude pages with PostScript
 340     (ps_pages, page_count, pages_parameter) = find_ps_pages(dvi_file)
 341
 342     # If all pages need PostScript, directly use the legacy method.
 343     if len(ps_pages) == page_count:
 344         vec = [argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex]
 345         return legacy_conversion(vec)
 346
 347     # Run the dvi file through dvipng.
 348     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
 349                   % (dvipng, dpi, fg_color, bg_color, pages_parameter, dvi_file)
 350     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 351
 352     if dvipng_status != None:
 353         warning("%s failed to generate images from %s... fallback to legacy method" \
 354               % (os.path.basename(dvipng), dvi_file))
 355         # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
 356         return legacy_conversion_step2(latex_file, dpi, output_format)
 357
 358     # Extract metrics info from dvipng_stdout.
 359     metrics_file = latex_file_re.sub(".metrics", latex_file)
 360     dvipng_metrics = extract_metrics_info(dvipng_stdout)
 361
 362     # If some pages require PostScript pass them to legacy method
 363     if len(ps_pages) > 0:
 364         # Create a new LaTeX file just for the snippets needing
 365         # the legacy method
 366         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 367         filter_pages(latex_file, legacy_latex_file, ps_pages)
 368
 369         # Pass the new LaTeX file to the legacy method
 370         vec = [ argv[0], latex_file_re.sub("_legacy.tex", argv[2]), \
 371                 argv[3], argv[1], argv[4], argv[5], latex ]
 372         legacy_metrics = legacy_conversion(vec, True)[1]
 373
 374         # Now we need to mix metrics data from dvipng and the legacy method
 375         original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
 376         destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 377
 378         # Join metrics from dvipng and legacy, and rename legacy bitmaps
 379         join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
 380             original_bitmap, destination_bitmap)
 381
 382     # Convert images to ppm format if necessary.
 383     if output_format == "ppm":
 384         convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
 385
 386     # Actually create the .metrics file
 387     write_metrics_info(dvipng_metrics, metrics_file)
 388
 389     return (0, dvipng_metrics)
 390
 391 if __name__ == "__main__":
 392     exit(main(sys.argv)[0])