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 \makeatletter
 237 \def\t@a{cmr}
 238 \if\f@family\t@a
 239 \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{\usepackage{ae,aecompl}}
 240 \fi
 241 \g@addto@macro\preview{\begingroup\color{bg}\special{ps::clippath fill}\color{fg}}
 242 \g@addto@macro\endpreview{\endgroup}
 243 \makeatother
 244 """ % (fg_color_gr, bg_color_gr, match.group(1)))
 245
 246     if success:
 247         copyfileobj(tmp, open(latex_file,"wb"), 1)
 248
 249     return success
 250
 251
 252 def crop_files(pnmcrop, basename):
 253     t = pipes.Template()
 254     t.append('%s -left' % pnmcrop, '--')
 255     t.append('%s -right' % pnmcrop, '--')
 256
 257     for file in glob.glob("%s*.ppm" % basename):
 258         tmp = mkstemp()
 259         new = t.open(file, "r")
 260         copyfileobj(new, tmp)
 261         if not new.close():
 262             copyfileobj(tmp, open(file,"wb"), 1)
 263
 264
 265 def legacy_conversion(argv, skipMetrics = False):
 266     # Parse and manipulate the command line arguments.
 267     if len(argv) == 7:
 268         latex = [argv[6]]
 269     elif len(argv) != 6:
 270         error(usage(argv[0]))
 271     else:
 272         latex = None
 273
 274     dir, latex_file = os.path.split(argv[1])
 275     if len(dir) != 0:
 276         os.chdir(dir)
 277
 278     dpi = string.atoi(argv[2])
 279
 280     output_format = argv[3]
 281
 282     fg_color = argv[4]
 283     bg_color = argv[5]
 284
 285     # External programs used by the script.
 286     latex = find_exe_or_terminate(latex or latex_commands)
 287
 288     pdf_output = latex in pdflatex_commands
 289
 290     return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
 291         bg_color, latex, pdf_output, skipMetrics)
 292
 293
 294 # Add color info to the latex file, since ghostscript doesn't
 295 # have the option to set foreground and background colors on
 296 # the command line. Run the resulting file through latex.
 297 def legacy_conversion_step1(latex_file, dpi, output_format, fg_color, bg_color,
 298                             latex, pdf_output = False, skipMetrics = False):
 299
 300     # Move color information, lyx and tightpage options into the latex file.
 301     if not legacy_latex_file(latex_file, fg_color, bg_color):
 302         error("""Unable to move the color information, and the lyx and tightpage
 303             options of preview-latex, into the latex file""")
 304
 305     # Compile the latex file.
 306     latex_status, latex_stdout = run_latex(latex, latex_file)
 307     if latex_status:
 308         progress("Will try to recover from %s failure" % latex)
 309
 310     if pdf_output:
 311         return legacy_conversion_step3(latex_file, dpi, output_format, True, skipMetrics)
 312     else:
 313         return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics)
 314
 315 # Creates a new LaTeX file from the original with pages specified in
 316 # failed_pages, pass it through pdflatex and updates the metrics
 317 # from the standard legacy route
 318 def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics,
 319     use_pdftocairo, conv, gs_device, gs_ext, alpha, resolution, output_format):
 320
 321     # Search for pdflatex executable
 322     pdflatex = find_exe(["pdflatex"])
 323     if pdflatex == None:
 324         warning("Can't find pdflatex. Some pages failed with all the possible routes.")
 325     else:
 326         # Create a new LaTeX file from the original but only with failed pages
 327         pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file)
 328         filter_pages(latex_file, pdf_latex_file, failed_pages)
 329
 330         # pdflatex call
 331         error_pages = []
 332         pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file)
 333         if pdflatex_status:
 334             error_pages = check_latex_log(latex_file_re.sub(".log", pdf_latex_file))
 335
 336         pdf_file = latex_file_re.sub(".pdf", pdf_latex_file)
 337         latex_file_root = latex_file_re.sub("", pdf_latex_file)
 338
 339         # Converter call to produce bitmaps
 340         if use_pdftocairo:
 341             conv_call = '%s -png -transp -r %d "%s" "%s"' \
 342                         % (conv, resolution, pdf_file, latex_file_root)
 343             conv_status, conv_stdout = run_command(conv_call)
 344             if not conv_status:
 345                 seqnum_re = re.compile("-([0-9]+)")
 346                 for name in glob.glob("%s-*.png" % latex_file_root):
 347                     match = seqnum_re.search(name)
 348                     if match != None:
 349                         new_name = seqnum_re.sub(str(int(match.group(1))), name)
 350                         os.rename(name, new_name)
 351         else:
 352             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 353                         '-sOutputFile="%s%%d.%s" ' \
 354                         '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 355                         '-r%f "%s"' \
 356                         % (conv, gs_device, latex_file_root, \
 357                             gs_ext, alpha, alpha, resolution, pdf_file)
 358             conv_status, conv_stdout = run_command(conv_call)
 359
 360         if conv_status:
 361             # Give up!
 362             warning("Some pages failed with all the possible routes")
 363         else:
 364             # We've done it!
 365             pdf_log_file = latex_file_re.sub(".log", pdf_latex_file)
 366             pdf_metrics = legacy_extract_metrics_info(pdf_log_file)
 367
 368             # Invalidate metrics for pages that produced errors
 369             if len(error_pages) > 0:
 370                 for index in error_pages:
 371                     pdf_metrics.pop(index - 1)
 372                     pdf_metrics.insert(index - 1, (index, -1.0))
 373
 374             original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file)
 375             destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file)
 376
 377             # Join the metrics with the those from dvips and rename the bitmap images
 378             join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages,
 379                 original_bitmap, destination_bitmap)
 380
 381
 382 # The file has been processed through latex and we expect dvi output.
 383 # Run dvips, taking note whether it was successful.
 384 def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False):
 385     # External programs used by the script.
 386     dvips   = find_exe_or_terminate(["dvips"])
 387
 388     # Run the dvi file through dvips.
 389     dvi_file = latex_file_re.sub(".dvi", latex_file)
 390     ps_file  = latex_file_re.sub(".ps",  latex_file)
 391
 392     dvips_call = '%s -i -o "%s" "%s"' % (dvips, ps_file, dvi_file)
 393     dvips_failed = False
 394
 395     dvips_status, dvips_stdout = run_command(dvips_call)
 396     if dvips_status:
 397         warning('Failed: %s %s ... looking for PDF' \
 398             % (os.path.basename(dvips), dvi_file))
 399         dvips_failed = True
 400
 401     return legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics)
 402
 403
 404 # Either latex and dvips have been run and we have a ps file, or
 405 # pdflatex has been run and we have a pdf file. Proceed with pdftocairo or gs.
 406 def legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics = False):
 407     # External programs used by the script.
 408     gs      = find_exe_or_terminate(["gswin32c", "gswin64c", "gs"])
 409     pnmcrop = find_exe(["pnmcrop"])
 410     pdftocairo = find_exe(["pdftocairo"])
 411     epstopdf   = find_exe(["epstopdf"])
 412     use_pdftocairo = pdftocairo != None and output_format == "png"
 413     if use_pdftocairo:
 414         conv = pdftocairo
 415     else:
 416         conv = gs
 417
 418     # Files to process
 419     pdf_file  = latex_file_re.sub(".pdf", latex_file)
 420     ps_file  = latex_file_re.sub(".ps",  latex_file)
 421
 422     # The latex file name without extension
 423     latex_file_root = latex_file_re.sub("", latex_file)
 424
 425     # Extract resolution data for the converter from the log file.
 426     log_file = latex_file_re.sub(".log", latex_file)
 427     resolution = extract_resolution(log_file, dpi)
 428
 429     # Check whether some pages produced errors
 430     error_pages = check_latex_log(log_file)
 431
 432     # Older versions of gs have problems with a large degree of
 433     # anti-aliasing at high resolutions
 434     alpha = 4
 435     if resolution > 150:
 436         alpha = 2
 437
 438     gs_device = "png16m"
 439     gs_ext = "png"
 440     if output_format == "ppm":
 441         gs_device = "pnmraw"
 442         gs_ext = "ppm"
 443
 444     # Extract the metrics from the log file
 445     legacy_metrics = legacy_extract_metrics_info(log_file)
 446
 447     # List of pages which failed to produce a correct output
 448     failed_pages = []
 449
 450     # Generate the bitmap images
 451     if dvips_failed:
 452         # dvips failed, maybe there's a PDF, try to produce bitmaps
 453         if use_pdftocairo:
 454             conv_call = '%s -png -transp -r %d "%s" "%s"' \
 455                         % (pdftocairo, resolution, pdf_file, latex_file_root)
 456
 457             conv_status, conv_stdout = run_command(conv_call)
 458             if not conv_status:
 459                 seqnum_re = re.compile("-([0-9]+)")
 460                 for name in glob.glob("%s-*.png" % latex_file_root):
 461                     match = seqnum_re.search(name)
 462                     if match != None:
 463                         new_name = seqnum_re.sub(str(int(match.group(1))), name)
 464                         os.rename(name, new_name)
 465         else:
 466             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 467                       '-sOutputFile="%s%%d.%s" ' \
 468                       '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 469                       '-r%f "%s"' \
 470                       % (gs, gs_device, latex_file_root, \
 471                          gs_ext, alpha, alpha, resolution, pdf_file)
 472
 473             conv_status, conv_stdout = run_command(conv_call)
 474
 475         if conv_status:
 476             error("Failed: %s %s" % (os.path.basename(conv), pdf_file))
 477     else:
 478         # Model for calling the converter on each file
 479         if use_pdftocairo and epstopdf != None:
 480             conv_call = '%s -png -transp -singlefile -r %d "%%s" "%s%%d"' \
 481                         % (pdftocairo, resolution, latex_file_root)
 482         else:
 483             conv_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \
 484                         '-sOutputFile="%s%%d.%s" ' \
 485                         '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \
 486                         '-r%f "%%s"' \
 487                         % (gs, gs_device, latex_file_root, \
 488                            gs_ext, alpha, alpha, resolution)
 489
 490         i = 0
 491         # Collect all the PostScript files (like *.001, *.002, ...)
 492         ps_files = glob.glob("%s.[0-9][0-9][0-9]" % latex_file_root)
 493         ps_files.sort()
 494
 495         # Call the converter for each file
 496         for file in ps_files:
 497             i = i + 1
 498             progress("Processing page %s, file %s" % (i, file))
 499             if use_pdftocairo and epstopdf != None:
 500                 conv_name = "epstopdf"
 501                 conv_status, conv_stdout = run_command("%s --outfile=%s.pdf %s"
 502                                                        % (epstopdf, file, file))
 503                 if not conv_status:
 504                     conv_name = "pdftocairo"
 505                     file = file + ".pdf"
 506                     conv_status, conv_stdout = run_command(conv_call % (file, i))
 507             else:
 508                 conv_name = "ghostscript"
 509                 conv_status, conv_stdout = run_command(conv_call % (i, file))
 510
 511             if conv_status:
 512                 # The converter failed, keep track of this
 513                 warning("%s failed on page %s, file %s" % (conv_name, i, file))
 514                 failed_pages.append(i)
 515
 516     # Pass failed pages to pdflatex
 517     if len(failed_pages) > 0:
 518         warning("Now trying to obtain failed previews through pdflatex")
 519         error_count = legacy_conversion_pdflatex(latex_file, failed_pages,
 520             legacy_metrics, use_pdftocairo, conv, gs_device, gs_ext, alpha,
 521             resolution, output_format)
 522     else:
 523         error_count = 0
 524
 525     # Invalidate metrics for pages that produced errors
 526     if len(error_pages) > 0:
 527         for index in error_pages:
 528             if index not in failed_pages:
 529                 legacy_metrics.pop(index - 1)
 530                 legacy_metrics.insert(index - 1, (index, -1.0))
 531                 error_count += 1
 532
 533     # Crop the ppm images
 534     if pnmcrop != None and output_format == "ppm":
 535         crop_files(pnmcrop, latex_file_root)
 536
 537     # Allow to skip .metrics creation for custom management
 538     # (see the dvipng method)
 539     if not skipMetrics:
 540         # Extract metrics info from the log file.
 541         metrics_file = latex_file_re.sub(".metrics", latex_file)
 542         write_metrics_info(legacy_metrics, metrics_file)
 543         if error_count:
 544             warning("Failed to produce %d preview snippet(s)" % error_count)
 545
 546     return (0, legacy_metrics)
 547
 548
 549 if __name__ == "__main__":
 550     sys.exit(legacy_conversion(sys.argv)[0])