lib/scripts/legacy_lyxpreview2ppm.py

   1 # -*- coding: utf-8 -*-
   2
   3 # file legacy_lyxpreview2ppm.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 # Full author contact details are available in file CREDITS
   9
  10 # with much advice from members of the preview-latex project:
  11 #   David Kastrup, dak@gnu.org and
  12 #   Jan-Åke Larsson, jalar@mai.liu.se.
  13 # and with much help testing the code under Windows from
  14 #   Paul A. Rubin, rubin@msu.edu.
  15
  16 # This script takes a LaTeX file and generates a collection of
  17 # png or ppm image files, one per previewed snippet.
  18 # Example usage:
  19 # legacy_lyxpreview2bitmap.py 0lyxpreview.tex 128 ppm 000000 faf0e6
  20
  21 # This script takes five arguments:
  22 # TEXFILE:       the name of the .tex file to be converted.
  23 # SCALEFACTOR:   a scale factor, used to ascertain the resolution of the
  24 #                generated image which is then passed to gs.
  25 # OUTPUTFORMAT:  the format of the output bitmap image files.
  26 #                This particular script can produce only "ppm" format output.
  27 # FG_COLOR:      the foreground color as a hexadecimal string, eg '000000'.
  28 # BG_COLOR:      the background color as a hexadecimal string, eg 'faf0e6'.
  29
  30 # Decomposing TEXFILE's name as DIR/BASE.tex, this script will,
  31 # if executed successfully, leave in DIR:
  32 # * a (possibly large) number of image files with names
  33 #   like BASE[0-9]+.(ppm|png)
  34 # * a file BASE.metrics, containing info needed by LyX to position
  35 #   the images correctly on the screen.
  36
  37 # The script uses several external programs and files:
  38 # * python 2.4 or later (subprocess module);
  39 # * A latex executable;
  40 # * preview.sty;
  41 # * dvips;
  42 # * gs;
  43 # * pdflatex (optional);
  44 # * pnmcrop (optional).
  45 # * pdftocairo (optional).
  46 # * epstopdf (optional).
  47
  48 # preview.sty is part of the preview-latex project
  49 #   http://preview-latex.sourceforge.net/
  50 # Alternatively, it can be obtained from
  51 #   CTAN/support/preview-latex/
  52
  53 # What does this script do?
  54 # [legacy_conversion]
  55 # 0) Process command-line arguments
  56 # [legacy_conversion_step1]
  57 # 1) Call latex to create a DVI file from LaTeX
  58 # [legacy_conversion_step2]
  59 # 2) Call dvips to create one PS file for each DVI page
  60 # [legacy_conversion_step3]
  61 # 3) If dvips fails look for PDF and call pdftocairo or gs to produce bitmaps
  62 # 4) Otherwise call pdftocairo or gs on each PostScript file to produce bitmaps
  63 # [legacy_conversion_pdflatex]
  64 # 5) Keep track of pages on which gs failed and pass them to pdflatex
  65 # 6) Call pdftocairo or gs on the PDF output from pdflatex to produce bitmaps
  66 # 7) Extract and write to file (or return to lyxpreview2bitmap)
  67 #    metrics from both methods (standard and pdflatex)
  68
  69 # The script uses the old dvi->ps->png conversion route,
  70 # which is good when using PSTricks, TikZ or other packages involving
  71 # PostScript literals (steps 1, 2, 4).
  72 # This script also generates bitmaps from PDF created by a call to
  73 # lyxpreview2bitmap.py passing "pdflatex" to the CONVERTER parameter
  74 # (step 3).
  75 # Finally, there's also has a fallback method based on pdflatex, which
  76 # is required in certain cases, if hyperref is active for instance,
  77 # (step 5, 6).
  78 # If possible, dvipng should be used, as it's much faster.
  79 # If possible, the script will use pdftocairo instead of gs,
  80 # as it's much faster and gives better results.
  81
  82 import glob, os, pipes, re, string, sys
  83
  84 from lyxpreview_tools import check_latex_log, copyfileobj, error, filter_pages,\
  85      find_exe, find_exe_or_terminate, join_metrics_and_rename, latex_commands, \
  86      latex_file_re, make_texcolor, mkstemp, pdflatex_commands, progress, \
  87      run_command, run_latex, warning, write_metrics_info
  88
  89
  90 def usage(prog_name):
  91     return "Usage: %s <latex file> <dpi> ppm <fg color> <bg color>\n" \
  92            "\twhere the colors are hexadecimal strings, eg 'faf0e6'" \
  93            % prog_name
  94
  95 # Returns a list of tuples containing page number and ascent fraction
  96 # extracted from dvipng output.
  97 # Use write_metrics_info to create the .metrics file with this info
  98 def legacy_extract_metrics_info(log_file):
  99
 100     log_re = re.compile("Preview: ([ST])")
 101     data_re = re.compile("(-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)")
 102
 103     tp_ascent  = 0.0
 104     tp_descent = 0.0
 105
 106     success = 0
 107     results = []
 108     try:
 109         for line in open(log_file, 'r').readlines():
 110             match = log_re.match(line)
 111             if match == None:
 112                 continue
 113
 114             snippet = (match.group(1) == 'S')
 115             success = 1
 116             match = data_re.search(line)
 117             if match == None:
 118                 error("Unexpected data in %s\n%s" % (log_file, line))
 119
 120             if snippet:
 121                 ascent  = string.atof(match.group(2))
 122                 descent = string.atof(match.group(3))
 123
 124                 frac = 0.5
 125                 if ascent == 0 and descent == 0:
 126                     # This is an empty image, forbid its display
 127                     frac = -1.0
 128                 elif ascent >= 0 or descent >= 0:
 129                     ascent = ascent + tp_ascent
 130                     descent = descent - tp_descent
 131
 132                     if abs(ascent + descent) > 0.1:
 133                         frac = ascent / (ascent + descent)
 134
 135                     # Sanity check
 136                     if frac < 0 or frac > 1:
 137                             frac = 0.5
 138
 139                 results.append((int(match.group(1)), frac))
 140
 141             else:
 142                 tp_descent = string.atof(match.group(2))
 143                 tp_ascent  = string.atof(match.group(4))
 144
 145     except:
 146         # Unable to open the file, but do nothing here because
 147         # the calling function will act on the value of 'success'.
 148         warning('Warning in legacy_extract_metrics_info! Unable to open "%s"' % log_file)
 149         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 150
 151     if success == 0:
 152         error("Failed to extract metrics info from %s" % log_file)
 153
 154     return results
 155
 156 def extract_resolution(log_file, dpi):
 157     fontsize_re = re.compile("Preview: Fontsize")
 158     magnification_re = re.compile("Preview: Magnification")
 159     extract_decimal_re = re.compile("([0-9\.]+)")
 160     extract_integer_re = re.compile("([0-9]+)")
 161
 162     found_fontsize = 0
 163     found_magnification = 0
 164
 165     # Default values
 166     magnification = 1000.0
 167     fontsize = 10.0
 168
 169     try:
 170         for line in open(log_file, 'r').readlines():
 171             if found_fontsize and found_magnification:
 172                 break
 173
 174             if not found_fontsize:
 175                 match = fontsize_re.match(line)
 176                 if match != None:
 177                     match = extract_decimal_re.search(line)
 178                     if match == None:
 179                         error("Unable to parse: %s" % line)
 180                     fontsize = string.atof(match.group(1))
 181                     found_fontsize = 1
 182                     continue
 183
 184             if not found_magnification:
 185                 match = magnification_re.match(line)
 186                 if match != None:
 187                     match = extract_integer_re.search(line)
 188                     if match == None:
 189                         error("Unable to parse: %s" % line)
 190                     magnification = string.atof(match.group(1))
 191                     found_magnification = 1
 192                     continue
 193
 194     except:
 195         warning('Warning in extract_resolution! Unable to open "%s"' % log_file)
 196         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 197
 198     # This is safe because both fontsize and magnification have
 199     # non-zero default values.
 200     return dpi * (10.0 / fontsize) * (1000.0 / magnification)
 201
 202
 203 def legacy_latex_file(latex_file, fg_color, bg_color):
 204     use_preview_re = re.compile(r"\s*\\usepackage\[([^]]+)\]{preview}")
 205     fg_color_gr = make_texcolor(fg_color, True)
 206     bg_color_gr = make_texcolor(bg_color, True)
 207
 208     tmp = mkstemp()
 209
 210     success = 0
 211     try:
 212         f = open(latex_file, 'r')
 213     except:
 214         # Unable to open the file, but do nothing here because
 215         # the calling function will act on the value of 'success'.
 216         warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file)
 217         warning(`sys.exc_type` + ',' + `sys.exc_value`)
 218
 219     for line in f.readlines():
 220         if success:
 221             tmp.write(line)
 222             continue
 223         match = use_preview_re.match(line)
 224         if match == None:
 225             tmp.write(line)
 226             continue
 227         success = 1
 228         # Package order: color should be loaded before preview
 229         # Preview options: add the options lyx and tightpage
 230         tmp.write(r"""
 231 \usepackage{color}
 232 \definecolor{fg}{rgb}{%s}
 233 \definecolor{bg}{rgb}{%s}
 234 \pagecolor{bg}
 235 \usepackage[%s,tightpage]{preview}
 236 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{\usepackage{ae,aecomp}}
 237 \makeatletter
 238 \g@addto@macro\preview{\begingroup\color{bg}\special{ps::clippath fill}\color{fg}}
 239 \g@addto@macro\endpreview{\endgroup}
 240 \makeatother
 241 """ % (fg_color_gr, bg_color_gr, match.group(1)))
 242
 243     if success:
 244         copyfileobj(tmp, open(latex_file,"wb"), 1)
 245
 246     return success
 247
 248
 249 def crop_files(pnmcrop, basename):
 250     t = pipes.Template()
 251     t.append('%s -left' % pnmcrop, '--')
 252     t.append('%s -right' % pnmcrop, '--')
 253
 254     for file in glob.glob("%s*.ppm" % basename):
 255         tmp = mkstemp()
 256         new = t.open(file, "r")
 257         copyfileobj(new, tmp)
 258         if not new.close():
 259             copyfileobj(tmp, open(file,"wb"), 1)
 260
 261
 262 def legacy_conversion(argv, skipMetrics = False):
 263     # Parse and manipulate the command line arguments.
 264     if len(argv) == 7:
 265         latex = [argv[6]]
 266     elif len(argv) != 6:
 267         error(usage(argv[0]))
 268     else:
 269         latex = None
 270
 271     dir, latex_file = os.path.split(argv[1])
 272     if len(dir) != 0:
 273         os.chdir(dir)
 274
 275     dpi = string.atoi(argv[2])
 276
 277     output_format = argv[3]
 278
 279     fg_color = argv[4]
 280     bg_color = argv[5]
 281
 282     # External programs used by the script.
 283     latex = find_exe_or_terminate(latex or latex_commands)
 284
 285     pdf_output = latex in pdflatex_commands
 286
 287     return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 288         bg_color, latex, pdf_output, skipMetrics)
 289
 290
 291 # Add color info to the latex file, since ghostscript doesn't
 292 # have the option to set foreground and background colors on
 293 # the command line. Run the resulting file through latex.
 294 def legacy_conversion_step1(latex_file, dpi, output_format, fg_color, bg_color,
 295                             latex, pdf_output = False, skipMetrics = False):
 296
 297     # Move color information, lyx and tightpage options into the latex file.
 298     if not legacy_latex_file(latex_file, fg_color, bg_color):
 299         error("""Unable to move the color information, and the lyx and tightpage
 300             options of preview-latex, into the latex file""")
 301
 302     # Compile the latex file.
 303     latex_status, latex_stdout = run_latex(latex, latex_file)
 304     if latex_status:
 305         warning("trying to recover from failed compilation")
 306
 307     if pdf_output:
 308         return legacy_conversion_step3(latex_file, dpi, output_format, True, skipMetrics)
 309     else:
 310         return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics)
 311
 312 # Creates a new LaTeX file from the original with pages specified in
 313 # failed_pages, pass it through pdflatex and updates the metrics
 314 # from the standard legacy route
 315 def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics,
 316     use_pdftocairo, conv, gs_device, gs_ext, alpha, resolution, output_format):
 317
 318     # Search for pdflatex executable
 319     pdflatex = find_exe(["pdflatex"])
 320     if pdflatex == None:
 321         warning("Can't find pdflatex. Some pages failed with all the possible routes.")
 322     else:
 323         # Create a new LaTeX file from the original but only with failed pages
 324         pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file)
 325         filter_pages(latex_file, pdf_latex_file, failed_pages)
 326
 327         # pdflatex call
 328         error_pages = []
 329         pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file)
 330         if pdflatex_status:
 331             error_pages = check_latex_log(latex_file_re.sub(".log", pdf_latex_file))
 332
 333         pdf_file = latex_file_re.sub(".pdf", pdf_latex_file)
 334         latex_file_root = latex_file_re.sub("", pdf_latex_file)
 335
 336         # Converter call to produce bitmaps
 337         if use_pdftocairo:
 338             conv_call = '%s -png -transp -r %d "%s" "%s"' \
 339                         % (conv, resolution, pdf_file, latex_file_root)
 340             conv_status, conv_stdout = run_command(conv_call)
 341             if not conv_status:
 342                 seqnum_re = re.compile("-([0-9]+)")
 343                 for name in glob.glob("%s-*.png" % latex_file_root):
 344                     match = seqnum_re.search(name)
 345                     if match != None:
 346                         new_name = seqnum_re.sub(str(int(match.group(1))), name)
 347                         os.rename(name, new_name)
 348         else:
 349             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 350                         '-sOutputFile="%s%%d.%s" ' \
 351                         '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 352                         '-r%f "%s"' \
 353                         % (conv, gs_device, latex_file_root, \
 354                             gs_ext, alpha, alpha, resolution, pdf_file)
 355             conv_status, conv_stdout = run_command(conv_call)
 356
 357         if conv_status:
 358             # Give up!
 359             warning("Some pages failed with all the possible routes")
 360         else:
 361             # We've done it!
 362             pdf_log_file = latex_file_re.sub(".log", pdf_latex_file)
 363             pdf_metrics = legacy_extract_metrics_info(pdf_log_file)
 364
 365             # Invalidate metrics for pages that produced errors
 366             if len(error_pages) > 0:
 367                 for index in error_pages:
 368                     pdf_metrics.pop(index - 1)
 369                     pdf_metrics.insert(index - 1, (index, -1.0))
 370
 371             original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file)
 372             destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 373
 374             # Join the metrics with the those from dvips and rename the bitmap images
 375             join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages,
 376                 original_bitmap, destination_bitmap)
 377
 378
 379 # The file has been processed through latex and we expect dvi output.
 380 # Run dvips, taking note whether it was successful.
 381 def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False):
 382     # External programs used by the script.
 383     dvips   = find_exe_or_terminate(["dvips"])
 384
 385     # Run the dvi file through dvips.
 386     dvi_file = latex_file_re.sub(".dvi", latex_file)
 387     ps_file  = latex_file_re.sub(".ps",  latex_file)
 388
 389     dvips_call = '%s -i -o "%s" "%s"' % (dvips, ps_file, dvi_file)
 390     dvips_failed = False
 391
 392     dvips_status, dvips_stdout = run_command(dvips_call)
 393     if dvips_status:
 394         warning('Failed: %s %s ... looking for PDF' \
 395             % (os.path.basename(dvips), dvi_file))
 396         dvips_failed = True
 397
 398     return legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics)
 399
 400
 401 # Either latex and dvips have been run and we have a ps file, or
 402 # pdflatex has been run and we have a pdf file. Proceed with pdftocairo or gs.
 403 def legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics = False):
 404     # External programs used by the script.
 405     gs      = find_exe_or_terminate(["gswin32c", "gswin64c", "gs"])
 406     pnmcrop = find_exe(["pnmcrop"])
 407     pdftocairo = find_exe(["pdftocairo"])
 408     epstopdf   = find_exe(["epstopdf"])
 409     use_pdftocairo = pdftocairo != None and output_format == "png"
 410     if use_pdftocairo:
 411         conv = pdftocairo
 412     else:
 413         conv = gs
 414
 415     # Files to process
 416     pdf_file  = latex_file_re.sub(".pdf", latex_file)
 417     ps_file  = latex_file_re.sub(".ps",  latex_file)
 418
 419     # The latex file name without extension
 420     latex_file_root = latex_file_re.sub("", latex_file)
 421
 422     # Extract resolution data for the converter from the log file.
 423     log_file = latex_file_re.sub(".log", latex_file)
 424     resolution = extract_resolution(log_file, dpi)
 425
 426     # Check whether some pages produced errors
 427     error_pages = check_latex_log(log_file)
 428
 429     # Older versions of gs have problems with a large degree of
 430     # anti-aliasing at high resolutions
 431     alpha = 4
 432     if resolution > 150:
 433         alpha = 2
 434
 435     gs_device = "png16m"
 436     gs_ext = "png"
 437     if output_format == "ppm":
 438         gs_device = "pnmraw"
 439         gs_ext = "ppm"
 440
 441     # Extract the metrics from the log file
 442     legacy_metrics = legacy_extract_metrics_info(log_file)
 443
 444     # List of pages which failed to produce a correct output
 445     failed_pages = []
 446
 447     # Generate the bitmap images
 448     if dvips_failed:
 449         # dvips failed, maybe there's a PDF, try to produce bitmaps
 450         if use_pdftocairo:
 451             conv_call = '%s -png -transp -r %d "%s" "%s"' \
 452                         % (pdftocairo, resolution, pdf_file, latex_file_root)
 453
 454             conv_status, conv_stdout = run_command(conv_call)
 455             if not conv_status:
 456                 seqnum_re = re.compile("-([0-9]+)")
 457                 for name in glob.glob("%s-*.png" % latex_file_root):
 458                     match = seqnum_re.search(name)
 459                     if match != None:
 460                         new_name = seqnum_re.sub(str(int(match.group(1))), name)
 461                         os.rename(name, new_name)
 462         else:
 463             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 464                       '-sOutputFile="%s%%d.%s" ' \
 465                       '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 466                       '-r%f "%s"' \
 467                       % (gs, gs_device, latex_file_root, \
 468                          gs_ext, alpha, alpha, resolution, pdf_file)
 469
 470             conv_status, conv_stdout = run_command(conv_call)
 471
 472         if conv_status:
 473             error("Failed: %s %s" % (os.path.basename(conv), pdf_file))
 474     else:
 475         # Model for calling the converter on each file
 476         if use_pdftocairo and epstopdf != None:
 477             conv_call = '%s -png -transp -singlefile -r %d "%%s" "%s%%d"' \
 478                         % (pdftocairo, resolution, latex_file_root)
 479         else:
 480             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 481                         '-sOutputFile="%s%%d.%s" ' \
 482                         '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 483                         '-r%f "%%s"' \
 484                         % (gs, gs_device, latex_file_root, \
 485                            gs_ext, alpha, alpha, resolution)
 486
 487         i = 0
 488         # Collect all the PostScript files (like *.001, *.002, ...)
 489         ps_files = glob.glob("%s.[0-9][0-9][0-9]" % latex_file_root)
 490         ps_files.sort()
 491
 492         # Call the converter for each file
 493         for file in ps_files:
 494             i = i + 1
 495             progress("Processing page %s, file %s" % (i, file))
 496             if use_pdftocairo and epstopdf != None:
 497                 conv_name = "epstopdf"
 498                 conv_status, conv_stdout = run_command("%s --outfile=%s.pdf %s"
 499                                                        % (epstopdf, file, file))
 500                 if not conv_status:
 501                     conv_name = "pdftocairo"
 502                     file = file + ".pdf"
 503                     conv_status, conv_stdout = run_command(conv_call % (file, i))
 504             else:
 505                 conv_name = "ghostscript"
 506                 conv_status, conv_stdout = run_command(conv_call % (i, file))
 507
 508             if conv_status:
 509                 # The converter failed, keep track of this
 510                 warning("%s failed on page %s, file %s" % (conv_name, i, file))
 511                 failed_pages.append(i)
 512
 513     # Pass failed pages to pdflatex
 514     if len(failed_pages) > 0:
 515         warning("Now trying to obtain failed previews through pdflatex")
 516         legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics,
 517             use_pdftocairo, conv, gs_device, gs_ext, alpha, resolution,
 518             output_format)
 519
 520     # Invalidate metrics for pages that produced errors
 521     if len(error_pages) > 0:
 522         for index in error_pages:
 523             if index not in failed_pages:
 524                 legacy_metrics.pop(index - 1)
 525                 legacy_metrics.insert(index - 1, (index, -1.0))
 526
 527     # Crop the ppm images
 528     if pnmcrop != None and output_format == "ppm":
 529         crop_files(pnmcrop, latex_file_root)
 530
 531     # Allow to skip .metrics creation for custom management
 532     # (see the dvipng method)
 533     if not skipMetrics:
 534         # Extract metrics info from the log file.
 535         metrics_file = latex_file_re.sub(".metrics", latex_file)
 536         write_metrics_info(legacy_metrics, metrics_file)
 537
 538     return (0, legacy_metrics)
 539
 540
 541 if __name__ == "__main__":
 542     sys.exit(legacy_conversion(sys.argv)[0])