lib/lyx2lyx/lyx_2_2.py

   1 # -*- coding: utf-8 -*-
   2 # This file is part of lyx2lyx
   3 # -*- coding: utf-8 -*-
   4 # Copyright (C) 2015 The LyX team
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License
   8 # as published by the Free Software Foundation; either version 2
   9 # of the License, or (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 """ Convert files to the file format generated by lyx 2.2"""
  21
  22 import re, string
  23 import unicodedata
  24 import sys, os
  25
  26 # Uncomment only what you need to import, please.
  27
  28 #from parser_tools import find_token, find_end_of, find_tokens, \
  29 #  find_token_exact, find_end_of_inset, find_end_of_layout, \
  30 #  find_token_backwards, is_in_inset, get_value, get_quoted_value, \
  31 #  del_token, check_token, get_option_value
  32
  33 from lyx2lyx_tools import add_to_preamble, put_cmd_in_ert, lyx2latex, \
  34   length_in_bp#, \
  35 #  insert_to_preamble, latex_length, revert_flex_inset, \
  36 #  revert_font_attrs, hex2ratio, str2bool
  37
  38 from parser_tools import find_token, find_token_backwards, find_re, \
  39      find_end_of_inset, find_end_of_layout, find_nonempty_line, \
  40      get_containing_layout, get_value, check_token
  41
  42 ####################################################################
  43 # Private helper functions
  44
  45 def revert_Argument_to_TeX_brace(document, line, endline, n, nmax, environment, opt, nolastopt):
  46     '''
  47     Reverts an InsetArgument to TeX-code
  48     usage:
  49     revert_Argument_to_TeX_brace(document, LineOfBegin, LineOfEnd, StartArgument, EndArgument, isEnvironment, isOpt, notLastOpt)
  50     LineOfBegin is the line  of the \begin_layout or \begin_inset statement
  51     LineOfEnd is the line  of the \end_layout or \end_inset statement, if "0" is given, the end of the file is used instead
  52     StartArgument is the number of the first argument that needs to be converted
  53     EndArgument is the number of the last argument that needs to be converted or the last defined one
  54     isEnvironment must be true, if the layout is for a LaTeX environment
  55     isOpt must be true, if the argument is an optional one
  56     notLastOpt must be true if the argument is mandatory and followed by optional ones
  57     '''
  58     lineArg = 0
  59     wasOpt = False
  60     while lineArg != -1 and n < nmax + 1:
  61       lineArg = find_token(document.body, "\\begin_inset Argument " + str(n), line)
  62       if lineArg > endline and endline != 0:
  63         return wasOpt
  64       if lineArg != -1:
  65         beginPlain = find_token(document.body, "\\begin_layout Plain Layout", lineArg)
  66         # we have to assure that no other inset is in the Argument
  67         beginInset = find_token(document.body, "\\begin_inset", beginPlain)
  68         endInset = find_token(document.body, "\\end_inset", beginPlain)
  69         k = beginPlain + 1
  70         l = k
  71         while beginInset < endInset and beginInset != -1:
  72           beginInset = find_token(document.body, "\\begin_inset", k)
  73           endInset = find_token(document.body, "\\end_inset", l)
  74           k = beginInset + 1
  75           l = endInset + 1
  76         if environment == False:
  77           if opt == False:
  78             if nolastopt == False:
  79               document.body[endInset - 2 : endInset + 1] = put_cmd_in_ert("}{")
  80             else:
  81               document.body[endInset - 2 : endInset + 1] = put_cmd_in_ert("}")
  82             del(document.body[lineArg : beginPlain + 1])
  83             wasOpt = False
  84           else:
  85             document.body[endInset - 2 : endInset + 1] = put_cmd_in_ert("]")
  86             document.body[lineArg : beginPlain + 1] = put_cmd_in_ert("[")
  87             wasOpt = True
  88         else:
  89           if opt == False:
  90             document.body[endInset - 2 : endInset + 1] = put_cmd_in_ert("}")
  91             document.body[lineArg : beginPlain + 1] = put_cmd_in_ert("{")
  92             wasOpt = False
  93           else:
  94             document.body[endInset - 2 : endInset + 1] = put_cmd_in_ert("]")
  95             document.body[lineArg : beginPlain + 1] = put_cmd_in_ert("[")
  96             wasOpt = True
  97         n += 1
  98     return wasOpt
  99
 100
 101 ###############################################################################
 102 ###
 103 ### Conversion and reversion routines
 104 ###
 105 ###############################################################################
 106
 107 def convert_separator(document):
 108     """
 109     Convert layout separators to separator insets and add (LaTeX) paragraph
 110     breaks in order to mimic previous LaTeX export.
 111     """
 112
 113     parins = ["\\begin_inset Separator parbreak", "\\end_inset", ""]
 114     parlay = ["\\begin_layout Standard", "\\begin_inset Separator parbreak",
 115               "\\end_inset", "", "\\end_layout", ""]
 116     sty_dict = {
 117         "family" : "default",
 118         "series" : "default",
 119         "shape"  : "default",
 120         "size"   : "default",
 121         "bar"    : "default",
 122         "color"  : "inherit"
 123         }
 124
 125     i = 0
 126     while 1:
 127         i = find_token(document.body, "\\begin_deeper", i)
 128         if i == -1:
 129             break
 130
 131         j = find_token_backwards(document.body, "\\end_layout", i-1)
 132         if j != -1:
 133             # reset any text style before inserting the inset
 134             lay = get_containing_layout(document.body, j-1)
 135             if lay != False:
 136                 content = "\n".join(document.body[lay[1]:lay[2]])
 137                 for val in list(sty_dict.keys()):
 138                     if content.find("\\%s" % val) != -1:
 139                         document.body[j:j] = ["\\%s %s" % (val, sty_dict[val])]
 140                         i = i + 1
 141                         j = j + 1
 142             document.body[j:j] = parins
 143             i = i + len(parins) + 1
 144         else:
 145             i = i + 1
 146
 147     i = 0
 148     while 1:
 149         i = find_token(document.body, "\\align", i)
 150         if i == -1:
 151             break
 152
 153         lay = get_containing_layout(document.body, i)
 154         if lay != False and lay[0] == "Plain Layout":
 155             i = i + 1
 156             continue
 157
 158         j = find_token_backwards(document.body, "\\end_layout", i-1)
 159         if j != -1:
 160             lay = get_containing_layout(document.body, j-1)
 161             if lay != False and lay[0] == "Standard" \
 162                and find_token(document.body, "\\align", lay[1], lay[2]) == -1 \
 163                and find_token(document.body, "\\begin_inset VSpace", lay[1], lay[2]) == -1:
 164                 # reset any text style before inserting the inset
 165                 content = "\n".join(document.body[lay[1]:lay[2]])
 166                 for val in list(sty_dict.keys()):
 167                     if content.find("\\%s" % val) != -1:
 168                         document.body[j:j] = ["\\%s %s" % (val, sty_dict[val])]
 169                         i = i + 1
 170                         j = j + 1
 171                 document.body[j:j] = parins
 172                 i = i + len(parins) + 1
 173             else:
 174                 i = i + 1
 175         else:
 176             i = i + 1
 177
 178     regexp = re.compile(r'^\\begin_layout (?:(-*)|(\s*))(Separator|EndOfSlide)(?:(-*)|(\s*))$', re.IGNORECASE)
 179
 180     i = 0
 181     while 1:
 182         i = find_re(document.body, regexp, i)
 183         if i == -1:
 184             return
 185
 186         j = find_end_of_layout(document.body, i)
 187         if j == -1:
 188             document.warning("Malformed LyX document: Missing `\\end_layout'.")
 189             return
 190
 191         lay = get_containing_layout(document.body, j-1)
 192         if lay != False:
 193             lines = document.body[lay[3]:lay[2]]
 194         else:
 195             lines = []
 196
 197         document.body[i:j+1] = parlay
 198         if len(lines) > 0:
 199             document.body[i+1:i+1] = lines
 200
 201         i = i + len(parlay) + len(lines) + 1
 202
 203
 204 def revert_separator(document):
 205     " Revert separator insets to layout separators "
 206
 207     beamer_classes = ["beamer", "article-beamer", "scrarticle-beamer"]
 208     if document.textclass in beamer_classes:
 209         beglaysep = "\\begin_layout Separator"
 210     else:
 211         beglaysep = "\\begin_layout --Separator--"
 212
 213     parsep = [beglaysep, "", "\\end_layout", ""]
 214     comert = ["\\begin_inset ERT", "status collapsed", "",
 215               "\\begin_layout Plain Layout", "%", "\\end_layout",
 216               "", "\\end_inset", ""]
 217     empert = ["\\begin_inset ERT", "status collapsed", "",
 218               "\\begin_layout Plain Layout", " ", "\\end_layout",
 219               "", "\\end_inset", ""]
 220
 221     i = 0
 222     while 1:
 223         i = find_token(document.body, "\\begin_inset Separator", i)
 224         if i == -1:
 225             return
 226
 227         lay = get_containing_layout(document.body, i)
 228         if lay == False:
 229             document.warning("Malformed LyX document: Can't convert separator inset at line " + str(i))
 230             i = i + 1
 231             continue
 232
 233         layoutname = lay[0]
 234         beg = lay[1]
 235         end = lay[2]
 236         kind = get_value(document.body, "\\begin_inset Separator", i, i+1, "plain").split()[1]
 237         before = document.body[beg+1:i]
 238         something_before = len(before) > 0 and len("".join(before)) > 0
 239         j = find_end_of_inset(document.body, i)
 240         after = document.body[j+1:end]
 241         something_after = len(after) > 0 and len("".join(after)) > 0
 242         if kind == "plain":
 243             beg = beg + len(before) + 1
 244         elif something_before:
 245             document.body[i:i] = ["\\end_layout", ""]
 246             i = i + 2
 247             j = j + 2
 248             beg = i
 249             end = end + 2
 250
 251         if kind == "plain":
 252             if something_after:
 253                 document.body[beg:j+1] = empert
 254                 i = i + len(empert)
 255             else:
 256                 document.body[beg:j+1] = comert
 257                 i = i + len(comert)
 258         else:
 259             if something_after:
 260                 if layoutname == "Standard":
 261                     if not something_before:
 262                         document.body[beg:j+1] = parsep
 263                         i = i + len(parsep)
 264                         document.body[i:i] = ["", "\\begin_layout Standard"]
 265                         i = i + 2
 266                     else:
 267                         document.body[beg:j+1] = ["\\begin_layout Standard"]
 268                         i = i + 1
 269                 else:
 270                     document.body[beg:j+1] = ["\\begin_deeper"]
 271                     i = i + 1
 272                     end = end + 1 - (j + 1 - beg)
 273                     if not something_before:
 274                         document.body[i:i] = parsep
 275                         i = i + len(parsep)
 276                         end = end + len(parsep)
 277                     document.body[i:i] = ["\\begin_layout Standard"]
 278                     document.body[end+2:end+2] = ["", "\\end_deeper", ""]
 279                     i = i + 4
 280             else:
 281                 next_par_is_aligned = False
 282                 k = find_nonempty_line(document.body, end+1)
 283                 if k != -1 and check_token(document.body[k], "\\begin_layout"):
 284                     lay = get_containing_layout(document.body, k)
 285                     next_par_is_aligned = lay != False and \
 286                             find_token(document.body, "\\align", lay[1], lay[2]) != -1
 287                 if k != -1 and not next_par_is_aligned \
 288                         and not check_token(document.body[k], "\\end_deeper") \
 289                         and not check_token(document.body[k], "\\begin_deeper"):
 290                     if layoutname == "Standard":
 291                         document.body[beg:j+1] = [beglaysep]
 292                         i = i + 1
 293                     else:
 294                         document.body[beg:j+1] = ["\\begin_deeper", beglaysep]
 295                         end = end + 2 - (j + 1 - beg)
 296                         document.body[end+1:end+1] = ["", "\\end_deeper", ""]
 297                         i = i + 3
 298                 else:
 299                     if something_before:
 300                         del document.body[i:end+1]
 301                     else:
 302                         del document.body[i:end-1]
 303
 304         i = i + 1
 305
 306
 307 def revert_smash(document):
 308     " Set amsmath to on if smash commands are used "
 309
 310     commands = ["smash[t]", "smash[b]", "notag"]
 311     i = find_token(document.header, "\\use_package amsmath", 0)
 312     if i == -1:
 313         document.warning("Malformed LyX document: Can't find \\use_package amsmath.")
 314         return;
 315     value = get_value(document.header, "\\use_package amsmath", i).split()[1]
 316     if value != "1":
 317         # nothing to do if package is not auto but on or off
 318         return;
 319     j = 0
 320     while True:
 321         j = find_token(document.body, '\\begin_inset Formula', j)
 322         if j == -1:
 323             return
 324         k = find_end_of_inset(document.body, j)
 325         if k == -1:
 326             document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(j))
 327             j += 1
 328             continue
 329         code = "\n".join(document.body[j:k])
 330         for c in commands:
 331             if code.find("\\%s" % c) != -1:
 332                 # set amsmath to on, since it is loaded by the newer format
 333                 document.header[i] = "\\use_package amsmath 2"
 334                 return
 335         j = k
 336
 337
 338 def revert_swissgerman(document):
 339     " Set language german-ch-old to german "
 340     i = 0
 341     if document.language == "german-ch-old":
 342         document.language = "german"
 343         i = find_token(document.header, "\\language", 0)
 344         if i != -1:
 345             document.header[i] = "\\language german"
 346     j = 0
 347     while True:
 348         j = find_token(document.body, "\\lang german-ch-old", j)
 349         if j == -1:
 350             return
 351         document.body[j] = document.body[j].replace("\\lang german-ch-old", "\\lang german")
 352         j = j + 1
 353
 354
 355 def revert_use_package(document, pkg, commands, oldauto, supported):
 356     # oldauto defines how the version we are reverting to behaves:
 357     # if it is true, the old version uses the package automatically.
 358     # if it is false, the old version never uses the package.
 359     # If "supported" is true, the target version also supports this
 360     # package natively.
 361     regexp = re.compile(r'(\\use_package\s+%s)' % pkg)
 362     p = find_re(document.header, regexp, 0)
 363     value = "1" # default is auto
 364     if p != -1:
 365         value = get_value(document.header, "\\use_package" , p).split()[1]
 366         if not supported:
 367             del document.header[p]
 368     if value == "2" and not supported: # on
 369         add_to_preamble(document, ["\\usepackage{" + pkg + "}"])
 370     elif value == "1" and not oldauto: # auto
 371         i = 0
 372         while True:
 373             i = find_token(document.body, '\\begin_inset Formula', i)
 374             if i == -1:
 375                 return
 376             j = find_end_of_inset(document.body, i)
 377             if j == -1:
 378                 document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
 379                 i += 1
 380                 continue
 381             code = "\n".join(document.body[i:j])
 382             for c in commands:
 383                 if code.find("\\%s" % c) != -1:
 384                     if supported:
 385                         document.header[p] = "\\use_package " + pkg + " 2"
 386                     else:
 387                         add_to_preamble(document, ["\\usepackage{" + pkg + "}"])
 388                     return
 389             i = j
 390
 391
 392 mathtools_commands = ["xhookrightarrow", "xhookleftarrow", "xRightarrow", \
 393                 "xrightharpoondown", "xrightharpoonup", "xrightleftharpoons", \
 394                 "xLeftarrow", "xleftharpoondown", "xleftharpoonup", \
 395                 "xleftrightarrow", "xLeftrightarrow", "xleftrightharpoons", \
 396                 "xmapsto"]
 397
 398 def revert_xarrow(document):
 399     "remove use_package mathtools"
 400     revert_use_package(document, "mathtools", mathtools_commands, False, True)
 401
 402
 403 def revert_beamer_lemma(document):
 404     " Reverts beamer lemma layout to ERT "
 405
 406     beamer_classes = ["beamer", "article-beamer", "scrarticle-beamer"]
 407     if document.textclass not in beamer_classes:
 408         return
 409
 410     consecutive = False
 411     i = 0
 412     while True:
 413         i = find_token(document.body, "\\begin_layout Lemma", i)
 414         if i == -1:
 415             return
 416         j = find_end_of_layout(document.body, i)
 417         if j == -1:
 418             document.warning("Malformed LyX document: Can't find end of Lemma layout")
 419             i += 1
 420             continue
 421         arg1 = find_token(document.body, "\\begin_inset Argument 1", i, j)
 422         endarg1 = find_end_of_inset(document.body, arg1)
 423         arg2 = find_token(document.body, "\\begin_inset Argument 2", i, j)
 424         endarg2 = find_end_of_inset(document.body, arg2)
 425         subst1 = []
 426         subst2 = []
 427         if arg1 != -1:
 428             beginPlain1 = find_token(document.body, "\\begin_layout Plain Layout", arg1, endarg1)
 429             if beginPlain1 == -1:
 430                 document.warning("Malformed LyX document: Can't find arg1 plain Layout")
 431                 i += 1
 432                 continue
 433             endPlain1 = find_end_of_inset(document.body, beginPlain1)
 434             content1 = document.body[beginPlain1 + 1 : endPlain1 - 2]
 435             subst1 = put_cmd_in_ert("<") + content1 + put_cmd_in_ert(">")
 436         if arg2 != -1:
 437             beginPlain2 = find_token(document.body, "\\begin_layout Plain Layout", arg2, endarg2)
 438             if beginPlain2 == -1:
 439                 document.warning("Malformed LyX document: Can't find arg2 plain Layout")
 440                 i += 1
 441                 continue
 442             endPlain2 = find_end_of_inset(document.body, beginPlain2)
 443             content2 = document.body[beginPlain2 + 1 : endPlain2 - 2]
 444             subst2 = put_cmd_in_ert("[") + content2 + put_cmd_in_ert("]")
 445
 446         # remove Arg insets
 447         if arg1 < arg2:
 448             del document.body[arg2 : endarg2 + 1]
 449             if arg1 != -1:
 450                 del document.body[arg1 : endarg1 + 1]
 451         if arg2 < arg1:
 452             del document.body[arg1 : endarg1 + 1]
 453             if arg2 != -1:
 454                 del document.body[arg2 : endarg2 + 1]
 455
 456         # index of end layout has probably changed
 457         j = find_end_of_layout(document.body, i)
 458         if j == -1:
 459             document.warning("Malformed LyX document: Can't find end of Lemma layout")
 460             i += 1
 461             continue
 462
 463         begcmd = []
 464
 465         # if this is not a consecutive env, add start command
 466         if not consecutive:
 467             begcmd = put_cmd_in_ert("\\begin{lemma}")
 468
 469         # has this a consecutive lemma?
 470         consecutive = document.body[j + 2] == "\\begin_layout Lemma"
 471
 472         # if this is not followed by a consecutive env, add end command
 473         if not consecutive:
 474             document.body[j : j + 1] = put_cmd_in_ert("\\end{lemma}") + ["\\end_layout"]
 475
 476         document.body[i : i + 1] = ["\\begin_layout Standard", ""] + begcmd + subst1 + subst2
 477
 478         i = j
 479
 480
 481
 482 def revert_question_env(document):
 483     """
 484     Reverts question and question* environments of
 485     theorems-ams-extended-bytype module to ERT
 486     """
 487
 488     # Do we use theorems-ams-extended-bytype module?
 489     have_mod = False
 490     mods = document.get_module_list()
 491     for mod in mods:
 492         if mod == "theorems-ams-extended-bytype":
 493             have_mod = True
 494             continue
 495
 496     if not have_mod:
 497         return
 498
 499     consecutive = False
 500     i = 0
 501     while True:
 502         i = find_token(document.body, "\\begin_layout Question", i)
 503         if i == -1:
 504             return
 505
 506         starred = document.body[i] == "\\begin_layout Question*"
 507
 508         j = find_end_of_layout(document.body, i)
 509         if j == -1:
 510             document.warning("Malformed LyX document: Can't find end of Question layout")
 511             i += 1
 512             continue
 513
 514         # if this is not a consecutive env, add start command
 515         begcmd = []
 516         if not consecutive:
 517             if starred:
 518                 begcmd = put_cmd_in_ert("\\begin{question*}")
 519             else:
 520                 begcmd = put_cmd_in_ert("\\begin{question}")
 521
 522         # has this a consecutive theorem of same type?
 523         consecutive = False
 524         if starred:
 525             consecutive = document.body[j + 2] == "\\begin_layout Question*"
 526         else:
 527             consecutive = document.body[j + 2] == "\\begin_layout Question"
 528
 529         # if this is not followed by a consecutive env, add end command
 530         if not consecutive:
 531             if starred:
 532                 document.body[j : j + 1] = put_cmd_in_ert("\\end{question*}") + ["\\end_layout"]
 533             else:
 534                 document.body[j : j + 1] = put_cmd_in_ert("\\end{question}") + ["\\end_layout"]
 535
 536         document.body[i : i + 1] = ["\\begin_layout Standard", ""] + begcmd
 537
 538         add_to_preamble(document, "\\providecommand{\questionname}{Question}")
 539
 540         if starred:
 541             add_to_preamble(document, "\\theoremstyle{plain}\n" \
 542                                       "\\newtheorem*{question*}{\\protect\\questionname}")
 543         else:
 544             add_to_preamble(document, "\\theoremstyle{plain}\n" \
 545                                       "\\newtheorem{question}{\\protect\\questionname}")
 546
 547         i = j
 548
 549
 550 def convert_dashes(document):
 551     "convert -- and --- to \\twohyphens and \\threehyphens"
 552
 553     if document.backend != "latex":
 554         return
 555
 556     i = 0
 557     while i < len(document.body):
 558         words = document.body[i].split()
 559         if len(words) > 1 and words[0] == "\\begin_inset" and \
 560            words[1] in ["CommandInset", "ERT", "External", "Formula", "Graphics", "IPA", "listings"]:
 561             # must not replace anything in insets that store LaTeX contents in .lyx files
 562             # (math and command insets withut overridden read() and write() methods
 563             # filtering out IPA makes Text::readParToken() more simple
 564             # skip ERT as well since it is not needed there
 565             j = find_end_of_inset(document.body, i)
 566             if j == -1:
 567                 document.warning("Malformed LyX document: Can't find end of " + words[1] + " inset at line " + str(i))
 568                 i += 1
 569             else:
 570                 i = j
 571             continue
 572         while True:
 573             j = document.body[i].find("--")
 574             if j == -1:
 575                 break
 576             front = document.body[i][:j]
 577             back = document.body[i][j+2:]
 578             # We can have an arbitrary number of consecutive hyphens.
 579             # These must be split into the corresponding number of two and three hyphens
 580             # We must match what LaTeX does: First try emdash, then endash, then single hyphen
 581             if back.find("-") == 0:
 582                 back = back[1:]
 583                 if len(back) > 0:
 584                     document.body.insert(i+1, back)
 585                 document.body[i] = front + "\\threehyphens"
 586             else:
 587                 if len(back) > 0:
 588                     document.body.insert(i+1, back)
 589                 document.body[i] = front + "\\twohyphens"
 590         i += 1
 591
 592
 593 def revert_dashes(document):
 594     "convert \\twohyphens and \\threehyphens to -- and ---"
 595
 596     i = 0
 597     while i < len(document.body):
 598         words = document.body[i].split()
 599         if len(words) > 1 and words[0] == "\\begin_inset" and \
 600            words[1] in ["CommandInset", "ERT", "External", "Formula", "Graphics", "IPA", "listings"]:
 601             # see convert_dashes
 602             j = find_end_of_inset(document.body, i)
 603             if j == -1:
 604                 document.warning("Malformed LyX document: Can't find end of " + words[1] + " inset at line " + str(i))
 605                 i += 1
 606             else:
 607                 i = j
 608             continue
 609         replaced = False
 610         if document.body[i].find("\\twohyphens") >= 0:
 611             document.body[i] = document.body[i].replace("\\twohyphens", "--")
 612             replaced = True
 613         if document.body[i].find("\\threehyphens") >= 0:
 614             document.body[i] = document.body[i].replace("\\threehyphens", "---")
 615             replaced = True
 616         if replaced and i+1 < len(document.body) and \
 617            (document.body[i+1].find("\\") != 0 or \
 618             document.body[i+1].find("\\twohyphens") == 0 or
 619             document.body[i+1].find("\\threehyphens") == 0) and \
 620            len(document.body[i]) + len(document.body[i+1]) <= 80:
 621             document.body[i] = document.body[i] + document.body[i+1]
 622             document.body[i+1:i+2] = []
 623         else:
 624             i += 1
 625
 626
 627 # order is important for the last three!
 628 phrases = ["LyX", "LaTeX2e", "LaTeX", "TeX"]
 629
 630 def is_part_of_converted_phrase(line, j, phrase):
 631     "is phrase part of an already converted phrase?"
 632     for p in phrases:
 633         converted = "\\SpecialCharNoPassThru \\" + p
 634         pos = j + len(phrase) - len(converted)
 635         if pos >= 0:
 636             if line[pos:pos+len(converted)] == converted:
 637                 return True
 638     return False
 639
 640
 641 def convert_phrases(document):
 642     "convert special phrases from plain text to \\SpecialCharNoPassThru"
 643
 644     if document.backend != "latex":
 645         return
 646
 647     for phrase in phrases:
 648         i = 0
 649         while i < len(document.body):
 650             words = document.body[i].split()
 651             if len(words) > 1 and words[0] == "\\begin_inset" and \
 652                words[1] in ["CommandInset", "External", "Formula", "Graphics", "listings"]:
 653                 # must not replace anything in insets that store LaTeX contents in .lyx files
 654                 # (math and command insets withut overridden read() and write() methods
 655                 j = find_end_of_inset(document.body, i)
 656                 if j == -1:
 657                     document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
 658                     i += 1
 659                 else:
 660                     i = j
 661                 continue
 662             if document.body[i].find("\\") == 0:
 663                 i += 1
 664                 continue
 665             j = document.body[i].find(phrase)
 666             if j == -1:
 667                 i += 1
 668                 continue
 669             if not is_part_of_converted_phrase(document.body[i], j, phrase):
 670                 front = document.body[i][:j]
 671                 back = document.body[i][j+len(phrase):]
 672                 if len(back) > 0:
 673                     document.body.insert(i+1, back)
 674                 # We cannot use SpecialChar since we do not know whether we are outside passThru
 675                 document.body[i] = front + "\\SpecialCharNoPassThru \\" + phrase
 676             i += 1
 677
 678
 679 def revert_phrases(document):
 680     "convert special phrases to plain text"
 681
 682     i = 0
 683     while i < len(document.body):
 684         words = document.body[i].split()
 685         if len(words) > 1 and words[0] == "\\begin_inset" and \
 686            words[1] in ["CommandInset", "External", "Formula", "Graphics", "listings"]:
 687             # see convert_phrases
 688             j = find_end_of_inset(document.body, i)
 689             if j == -1:
 690                 document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
 691                 i += 1
 692             else:
 693                 i = j
 694             continue
 695         replaced = False
 696         for phrase in phrases:
 697             # we can replace SpecialChar since LyX ensures that it cannot be inserted into passThru parts
 698             if document.body[i].find("\\SpecialChar \\" + phrase) >= 0:
 699                 document.body[i] = document.body[i].replace("\\SpecialChar \\" + phrase, phrase)
 700                 replaced = True
 701             if document.body[i].find("\\SpecialCharNoPassThru \\" + phrase) >= 0:
 702                 document.body[i] = document.body[i].replace("\\SpecialCharNoPassThru \\" + phrase, phrase)
 703                 replaced = True
 704         if replaced and i+1 < len(document.body) and \
 705            (document.body[i+1].find("\\") != 0 or \
 706             document.body[i+1].find("\\SpecialChar") == 0) and \
 707            len(document.body[i]) + len(document.body[i+1]) <= 80:
 708             document.body[i] = document.body[i] + document.body[i+1]
 709             document.body[i+1:i+2] = []
 710             i -= 1
 711         i += 1
 712
 713
 714 def convert_specialchar_internal(document, forward):
 715     specialchars = {"\\-":"softhyphen", "\\textcompwordmark{}":"ligaturebreak", \
 716         "\\@.":"endofsentence", "\\ldots{}":"ldots", \
 717         "\\menuseparator":"menuseparator", "\\slash{}":"breakableslash", \
 718         "\\nobreakdash-":"nobreakdash", "\\LyX":"LyX", \
 719         "\\TeX":"TeX", "\\LaTeX2e":"LaTeX2e", \
 720         "\\LaTeX":"LaTeX" # must be after LaTeX2e
 721     }
 722
 723     i = 0
 724     while i < len(document.body):
 725         words = document.body[i].split()
 726         if len(words) > 1 and words[0] == "\\begin_inset" and \
 727            words[1] in ["CommandInset", "External", "Formula", "Graphics", "listings"]:
 728             # see convert_phrases
 729             j = find_end_of_inset(document.body, i)
 730             if j == -1:
 731                 document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
 732                 i += 1
 733             else:
 734                 i = j
 735             continue
 736         for key, value in specialchars.iteritems():
 737             if forward:
 738                 document.body[i] = document.body[i].replace("\\SpecialChar " + key, "\\SpecialChar " + value)
 739                 document.body[i] = document.body[i].replace("\\SpecialCharNoPassThru " + key, "\\SpecialCharNoPassThru " + value)
 740             else:
 741                 document.body[i] = document.body[i].replace("\\SpecialChar " + value, "\\SpecialChar " + key)
 742                 document.body[i] = document.body[i].replace("\\SpecialCharNoPassThru " + value, "\\SpecialCharNoPassThru " + key)
 743         i += 1
 744
 745
 746 def convert_specialchar(document):
 747     "convert special characters to new syntax"
 748     convert_specialchar_internal(document, True)
 749
 750
 751 def revert_specialchar(document):
 752     "convert special characters to old syntax"
 753     convert_specialchar_internal(document, False)
 754
 755
 756 def revert_georgian(document):
 757     "Set the document language to English but assure Georgian output"
 758
 759     if document.language == "georgian":
 760         document.language = "english"
 761         i = find_token(document.header, "\\language georgian", 0)
 762         if i != -1:
 763             document.header[i] = "\\language english"
 764         j = find_token(document.header, "\\language_package default", 0)
 765         if j != -1:
 766             document.header[j] = "\\language_package babel"
 767         k = find_token(document.header, "\\options", 0)
 768         if k != -1:
 769             document.header[k] = document.header[k].replace("\\options", "\\options georgian,")
 770         else:
 771             l = find_token(document.header, "\\use_default_options", 0)
 772             document.header.insert(l + 1, "\\options georgian")
 773
 774
 775 def revert_sigplan_doi(document):
 776     " Reverts sigplanconf DOI layout to ERT "
 777
 778     if document.textclass != "sigplanconf":
 779         return
 780
 781     i = 0
 782     while True:
 783         i = find_token(document.body, "\\begin_layout DOI", i)
 784         if i == -1:
 785             return
 786         j = find_end_of_layout(document.body, i)
 787         if j == -1:
 788             document.warning("Malformed LyX document: Can't find end of DOI layout")
 789             i += 1
 790             continue
 791
 792         content = lyx2latex(document, document.body[i:j + 1])
 793         add_to_preamble(document, ["\\doi{" + content + "}"])
 794         del document.body[i:j + 1]
 795         # no need to reset i
 796
 797
 798 def revert_ex_itemargs(document):
 799     " Reverts \\item arguments of the example environments (Linguistics module) to TeX-code "
 800
 801     # Do we use the linguistics module?
 802     have_mod = False
 803     mods = document.get_module_list()
 804     for mod in mods:
 805         if mod == "linguistics":
 806             have_mod = True
 807             continue
 808
 809     if not have_mod:
 810         return
 811
 812     i = 0
 813     example_layouts = ["Numbered Examples (consecutive)", "Subexample"]
 814     while True:
 815         i = find_token(document.body, "\\begin_inset Argument item:", i)
 816         if i == -1:
 817             return
 818         j = find_end_of_inset(document.body, i)
 819         # Find containing paragraph layout
 820         parent = get_containing_layout(document.body, i)
 821         if parent == False:
 822             document.warning("Malformed LyX document: Can't find parent paragraph layout")
 823             i += 1
 824             continue
 825         parbeg = parent[3]
 826         layoutname = parent[0]
 827         if layoutname in example_layouts:
 828             beginPlain = find_token(document.body, "\\begin_layout Plain Layout", i)
 829             endPlain = find_end_of_layout(document.body, beginPlain)
 830             content = document.body[beginPlain + 1 : endPlain]
 831             del document.body[i:j+1]
 832             subst = put_cmd_in_ert("[") + content + put_cmd_in_ert("]")
 833             document.body[parbeg : parbeg] = subst
 834         i += 1
 835
 836
 837 def revert_forest(document):
 838     " Reverts the forest environment (Linguistics module) to TeX-code "
 839
 840     # Do we use the linguistics module?
 841     have_mod = False
 842     mods = document.get_module_list()
 843     for mod in mods:
 844         if mod == "linguistics":
 845             have_mod = True
 846             continue
 847
 848     if not have_mod:
 849         return
 850
 851     i = 0
 852     while True:
 853         i = find_token(document.body, "\\begin_inset Flex Structure Tree", i)
 854         if i == -1:
 855             return
 856         j = find_end_of_inset(document.body, i)
 857         if j == -1:
 858             document.warning("Malformed LyX document: Can't find end of Structure Tree inset")
 859             i += 1
 860             continue
 861
 862         beginPlain = find_token(document.body, "\\begin_layout Plain Layout", i)
 863         endPlain = find_end_of_layout(document.body, beginPlain)
 864         content = lyx2latex(document, document.body[beginPlain : endPlain])
 865
 866         add_to_preamble(document, ["\\usepackage{forest}"])
 867
 868         document.body[i:j + 1] = ["\\begin_inset ERT", "status collapsed", "",
 869                 "\\begin_layout Plain Layout", "", "\\backslash",
 870                 "begin{forest}", "\\end_layout", "", "\\begin_layout Plain Layout",
 871                 content, "\\end_layout", "", "\\begin_layout Plain Layout",
 872                 "\\backslash", "end{forest}", "", "\\end_layout", "", "\\end_inset"]
 873         # no need to reset i
 874
 875
 876 def revert_glossgroup(document):
 877     " Reverts the GroupGlossedWords inset (Linguistics module) to TeX-code "
 878
 879     # Do we use the linguistics module?
 880     have_mod = False
 881     mods = document.get_module_list()
 882     for mod in mods:
 883         if mod == "linguistics":
 884             have_mod = True
 885             continue
 886
 887     if not have_mod:
 888         return
 889
 890     i = 0
 891     while True:
 892         i = find_token(document.body, "\\begin_inset Flex GroupGlossedWords", i)
 893         if i == -1:
 894             return
 895         j = find_end_of_inset(document.body, i)
 896         if j == -1:
 897             document.warning("Malformed LyX document: Can't find end of GroupGlossedWords inset")
 898             i += 1
 899             continue
 900
 901         beginPlain = find_token(document.body, "\\begin_layout Plain Layout", i)
 902         endPlain = find_end_of_layout(document.body, beginPlain)
 903         content = lyx2latex(document, document.body[beginPlain : endPlain])
 904
 905         document.body[i:j + 1] = ["{", "", content, "", "}"]
 906         # no need to reset i
 907
 908
 909 def revert_newgloss(document):
 910     " Reverts the new Glosse insets (Linguistics module) to the old format "
 911
 912     # Do we use the linguistics module?
 913     have_mod = False
 914     mods = document.get_module_list()
 915     for mod in mods:
 916         if mod == "linguistics":
 917             have_mod = True
 918             continue
 919
 920     if not have_mod:
 921         return
 922
 923     glosses = ("\\begin_inset Flex Glosse", "\\begin_inset Flex Tri-Glosse")
 924     for glosse in glosses:
 925         i = 0
 926         while True:
 927             i = find_token(document.body, glosse, i)
 928             if i == -1:
 929                 break
 930             j = find_end_of_inset(document.body, i)
 931             if j == -1:
 932                 document.warning("Malformed LyX document: Can't find end of Glosse inset")
 933                 i += 1
 934                 continue
 935
 936             arg = find_token(document.body, "\\begin_inset Argument 1", i, j)
 937             endarg = find_end_of_inset(document.body, arg)
 938             argcontent = ""
 939             if arg != -1:
 940                 argbeginPlain = find_token(document.body, "\\begin_layout Plain Layout", arg, endarg)
 941                 if argbeginPlain == -1:
 942                     document.warning("Malformed LyX document: Can't find arg plain Layout")
 943                     i += 1
 944                     continue
 945                 argendPlain = find_end_of_inset(document.body, argbeginPlain)
 946                 argcontent = lyx2latex(document, document.body[argbeginPlain : argendPlain - 2])
 947
 948                 document.body[j:j] = ["", "\\begin_layout Plain Layout","\\backslash", "glt ",
 949                     argcontent, "\\end_layout"]
 950
 951                 # remove Arg insets and paragraph, if it only contains this inset
 952                 if document.body[arg - 1] == "\\begin_layout Plain Layout" and find_end_of_layout(document.body, arg - 1) == endarg + 3:
 953                     del document.body[arg - 1 : endarg + 4]
 954                 else:
 955                     del document.body[arg : endarg + 1]
 956
 957             beginPlain = find_token(document.body, "\\begin_layout Plain Layout", i)
 958             endPlain = find_end_of_layout(document.body, beginPlain)
 959             content = lyx2latex(document, document.body[beginPlain : endPlain])
 960
 961             document.body[beginPlain + 1:endPlain] = [content]
 962             i = beginPlain + 1
 963
 964
 965 def convert_newgloss(document):
 966     " Converts Glosse insets (Linguistics module) to the new format "
 967
 968     # Do we use the linguistics module?
 969     have_mod = False
 970     mods = document.get_module_list()
 971     for mod in mods:
 972         if mod == "linguistics":
 973             have_mod = True
 974             continue
 975
 976     if not have_mod:
 977         return
 978
 979     glosses = ("\\begin_inset Flex Glosse", "\\begin_inset Flex Tri-Glosse")
 980     for glosse in glosses:
 981         i = 0
 982         while True:
 983             i = find_token(document.body, glosse, i)
 984             if i == -1:
 985                 break
 986             j = find_end_of_inset(document.body, i)
 987             if j == -1:
 988                 document.warning("Malformed LyX document: Can't find end of Glosse inset")
 989                 i += 1
 990                 continue
 991
 992             k = i
 993             while True:
 994                 argcontent = []
 995                 beginPlain = find_token(document.body, "\\begin_layout Plain Layout", k, j)
 996                 if beginPlain == -1:
 997                     break
 998                 endPlain = find_end_of_layout(document.body, beginPlain)
 999                 if endPlain == -1:
