]> git.lyx.org Git - lyx.git/blobdiff - lib/scripts/legacy_lyxpreview2ppm.py
#7894 explain the status column of mac bindings
[lyx.git] / lib / scripts / legacy_lyxpreview2ppm.py
index 6f07d38850a3bf4afd8156cba42f72e51129e08b..7c6e1e6274dc562e675a5fce85aa64fbd5d64e15 100644 (file)
 
 # 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]
@@ -77,8 +80,8 @@ import glob, os, pipes, re, string, sys
 
 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, progress, run_command, warning, \
-     write_metrics_info
+     latex_file_re, make_texcolor, mkstemp, pdflatex_commands, progress, \
+     run_command, run_latex, warning, write_metrics_info
 
 
 def usage(prog_name):
@@ -191,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)
 
@@ -265,24 +271,34 @@ 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.
     latex = find_exe_or_terminate(latex or latex_commands)
 
-    # 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")
+    pdf_output = latex in pdflatex_commands
 
-    # Compile the latex file.
-    latex_call = '%s "%s"' % (latex, latex_file)
+    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):
 
-    latex_status, latex_stdout = run_command(latex_call)
-    if latex_status:
-        warning("%s had problems compiling %s" \
-              % (os.path.basename(latex), 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""")
 
-    return legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics)
+    # Compile the latex file.
+    latex_status, latex_stdout = run_latex(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
@@ -300,11 +316,7 @@ def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs,
         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)
-        if pdflatex_status:
-            warning("%s had problems compiling %s" \
-                % (os.path.basename(pdflatex), pdf_latex_file))
+        pdflatex_status, pdflatex_stdout = run_latex(pdflatex, pdf_latex_file)
 
         pdf_file = latex_file_re.sub(".pdf", pdf_latex_file)
 
@@ -332,16 +344,15 @@ def legacy_conversion_pdflatex(latex_file, failed_pages, legacy_metrics, gs,
                 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.
     dvips   = find_exe_or_terminate(["dvips"])
-    gs      = find_exe_or_terminate(["gswin32c", "gs"])
-    pnmcrop = find_exe(["pnmcrop"])
 
     # 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
@@ -352,6 +363,20 @@ def legacy_conversion_step2(latex_file, dpi, output_format, skipMetrics = False)
             % (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)
@@ -431,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])