]> git.lyx.org Git - lyx.git/blobdiff - lib/lyx2lyx/lyx_2_1.py
More sensible longtable caption handling (needed for bug #7412)
[lyx.git] / lib / lyx2lyx / lyx_2_1.py
index db3dc0b04692263721e2ccfe7d95dff817fc1b5f..a708c2da1662301a507e61160cbca05cd058b2cd 100644 (file)
@@ -15,7 +15,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 """ Convert files to the file format generated by lyx 2.1"""
 
@@ -25,14 +25,15 @@ import sys, os
 
 # Uncomment only what you need to import, please.
 
-from parser_tools import find_token, find_end_of_inset
+from parser_tools import del_token, find_token, find_end_of, find_end_of_inset, \
+    get_option_value, get_value, get_quoted_value, set_option_value
 
 #from parser_tools import find_token, find_end_of, find_tokens, \
   #find_token_exact, find_end_of_inset, find_end_of_layout, \
   #find_token_backwards, is_in_inset, get_value, get_quoted_value, \
   #del_token, check_token, get_option_value
 
-from lyx2lyx_tools import put_cmd_in_ert
+from lyx2lyx_tools import add_to_preamble, put_cmd_in_ert
 
 #from lyx2lyx_tools import add_to_preamble, insert_to_preamble, \
 #  put_cmd_in_ert, lyx2latex, latex_length, revert_flex_inset, \
@@ -61,12 +62,274 @@ def revert_visible_space(document):
     "Revert InsetSpace visible into its ERT counterpart"
     i = 0
     while True:
-        i = find_token(document.body, "\\begin_inset space \\textvisiblespace{}", i)
-        if i == -1:
-            return
+      i = find_token(document.body, "\\begin_inset space \\textvisiblespace{}", i)
+      if i == -1:
+        return
+      end = find_end_of_inset(document.body, i)
+      subst = put_cmd_in_ert("\\textvisiblespace{}")
+      document.body[i:end + 1] = subst
+
+
+def convert_undertilde(document):
+    " Load undertilde automatically "
+    i = find_token(document.header, "\\use_mathdots" , 0)
+    if i != -1:
+      document.header.insert(i + 1, "\\use_undertilde 1")
+
+
+def revert_undertilde(document):
+    " Load undertilde if used in the document "
+    undertilde = find_token(document.header, "\\use_undertilde" , 0)
+    if undertilde == -1:
+      document.warning("No \\use_undertilde line. Assuming auto.")
+    else:
+      val = get_value(document.header, "\\use_undertilde", undertilde)
+      del document.header[undertilde]
+      try:
+        usetilde = int(val)
+      except:
+        document.warning("Invalid \\use_undertilde value: " + val + ". Assuming auto.")
+        # probably usedots has not been changed, but be safe.
+        usetilde = 1
+
+      if usetilde == 0:
+        # do not load case
+        return
+      if usetilde == 2:
+        # force load case
+        add_to_preamble(document, ["\\usepackage{undertilde}"])
+        return
+    
+    # so we are in the auto case. we want to load undertilde if \utilde is used.
+    i = 0
+    while True:
+      i = find_token(document.body, '\\begin_inset Formula', i)
+      if i == -1:
+        return
+      j = find_end_of_inset(document.body, i)
+      if j == -1:
+        document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
+        i += 1
+        continue
+      code = "\n".join(document.body[i:j])
+      if code.find("\\utilde") != -1:
+        add_to_preamble(document, ["\\@ifundefined{utilde}{\\usepackage{undertilde}}"])
+        return
+      i = j
+
+
+def revert_negative_space(document):
+    "Revert InsetSpace negmedspace and negthickspace into its TeX-code counterpart"
+    i = 0
+    j = 0
+    reverted = False
+    while True:
+      i = find_token(document.body, "\\begin_inset space \\negmedspace{}", i)
+      if i == -1:
+        j = find_token(document.body, "\\begin_inset space \\negthickspace{}", j)
+        if j == -1:
+          # load amsmath in the preamble if not already loaded if we are at the end of checking
+          if reverted == True:
+            i = find_token(document.header, "\\use_amsmath 2", 0)
+            if i == -1:
+              add_to_preamble(document, ["\\@ifundefined{negthickspace}{\\usepackage{amsmath}}"])
+          return
+      if i == -1:
+        return
+      end = find_end_of_inset(document.body, i)
+      subst = put_cmd_in_ert("\\negmedspace{}")
+      document.body[i:end + 1] = subst
+      j = find_token(document.body, "\\begin_inset space \\negthickspace{}", j)
+      if j == -1:
+        return
+      end = find_end_of_inset(document.body, j)
+      subst = put_cmd_in_ert("\\negthickspace{}")
+      document.body[j:end + 1] = subst
+      reverted = True
+
+
+def revert_math_spaces(document):
+    "Revert formulas with protected custom space and protected hfills to TeX-code"
+    i = 0
+    while True:
+      i = find_token(document.body, "\\begin_inset Formula", i)
+      if i == -1:
+        return
+      j = document.body[i].find("\\hspace*")
+      if j != -1:
         end = find_end_of_inset(document.body, i)
-        subst = put_cmd_in_ert("\\textvisiblespace{}")
+        subst = put_cmd_in_ert(document.body[i][21:])
         document.body[i:end + 1] = subst
+      i = i + 1
+
+
+def convert_japanese_encodings(document):
+    " Rename the japanese encodings to names understood by platex "
+    jap_enc_dict = {
+        "EUC-JP-pLaTeX": "euc",
+        "JIS-pLaTeX":    "jis",
+        "SJIS-pLaTeX":   "sjis"
+    }
+    i = find_token(document.header, "\\inputencoding" , 0)
+    if i == -1:
+        return
+    val = get_value(document.header, "\\inputencoding", i)
+    if val in jap_enc_dict.keys():
+        document.header[i] = "\\inputencoding %s" % jap_enc_dict[val]
+
+
+def revert_japanese_encodings(document):
+    " Revert the japanese encodings name changes "
+    jap_enc_dict = {
+        "euc":  "EUC-JP-pLaTeX",
+        "jis":  "JIS-pLaTeX",
+        "sjis": "SJIS-pLaTeX"
+    }
+    i = find_token(document.header, "\\inputencoding" , 0)
+    if i == -1:
+        return
+    val = get_value(document.header, "\\inputencoding", i)
+    if val in jap_enc_dict.keys():
+        document.header[i] = "\\inputencoding %s" % jap_enc_dict[val]
+
+
+def revert_justification(document):
+    " Revert the \\justification buffer param"
+    if not del_token(document.header, '\\justification', 0):
+        document.warning("Malformed LyX document: Missing \\justification.")
+
+
+def revert_australian(document):
+    "Set English language variants Australian and Newzealand to English" 
+
+    if document.language == "australian" or document.language == "newzealand": 
+        document.language = "english" 
+        i = find_token(document.header, "\\language", 0) 
+        if i != -1: 
+            document.header[i] = "\\language english" 
+
+    j = 0 
+    while True: 
+        j = find_token(document.body, "\\lang australian", j) 
+        if j == -1: 
+            j = find_token(document.body, "\\lang newzealand", 0)
+            if j == -1:
+                return
+            else:
+                document.body[j] = document.body[j].replace("\\lang newzealand", "\\lang english")
+        else:
+            document.body[j] = document.body[j].replace("\\lang australian", "\\lang english") 
+        j += 1
+
+
+def convert_biblio_style(document):
+    "Add a sensible default for \\biblio_style based on the citation engine."
+    i = find_token(document.header, "\\cite_engine", 0)
+    if i != -1:
+        engine = get_value(document.header, "\\cite_engine", i).split("_")[0]
+        style = {"basic": "plain", "natbib": "plainnat", "jurabib": "jurabib"}
+        document.header.insert(i + 1, "\\biblio_style " + style[engine])
+
+
+def revert_biblio_style(document):
+    "BibTeX insets with default option use the style defined by \\biblio_style."
+    i = find_token(document.header, "\\biblio_style" , 0)
+    if i == -1:
+        document.warning("No \\biblio_style line. Nothing to do.")
+        return
+
+    default_style = get_value(document.header, "\\biblio_style", i)
+    del document.header[i]
+
+    # We are looking for bibtex insets having the default option
+    i = 0
+    while True:
+        i = find_token(document.body, "\\begin_inset CommandInset bibtex", i)
+        if i == -1:
+            return
+        j = find_end_of_inset(document.body, i)
+        if j == -1:
+            document.warning("Malformed LyX document: Can't find end of bibtex inset at line " + str(i))
+            i += 1
+            return
+        k = find_token(document.body, "options", i, j)
+        if k != -1:
+            options = get_quoted_value(document.body, "options", k)
+            if "default" in options.split(","):
+                document.body[k] = 'options "%s"' \
+                    % options.replace("default", default_style)
+        i = j
+
+
+def handle_longtable_captions(document, forward):
+    begin_table = 0
+    while True:
+        begin_table = find_token(document.body, '<lyxtabular version=', begin_table)
+        if begin_table == -1:
+            break
+        end_table = find_end_of(document.body, begin_table, '<lyxtabular', '</lyxtabular>')
+        if end_table == -1:
+            document.warning("Malformed LyX document: Could not find end of table.")
+            begin_table += 1
+            continue
+        fline = find_token(document.body, "<features", begin_table, end_table)
+        if fline == -1:
+            document.warning("Can't find features for inset at line " + str(begin_table))
+            begin_table += 1
+            continue
+        p = document.body[fline].find("islongtable")
+        if p == -1:
+            # no longtable
+            begin_table += 1
+            continue
+        numrows = get_option_value(document.body[begin_table], "rows")
+        try:
+            numrows = int(numrows)
+        except:
+            document.warning(document.body[begin_table])
+            document.warning("Unable to determine rows!")
+            begin_table = end_table
+            continue
+        begin_row = begin_table
+        for row in range(numrows):
+            begin_row = find_token(document.body, '<row', begin_row, end_table)
+            if begin_row == -1:
+                document.warning("Can't find row " + str(row + 1))
+                break
+            end_row = find_end_of(document.body, begin_row, '<row', '</row>')
+            if end_row == -1:
+                document.warning("Can't find end of row " + str(row + 1))
+                break
+            if forward:
+                if (get_option_value(document.body[begin_row], 'caption') == 'true' and
+                    get_option_value(document.body[begin_row], 'endfirsthead') != 'true' and
+                    get_option_value(document.body[begin_row], 'endhead') != 'true' and
+                    get_option_value(document.body[begin_row], 'endfoot') != 'true' and
+                    get_option_value(document.body[begin_row], 'endlastfoot') != 'true'):
+                    document.body[begin_row] = set_option_value(document.body[begin_row], 'caption', 'true", endfirsthead="true')
+            elif get_option_value(document.body[begin_row], 'caption') == 'true':
+                if get_option_value(document.body[begin_row], 'endfirsthead') == 'true':
+                    document.body[begin_row] = set_option_value(document.body[begin_row], 'endfirsthead', 'false')
+                if get_option_value(document.body[begin_row], 'endhead') == 'true':
+                    document.body[begin_row] = set_option_value(document.body[begin_row], 'endhead', 'false')
+                if get_option_value(document.body[begin_row], 'endfoot') == 'true':
+                    document.body[begin_row] = set_option_value(document.body[begin_row], 'endfoot', 'false')
+                if get_option_value(document.body[begin_row], 'endlastfoot') == 'true':
+                    document.body[begin_row] = set_option_value(document.body[begin_row], 'endlastfoot', 'false')
+            begin_row = end_row
+        # since there could be a tabular inside this one, we 
+        # cannot jump to end.
+        begin_table += 1
+
+
+def convert_longtable_captions(document):
+    "Add a firsthead flag to caption rows"
+    handle_longtable_captions(document, True)
+
+
+def revert_longtable_captions(document):
+    "remove head/foot flag from caption rows"
+    handle_longtable_captions(document, False)
 
 
 ##
@@ -74,10 +337,26 @@ def revert_visible_space(document):
 #
 
 supported_versions = ["2.1.0","2.1"]
-convert = [[414, []]
+convert = [
+           [414, []],
+           [415, [convert_undertilde]],
+           [416, []],
+           [417, [convert_japanese_encodings]],
+           [418, []],
+           [419, []],
+           [420, [convert_biblio_style]],
+           [421, [convert_longtable_captions]],
           ]
 
-revert =  [[413, [revert_visible_space]]
+revert =  [
+           [420, [revert_longtable_captions]],
+           [419, [revert_biblio_style]],
+           [418, [revert_australian]],
+           [417, [revert_justification]],
+           [416, [revert_japanese_encodings]],
+           [415, [revert_negative_space,revert_math_spaces]],
+           [414, [revert_undertilde]],
+           [413, [revert_visible_space]]
           ]