]> git.lyx.org Git - lyx.git/blobdiff - lib/scripts/lyxpreview2bitmap.py
Split osf options to families
[lyx.git] / lib / scripts / lyxpreview2bitmap.py
index a7d76236fba969b982b648e2a3859bf81db0ead3..eee000deeae33840f085d6554a0a82305b811850 100755 (executable)
 # Moreover dvipng can't work with PDF files, so, if the CONVERTER
 # paramter is pdflatex we have to fallback to legacy route (step 2).
 
-import getopt, glob, os, re, shutil, string, sys
+from __future__ import print_function
 
-from legacy_lyxpreview2ppm import legacy_conversion_step1
+import getopt, glob, os, re, shutil, sys, tempfile
+
+import lyxpreview_tools
+
+from legacy_lyxpreview2ppm import extract_resolution, legacy_conversion_step1
 
 from lyxpreview_tools import bibtex_commands, check_latex_log, 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, run_tex, \
+     pdflatex_commands, progress, run_command, run_latex, run_tex, \
      warning, write_metrics_info
 
+PY2 = sys.version_info[0] == 2
 
 def usage(prog_name):
     msg = """
@@ -134,8 +139,8 @@ def extract_metrics_info(dvipng_stdout):
         success = 1
 
         # Calculate the 'ascent fraction'.
-        descent = string.atof(match.group(1))
-        ascent  = string.atof(match.group(2))
+        descent = float(match.group(1))
+        ascent  = float(match.group(2))
 
         frac = 0.5
         if ascent < 0:
@@ -159,60 +164,31 @@ def extract_metrics_info(dvipng_stdout):
 
 
 def fix_latex_file(latex_file, pdf_output):
-    documentclass_re = re.compile("(\\\\documentclass\[)(1[012]pt,?)(.+)")
-    def_re = re.compile(r"(\\newcommandx|\\global\\long\\def)(\\[a-zA-Z])(.+)")
-    usepackage_re = re.compile("\\\\usepackage")
-    userpreamble_re = re.compile("User specified LaTeX commands")
-    enduserpreamble_re = re.compile("\\\\makeatother")
+    # python 2 does not allow to declare a string as raw byte so we double
+    # the backslashes and remove the r preffix
+    def_re = re.compile(b"(\\\\newcommandx|\\\\global\\\\long\\\\def)"
+                        b"(\\\\[a-zA-Z]+)")
 
-    tmp = mkstemp()
+    tmp = tempfile.TemporaryFile()
 
-    in_user_preamble = 0
-    usepkg = 0
-    changed = 0
+    changed = False
     macros = []
-    for line in open(latex_file, 'r').readlines():
-        match = documentclass_re.match(line)
-        if match != None:
-            changed = 1
-            tmp.write("%s%s\n" % (match.group(1), match.group(3)))
-            continue
-
-        if not pdf_output and not usepkg:
-            if userpreamble_re.search(line) != None:
-                in_user_preamble = 1
-            elif enduserpreamble_re.search(line) != None:
-                in_user_preamble = 0
-            if usepackage_re.match(line) != None and in_user_preamble:
-                usepkg = 1
-                changed = 1
-                tmp.write("\\def\\t@a{microtype}\n")
-                tmp.write("\\let\\oldusepkg\\usepackage\n")
-                tmp.write("\\def\\usepackage{\\@ifnextchar[\\@usepkg{\\@usepkg[]}}\n")
-                tmp.write("\\def\\@usepkg[#1]#2{\\@ifnextchar[")
-                tmp.write("{\\@@usepkg[#1]{#2}}{\\@@usepkg[#1]{#2}[]}}\n")
-                tmp.write("\\def\@@usepkg[#1]#2[#3]{\\def\\t@b{#2}")
-                tmp.write("\\ifx\\t@a\\t@b\\else\\oldusepkg[#1]{#2}[#3]\\fi}\n")
-                tmp.write(line)
-                continue
-
-        match = def_re.match(line)
-        if match == None:
-            tmp.write(line)
-            continue
-
-        macroname = match.group(2)
-        if not macroname in macros:
-            macros.append(macroname)
-            tmp.write(line)
-            continue
-
-        definecmd = match.group(1)
-        if definecmd == "\\global\\long\\def":
-            tmp.write(line)
+    for line in open(latex_file, 'rb').readlines():
+        if not pdf_output and line.startswith(b"\\documentclass"):
+            changed = True
+            line += b"\\PassOptionsToPackage{draft}{microtype}\n"
         else:
-            changed = 1
-            tmp.write("\\renewcommandx%s%s\n" % (match.group(2), match.group(3)))
+            match = def_re.match(line)
+            if match != None:
+                macroname = match.group(2)
+                if macroname in macros:
+                    definecmd = match.group(1)
+                    if definecmd == b"\\newcommandx":
+                        changed = True
+                        line = line.replace(definecmd, b"\\renewcommandx")
+                else:
+                    macros.append(macroname)
+        tmp.write(line)
 
     if changed:
         copyfileobj(tmp, open(latex_file,"wb"), 1)
@@ -247,7 +223,7 @@ def find_ps_pages(dvi_file):
         error("No DVI output.")
 
     # Check for PostScript specials in the dvi, badly supported by dvipng,
-    # and inclusion of PDF/PNG/JPG files. 
+    # and inclusion of PDF/PNG/JPG files.
     # This is required for correct rendering of PSTricks and TikZ
     dv2dt = find_exe_or_terminate(["dv2dt"])
     dv2dt_call = '%s "%s"' % (dv2dt, dvi_file)
@@ -309,7 +285,7 @@ def find_ps_pages(dvi_file):
 
         # Use page ranges, as a list of pages could exceed command line
         # maximum length (especially under Win32)
-        for index in xrange(1, page_index + 1):
+        for index in range(1, page_index + 1):
             if (not index in ps_or_pdf_pages) and skip:
                 # We were skipping pages but current page shouldn't be skipped.
                 # Add this page to -pp, it could stay alone or become the
@@ -356,24 +332,23 @@ def main(argv):
         (opts, args) = getopt.gnu_getopt(argv[1:], "dhv", ["bibtex=", "bg=",
             "debug", "dpi=", "fg=", "help", "latex=", "lilypond",
             "lilypond-book=", "png", "ppm", "verbose"])
-    except getopt.GetoptError, err:
+    except getopt.GetoptError as err:
         error("%s\n%s" % (err, usage(script_name)))
 
     opts.reverse()
     for opt, val in opts:
         if opt in ("-h", "--help"):
-            print usage(script_name)
+            print(usage(script_name))
             sys.exit(0)
         elif opt == "--bibtex":
             bibtex = [val]
         elif opt == "--bg":
             bg_color = val
         elif opt in ("-d", "--debug"):
-            import lyxpreview_tools
             lyxpreview_tools.debug = True
         elif opt == "--dpi":
             try:
-                dpi = string.atoi(val)
+                dpi = int(val)
             except:
                 error("Cannot convert %s to an integer value" % val)
         elif opt == "--fg":
@@ -387,7 +362,6 @@ def main(argv):
         elif opt in ("--png", "--ppm"):
             output_format = opt[2:]
         elif opt in ("-v", "--verbose"):
-            import lyxpreview_tools
             lyxpreview_tools.verbose = True
 
     # Determine input file
@@ -398,23 +372,41 @@ def main(argv):
     input_path = args[0]
     dir, latex_file = os.path.split(input_path)
 
+    # Check for the input file
+    if not os.path.exists(input_path):
+        error('File "%s" not found.' % input_path)
+    if len(dir) != 0:
+        os.chdir(dir)
+
+    if lyxpreview_tools.verbose:
+        f_out = open('verbose.txt', 'a')
+        sys.stdout = f_out
+        sys.stderr = f_out
+
     # Echo the settings
+    progress("Running Python %s" % str(sys.version_info[:3]))
     progress("Starting %s..." % script_name)
+    if os.name == "nt":
+        progress("Use win32_modules: %d" % lyxpreview_tools.use_win32_modules)
     progress("Output format: %s" % output_format)
     progress("Foreground color: %s" % fg_color)
     progress("Background color: %s" % bg_color)
     progress("Resolution (dpi): %s" % dpi)
     progress("File to process: %s" % input_path)
 
-    # Check for the input file
-    if not os.path.exists(input_path):
-        error('File "%s" not found.' % input_path)
-    if len(dir) != 0:
-        os.chdir(dir)
+    # For python > 2 convert strings to bytes
+    if not PY2:
+        fg_color = bytes(fg_color, 'ascii')
+        bg_color = bytes(bg_color, 'ascii')
 
     fg_color_dvipng = make_texcolor(fg_color, False)
     bg_color_dvipng = make_texcolor(bg_color, False)
 
+    # For python > 2 convert bytes to string
+    if not PY2:
+        fg_color_dvipng = fg_color_dvipng.decode('ascii')
+        bg_color_dvipng = bg_color_dvipng.decode('ascii')
+
     # External programs used by the script.
     latex = find_exe_or_terminate(latex or latex_commands)
     bibtex = find_exe(bibtex or bibtex_commands)
@@ -432,8 +424,8 @@ def main(argv):
     progress("Preprocess through lilypond-book: %s" % lilypond)
     progress("Altering the latex file for font size and colors")
 
-    # Omit font size specification in latex file and make sure that multiple
-    # defined macros and the microtype package don't cause issues.
+    # Make sure that multiple defined macros and the microtype package
+    # don't cause issues in the latex file.
     fix_latex_file(latex_file, pdf_output)
 
     if lilypond:
@@ -478,9 +470,10 @@ def main(argv):
     # Compile the latex file.
     error_pages = []
     latex_status, latex_stdout = run_latex(latex, latex_file, bibtex)
+    latex_log = latex_file_re.sub(".log", latex_file)
     if latex_status:
         progress("Will try to recover from %s failure" % latex)
-        error_pages = check_latex_log(latex_file_re.sub(".log", latex_file))
+        error_pages = check_latex_log(latex_log)
 
     # The dvi output file name
     dvi_file = latex_file_re.sub(".dvi", latex_file)
@@ -516,9 +509,12 @@ def main(argv):
         return legacy_conversion_step1(latex_file, dpi, output_format, fg_color,
             bg_color, "pdflatex", True)
 
+    # Retrieve resolution
+    resolution = extract_resolution(latex_log, dpi)
+
     # Run the dvi file through dvipng.
     dvipng_call = '%s -Ttight -depth -height -D %d -fg "%s" -bg "%s" %s "%s"' \
-        % (dvipng, dpi, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
+        % (dvipng, resolution, fg_color_dvipng, bg_color_dvipng, pages_parameter, dvi_file)
     dvipng_status, dvipng_stdout = run_command(dvipng_call)
 
     if dvipng_status: