]> git.lyx.org Git - lyx.git/blobdiff - lib/scripts/lyxpreview_tools.py
whitespace.
[lyx.git] / lib / scripts / lyxpreview_tools.py
index 767689f98ccaf800c946a5dedd31b7a2c47edc1c..2012927c05003e662621a29ecf2bd75cb33a01d3 100644 (file)
@@ -1,4 +1,3 @@
-#! /usr/bin/env python
 
 # file lyxpreview_tools.py
 # This file is part of LyX, the document processor.
@@ -12,7 +11,7 @@
 
 # A repository of the following functions, used by the lyxpreview2xyz scripts.
 # copyfileobj, error, find_exe, find_exe_or_terminate, make_texcolor, mkstemp,
-# progress, run_command, warning
+# progress, run_command, run_latex, warning
 
 # Requires python 2.4 or later (subprocess module).
 
@@ -23,7 +22,8 @@ import os, re, string, subprocess, sys, tempfile
 debug = False
 verbose = False
 
-# Known flavors of latex
+# Known flavors of latex and bibtex
+bibtex_commands = ("bibtex", "bibtex8", "biber")
 latex_commands = ("latex", "pplatex", "platex", "latex2e")
 pdflatex_commands = ("pdflatex", "xelatex", "lualatex")
 
@@ -35,6 +35,7 @@ path = os.environ["PATH"].split(os.pathsep)
 extlist = ['']
 if "PATHEXT" in os.environ:
     extlist += os.environ["PATHEXT"].split(os.pathsep)
+extlist.append('.py')
 
 use_win32_modules = 0
 if os.name == "nt":
@@ -98,6 +99,9 @@ def find_exe(candidates):
                     # have found it). Return just the basename to avoid
                     # problems when the path to the executable contains
                     # spaces.
+                    if full_path.lower().endswith('.py'):
+                        return command.replace(prog, '"%s" "%s"'
+                            % (sys.executable, full_path))
                     return command
 
     return None
@@ -111,14 +115,21 @@ def find_exe_or_terminate(candidates):
     return exe
 
 
-def run_command_popen(cmd):
+def run_command_popen(cmd, stderr2stdout):
     if os.name == 'nt':
         unix = False
     else:
         unix = True
