lib/lyx2lyx/lyx_2_0.py

   1 # -*- coding: utf-8 -*-
   2 # This file is part of lyx2lyx
   3 # -*- coding: utf-8 -*-
   4 # Copyright (C) 2010 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.0"""
  21
  22 import re, string
  23 import unicodedata
  24 import sys, os
  25
  26 from parser_tools import find_token, find_end_of, find_tokens, get_value, get_value_string
  27
  28 ####################################################################
  29 # Private helper functions
  30
  31 def remove_option(document, m, option):
  32     l = document.body[m].find(option)
  33     if l != -1:
  34         val = document.body[m][l:].split('"')[1]
  35         document.body[m] = document.body[m][:l - 1] + document.body[m][l+len(option + '="' + val + '"'):]
  36     return l
  37
  38 def find_end_of_inset(lines, i):
  39     " Find end of inset, where lines[i] is included."
  40     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
  41
  42
  43 # Note that text can be either a list of lines or a single line.
  44 def add_to_preamble(document, text):
  45     """ Add text to the preamble if it is not already there.
  46     Only the first line is checked!"""
  47
  48     if not type(text) is list:
  49       # split on \n just in case
  50       # it'll give us the one element list we want
  51       # if there's no \n, too
  52       text = text.split('\n')
  53
  54     if find_token(document.preamble, text[0], 0) != -1:
  55         return
  56
  57     document.preamble.extend(text)
  58
  59
  60 def insert_to_preamble(index, document, text):
  61     """ Insert text to the preamble at a given line"""
  62
  63     document.preamble.insert(index, text)
  64
  65
  66 def read_unicodesymbols():
  67     " Read the unicodesymbols list of unicode characters and corresponding commands."
  68     pathname = os.path.abspath(os.path.dirname(sys.argv[0]))
  69     fp = open(os.path.join(pathname.strip('lyx2lyx'), 'unicodesymbols'))
  70     spec_chars = []
  71     # Two backslashes, followed by some non-word character, and then a character
  72     # in brackets. The idea is to check for constructs like: \"{u}, which is how
  73     # they are written in the unicodesymbols file; but they can also be written
  74     # as: \"u or even \" u.
  75     r = re.compile(r'\\\\(\W)\{(\w)\}')
  76     for line in fp.readlines():
  77         if line[0] != '#' and line.strip() != "":
  78             line=line.replace(' "',' ') # remove all quotation marks with spaces before
  79             line=line.replace('" ',' ') # remove all quotation marks with spaces after
  80             line=line.replace(r'\"','"') # replace \" by " (for characters with diaeresis)
  81             try:
  82                 [ucs4,command,dead] = line.split(None,2)
  83                 if command[0:1] != "\\":
  84                     continue
  85                 spec_chars.append([command, unichr(eval(ucs4))])
  86             except:
  87                 continue
  88             m = r.match(command)
  89             if m != None:
  90                 command = "\\\\"
  91                 # If the character is a double-quote, then we need to escape it, too,
  92                 # since it is done that way in the LyX file.
  93                 if m.group(1) == "\"":
  94                     command += "\\"
  95                 commandbl = command
  96                 command += m.group(1) + m.group(2)
  97                 commandbl += m.group(1) + ' ' + m.group(2)
  98                 spec_chars.append([command, unichr(eval(ucs4))])
  99                 spec_chars.append([commandbl, unichr(eval(ucs4))])
 100     fp.close()
 101     return spec_chars
 102
 103
 104 unicode_reps = read_unicodesymbols()
 105
 106
 107 # DO NOT USE THIS ROUTINE ANY MORE. Better yet, replace the uses that
 108 # have been made of it with uses of put_cmd_in_ert.
 109 def old_put_cmd_in_ert(string):
 110     for rep in unicode_reps:
 111         string = string.replace(rep[1], rep[0].replace('\\\\', '\\'))
 112     string = string.replace('\\', "\\backslash\n")
 113     string = "\\begin_inset ERT\nstatus collapsed\n\\begin_layout Plain Layout\n" \
 114       + string + "\n\\end_layout\n\\end_inset"
 115     return string
 116
 117
 118 # This routine wraps some content in an ERT inset.
 119 #
 120 # NOTE: The function accepts either a single string or a LIST of strings as
 121 # argument. But it returns a LIST of strings, split on \n, so that it does
 122 # not have embedded newlines.
 123 #
 124 # This is how lyx2lyx represents a LyX document: as a list of strings,
 125 # each representing a line of a LyX file. Embedded newlines confuse
 126 # lyx2lyx very much.
 127 #
 128 # A call to this routine will often go something like this:
 129 #   i = find_token('\\begin_inset FunkyInset', ...)
 130 #   ...
 131 #   j = find_end_of_inset(document.body, i)
 132 #   content = ...extract content from insets
 133 #   # that could be as simple as:
 134 #   # content = lyx2latex(document[i:j + 1])
 135 #   ert = put_cmd_in_ert(content)
 136 #   document.body[i:j] = ert
 137 # Now, before we continue, we need to reset i appropriately. Normally,
 138 # this would be:
 139 #   i += len(ert)
 140 # That puts us right after the ERT we just inserted.
 141 #
 142 def put_cmd_in_ert(arg):
 143     ret = ["\\begin_inset ERT", "status collapsed", "\\begin_layout Plain Layout", ""]
 144     # Despite the warnings just given, it will be faster for us to work
 145     # with a single string internally. That way, we only go through the
 146     # unicode_reps loop once.
 147     if type(arg) is list:
 148       s = "\n".join(arg)
 149     else:
 150       s = arg
 151     for rep in unicode_reps:
 152       s = s.replace(rep[1], rep[0].replace('\\\\', '\\'))
 153     s = s.replace('\\', "\\backslash\n")
 154     ret += s.splitlines()
 155     ret += ["\\end_layout", "\\end_inset"]
 156     return ret
 157
 158
 159 def lyx2latex(document, lines):
 160     'Convert some LyX stuff into corresponding LaTeX stuff, as best we can.'
 161     # clean up multiline stuff
 162     content = ""
 163     ert_end = 0
 164     note_end = 0
 165     hspace = ""
 166
 167     for curline in range(len(lines)):
 168       line = lines[curline]
 169       if line.startswith("\\begin_inset Note Note"):
 170           # We want to skip LyX notes, so remember where the inset ends
 171           note_end = find_end_of_inset(lines, curline + 1)
 172           continue
 173       elif note_end >= curline:
 174           # Skip LyX notes
 175           continue
 176       elif line.startswith("\\begin_inset ERT"):
 177           # We don't want to replace things inside ERT, so figure out
 178           # where the end of the inset is.
 179           ert_end = find_end_of_inset(lines, curline + 1)
 180           continue
 181       elif line.startswith("\\begin_inset Formula"):
 182           line = line[20:]
 183       elif line.startswith("\\begin_inset Quotes"):
 184           # For now, we do a very basic reversion. Someone who understands
 185           # quotes is welcome to fix it up.
 186           qtype = line[20:].strip()
 187           # lang = qtype[0]
 188           side = qtype[1]
 189           dbls = qtype[2]
 190           if side == "l":
 191               if dbls == "d":
 192                   line = "``"
 193               else:
 194                   line = "`"
 195           else:
 196               if dbls == "d":
 197                   line = "''"
 198               else:
 199                   line = "'"
 200       elif line.startswith("\\begin_inset space"):
 201           line = line[18:].strip()
 202           if line.startswith("\\hspace"):
 203               # Account for both \hspace and \hspace*
 204               hspace = line[:-2]
 205               continue
 206           elif line == "\\space{}":
 207               line = "\\ "
 208           elif line == "\\thinspace{}":
 209               line = "\\,"
 210       elif hspace != "":
 211           # The LyX length is in line[8:], after the \length keyword
 212           length = latex_length(line[8:])[1]
 213           line = hspace + "{" + length + "}"
 214           hspace = ""
 215       elif line.isspace() or \
 216             line.startswith("\\begin_layout") or \
 217             line.startswith("\\end_layout") or \
 218             line.startswith("\\begin_inset") or \
 219             line.startswith("\\end_inset") or \
 220             line.startswith("\\lang") or \
 221             line.strip() == "status collapsed" or \
 222             line.strip() == "status open":
 223           #skip all that stuff
 224           continue
 225
 226       # this needs to be added to the preamble because of cases like
 227       # \textmu, \textbackslash, etc.
 228       add_to_preamble(document, ['% added by lyx2lyx for converted index entries',
 229                                  '\\@ifundefined{textmu}',
 230                                  ' {\\usepackage{textcomp}}{}'])
 231       # a lossless reversion is not possible
 232       # try at least to handle some common insets and settings
 233       if ert_end >= curline:
 234           line = line.replace(r'\backslash', '\\')
 235       else:
 236           # No need to add "{}" after single-nonletter macros
 237           line = line.replace('&', '\\&')
 238           line = line.replace('#', '\\#')
 239           line = line.replace('^', '\\textasciicircum{}')
 240           line = line.replace('%', '\\%')
 241           line = line.replace('_', '\\_')
 242           line = line.replace('$', '\\$')
 243
 244           # Do the LyX text --> LaTeX conversion
 245           for rep in unicode_reps:
 246             line = line.replace(rep[1], rep[0] + "{}")
 247           line = line.replace(r'\backslash', r'\textbackslash{}')
 248           line = line.replace(r'\series bold', r'\bfseries{}').replace(r'\series default', r'\mdseries{}')
 249           line = line.replace(r'\shape italic', r'\itshape{}').replace(r'\shape smallcaps', r'\scshape{}')
 250           line = line.replace(r'\shape slanted', r'\slshape{}').replace(r'\shape default', r'\upshape{}')
 251           line = line.replace(r'\emph on', r'\em{}').replace(r'\emph default', r'\em{}')
 252           line = line.replace(r'\noun on', r'\scshape{}').replace(r'\noun default', r'\upshape{}')
 253           line = line.replace(r'\bar under', r'\underbar{').replace(r'\bar default', r'}')
 254           line = line.replace(r'\family sans', r'\sffamily{}').replace(r'\family default', r'\normalfont{}')
 255           line = line.replace(r'\family typewriter', r'\ttfamily{}').replace(r'\family roman', r'\rmfamily{}')
 256           line = line.replace(r'\InsetSpace ', r'').replace(r'\SpecialChar ', r'')
 257       content += line
 258     return content
 259
 260
 261 def latex_length(slen):
 262     '''
 263     Convert lengths to their LaTeX representation. Returns (bool, length),
 264     where the bool tells us if it was a percentage, and the length is the
 265     LaTeX representation.
 266     '''
 267     i = 0
 268     percent = False
 269     # the slen has the form
 270     # ValueUnit+ValueUnit-ValueUnit or
 271     # ValueUnit+-ValueUnit
 272     # the + and - (glue lengths) are optional
 273     # the + always precedes the -
 274
 275     # Convert relative lengths to LaTeX units
 276     units = {"text%":"\\textwidth", "col%":"\\columnwidth",
 277              "page%":"\\paperwidth", "line%":"\\linewidth",
 278              "theight%":"\\textheight", "pheight%":"\\paperheight"}
 279     for unit in units.keys():
 280         i = slen.find(unit)
 281         if i == -1:
 282             continue
 283         percent = True
 284         minus = slen.rfind("-", 1, i)
 285         plus = slen.rfind("+", 0, i)
 286         latex_unit = units[unit]
 287         if plus == -1 and minus == -1:
 288             value = slen[:i]
 289             value = str(float(value)/100)
 290             end = slen[i + len(unit):]
 291             slen = value + latex_unit + end
 292         if plus > minus:
 293             value = slen[plus + 1:i]
 294             value = str(float(value)/100)
 295             begin = slen[:plus + 1]
 296             end = slen[i+len(unit):]
 297             slen = begin + value + latex_unit + end
 298         if plus < minus:
 299             value = slen[minus + 1:i]
 300             value = str(float(value)/100)
 301             begin = slen[:minus + 1]
 302             slen = begin + value + latex_unit
 303
 304     # replace + and -, but only if the - is not the first character
 305     slen = slen[0] + slen[1:].replace("+", " plus ").replace("-", " minus ")
 306     # handle the case where "+-1mm" was used, because LaTeX only understands
 307     # "plus 1mm minus 1mm"
 308     if slen.find("plus  minus"):
 309         lastvaluepos = slen.rfind(" ")
 310         lastvalue = slen[lastvaluepos:]
 311         slen = slen.replace("  ", lastvalue + " ")
 312     return (percent, slen)
 313
 314
 315 def revert_flex_inset(document, name, LaTeXname, position):
 316   " Convert flex insets to TeX code "
 317   i = position
 318   while True:
 319     i = find_token(document.body, '\\begin_inset Flex ' + name, i)
 320     if i == -1:
 321       return
 322     z = find_end_of_inset(document.body, i)
 323     if z == -1:
 324       document.warning("Malformed LyX document: Can't find end of Flex " + name + " inset.")
 325       return
 326     # remove the \end_inset
 327     document.body[z - 2:z + 1] = put_cmd_in_ert("}")
 328     # we need to reset character layouts if necessary
 329     j = find_token(document.body, '\\emph on', i, z)
 330     k = find_token(document.body, '\\noun on', i, z)
 331     l = find_token(document.body, '\\series', i, z)
 332     m = find_token(document.body, '\\family', i, z)
 333     n = find_token(document.body, '\\shape', i, z)
 334     o = find_token(document.body, '\\color', i, z)
 335     p = find_token(document.body, '\\size', i, z)
 336     q = find_token(document.body, '\\bar under', i, z)
 337     r = find_token(document.body, '\\uuline on', i, z)
 338     s = find_token(document.body, '\\uwave on', i, z)
 339     t = find_token(document.body, '\\strikeout on', i, z)
 340     if j != -1:
 341       document.body.insert(z - 2, "\\emph default")
 342     if k != -1:
 343       document.body.insert(z - 2, "\\noun default")
 344     if l != -1:
 345       document.body.insert(z - 2, "\\series default")
 346     if m != -1:
 347       document.body.insert(z - 2, "\\family default")
 348     if n != -1:
 349       document.body.insert(z - 2, "\\shape default")
 350     if o != -1:
 351       document.body.insert(z - 2, "\\color inherit")
 352     if p != -1:
 353       document.body.insert(z - 2, "\\size default")
 354     if q != -1:
 355       document.body.insert(z - 2, "\\bar default")
 356     if r != -1:
 357       document.body.insert(z - 2, "\\uuline default")
 358     if s != -1:
 359       document.body.insert(z - 2, "\\uwave default")
 360     if t != -1:
 361       document.body.insert(z - 2, "\\strikeout default")
 362     document.body[i:i + 4] = put_cmd_in_ert(LaTeXname + "{")
 363     i += 1
 364
 365
 366 def revert_font_attrs(document, name, LaTeXname):
 367   " Reverts font changes to TeX code "
 368   i = 0
 369   changed = False
 370   while True:
 371     i = find_token(document.body, name + ' on', i)
 372     if i == -1:
 373       return changed
 374     j = find_token(document.body, name + ' default', i)
 375     k = find_token(document.body, name + ' on', i + 1)
 376     # if there is no default set, the style ends with the layout
 377     # assure hereby that we found the correct layout end
 378     if j != -1 and (j < k or k == -1):
 379       document.body[j:j + 1] = put_cmd_in_ert("}")
 380     else:
 381       j = find_token(document.body, '\\end_layout', i)
 382       document.body[j:j] = put_cmd_in_ert("}")
 383     document.body[i:i + 1] = put_cmd_in_ert(LaTeXname + "{")
 384     changed = True
 385     i += 1
 386
 387
 388 def revert_layout_command(document, name, LaTeXname, position):
 389   " Reverts a command from a layout to TeX code "
 390   i = position
 391   while True:
 392     i = find_token(document.body, '\\begin_layout ' + name, i)
 393     if i == -1:
 394       return
 395     k = -1
 396     # find the next layout
 397     j = i + 1
 398     while k == -1:
 399       j = find_token(document.body, '\\begin_layout', j)
 400       l = len(document.body)
 401       # if nothing was found it was the last layout of the document
 402       if j == -1:
 403         document.body[l - 4:l - 4] = put_cmd_in_ert("}")
 404         k = 0
 405       # exclude plain layout because this can be TeX code or another inset
 406       elif document.body[j] != '\\begin_layout Plain Layout':
 407         document.body[j - 2:j - 2] = put_cmd_in_ert("}")
 408         k = 0
 409       else:
 410         j += 1
 411     document.body[i] = '\\begin_layout Standard'
 412     document.body[i + 1:i + 1] = put_cmd_in_ert(LaTeXname + "{")
 413     i += 1
 414
 415
 416 ###############################################################################
 417 ###
 418 ### Conversion and reversion routines
 419 ###
 420 ###############################################################################
 421
 422 def revert_swiss(document):
 423     " Set language german-ch to ngerman "
 424     i = 0
 425     if document.language == "german-ch":
 426         document.language = "ngerman"
 427         i = find_token(document.header, "\\language", 0)
 428         if i != -1:
 429             document.header[i] = "\\language ngerman"
 430     j = 0
 431     while True:
 432         j = find_token(document.body, "\\lang german-ch", j)
 433         if j == -1:
 434             return
 435         document.body[j] = document.body[j].replace("\\lang german-ch", "\\lang ngerman")
 436         j = j + 1
 437
 438
 439 def revert_tabularvalign(document):
 440    " Revert the tabular valign option "
 441    i = 0
 442    while True:
 443       i = find_token(document.body, "\\begin_inset Tabular", i)
 444       if i == -1:
 445           return
 446       end = find_end_of_inset(document.body, i)
 447       if end == -1:
 448           document.warning("Can't find end of inset at line " + str(i))
 449           i += 1
 450           continue
 451       fline = find_token(document.body, "<features", i, end)
 452       if fline == -1:
 453           document.warning("Can't find features for inset at line " + str(i))
 454           i += 1
 455           continue
 456       p = document.body[fline].find("islongtable")
 457       if p != -1:
 458           q = document.body[fline].find("tabularvalignment")
 459           if q != -1:
 460               # FIXME
 461               # This seems wrong: It removes everything after
 462               # tabularvalignment, too.
 463               document.body[fline] = document.body[fline][:q - 1] + '>'
 464           i += 1
 465           continue
 466
 467        # no longtable
 468       tabularvalignment = 'c'
 469       # which valignment is specified?
 470       m = document.body[fline].find('tabularvalignment="top"')
 471       if m != -1:
 472           tabularvalignment = 't'
 473       m = document.body[fline].find('tabularvalignment="bottom"')
 474       if m != -1:
 475           tabularvalignment = 'b'
 476       # delete tabularvalignment
 477       q = document.body[fline].find("tabularvalignment")
 478       if q != -1:
 479           # FIXME
 480           # This seems wrong: It removes everything after
 481           # tabularvalignment, too.
 482           document.body[fline] = document.body[fline][:q - 1] + '>'
 483
 484       # don't add a box when centered
 485       if tabularvalignment == 'c':
 486           i = end
 487           continue
 488       subst = ['\\end_layout', '\\end_inset']
 489       document.body[end:end] = subst # just inserts those lines
 490       subst = ['\\begin_inset Box Frameless',
 491           'position "' + tabularvalignment +'"',
 492           'hor_pos "c"',
 493           'has_inner_box 1',
 494           'inner_pos "c"',
 495           'use_parbox 0',
 496           # we don't know the width, assume 50%
 497           'width "50col%"',
 498           'special "none"',
 499           'height "1in"',
 500           'height_special "totalheight"',
 501           'status open',
 502           '',
 503           '\\begin_layout Plain Layout']
 504       document.body[i:i] = subst # this just inserts the array at i
 505       # since there could be a tabular inside a tabular, we cannot
 506       # jump to end
 507       i += len(subst)
 508
 509
 510 def revert_phantom_types(document, ptype, cmd):
 511     " Reverts phantom to ERT "
 512     i = 0
 513     while True:
 514       i = find_token(document.body, "\\begin_inset Phantom " + ptype, i)
 515       if i == -1:
 516           return
 517       end = find_end_of_inset(document.body, i)
 518       if end == -1:
 519           document.warning("Can't find end of inset at line " + str(i))
 520           i += 1
 521           continue
 522       blay = find_token(document.body, "\\begin_layout Plain Layout", i, end)
 523       if blay == -1:
 524           document.warning("Can't find layout for inset at line " + str(i))
 525           i = end
 526           continue
 527       bend = find_token(document.body, "\\end_layout", blay, end)
 528       if bend == -1:
 529           document.warning("Malformed LyX document: Could not find end of Phantom inset's layout.")
 530           i = end
 531           continue
 532       substi = ["\\begin_inset ERT", "status collapsed", "",
 533                 "\\begin_layout Plain Layout", "", "", "\\backslash",
 534                 cmd + "{", "\\end_layout", "", "\\end_inset"]
 535       substj = ["\\size default", "", "\\begin_inset ERT", "status collapsed", "",
 536                 "\\begin_layout Plain Layout", "", "}", "\\end_layout", "", "\\end_inset"]
 537       # do the later one first so as not to mess up the numbering
 538       document.body[bend:end + 1] = substj
 539       document.body[i:blay + 1] = substi
 540       i = end + len(substi) + len(substj) - (end - bend) - (blay - i) - 2
 541
 542
 543 def revert_phantom(document):
 544     revert_phantom_types(document, "Phantom", "phantom")
 545
 546 def revert_hphantom(document):
 547     revert_phantom_types(document, "HPhantom", "hphantom")
 548
 549 def revert_vphantom(document):
 550     revert_phantom_types(document, "VPhantom", "vphantom")
 551
 552
 553 def revert_xetex(document):
 554     " Reverts documents that use XeTeX "
 555     i = find_token(document.header, '\\use_xetex', 0)
 556     if i == -1:
 557         document.warning("Malformed LyX document: Missing \\use_xetex.")
 558         return
 559     if get_value(document.header, "\\use_xetex", i) == 'false':
 560         del document.header[i]
 561         return
 562     del document.header[i]
 563     # 1.) set doc encoding to utf8-plain
 564     i = find_token(document.header, "\\inputencoding", 0)
 565     if i == -1:
 566         document.warning("Malformed LyX document: Missing \\inputencoding.")
 567     document.header[i] = "\\inputencoding utf8-plain"
 568     # 2.) check font settings
 569     l = find_token(document.header, "\\font_roman", 0)
 570     if l == -1:
 571         document.warning("Malformed LyX document: Missing \\font_roman.")
 572     line = document.header[l]
 573     l = re.compile(r'\\font_roman (.*)$')
 574     m = l.match(line)
 575     roman = m.group(1)
 576     l = find_token(document.header, "\\font_sans", 0)
 577     if l == -1:
 578         document.warning("Malformed LyX document: Missing \\font_sans.")
 579     line = document.header[l]
 580     l = re.compile(r'\\font_sans (.*)$')
 581     m = l.match(line)
 582     sans = m.group(1)
 583     l = find_token(document.header, "\\font_typewriter", 0)
 584     if l == -1:
 585         document.warning("Malformed LyX document: Missing \\font_typewriter.")
 586     line = document.header[l]
 587     l = re.compile(r'\\font_typewriter (.*)$')
 588     m = l.match(line)
 589     typewriter = m.group(1)
 590     osf = get_value(document.header, '\\font_osf', 0) == "true"
 591     sf_scale = float(get_value(document.header, '\\font_sf_scale', 0))
 592     tt_scale = float(get_value(document.header, '\\font_tt_scale', 0))
 593     # 3.) set preamble stuff
 594     pretext = '%% This document must be processed with xelatex!\n'
 595     pretext += '\\usepackage{fontspec}\n'
 596     if roman != "default":
 597         pretext += '\\setmainfont[Mapping=tex-text]{' + roman + '}\n'
 598     if sans != "default":
 599         pretext += '\\setsansfont['
 600         if sf_scale != 100:
 601             pretext += 'Scale=' + str(sf_scale / 100) + ','
 602         pretext += 'Mapping=tex-text]{' + sans + '}\n'
 603     if typewriter != "default":
 604         pretext += '\\setmonofont'
 605         if tt_scale != 100:
 606             pretext += '[Scale=' + str(tt_scale / 100) + ']'
 607         pretext += '{' + typewriter + '}\n'
 608     if osf:
 609         pretext += '\\defaultfontfeatures{Numbers=OldStyle}\n'
 610     pretext += '\usepackage{xunicode}\n'
 611     pretext += '\usepackage{xltxtra}\n'
 612     insert_to_preamble(0, document, pretext)
 613     # 4.) reset font settings
 614     i = find_token(document.header, "\\font_roman", 0)
 615     if i == -1:
 616         document.warning("Malformed LyX document: Missing \\font_roman.")
 617     document.header[i] = "\\font_roman default"
 618     i = find_token(document.header, "\\font_sans", 0)
 619     if i == -1:
 620         document.warning("Malformed LyX document: Missing \\font_sans.")
 621     document.header[i] = "\\font_sans default"
 622     i = find_token(document.header, "\\font_typewriter", 0)
 623     if i == -1:
 624         document.warning("Malformed LyX document: Missing \\font_typewriter.")
 625     document.header[i] = "\\font_typewriter default"
 626     i = find_token(document.header, "\\font_osf", 0)
 627     if i == -1:
 628         document.warning("Malformed LyX document: Missing \\font_osf.")
 629     document.header[i] = "\\font_osf false"
 630     i = find_token(document.header, "\\font_sc", 0)
 631     if i == -1:
 632         document.warning("Malformed LyX document: Missing \\font_sc.")
 633     document.header[i] = "\\font_sc false"
 634     i = find_token(document.header, "\\font_sf_scale", 0)
 635     if i == -1:
 636         document.warning("Malformed LyX document: Missing \\font_sf_scale.")
 637     document.header[i] = "\\font_sf_scale 100"
 638     i = find_token(document.header, "\\font_tt_scale", 0)
 639     if i == -1:
 640         document.warning("Malformed LyX document: Missing \\font_tt_scale.")
 641     document.header[i] = "\\font_tt_scale 100"
 642
 643
 644 def revert_outputformat(document):
 645     " Remove default output format param "
 646     i = find_token(document.header, '\\default_output_format', 0)
 647     if i == -1:
 648         document.warning("Malformed LyX document: Missing \\default_output_format.")
 649         return
 650     del document.header[i]
 651
 652
 653 def hex2ratio(s):
 654     val = string.atoi(s, 16)
 655     if val != 0:
 656       val += 1
 657     return str(val / 256.0)
 658
 659
 660 def revert_backgroundcolor(document):
 661     " Reverts background color to preamble code "
 662     i = find_token(document.header, "\\backgroundcolor", 0)
 663     if i == -1:
 664         return
 665     colorcode = get_value(document.header, '\\backgroundcolor', i)
 666     del document.header[i]
 667     # don't clutter the preamble if backgroundcolor is not set
 668     if colorcode == "#ffffff":
 669         return
 670     red   = hex2ratio(colorcode[1:3])
 671     green = hex2ratio(colorcode[3:5])
 672     blue  = hex2ratio(colorcode[5:7])
 673     insert_to_preamble(0, document,
 674                           '% Commands inserted by lyx2lyx to set the background color\n'
 675                           + '\\@ifundefined{definecolor}{\\usepackage{color}}{}\n'
 676                           + '\\definecolor{page_backgroundcolor}{rgb}{'
 677                           + red + ',' + green + ',' + blue + '}\n'
 678                           + '\\pagecolor{page_backgroundcolor}\n')
 679
 680
 681 def revert_splitindex(document):
 682     " Reverts splitindex-aware documents "
 683     i = find_token(document.header, '\\use_indices', 0)
 684     if i == -1:
 685         document.warning("Malformed LyX document: Missing \\use_indices.")
 686         return
 687     indices = get_value(document.header, "\\use_indices", i)
 688     preamble = ""
 689     useindices = (indices == "true")
 690     if useindices:
 691          preamble += "\\usepackage{splitidx}\n"
 692     del document.header[i]
 693
 694     # deal with index declarations in the preamble
 695     i = 0
 696     while True:
 697         i = find_token(document.header, "\\index", i)
 698         if i == -1:
 699             break
 700         k = find_token(document.header, "\\end_index", i)
 701         if k == -1:
 702             document.warning("Malformed LyX document: Missing \\end_index.")
 703             return
 704         if useindices:
 705           line = document.header[i]
 706           l = re.compile(r'\\index (.*)$')
 707           m = l.match(line)
 708           iname = m.group(1)
 709           ishortcut = get_value(document.header, '\\shortcut', i, k)
 710           if ishortcut != "":
 711               preamble += "\\newindex[" + iname + "]{" + ishortcut + "}\n"
 712         del document.header[i:k + 1]
 713     if preamble != "":
 714         insert_to_preamble(0, document, preamble)
 715
 716     # deal with index insets
 717     # these need to have the argument removed
 718     i = 0
 719     while True:
 720         i = find_token(document.body, "\\begin_inset Index", i)
 721         if i == -1:
 722             break
 723         line = document.body[i]
 724         l = re.compile(r'\\begin_inset Index (.*)$')
 725         m = l.match(line)
 726         itype = m.group(1)
 727         if itype == "idx" or indices == "false":
 728             document.body[i] = "\\begin_inset Index"
 729         else:
 730             k = find_end_of_inset(document.body, i)
 731             if k == -1:
 732                 document.warning("Can't find end of index inset!")
 733                 i += 1
 734                 continue
 735             content = lyx2latex(document, document.body[i:k])
 736             # escape quotes
 737             content = content.replace('"', r'\"')
 738             subst = put_cmd_in_ert("\\sindex[" + itype + "]{" + content + "}")
 739             document.body[i:k + 1] = subst
 740         i = i + 1
 741
 742     # deal with index_print insets
 743     i = 0
 744     while True:
 745         i = find_token(document.body, "\\begin_inset CommandInset index_print", i)
 746         if i == -1:
 747             return
 748         k = find_end_of_inset(document.body, i)
 749         ptype = get_value(document.body, 'type', i, k).strip('"')
 750         if ptype == "idx":
 751             j = find_token(document.body, "type", i, k)
 752             del document.body[j]
 753         elif not useindices:
 754             del document.body[i:k + 1]
 755         else:
 756             subst = put_cmd_in_ert("\\printindex[" + ptype + "]{}")
 757             document.body[i:k + 1] = subst
 758         i = i + 1
 759
 760
 761 def convert_splitindex(document):
 762     " Converts index and printindex insets to splitindex-aware format "
 763     i = 0
 764     while True:
 765         i = find_token(document.body, "\\begin_inset Index", i)
 766         if i == -1:
 767             break
 768         document.body[i] = document.body[i].replace("\\begin_inset Index",
 769             "\\begin_inset Index idx")
 770         i = i + 1
 771     i = 0
 772     while True:
 773         i = find_token(document.body, "\\begin_inset CommandInset index_print", i)
 774         if i == -1:
 775             return
 776         if document.body[i + 1].find('LatexCommand printindex') == -1:
 777             document.warning("Malformed LyX document: Incomplete printindex inset.")
 778             return
 779         subst = ["LatexCommand printindex",
 780             "type \"idx\""]
 781         document.body[i + 1:i + 2] = subst
 782         i = i + 1
 783
 784
 785 def revert_subindex(document):
 786     " Reverts \\printsubindex CommandInset types "
 787     i = find_token(document.header, '\\use_indices', 0)
 788     if i == -1:
 789         document.warning("Malformed LyX document: Missing \\use_indices.")
 790         return
 791     indices = get_value(document.header, "\\use_indices", i)
 792     useindices = (indices == "true")
 793     i = 0
 794     while True:
 795         i = find_token(document.body, "\\begin_inset CommandInset index_print", i)
 796         if i == -1:
 797             return
 798         k = find_end_of_inset(document.body, i)
 799         ctype = get_value(document.body, 'LatexCommand', i, k)
 800         if ctype != "printsubindex":
 801             i = k + 1
 802             continue
 803         ptype = get_value(document.body, 'type', i, k).strip('"')
 804         if not useindices:
 805             del document.body[i:k + 1]
 806         else:
 807             subst = put_cmd_in_ert("\\printsubindex[" + ptype + "]{}")
 808             document.body[i:k + 1] = subst
 809         i = i + 1
 810
 811
 812 def revert_printindexall(document):
 813     " Reverts \\print[sub]index* CommandInset types "
 814     i = find_token(document.header, '\\use_indices', 0)
 815     if i == -1:
 816         document.warning("Malformed LyX document: Missing \\use_indices.")
 817         return
 818     indices = get_value(document.header, "\\use_indices", i)
 819     useindices = (indices == "true")
 820     i = 0
 821     while True:
 822         i = find_token(document.body, "\\begin_inset CommandInset index_print", i)
 823         if i == -1:
 824             return
 825         k = find_end_of_inset(document.body, i)
 826         ctype = get_value(document.body, 'LatexCommand', i, k)
 827         if ctype != "printindex*" and ctype != "printsubindex*":
 828             i = k
 829             continue
 830         if not useindices:
 831             del document.body[i:k + 1]
 832         else:
 833             subst = put_cmd_in_ert("\\" + ctype + "{}")
 834             document.body[i:k + 1] = subst
 835         i = i + 1
 836
 837
 838 def revert_strikeout(document):
 839   " Reverts \\strikeout font attribute "
 840   changed = revert_font_attrs(document, "\\uuline", "\\uuline")
 841   changed = revert_font_attrs(document, "\\uwave", "\\uwave") or changed
 842   changed = revert_font_attrs(document, "\\strikeout", "\\sout")  or changed
 843   if changed == True:
 844     insert_to_preamble(0, document,
 845         '% Commands inserted by lyx2lyx for proper underlining\n'
 846         + '\\PassOptionsToPackage{normalem}{ulem}\n'
 847         + '\\usepackage{ulem}\n')
 848
 849
 850 def revert_ulinelatex(document):
 851     " Reverts \\uline font attribute "
 852     i = find_token(document.body, '\\bar under', 0)
 853     if i == -1:
 854         return
 855     insert_to_preamble(0, document,
 856             '% Commands inserted by lyx2lyx for proper underlining\n'
 857             + '\\PassOptionsToPackage{normalem}{ulem}\n'
 858             + '\\usepackage{ulem}\n'
 859             + '\\let\\cite@rig\\cite\n'
 860             + '\\newcommand{\\b@xcite}[2][\\%]{\\def\\def@pt{\\%}\\def\\pas@pt{#1}\n'
 861             + '  \\mbox{\\ifx\\def@pt\\pas@pt\\cite@rig{#2}\\else\\cite@rig[#1]{#2}\\fi}}\n'
 862             + '\\renewcommand{\\underbar}[1]{{\\let\\cite\\b@xcite\\uline{#1}}}\n')
 863
 864
 865 def revert_custom_processors(document):
 866     " Remove bibtex_command and index_command params "
 867     i = find_token(document.header, '\\bibtex_command', 0)
 868     if i == -1:
 869         document.warning("Malformed LyX document: Missing \\bibtex_command.")
 870     else:
 871         del document.header[i]
 872     i = find_token(document.header, '\\index_command', 0)
 873     if i == -1:
 874         document.warning("Malformed LyX document: Missing \\index_command.")
 875     else:
 876         del document.header[i]
 877
 878
 879 def convert_nomencl_width(document):
 880     " Add set_width param to nomencl_print "
 881     i = 0
 882     while True:
 883       i = find_token(document.body, "\\begin_inset CommandInset nomencl_print", i)
 884       if i == -1:
 885         break
 886       document.body.insert(i + 2, "set_width \"none\"")
 887       i = i + 1
 888
 889
 890 def revert_nomencl_width(document):
 891     " Remove set_width param from nomencl_print "
 892     i = 0
 893     while True:
 894       i = find_token(document.body, "\\begin_inset CommandInset nomencl_print", i)
 895       if i == -1:
 896         break
 897       j = find_end_of_inset(document.body, i)
 898       l = find_token(document.body, "set_width", i, j)
 899       if l == -1:
 900             document.warning("Can't find set_width option for nomencl_print!")
 901             i = j
 902             continue
 903       del document.body[l]
 904       i = j - 1
 905
 906
 907 def revert_nomencl_cwidth(document):
 908     " Remove width param from nomencl_print "
 909     i = 0
 910     while True:
 911       i = find_token(document.body, "\\begin_inset CommandInset nomencl_print", i)
 912       if i == -1:
 913         break
 914       j = find_end_of_inset(document.body, i)
 915       l = find_token(document.body, "width", i, j)
 916       if l == -1:
 917         document.warning("Can't find width option for nomencl_print!")
 918         i = j
 919         continue
 920       width = get_value(document.body, "width", i, j).strip('"')
 921       del document.body[l]
 922       add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
 923       add_to_preamble(document, ["\\setlength{\\nomlabelwidth}{" + width + "}"])
 924       i = j - 1
 925
 926
 927 def revert_applemac(document):
 928     " Revert applemac encoding to auto "
 929     if document.encoding != "applemac":
 930       return
 931     document.encoding = "auto"
 932     i = find_token(document.header, "\\encoding", 0)
 933     if i != -1:
 934         document.header[i] = "\\encoding auto"
 935
 936
 937 def revert_longtable_align(document):
 938     " Remove longtable alignment setting "
 939     i = 0
 940     while True:
 941       i = find_token(document.body, "\\begin_inset Tabular", i)
 942       if i == -1:
 943           break
 944       end = find_end_of_inset(document.body, i)
 945       if end == -1:
 946           document.warning("Can't find end of inset at line " + str(i))
 947           i += 1
 948           continue
 949       fline = find_token(document.body, "<features", i, end)
 950       if fline == -1:
 951           document.warning("Can't find features for inset at line " + str(i))
 952           i += 1
 953           continue
 954       j = document.body[fline].find("longtabularalignment")
 955       if j == -1:
 956           i += 1
 957           continue
 958       # FIXME Is this correct? It wipes out everything after the
 959       # one we found.
 960       document.body[fline] = document.body[fline][:j - 1] + '>'
 961       # since there could be a tabular inside this one, we
 962       # cannot jump to end.
 963       i += 1
 964
 965
 966 def revert_branch_filename(document):
 967     " Remove \\filename_suffix parameter from branches "
 968     i = 0
 969     while True:
 970         i = find_token(document.header, "\\filename_suffix", i)
 971         if i == -1:
 972             return
 973         del document.header[i]
 974
 975
 976 def revert_paragraph_indentation(document):
 977     " Revert custom paragraph indentation to preamble code "
 978     i = find_token(document.header, "\\paragraph_indentation", 0)
 979     if i == -1:
 980       return
 981     length = get_value(document.header, "\\paragraph_indentation", i)
 982     # we need only remove the line if indentation is default
 983     if length != "default":
 984       # handle percent lengths
 985       length = latex_length(length)[1]
 986       add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
 987       add_to_preamble(document, ["\\setlength{\\parindent}{" + length + "}"])
 988     del document.header[i]
 989
 990
 991 def revert_percent_skip_lengths(document):
 992     " Revert relative lengths for paragraph skip separation to preamble code "
 993     i = find_token(document.header, "\\defskip", 0)
 994     if i == -1:
 995         return
 996     length = get_value(document.header, "\\defskip", i)
 997     # only revert when a custom length was set and when
 998     # it used a percent length
 999     if length in ('smallskip', 'medskip', 'bigskip'):
