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 # * pngtoppm (if outputing ppm format images).
  23
  24 # preview.sty and dvipng are part of the preview-latex project
  25 # http://preview-latex.sourceforge.net/
  26
  27 # preview.sty can alternatively be obtained from
  28 # CTAN/support/preview-latex/
  29
  30 # Example usage:
  31 # lyxpreview2bitmap.py png 0lyxpreview.tex 128 000000 faf0e6
  32
  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.
  41
  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
  45 #   like BASE[0-9]+.png
  46 # * a file BASE.metrics, containing info needed by LyX to position
  47 #   the images correctly on the screen.
  48
  49 import glob, os, re, string, sys
  50
  51 from legacy_lyxpreview2ppm import legacy_conversion, \
  52      legacy_conversion_step2, legacy_extract_metrics_info
  53
  54 from lyxpreview_tools import copyfileobj, error, find_exe, \
  55      find_exe_or_terminate, make_texcolor, mkstemp, run_command, warning, \
  56      write_metrics_info
  57
  58
  59 # Pre-compiled regular expressions.
  60 latex_file_re = re.compile("\.tex$")
  61
  62
  63 def usage(prog_name):
  64     return "Usage: %s <format> <latex file> <dpi> <fg color> <bg color>\n"\
  65            "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\
  66            % prog_name
  67
  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]+)")
  77
  78     success = 0
  79     page = ""
  80     pos = 0
  81     results = []
  82     while 1:
  83         match = page_re.search(dvipng_stdout, pos)
  84         if match == None:
  85             break
  86         page = match.group(1)
  87         pos = match.end()
  88         match = metrics_re.search(dvipng_stdout, pos)
  89         if match == None:
  90             break
  91         success = 1
  92
  93         # Calculate the 'ascent fraction'.
  94         descent = string.atof(match.group(1))
  95         ascent  = string.atof(match.group(2))
  96
  97         frac = 0.5
  98         if ascent >= 0 or descent >= 0:
  99             if abs(ascent + descent) > 0.1:
 100                 frac = ascent / (ascent + descent)
 101
 102             # Sanity check
 103             if frac < 0:
 104                 frac = 0.5
 105
 106         results.append((page, frac))
 107         pos = match.end() + 2
 108
 109     if success == 0:
 110         error("Failed to extract metrics info from dvipng")
 111
 112     return results
 113
 114
 115 def color_pdf(latex_file, bg_color, fg_color):
 116     use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)(pdftex\]{preview})")
 117
 118     tmp = mkstemp()
 119
 120     fg = ""
 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)
 123
 124     success = 0
 125     try:
 126         for line in open(latex_file, 'r').readlines():
 127             match = use_preview_pdf_re.match(line)
 128             if match == None:
 129                 tmp.write(line)
 130                 continue
 131             success = 1
 132             tmp.write("  \\usepackage{color}\n" \
 133                   "  \\pagecolor[rgb]{%s}\n" \
 134                   "%s" \
 135                   "%s\n" \
 136                   % (bg_color, fg, match.group()))
 137             continue
 138
 139     except:
 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`)
 144
 145     if success:
 146         copyfileobj(tmp, open(latex_file,"wb"), 1)
 147
 148     return success
 149
 150
 151 def convert_to_ppm_format(pngtopnm, basename):
 152     png_file_re = re.compile("\.png$")
 153
 154     for png_file in glob.glob("%s*.png" % basename):
 155         ppm_file = png_file_re.sub(".ppm", png_file)
 156
 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)
 161
 162         ppm = open(ppm_file, 'w')
 163         ppm.write(p2p_stdout)
 164         os.remove(png_file)
 165
 166
 167 def main(argv):
 168     # Parse and manipulate the command line arguments.
 169     if len(argv) != 6 and len(argv) != 7:
 170         error(usage(argv[0]))
 171
 172     output_format = string.lower(argv[1])
 173
 174     dir, latex_file = os.path.split(argv[2])
 175     if len(dir) != 0:
 176         os.chdir(dir)
 177
 178     dpi = string.atoi(argv[3])
 179     fg_color = make_texcolor(argv[4], False)
 180     bg_color = make_texcolor(argv[5], False)
 181
 182     fg_color_gr = make_texcolor(argv[4], True)
 183     bg_color_gr = make_texcolor(argv[5], True)
 184
 185     # External programs used by the script.
 186     path = string.split(os.environ["PATH"], os.pathsep)
 187     if len(argv) == 7:
 188         latex = argv[6]
 189     else:
 190         latex = find_exe_or_terminate(["latex", "pplatex", "platex", "latex2e"], path)
 191
 192     # This can go once dvipng becomes widespread.
 193     dvipng = find_exe(["dvipng"], path)
 194     if dvipng == None:
 195         # The data is input to legacy_conversion in as similar
 196         # as possible a manner to that input to the code used in
 197         # LyX 1.3.x.
 198         vec = [ argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex ]
 199         return legacy_conversion(vec)
 200
 201     pngtopnm = ""
 202     if output_format == "ppm":
 203         pngtopnm = find_exe_or_terminate(["pngtopnm"], path)
 204
 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")
 208
 209     # Compile the latex file.
 210     latex_call = '%s "%s"' % (latex, latex_file)
 211
 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))
 216
 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)
 221
 222     # The dvi output file name
 223     dvi_file = latex_file_re.sub(".dvi", latex_file)
 224
 225     # Check for PostScript specials in the dvi, badly supported by dvipng
 226     # This is required for correct rendering of PSTricks and TikZ
 227     dv2dt = find_exe_or_terminate(["dv2dt"], path)
 228     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
 229
 230     # The output from dv2dt goes to stdout
 231     dv2dt_status, dv2dt_output = run_command(dv2dt_call)
 232     psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
 233
 234     # Parse the dtl file looking for PostScript specials.
 235     # Pages using PostScript specials are recorded in ps_pages and then
 236     # used to create a different LaTeX file for processing in legacy mode.
 237     page_has_ps = False
 238     page_index = 0
 239     ps_pages = []
 240
 241     for line in dv2dt_output.split("\n"):
 242         # New page
 243         if line.startswith("bop"):
 244             page_has_ps = False
 245             page_index += 1
 246
 247         # End of page
 248         if line.startswith("eop") and page_has_ps:
 249             # We save in a list all the PostScript pages
 250             ps_pages.append(page_index)
 251
 252         if psliteral_re.match(line) != None:
 253             # Literal PostScript special detected!
 254             page_has_ps = True
 255
 256     pages_parameter = ""
 257     if len(ps_pages) == page_index:
 258         # All pages need PostScript, so directly use the legacy method.
 259         vec = [argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex]
 260         return legacy_conversion(vec)
 261     elif len(ps_pages) > 0:
 262         # Don't process Postscript pages with dvipng by selecting the
 263         # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
 264         pages_parameter = " -pp "
 265         skip = True
 266         last = -1
 267
 268         # Use page ranges, as a list of pages could exceed command line
 269         # maximum length (especially under Win32)
 270         for index in xrange(1, page_index + 1):
 271             if (not index in ps_pages) and skip:
 272                 # We were skipping pages but current page shouldn't be skipped.
 273                 # Add this page to -pp, it could stay alone or become the
 274                 # start of a range.
 275                 pages_parameter += str(index)
 276                 # Save the starting index to avoid things such as "11-11"
 277                 last = index
 278                 # We're not skipping anymore
 279                 skip = False
 280             elif (index in ps_pages) and (not skip):
 281                 # We weren't skipping but current page should be skipped
 282                 if last != index - 1:
 283                     # If the start index of the range is the previous page
 284                     # then it's not a range
 285                     pages_parameter += "-" + str(index - 1)
 286
 287                 # Add a separator
 288                 pages_parameter += ","
 289                 # Now we're skipping
 290                 skip = True
 291
 292         # Remove the trailing separator
 293         pages_parameter = pages_parameter.rstrip(",")
 294         # We've to manage the case in which the last page is closing a range
 295         if (not index in ps_pages) and (not skip) and (last != index):
 296                 pages_parameter += "-" + str(index)
 297
 298     # Run the dvi file through dvipng.
 299     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
 300                   % (dvipng, dpi, fg_color, bg_color, pages_parameter, dvi_file)
 301     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 302
 303     if dvipng_status != None:
 304         warning("%s failed to generate images from %s ... looking for PDF" \
 305               % (os.path.basename(dvipng), dvi_file))
 306         # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
 307         return legacy_conversion_step2(latex_file, dpi, output_format)
 308
 309     if len(ps_pages) > 0:
 310         # Some pages require PostScript.
 311         # Create a new LaTeX file just for the snippets needing
 312         # the legacy method
 313         original_latex = open(latex_file, "r")
 314         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 315         legacy_latex = open(legacy_latex_file, "w")
 316
 317         page_index = 0
 318         skip_page = False
 319         for line in original_latex:
 320             if line.startswith("\\begin{preview}"):
 321                 page_index += 1
 322                 # Skips all pages processed by dvipng
 323                 skip_page = page_index not in ps_pages
 324
 325             if not skip_page:
 326                 legacy_latex.write(line)
 327
 328             if line.startswith("\\end{preview}"):
 329                 skip_page = False
 330
 331         legacy_latex.close()
 332         original_latex.close()
 333
 334         # Pass the new LaTeX file to the legacy method
 335         vec = [ argv[0], latex_file_re.sub("_legacy.tex", argv[2]), \
 336                 argv[3], argv[1], argv[4], argv[5], latex ]
 337         legacy_conversion(vec, True)
 338
 339         # Now we need to mix metrics data from dvipng and the legacy method
 340         metrics_file = latex_file_re.sub(".metrics", latex_file)
 341
 342         dvipng_metrics = extract_metrics_info(dvipng_stdout)
 343         legacy_metrics = legacy_extract_metrics_info(latex_file_re.sub("_legacy.log", latex_file))
 344
 345         # Check whether a page is present in dvipng_metrics, otherwise
 346         # add it getting the metrics from legacy_metrics
 347         legacy_index = -1;
 348         for i in range(page_index):
 349             # If we exceed the array bounds or the dvipng_metrics doesn't
 350             # match the current one, this page belongs to the legacy method
 351             if (i > len(dvipng_metrics) - 1) or (dvipng_metrics[i][0] != str(i + 1)):
 352                 legacy_index += 1
 353
 354                 # Add this metric from the legacy output
 355                 dvipng_metrics.insert(i, (str(i + 1), legacy_metrics[legacy_index][1]))
 356                 # Legacy output filename
 357                 legacy_output = os.path.join(dir, latex_file_re.sub("_legacy%s.%s" %
 358                     (legacy_metrics[legacy_index][0], output_format), latex_file))
 359
 360                 # Check whether legacy method actually created the file
 361                 if os.path.isfile(legacy_output):
 362                     # Rename the file by removing the "_legacy" suffix
 363                     # and adjusting the index
 364                     bitmap_output = os.path.join(dir, latex_file_re.sub("%s.%s" %
 365                         (str(i + 1), output_format), latex_file))
 366                     os.rename(legacy_output, bitmap_output)
 367
 368         # Actually create the .metrics file
 369         write_metrics_info(dvipng_metrics, metrics_file)
 370     else:
 371         # Extract metrics info from dvipng_stdout.
 372         # In this case we just used dvipng, so no special metrics
 373         # handling is needed.
 374         metrics_file = latex_file_re.sub(".metrics", latex_file)
 375         write_metrics_info(extract_metrics_info(dvipng_stdout), metrics_file)
 376
 377     # Convert images to ppm format if necessary.
 378     if output_format == "ppm":
 379         convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
 380
 381     return 0
 382
 383
 384 if __name__ == "__main__":
 385     main(sys.argv)