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):
 116     use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)(pdftex\]{preview})")
 117
 118     tmp = mkstemp()
 119
 120     success = 0
 121     try:
 122         for line in open(latex_file, 'r').readlines():
 123             match = use_preview_pdf_re.match(line)
 124             if match == None:
 125                 tmp.write(line)
 126                 continue
 127             success = 1
 128             tmp.write("  \\usepackage{color}\n" \
 129                   "  \\pagecolor[rgb]{%s}\n" \
 130                   "%s\n" \
 131                   % (bg_color, match.group()))
 132             continue
 133
 134     except:
 135         # Unable to open the file, but do nothing here because
 136         # the calling function will act on the value of 'success'.
 137         warning('Warning in color_pdf! Unable to open "%s"' % latex_file)
 138         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 139
 140     if success:
 141         copyfileobj(tmp, open(latex_file,"wb"), 1)
 142
 143     return success
 144
 145
 146 def convert_to_ppm_format(pngtopnm, basename):
 147     png_file_re = re.compile("\.png$")
 148
 149     for png_file in glob.glob("%s*.png" % basename):
 150         ppm_file = png_file_re.sub(".ppm", png_file)
 151
 152         p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
 153         p2p_status, p2p_stdout = run_command(p2p_cmd)
 154         if p2p_status != None:
 155             error("Unable to convert %s to ppm format" % png_file)
 156
 157         ppm = open(ppm_file, 'w')
 158         ppm.write(p2p_stdout)
 159         os.remove(png_file)
 160
 161
 162 def main(argv):
 163     # Parse and manipulate the command line arguments.
 164     if len(argv) != 6 and len(argv) != 7:
 165         error(usage(argv[0]))
 166
 167     output_format = string.lower(argv[1])
 168
 169     dir, latex_file = os.path.split(argv[2])
 170     if len(dir) != 0:
 171         os.chdir(dir)
 172
 173     dpi = string.atoi(argv[3])
 174     fg_color = make_texcolor(argv[4], False)
 175     bg_color = make_texcolor(argv[5], False)
 176
 177     bg_color_gr = make_texcolor(argv[5], True)
 178
 179     # External programs used by the script.
 180     path = string.split(os.environ["PATH"], os.pathsep)
 181     if len(argv) == 7:
 182         latex = argv[6]
 183     else:
 184         latex = find_exe_or_terminate(["latex", "pplatex", "platex", "latex2e"], path)
 185
 186     # This can go once dvipng becomes widespread.
 187     dvipng = find_exe(["dvipng"], path)
 188     if dvipng == None:
 189         # The data is input to legacy_conversion in as similar
 190         # as possible a manner to that input to the code used in
 191         # LyX 1.3.x.
 192         vec = [ argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex ]
 193         return legacy_conversion(vec)
 194
 195     pngtopnm = ""
 196     if output_format == "ppm":
 197         pngtopnm = find_exe_or_terminate(["pngtopnm"], path)
 198
 199     # Move color information for PDF into the latex file.
 200     if not color_pdf(latex_file, bg_color_gr):
 201         error("Unable to move color info into the latex file")
 202
 203     # Compile the latex file.
 204     latex_call = '%s "%s"' % (latex, latex_file)
 205
 206     latex_status, latex_stdout = run_command(latex_call)
 207     if latex_status != None:
 208         warning("%s had problems compiling %s" \
 209               % (os.path.basename(latex), latex_file))
 210
 211     if latex == "xelatex":
 212         warning("Using XeTeX")
 213         # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
 214         return legacy_conversion_step2(latex_file, dpi, output_format)
 215
 216     # The dvi output file name
 217     dvi_file = latex_file_re.sub(".dvi", latex_file)
 218
 219     # Check for PostScript specials in the dvi, badly supported by dvipng
 220     # This is required for correct rendering of PSTricks and TikZ
 221     dv2dt = find_exe_or_terminate(["dv2dt"], path)
 222     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
 223
 224     # The output from dv2dt goes to stdout
 225     dv2dt_status, dv2dt_output = run_command(dv2dt_call)
 226     psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
 227
 228     # Parse the dtl file looking for PostScript specials.
 229     # Pages using PostScript specials are recorded in ps_pages and then
 230     # used to create a different LaTeX file for processing in legacy mode.
 231     page_has_ps = False
 232     page_index = 0
 233     ps_pages = []
 234
 235     for line in dv2dt_output.split("\n"):
 236         # New page
 237         if line.startswith("bop"):
 238             page_has_ps = False
 239             page_index += 1
 240
 241         # End of page
 242         if line.startswith("eop") and page_has_ps:
 243             # We save in a list all the PostScript pages
 244             ps_pages.append(page_index)
 245
 246         if psliteral_re.match(line) != None:
 247             # Literal PostScript special detected!
 248             page_has_ps = True
 249
 250     pages_parameter = ""
 251     if len(ps_pages) == page_index:
 252         # All pages need PostScript, so directly use the legacy method.
 253         vec = [argv[0], argv[2], argv[3], argv[1], argv[4], argv[5], latex]
 254         return legacy_conversion(vec)
 255     elif len(ps_pages) > 0:
 256         # Don't process Postscript pages with dvipng by selecting the
 257         # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
 258         pages_parameter = " -pp "
 259         skip = True
 260         last = -1
 261
 262         # Use page ranges, as a list of pages could exceed command line
 263         # maximum length (especially under Win32)
 264         for index in xrange(1, page_index + 1):
 265             if (not index in ps_pages) and skip:
 266                 # We were skipping pages but current page shouldn't be skipped.
 267                 # Add this page to -pp, it could stay alone or become the
 268                 # start of a range.
 269                 pages_parameter += str(index)
 270                 # Save the starting index to avoid things such as "11-11"
 271                 last = index
 272                 # We're not skipping anymore
 273                 skip = False
 274             elif (index in ps_pages) and (not skip):
 275                 # We weren't skipping but current page should be skipped
 276                 if last != index - 1:
 277                     # If the start index of the range is the previous page
 278                     # then it's not a range
 279                     pages_parameter += "-" + str(index - 1)
 280
 281                 # Add a separator
 282                 pages_parameter += ","
 283                 # Now we're skipping
 284                 skip = True
 285
 286         # Remove the trailing separator
 287         pages_parameter = pages_parameter.rstrip(",")
 288         # We've to manage the case in which the last page is closing a range
 289         if (not index in ps_pages) and (not skip) and (last != index):
 290                 pages_parameter += "-" + str(index)
 291
 292     # Run the dvi file through dvipng.
 293     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
 294                   % (dvipng, dpi, fg_color, bg_color, pages_parameter, dvi_file)
 295     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 296
 297     if dvipng_status != None:
 298         warning("%s failed to generate images from %s ... looking for PDF" \
 299               % (os.path.basename(dvipng), dvi_file))
 300         # FIXME: skip unnecessary dvips trial in legacy_conversion_step2
 301         return legacy_conversion_step2(latex_file, dpi, output_format)
 302
 303     if len(ps_pages) > 0:
 304         # Some pages require PostScript.
 305         # Create a new LaTeX file just for the snippets needing
 306         # the legacy method
 307         original_latex = open(latex_file, "r")
 308         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 309         legacy_latex = open(legacy_latex_file, "w")
 310
 311         page_index = 0
 312         skip_page = False
 313         for line in original_latex:
 314             if line.startswith("\\begin{preview}"):
 315                 page_index += 1
 316                 # Skips all pages processed by dvipng
 317                 skip_page = page_index not in ps_pages
 318
 319             if not skip_page:
 320                 legacy_latex.write(line)
 321
 322             if line.startswith("\\end{preview}"):
 323                 skip_page = False
 324
 325         legacy_latex.close()
 326         original_latex.close()
 327
 328         # Pass the new LaTeX file to the legacy method
 329         vec = [ argv[0], latex_file_re.sub("_legacy.tex", argv[2]), \
 330                 argv[3], argv[1], argv[4], argv[5], latex ]
 331         legacy_conversion(vec, True)
 332
 333         # Now we need to mix metrics data from dvipng and the legacy method
 334         metrics_file = latex_file_re.sub(".metrics", latex_file)
 335
 336         dvipng_metrics = extract_metrics_info(dvipng_stdout)
 337         legacy_metrics = legacy_extract_metrics_info(latex_file_re.sub("_legacy.log", latex_file))
 338
 339         # Check whether a page is present in dvipng_metrics, otherwise
 340         # add it getting the metrics from legacy_metrics
 341         legacy_index = -1;
 342         for i in range(page_index):
 343             # If we exceed the array bounds or the dvipng_metrics doesn't
 344             # match the current one, this page belongs to the legacy method
 345             if (i > len(dvipng_metrics) - 1) or (dvipng_metrics[i][0] != str(i + 1)):
 346                 legacy_index += 1
 347
 348                 # Add this metric from the legacy output
 349                 dvipng_metrics.insert(i, (str(i + 1), legacy_metrics[legacy_index][1]))
 350                 # Legacy output filename
 351                 legacy_output = os.path.join(dir, latex_file_re.sub("_legacy%s.%s" %
 352                     (legacy_metrics[legacy_index][0], output_format), latex_file))
 353
 354                 # Check whether legacy method actually created the file
 355                 if os.path.isfile(legacy_output):
 356                     # Rename the file by removing the "_legacy" suffix
 357                     # and adjusting the index
 358                     bitmap_output = os.path.join(dir, latex_file_re.sub("%s.%s" %
 359                         (str(i + 1), output_format), latex_file))
 360                     os.rename(legacy_output, bitmap_output)
 361
 362         # Actually create the .metrics file
 363         write_metrics_info(dvipng_metrics, metrics_file)
 364     else:
 365         # Extract metrics info from dvipng_stdout.
 366         # In this case we just used dvipng, so no special metrics
 367         # handling is needed.
 368         metrics_file = latex_file_re.sub(".metrics", latex_file)
 369         write_metrics_info(extract_metrics_info(dvipng_stdout), metrics_file)
 370
 371     # Convert images to ppm format if necessary.
 372     if output_format == "ppm":
 373         convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
 374
 375     return 0
 376
 377
 378 if __name__ == "__main__":
 379     main(sys.argv)