X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Fscripts%2Flegacy_lyxpreview2ppm.py;h=7c6e1e6274dc562e675a5fce85aa64fbd5d64e15;hb=c0bbc020a56e0e55fe4a07230ab6d9851fef0c24;hp=87cfe32194a35397bf667297f2eb13b47bf84809;hpb=adf6faf4d48b5dca02e0686f301b67f8293b2211;p=lyx.git diff --git a/lib/scripts/legacy_lyxpreview2ppm.py b/lib/scripts/legacy_lyxpreview2ppm.py index 87cfe32194..7c6e1e6274 100644 --- a/lib/scripts/legacy_lyxpreview2ppm.py +++ b/lib/scripts/legacy_lyxpreview2ppm.py @@ -15,7 +15,7 @@ # Paul A. Rubin, rubin@msu.edu. # This script takes a LaTeX file and generates a collection of -# ppm image files, one per previewed snippet. +# png or ppm image files, one per previewed snippet. # Example usage: # legacy_lyxpreview2bitmap.py 0lyxpreview.tex 128 ppm 000000 faf0e6 @@ -31,15 +31,17 @@ # Decomposing TEXFILE's name as DIR/BASE.tex, this script will, # if executed successfully, leave in DIR: # * a (possibly large) number of image files with names -# like BASE[0-9]+.ppm +# like BASE[0-9]+.(ppm|png) # * a file BASE.metrics, containing info needed by LyX to position # the images correctly on the screen. # The script uses several external programs and files: +# * python 2.4 or later (subprocess module); # * A latex executable; # * preview.sty; # * dvips; # * gs; +# * pdflatex (optional); # * pnmcrop (optional). # preview.sty is part of the preview-latex project @@ -47,25 +49,44 @@ # Alternatively, it can be obtained from # CTAN/support/preview-latex/ -# The script uses the deprecated dvi->ps->ppm conversion route. -# If possible, please grab 'dvipng'; it's faster and more robust. -# If you have it then this script will not be invoked by -# lyxpreview2bitmap.py. -# Warning: this legacy support will be removed one day... +# What does this script do? +# [legacy_conversion] +# 0) Process command-line arguments +# [legacy_conversion_step1] +# 1) Call latex to create a DVI file from LaTeX +# [legacy_conversion_step2] +# 2) Call dvips to create one PS file for each DVI page +# [legacy_conversion_step3] +# 3) If dvips fails look for PDF and call gs to produce bitmaps +# 4) Otherwise call gs on each PostScript file to produce bitmaps +# [legacy_conversion_pdflatex] +# 5) Keep track of pages on which gs failed and pass them to pdflatex +# 6) Call gs on the PDF output from pdflatex to produce bitmaps +# 7) Extract and write to file (or return to lyxpreview2bitmap) +# metrics from both methods (standard and pdflatex) + +# The script uses the old dvi->ps->png conversion route, +# which is good when using PSTricks, TikZ or other packages involving +# PostScript literals (steps 1, 2, 4). +# This script also generates bitmaps from PDF created by a call to +# lyxpreview2bitmap.py passing "pdflatex" to the CONVERTER parameter +# (step 3). +# Finally, there's also has a fallback method based on pdflatex, which +# is required in certain cases, if hyperref is active for instance, +# (step 5, 6). +# If possible, dvipng should be used, as it's much faster. import glob, os, pipes, re, string, sys -from lyxpreview_tools import copyfileobj, error, find_exe, \ - find_exe_or_terminate, make_texcolor, mkstemp, run_command, warning, \ - write_metrics_info, filter_pages, join_metrics_and_rename - -# Pre-compiled regular expression. -latex_file_re = re.compile("\.tex$") +from lyxpreview_tools import copyfileobj, error, filter_pages, find_exe, \ + find_exe_or_terminate, join_metrics_and_rename, latex_commands, \ + latex_file_re, make_texcolor, mkstemp, pdflatex_commands, progress, \ + run_command, run_latex, warning, write_metrics_info def usage(prog_name): - return "Usage: %s ppm \n"\ - "\twhere the colors are hexadecimal strings, eg 'faf0e6'"\ + return "Usage: %s ppm \n" \ + "\twhere the colors are hexadecimal strings, eg 'faf0e6'" \ % prog_name # Returns a list of tuples containing page number and ascent fraction @@ -120,10 +141,10 @@ def legacy_extract_metrics_info(log_file): # the calling function will act on the value of 'success'. warning('Warning in legacy_extract_metrics_info! Unable to open "%s"' % log_file) warning(`sys.exc_type` + ',' + `sys.exc_value`) - + if success == 0: error("Failed to extract metrics info from %s" % log_file) - + return results def extract_resolution(log_file, dpi): @@ -173,42 +194,45 @@ def extract_resolution(log_file, dpi): return dpi * (10.0 / fontsize) * (1000.0 / magnification) -def legacy_latex_file(latex_file, fg_color, bg_color, bg_color_gr): - use_preview_dvi_re = re.compile("(\s*\\\\usepackage\[[^]]+)(dvips\]{preview})") - use_preview_pdf_re = re.compile("(\s*\\\\usepackage\[[^]]+)(pdftex\]{preview})") +def legacy_latex_file(latex_file, fg_color, bg_color): + use_preview_re = re.compile(r"\s*\\usepackage\[([^]]+)\]{preview}") + fg_color_gr = make_texcolor(fg_color, True) + bg_color_gr = make_texcolor(bg_color, True) tmp = mkstemp() success = 0 try: - for line in open(latex_file, 'r').readlines(): - match = use_preview_dvi_re.match(line) - if match == None: - match = use_preview_pdf_re.match(line) - if match == None: - tmp.write(line) - continue - success = 1 - tmp.write(" \\usepackage{color}\n" \ - " \\pagecolor[rgb]{%s}\n" \ - "%s\n" \ - % (bg_color_gr, match.group())) - continue - - success = 1 - tmp.write("%stightpage,%s\n" \ - " \\AtBeginDocument{\\AtBeginDvi{%%\n" \ - " \\special{!userdict begin/bop-hook{//bop-hook exec\n" \ - " <%s%s>{255 div}forall setrgbcolor\n" \ - " clippath fill setrgbcolor}bind def end}}}\n" \ - % (match.group(1), match.group(2), fg_color, bg_color)) - + f = open(latex_file, 'r') except: # Unable to open the file, but do nothing here because # the calling function will act on the value of 'success'. warning('Warning in legacy_latex_file! Unable to open "%s"' % latex_file) warning(`sys.exc_type` + ',' + `sys.exc_value`) + for line in f.readlines(): + if success: + tmp.write(line) + continue + match = use_preview_re.match(line) + if match == None: + tmp.write(line) + continue + success = 1 + # Package order: color should be loaded before preview + # Preview options: add the options lyx and tightpage + tmp.write(r""" +\usepackage{color} +\definecolor{fg}{rgb}{%s} +\definecolor{bg}{rgb}{%s} +\pagecolor{bg} +\usepackage[%s,lyx,tightpage]{preview} +\makeatletter +\g@addto@macro\preview{\begingroup\color{bg}\special{ps::clippath fill}\color{fg}} +\g@addto@macro\endpreview{\endgroup} +\makeatother +""" % (fg_color_gr, bg_color_gr, match.group(1))) + if success: copyfileobj(tmp, open(latex_file,"wb"), 1) @@ -229,12 +253,13 @@ def crop_files(pnmcrop, basename): def legacy_conversion(argv, skipMetrics = False): - latex_commands = ["latex", "pplatex", "platex", "latex2e"] # Parse and manipulate the command line arguments. if len(argv) == 7: - latex_commands = [argv[6]] + latex = [argv[6]] elif len(argv) != 6: error(usage(argv[0])) + else: + latex = None dir, latex_file = os.path.split(argv[1]) if len(dir) != 0: @@ -246,48 +271,112 @@ def legacy_conversion(argv, skipMetrics = False): fg_color = argv[4] bg_color = argv[5] - bg_color_gr = make_texcolor(argv[5], True) # External programs used by the script. - path = string.split(os.environ["PATH"], os.pathsep) - latex = find_exe_or_terminate(latex_commands, path) + latex = find_exe_or_terminate(latex or latex_commands) + + pdf_output = latex in pdflatex_commands + + return legacy_conversion_step1(latex_file, dpi, output_format, fg_color, + bg_color, latex, pdf_output, skipMetrics) + + +# Add color info to the latex file, since ghostscript doesn't +# have the option to set foreground and background colors on +# the command line. Run the resulting file through latex. +def legacy_conversion_step1(latex_file, dpi, output_format, fg_color, bg_color, + latex, pdf_output = False, skipMetrics = False): - # Move color information into the latex file. - if not legacy_latex_file(latex_file, fg_color, bg_color, bg_color_gr): - error("Unable to move color info into the latex file") + # Move color information, lyx and tightpage options into the latex file. + if not legacy_latex_file(latex_file, fg_color, bg_color): + error("""Unable to move the color information, and the lyx and tightpage + options of preview-latex, into the latex file""") # Compile the latex file. - latex_call = '%s "%s"' % (latex, latex_file) + latex_status, latex_stdout = run_latex(latex, latex_file) - latex_status, latex_stdout = run_command(latex_call) - if latex_status != None: - warning("%s had problems compiling %s" \ - % (os.path.basename(latex), latex_file)) + if pdf_output: + return legacy_conversion_step3(latex_file, dpi, output_format, True, skipMetrics) + else: + return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics) + +# Creates a new LaTeX file from the original with pages specified in +# failed_pages, pass it through pdflatex and updates the metrics +# from the standard legacy route +def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs, + gs_device, gs_ext, alpha, resolution, output_format): + + # Search for pdflatex executable + pdflatex = find_exe(["pdflatex"]) + if pdflatex == None: + warning("Can't find pdflatex. Some pages failed with all the possible routes.") + else: + # Create a new LaTeX file from the original but only with failed pages + pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file) + filter_pages(latex_file, pdf_latex_file, failed_pages) - return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics) + # pdflatex call + pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file) + pdf_file = latex_file_re.sub(".pdf", pdf_latex_file) + # GhostScript call to produce bitmaps + gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \ + '-sOutputFile="%s%%d.%s" ' \ + '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \ + '-r%f "%s"' \ + % (gs, gs_device, latex_file_re.sub("", pdf_latex_file), \ + gs_ext, alpha, alpha, resolution, pdf_file) + gs_status, gs_stdout = run_command(gs_call) + if gs_status: + # Give up! + warning("Some pages failed with all the possible routes") + else: + # We've done it! + pdf_log_file = latex_file_re.sub(".log", pdf_latex_file) + pdf_metrics = legacy_extract_metrics_info(pdf_log_file) + + original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file) + destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file) + + # Join the metrics with the those from dvips and rename the bitmap images + join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages, + original_bitmap, destination_bitmap) + + +# The file has been processed through latex and we expect dvi output. +# Run dvips, taking note whether it was successful. def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False): # External programs used by the script. - path = string.split(os.environ["PATH"], os.pathsep) - dvips = find_exe_or_terminate(["dvips"], path) - gs = find_exe_or_terminate(["gswin32c", "gs"], path) - pnmcrop = find_exe(["pnmcrop"], path) + dvips = find_exe_or_terminate(["dvips"]) # Run the dvi file through dvips. dvi_file = latex_file_re.sub(".dvi", latex_file) ps_file = latex_file_re.sub(".ps", latex_file) - pdf_file = latex_file_re.sub(".pdf", latex_file) dvips_call = '%s -i -o "%s" "%s"' % (dvips, ps_file, dvi_file) dvips_failed = False dvips_status, dvips_stdout = run_command(dvips_call) - if dvips_status != None: + if dvips_status: warning('Failed: %s %s ... looking for PDF' \ % (os.path.basename(dvips), dvi_file)) dvips_failed = True + return legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics) + + +# Either latex and dvips have been run and we have a ps file, or +# pdflatex has been run and we have a pdf file. Proceed with gs. +def legacy_conversion_step3(latex_file, dpi, output_format, dvips_failed, skipMetrics = False): + # External programs used by the script. + gs = find_exe_or_terminate(["gswin32c", "gs"]) + pnmcrop = find_exe(["pnmcrop"]) + + # Files to process + pdf_file = latex_file_re.sub(".pdf", latex_file) + ps_file = latex_file_re.sub(".ps", latex_file) + # Extract resolution data for gs from the log file. log_file = latex_file_re.sub(".log", latex_file) resolution = extract_resolution(log_file, dpi) @@ -306,12 +395,13 @@ def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False) # Extract the metrics from the log file legacy_metrics = legacy_extract_metrics_info(log_file) - + # List of pages which failed to produce a correct output failed_pages = [] - + # Generate the bitmap images if dvips_failed: + # dvips failed, maybe there's a PDF, try to produce bitmaps gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \ '-sOutputFile="%s%%d.%s" ' \ '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \ @@ -320,64 +410,36 @@ def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False) gs_ext, alpha, alpha, resolution, pdf_file) gs_status, gs_stdout = run_command(gs_call) - if gs_status != None: + if gs_status: error("Failed: %s %s" % (os.path.basename(gs), ps_file)) else: + # Model for calling gs on each file gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \ '-sOutputFile="%s%%d.%s" ' \ '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \ '-r%f "%%s"' \ % (gs, gs_device, latex_file_re.sub("", latex_file), \ gs_ext, alpha, alpha, resolution) + i = 0 + # Collect all the PostScript files (like *.001, *.002, ...) ps_files = glob.glob("%s.[0-9][0-9][0-9]" % latex_file_re.sub("", latex_file)) ps_files.sort() - - # Call GhostScript for each page + + # Call GhostScript for each file for file in ps_files: i = i + 1 + progress("Processing page %s, file %s" % (i, file)) gs_status, gs_stdout = run_command(gs_call % (i, file)) - if gs_status != None: + if gs_status: # gs failed, keep track of this + warning("Ghostscript failed on page %s, file %s" % (i, file)) failed_pages.append(i) - - + # Pass failed pages to pdflatex if len(failed_pages) > 0: - pdflatex = find_exe(["pdflatex"], path) - if pdflatex != None: - # Create a new LaTeX file from the original but only with failed pages - pdf_latex_file = latex_file_re.sub("_pdflatex.tex", latex_file) - filter_pages(latex_file, pdf_latex_file, failed_pages) - - # pdflatex call - pdflatex_call = '%s "%s"' % (pdflatex, pdf_latex_file) - pdflatex_status, pdflatex_stdout = run_command(pdflatex_call) - - pdf_file = latex_file_re.sub(".pdf", pdf_latex_file) - - # GhostScript call to produce bitmaps - gs_call = '%s -dNOPAUSE -dBATCH -dSAFER -sDEVICE=%s ' \ - '-sOutputFile="%s%%d.%s" ' \ - '-dGraphicsAlphaBit=%d -dTextAlphaBits=%d ' \ - '-r%f "%s"' \ - % (gs, gs_device, latex_file_re.sub("", pdf_latex_file), \ - gs_ext, alpha, alpha, resolution, pdf_file) - - gs_status, gs_stdout = run_command(gs_call) - if gs_status != None: - # Give up! - warning("Some pages failed with all the possible routes") - else: - # We've done it! - pdf_log_file = latex_file_re.sub(".log", pdf_latex_file) - pdf_metrics = legacy_extract_metrics_info(pdf_log_file) - - original_bitmap = latex_file_re.sub("%d." + output_format, pdf_latex_file) - destination_bitmap = latex_file_re.sub("%d." + output_format, latex_file) - - # Join the metrics with the those from dvips and rename the bitmap images - join_metrics_and_rename(legacy_metrics, pdf_metrics, failed_pages, original_bitmap, destination_bitmap) + legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs, + gs_device, gs_ext, alpha, resolution, output_format) # Crop the images if pnmcrop != None: @@ -394,4 +456,4 @@ def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False) if __name__ == "__main__": - exit(legacy_conversion(sys.argv)[0]) + sys.exit(legacy_conversion(sys.argv)[0])