-    pipe = subprocess.Popen(cmd, shell=unix, close_fds=unix, stdin=subprocess.PIPE, \
-        stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
-    cmd_stdout = pipe.communicate()[0]
+    if stderr2stdout:
+        pipe = subprocess.Popen(cmd, shell=unix, close_fds=unix, stdin=subprocess.PIPE, \
+            stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
+        cmd_stdout = pipe.communicate()[0]
+    else:
+        pipe = subprocess.Popen(cmd, shell=unix, close_fds=unix, stdin=subprocess.PIPE, \
+            stdout=subprocess.PIPE, universal_newlines=True)
+        (cmd_stdout, cmd_stderr) = pipe.communicate()
+        if cmd_stderr:
+            sys.stderr.write(cmd_stderr)
     cmd_status = pipe.returncode
 
     global debug
@@ -157,7 +168,7 @@ def run_command_win32(cmd):
             if hr != winerror.ERROR_IO_PENDING:
                 data = data + buffer
 
-        except pywintypes.error, e:
+        except pywintypes.error as e:
             if e.args[0] != winerror.ERROR_BROKEN_PIPE:
                 error = 1
             break
@@ -177,12 +188,12 @@ def run_command_win32(cmd):
     return 0, data
 
 
-def run_command(cmd):
+def run_command(cmd, stderr2stdout = True):
     progress("Running %s" % cmd)
     if use_win32_modules:
         return run_command_win32(cmd)
     else:
-        return run_command_popen(cmd)
+        return run_command_popen(cmd, stderr2stdout)
 
 
 def get_version_info():
@@ -261,11 +272,13 @@ def write_metrics_info(metrics_info, metrics_file):
 # Reads a .tex files and create an identical file but only with
 # pages whose index is in pages_to_keep
 def filter_pages(source_path, destination_path, pages_to_keep):
+    def_re = re.compile(r"(\\newcommandx|\\renewcommandx|\\global\\long\\def)(\\[a-zA-Z]+)(.+)")
     source_file = open(source_path, "r")
     destination_file = open(destination_path, "w")
 
     page_index = 0
     skip_page = False
+    macros = []
     for line in source_file:
         # We found a new page
         if line.startswith("\\begin{preview}"):
@@ -274,6 +287,14 @@ def filter_pages(source_path, destination_path, pages_to_keep):
             skip_page = page_index not in pages_to_keep
 
         if not skip_page:
+            match = def_re.match(line)
+            if match != None:
+                definecmd = match.group(1)
+                macroname = match.group(2)
+                if not macroname in macros:
+                    macros.append(macroname)
+                    if definecmd == "\\renewcommandx":
+                        line = line.replace(definecmd, "\\newcommandx")
             destination_file.write(line)
 
         # End of a page, we reset the skip_page bool
@@ -306,3 +327,85 @@ def join_metrics_and_rename(original_metrics, new_metrics, new_page_indexes, ori
             original_metrics[legacy_index] = (index, metric)
         else:
             original_metrics.insert(legacy_index, (index, metric))
+
+
+def run_latex(latex, latex_file, bibtex = None):
+    # Run latex
+    latex_status, latex_stdout = run_tex(latex, latex_file)
+
+    if bibtex is None:
+        return latex_status, latex_stdout
+
+    # The aux and log output file names
+    aux_file = latex_file_re.sub(".aux", latex_file)
+    log_file = latex_file_re.sub(".log", latex_file)
+
+    # Run bibtex/latex if necessary
+    progress("Checking if a bibtex run is necessary")
+    if string_in_file(r"\bibdata", aux_file):
+        bibtex_status, bibtex_stdout = run_tex(bibtex, aux_file)
+        latex_status, latex_stdout = run_tex(latex, latex_file)
+    # Rerun latex if necessary
+    progress("Checking if a latex rerun is necessary")
+    if string_in_file("Warning: Citation", log_file):
+        latex_status, latex_stdout = run_tex(latex, latex_file)
+
+    return latex_status, latex_stdout
+
+
+def run_tex(tex, tex_file):
+    tex_call = '%s "%s"' % (tex, tex_file)
+
+    tex_status, tex_stdout = run_command(tex_call)
+    if tex_status:
+        progress("Warning: %s had problems compiling %s" \
+            % (os.path.basename(tex), tex_file))
+    return tex_status, tex_stdout
+
+
+def string_in_file(string, infile):
+    if not os.path.isfile(infile):
+        return False
+    f = open(infile, 'r')
+    for line in f.readlines():
+        if string in line:
+            f.close()
+            return True
+    f.close()
+    return False
+
+
+# Returns a list of indexes of pages giving errors extracted from the latex log
+def check_latex_log(log_file):
+
+    error_re = re.compile("^! ")
+    snippet_re = re.compile("^Preview: Snippet ")
+    data_re = re.compile("([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)")
+
+    found_error = False
+    error_pages = []
+
+    try:
+        for line in open(log_file, 'r').readlines():
+            if not found_error:
+                match = error_re.match(line)
+                if match != None:
+                    found_error = True
+                continue
+            else:
+                match = snippet_re.match(line)
+                if match == None:
+                    continue
+
+                found_error = False
+                match = data_re.search(line)
+                if match == None:
+                    error("Unexpected data in %s\n%s" % (log_file, line))
+
+                error_pages.append(int(match.group(1)))
+
+    except:
+        warning('check_latex_log: Unable to open "%s"' % log_file)
+        warning(repr(sys.exc_info()[0]) + ',' + repr(sys.exc_info()[1]))
+
+    return error_pages