lib/scripts/lyxpreview2bitmap.py

   1 # -*- coding: utf-8 -*-
   2
   3 # file lyxpreview2bitmap.py
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6
   7 # author Angus Leeming
   8 # with much advice from members of the preview-latex project:
   9 # David Kastrup, dak@gnu.org and
  10 # Jan-Åke Larsson, jalar@mai.liu.se.
  11
  12 # Full author contact details are available in file CREDITS
  13
  14 # This script takes a LaTeX file and generates a collection of
  15 # png or ppm image files, one per previewed snippet.
  16
  17 # Pre-requisites:
  18 # * python 2.4 or later (subprocess module);
  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 --bg=faf0e6 0lyxpreview.tex
  33
  34 # This script takes one obligatory argument:
  35 #
  36 #   <input file>:  The name of the .tex file to be converted.
  37 #
  38 # and these optional arguments:
  39 #
  40 #   --png, --ppm:  The desired output format. Either 'png' or 'ppm'.
  41 #   --dpi=<res>:   A scale factor, used to ascertain the resolution of the
  42 #                  generated image which is then passed to gs.
  43 #   --fg=<color>:  The foreground color as a hexadecimal string, eg '000000'.
  44 #   --bg=<color>:  The background color as a hexadecimal string, eg 'faf0e6'.
  45 #   --latex=<exe>: The converter for latex files. Default is latex.
  46 #   --bibtex=<exe>: The converter for bibtex files. Default is bibtex.
  47 #   --lilypond:    Preprocess through lilypond-book. Default is false.
  48 #   --lilypond-book=<exe>:
  49 #                  The converter for lytex files. Default is lilypond-book.
  50 #
  51 #   -d, --debug    Show the output from external commands.
  52 #   -h, --help     Show an help screen and exit.
  53 #   -v, --verbose  Show progress messages.
  54
  55 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
  56 # if executed successfully, leave in DIR:
  57 # * a (possibly large) number of image files with names
  58 #   like BASE[0-9]+.png
  59 # * a file BASE.metrics, containing info needed by LyX to position
  60 #   the images correctly on the screen.
  61
  62 # What does this script do?
  63 # 1) Call latex/pdflatex/xelatex/whatever (CONVERTER parameter)
  64 # 2) If the output is a PDF fallback to legacy
  65 # 3) Otherwise check each page of the DVI (with dv2dt) looking for
  66 #    PostScript literals, not well supported by dvipng. Pages
  67 #    containing them are passed to the legacy method in a new LaTeX file.
  68 # 4) Call dvipng on the pages without PS literals
  69 # 5) Join metrics info coming from both methods (legacy and dvipng)
  70 #    and write them to file
  71
  72 # dvipng is fast but gives problem in several cases, like with
  73 # PSTricks, TikZ and other packages using PostScript literals
  74 # for all these cases the legacy route is taken (step 3).
  75 # Moreover dvipng can't work with PDF files, so, if the CONVERTER
  76 # paramter is pdflatex we have to fallback to legacy route (step 2).
  77
  78 import getopt, glob, os, re, shutil, string, sys
  79
  80 from legacy_lyxpreview2ppm import legacy_conversion_step1
  81
  82 from lyxpreview_tools import bibtex_commands, copyfileobj, error, \
  83      filter_pages, find_exe, find_exe_or_terminate, join_metrics_and_rename, \
  84      latex_commands, latex_file_re, make_texcolor, mkstemp, pdflatex_commands, \
  85      progress, run_command, run_latex, run_tex, warning, write_metrics_info
  86
  87
  88 def usage(prog_name):
  89     msg = """
  90 Usage: %s <options> <input file>
  91
  92 Options:
  93   --dpi=<res>:   Resolution per inch (default: 128)
  94   --png, --ppm:  Select the output format (default: png)
  95   --fg=<color>:  Foreground color (default: black, ie '000000')
  96   --bg=<color>:  Background color (default: white, ie 'ffffff')
  97   --latex=<exe>: Specify the executable for latex (default: latex)
  98   --bibtex=<exe>: Specify the executable for bibtex (default: bibtex)
  99   --lilypond:    Preprocess through lilypond-book (default: false)
 100   --lilypond-book=<exe>:
 101                  The executable for lilypond-book (default: lilypond-book)
 102
 103   -d, --debug:   Show the output from external commands
 104   -h, --help:    Show this help screen and exit
 105   -v, --verbose: Show progress messages
 106
 107 The colors are hexadecimal strings, eg 'faf0e6'."""
 108     return msg % prog_name
 109
 110 # Returns a list of tuples containing page number and ascent fraction
 111 # extracted from dvipng output.
 112 # Use write_metrics_info to create the .metrics file with this info
 113 def extract_metrics_info(dvipng_stdout):
 114     # "\[[0-9]+" can match two kinds of numbers: page numbers from dvipng
 115     # and glyph numbers from mktexpk. The glyph numbers always match
 116     # "\[[0-9]+\]" while the page number never is followed by "\]". Thus:
 117     page_re = re.compile("\[([0-9]+)[^]]");
 118     metrics_re = re.compile("depth=(-?[0-9]+) height=(-?[0-9]+)")
 119
 120     success = 0
 121     page = ""
 122     pos = 0
 123     results = []
 124     while 1:
 125         match = page_re.search(dvipng_stdout, pos)
 126         if match == None:
 127             break
 128         page = match.group(1)
 129         pos = match.end()
 130         match = metrics_re.search(dvipng_stdout, pos)
 131         if match == None:
 132             break
 133         success = 1
 134
 135         # Calculate the 'ascent fraction'.
 136         descent = string.atof(match.group(1))
 137         ascent  = string.atof(match.group(2))
 138
 139         frac = 0.5
 140         if ascent >= 0 or descent >= 0:
 141             if abs(ascent + descent) > 0.1:
 142                 frac = ascent / (ascent + descent)
 143
 144             # Sanity check
 145             if frac < 0:
 146                 frac = 0.5
 147
 148         results.append((int(page), frac))
 149         pos = match.end() + 2
 150
 151     if success == 0:
 152         error("Failed to extract metrics info from dvipng")
 153
 154     return results
 155
 156
 157 def fix_latex_file(latex_file):
 158     documentclass_re = re.compile("(\\\\documentclass\[)(1[012]pt,?)(.+)")
 159
 160     tmp = mkstemp()
 161
 162     changed = 0
 163     for line in open(latex_file, 'r').readlines():
 164         match = documentclass_re.match(line)
 165         if match == None:
 166             tmp.write(line)
 167             continue
 168
 169         changed = 1
 170         tmp.write("%s%s\n" % (match.group(1), match.group(3)))
 171
 172     if changed:
 173         copyfileobj(tmp, open(latex_file,"wb"), 1)
 174
 175     return changed
 176
 177
 178 def convert_to_ppm_format(pngtopnm, basename):
 179     png_file_re = re.compile("\.png$")
 180
 181     for png_file in glob.glob("%s*.png" % basename):
 182         ppm_file = png_file_re.sub(".ppm", png_file)
 183
 184         p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
 185         p2p_status, p2p_stdout = run_command(p2p_cmd)
 186         if p2p_status:
 187             error("Unable to convert %s to ppm format" % png_file)
 188
 189         ppm = open(ppm_file, 'w')
 190         ppm.write(p2p_stdout)
 191         os.remove(png_file)
 192
 193 # Returns a tuple of:
 194 # ps_pages: list of page indexes of pages containing PS literals
 195 # page_count: total number of pages
 196 # pages_parameter: parameter for dvipng to exclude pages with PostScript
 197 def find_ps_pages(dvi_file):
 198     # latex failed
 199     # FIXME: try with pdflatex
 200     if not os.path.isfile(dvi_file):
 201         error("No DVI output.")
 202
 203     # Check for PostScript specials in the dvi, badly supported by dvipng
 204     # This is required for correct rendering of PSTricks and TikZ
 205     dv2dt = find_exe_or_terminate(["dv2dt"])
 206     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
 207
 208     # The output from dv2dt goes to stdout
 209     dv2dt_status, dv2dt_output = run_command(dv2dt_call)
 210     psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
 211
 212     # Parse the dtl file looking for PostScript specials.
 213     # Pages using PostScript specials are recorded in ps_pages and then
 214     # used to create a different LaTeX file for processing in legacy mode.
 215     page_has_ps = False
 216     page_index = 0
 217     ps_pages = []
 218
 219     for line in dv2dt_output.split("\n"):
 220         # New page
 221         if line.startswith("bop"):
 222             page_has_ps = False
 223             page_index += 1
 224
 225         # End of page
 226         if line.startswith("eop") and page_has_ps:
 227             # We save in a list all the PostScript pages
 228             ps_pages.append(page_index)
 229
 230         if psliteral_re.match(line) != None:
 231             # Literal PostScript special detected!
 232             page_has_ps = True
 233
 234     # Create the -pp parameter for dvipng
 235     pages_parameter = ""
 236     if len(ps_pages) > 0 and len(ps_pages) < page_index:
 237         # Don't process Postscript pages with dvipng by selecting the
 238         # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
 239         pages_parameter = " -pp "
 240         skip = True
 241         last = -1
 242
 243         # Use page ranges, as a list of pages could exceed command line
 244         # maximum length (especially under Win32)
 245         for index in xrange(1, page_index + 1):
 246             if (not index in ps_pages) and skip:
 247                 # We were skipping pages but current page shouldn't be skipped.
 248                 # Add this page to -pp, it could stay alone or become the
 249                 # start of a range.
 250                 pages_parameter += str(index)
 251                 # Save the starting index to avoid things such as "11-11"
 252                 last = index
 253                 # We're not skipping anymore
 254                 skip = False
 255             elif (index in ps_pages) and (not skip):
 256                 # We weren't skipping but current page should be skipped
 257                 if last != index - 1:
 258                     # If the start index of the range is the previous page
 259                     # then it's not a range
 260                     pages_parameter += "-" + str(index - 1)
 261
 262                 # Add a separator
 263                 pages_parameter += ","
 264                 # Now we're skipping
 265                 skip = True
 266
 267         # Remove the trailing separator
 268         pages_parameter = pages_parameter.rstrip(",")
 269         # We've to manage the case in which the last page is closing a range
 270         if (not index in ps_pages) and (not skip) and (last != index):
 271                 pages_parameter += "-" + str(index)
 272
 273     return (ps_pages, page_index, pages_parameter)
 274
 275 def main(argv):
 276     # Set defaults.
 277     dpi = 128
 278     fg_color = "000000"
 279     bg_color = "ffffff"
 280     bibtex = None
 281     latex = None
 282     lilypond = False
 283     lilypond_book = None
 284     output_format = "png"
 285     script_name = argv[0]
 286
 287     # Parse and manipulate the command line arguments.
 288     try:
 289         (opts, args) = getopt.gnu_getopt(argv[1:], "dhv", ["bibtex=", "bg=",
 290             "debug", "dpi=", "fg=", "help", "latex=", "lilypond",
 291             "lilypond-book=", "png", "ppm", "verbose"])
 292     except getopt.GetoptError, err:
 293         error("%s\n%s" % (err, usage(script_name)))
 294
 295     opts.reverse()
 296     for opt, val in opts:
 297         if opt in ("-h", "--help"):
 298             print usage(script_name)
 299             sys.exit(0)
 300         elif opt == "--bibtex":
 301             bibtex = [val]
 302         elif opt == "--bg":
 303             bg_color = val
 304         elif opt in ("-d", "--debug"):
 305             import lyxpreview_tools
 306             lyxpreview_tools.debug = True
 307         elif opt == "--dpi":
 308             try:
 309                 dpi = string.atoi(val)
 310             except:
 311                 error("Cannot convert %s to an integer value" % val)
 312         elif opt == "--fg":
 313             fg_color = val
 314         elif opt == "--latex":
 315             latex = [val]
 316         elif opt == "--lilypond":
 317             lilypond = True
 318         elif opt == "--lilypond-book":
 319             lilypond_book = [val]
 320         elif opt in ("--png", "--ppm"):
 321             output_format = opt[2:]
 322         elif opt in ("-v", "--verbose"):
 323             import lyxpreview_tools
 324             lyxpreview_tools.verbose = True
 325
 326     # Determine input file
 327     if len(args) != 1:
 328         err = "A single input file is required, %s given" % (len(args) or "none")
 329         error("%s\n%s" % (err, usage(script_name)))
 330
 331     input_path = args[0]
 332     dir, latex_file = os.path.split(input_path)
 333
 334     # Echo the settings
 335     progress("Starting %s..." % script_name)
 336     progress("Output format: %s" % output_format)
 337     progress("Foreground color: %s" % fg_color)
 338     progress("Background color: %s" % bg_color)
 339     progress("Resolution (dpi): %s" % dpi)
 340     progress("File to process: %s" % input_path)
 341
 342     # Check for the input file
 343     if not os.path.exists(input_path):
 344         error('File "%s" not found.' % input_path)
 345     if len(dir) != 0:
 346         os.chdir(dir)
 347
 348     fg_color_dvipng = make_texcolor(fg_color, False)
 349     bg_color_dvipng = make_texcolor(bg_color, False)
 350
 351     # External programs used by the script.
 352     latex = find_exe_or_terminate(latex or latex_commands)
 353     bibtex = find_exe(bibtex or bibtex_commands)
 354     if lilypond:
 355         lilypond_book = find_exe_or_terminate(lilypond_book or
 356             ["lilypond-book --safe"])
 357
 358     # These flavors of latex are known to produce pdf output
 359     pdf_output = latex in pdflatex_commands
 360
 361     progress("Latex command: %s" % latex)
 362     progress("Latex produces pdf output: %s" % pdf_output)
 363     progress("Bibtex command: %s" % bibtex)
 364     progress("Lilypond-book command: %s" % lilypond_book)
 365     progress("Preprocess through lilypond-book: %s" % lilypond)
 366     progress("Altering the latex file for font size and colors")
 367
 368     # Omit font size specification in latex file.
 369     fix_latex_file(latex_file)
 370
 371     if lilypond:
 372         progress("Preprocess the latex file through %s" % lilypond_book)
 373         if pdf_output:
 374             lilypond_book += " --pdf"
 375         lilypond_book += " --latex-program=%s" % latex.split()[0]
 376
 377         # Make a copy of the latex file
 378         lytex_file = latex_file_re.sub(".lytex", latex_file)
 379         shutil.copyfile(latex_file, lytex_file)
 380
 381         # Preprocess the latex file through lilypond-book.
 382         lytex_status, lytex_stdout = run_tex(lilypond_book, lytex_file)
 383
 384     if pdf_output:
 385         progress("Using the legacy conversion method (PDF support)")
 386         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 387             bg_color, latex, pdf_output)
 388
 389     # This can go once dvipng becomes widespread.
 390     dvipng = find_exe(["dvipng"])
 391     if dvipng == None:
 392         progress("Using the legacy conversion method (dvipng not found)")
 393         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 394             bg_color, latex, pdf_output)
 395
 396     dv2dt = find_exe(["dv2dt"])
 397     if dv2dt == None:
 398         progress("Using the legacy conversion method (dv2dt not found)")
 399         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 400             bg_color, latex, pdf_output)
 401
 402     pngtopnm = ""
 403     if output_format == "ppm":
 404         pngtopnm = find_exe(["pngtopnm"])
 405         if pngtopnm == None:
 406             progress("Using the legacy conversion method (pngtopnm not found)")
 407             return legacy_conversion_step1(latex_file, dpi, output_format,
 408                 fg_color, bg_color, latex, pdf_output)
 409
 410     # Compile the latex file.
 411     latex_status, latex_stdout = run_latex(latex, latex_file, bibtex)
 412
 413     # The dvi output file name
 414     dvi_file = latex_file_re.sub(".dvi", latex_file)
 415
 416     # If there's no DVI output, look for PDF and go to legacy or fail
 417     if not os.path.isfile(dvi_file):
 418         # No DVI, is there a PDF?
 419         pdf_file = latex_file_re.sub(".pdf", latex_file)
 420         if os.path.isfile(pdf_file):
 421             progress("%s produced a PDF output, fallback to legacy." \
 422                 % (os.path.basename(latex)))
 423             progress("Using the legacy conversion method (PDF support)")
 424             return legacy_conversion_step1(latex_file, dpi, output_format,
 425                 fg_color, bg_color, latex, True)
 426         else:
 427             error("No DVI or PDF output. %s failed." \
 428                 % (os.path.basename(latex)))
 429
 430     # Look for PS literals in DVI pages
 431     # ps_pages: list of page indexes of pages containing PS literals
 432     # page_count: total number of pages
 433     # pages_parameter: parameter for dvipng to exclude pages with PostScript
 434     (ps_pages, page_count, pages_parameter) = find_ps_pages(dvi_file)
 435
 436     # If all pages need PostScript, directly use the legacy method.
 437     if len(ps_pages) == page_count:
 438         progress("Using the legacy conversion method (PostScript support)")
 439         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 440             bg_color, latex, pdf_output)
 441
 442     # Run the dvi file through dvipng.
 443     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
 444         % (dvipng, dpi, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
 445     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 446
 447     if dvipng_status:
 448         warning("%s failed to generate images from %s... fallback to legacy method" \
 449               % (os.path.basename(dvipng), dvi_file))
 450         progress("Using the legacy conversion method (dvipng failed)")
 451         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 452             bg_color, latex, pdf_output)
 453
 454     # Extract metrics info from dvipng_stdout.
 455     metrics_file = latex_file_re.sub(".metrics", latex_file)
 456     dvipng_metrics = extract_metrics_info(dvipng_stdout)
 457
 458     # If some pages require PostScript pass them to legacy method
 459     if len(ps_pages) > 0:
 460         # Create a new LaTeX file just for the snippets needing
 461         # the legacy method
 462         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 463         filter_pages(latex_file, legacy_latex_file, ps_pages)
 464
 465         # Pass the new LaTeX file to the legacy method
 466         progress("Pages %s include postscript specials" % ps_pages)
 467         progress("Using the legacy conversion method (PostScript support)")
 468         legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
 469             dpi, output_format, fg_color, bg_color, latex, pdf_output, True)
 470
 471         # Now we need to mix metrics data from dvipng and the legacy method
 472         original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
 473         destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 474
 475         # Join metrics from dvipng and legacy, and rename legacy bitmaps
 476         join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
 477             original_bitmap, destination_bitmap)
 478
 479     # Convert images to ppm format if necessary.
 480     if output_format == "ppm":
 481         convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
 482
 483     # Actually create the .metrics file
 484     write_metrics_info(dvipng_metrics, metrics_file)
 485
 486     return (0, dvipng_metrics)
 487
 488 if __name__ == "__main__":
 489     sys.exit(main(sys.argv)[0])