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