1000                     document.warning("Malformed LyX document: Can't find end of Glosse layout")
1001                     i += 1
1002                     continue
1003
1004                 glt  = find_token(document.body, "\\backslash", beginPlain, endPlain)
1005                 if glt != -1 and document.body[glt + 1].startswith("glt"):
1006                     document.body[glt + 1] = document.body[glt + 1].lstrip("glt").lstrip()
1007                     argcontent = document.body[glt + 1 : endPlain]
1008                     document.body[beginPlain + 1 : endPlain] = ["\\begin_inset Argument 1", "status open", "",
1009                         "\\begin_layout Plain Layout", "\\begin_inset ERT", "status open", "",
1010                         "\\begin_layout Plain Layout", ""] + argcontent + ["\\end_layout", "", "\\end_inset", "",
1011                         "\\end_layout", "", "\\end_inset"]
1012                 else:
1013                     content = document.body[beginPlain + 1 : endPlain]
1014                     document.body[beginPlain + 1 : endPlain] = ["\\begin_inset ERT", "status open", "",
1015                         "\\begin_layout Plain Layout"] + content + ["\\end_layout", "", "\\end_inset"]
1016
1017                 endPlain = find_end_of_layout(document.body, beginPlain)
1018                 k = endPlain
1019                 j = find_end_of_inset(document.body, i)
1020
1021             i = endPlain + 1
1022
1023
1024 def convert_BoxFeatures(document):
1025     " adds new box features "
1026
1027     i = 0
1028     while True:
1029         i = find_token(document.body, "height_special", i)
1030         if i == -1:
1031             return
1032         document.body[i+1:i+1] = ['thickness "0.4pt"', 'separation "3pt"', 'shadowsize "4pt"']
1033         i = i + 4
1034
1035
1036 def revert_BoxFeatures(document):
1037     " outputs new box features as TeX code "
1038
1039     i = 0
1040     defaultSep = "3pt"
1041     defaultThick = "0.4pt"
1042     defaultShadow = "4pt"
1043     while True:
1044         i = find_token(document.body, "height_special", i)
1045         if i == -1:
1046             return
1047         # read out the values
1048         beg = document.body[i+1].find('"');
1049         end = document.body[i+1].rfind('"');
1050         thickness = document.body[i+1][beg+1:end];
1051         beg = document.body[i+2].find('"');
1052         end = document.body[i+2].rfind('"');
1053         separation = document.body[i+2][beg+1:end];
1054         beg = document.body[i+3].find('"');
1055         end = document.body[i+3].rfind('"');
1056         shadowsize = document.body[i+3][beg+1:end];
1057         # delete the specification
1058         del document.body[i+1:i+4]
1059         # output ERT
1060         # first output the closing brace
1061         if shadowsize != defaultShadow or separation != defaultSep or thickness != defaultThick:
1062             document.body[i + 10 : i + 10] = put_cmd_in_ert("}")
1063         # now output the lengths
1064         if shadowsize != defaultShadow or separation != defaultSep or thickness != defaultThick:
1065             document.body[i - 10 : i - 10] = put_cmd_in_ert("{")
1066         if thickness != defaultThick:
1067             document.body[i - 5 : i - 4] = ["{\\backslash fboxrule " + thickness]
1068         if separation != defaultSep and thickness == defaultThick:
1069             document.body[i - 5 : i - 4] = ["{\\backslash fboxsep " + separation]
1070         if separation != defaultSep and thickness != defaultThick:
1071             document.body[i - 5 : i - 4] = ["{\\backslash fboxrule " + thickness + "\\backslash fboxsep " + separation]
1072         if shadowsize != defaultShadow and separation == defaultSep and thickness == defaultThick:
1073             document.body[i - 5 : i - 4] = ["{\\backslash shadowsize " + shadowsize]
1074         if shadowsize != defaultShadow and separation != defaultSep and thickness == defaultThick:
1075             document.body[i - 5 : i - 4] = ["{\\backslash fboxsep " + separation + "\\backslash shadowsize " + shadowsize]
1076         if shadowsize != defaultShadow and separation == defaultSep and thickness != defaultThick:
1077             document.body[i - 5 : i - 4] = ["{\\backslash fboxrule " + thickness + "\\backslash shadowsize " + shadowsize]
1078         if shadowsize != defaultShadow and separation != defaultSep and thickness != defaultThick:
1079             document.body[i - 5 : i - 4] = ["{\\backslash fboxrule " + thickness + "\\backslash fboxsep " + separation + "\\backslash shadowsize " + shadowsize]
1080         i = i + 11
1081
1082
1083 def convert_origin(document):
1084     " Insert the origin tag "
1085
1086     i = find_token(document.header, "\\textclass ", 0)
1087     if i == -1:
1088         document.warning("Malformed LyX document: No \\textclass!!")
1089         return;
1090     if document.dir == "":
1091         origin = "stdin"
1092     else:
1093         origin = document.dir.replace('\\', '/') + '/'
1094         if os.name != 'nt':
1095             origin = unicode(origin, sys.getfilesystemencoding())
1096     document.header[i:i] = ["\\origin " + origin]
1097
1098
1099 def revert_origin(document):
1100     " Remove the origin tag "
1101
1102     i = find_token(document.header, "\\origin ", 0)
1103     if i == -1:
1104         document.warning("Malformed LyX document: No \\origin!!")
1105         return;
1106     del document.header[i]
1107
1108
1109 color_names = ["brown", "darkgray", "gray", \
1110                "lightgray", "lime", "olive", "orange", \
1111                "pink", "purple", "teal", "violet"]
1112
1113 def revert_textcolor(document):
1114     " revert new \\textcolor colors to TeX code "
1115
1116     i = 0
1117     j = 0
1118     xcolor = False
1119     while True:
1120         i = find_token(document.body, "\\color ", i)
1121         if i == -1:
1122             return
1123         else:
1124             for color in list(color_names):
1125                 if document.body[i] == "\\color " + color:
1126                     # register that xcolor must be loaded in the preamble
1127                     if xcolor == False:
1128                         xcolor = True
1129                         add_to_preamble(document, ["\\@ifundefined{rangeHsb}{\usepackage{xcolor}}{}"])
1130                     # find the next \\color and/or the next \\end_layout
1131                     j = find_token(document.body, "\\color", i + 1)
1132                     k = find_token(document.body, "\\end_layout", i + 1)
1133                     if j == -1 and k != -1:
1134                         j = k +1
1135                     # output TeX code
1136                     # first output the closing brace
1137                     if k < j:
1138                         document.body[k: k] = put_cmd_in_ert("}")
1139                     else:
1140                         document.body[j: j] = put_cmd_in_ert("}")
1141                     # now output the \textcolor command
1142                     document.body[i : i + 1] = put_cmd_in_ert("\\textcolor{" + color + "}{")
1143         i = i + 1
1144
1145
1146 def convert_colorbox(document):
1147     " adds color settings for boxes "
1148
1149     i = 0
1150     while True:
1151         i = find_token(document.body, "shadowsize", i)
1152         if i == -1:
1153             return
1154         document.body[i+1:i+1] = ['framecolor "black"', 'backgroundcolor "none"']
1155         i = i + 3
1156
1157
1158 def revert_colorbox(document):
1159     " outputs color settings for boxes as TeX code "
1160
1161     binset = 0
1162     defaultframecolor = "black"
1163     defaultbackcolor = "none"
1164     while True:
1165         binset = find_token(document.body, "\\begin_inset Box", binset)
1166         if binset == -1:
1167             return
1168
1169         einset = find_end_of_inset(document.body, binset)
1170         if einset == -1:
1171             document.warning("Malformed LyX document: Can't find end of box inset!")
1172             binset += 1
1173             continue
1174
1175         blay = find_token(document.body, "\\begin_layout", binset, einset)
1176         if blay == -1:
1177             document.warning("Malformed LyX document: Can't find start of layout!")
1178             binset = einset
1179             continue
1180
1181         # doing it this way, we make sure only to find a framecolor option
1182         frame = find_token(document.body, "framecolor", binset, blay)
1183         if frame == -1:
1184             binset = einset
1185             continue
1186
1187         beg = document.body[frame].find('"')
1188         end = document.body[frame].rfind('"')
1189         framecolor = document.body[frame][beg+1:end]
1190
1191         # this should be on the next line
1192         bgcolor = frame + 1
1193         beg = document.body[bgcolor].find('"')
1194         end = document.body[bgcolor].rfind('"')
1195         backcolor = document.body[bgcolor][beg+1:end]
1196
1197         # delete those bits
1198         del document.body[frame:frame+2]
1199         # adjust end of inset
1200         einset -= 2
1201
1202         if document.body[binset] == "\\begin_inset Box Boxed" and \
1203             framecolor != defaultframecolor:
1204           document.body[binset] = "\\begin_inset Box Frameless"
1205
1206         # output TeX code
1207         # first output the closing brace
1208         if framecolor == defaultframecolor and backcolor == defaultbackcolor:
1209             # nothing needed
1210             pass
1211         else:
1212             document.body[einset + 1 : einset + 1] = put_cmd_in_ert("}")
1213             if framecolor != defaultframecolor:
1214                 document.body[binset:binset] = put_cmd_in_ert("\\backslash fcolorbox{" + framecolor + "}{" + backcolor + "}{")
1215             else:
1216               document.body[binset:binset] = put_cmd_in_ert("\\backslash colorbox{" + backcolor + "}{")
1217
1218         binset = einset
1219
1220
1221 def revert_mathmulticol(document):
1222     " Convert formulas to ERT if they contain multicolumns "
1223
1224     i = 0
1225     while True:
1226         i = find_token(document.body, '\\begin_inset Formula', i)
1227         if i == -1:
1228             return
1229         j = find_end_of_inset(document.body, i)
1230         if j == -1:
1231             document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
1232             i += 1
1233             continue
1234         lines = document.body[i:j]
1235         lines[0] = lines[0].replace('\\begin_inset Formula', '').lstrip()
1236         code = "\n".join(lines)
1237         converted = False
1238         k = 0
1239         n = 0
1240         while n >= 0:
1241             n = code.find("\\multicolumn", k)
1242             # no need to convert degenerated multicolumn cells,
1243             # they work in old LyX versions as "math ERT"
1244             if n != -1 and code.find("\\multicolumn{1}", k) != n:
1245                 ert = put_cmd_in_ert(code)
1246                 document.body[i:j+1] = ert
1247                 converted = True
1248                 break
1249             else:
1250                 k = n + 12
1251         if converted:
1252             i = find_end_of_inset(document.body, i)
1253         else:
1254             i = j
1255
1256
1257 def revert_jss(document):
1258     " Reverts JSS In_Preamble commands to ERT in preamble "
1259
1260     if document.textclass != "jss":
1261         return
1262
1263     h = 0
1264     m = 0
1265     j = 0
1266     k = 0
1267     n = 0
1268     while True:
1269       # at first revert the inset layouts because they can be part of the In_Preamble layouts
1270       while m != -1 or j != -1 or h != -1 or k != -1 or n != -1:
1271         # \pkg
1272         if h != -1:
1273           h = find_token(document.body, "\\begin_inset Flex Pkg", h)
1274         if h != -1:
1275           endh = find_end_of_inset(document.body, h)
1276           document.body[endh - 2 : endh + 1] = put_cmd_in_ert("}")
1277           document.body[h : h + 4] = put_cmd_in_ert("\\pkg{")
1278           h = h + 5
1279         # \proglang
1280         if m != -1:
1281           m = find_token(document.body, "\\begin_inset Flex Proglang", m)
1282         if m != -1:
1283           endm = find_end_of_inset(document.body, m)
1284           document.body[endm - 2 : endm + 1] = put_cmd_in_ert("}")
1285           document.body[m : m + 4] = put_cmd_in_ert("\\proglang{")
1286           m = m + 5
1287         # \code
1288         if j != -1:
1289           j = find_token(document.body, "\\begin_inset Flex Code", j)
1290         if j != -1:
1291           # assure that we are not in a Code Chunk inset
1292           if document.body[j][-1] == "e":
1293               endj = find_end_of_inset(document.body, j)
1294               document.body[endj - 2 : endj + 1] = put_cmd_in_ert("}")
1295               document.body[j : j + 4] = put_cmd_in_ert("\\code{")
1296               j = j + 5
1297           else:
1298               j = j + 1
1299         # \email
1300         if k != -1:
1301           k = find_token(document.body, "\\begin_inset Flex E-mail", k)
1302         if k != -1:
1303           endk = find_end_of_inset(document.body, k)
1304           document.body[endk - 2 : endk + 1] = put_cmd_in_ert("}")
1305           document.body[k : k + 4] = put_cmd_in_ert("\\email{")
1306           k = k + 5
1307         # \url
1308         if n != -1:
1309           n = find_token(document.body, "\\begin_inset Flex URL", n)
1310         if n != -1:
1311           endn = find_end_of_inset(document.body, n)
1312           document.body[endn - 2 : endn + 1] = put_cmd_in_ert("}")
1313           document.body[n : n + 4] = put_cmd_in_ert("\\url{")
1314           n = n + 5
1315       # now revert the In_Preamble layouts
1316       # \title
1317       i = find_token(document.body, "\\begin_layout Title", 0)
1318       if i == -1:
1319         return
1320       j = find_end_of_layout(document.body, i)
1321       if j == -1:
1322         document.warning("Malformed LyX document: Can't find end of Title layout")
1323         i += 1
1324         continue
1325       content = lyx2latex(document, document.body[i:j + 1])
1326       add_to_preamble(document, ["\\title{" + content + "}"])
1327       del document.body[i:j + 1]
1328       # \author
1329       i = find_token(document.body, "\\begin_layout Author", 0)
1330       if i == -1:
1331         return
1332       j = find_end_of_layout(document.body, i)
1333       if j == -1:
1334         document.warning("Malformed LyX document: Can't find end of Author layout")
1335         i += 1
1336         continue
1337       content = lyx2latex(document, document.body[i:j + 1])
1338       add_to_preamble(document, ["\\author{" + content + "}"])
1339       del document.body[i:j + 1]
1340       # \Plainauthor
1341       i = find_token(document.body, "\\begin_layout Plain Author", 0)
1342       if i == -1:
1343         return
1344       j = find_end_of_layout(document.body, i)
1345       if j == -1:
1346         document.warning("Malformed LyX document: Can't find end of Plain Author layout")
1347         i += 1
1348         continue
1349       content = lyx2latex(document, document.body[i:j + 1])
1350       add_to_preamble(document, ["\\Plainauthor{" + content + "}"])
1351       del document.body[i:j + 1]
1352       # \Plaintitle
1353       i = find_token(document.body, "\\begin_layout Plain Title", 0)
1354       if i == -1:
1355         return
1356       j = find_end_of_layout(document.body, i)
1357       if j == -1:
1358         document.warning("Malformed LyX document: Can't find end of Plain Title layout")
1359         i += 1
1360         continue
1361       content = lyx2latex(document, document.body[i:j + 1])
1362       add_to_preamble(document, ["\\Plaintitle{" + content + "}"])
1363       del document.body[i:j + 1]
1364       # \Shorttitle
1365       i = find_token(document.body, "\\begin_layout Short Title", 0)
1366       if i == -1:
1367         return
1368       j = find_end_of_layout(document.body, i)
1369       if j == -1:
1370         document.warning("Malformed LyX document: Can't find end of Short Title layout")
1371         i += 1
1372         continue
1373       content = lyx2latex(document, document.body[i:j + 1])
1374       add_to_preamble(document, ["\\Shorttitle{" + content + "}"])
1375       del document.body[i:j + 1]
1376       # \Abstract
1377       i = find_token(document.body, "\\begin_layout Abstract", 0)
1378       if i == -1:
1379         return
1380       j = find_end_of_layout(document.body, i)
1381       if j == -1:
1382         document.warning("Malformed LyX document: Can't find end of Abstract layout")
1383         i += 1
1384         continue
1385       content = lyx2latex(document, document.body[i:j + 1])
1386       add_to_preamble(document, ["\\Abstract{" + content + "}"])
1387       del document.body[i:j + 1]
1388       # \Keywords
1389       i = find_token(document.body, "\\begin_layout Keywords", 0)
1390       if i == -1:
1391         return
1392       j = find_end_of_layout(document.body, i)
1393       if j == -1:
1394         document.warning("Malformed LyX document: Can't find end of Keywords layout")
1395         i += 1
1396         continue
1397       content = lyx2latex(document, document.body[i:j + 1])
1398       add_to_preamble(document, ["\\Keywords{" + content + "}"])
1399       del document.body[i:j + 1]
1400       # \Plainkeywords
1401       i = find_token(document.body, "\\begin_layout Plain Keywords", 0)
1402       if i == -1:
1403         return
1404       j = find_end_of_layout(document.body, i)
1405       if j == -1:
1406         document.warning("Malformed LyX document: Can't find end of Plain Keywords layout")
1407         i += 1
1408         continue
1409       content = lyx2latex(document, document.body[i:j + 1])
1410       add_to_preamble(document, ["\\Plainkeywords{" + content + "}"])
1411       del document.body[i:j + 1]
1412       # \Address
1413       i = find_token(document.body, "\\begin_layout Address", 0)
1414       if i == -1:
1415         return
1416       j = find_end_of_layout(document.body, i)
1417       if j == -1:
1418         document.warning("Malformed LyX document: Can't find end of Address layout")
1419         i += 1
1420         continue
1421       content = lyx2latex(document, document.body[i:j + 1])
1422       add_to_preamble(document, ["\\Address{" + content + "}"])
1423       del document.body[i:j + 1]
1424       # finally handle the code layouts
1425       h = 0
1426       m = 0
1427       j = 0
1428       k = 0
1429       while m != -1 or j != -1 or h != -1 or k != -1:
1430         # \CodeChunk
1431         if h != -1:
1432           h = find_token(document.body, "\\begin_inset Flex Code Chunk", h)
1433         if h != -1:
1434           endh = find_end_of_inset(document.body, h)
1435           document.body[endh + 1 : endh] = ["\\end_layout"]
1436           document.body[endh : endh + 1] = put_cmd_in_ert("\\end{CodeChunk}")
1437           document.body[h : h + 3] = put_cmd_in_ert("\\begin{CodeChunk}")
1438           document.body[h - 1 : h] = ["\\begin_layout Standard"]
1439           h = h + 1
1440         # \CodeInput
1441         if j != -1:
1442           j = find_token(document.body, "\\begin_layout Code Input", j)
1443         if j != -1:
1444           endj = find_end_of_layout(document.body, j)
1445           document.body[endj : endj + 1] = ["\\end_layout", "", "\\begin_layout Standard"]
1446           document.body[endj + 3 : endj + 4] = put_cmd_in_ert("\\end{CodeInput}")
1447           document.body[endj + 13 : endj + 13] = ["\\end_layout", "", "\\begin_layout Standard"]
1448           document.body[j + 1 : j] = ["\\end_layout", "", "\\begin_layout Standard"]
1449           document.body[j : j + 1] = put_cmd_in_ert("\\begin{CodeInput}")
1450           j = j + 1
1451         # \CodeOutput
1452         if k != -1:
1453           k = find_token(document.body, "\\begin_layout Code Output", k)
1454         if k != -1:
1455           endk = find_end_of_layout(document.body, k)
1456           document.body[endk : endk + 1] = ["\\end_layout", "", "\\begin_layout Standard"]
1457           document.body[endk + 3 : endk + 4] = put_cmd_in_ert("\\end{CodeOutput}")
1458           document.body[endk + 13 : endk + 13] = ["\\end_layout", "", "\\begin_layout Standard"]
1459           document.body[k + 1 : k] = ["\\end_layout", "", "\\begin_layout Standard"]
1460           document.body[k : k + 1] = put_cmd_in_ert("\\begin{CodeOutput}")
1461           k = k + 1
1462         # \Code
1463         if m != -1:
1464           m = find_token(document.body, "\\begin_layout Code", m)
1465         if m != -1:
1466           endm = find_end_of_layout(document.body, m)
1467           document.body[endm : endm + 1] = ["\\end_layout", "", "\\begin_layout Standard"]
1468           document.body[endm + 3 : endm + 4] = put_cmd_in_ert("\\end{Code}")
1469           document.body[endm + 13 : endm + 13] = ["\\end_layout", "", "\\begin_layout Standard"]
1470           document.body[m + 1 : m] = ["\\end_layout", "", "\\begin_layout Standard"]
1471           document.body[m : m + 1] = put_cmd_in_ert("\\begin{Code}")
1472           m = m + 1
1473
1474
1475 def convert_subref(document):
1476     " converts sub: ref prefixes to subref: "
1477
1478     # 1) label insets
1479     rx = re.compile(r'^name \"sub:(.+)$')
1480     i = 0
1481     while True:
1482         i = find_token(document.body, "\\begin_inset CommandInset label", i)
1483         if i == -1:
1484             break
1485         j = find_end_of_inset(document.body, i)
1486         if j == -1:
1487             document.warning("Malformed LyX document: Can't find end of Label inset at line " + str(i))
1488             i += 1
1489             continue
1490
1491         for p in range(i, j):
1492             m = rx.match(document.body[p])
1493             if m:
1494                 label = m.group(1)
1495                 document.body[p] = "name \"subsec:" + label
1496         i += 1
1497
1498     # 2) xref insets
1499     rx = re.compile(r'^reference \"sub:(.+)$')
1500     i = 0
1501     while True:
1502         i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1503         if i == -1:
1504             return
1505         j = find_end_of_inset(document.body, i)
1506         if j == -1:
1507             document.warning("Malformed LyX document: Can't find end of Ref inset at line " + str(i))
1508             i += 1
1509             continue
1510
1511         for p in range(i, j):
1512             m = rx.match(document.body[p])
1513             if m:
1514                 label = m.group(1)
1515                 document.body[p] = "reference \"subsec:" + label
1516                 break
1517         i += 1
1518
1519
1520
1521 def revert_subref(document):
1522     " reverts subref: ref prefixes to sub: "
1523
1524     # 1) label insets
1525     rx = re.compile(r'^name \"subsec:(.+)$')
1526     i = 0
1527     while True:
1528         i = find_token(document.body, "\\begin_inset CommandInset label", i)
1529         if i == -1:
1530             break
1531         j = find_end_of_inset(document.body, i)
1532         if j == -1:
1533             document.warning("Malformed LyX document: Can't find end of Label inset at line " + str(i))
1534             i += 1
1535             continue
1536
1537         for p in range(i, j):
1538             m = rx.match(document.body[p])
1539             if m:
1540                 label = m.group(1)
1541                 document.body[p] = "name \"sub:" + label
1542                 break
1543         i += 1
1544
1545     # 2) xref insets
1546     rx = re.compile(r'^reference \"subsec:(.+)$')
1547     i = 0
1548     while True:
1549         i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1550         if i == -1:
1551             return
1552         j = find_end_of_inset(document.body, i)
1553         if j == -1:
1554             document.warning("Malformed LyX document: Can't find end of Ref inset at line " + str(i))
1555             i += 1
1556             continue
1557
1558         for p in range(i, j):
1559             m = rx.match(document.body[p])
1560             if m:
1561                 label = m.group(1)
1562                 document.body[p] = "reference \"sub:" + label
1563                 break
1564         i += 1
1565
1566
1567 def convert_nounzip(document):
1568     " remove the noUnzip parameter of graphics insets "
1569
1570     rx = re.compile(r'\s*noUnzip\s*$')
1571     i = 0
1572     while True:
1573         i = find_token(document.body, "\\begin_inset Graphics", i)
1574         if i == -1:
1575             break
1576         j = find_end_of_inset(document.body, i)
1577         if j == -1:
1578             document.warning("Malformed LyX document: Can't find end of graphics inset at line " + str(i))
1579             i += 1
1580             continue
1581
1582         k = find_re(document.body, rx, i, j)
1583         if k != -1:
1584           del document.body[k]
1585           j = j - 1
1586         i = j + 1
1587
1588
1589 def convert_revert_external_bbox(document, forward):
1590     " add units to bounding box of external insets "
1591
1592     rx = re.compile(r'^\s*boundingBox\s+\S+\s+\S+\s+\S+\s+\S+\s*$')
1593     i = 0
1594     while True:
1595         i = find_token(document.body, "\\begin_inset External", i)
1596         if i == -1:
1597             break
1598         j = find_end_of_inset(document.body, i)
1599         if j == -1:
1600             document.warning("Malformed LyX document: Can't find end of external inset at line " + str(i))
1601             i += 1
1602             continue
1603         k = find_re(document.body, rx, i, j)
1604         if k == -1:
1605             i = j + 1
1606             continue
1607         tokens = document.body[k].split()
1608         if forward:
1609             for t in range(1, 5):
1610                 tokens[t] += "bp"
1611         else:
1612             for t in range(1, 5):
1613                 tokens[t] = length_in_bp(tokens[t])
1614         document.body[k] = "\tboundingBox " + tokens[1] + " " + tokens[2] + " " + \
1615                            tokens[3] + " " + tokens[4]
1616         i = j + 1
1617
1618
1619 def convert_external_bbox(document):
1620     convert_revert_external_bbox(document, True)
1621
1622
1623 def revert_external_bbox(document):
1624     convert_revert_external_bbox(document, False)
1625
1626
1627 def revert_tcolorbox_1(document):
1628   " Reverts the Flex:Subtitle inset of tcolorbox to TeX-code "
1629   i = -1
1630   while True:
1631     i = find_token(document.header, "tcolorbox", i)
1632     if i == -1:
1633       break
1634     else:
1635       flex = 0
1636       flexEnd = -1
1637       flex = find_token(document.body, "\\begin_inset Flex Subtitle", flex)
1638       if flex == -1:
1639         return flexEnd
1640       flexEnd = find_end_of_inset(document.body, flex)
1641       wasOpt = revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, False, True, False)
1642       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, False, False, False)
1643       flexEnd = find_end_of_inset(document.body, flex)
1644       if wasOpt == True:
1645         document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\tcbsubtitle")
1646       else:
1647         document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\tcbsubtitle{")
1648       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("}")
1649       flex += 1
1650
1651
1652 def revert_tcolorbox_2(document):
1653   " Reverts the Flex:Raster_Color_Box inset of tcolorbox to TeX-code "
1654   i = -1
1655   while True:
1656     i = find_token(document.header, "tcolorbox", i)
1657     if i == -1:
1658       break
1659     else:
1660       flex = 0
1661       flexEnd = -1
1662       flex = find_token(document.body, "\\begin_inset Flex Raster Color Box", flex)
1663       if flex == -1:
1664         return flexEnd
1665       flexEnd = find_end_of_inset(document.body, flex)
1666       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1667       flexEnd = find_end_of_inset(document.body, flex)
1668       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{tcbraster}")
1669       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("\\end{tcbraster}")
1670       flex += 1
1671
1672
1673 def revert_tcolorbox_3(document):
1674   " Reverts the Flex:Custom_Color_Box_1 inset of tcolorbox to TeX-code "
1675   i = -1
1676   while True:
1677     i = find_token(document.header, "tcolorbox", i)
1678     if i == -1:
1679       break
1680     else:
1681       flex = 0
1682       flexEnd = -1
1683       flex = find_token(document.body, "\\begin_inset Flex Custom Color Box 1", flex)
1684       if flex == -1:
1685         return flexEnd
1686       flexEnd = find_end_of_inset(document.body, flex)
1687       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1688       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, True, False, False)
1689       flexEnd = find_end_of_inset(document.body, flex)
1690       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{cBoxA}")
1691       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("{}\\end{cBoxA}")
1692       flex += 1
1693
1694
1695 def revert_tcolorbox_4(document):
1696   " Reverts the Flex:Custom_Color_Box_2 inset of tcolorbox to TeX-code "
1697   i = -1
1698   while True:
1699     i = find_token(document.header, "tcolorbox", i)
1700     if i == -1:
1701       break
1702     else:
1703       flex = 0
1704       flexEnd = -1
1705       flex = find_token(document.body, "\\begin_inset Flex Custom Color Box 2", flex)
1706       if flex == -1:
1707         return flexEnd
1708       flexEnd = find_end_of_inset(document.body, flex)
1709       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1710       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, True, False, False)
1711       flexEnd = find_end_of_inset(document.body, flex)
1712       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{cBoxB}")
1713       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("{}\\end{cBoxB}")
1714       flex += 1
1715
1716
1717 def revert_tcolorbox_5(document):
1718   " Reverts the Flex:Custom_Color_Box_3 inset of tcolorbox to TeX-code "
1719   i = -1
1720   while True:
1721     i = find_token(document.header, "tcolorbox", i)
1722     if i == -1:
1723       break
1724     else:
1725       flex = 0
1726       flexEnd = -1
1727       flex = find_token(document.body, "\\begin_inset Flex Custom Color Box 3", flex)
1728       if flex == -1:
1729         return flexEnd
1730       flexEnd = find_end_of_inset(document.body, flex)
1731       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1732       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, True, False, False)
1733       flexEnd = find_end_of_inset(document.body, flex)
1734       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{cBoxC}")
1735       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("{}\\end{cBoxC}")
1736       flex += 1
1737
1738
1739 def revert_tcolorbox_6(document):
1740   " Reverts the Flex:Custom_Color_Box_4 inset of tcolorbox to TeX-code "
1741   i = -1
1742   while True:
1743     i = find_token(document.header, "tcolorbox", i)
1744     if i == -1:
1745       break
1746     else:
1747       flex = 0
1748       flexEnd = -1
1749       flex = find_token(document.body, "\\begin_inset Flex Custom Color Box 4", flex)
1750       if flex == -1:
1751         return flexEnd
1752       flexEnd = find_end_of_inset(document.body, flex)
1753       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1754       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, True, False, False)
1755       flexEnd = find_end_of_inset(document.body, flex)
1756       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{cBoxD}")
1757       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("{}\\end{cBoxD}")
1758       flex += 1
1759
1760
1761 def revert_tcolorbox_7(document):
1762   " Reverts the Flex:Custom_Color_Box_5 inset of tcolorbox to TeX-code "
1763   i = -1
1764   while True:
1765     i = find_token(document.header, "tcolorbox", i)
1766     if i == -1:
1767       break
1768     else:
1769       flex = 0
1770       flexEnd = -1
1771       flex = find_token(document.body, "\\begin_inset Flex Custom Color Box 5", flex)
1772       if flex == -1:
1773         return flexEnd
1774       flexEnd = find_end_of_inset(document.body, flex)
1775       revert_Argument_to_TeX_brace(document, flex, flexEnd, 1, 1, True, True, False)
1776       revert_Argument_to_TeX_brace(document, flex, 0, 2, 2, True, False, False)
1777       flexEnd = find_end_of_inset(document.body, flex)
1778       document.body[flex + 0 : flex + 4] = put_cmd_in_ert("\\begin{cBoxE}")
1779       document.body[flexEnd + 4 : flexEnd + 7] = put_cmd_in_ert("{}\\end{cBoxE}")
1780       flex += 1
1781
1782
1783 def revert_tcolorbox_8(document):
1784   " Reverts the layout New Color Box Type of tcolorbox to TeX-code "
1785   i = 0
1786   j = 0
1787   k = 0
1788   while True:
1789     if i != -1:
1790       i = find_token(document.body, "\\begin_layout New Color Box Type", i)
1791     if i != -1:
1792       j = find_end_of_layout(document.body, i)
1793       wasOpt = revert_Argument_to_TeX_brace(document, i, j, 1, 1, False, True, False)
1794       revert_Argument_to_TeX_brace(document, i, 0, 2, 2, False, False, True)
1795       revert_Argument_to_TeX_brace(document, i, 0, 3, 4, False, True, False)
1796       document.body[i] = document.body[i].replace("\\begin_layout New Color Box Type", "\\begin_layout Standard")
1797       if wasOpt == True:
1798         document.body[i + 1 : i + 1] = put_cmd_in_ert("\\newtcolorbox")
1799       else:
1800         document.body[i + 1 : i + 1] = put_cmd_in_ert("\\newtcolorbox{")
1801       k = find_end_of_inset(document.body, j)
1802       k = find_token(document.body, "\\end_inset", k + 1)
1803       k = find_token(document.body, "\\end_inset", k + 1)
1804       if wasOpt == True:
1805         k = find_token(document.body, "\\end_inset", k + 1)
1806       document.body[k + 2 : j + 2] = put_cmd_in_ert("{")
1807       j = find_token(document.body, "\\begin_layout Standard", j + 1)
1808       document.body[j - 2 : j - 2] = put_cmd_in_ert("}")
1809       i += 1
1810     if i == -1:
1811       return
1812
1813
1814 def revert_moderncv_1(document):
1815   " Reverts the new inset of moderncv to TeX-code in preamble "
1816
1817   if document.textclass != "moderncv":
1818     return
1819   i = 0
1820   j = 0
1821   lineArg = 0
1822   while True:
1823     # at first revert the new styles
1824     # \moderncvicons
1825     i = find_token(document.body, "\\begin_layout CVIcons", 0)
1826     if i == -1:
1827       return
1828     j = find_end_of_layout(document.body, i)
1829     if j == -1:
1830       document.warning("Malformed LyX document: Can't find end of CVIcons layout")
1831       i += 1
1832       continue
1833     content = lyx2latex(document, document.body[i:j + 1])
1834     add_to_preamble(document, ["\\moderncvicons{" + content + "}"])
1835     del document.body[i:j + 1]
1836     # \hintscolumnwidth
1837     i = find_token(document.body, "\\begin_layout CVColumnWidth", 0)
1838     if i == -1:
1839       return
1840     j = find_end_of_layout(document.body, i)
1841     if j == -1:
1842       document.warning("Malformed LyX document: Can't find end of CVColumnWidth layout")
1843       i += 1
1844       continue
1845     content = lyx2latex(document, document.body[i:j + 1])
1846     add_to_preamble(document, ["\\setlength{\hintscolumnwidth}{" + content + "}"])
1847     del document.body[i:j + 1]
1848     # now change the new styles to the obsolete ones
1849     # \name
1850     i = find_token(document.body, "\\begin_layout Name", 0)
1851     if i == -1:
1852       return
1853     j = find_end_of_layout(document.body, i)
1854     if j == -1:
1855       document.warning("Malformed LyX document: Can't find end of Name layout")
1856       i += 1
1857       continue
1858     lineArg = find_token(document.body, "\\begin_inset Argument 1", i)
1859     if lineArg > j and j != 0:
1860       return
1861     if lineArg != -1:
1862       beginPlain = find_token(document.body, "\\begin_layout Plain Layout", lineArg)
1863       # we have to assure that no other inset is in the Argument
1864       beginInset = find_token(document.body, "\\begin_inset", beginPlain)
1865       endInset = find_token(document.body, "\\end_inset", beginPlain)
1866       k = beginPlain + 1
1867       l = k
1868       while beginInset < endInset and beginInset != -1:
1869         beginInset = find_token(document.body, "\\begin_inset", k)
1870         endInset = find_token(document.body, "\\end_inset", l)
1871         k = beginInset + 1
1872         l = endInset + 1
1873       Arg2 = document.body[l + 5 : l + 6]
1874       # rename the style
1875       document.body[i : i + 1]= ["\\begin_layout FirstName"]
1876       # delete the Argument inset
1877       del( document.body[endInset - 2 : endInset + 3])
1878       del( document.body[lineArg : beginPlain + 1])
1879       document.body[i + 4 : i + 4]= ["\\begin_layout FamilyName"] + Arg2 + ["\\end_layout"] + [""]
1880
1881
1882 def revert_moderncv_2(document):
1883   " Reverts the phone inset of moderncv to the obsoleted mobile or fax "
1884
1885   if document.textclass != "moderncv":
1886     return
1887   i = 0
1888   j = 0
1889   lineArg = 0
1890   while True:
1891     # \phone
1892     i = find_token(document.body, "\\begin_layout Phone", i)
1893     if i == -1:
1894       return
1895     j = find_end_of_layout(document.body, i)
1896     if j == -1:
1897       document.warning("Malformed LyX document: Can't find end of Phone layout")
1898       i += 1
1899       return
1900     lineArg = find_token(document.body, "\\begin_inset Argument 1", i)
1901     if lineArg > j and j != 0:
1902       i += 1
1903       continue
1904     if lineArg != -1:
1905       beginPlain = find_token(document.body, "\\begin_layout Plain Layout", lineArg)
1906       # we have to assure that no other inset is in the Argument
1907       beginInset = find_token(document.body, "\\begin_inset", beginPlain)
1908       endInset = find_token(document.body, "\\end_inset", beginPlain)
1909       k = beginPlain + 1
1910       l = k
1911       while beginInset < endInset and beginInset != -1:
1912         beginInset = find_token(document.body, "\\begin_inset", k)
1913         endInset = find_token(document.body, "\\end_inset", l)
1914         k = beginInset + 1
1915         l = endInset + 1
1916       Arg = document.body[beginPlain + 1 : beginPlain + 2]
1917       # rename the style
1918       if Arg[0] == "mobile":
1919         document.body[i : i + 1]= ["\\begin_layout Mobile"]
1920       if Arg[0] == "fax":
1921         document.body[i : i + 1]= ["\\begin_layout Fax"]
1922       # delete the Argument inset
1923       del(document.body[endInset - 2 : endInset + 1])
1924       del(document.body[lineArg : beginPlain + 3])
1925     i += 1
1926
1927
1928 def convert_moderncv(document):
1929   " Convert the Fax and Mobile inset of moderncv to the new phone inset "
1930
1931   if document.textclass != "moderncv":
1932     return
1933   i = 0
1934   j = 0
1935   lineArg = 0
1936   while True:
1937     # \mobile
1938     i = find_token(document.body, "\\begin_layout Mobile", i)
1939     if i == -1:
1940       return
1941     j = find_end_of_layout(document.body, i)
1942     if j == -1:
1943       document.warning("Malformed LyX document: Can't find end of Mobile layout")
1944       i += 1
1945       return
1946     document.body[i + 1 : i + 1] = ["\\begin_inset Argument 1", "status open", "",
1947                         "\\begin_layout Plain Layout", "mobile", "\\end_layout", "",
1948                         "\\end_inset", ""]
1949     # \fax
1950     i = find_token(document.body, "\\begin_layout Fax", i)
1951     if i == -1:
1952       return
1953     j = find_end_of_layout(document.body, i)
1954     if j == -1:
1955       document.warning("Malformed LyX document: Can't find end of Fax layout")
1956       i += 1
1957       return
1958     document.body[i + 1 : i + 1] = ["\\begin_inset Argument 1", "status open", "",
1959                         "\\begin_layout Plain Layout", "fax", "\\end_layout", "",
1960                         "\\end_inset", ""]
1961     # \firstname and \familyname
1962     i1 = find_token(document.body, "\\begin_layout FirstName", 0)
1963     if i1 == -1:
1964       return
1965     j1 = find_end_of_layout(document.body, i1)
1966     if j1 == -1:
1967       document.warning("Malformed LyX document: Can't find end of FirstName layout")
1968       i1 += 1
1969       return
1970     FirstName = document.body[i1 + 1 : i1 + 2]
1971     i2 = find_token(document.body, "\\begin_layout FamilyName", 0)
1972     if i2 == -1:
1973       return
1974     j2 = find_end_of_layout(document.body, i2)
1975     if j2 == -1:
1976       document.warning("Malformed LyX document: Can't find end of FamilyName layout")
1977       i2 += 1
1978       return
1979     FamilyName = document.body[i2 + 1 : i2 + 2]
1980     if j1 > j2:
1981       k = j1
1982       l = i2
1983     else:
1984       k = j2
1985       l = i1
1986     document.body[k + 1 : k + 1] = ["\\begin_layout Name", "\\begin_inset Argument 1", "status open", "",
1987                         "\\begin_layout Plain Layout", FirstName[0], "\\end_layout", "",
1988                         "\\end_inset", "", FamilyName[0], "\\end_layout", ""]
1989     #document.body[i2 + 1 : i2 + 1] = ["hellok: ", str(k)]
1990     del(document.body[l : k])
1991     i += 1
1992     i1 += 1
1993     i2 += 1
1994
1995 ##
1996 # Conversion hub
1997 #
1998
1999 supported_versions = ["2.2.0", "2.2"]
2000 convert = [
2001            [475, [convert_separator]],
2002            # nothing to do for 476: We consider it a bug that older versions
2003            # did not load amsmath automatically for these commands, and do not
2004            # want to hardcode amsmath off.
2005            [476, []],
2006            [477, []],
2007            [478, []],
2008            [479, []],
2009            [480, []],
2010            [481, [convert_dashes]],
2011            [482, [convert_phrases]],
2012            [483, [convert_specialchar]],
2013            [484, []],
2014            [485, []],
2015            [486, []],
2016            [487, []],
2017            [488, [convert_newgloss]],
2018            [489, [convert_BoxFeatures]],
2019            [490, [convert_origin]],
2020            [491, []],
2021            [492, [convert_colorbox]],
2022            [493, []],
2023            [494, []],
2024            [495, [convert_subref]],
2025            [496, [convert_nounzip]],
2026            [497, [convert_external_bbox]],
2027            [498, []],
2028            [499, [convert_moderncv]]
2029           ]
2030
2031 revert =  [
2032            [498, [revert_moderncv_1, revert_moderncv_2]],
2033            [497, [revert_tcolorbox_1, revert_tcolorbox_2,
2034                   revert_tcolorbox_3, revert_tcolorbox_4, revert_tcolorbox_5,
2035                   revert_tcolorbox_6, revert_tcolorbox_7, revert_tcolorbox_8]],
2036            [496, [revert_external_bbox]],
2037            [495, []], # nothing to do since the noUnzip parameter was optional
2038            [494, [revert_subref]],
2039            [493, [revert_jss]],
2040            [492, [revert_mathmulticol]],
2041            [491, [revert_colorbox]],
2042            [490, [revert_textcolor]],
2043            [489, [revert_origin]],
2044            [488, [revert_BoxFeatures]],
2045            [487, [revert_newgloss, revert_glossgroup]],
2046            [486, [revert_forest]],
2047            [485, [revert_ex_itemargs]],
2048            [484, [revert_sigplan_doi]],
2049            [483, [revert_georgian]],
2050            [482, [revert_specialchar]],
2051            [481, [revert_phrases]],
2052            [480, [revert_dashes]],
2053            [479, [revert_question_env]],
2054            [478, [revert_beamer_lemma]],
2055            [477, [revert_xarrow]],
2056            [476, [revert_swissgerman]],
2057            [475, [revert_smash]],
2058            [474, [revert_separator]]
2059           ]
2060
2061
2062 if __name__ == "__main__":
2063     pass