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