1000         return
1001     # handle percent lengths
1002     percent, length = latex_length(length)
1003     if percent == "True":
1004         add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
1005         add_to_preamble(document, ["\\setlength{\\parskip}{" + length + "}"])
1006         # set defskip to medskip as default
1007         document.header[i] = "\\defskip medskip"
1008
1009
1010 def revert_percent_vspace_lengths(document):
1011     " Revert relative VSpace lengths to ERT "
1012     i = 0
1013     while True:
1014       i = find_token(document.body, "\\begin_inset VSpace", i)
1015       if i == -1:
1016           break
1017       # only revert if a custom length was set and if
1018       # it used a percent length
1019       r = re.compile(r'\\begin_inset VSpace (.*)$')
1020       m = r.match(document.body[i])
1021       length = m.group(1)
1022       if length in ('defskip', 'smallskip', 'medskip', 'bigskip', 'vfill'):
1023          i += 1
1024          continue
1025       # check if the space has a star (protected space)
1026       protected = (document.body[i].rfind("*") != -1)
1027       if protected:
1028           length = length.rstrip('*')
1029       # handle percent lengths
1030       percent, length = latex_length(length)
1031       # revert the VSpace inset to ERT
1032       if percent == "True":
1033           if protected:
1034               subst = put_cmd_in_ert("\\vspace*{" + length + "}")
1035           else:
1036               subst = put_cmd_in_ert("\\vspace{" + length + "}")
1037           document.body[i:i + 2] = subst
1038       i += 1
1039
1040
1041 def revert_percent_hspace_lengths(document):
1042     " Revert relative HSpace lengths to ERT "
1043     i = 0
1044     while True:
1045       i = find_token(document.body, "\\begin_inset space \\hspace", i)
1046       if i == -1:
1047           break
1048       j = find_end_of_inset(document.body, i)
1049       if j == -1:
1050           document.warning("Can't find end of inset at line " + str(i))
1051           i += 1
1052           continue
1053       # only revert if a custom length was set...
1054       length = get_value(document.body, '\\length', i + 1, j)
1055       if length == '':
1056           document.warning("Malformed lyx document: Missing '\\length' in Space inset.")
1057           i = j
1058           continue
1059       protected = (document.body[i].find("\\hspace*{}") != -1)
1060       # ...and if it used a percent length
1061       percent, length = latex_length(length)
1062       # revert the HSpace inset to ERT
1063       if percent == "True":
1064           if protected:
1065               subst = put_cmd_in_ert("\\hspace*{" + length + "}")
1066           else:
1067               subst = put_cmd_in_ert("\\hspace{" + length + "}")
1068           document.body[i:j + 1] = subst
1069       # if we did a substitution, this will still be ok
1070       i = j
1071
1072
1073 def revert_hspace_glue_lengths(document):
1074     " Revert HSpace glue lengths to ERT "
1075     i = 0
1076     while True:
1077       i = find_token(document.body, "\\begin_inset space \\hspace", i)
1078       if i == -1:
1079           break
1080       protected = (document.body[i].find("\\hspace*{}") != -1)
1081       length = get_value(document.body, '\\length', i + 1)
1082       if length == '':
1083           document.warning("Malformed lyx document: Missing '\\length' in Space inset.")
1084           return
1085       # only revert if the length contains a plus or minus at pos != 0
1086       glue  = re.compile(r'.+[\+-]')
1087       if glue.search(length):
1088           # handle percent lengths
1089           length = latex_length(length)[1]
1090           # revert the HSpace inset to ERT
1091           if protected:
1092               subst = [old_put_cmd_in_ert("\\hspace*{" + length + "}")]
1093           else:
1094               subst = [old_put_cmd_in_ert("\\hspace{" + length + "}")]
1095           document.body[i:i + 3] = subst
1096       i = i + 2
1097
1098 def convert_author_id(document):
1099     " Add the author_id to the \\author definition and make sure 0 is not used"
1100     i = 0
1101     j = 1
1102     while True:
1103         i = find_token(document.header, "\\author", i)
1104         if i == -1:
1105             break
1106
1107         r = re.compile(r'(\\author) (\".*\")\s?(.*)$')
1108         m = r.match(document.header[i])
1109         if m != None:
1110             name = m.group(2)
1111
1112             email = ''
1113             if m.lastindex == 3:
1114                 email = m.group(3)
1115             document.header[i] = "\\author %i %s %s" % (j, name, email)
1116         j = j + 1
1117         i = i + 1
1118
1119     k = 0
1120     while True:
1121         k = find_token(document.body, "\\change_", k)
1122         if k == -1:
1123             break
1124
1125         change = document.body[k].split(' ');
1126         if len(change) == 3:
1127             type = change[0]
1128             author_id = int(change[1])
1129             time = change[2]
1130             document.body[k] = "%s %i %s" % (type, author_id + 1, time)
1131         k = k + 1
1132
1133 def revert_author_id(document):
1134     " Remove the author_id from the \\author definition "
1135     i = 0
1136     j = 0
1137     idmap = dict()
1138     while True:
1139         i = find_token(document.header, "\\author", i)
1140         if i == -1:
1141             break
1142
1143         r = re.compile(r'(\\author) (\d+) (\".*\")\s?(.*)$')
1144         m = r.match(document.header[i])
1145         if m != None:
1146             author_id = int(m.group(2))
1147             idmap[author_id] = j
1148             name = m.group(3)
1149
1150             email = ''
1151             if m.lastindex == 4:
1152                 email = m.group(4)
1153             document.header[i] = "\\author %s %s" % (name, email)
1154         i = i + 1
1155         j = j + 1
1156
1157     k = 0
1158     while True:
1159         k = find_token(document.body, "\\change_", k)
1160         if k == -1:
1161             break
1162
1163         change = document.body[k].split(' ');
1164         if len(change) == 3:
1165             type = change[0]
1166             author_id = int(change[1])
1167             time = change[2]
1168             document.body[k] = "%s %i %s" % (type, idmap[author_id], time)
1169         k = k + 1
1170
1171
1172 def revert_suppress_date(document):
1173     " Revert suppressing of default document date to preamble code "
1174     i = 0
1175     while True:
1176       i = find_token(document.header, "\\suppress_date", i)
1177       if i == -1:
1178           break
1179       # remove the preamble line and write to the preamble
1180       # when suppress_date was true
1181       date = get_value(document.header, "\\suppress_date", i)
1182       if date == "true":
1183           add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
1184           add_to_preamble(document, ["\\date{}"])
1185       del document.header[i]
1186       i = i + 1
1187
1188
1189 def revert_mhchem(document):
1190     "Revert mhchem loading to preamble code"
1191     i = 0
1192     j = 0
1193     k = 0
1194     mhchem = "off"
1195     i = find_token(document.header, "\\use_mhchem 1", 0)
1196     if i != -1:
1197         mhchem = "auto"
1198     else:
1199         i = find_token(document.header, "\\use_mhchem 2", 0)
1200         if i != -1:
1201             mhchem = "on"
1202     if mhchem == "auto":
1203         j = find_token(document.body, "\\cf{", 0)
1204         if j != -1:
1205             mhchem = "on"
1206         else:
1207             j = find_token(document.body, "\\ce{", 0)
1208             if j != -1:
1209                 mhchem = "on"
1210     if mhchem == "on":
1211         add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
1212         add_to_preamble(document, ["\\PassOptionsToPackage{version=3}{mhchem}"])
1213         add_to_preamble(document, ["\\usepackage{mhchem}"])
1214     k = find_token(document.header, "\\use_mhchem", 0)
1215     if k == -1:
1216         document.warning("Malformed LyX document: Could not find mhchem setting.")
1217         return
1218     del document.header[k]
1219
1220
1221 def revert_fontenc(document):
1222     " Remove fontencoding param "
1223     i = find_token(document.header, '\\fontencoding', 0)
1224     if i == -1:
1225         document.warning("Malformed LyX document: Missing \\fontencoding.")
1226         return
1227     del document.header[i]
1228
1229
1230 def merge_gbrief(document):
1231     " Merge g-brief-en and g-brief-de to one class "
1232
1233     if document.textclass != "g-brief-de":
1234         if document.textclass == "g-brief-en":
1235             document.textclass = "g-brief"
1236             document.set_textclass()
1237         return
1238
1239     obsoletedby = { "Brieftext":       "Letter",
1240                     "Unterschrift":    "Signature",
1241                     "Strasse":         "Street",
1242                     "Zusatz":          "Addition",
1243                     "Ort":             "Town",
1244                     "Land":            "State",
1245                     "RetourAdresse":   "ReturnAddress",
1246                     "MeinZeichen":     "MyRef",
1247                     "IhrZeichen":      "YourRef",
1248                     "IhrSchreiben":    "YourMail",
1249                     "Telefon":         "Phone",
1250                     "BLZ":             "BankCode",
1251                     "Konto":           "BankAccount",
1252                     "Postvermerk":     "PostalComment",
1253                     "Adresse":         "Address",
1254                     "Datum":           "Date",
1255                     "Betreff":         "Reference",
1256                     "Anrede":          "Opening",
1257                     "Anlagen":         "Encl.",
1258                     "Verteiler":       "cc",
1259                     "Gruss":           "Closing"}
1260     i = 0
1261     while 1:
1262         i = find_token(document.body, "\\begin_layout", i)
1263         if i == -1:
1264             break
1265
1266         layout = document.body[i][14:]
1267         if layout in obsoletedby:
1268             document.body[i] = "\\begin_layout " + obsoletedby[layout]
1269
1270         i += 1
1271
1272     document.textclass = "g-brief"
1273     document.set_textclass()
1274
1275
1276 def revert_gbrief(document):
1277     " Revert g-brief to g-brief-en "
1278     if document.textclass == "g-brief":
1279         document.textclass = "g-brief-en"
1280         document.set_textclass()
1281
1282
1283 def revert_html_options(document):
1284     " Remove html options "
1285     i = find_token(document.header, '\\html_use_mathml', 0)
1286     if i != -1:
1287         del document.header[i]
1288     i = find_token(document.header, '\\html_be_strict', 0)
1289     if i != -1:
1290         del document.header[i]
1291
1292
1293 def revert_includeonly(document):
1294     i = 0
1295     while True:
1296         i = find_token(document.header, "\\begin_includeonly", i)
1297         if i == -1:
1298             return
1299         j = find_end_of(document.header, i, "\\begin_includeonly", "\\end_includeonly")
1300         if j == -1:
1301             # this should not happen
1302             break
1303         document.header[i : j + 1] = []
1304
1305
1306 def revert_includeall(document):
1307     " Remove maintain_unincluded_children param "
1308     i = find_token(document.header, '\\maintain_unincluded_children', 0)
1309     if i != -1:
1310         del document.header[i]
1311
1312
1313 def revert_multirow(document):
1314     " Revert multirow cells in tables to TeX-code"
1315     i = 0
1316     multirow = False
1317     while True:
1318       # cell type 3 is multirow begin cell
1319       i = find_token(document.body, '<cell multirow="3"', i)
1320       if i == -1:
1321           break
1322       # a multirow cell was found
1323       multirow = True
1324       # remove the multirow tag, set the valignment to top
1325       # and remove the bottom line
1326       document.body[i] = document.body[i].replace(' multirow="3" ', ' ')
1327       document.body[i] = document.body[i].replace('valignment="middle"', 'valignment="top"')
1328       document.body[i] = document.body[i].replace(' bottomline="true" ', ' ')
1329       # write ERT to create the multirow cell
1330       # use 2 rows and 2cm as default with because the multirow span
1331       # and the column width is only hardly accessible
1332       subst = [old_put_cmd_in_ert("\\multirow{2}{2cm}{")]
1333       document.body[i + 4:i + 4] = subst
1334       i = find_token(document.body, "</cell>", i)
1335       if i == -1:
1336            document.warning("Malformed LyX document: Could not find end of tabular cell.")
1337            break
1338       subst = [old_put_cmd_in_ert("}")]
1339       document.body[i - 3:i - 3] = subst
1340       # cell type 4 is multirow part cell
1341       i = find_token(document.body, '<cell multirow="4"', i)
1342       if i == -1:
1343           break
1344       # remove the multirow tag, set the valignment to top
1345       # and remove the top line
1346       document.body[i] = document.body[i].replace(' multirow="4" ', ' ')
1347       document.body[i] = document.body[i].replace('valignment="middle"', 'valignment="top"')
1348       document.body[i] = document.body[i].replace(' topline="true" ', ' ')
1349       i = i + 1
1350     if multirow == True:
1351         add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
1352         add_to_preamble(document, ["\\usepackage{multirow}"])
1353
1354
1355 def convert_math_output(document):
1356     " Convert \html_use_mathml to \html_math_output "
1357     i = find_token(document.header, "\\html_use_mathml", 0)
1358     if i == -1:
1359         return
1360     rgx = re.compile(r'\\html_use_mathml\s+(\w+)')
1361     m = rgx.match(document.header[i])
1362     newval = "0" # MathML
1363     if m:
1364       val = m.group(1)
1365       if val != "true":
1366         newval = "2" # Images
1367     else:
1368       document.warning("Can't match " + document.header[i])
1369     document.header[i] = "\\html_math_output " + newval
1370
1371
1372 def revert_math_output(document):
1373     " Revert \html_math_output to \html_use_mathml "
1374     i = find_token(document.header, "\\html_math_output", 0)
1375     if i == -1:
1376         return
1377     rgx = re.compile(r'\\html_math_output\s+(\d)')
1378     m = rgx.match(document.header[i])
1379     newval = "true"
1380     if m:
1381         val = m.group(1)
1382         if val == "1" or val == "2":
1383             newval = "false"
1384     else:
1385         document.warning("Unable to match " + document.header[i])
1386     document.header[i] = "\\html_use_mathml " + newval
1387
1388
1389
1390 def revert_inset_preview(document):
1391     " Dissolves the preview inset "
1392     i = 0
1393     j = 0
1394     k = 0
1395     while True:
1396       i = find_token(document.body, "\\begin_inset Preview", i)
1397       if i == -1:
1398           return
1399       j = find_end_of_inset(document.body, i)
1400       if j == -1:
1401           document.warning("Malformed LyX document: Could not find end of Preview inset.")
1402           return
1403       #If the layout is Standard we need to remove it, otherwise there
1404       #will be paragraph breaks that shouldn't be there.
1405       k = find_token(document.body, "\\begin_layout Standard", i)
1406       if k == i + 2:
1407           del document.body[i:i + 3]
1408           del document.body[j - 5:j - 2]
1409           i -= 6
1410       else:
1411           del document.body[i]
1412           del document.body[j - 1]
1413           i -= 2
1414
1415
1416 def revert_equalspacing_xymatrix(document):
1417     " Revert a Formula with xymatrix@! to an ERT inset "
1418     i = 0
1419     j = 0
1420     has_preamble = False
1421     has_equal_spacing = False
1422     while True:
1423       found = -1
1424       i = find_token(document.body, "\\begin_inset Formula", i)
1425       if i == -1:
1426           break
1427       j = find_end_of_inset(document.body, i)
1428       if j == -1:
1429           document.warning("Malformed LyX document: Could not find end of Formula inset.")
1430           break
1431
1432       for curline in range(i,j):
1433           found = document.body[curline].find("\\xymatrix@!")
1434           if found != -1:
1435               break
1436
1437       if found != -1:
1438           has_equal_spacing = True
1439           content = [document.body[i][21:]]
1440           content += document.body[i + 1:j]
1441           subst = put_cmd_in_ert(content)
1442           document.body[i:j + 1] = subst
1443           i += len(subst)
1444       else:
1445           for curline in range(i,j):
1446               l = document.body[curline].find("\\xymatrix")
1447               if l != -1:
1448                   has_preamble = True;
1449                   break;
1450           i = j + 1
1451     if has_equal_spacing and not has_preamble:
1452         add_to_preamble(document, ['\\usepackage[all]{xy}'])
1453
1454
1455 def revert_notefontcolor(document):
1456     " Reverts greyed-out note font color to preamble code "
1457     i = 0
1458     colorcode = ""
1459     while True:
1460       i = find_token(document.header, "\\notefontcolor", i)
1461       if i == -1:
1462           return
1463       colorcode = get_value(document.header, '\\notefontcolor', 0)
1464       del document.header[i]
1465       # the color code is in the form #rrggbb where every character denotes a hex number
1466       # convert the string to an int
1467       red = string.atoi(colorcode[1:3],16)
1468       # we want the output "0.5" for the value "127" therefore increment here
1469       if red != 0:
1470           red = red + 1
1471       redout = float(red) / 256
1472       green = string.atoi(colorcode[3:5],16)
1473       if green != 0:
1474           green = green + 1
1475       greenout = float(green) / 256
1476       blue = string.atoi(colorcode[5:7],16)
1477       if blue != 0:
1478           blue = blue + 1
1479       blueout = float(blue) / 256
1480       # write the preamble
1481       insert_to_preamble(0, document,
1482                            '% Commands inserted by lyx2lyx to set the font color\n'
1483                            '% for greyed-out notes\n'
1484                            + '\\@ifundefined{definecolor}{\\usepackage{color}}{}\n'
1485                            + '\\definecolor{note_fontcolor}{rgb}{'
1486                            + str(redout) + ', ' + str(greenout)
1487                            + ', ' + str(blueout) + '}\n'
1488                            + '\\renewenvironment{lyxgreyedout}\n'
1489                            + ' {\\textcolor{note_fontcolor}\\bgroup}{\\egroup}\n')
1490
1491
1492 def revert_turkmen(document):
1493     "Set language Turkmen to English"
1494     i = 0
1495     if document.language == "turkmen":
1496         document.language = "english"
1497         i = find_token(document.header, "\\language", 0)
1498         if i != -1:
1499             document.header[i] = "\\language english"
1500     j = 0
1501     while True:
1502         j = find_token(document.body, "\\lang turkmen", j)
1503         if j == -1:
1504             return
1505         document.body[j] = document.body[j].replace("\\lang turkmen", "\\lang english")
1506         j = j + 1
1507
1508
1509 def revert_fontcolor(document):
1510     " Reverts font color to preamble code "
1511     i = 0
1512     colorcode = ""
1513     while True:
1514       i = find_token(document.header, "\\fontcolor", i)
1515       if i == -1:
1516           return
1517       colorcode = get_value(document.header, '\\fontcolor', 0)
1518       del document.header[i]
1519       # don't clutter the preamble if backgroundcolor is not set
1520       if colorcode == "#000000":
1521           continue
1522       # the color code is in the form #rrggbb where every character denotes a hex number
1523       # convert the string to an int
1524       red = string.atoi(colorcode[1:3],16)
1525       # we want the output "0.5" for the value "127" therefore add here
1526       if red != 0:
1527           red = red + 1
1528       redout = float(red) / 256
1529       green = string.atoi(colorcode[3:5],16)
1530       if green != 0:
1531           green = green + 1
1532       greenout = float(green) / 256
1533       blue = string.atoi(colorcode[5:7],16)
1534       if blue != 0:
1535           blue = blue + 1
1536       blueout = float(blue) / 256
1537       # write the preamble
1538       insert_to_preamble(0, document,
1539                            '% Commands inserted by lyx2lyx to set the font color\n'
1540                            + '\\@ifundefined{definecolor}{\\usepackage{color}}{}\n'
1541                            + '\\definecolor{document_fontcolor}{rgb}{'
1542                            + str(redout) + ', ' + str(greenout)
1543                            + ', ' + str(blueout) + '}\n'
1544                            + '\\color{document_fontcolor}\n')
1545
1546 def revert_shadedboxcolor(document):
1547     " Reverts shaded box color to preamble code "
1548     i = 0
1549     colorcode = ""
1550     while True:
1551       i = find_token(document.header, "\\boxbgcolor", i)
1552       if i == -1:
1553           return
1554       colorcode = get_value(document.header, '\\boxbgcolor', 0)
1555       del document.header[i]
1556       # the color code is in the form #rrggbb where every character denotes a hex number
1557       # convert the string to an int
1558       red = string.atoi(colorcode[1:3],16)
1559       # we want the output "0.5" for the value "127" therefore increment here
1560       if red != 0:
1561           red = red + 1
1562       redout = float(red) / 256
1563       green = string.atoi(colorcode[3:5],16)
1564       if green != 0:
1565           green = green + 1
1566       greenout = float(green) / 256
1567       blue = string.atoi(colorcode[5:7],16)
1568       if blue != 0:
1569           blue = blue + 1
1570       blueout = float(blue) / 256
1571       # write the preamble
1572       insert_to_preamble(0, document,
1573                            '% Commands inserted by lyx2lyx to set the color\n'
1574                            '% of boxes with shaded background\n'
1575                            + '\\@ifundefined{definecolor}{\\usepackage{color}}{}\n'
1576                            + '\\definecolor{shadecolor}{rgb}{'
1577                            + str(redout) + ', ' + str(greenout)
1578                            + ', ' + str(blueout) + '}\n')
1579
1580
1581 def revert_lyx_version(document):
1582     " Reverts LyX Version information from Inset Info "
1583     version = "LyX version"
1584     try:
1585         import lyx2lyx_version
1586         version = lyx2lyx_version.version
1587     except:
1588         pass
1589
1590     i = 0
1591     while 1:
1592         i = find_token(document.body, '\\begin_inset Info', i)
1593         if i == -1:
1594             return
1595         j = find_end_of_inset(document.body, i + 1)
1596         if j == -1:
1597             # should not happen
1598             document.warning("Malformed LyX document: Could not find end of Info inset.")
1599         # We expect:
1600         # \begin_inset Info
1601         # type  "lyxinfo"
1602         # arg   "version"
1603         # \end_inset
1604         # but we shall try to be forgiving.
1605         arg = typ = ""
1606         for k in range(i, j):
1607             if document.body[k].startswith("arg"):
1608                 arg = document.body[k][3:].strip().strip('"')
1609             if document.body[k].startswith("type"):
1610                 typ = document.body[k][4:].strip().strip('"')
1611         if arg != "version" or typ != "lyxinfo":
1612             i = j + 1
1613             continue
1614
1615         # We do not actually know the version of LyX used to produce the document.
1616         # But we can use our version, since we are reverting.
1617         s = [version]
1618         # Now we want to check if the line after "\end_inset" is empty. It normally
1619         # is, so we want to remove it, too.
1620         lastline = j + 1
1621         if document.body[j + 1].strip() == "":
1622             lastline = j + 2
1623         document.body[i: lastline] = s
1624         i = i + 1
1625
1626
1627 def revert_math_scale(document):
1628   " Remove math scaling and LaTeX options "
1629   i = find_token(document.header, '\\html_math_img_scale', 0)
1630   if i != -1:
1631     del document.header[i]
1632   i = find_token(document.header, '\\html_latex_start', 0)
1633   if i != -1:
1634     del document.header[i]
1635   i = find_token(document.header, '\\html_latex_end', 0)
1636   if i != -1:
1637     del document.header[i]
1638
1639
1640 def revert_pagesizes(document):
1641   i = 0
1642   " Revert page sizes to default "
1643   i = find_token(document.header, '\\papersize', 0)
1644   if i != -1:
1645     size = document.header[i][11:]
1646     if size == "a0paper" or size == "a1paper" or size == "a2paper" \
1647     or size == "a6paper" or size == "b0paper" or size == "b1paper" \
1648     or size == "b2paper" or size == "b6paper" or size == "b0j" \
1649     or size == "b1j" or size == "b2j" or size == "b3j" or size == "b4j" \
1650     or size == "b5j" or size == "b6j":
1651       del document.header[i]
1652
1653
1654 def revert_DIN_C_pagesizes(document):
1655   i = 0
1656   " Revert DIN C page sizes to default "
1657   i = find_token(document.header, '\\papersize', 0)
1658   if i != -1:
1659     size = document.header[i][11:]
1660     if size == "c0paper" or size == "c1paper" or size == "c2paper" \
1661     or size == "c3paper" or size == "c4paper" or size == "c5paper" \
1662     or size == "c6paper":
1663       del document.header[i]
1664
1665
1666 def convert_html_quotes(document):
1667   " Remove quotes around html_latex_start and html_latex_end "
1668
1669   i = find_token(document.header, '\\html_latex_start', 0)
1670   if i != -1:
1671     line = document.header[i]
1672     l = re.compile(r'\\html_latex_start\s+"(.*)"')
1673     m = l.match(line)
1674     if m != None:
1675       document.header[i] = "\\html_latex_start " + m.group(1)
1676
1677   i = find_token(document.header, '\\html_latex_end', 0)
1678   if i != -1:
1679     line = document.header[i]
1680     l = re.compile(r'\\html_latex_end\s+"(.*)"')
1681     m = l.match(line)
1682     if m != None:
1683       document.header[i] = "\\html_latex_end " + m.group(1)
1684
1685
1686 def revert_html_quotes(document):
1687   " Remove quotes around html_latex_start and html_latex_end "
1688
1689   i = find_token(document.header, '\\html_latex_start', 0)
1690   if i != -1:
1691     line = document.header[i]
1692     l = re.compile(r'\\html_latex_start\s+(.*)')
1693     m = l.match(line)
1694     document.header[i] = "\\html_latex_start \"" + m.group(1) + "\""
1695
1696   i = find_token(document.header, '\\html_latex_end', 0)
1697   if i != -1:
1698     line = document.header[i]
1699     l = re.compile(r'\\html_latex_end\s+(.*)')
1700     m = l.match(line)
1701     document.header[i] = "\\html_latex_end \"" + m.group(1) + "\""
1702
1703
1704 def revert_output_sync(document):
1705   " Remove forward search options "
1706   i = find_token(document.header, '\\output_sync_macro', 0)
1707   if i != -1:
1708     del document.header[i]
1709   i = find_token(document.header, '\\output_sync', 0)
1710   if i != -1:
1711     del document.header[i]
1712
1713
1714 def convert_beamer_args(document):
1715   " Convert ERT arguments in Beamer to InsetArguments "
1716
1717   if document.textclass != "beamer" and document.textclass != "article-beamer":
1718     return
1719
1720   layouts = ("Block", "ExampleBlock", "AlertBlock")
1721   for layout in layouts:
1722     blay = 0
1723     while True:
1724       blay = find_token(document.body, '\\begin_layout ' + layout, blay)
1725       if blay == -1:
1726         break
1727       elay = find_end_of(document.body, blay, '\\begin_layout', '\\end_layout')
1728       if elay == -1:
1729         document.warning("Malformed LyX document: Can't find end of " + layout + " layout.")
1730         blay += 1
1731         continue
1732       bert = find_token(document.body, '\\begin_inset ERT', blay)
1733       if bert == -1:
1734         document.warning("Malformed Beamer LyX document: Can't find argument of " + layout + " layout.")
1735         blay = elay + 1
1736         continue
1737       eert = find_end_of_inset(document.body, bert)
1738       if eert == -1:
1739         document.warning("Malformed LyX document: Can't find end of ERT.")
1740         blay = elay + 1
1741         continue
1742
1743       # So the ERT inset begins at line k and goes to line l. We now wrap it in
1744       # an argument inset.
1745       # Do the end first, so as not to mess up the variables.
1746       document.body[eert + 1:eert + 1] = ['', '\\end_layout', '', '\\end_inset', '']
1747       document.body[bert:bert] = ['\\begin_inset OptArg', 'status open', '',
1748           '\\begin_layout Plain Layout']
1749       blay = elay + 9
1750
1751
1752 def revert_beamer_args(document):
1753   " Revert Beamer arguments to ERT "
1754
1755   if document.textclass != "beamer" and document.textclass != "article-beamer":
1756     return
1757
1758   layouts = ("Block", "ExampleBlock", "AlertBlock")
1759   for layout in layouts:
1760     blay = 0
1761     while True:
1762       blay = find_token(document.body, '\\begin_layout ' + layout, blay)
1763       if blay == -1:
1764         break
1765       elay = find_end_of(document.body, blay, '\\begin_layout', '\\end_layout')
1766       if elay == -1:
1767         document.warning("Malformed LyX document: Can't find end of " + layout + " layout.")
1768         blay += 1
1769         continue
1770       bopt = find_token(document.body, '\\begin_inset OptArg', blay)
1771       if bopt == -1:
1772         # it is legal not to have one of these
1773         blay = elay + 1
1774         continue
1775       eopt = find_end_of_inset(document.body, bopt)
1776       if eopt == -1:
1777         document.warning("Malformed LyX document: Can't find end of argument.")
1778         blay = elay + 1
1779         continue
1780       bplay = find_token(document.body, '\\begin_layout Plain Layout', blay)
1781       if bplay == -1:
1782         document.warning("Malformed LyX document: Can't find plain layout.")
1783         blay = elay + 1
1784         continue
1785       eplay = find_end_of(document.body, bplay, '\\begin_layout', '\\end_layout')
1786       if eplay == -1:
1787         document.warning("Malformed LyX document: Can't find end of plain layout.")
1788         blay = elay + 1
1789         continue
1790       # So the content of the argument inset goes from bplay + 1 to eplay - 1
1791       bcont = bplay + 1
1792       if bcont >= eplay:
1793         # Hmm.
1794         document.warning(str(bcont) + " " + str(eplay))
1795         blay = blay + 1
1796         continue
1797       # we convert the content of the argument into pure LaTeX...
1798       content = lyx2latex(document, document.body[bcont:eplay])
1799       strlist = put_cmd_in_ert(["{" + content + "}"])
1800
1801       # now replace the optional argument with the ERT
1802       document.body[bopt:eopt + 1] = strlist
1803       blay = blay + 1
1804
1805
1806 def revert_align_decimal(document):
1807   l = 0
1808   while True:
1809     l = document.body[l].find('alignment=decimal')
1810     if l == -1:
1811         break
1812     remove_option(document, l, 'decimal_point')
1813     document.body[l].replace('decimal', 'center')
1814
1815
1816 def convert_optarg(document):
1817   " Convert \\begin_inset OptArg to \\begin_inset Argument "
1818   i = 0
1819   while 1:
1820     i = find_token(document.body, '\\begin_inset OptArg', i)
1821     if i == -1:
1822       return
1823     document.body[i] = "\\begin_inset Argument"
1824     i += 1
1825
1826
1827 def revert_argument(document):
1828   " Convert \\begin_inset Argument to \\begin_inset OptArg "
1829   i = 0
1830   while 1:
1831     i = find_token(document.body, '\\begin_inset Argument', i)
1832     if i == -1:
1833       return
1834     document.body[i] = "\\begin_inset OptArg"
1835     i += 1
1836
1837
1838 def revert_makebox(document):
1839   " Convert \\makebox to TeX code "
1840   i = 0
1841   while 1:
1842     # only revert frameless boxes without an inner box
1843     i = find_token(document.body, '\\begin_inset Box Frameless', i)
1844     if i == -1:
1845       # remove the option use_makebox
1846       revert_use_makebox(document)
1847       return
1848     z = find_end_of_inset(document.body, i)
1849     if z == -1:
1850       document.warning("Malformed LyX document: Can't find end of box inset.")
1851       return
1852     j = find_token(document.body, 'use_makebox 1', i)
1853     # assure we found the makebox of the current box
1854     if j < z and j != -1:
1855       y = find_token(document.body, "\\begin_layout", i)
1856       if y > z or y == -1:
1857         document.warning("Malformed LyX document: Can't find layout in box.")
1858         return
1859       # remove the \end_layout \end_inset pair
1860       document.body[z - 2:z + 1] = put_cmd_in_ert("}")
1861       # determine the alignment
1862       k = find_token(document.body, 'hor_pos', j - 4)
1863       align = document.body[k][9]
1864       # determine the width
1865       l = find_token(document.body, 'width "', j + 1)
1866       length = document.body[l][7:]
1867       # remove trailing '"'
1868       length = length[:-1]
1869       length = latex_length(length)[1]
1870       subst = "\\makebox[" + length + "][" \
1871         + align + "]{"
1872       document.body[i:y + 1] = put_cmd_in_ert(subst)
1873     i += 1
1874
1875
1876 def revert_use_makebox(document):
1877   " Deletes use_makebox option of boxes "
1878   h = 0
1879   while 1:
1880     # remove the option use_makebox
1881     h = find_token(document.body, 'use_makebox', 0)
1882     if h == -1:
1883       return
1884     del document.body[h]
1885     h += 1
1886
1887
1888 def convert_use_makebox(document):
1889   " Adds use_makebox option for boxes "
1890   i = 0
1891   while 1:
1892     # remove the option use_makebox
1893     i = find_token(document.body, '\\begin_inset Box', i)
1894     if i == -1:
1895       return
1896     k = find_token(document.body, 'use_parbox', i)
1897     if k == -1:
1898       document.warning("Malformed LyX document: Can't find use_parbox statement in box.")
1899       return
1900     document.body.insert(k + 1, "use_makebox 0")
1901     i = k + 1
1902
1903
1904 def revert_IEEEtran(document):
1905   " Convert IEEEtran layouts and styles to TeX code "
1906   if document.textclass != "IEEEtran":
1907     return
1908   revert_flex_inset(document, "IEEE membership", "\\IEEEmembership", 0)
1909   revert_flex_inset(document, "Lowercase", "\\MakeLowercase", 0)
1910   layouts = ("Special Paper Notice", "After Title Text", "Publication ID",
1911              "Page headings", "Biography without photo")
1912   latexcmd = {"Special Paper Notice": "\\IEEEspecialpapernotice",
1913               "After Title Text":     "\\IEEEaftertitletext",
1914               "Publication ID":       "\\IEEEpubid"}
1915   obsoletedby = {"Page headings":            "MarkBoth",
1916                  "Biography without photo":  "BiographyNoPhoto"}
1917   for layout in layouts:
1918     i = 0
1919     while True:
1920         i = find_token(document.body, '\\begin_layout ' + layout, i)
1921         if i == -1:
1922           break
1923         j = find_end_of(document.body, i, '\\begin_layout', '\\end_layout')
1924         if j == -1:
1925           document.warning("Malformed LyX document: Can't find end of " + layout + " layout.")
1926           i += 1
1927           continue
1928         if layout in obsoletedby:
1929           document.body[i] = "\\begin_layout " + obsoletedby[layout]
1930           i = j
1931         else:
1932           content = lyx2latex(document, document.body[i:j + 1])
1933           add_to_preamble(document, [latexcmd[layout] + "{" + content + "}"])
1934           del document.body[i:j + 1]
1935
1936
1937 def convert_prettyref(document):
1938         " Converts prettyref references to neutral formatted refs "
1939         re_ref = re.compile("^\s*reference\s+\"(\w+):(\S+)\"")
1940         nm_ref = re.compile("^\s*name\s+\"(\w+):(\S+)\"")
1941
1942         i = 0
1943         while True:
1944                 i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1945                 if i == -1:
1946                         break
1947                 j = find_end_of_inset(document.body, i)
1948                 if j == -1:
1949                         document.warning("Malformed LyX document: No end of InsetRef!")
1950                         i += 1
1951                         continue
1952                 k = find_token(document.body, "LatexCommand prettyref", i)
1953                 if k != -1 and k < j:
1954                         document.body[k] = "LatexCommand formatted"
1955                 i = j + 1
1956         document.header.insert(-1, "\\use_refstyle 0")
1957
1958
1959 def revert_refstyle(document):
1960         " Reverts neutral formatted refs to prettyref "
1961         re_ref = re.compile("^reference\s+\"(\w+):(\S+)\"")
1962         nm_ref = re.compile("^\s*name\s+\"(\w+):(\S+)\"")
1963
1964         i = 0
1965         while True:
1966                 i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1967                 if i == -1:
1968                         break
1969                 j = find_end_of_inset(document.body, i)
1970                 if j == -1:
1971                         document.warning("Malformed LyX document: No end of InsetRef")
1972                         i += 1
1973                         continue
1974                 k = find_token(document.body, "LatexCommand formatted", i)
1975                 if k != -1 and k < j:
1976                         document.body[k] = "LatexCommand prettyref"
1977                 i = j + 1
1978         i = find_token(document.header, "\\use_refstyle", 0)
1979         if i != -1:
1980                 document.header.pop(i)
1981
1982
1983 def revert_nameref(document):
1984   " Convert namerefs to regular references "
1985   cmds = ["Nameref", "nameref"]
1986   foundone = False
1987   rx = re.compile(r'reference "(.*)"')
1988   for cmd in cmds:
1989     i = 0
1990     oldcmd = "LatexCommand " + cmd
1991     while 1:
1992       # It seems better to look for this, as most of the reference
1993       # insets won't be ones we care about.
1994       i = find_token(document.body, oldcmd, i)
1995       if i == -1:
1996         break
1997       cmdloc = i
1998       i += 1
1999       # Make sure it is actually in an inset!
2000       # We could just check document.lines[i-1], but that relies
2001       # upon something that might easily change.
2002       # We'll look back a few lines.
2003       stins = cmdloc - 10
2004       if stins < 0:
2005         stins = 0
2006       stins = find_token(document.body, "\\begin_inset CommandInset ref", stins)
2007       if stins == -1 or stins > cmdloc:
2008         continue
2009       endins = find_end_of_inset(document.body, stins)
2010       if endins == -1:
2011         document.warning("Can't find end of inset at line " + stins + "!!")
2012         continue
2013       if endins < cmdloc:
2014         continue
2015       refline = find_token(document.body, "reference", stins)
2016       if refline == -1 or refline > endins:
2017         document.warning("Can't find reference for inset at line " + stinst + "!!")
2018         continue
2019       m = rx.match(document.body[refline])
2020       if not m:
2021         document.warning("Can't match reference line: " + document.body[ref])
2022         continue
2023       foundone = True
2024       ref = m.group(1)
2025       newcontent = ['\\begin_inset ERT', 'status collapsed', '', \
2026         '\\begin_layout Plain Layout', '', '\\backslash', \
2027         cmd + '{' + ref + '}', '\\end_layout', '', '\\end_inset']
2028       document.body[stins:endins + 1] = newcontent
2029   if foundone:
2030     add_to_preamble(document, "\usepackage{nameref}")
2031
2032
2033 def remove_Nameref(document):
2034   " Convert Nameref commands to nameref commands "
2035   i = 0
2036   while 1:
2037     # It seems better to look for this, as most of the reference
2038     # insets won't be ones we care about.
2039     i = find_token(document.body, "LatexCommand Nameref" , i)
2040     if i == -1:
2041       break
2042     cmdloc = i
2043     i += 1
2044
2045     # Make sure it is actually in an inset!
2046     # We could just check document.lines[i-1], but that relies
2047     # upon something that might easily change.
2048     # We'll look back a few lines.
2049     stins = cmdloc - 10
2050     if stins < 0:
2051       stins = 0
2052     stins = find_token(document.body, "\\begin_inset CommandInset ref", stins)
2053     if stins == -1 or stins > cmdloc:
2054       continue
2055     endins = find_end_of_inset(document.body, stins)
2056     if endins == -1:
2057       document.warning("Can't find end of inset at line " + stins + "!!")
2058       continue
2059     if endins < cmdloc:
2060       continue
2061     document.body[cmdloc] = "LatexCommand nameref"
2062
2063
2064 def revert_mathrsfs(document):
2065     " Load mathrsfs if \mathrsfs us use in the document "
2066     i = 0
2067     end = len(document.body) - 1
2068     while True:
2069       j = document.body[i].find("\\mathscr{")
2070       if j != -1:
2071         add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
2072         add_to_preamble(document, ["\\usepackage{mathrsfs}"])
2073         break
2074       if i == end:
2075         break
2076       i += 1
2077
2078
2079 def convert_flexnames(document):
2080     "Convert \\begin_inset Flex Custom:Style to \\begin_inset Flex Style and similarly for CharStyle and Element."
2081
2082     i = 0
2083     rx = re.compile(r'^\\begin_inset Flex (?:Custom|CharStyle|Element):(.+)$')
2084     while True:
2085       i = find_token(document.body, "\\begin_inset Flex", i)
2086       if i == -1:
2087         return
2088       m = rx.match(document.body[i])
2089       if m:
2090         document.body[i] = "\\begin_inset Flex " + m.group(1)
2091       i += 1
2092
2093
2094 flex_insets = [
2095   ["Alert", "CharStyle:Alert"],
2096   ["Code", "CharStyle:Code"],
2097   ["Concepts", "CharStyle:Concepts"],
2098   ["E-Mail", "CharStyle:E-Mail"],
2099   ["Emph", "CharStyle:Emph"],
2100   ["Expression", "CharStyle:Expression"],
2101   ["Initial", "CharStyle:Initial"],
2102   ["Institute", "CharStyle:Institute"],
2103   ["Meaning", "CharStyle:Meaning"],
2104   ["Noun", "CharStyle:Noun"],
2105   ["Strong", "CharStyle:Strong"],
2106   ["Structure", "CharStyle:Structure"],
2107   ["ArticleMode", "Custom:ArticleMode"],
2108   ["Endnote", "Custom:Endnote"],
2109   ["Glosse", "Custom:Glosse"],
2110   ["PresentationMode", "Custom:PresentationMode"],
2111   ["Tri-Glosse", "Custom:Tri-Glosse"]
2112 ]
2113
2114 flex_elements = [
2115   ["Abbrev", "Element:Abbrev"],
2116   ["CCC-Code", "Element:CCC-Code"],
2117   ["Citation-number", "Element:Citation-number"],
2118   ["City", "Element:City"],
2119   ["Code", "Element:Code"],
2120   ["CODEN", "Element:CODEN"],
2121   ["Country", "Element:Country"],
2122   ["Day", "Element:Day"],
2123   ["Directory", "Element:Directory"],
2124   ["Dscr", "Element:Dscr"],
2125   ["Email", "Element:Email"],
2126   ["Emph", "Element:Emph"],
2127   ["Filename", "Element:Filename"],
2128   ["Firstname", "Element:Firstname"],
2129   ["Fname", "Element:Fname"],
2130   ["GuiButton", "Element:GuiButton"],
2131   ["GuiMenu", "Element:GuiMenu"],
2132   ["GuiMenuItem", "Element:GuiMenuItem"],
2133   ["ISSN", "Element:ISSN"],
2134   ["Issue-day", "Element:Issue-day"],
2135   ["Issue-months", "Element:Issue-months"],
2136   ["Issue-number", "Element:Issue-number"],
2137   ["KeyCap", "Element:KeyCap"],
2138   ["KeyCombo", "Element:KeyCombo"],
2139   ["Keyword", "Element:Keyword"],
2140   ["Literal", "Element:Literal"],
2141   ["MenuChoice", "Element:MenuChoice"],
2142   ["Month", "Element:Month"],
2143   ["Orgdiv", "Element:Orgdiv"],
2144   ["Orgname", "Element:Orgname"],
2145   ["Postcode", "Element:Postcode"],
2146   ["SS-Code", "Element:SS-Code"],
2147   ["SS-Title", "Element:SS-Title"],
2148   ["State", "Element:State"],
2149   ["Street", "Element:Street"],
2150   ["Surname", "Element:Surname"],
2151   ["Volume", "Element:Volume"],
2152   ["Year", "Element:Year"]
2153 ]
2154
2155
2156 def revert_flexnames(document):
2157   if document.backend == "latex":
2158     flexlist = flex_insets
2159   else:
2160     flexlist = flex_elements
2161
2162   rx = re.compile(r'^\\begin_inset Flex\s+(.+)$')
2163   i = 0
2164   while True:
2165     i = find_token(document.body, "\\begin_inset Flex", i)
2166     if i == -1:
2167       return
2168     m = rx.match(document.body[i])
2169     if not m:
2170       document.warning("Illegal flex inset: " + document.body[i])
2171       i += 1
2172       continue
2173
2174     style = m.group(1)
2175     for f in flexlist:
2176       if f[0] == style:
2177         document.body[i] = "\\begin_inset Flex " + f[1]
2178         break
2179
2180     i += 1
2181
2182
2183 def convert_mathdots(document):
2184     " Load mathdots automatically "
2185     while True:
2186       i = find_token(document.header, "\\use_esint" , 0)
2187       if i != -1:
2188         document.header.insert(i + 1, "\\use_mathdots 1")
2189       break
2190
2191
2192 def revert_mathdots(document):
2193     " Load mathdots if used in the document "
2194     i = 0
2195     ddots = re.compile(r'\\begin_inset Formula .*\\ddots', re.DOTALL)
2196     vdots = re.compile(r'\\begin_inset Formula .*\\vdots', re.DOTALL)
2197     iddots = re.compile(r'\\begin_inset Formula .*\\iddots', re.DOTALL)
2198     mathdots = find_token(document.header, "\\use_mathdots" , 0)
2199     no = find_token(document.header, "\\use_mathdots 0" , 0)
2200     auto = find_token(document.header, "\\use_mathdots 1" , 0)
2201     yes = find_token(document.header, "\\use_mathdots 2" , 0)
2202     if mathdots != -1:
2203       del document.header[mathdots]
2204     while True:
2205       i = find_token(document.body, '\\begin_inset Formula', i)
2206       if i == -1:
2207         return
2208       j = find_end_of_inset(document.body, i)
2209       if j == -1:
2210         document.warning("Malformed LyX document: Can't find end of Formula inset.")
2211         return
2212       k = ddots.search("\n".join(document.body[i:j]))
2213       l = vdots.search("\n".join(document.body[i:j]))
2214       m = iddots.search("\n".join(document.body[i:j]))
2215       if (yes == -1) and ((no != -1) or (not k and not l and not m) or (auto != -1 and not m)):
2216         i += 1
2217         continue
2218       # use \@ifundefined to catch also the "auto" case
2219       add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
2220       add_to_preamble(document, ["\\@ifundefined{iddots}{\\usepackage{mathdots}}\n"])
2221       return
2222
2223
2224 def convert_rule(document):
2225     " Convert \\lyxline to CommandInset line "
2226     i = 0
2227     while True:
2228       i = find_token(document.body, "\\lyxline" , i)
2229       if i == -1:
2230         return
2231
2232       j = find_token(document.body, "\\color" , i - 2)
2233       if j == i - 2:
2234         color = document.body[j] + '\n'
2235       else:
2236         color = ''
2237       k = find_token(document.body, "\\begin_layout Standard" , i - 4)
2238       # we need to handle the case that \lyxline is in a separate paragraph and that it is colored
2239       # the result is then an extra empty paragraph which we get by adding an empty ERT inset
2240       if k == i - 4 and j == i - 2 and document.body[i - 1] == '':
2241         layout = '\\begin_inset ERT\nstatus collapsed\n\n\\begin_layout Plain Layout\n\n\n\\end_layout\n\n\\end_inset\n' \
2242           + '\\end_layout\n\n' \
2243           + '\\begin_layout Standard\n'
2244       elif k == i - 2 and document.body[i - 1] == '':
2245         layout = ''
2246       else:
2247         layout = '\\end_layout\n\n' \
2248           + '\\begin_layout Standard\n'
2249       l = find_token(document.body, "\\begin_layout Standard" , i + 4)
2250       if l == i + 4 and document.body[i + 1] == '':
2251         layout2 = ''
2252       else:
2253         layout2 = '\\end_layout\n' \
2254           + '\n\\begin_layout Standard\n'
2255       subst = layout \
2256         + '\\noindent\n\n' \
2257         + color \
2258         + '\\begin_inset CommandInset line\n' \
2259         + 'LatexCommand rule\n' \
2260         + 'offset "0.5ex"\n' \
2261         + 'width "100line%"\n' \
2262         + 'height "1pt"\n' \
2263         + '\n\\end_inset\n\n\n' \
2264         + layout2
2265       document.body[i] = subst
2266       i += 1
2267
2268
2269 def revert_rule(document):
2270     " Revert line insets to Tex code "
2271     i = 0
2272     while 1:
2273       i = find_token(document.body, "\\begin_inset CommandInset line" , i)
2274       if i == -1:
2275         return
2276       # find end of inset
2277       j = find_token(document.body, "\\end_inset" , i)
2278       # assure we found the end_inset of the current inset
2279       if j > i + 6 or j == -1:
2280         document.warning("Malformed LyX document: Can't find end of line inset.")
2281         return
2282       # determine the optional offset
2283       k = find_token(document.body, 'offset', i, j)
2284       if k != -1:
2285         offset = document.body[k][8:-1]
2286       else:
2287         offset = ""
2288       # determine the width
2289       l = find_token(document.body, 'width', i, j)
2290       if l != -1:
2291         width = document.body[l][7:-1]
2292       else:
2293         width = "100col%"
2294       # determine the height
2295       m = find_token(document.body, 'height', i, j)
2296       if m != -1:
2297         height = document.body[m][8:-1]
2298       else:
2299         height = "1pt"
2300       # output the \rule command
2301       if offset:
2302         subst = "\\rule[" + offset + "]{" + width + "}{" + height + "}"
2303       else:
2304         subst = "\\rule{" + width + "}{" + height + "}"
2305       document.body[i:j + 1] = put_cmd_in_ert(subst)
2306       i += 1
2307
2308
2309 def revert_diagram(document):
2310   " Add the feyn package if \\Diagram is used in math "
2311   i = 0
2312   re_diagram = re.compile(r'\\begin_inset Formula .*\\Diagram', re.DOTALL)
2313   while True:
2314     i = find_token(document.body, '\\begin_inset Formula', i)
2315     if i == -1:
2316       return
2317     j = find_end_of_inset(document.body, i)
2318     if j == -1:
2319         document.warning("Malformed LyX document: Can't find end of Formula inset.")
2320         return
2321     m = re_diagram.search("\n".join(document.body[i:j]))
2322     if not m:
2323       i += 1
2324       continue
2325     add_to_preamble(document, ["% this command was inserted by lyx2lyx"])
2326     add_to_preamble(document, "\\usepackage{feyn}")
2327     # only need to do it once!
2328     return
2329
2330
2331 def convert_bibtex_clearpage(document):
2332   " insert a clear(double)page bibliographystyle if bibtotoc option is used "
2333
2334   i = find_token(document.header, '\\papersides', 0)
2335   if i == -1:
2336     document.warning("Malformed LyX document: Can't find papersides definition.")
2337     return
2338   sides = int(document.header[i][12])
2339
2340   j = 0
2341   while True:
2342     j = find_token(document.body, "\\begin_inset CommandInset bibtex", j)
2343     if j == -1:
2344       return
2345
2346     k = find_end_of_inset(document.body, j)
2347     if k == -1:
2348       document.warning("Can't find end of Bibliography inset at line " + str(j))
2349       j += 1
2350       continue
2351
2352     # only act if there is the option "bibtotoc"
2353     m = find_token(document.body, 'options', j, k)
2354     if m == -1:
2355       document.warning("Can't find options for bibliography inset at line " + str(j))
2356       j = k
2357       continue
2358
2359     optline = document.body[m]
2360     idx = optline.find("bibtotoc")
2361     if idx == -1:
2362       j = k
2363       continue
2364
2365     # so we want to insert a new page right before the paragraph that
2366     # this bibliography thing is in. we'll look for it backwards.
2367     lay = j - 1
2368     while lay >= 0:
2369       if document.body[lay].startswith("\\begin_layout"):
2370         break
2371       lay -= 1
2372
2373     if lay < 0:
2374       document.warning("Can't find layout containing bibliography inset at line " + str(j))
2375       j = k
2376       continue
2377
2378     subst1 = '\\begin_layout Standard\n' \
2379       + '\\begin_inset Newpage clearpage\n' \
2380       + '\\end_inset\n\n\n' \
2381       + '\\end_layout\n'
2382     subst2 = '\\begin_layout Standard\n' \
2383       + '\\begin_inset Newpage cleardoublepage\n' \
2384       + '\\end_inset\n\n\n' \
2385       + '\\end_layout\n'
2386     if sides == 1:
2387       document.body.insert(lay, subst1)
2388       document.warning(subst1)
2389     else:
2390       document.body.insert(lay, subst2)
2391       document.warning(subst2)
2392
2393     j = k
2394
2395
2396 ##
2397 # Conversion hub
2398 #
2399
2400 supported_versions = ["2.0.0","2.0"]
2401 convert = [[346, []],
2402            [347, []],
2403            [348, []],
2404            [349, []],
2405            [350, []],
2406            [351, []],
2407            [352, [convert_splitindex]],
2408            [353, []],
2409            [354, []],
2410            [355, []],
2411            [356, []],
2412            [357, []],
2413            [358, []],
2414            [359, [convert_nomencl_width]],
2415            [360, []],
2416            [361, []],
2417            [362, []],
2418            [363, []],
2419            [364, []],
2420            [365, []],
2421            [366, []],
2422            [367, []],
2423            [368, []],
2424            [369, [convert_author_id]],
2425            [370, []],
2426            [371, []],
2427            [372, []],
2428            [373, [merge_gbrief]],
2429            [374, []],
2430            [375, []],
2431            [376, []],
2432            [377, []],
2433            [378, []],
2434            [379, [convert_math_output]],
2435            [380, []],
2436            [381, []],
2437            [382, []],
2438            [383, []],
2439            [384, []],
2440            [385, []],
2441            [386, []],
2442            [387, []],
2443            [388, []],
2444            [389, [convert_html_quotes]],
2445            [390, []],
2446            [391, []],
2447            [392, []],
2448            [393, [convert_optarg]],
2449            [394, [convert_use_makebox]],
2450            [395, []],
2451            [396, []],
2452            [397, [remove_Nameref]],
2453            [398, []],
2454            [399, [convert_mathdots]],
2455            [400, [convert_rule]],
2456            [401, []],
2457            [402, [convert_bibtex_clearpage]],
2458            [403, [convert_flexnames]],
2459            [404, [convert_prettyref]]
2460 ]
2461
2462 revert =  [[403, [revert_refstyle]],
2463            [402, [revert_flexnames]],
2464            [401, []],
2465            [400, [revert_diagram]],
2466            [399, [revert_rule]],
2467            [398, [revert_mathdots]],
2468            [397, [revert_mathrsfs]],
2469            [396, []],
2470            [395, [revert_nameref]],
2471            [394, [revert_DIN_C_pagesizes]],
2472            [393, [revert_makebox]],
2473            [392, [revert_argument]],
2474            [391, [revert_beamer_args]],
2475            [390, [revert_align_decimal, revert_IEEEtran]],
2476            [389, [revert_output_sync]],
2477            [388, [revert_html_quotes]],
2478            [387, [revert_pagesizes]],
2479            [386, [revert_math_scale]],
2480            [385, [revert_lyx_version]],
2481            [384, [revert_shadedboxcolor]],
2482            [383, [revert_fontcolor]],
2483            [382, [revert_turkmen]],
2484            [381, [revert_notefontcolor]],
2485            [380, [revert_equalspacing_xymatrix]],
2486            [379, [revert_inset_preview]],
2487            [378, [revert_math_output]],
2488            [377, []],
2489            [376, [revert_multirow]],
2490            [375, [revert_includeall]],
2491            [374, [revert_includeonly]],
2492            [373, [revert_html_options]],
2493            [372, [revert_gbrief]],
2494            [371, [revert_fontenc]],
2495            [370, [revert_mhchem]],
2496            [369, [revert_suppress_date]],
2497            [368, [revert_author_id]],
2498            [367, [revert_hspace_glue_lengths]],
2499            [366, [revert_percent_vspace_lengths, revert_percent_hspace_lengths]],
2500            [365, [revert_percent_skip_lengths]],
2501            [364, [revert_paragraph_indentation]],
2502            [363, [revert_branch_filename]],
2503            [362, [revert_longtable_align]],
2504            [361, [revert_applemac]],
2505            [360, []],
2506            [359, [revert_nomencl_cwidth]],
2507            [358, [revert_nomencl_width]],
2508            [357, [revert_custom_processors]],
2509            [356, [revert_ulinelatex]],
2510            [355, []],
2511            [354, [revert_strikeout]],
2512            [353, [revert_printindexall]],
2513            [352, [revert_subindex]],
2514            [351, [revert_splitindex]],
2515            [350, [revert_backgroundcolor]],
2516            [349, [revert_outputformat]],
2517            [348, [revert_xetex]],
2518            [347, [revert_phantom, revert_hphantom, revert_vphantom]],
2519            [346, [revert_tabularvalign]],
2520            [345, [revert_swiss]]
2521           ]
2522
2523
2524 if __name__ == "__main__":
2525     pass