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