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:
 141             # This is an empty image, forbid its display
 142             frac = -1.0
 143         elif ascent >= 0 or descent >= 0:
 144             if abs(ascent + descent) > 0.1:
 145                 frac = ascent / (ascent + descent)
 146
 147             # Sanity check
 148             if frac < 0:
 149                 frac = 0.5
 150
 151         results.append((int(page), frac))
 152         pos = match.end() + 2
 153
 154     if success == 0:
 155         error("Failed to extract metrics info from dvipng")
 156
 157     return results
 158
 159
 160 def fix_latex_file(latex_file):
 161     documentclass_re = re.compile("(\\\\documentclass\[)(1[012]pt,?)(.+)")
 162     newcommandx_re = re.compile("^(\\\\newcommandx)(.+)")
 163
 164     tmp = mkstemp()
 165
 166     changed = 0
 167     for line in open(latex_file, 'r').readlines():
 168         match = documentclass_re.match(line)
 169         if match != None:
 170             changed = 1
 171             tmp.write("%s%s\n" % (match.group(1), match.group(3)))
 172             continue
 173
 174         match = newcommandx_re.match(line)
 175         if match == None:
 176             tmp.write(line)
 177             continue
 178
 179         changed = 1
 180         tmp.write("\\providecommandx%s\n" % match.group(2))
 181
 182     if changed:
 183         copyfileobj(tmp, open(latex_file,"wb"), 1)
 184
 185     return changed
 186
 187
 188 def convert_to_ppm_format(pngtopnm, basename):
 189     png_file_re = re.compile("\.png$")
 190
 191     for png_file in glob.glob("%s*.png" % basename):
 192         ppm_file = png_file_re.sub(".ppm", png_file)
 193
 194         p2p_cmd = '%s "%s"' % (pngtopnm, png_file)
 195         p2p_status, p2p_stdout = run_command(p2p_cmd)
 196         if p2p_status:
 197             error("Unable to convert %s to ppm format" % png_file)
 198
 199         ppm = open(ppm_file, 'w')
 200         ppm.write(p2p_stdout)
 201         os.remove(png_file)
 202
 203 # Returns a tuple of:
 204 # ps_pages: list of page indexes of pages containing PS literals
 205 # pdf_pages: list of page indexes of pages requiring running pdflatex
 206 # page_count: total number of pages
 207 # pages_parameter: parameter for dvipng to exclude pages with PostScript/PDF
 208 def find_ps_pages(dvi_file):
 209     # latex failed
 210     # FIXME: try with pdflatex
 211     if not os.path.isfile(dvi_file):
 212         error("No DVI output.")
 213
 214     # Check for PostScript specials in the dvi, badly supported by dvipng,
 215     # and inclusion of PDF/PNG/JPG files.
 216     # This is required for correct rendering of PSTricks and TikZ
 217     dv2dt = find_exe_or_terminate(["dv2dt"])
 218     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
 219
 220     # The output from dv2dt goes to stdout
 221     dv2dt_status, dv2dt_output = run_command(dv2dt_call)
 222     psliteral_re = re.compile("^special[1-4] [0-9]+ '(\"|ps:)")
 223     hyperref_re = re.compile("^special[1-4] [0-9]+ 'ps:.*/DEST pdfmark")
 224     pdffile_re = re.compile("^special[1-4] [0-9]+ 'PSfile=.*.(pdf|png|jpg|jpeg|PDF|PNG|JPG|JPEG)")
 225
 226     # Parse the dtl file looking for PostScript specials and pdflatex files.
 227     # Pages using PostScript specials or pdflatex files are recorded in
 228     # ps_pages or pdf_pages, respectively, and then used to create a
 229     # different LaTeX file for processing in legacy mode.
 230     # If hyperref is detected, the corresponding page is recorded in pdf_pages.
 231     page_has_ps = False
 232     page_has_pdf = False
 233     page_index = 0
 234     ps_pages = []
 235     pdf_pages = []
 236     ps_or_pdf_pages = []
 237
 238     for line in dv2dt_output.split("\n"):
 239         # New page
 240         if line.startswith("bop"):
 241             page_has_ps = False
 242             page_has_pdf = False
 243             page_index += 1
 244
 245         # End of page
 246         if line.startswith("eop") and (page_has_ps or page_has_pdf):
 247             # We save in a list all the PostScript/PDF pages
 248             if page_has_ps:
 249                 ps_pages.append(page_index)
 250             else:
 251                 pdf_pages.append(page_index)
 252             ps_or_pdf_pages.append(page_index)
 253
 254         if psliteral_re.match(line) != None:
 255             # Literal PostScript special detected!
 256             # If hyperref is detected, put this page on the pdf pages list
 257             if hyperref_re.match(line) != None:
 258                 page_has_ps = False
 259                 page_has_pdf = True
 260             else:
 261                 page_has_ps = True
 262         elif pdffile_re.match(line) != None:
 263             # Inclusion of pdflatex image file detected!
 264             page_has_pdf = True
 265
 266     # Create the -pp parameter for dvipng
 267     pages_parameter = ""
 268     if len(ps_or_pdf_pages) > 0 and len(ps_or_pdf_pages) < page_index:
 269         # Don't process Postscript/PDF pages with dvipng by selecting the
 270         # wanted pages through the -pp parameter. E.g., dvipng -pp 4-12,14,64
 271         pages_parameter = " -pp "
 272         skip = True
 273         last = -1
 274
 275         # Use page ranges, as a list of pages could exceed command line
 276         # maximum length (especially under Win32)
 277         for index in xrange(1, page_index + 1):
 278             if (not index in ps_or_pdf_pages) and skip:
 279                 # We were skipping pages but current page shouldn't be skipped.
 280                 # Add this page to -pp, it could stay alone or become the
 281                 # start of a range.
 282                 pages_parameter += str(index)
 283                 # Save the starting index to avoid things such as "11-11"
 284                 last = index
 285                 # We're not skipping anymore
 286                 skip = False
 287             elif (index in ps_or_pdf_pages) and (not skip):
 288                 # We weren't skipping but current page should be skipped
 289                 if last != index - 1:
 290                     # If the start index of the range is the previous page
 291                     # then it's not a range
 292                     pages_parameter += "-" + str(index - 1)
 293
 294                 # Add a separator
 295                 pages_parameter += ","
 296                 # Now we're skipping
 297                 skip = True
 298
 299         # Remove the trailing separator
 300         pages_parameter = pages_parameter.rstrip(",")
 301         # We've to manage the case in which the last page is closing a range
 302         if (not index in ps_or_pdf_pages) and (not skip) and (last != index):
 303                 pages_parameter += "-" + str(index)
 304
 305     return (ps_pages, pdf_pages, page_index, pages_parameter)
 306
 307 def main(argv):
 308     # Set defaults.
 309     dpi = 128
 310     fg_color = "000000"
 311     bg_color = "ffffff"
 312     bibtex = None
 313     latex = None
 314     lilypond = False
 315     lilypond_book = None
 316     output_format = "png"
 317     script_name = argv[0]
 318
 319     # Parse and manipulate the command line arguments.
 320     try:
 321         (opts, args) = getopt.gnu_getopt(argv[1:], "dhv", ["bibtex=", "bg=",
 322             "debug", "dpi=", "fg=", "help", "latex=", "lilypond",
 323             "lilypond-book=", "png", "ppm", "verbose"])
 324     except getopt.GetoptError, err:
 325         error("%s\n%s" % (err, usage(script_name)))
 326
 327     opts.reverse()
 328     for opt, val in opts:
 329         if opt in ("-h", "--help"):
 330             print usage(script_name)
 331             sys.exit(0)
 332         elif opt == "--bibtex":
 333             bibtex = [val]
 334         elif opt == "--bg":
 335             bg_color = val
 336         elif opt in ("-d", "--debug"):
 337             import lyxpreview_tools
 338             lyxpreview_tools.debug = True
 339         elif opt == "--dpi":
 340             try:
 341                 dpi = string.atoi(val)
 342             except:
 343                 error("Cannot convert %s to an integer value" % val)
 344         elif opt == "--fg":
 345             fg_color = val
 346         elif opt == "--latex":
 347             latex = [val]
 348         elif opt == "--lilypond":
 349             lilypond = True
 350         elif opt == "--lilypond-book":
 351             lilypond_book = [val]
 352         elif opt in ("--png", "--ppm"):
 353             output_format = opt[2:]
 354         elif opt in ("-v", "--verbose"):
 355             import lyxpreview_tools
 356             lyxpreview_tools.verbose = True
 357
 358     # Determine input file
 359     if len(args) != 1:
 360         err = "A single input file is required, %s given" % (len(args) or "none")
 361         error("%s\n%s" % (err, usage(script_name)))
 362
 363     input_path = args[0]
 364     dir, latex_file = os.path.split(input_path)
 365
 366     # Echo the settings
 367     progress("Starting %s..." % script_name)
 368     progress("Output format: %s" % output_format)
 369     progress("Foreground color: %s" % fg_color)
 370     progress("Background color: %s" % bg_color)
 371     progress("Resolution (dpi): %s" % dpi)
 372     progress("File to process: %s" % input_path)
 373
 374     # Check for the input file
 375     if not os.path.exists(input_path):
 376         error('File "%s" not found.' % input_path)
 377     if len(dir) != 0:
 378         os.chdir(dir)
 379
 380     fg_color_dvipng = make_texcolor(fg_color, False)
 381     bg_color_dvipng = make_texcolor(bg_color, False)
 382
 383     # External programs used by the script.
 384     latex = find_exe_or_terminate(latex or latex_commands)
 385     bibtex = find_exe(bibtex or bibtex_commands)
 386     if lilypond:
 387         lilypond_book = find_exe_or_terminate(lilypond_book or
 388             ["lilypond-book --safe"])
 389
 390     # These flavors of latex are known to produce pdf output
 391     pdf_output = latex in pdflatex_commands
 392
 393     progress("Latex command: %s" % latex)
 394     progress("Latex produces pdf output: %s" % pdf_output)
 395     progress("Bibtex command: %s" % bibtex)
 396     progress("Lilypond-book command: %s" % lilypond_book)
 397     progress("Preprocess through lilypond-book: %s" % lilypond)
 398     progress("Altering the latex file for font size and colors")
 399
 400     # Omit font size specification in latex file and make sure multiple
 401     # defined macros are not an issue.
 402     fix_latex_file(latex_file)
 403
 404     if lilypond:
 405         progress("Preprocess the latex file through %s" % lilypond_book)
 406         if pdf_output:
 407             lilypond_book += " --pdf"
 408         lilypond_book += " --latex-program=%s" % latex.split()[0]
 409
 410         # Make a copy of the latex file
 411         lytex_file = latex_file_re.sub(".lytex", latex_file)
 412         shutil.copyfile(latex_file, lytex_file)
 413
 414         # Preprocess the latex file through lilypond-book.
 415         lytex_status, lytex_stdout = run_tex(lilypond_book, lytex_file)
 416
 417     if pdf_output:
 418         progress("Using the legacy conversion method (PDF support)")
 419         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 420             bg_color, latex, pdf_output)
 421
 422     # This can go once dvipng becomes widespread.
 423     dvipng = find_exe(["dvipng"])
 424     if dvipng == None:
 425         progress("Using the legacy conversion method (dvipng not found)")
 426         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 427             bg_color, latex, pdf_output)
 428
 429     dv2dt = find_exe(["dv2dt"])
 430     if dv2dt == None:
 431         progress("Using the legacy conversion method (dv2dt not found)")
 432         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 433             bg_color, latex, pdf_output)
 434
 435     pngtopnm = ""
 436     if output_format == "ppm":
 437         pngtopnm = find_exe(["pngtopnm"])
 438         if pngtopnm == None:
 439             progress("Using the legacy conversion method (pngtopnm not found)")
 440             return legacy_conversion_step1(latex_file, dpi, output_format,
 441                 fg_color, bg_color, latex, pdf_output)
 442
 443     # Compile the latex file.
 444     latex_status, latex_stdout = run_latex(latex, latex_file, bibtex)
 445     if latex_status:
 446         warning("trying to recover from failed compilation")
 447
 448     # The dvi output file name
 449     dvi_file = latex_file_re.sub(".dvi", latex_file)
 450
 451     # If there's no DVI output, look for PDF and go to legacy or fail
 452     if not os.path.isfile(dvi_file):
 453         # No DVI, is there a PDF?
 454         pdf_file = latex_file_re.sub(".pdf", latex_file)
 455         if os.path.isfile(pdf_file):
 456             progress("%s produced a PDF output, fallback to legacy." \
 457                 % (os.path.basename(latex)))
 458             progress("Using the legacy conversion method (PDF support)")
 459             return legacy_conversion_step1(latex_file, dpi, output_format,
 460                 fg_color, bg_color, latex, True)
 461         else:
 462             error("No DVI or PDF output. %s failed." \
 463                 % (os.path.basename(latex)))
 464
 465     # Look for PS literals or inclusion of pdflatex files in DVI pages
 466     # ps_pages: list of indexes of pages containing PS literals
 467     # pdf_pages: list of indexes of pages requiring running pdflatex
 468     # page_count: total number of pages
 469     # pages_parameter: parameter for dvipng to exclude pages with PostScript
 470     (ps_pages, pdf_pages, page_count, pages_parameter) = find_ps_pages(dvi_file)
 471
 472     # If all pages need PostScript or pdflatex, directly use the legacy method.
 473     if len(ps_pages) == page_count:
 474         progress("Using the legacy conversion method (PostScript support)")
 475         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 476             bg_color, latex, pdf_output)
 477     elif len(pdf_pages) == page_count:
 478         progress("Using the legacy conversion method (PDF support)")
 479         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 480             bg_color, "pdflatex", True)
 481
 482     # Run the dvi file through dvipng.
 483     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
 484         % (dvipng, dpi, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
 485     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 486
 487     if dvipng_status:
 488         warning("%s failed to generate images from %s... fallback to legacy method" \
 489               % (os.path.basename(dvipng), dvi_file))
 490         progress("Using the legacy conversion method (dvipng failed)")
 491         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 492             bg_color, latex, pdf_output)
 493
 494     # Extract metrics info from dvipng_stdout.
 495     metrics_file = latex_file_re.sub(".metrics", latex_file)
 496     dvipng_metrics = extract_metrics_info(dvipng_stdout)
 497
 498     # If some pages require PostScript pass them to legacy method
 499     if len(ps_pages) > 0:
 500         # Create a new LaTeX file just for the snippets needing
 501         # the legacy method
 502         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 503         filter_pages(latex_file, legacy_latex_file, ps_pages)
 504
 505         # Pass the new LaTeX file to the legacy method
 506         progress("Pages %s include postscript specials" % ps_pages)
 507         progress("Using the legacy conversion method (PostScript support)")
 508         legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
 509             dpi, output_format, fg_color, bg_color, latex, pdf_output, True)
 510
 511         # Now we need to mix metrics data from dvipng and the legacy method
 512         original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
 513         destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 514
 515         # Join metrics from dvipng and legacy, and rename legacy bitmaps
 516         join_metrics_and_rename(dvipng_metrics, legacy_metrics, ps_pages,
 517             original_bitmap, destination_bitmap)
 518
 519     # If some pages require running pdflatex pass them to legacy method
 520     if len(pdf_pages) > 0:
 521         # Create a new LaTeX file just for the snippets needing
 522         # the legacy method
 523         legacy_latex_file = latex_file_re.sub("_legacy.tex", latex_file)
 524         filter_pages(latex_file, legacy_latex_file, pdf_pages)
 525
 526         # Pass the new LaTeX file to the legacy method
 527         progress("Pages %s require processing with pdflatex" % pdf_pages)
 528         progress("Using the legacy conversion method (PDF support)")
 529         legacy_status, legacy_metrics = legacy_conversion_step1(legacy_latex_file,
 530             dpi, output_format, fg_color, bg_color, "pdflatex", True, True)
 531
 532         # Now we need to mix metrics data from dvipng and the legacy method
 533         original_bitmap = latex_file_re.sub("%d." + output_format, legacy_latex_file)
 534         destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 535
 536         # Join metrics from dvipng and legacy, and rename legacy bitmaps
 537         join_metrics_and_rename(dvipng_metrics, legacy_metrics, pdf_pages,
 538             original_bitmap, destination_bitmap)
 539
 540     # Convert images to ppm format if necessary.
 541     if output_format == "ppm":
 542         convert_to_ppm_format(pngtopnm, latex_file_re.sub("", latex_file))
 543
 544     # Actually create the .metrics file
 545     write_metrics_info(dvipng_metrics, metrics_file)
 546
 547     return (0, dvipng_metrics)
 548
 549 if __name__ == "__main__":
 550     sys.exit(main(sys.argv)[0])