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
  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     i = 0
 943     multirow = False
 944     while True:
 945       # cell type 3 is multirow begin cell
 946       i = find_token(document.body, '<cell multirow="3"', i)
 947       if i == -1:
 948           break
 949       # a multirow cell was found
 950       multirow = True
 951       # remove the multirow tag, set the valignment to top
 952       # and remove the bottom line
 953       document.body[i] = document.body[i].replace(' multirow="3" ', ' ')
 954       document.body[i] = document.body[i].replace('valignment="middle"', 'valignment="top"')
 955       document.body[i] = document.body[i].replace(' bottomline="true" ', ' ')
 956       # write ERT to create the multirow cell
 957       # use 2 rows and 2cm as default with because the multirow span
 958       # and the column width is only hardly accessible
 959       cend = find_token(document.body, "</cell>", i)
 960       if cend == -1:
 961           document.warning("Malformed LyX document: Could not find end of tabular cell.")
 962           i += 1
 963           continue
 964       blay = find_token(document.body, "\\begin_layout", i, cend)
 965       if blay == -1:
 966           document.warning("Can't find layout for cell!")
 967           i = j
 968           continue
 969       bend = find_end_of_layout(document.body, blay)
 970       if blay == -1:
 971           document.warning("Can't find end of layout for cell!")
 972           i = cend
 973           continue
 974
 975       # do the later one first, so as not to mess up the numbering
 976       # we are wrapping the whole cell in this ert
 977       # so before the end of the layout...
 978       document.body[bend:bend] = put_cmd_in_ert("}")
 979       # ...and after the beginning
 980       document.body[blay+1:blay+1] = put_cmd_in_ert("\\multirow{2}{2cm}{")
 981
 982       while True:
 983           # cell type 4 is multirow part cell
 984           k = find_token(document.body, '<cell multirow="4"', cend)
 985           if k == -1:
 986               break
 987           # remove the multirow tag, set the valignment to top
 988           # and remove the top line
 989           document.body[k] = document.body[k].replace(' multirow="4" ', ' ')
 990           document.body[k] = document.body[k].replace('valignment="middle"', 'valignment="top"')
 991           document.body[k] = document.body[k].replace(' topline="true" ', ' ')
 992           k += 1
 993       # this will always be ok
 994       i = cend
 995
 996     if multirow == True:
 997         add_to_preamble(document, ["\\usepackage{multirow}"])
 998
 999
1000 def convert_math_output(document):
1001     " Convert \html_use_mathml to \html_math_output "
1002     i = find_token(document.header, "\\html_use_mathml", 0)
1003     if i == -1:
1004         return
1005     rgx = re.compile(r'\\html_use_mathml\s+(\w+)')
1006     m = rgx.match(document.header[i])
1007     newval = "0" # MathML
1008     if m:
1009       val = str2bool(m.group(1))
1010       if not val:
1011         newval = "2" # Images
1012     else:
1013       document.warning("Can't match " + document.header[i])
1014     document.header[i] = "\\html_math_output " + newval
1015
1016
1017 def revert_math_output(document):
1018     " Revert \html_math_output to \html_use_mathml "
1019     i = find_token(document.header, "\\html_math_output", 0)
1020     if i == -1:
1021         return
1022     rgx = re.compile(r'\\html_math_output\s+(\d)')
1023     m = rgx.match(document.header[i])
1024     newval = "true"
1025     if m:
1026         val = m.group(1)
1027         if val == "1" or val == "2":
1028             newval = "false"
1029     else:
1030         document.warning("Unable to match " + document.header[i])
1031     document.header[i] = "\\html_use_mathml " + newval
1032
1033
1034
1035 def revert_inset_preview(document):
1036     " Dissolves the preview inset "
1037     i = 0
1038     while True:
1039       i = find_token(document.body, "\\begin_inset Preview", i)
1040       if i == -1:
1041           return
1042       iend = find_end_of_inset(document.body, i)
1043       if iend == -1:
1044           document.warning("Malformed LyX document: Could not find end of Preview inset.")
1045           i += 1
1046           continue
1047
1048       # This has several issues.
1049       # We need to do something about the layouts inside InsetPreview.
1050       # If we just leave the first one, then we have something like:
1051       # \begin_layout Standard
1052       # ...
1053       # \begin_layout Standard
1054       # and we get a "no \end_layout" error. So something has to be done.
1055       # Ideally, we would check if it is the same as the layout we are in.
1056       # If so, we just remove it; if not, we end the active one. But it is
1057       # not easy to know what layout we are in, due to depth changes, etc,
1058       # and it is not clear to me how much work it is worth doing. In most
1059       # cases, the layout will probably be the same.
1060       #
1061       # For the same reason, we have to remove the \end_layout tag at the
1062       # end of the last layout in the inset. Again, that will sometimes be
1063       # wrong, but it will usually be right. To know what to do, we would
1064       # again have to know what layout the inset is in.
1065
1066       blay = find_token(document.body, "\\begin_layout", i, iend)
1067       if blay == -1:
1068           document.warning("Can't find layout for preview inset!")
1069           # always do the later one first...
1070           del document.body[iend]
1071           del document.body[i]
1072           # deletions mean we do not need to reset i
1073           continue
1074
1075       # This is where we would check what layout we are in.
1076       # The check for Standard is definitely wrong.
1077       #
1078       # lay = document.body[blay].split(None, 1)[1]
1079       # if lay != oldlayout:
1080       #     # record a boolean to tell us what to do later....
1081       #     # better to do it later, since (a) it won't mess up
1082       #     # the numbering and (b) we only modify at the end.
1083
1084       # we want to delete the last \\end_layout in this inset, too.
1085       # note that this may not be the \\end_layout that goes with blay!!
1086       bend = find_end_of_layout(document.body, blay)
1087       while True:
1088           tmp = find_token(document.body, "\\end_layout", bend + 1, iend)
1089           if tmp == -1:
1090               break
1091           bend = tmp
1092       if bend == blay:
1093           document.warning("Unable to find last layout in preview inset!")
1094           del document.body[iend]
1095           del document.body[i]
1096           # deletions mean we do not need to reset i
1097           continue
1098       # always do the later one first...
1099       del document.body[iend]
1100       del document.body[bend]
1101       del document.body[i:blay + 1]
1102       # we do not need to reset i
1103
1104
1105 def revert_equalspacing_xymatrix(document):
1106     " Revert a Formula with xymatrix@! to an ERT inset "
1107     i = 0
1108     has_preamble = False
1109     has_equal_spacing = False
1110
1111     while True:
1112       i = find_token(document.body, "\\begin_inset Formula", i)
1113       if i == -1:
1114           break
1115       j = find_end_of_inset(document.body, i)
1116       if j == -1:
1117           document.warning("Malformed LyX document: Could not find end of Formula inset.")
1118           i += 1
1119           continue
1120
1121       for curline in range(i,j):
1122           found = document.body[curline].find("\\xymatrix@!")
1123           if found != -1:
1124               break
1125
1126       if found != -1:
1127           has_equal_spacing = True
1128           content = [document.body[i][21:]]
1129           content += document.body[i + 1:j]
1130           subst = put_cmd_in_ert(content)
1131           document.body[i:j + 1] = subst
1132           i += len(subst) - (j - i) + 1
1133       else:
1134           for curline in range(i,j):
1135               l = document.body[curline].find("\\xymatrix")
1136               if l != -1:
1137                   has_preamble = True;
1138                   break;
1139           i = j + 1
1140
1141     if has_equal_spacing and not has_preamble:
1142         add_to_preamble(document, ['\\usepackage[all]{xy}'])
1143
1144
1145 def revert_notefontcolor(document):
1146     " Reverts greyed-out note font color to preamble code "
1147
1148     i = find_token(document.header, "\\notefontcolor", 0)
1149     if i == -1:
1150         return
1151
1152     colorcode = get_value(document.header, '\\notefontcolor', i)
1153     del document.header[i]
1154
1155     # are there any grey notes?
1156     if find_token(document.body, "\\begin_inset Note Greyedout", 0) == -1:
1157         # no need to do anything else, and \renewcommand will throw
1158         # an error since lyxgreyedout will not exist.
1159         return
1160
1161     # the color code is in the form #rrggbb where every character denotes a hex number
1162     red = hex2ratio(colorcode[1:3])
1163     green = hex2ratio(colorcode[3:5])
1164     blue = hex2ratio(colorcode[5:7])
1165     # write the preamble
1166     insert_to_preamble(document,
1167       [ '%  for greyed-out notes',
1168         '\\@ifundefined{definecolor}{\\usepackage{color}}{}'
1169         '\\definecolor{note_fontcolor}{rgb}{%s,%s,%s}' % (red, green, blue),
1170         '\\renewenvironment{lyxgreyedout}',
1171         ' {\\textcolor{note_fontcolor}\\bgroup}{\\egroup}'])
1172
1173
1174 def revert_turkmen(document):
1175     "Set language Turkmen to English"
1176
1177     if document.language == "turkmen":
1178         document.language = "english"
1179         i = find_token(document.header, "\\language", 0)
1180         if i != -1:
1181             document.header[i] = "\\language english"
1182
1183     j = 0
1184     while True:
1185         j = find_token(document.body, "\\lang turkmen", j)
1186         if j == -1:
1187             return
1188         document.body[j] = document.body[j].replace("\\lang turkmen", "\\lang english")
1189         j += 1
1190
1191
1192 def revert_fontcolor(document):
1193     " Reverts font color to preamble code "
1194     i = find_token(document.header, "\\fontcolor", 0)
1195     if i == -1:
1196         return
1197     colorcode = get_value(document.header, '\\fontcolor', i)
1198     del document.header[i]
1199     # don't clutter the preamble if font color is not set
1200     if colorcode == "#000000":
1201         return
1202     # the color code is in the form #rrggbb where every character denotes a hex number
1203     red = hex2ratio(colorcode[1:3])
1204     green = hex2ratio(colorcode[3:5])
1205     blue = hex2ratio(colorcode[5:7])
1206     # write the preamble
1207     insert_to_preamble(document,
1208       ['%  Set the font color',
1209       '\\@ifundefined{definecolor}{\\usepackage{color}}{}',
1210       '\\definecolor{document_fontcolor}{rgb}{%s,%s,%s}' % (red, green, blue),
1211       '\\color{document_fontcolor}'])
1212
1213
1214 def revert_shadedboxcolor(document):
1215     " Reverts shaded box color to preamble code "
1216     i = find_token(document.header, "\\boxbgcolor", 0)
1217     if i == -1:
1218         return
1219     colorcode = get_value(document.header, '\\boxbgcolor', i)
1220     del document.header[i]
1221     # the color code is in the form #rrggbb
1222     red = hex2ratio(colorcode[1:3])
1223     green = hex2ratio(colorcode[3:5])
1224     blue = hex2ratio(colorcode[5:7])
1225     # write the preamble
1226     insert_to_preamble(document,
1227       ['%  Set the color of boxes with shaded background',
1228       '\\@ifundefined{definecolor}{\\usepackage{color}}{}',
1229       "\\definecolor{shadecolor}{rgb}{%s,%s,%s}" % (red, green, blue)])
1230
1231
1232 def revert_lyx_version(document):
1233     " Reverts LyX Version information from Inset Info "
1234     version = "LyX version"
1235     try:
1236         import lyx2lyx_version
1237         version = lyx2lyx_version.version
1238     except:
1239         pass
1240
1241     i = 0
1242     while 1:
1243         i = find_token(document.body, '\\begin_inset Info', i)
1244         if i == -1:
1245             return
1246         j = find_end_of_inset(document.body, i + 1)
1247         if j == -1:
1248             document.warning("Malformed LyX document: Could not find end of Info inset.")
1249             i += 1
1250             continue
1251
1252         # We expect:
1253         # \begin_inset Info
1254         # type  "lyxinfo"
1255         # arg   "version"
1256         # \end_inset
1257         typ = get_quoted_value(document.body, "type", i, j)
1258         arg = get_quoted_value(document.body, "arg", i, j)
1259         if arg != "version" or typ != "lyxinfo":
1260             i = j + 1
1261             continue
1262
1263         # We do not actually know the version of LyX used to produce the document.
1264         # But we can use our version, since we are reverting.
1265         s = [version]
1266         # Now we want to check if the line after "\end_inset" is empty. It normally
1267         # is, so we want to remove it, too.
1268         lastline = j + 1
1269         if document.body[j + 1].strip() == "":
1270             lastline = j + 2
1271         document.body[i: lastline] = s
1272         i = i + 1
1273
1274
1275 def revert_math_scale(document):
1276   " Remove math scaling and LaTeX options "
1277   del_token(document.header, '\\html_math_img_scale', 0)
1278   del_token(document.header, '\\html_latex_start', 0)
1279   del_token(document.header, '\\html_latex_end', 0)
1280
1281
1282 def revert_pagesizes(document):
1283   " Revert page sizes to default "
1284   i = find_token(document.header, '\\papersize', 0)
1285   if i != -1:
1286     size = document.header[i][11:]
1287     if size == "a0paper" or size == "a1paper" or size == "a2paper" \
1288     or size == "a6paper" or size == "b0paper" or size == "b1paper" \
1289     or size == "b2paper" or size == "b6paper" or size == "b0j" \
1290     or size == "b1j" or size == "b2j" or size == "b3j" or size == "b4j" \
1291     or size == "b5j" or size == "b6j":
1292       del document.header[i]
1293
1294
1295 def revert_DIN_C_pagesizes(document):
1296   " Revert DIN C page sizes to default "
1297   i = find_token(document.header, '\\papersize', 0)
1298   if i != -1:
1299     size = document.header[i][11:]
1300     if size == "c0paper" or size == "c1paper" or size == "c2paper" \
1301     or size == "c3paper" or size == "c4paper" or size == "c5paper" \
1302     or size == "c6paper":
1303       del document.header[i]
1304
1305
1306 def convert_html_quotes(document):
1307   " Remove quotes around html_latex_start and html_latex_end "
1308
1309   i = find_token(document.header, '\\html_latex_start', 0)
1310   if i != -1:
1311     line = document.header[i]
1312     l = re.compile(r'\\html_latex_start\s+"(.*)"')
1313     m = l.match(line)
1314     if m:
1315       document.header[i] = "\\html_latex_start " + m.group(1)
1316
1317   i = find_token(document.header, '\\html_latex_end', 0)
1318   if i != -1:
1319     line = document.header[i]
1320     l = re.compile(r'\\html_latex_end\s+"(.*)"')
1321     m = l.match(line)
1322     if m:
1323       document.header[i] = "\\html_latex_end " + m.group(1)
1324
1325
1326 def revert_html_quotes(document):
1327   " Remove quotes around html_latex_start and html_latex_end "
1328
1329   i = find_token(document.header, '\\html_latex_start', 0)
1330   if i != -1:
1331     line = document.header[i]
1332     l = re.compile(r'\\html_latex_start\s+(.*)')
1333     m = l.match(line)
1334     if not m:
1335         document.warning("Weird html_latex_start line: " + line)
1336         del document.header[i]
1337     else:
1338         document.header[i] = "\\html_latex_start \"" + m.group(1) + "\""
1339
1340   i = find_token(document.header, '\\html_latex_end', 0)
1341   if i != -1:
1342     line = document.header[i]
1343     l = re.compile(r'\\html_latex_end\s+(.*)')
1344     m = l.match(line)
1345     if not m:
1346         document.warning("Weird html_latex_end line: " + line)
1347         del document.header[i]
1348     else:
1349         document.header[i] = "\\html_latex_end \"" + m.group(1) + "\""
1350
1351
1352 def revert_output_sync(document):
1353   " Remove forward search options "
1354   del_token(document.header, '\\output_sync_macro', 0)
1355   del_token(document.header, '\\output_sync', 0)
1356
1357
1358 def revert_align_decimal(document):
1359   i = 0
1360   while True:
1361     i = find_token(document.body, "\\begin_inset Tabular", i)
1362     if i == -1:
1363       return
1364     j = find_end_of_inset(document.body, i)
1365     if j == -1:
1366       document.warning("Unable to find end of Tabular inset at line " + str(i))
1367       i += 1
1368       continue
1369     cell = find_token(document.body, "<cell", i, j)
1370     if cell == -1:
1371       document.warning("Can't find any cells in Tabular inset at line " + str(i))
1372       i = j
1373       continue
1374     k = i + 1
1375     while True:
1376       k = find_token(document.body, "<column", k, cell)
1377       if k == -1:
1378         return
1379       if document.body[k].find('alignment="decimal"') == -1:
1380         k += 1
1381         continue
1382       remove_option(document.body, k, 'decimal_point')
1383       document.body[k] = \
1384         document.body[k].replace('alignment="decimal"', 'alignment="center"')
1385       k += 1
1386
1387
1388 def convert_optarg(document):
1389   " Convert \\begin_inset OptArg to \\begin_inset Argument "
1390   i = 0
1391   while 1:
1392     i = find_token(document.body, '\\begin_inset OptArg', i)
1393     if i == -1:
1394       return
1395     document.body[i] = "\\begin_inset Argument"
1396     i += 1
1397
1398
1399 def revert_argument(document):
1400   " Convert \\begin_inset Argument to \\begin_inset OptArg "
1401   i = 0
1402   while 1:
1403     i = find_token(document.body, '\\begin_inset Argument', i)
1404     if i == -1:
1405       return
1406     document.body[i] = "\\begin_inset OptArg"
1407     i += 1
1408
1409
1410 def revert_makebox(document):
1411   " Convert \\makebox to TeX code "
1412   i = 0
1413   while 1:
1414     i = find_token(document.body, '\\begin_inset Box', i)
1415     if i == -1:
1416       break
1417     z = find_end_of_inset(document.body, i)
1418     if z == -1:
1419       document.warning("Malformed LyX document: Can't find end of box inset.")
1420       i += 1
1421       continue
1422     blay = find_token(document.body, "\\begin_layout", i, z)
1423     if blay == -1:
1424       document.warning("Malformed LyX document: Can't find layout in box.")
1425       i = z
1426       continue
1427     # by looking before the layout we make sure we're actually finding
1428     # an option, not text.
1429     j = find_token(document.body, 'use_makebox', i, blay)
1430     if j == -1:
1431         i = z
1432         continue
1433
1434     if not check_token(document.body[i], "\\begin_inset Box Frameless") \
1435       or get_value(document.body, 'use_makebox', j) != 1:
1436         del document.body[j]
1437         i = z
1438         continue
1439     bend = find_end_of_layout(document.body, blay)
1440     if bend == -1 or bend > z:
1441         document.warning("Malformed LyX document: Can't find end of layout in box.")
1442         i = z
1443         continue
1444     # determine the alignment
1445     align = get_quoted_value(document.body, 'hor_pos', i, blay, "c")
1446     # determine the width
1447     length = get_quoted_value(document.body, 'width', i, blay, "50col%")
1448     length = latex_length(length)[1]
1449     # remove the \end_layout \end_inset pair
1450     document.body[bend:z + 1] = put_cmd_in_ert("}")
1451     subst = "\\makebox[" + length + "][" \
1452       + align + "]{"
1453     document.body[i:blay + 1] = put_cmd_in_ert(subst)
1454     i += 1
1455
1456
1457 def convert_use_makebox(document):
1458   " Adds use_makebox option for boxes "
1459   i = 0
1460   while 1:
1461     i = find_token(document.body, '\\begin_inset Box', i)
1462     if i == -1:
1463       return
1464     # all of this is to make sure we actually find the use_parbox
1465     # that is an option for this box, not some text elsewhere.
1466     z = find_end_of_inset(document.body, i)
1467     if z == -1:
1468       document.warning("Can't find end of box inset!!")
1469       i += 1
1470       continue
1471     blay = find_token(document.body, "\\begin_layout", i, z)
1472     if blay == -1:
1473       document.warning("Can't find layout in box inset!!")
1474       i = z
1475       continue
1476     # so now we are looking for use_parbox before the box's layout
1477     k = find_token(document.body, 'use_parbox', i, blay)
1478     if k == -1:
1479       document.warning("Malformed LyX document: Can't find use_parbox statement in box.")
1480       i = z
1481       continue
1482     document.body.insert(k + 1, "use_makebox 0")
1483     i = z + 1
1484
1485
1486 def revert_IEEEtran(document):
1487   " Convert IEEEtran layouts and styles to TeX code "
1488   if document.textclass != "IEEEtran":
1489     return
1490   revert_flex_inset(document.body, "IEEE membership", "\\IEEEmembership")
1491   revert_flex_inset(document.body, "Lowercase", "\\MakeLowercase")
1492   layouts = ("Special Paper Notice", "After Title Text", "Publication ID",
1493              "Page headings", "Biography without photo")
1494   latexcmd = {"Special Paper Notice": "\\IEEEspecialpapernotice",
1495               "After Title Text":     "\\IEEEaftertitletext",
1496               "Publication ID":       "\\IEEEpubid"}
1497   obsoletedby = {"Page headings":            "MarkBoth",
1498                  "Biography without photo":  "BiographyNoPhoto"}
1499   for layout in layouts:
1500     i = 0
1501     while True:
1502         i = find_token(document.body, '\\begin_layout ' + layout, i)
1503         if i == -1:
1504           break
1505         j = find_end_of_layout(document.body, i)
1506         if j == -1:
1507           document.warning("Malformed LyX document: Can't find end of " + layout + " layout.")
1508           i += 1
1509           continue
1510         if layout in obsoletedby:
1511           document.body[i] = "\\begin_layout " + obsoletedby[layout]
1512           i = j
1513           continue
1514         content = lyx2latex(document, document.body[i:j + 1])
1515         add_to_preamble(document, [latexcmd[layout] + "{" + content + "}"])
1516         del document.body[i:j + 1]
1517         # no need to reset i
1518
1519
1520 def convert_prettyref(document):
1521         " Converts prettyref references to neutral formatted refs "
1522         re_ref = re.compile("^\s*reference\s+\"(\w+):(\S+)\"")
1523         nm_ref = re.compile("^\s*name\s+\"(\w+):(\S+)\"")
1524
1525         i = 0
1526         while True:
1527                 i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1528                 if i == -1:
1529                         break
1530                 j = find_end_of_inset(document.body, i)
1531                 if j == -1:
1532                         document.warning("Malformed LyX document: No end of InsetRef!")
1533                         i += 1
1534                         continue
1535                 k = find_token(document.body, "LatexCommand prettyref", i, j)
1536                 if k != -1:
1537                         document.body[k] = "LatexCommand formatted"
1538                 i = j + 1
1539         document.header.insert(-1, "\\use_refstyle 0")
1540
1541
1542 def revert_refstyle(document):
1543         " Reverts neutral formatted refs to prettyref "
1544         re_ref = re.compile("^reference\s+\"(\w+):(\S+)\"")
1545         nm_ref = re.compile("^\s*name\s+\"(\w+):(\S+)\"")
1546
1547         i = 0
1548         while True:
1549                 i = find_token(document.body, "\\begin_inset CommandInset ref", i)
1550                 if i == -1:
1551                         break
1552                 j = find_end_of_inset(document.body, i)
1553                 if j == -1:
1554                         document.warning("Malformed LyX document: No end of InsetRef")
1555                         i += 1
1556                         continue
1557                 k = find_token(document.body, "LatexCommand formatted", i, j)
1558                 if k != -1:
1559                         document.body[k] = "LatexCommand prettyref"
1560                 i = j + 1
1561         i = find_token(document.header, "\\use_refstyle", 0)
1562         if i != -1:
1563                 document.header.pop(i)
1564
1565
1566 def revert_nameref(document):
1567   " Convert namerefs to regular references "
1568   cmds = ["Nameref", "nameref"]
1569   foundone = False
1570   rx = re.compile(r'reference "(.*)"')
1571   for cmd in cmds:
1572     i = 0
1573     oldcmd = "LatexCommand " + cmd
1574     while 1:
1575       # It seems better to look for this, as most of the reference
1576       # insets won't be ones we care about.
1577       i = find_token(document.body, oldcmd, i)
1578       if i == -1:
1579         break
1580       cmdloc = i
1581       i += 1
1582       # Make sure it is actually in an inset!
1583       # A normal line could begin with "LatexCommand nameref"!
1584       val = is_in_inset(document.body, cmdloc, \
1585           "\\begin_inset CommandInset ref")
1586       if not val:
1587           continue
1588       stins, endins = val
1589
1590       # ok, so it is in an InsetRef
1591       refline = find_token(document.body, "reference", stins, endins)
1592       if refline == -1:
1593         document.warning("Can't find reference for inset at line " + stinst + "!!")
1594         continue
1595       m = rx.match(document.body[refline])
1596       if not m:
1597         document.warning("Can't match reference line: " + document.body[ref])
1598         continue
1599       foundone = True
1600       ref = m.group(1)
1601       newcontent = put_cmd_in_ert('\\' + cmd + '{' + ref + '}')
1602       document.body[stins:endins + 1] = newcontent
1603
1604   if foundone:
1605     add_to_preamble(document, ["\usepackage{nameref}"])
1606
1607
1608 def remove_Nameref(document):
1609   " Convert Nameref commands to nameref commands "
1610   i = 0
1611   while 1:
1612     # It seems better to look for this, as most of the reference
1613     # insets won't be ones we care about.
1614     i = find_token(document.body, "LatexCommand Nameref" , i)
1615     if i == -1:
1616       break
1617     cmdloc = i
1618     i += 1
1619
1620     # Make sure it is actually in an inset!
1621     val = is_in_inset(document.body, cmdloc, \
1622         "\\begin_inset CommandInset ref")
1623     if not val:
1624       continue
1625     document.body[cmdloc] = "LatexCommand nameref"
1626
1627
1628 def revert_mathrsfs(document):
1629     " Load mathrsfs if \mathrsfs us use in the document "
1630     i = 0
1631     for line in document.body:
1632       if line.find("\\mathscr{") != -1:
1633         add_to_preamble(document, ["\\usepackage{mathrsfs}"])
1634         return
1635
1636
1637 def convert_flexnames(document):
1638     "Convert \\begin_inset Flex Custom:Style to \\begin_inset Flex Style and similarly for CharStyle and Element."
1639
1640     i = 0
1641     rx = re.compile(r'^\\begin_inset Flex (?:Custom|CharStyle|Element):(.+)$')
1642     while True:
1643       i = find_token(document.body, "\\begin_inset Flex", i)
1644       if i == -1:
1645         return
1646       m = rx.match(document.body[i])
1647       if m:
1648         document.body[i] = "\\begin_inset Flex " + m.group(1)
1649       i += 1
1650
1651
1652 flex_insets = {
1653   "Alert" : "CharStyle:Alert",
1654   "Code" : "CharStyle:Code",
1655   "Concepts" : "CharStyle:Concepts",
1656   "E-Mail" : "CharStyle:E-Mail",
1657   "Emph" : "CharStyle:Emph",
1658   "Expression" : "CharStyle:Expression",
1659   "Initial" : "CharStyle:Initial",
1660   "Institute" : "CharStyle:Institute",
1661   "Meaning" : "CharStyle:Meaning",
1662   "Noun" : "CharStyle:Noun",
1663   "Strong" : "CharStyle:Strong",
1664   "Structure" : "CharStyle:Structure",
1665   "ArticleMode" : "Custom:ArticleMode",
1666   "Endnote" : "Custom:Endnote",
1667   "Glosse" : "Custom:Glosse",
1668   "PresentationMode" : "Custom:PresentationMode",
1669   "Tri-Glosse" : "Custom:Tri-Glosse"
1670 }
1671
1672 flex_elements = {
1673   "Abbrev" : "Element:Abbrev",
1674   "CCC-Code" : "Element:CCC-Code",
1675   "Citation-number" : "Element:Citation-number",
1676   "City" : "Element:City",
1677   "Code" : "Element:Code",
1678   "CODEN" : "Element:CODEN",
1679   "Country" : "Element:Country",
1680   "Day" : "Element:Day",
1681   "Directory" : "Element:Directory",
1682   "Dscr" : "Element:Dscr",
1683   "Email" : "Element:Email",
1684   "Emph" : "Element:Emph",
1685   "Filename" : "Element:Filename",
1686   "Firstname" : "Element:Firstname",
1687   "Fname" : "Element:Fname",
1688   "GuiButton" : "Element:GuiButton",
1689   "GuiMenu" : "Element:GuiMenu",
1690   "GuiMenuItem" : "Element:GuiMenuItem",
1691   "ISSN" : "Element:ISSN",
1692   "Issue-day" : "Element:Issue-day",
1693   "Issue-months" : "Element:Issue-months",
1694   "Issue-number" : "Element:Issue-number",
1695   "KeyCap" : "Element:KeyCap",
1696   "KeyCombo" : "Element:KeyCombo",
1697   "Keyword" : "Element:Keyword",
1698   "Literal" : "Element:Literal",
1699   "MenuChoice" : "Element:MenuChoice",
1700   "Month" : "Element:Month",
1701   "Orgdiv" : "Element:Orgdiv",
1702   "Orgname" : "Element:Orgname",
1703   "Postcode" : "Element:Postcode",
1704   "SS-Code" : "Element:SS-Code",
1705   "SS-Title" : "Element:SS-Title",
1706   "State" : "Element:State",
1707   "Street" : "Element:Street",
1708   "Surname" : "Element:Surname",
1709   "Volume" : "Element:Volume",
1710   "Year" : "Element:Year"
1711 }
1712
1713
1714 def revert_flexnames(document):
1715   if document.backend == "latex":
1716     flexlist = flex_insets
1717   else:
1718     flexlist = flex_elements
1719
1720   rx = re.compile(r'^\\begin_inset Flex\s+(.+)$')
1721   i = 0
1722   while True:
1723     i = find_token(document.body, "\\begin_inset Flex", i)
1724     if i == -1:
1725       return
1726     m = rx.match(document.body[i])
1727     if not m:
1728       document.warning("Illegal flex inset: " + document.body[i])
1729       i += 1
1730       continue
1731     style = m.group(1)
1732     if style in flexlist:
1733       document.body[i] = "\\begin_inset Flex " + flexlist[style]
1734     i += 1
1735
1736
1737 def convert_mathdots(document):
1738     " Load mathdots automatically "
1739     i = find_token(document.header, "\\use_esint" , 0)
1740     if i != -1:
1741       document.header.insert(i + 1, "\\use_mathdots 1")
1742
1743
1744 def revert_mathdots(document):
1745     " Load mathdots if used in the document "
1746
1747     mathdots = find_token(document.header, "\\use_mathdots" , 0)
1748     if mathdots == -1:
1749       document.warning("No \\usemathdots line. Assuming auto.")
1750     else:
1751       val = get_value(document.header, "\\use_mathdots", mathdots)
1752       del document.header[mathdots]
1753       try:
1754         usedots = int(val)
1755       except:
1756         document.warning("Invalid \\use_mathdots value: " + val + ". Assuming auto.")
1757         # probably usedots has not been changed, but be safe.
1758         usedots = 1
1759
1760       if usedots == 0:
1761         # do not load case
1762         return
1763       if usedots == 2:
1764         # force load case
1765         add_to_preamble(["\\usepackage{mathdots}"])
1766         return
1767
1768     # so we are in the auto case. we want to load mathdots if \iddots is used.
1769     i = 0
1770     while True:
1771       i = find_token(document.body, '\\begin_inset Formula', i)
1772       if i == -1:
1773         return
1774       j = find_end_of_inset(document.body, i)
1775       if j == -1:
1776         document.warning("Malformed LyX document: Can't find end of Formula inset at line " + str(i))
1777         i += 1
1778         continue
1779       code = "\n".join(document.body[i:j])
1780       if code.find("\\iddots") != -1:
1781         add_to_preamble(document, ["\\@ifundefined{iddots}{\\usepackage{mathdots}}"])
1782         return
1783       i = j
1784
1785
1786 def convert_rule(document):
1787     " Convert \\lyxline to CommandInset line. "
1788     i = 0
1789
1790     inset = ['\\begin_inset CommandInset line',
1791       'LatexCommand rule',
1792       'offset "0.5ex"',
1793       'width "100line%"',
1794       'height "1pt"', '',
1795       '\\end_inset', '', '']
1796
1797     # if paragraphs are indented, we may have to unindent to get the
1798     # line to be full-width.
1799     indent = get_value(document.header, "\\paragraph_separation", 0)
1800     have_indent = (indent == "indent")
1801
1802     while True:
1803       i = find_token(document.body, "\\lyxline" , i)
1804       if i == -1:
1805         return
1806
1807       # we need to find out if this line follows other content
1808       # in its paragraph. find its layout....
1809       lastlay = find_token_backwards(document.body, "\\begin_layout", i)
1810       if lastlay == -1:
1811         document.warning("Can't find layout for line at " + str(i))
1812         # do the best we can.
1813         document.body[i:i+1] = inset
1814         i += len(inset)
1815         continue
1816
1817       # ...and look for other content before it.
1818       lineisfirst = True
1819       for line in document.body[lastlay + 1:i]:
1820         # is it empty or a paragraph option?
1821         if not line or line[0] == '\\':
1822           continue
1823         lineisfirst = False
1824         break
1825
1826       if lineisfirst:
1827         document.body[i:i+1] = inset
1828         if indent:
1829           # we need to unindent, lest the line be too long
1830           document.body.insert(lastlay + 1, "\\noindent")
1831         i += len(inset)
1832       else:
1833         # so our line is in the middle of a paragraph
1834         # we need to add a new line, lest this line follow the
1835         # other content on that line and run off the side of the page
1836         document.body[i:i+1] = inset
1837         document.body[i:i] = ["\\begin_inset Newline newline", "\\end_inset", ""]
1838       i += len(inset)
1839
1840
1841 def revert_rule(document):
1842     " Revert line insets to Tex code "
1843     i = 0
1844     while 1:
1845       i = find_token(document.body, "\\begin_inset CommandInset line" , i)
1846       if i == -1:
1847         return
1848       # find end of inset
1849       j = find_token(document.body, "\\end_inset" , i)
1850       if j == -1:
1851         document.warning("Malformed LyX document: Can't find end of line inset.")
1852         return
1853       # determine the optional offset
1854       offset = get_quoted_value(document.body, 'offset', i, j)
1855       if offset:
1856         offset = '[' + offset + ']'
1857       # determine the width
1858       width = get_quoted_value(document.body, 'width', i, j, "100col%")
1859       width = latex_length(width)[1]
1860       # determine the height
1861       height = get_quoted_value(document.body, 'height', i, j, "1pt")
1862       height = latex_length(height)[1]
1863       # output the \rule command
1864       subst = "\\rule[" + offset + "]{" + width + "}{" + height + "}"
1865       document.body[i:j + 1] = put_cmd_in_ert(subst)
1866       i += len(subst) - (j - i)
1867
1868
1869 def revert_diagram(document):
1870   " Add the feyn package if \\Diagram is used in math "
1871   i = 0
1872   while True:
1873     i = find_token(document.body, '\\begin_inset Formula', i)
1874     if i == -1:
1875       return
1876     j = find_end_of_inset(document.body, i)
1877     if j == -1:
1878         document.warning("Malformed LyX document: Can't find end of Formula inset.")
1879         return
1880     lines = "\n".join(document.body[i:j])
1881     if lines.find("\\Diagram") == -1:
1882       i = j
1883       continue
1884     add_to_preamble(document, ["\\usepackage{feyn}"])
1885     # only need to do it once!
1886     return
1887
1888
1889 def convert_bibtex_clearpage(document):
1890   " insert a clear(double)page bibliographystyle if bibtotoc option is used "
1891
1892   i = find_token(document.header, '\\papersides', 0)
1893   sides = 0
1894   if i == -1:
1895     document.warning("Malformed LyX document: Can't find papersides definition.")
1896     document.warning("Assuming single sided.")
1897     sides = 1
1898   else:
1899     val = get_value(document.header, "\\papersides", i)
1900     try:
1901       sides = int(val)
1902     except:
1903       pass
1904     if sides != 1 and sides != 2:
1905       document.warning("Invalid papersides value: " + val)
1906       document.warning("Assuming single sided.")
1907       sides = 1
1908
1909   j = 0
1910   while True:
1911     j = find_token(document.body, "\\begin_inset CommandInset bibtex", j)
1912     if j == -1:
1913       return
1914
1915     k = find_end_of_inset(document.body, j)
1916     if k == -1:
1917       document.warning("Can't find end of Bibliography inset at line " + str(j))
1918       j += 1
1919       continue
1920
1921     # only act if there is the option "bibtotoc"
1922     val = get_value(document.body, 'options', j, k)
1923     if not val:
1924       document.warning("Can't find options for bibliography inset at line " + str(j))
1925       j = k
1926       continue
1927
1928     if val.find("bibtotoc") == -1:
1929       j = k
1930       continue
1931
1932     # so we want to insert a new page right before the paragraph that
1933     # this bibliography thing is in.
1934     lay = find_token_backwards(document.body, "\\begin_layout", j)
1935     if lay == -1:
1936       document.warning("Can't find layout containing bibliography inset at line " + str(j))
1937       j = k
1938       continue
1939
1940     if sides == 1:
1941       cmd = "clearpage"
1942     else:
1943       cmd = "cleardoublepage"
1944     subst = ['\\begin_layout Standard',
1945         '\\begin_inset Newpage ' + cmd,
1946         '\\end_inset', '', '',
1947         '\\end_layout', '']
1948     document.body[lay:lay] = subst
1949     j = k + len(subst)
1950
1951
1952 def check_passthru(document):
1953   tc = document.textclass
1954   ok = (tc == "literate-article" or tc == "literate-book" or tc == "literate-report")
1955   if not ok:
1956     mods = document.get_module_list()
1957     for mod in mods:
1958       if mod == "sweave" or mod == "noweb":
1959         ok = True
1960         break
1961   return ok
1962
1963
1964 def convert_passthru(document):
1965     " http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg161298.html "
1966     if not check_passthru:
1967       return
1968
1969     rx = re.compile("\\\\begin_layout \s*(\w+)")
1970     beg = 0
1971     for lay in ["Chunk", "Scrap"]:
1972       while True:
1973         beg = find_token(document.body, "\\begin_layout " + lay, beg)
1974         if beg == -1:
1975           break
1976         end = find_end_of_layout(document.body, beg)
1977         if end == -1:
1978           document.warning("Can't find end of layout at line " + str(beg))
1979           beg += 1
1980           continue
1981         # we are now going to replace newline insets within this layout
1982         # by new instances of this layout. so we have repeated layouts
1983         # instead of newlines.
1984         ns = beg
1985         while True:
1986           ns = find_token(document.body, "\\begin_inset Newline newline", ns, end)
1987           if ns == -1:
1988             break
1989           ne = find_end_of_inset(document.body, ns)
1990           if ne == -1 or ne > end:
1991             document.warning("Can't find end of inset at line " + str(nb))
1992             ns += 1
1993             continue
1994           if document.body[ne + 1] == "":
1995             ne += 1
1996           subst = ["\\end_layout", "", "\\begin_layout " + lay]
1997           document.body[ns:ne + 1] = subst
1998           # now we need to adjust end, in particular, but might as well
1999           # do ns properly, too
2000           newlines = (ne - ns) - len(subst)
2001           ns += newlines + 2
2002           end += newlines + 1
2003         # ok, we now want to find out if the next layout is the
2004         # same as this one. if so, we will insert an extra copy of it
2005         didit = False
2006         next = find_token(document.body, "\\begin_layout", end)
2007         if next != -1:
2008           m = rx.match(document.body[next])
2009           if m:
2010             nextlay = m.group(1)
2011             if nextlay == lay:
2012               subst = ["\\begin_layout " + lay, "", "\\end_layout", ""]
2013               document.body[next:next] = subst
2014               didit = True
2015         beg = end + 1
2016         if didit:
2017           beg += 4 # for the extra layout
2018
2019
2020 def revert_passthru(document):
2021     " http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg161298.html "
2022     if not check_passthru:
2023       return
2024     rx = re.compile("\\\\begin_layout \s*(\w+)")
2025     beg = 0
2026     for lay in ["Chunk", "Scrap"]:
2027       while True:
2028         beg = find_token(document.body, "\\begin_layout " + lay, beg)
2029         if beg == -1:
2030           break
2031         end = find_end_of_layout(document.body, beg)
2032         if end == -1:
2033           document.warning("Can't find end of layout at line " + str(beg))
2034           beg += 1
2035           continue
2036
2037         # we now want to find out if the next layout is the
2038         # same as this one. but we will need to do this over and
2039         # over again.
2040         while True:
2041           next = find_token(document.body, "\\begin_layout", end)
2042           if next == -1:
2043             break
2044           m = rx.match(document.body[next])
2045           if not m:
2046             break
2047           nextlay = m.group(1)
2048           if nextlay != lay:
2049             break
2050           # so it is the same layout again. we now want to know if it is empty.
2051           # but first let's check and make sure there is no content between the
2052           # two layouts. i'm not sure if that can happen or not.
2053           for l in range(end + 1, next):
2054             document.warning("c'" + document.body[l] + "'")
2055             if document.body[l] != "":
2056               document.warning("Found content between adjacent " + lay + " layouts!")
2057               break
2058           nextend = find_end_of_layout(document.body, next)
2059           if nextend == -1:
2060             document.warning("Can't find end of layout at line " + str(next))
2061             break
2062           empty = True
2063           for l in range(next + 1, nextend):
2064             document.warning("e'" + document.body[l] + "'")
2065             if document.body[l] != "":
2066               empty = False
2067               break
2068           if empty:
2069             # empty layouts just get removed
2070             # should we check if it's before yet another such layout?
2071             del document.body[next : nextend + 1]
2072             # and we do not want to check again. we know the next layout
2073             # should be another Chunk and should be left as is.
2074             break
2075           else:
2076             # if it's not empty, then we want to insert a newline in place
2077             # of the layout switch
2078             subst = ["\\begin_inset Newline newline", "\\end_inset", ""]
2079             document.body[end : next + 1] = subst
2080             # and now we have to find the end of the new, larger layout
2081             newend = find_end_of_layout(document.body, beg)
2082             if newend == -1:
2083               document.warning("Can't find end of new layout at line " + str(beg))
2084               break
2085             end = newend
2086         beg = end + 1
2087
2088
2089 def revert_multirowOffset(document):
2090     " Revert multirow cells with offset in tables to TeX-code"
2091     i = 0
2092     multirowOffset = False
2093     while True:
2094       # cell type 3 is multirow begin cell
2095       i = find_token(document.body, '<cell multirow="3" mroffset=', i)
2096       if i == -1:
2097           break
2098       # a multirow cell with offset was found
2099       multirowOffset = True
2100       # remove the multirow tag, set the valignment to top
2101       # the the bottom line and offset
2102       document.body[i] = document.body[i].replace(' multirow="3" ', ' ')
2103       document.body[i] = document.body[i].replace('valignment="middle"', 'valignment="top"')
2104       document.body[i] = document.body[i].replace(' bottomline="true" ', ' ')
2105       document.body[i] = document.body[i].replace(' mroffset=', '')
2106       # store the offset and remove it
2107       begin = document.body[i].find('"')
2108       end = document.body[i].find('" ', begin)
2109       offset = document.body[i][begin + 1:end]
2110       document.body[i] = document.body[i].replace(document.body[i][begin:end + 1], '')
2111       # write ERT to create the multirow cell
2112       # use 2 rows and 2cm as default with because the multirow span
2113       # and the column width is only hardly accessible
2114       cend = find_token(document.body, "</cell>", i)
2115       if cend == -1:
2116           document.warning("Malformed LyX document: Could not find end of tabular cell.")
2117           i += 1
2118           continue
2119       blay = find_token(document.body, "\\begin_layout", i, cend)
2120       if blay == -1:
2121           document.warning("Can't find layout for cell!")
2122           i = j
2123           continue
2124       bend = find_end_of_layout(document.body, blay)
2125       if blay == -1:
2126           document.warning("Can't find end of layout for cell!")
2127           i = cend
2128           continue
2129       # do the later one first, so as not to mess up the numbering
2130       # we are wrapping the whole cell in this ert
2131       # so before the end of the layout...
2132       document.body[bend:bend] = put_cmd_in_ert("}")
2133       # ...and after the beginning
2134       document.body[blay+1:blay+1] = put_cmd_in_ert("\\multirow{2}{2cm}[" + offset + "]{")
2135       while True:
2136           # cell type 4 is multirow part cell
2137           k = find_token(document.body, '<cell multirow="4"', cend)
2138           if k == -1:
2139               break
2140           # remove the multirow tag, set the valignment to top
2141           # and remove the top line
2142           document.body[k] = document.body[k].replace(' multirow="4" ', ' ')
2143           document.body[k] = document.body[k].replace('valignment="middle"', 'valignment="top"')
2144           document.body[k] = document.body[k].replace(' topline="true" ', ' ')
2145           k += 1
2146       # this will always be ok
2147       i = cend
2148     if multirowOffset == True:
2149         add_to_preamble(document, ["\\usepackage{multirow}"])
2150
2151
2152 ##
2153 # Conversion hub
2154 #
2155
2156 supported_versions = ["2.0.0","2.0"]
2157 convert = [[346, []],
2158            [347, []],
2159            [348, []],
2160            [349, []],
2161            [350, []],
2162            [351, []],
2163            [352, [convert_splitindex]],
2164            [353, []],
2165            [354, []],
2166            [355, []],
2167            [356, []],
2168            [357, []],
2169            [358, []],
2170            [359, [convert_nomencl_width]],
2171            [360, []],
2172            [361, []],
2173            [362, []],
2174            [363, []],
2175            [364, []],
2176            [365, []],
2177            [366, []],
2178            [367, []],
2179            [368, []],
2180            [369, [convert_author_id]],
2181            [370, []],
2182            [371, []],
2183            [372, []],
2184            [373, [merge_gbrief]],
2185            [374, []],
2186            [375, []],
2187            [376, []],
2188            [377, []],
2189            [378, []],
2190            [379, [convert_math_output]],
2191            [380, []],
2192            [381, []],
2193            [382, []],
2194            [383, []],
2195            [384, []],
2196            [385, []],
2197            [386, []],
2198            [387, []],
2199            [388, []],
2200            [389, [convert_html_quotes]],
2201            [390, []],
2202            [391, []],
2203            [392, []],
2204            [393, [convert_optarg]],
2205            [394, [convert_use_makebox]],
2206            [395, []],
2207            [396, []],
2208            [397, [remove_Nameref]],
2209            [398, []],
2210            [399, [convert_mathdots]],
2211            [400, [convert_rule]],
2212            [401, []],
2213            [402, [convert_bibtex_clearpage]],
2214            [403, [convert_flexnames]],
2215            [404, [convert_prettyref]],
2216            [405, []],
2217            [406, [convert_passthru]],
2218            [407, []]
2219 ]
2220
2221 revert =  [[406, [revert_multirowOffset]],
2222            [405, [revert_passthru]],
2223            [404, []],
2224            [403, [revert_refstyle]],
2225            [402, [revert_flexnames]],
2226            [401, []],
2227            [400, [revert_diagram]],
2228            [399, [revert_rule]],
2229            [398, [revert_mathdots]],
2230            [397, [revert_mathrsfs]],
2231            [396, []],
2232            [395, [revert_nameref]],
2233            [394, [revert_DIN_C_pagesizes]],
2234            [393, [revert_makebox]],
2235            [392, [revert_argument]],
2236            [391, []],
2237            [390, [revert_align_decimal, revert_IEEEtran]],
2238            [389, [revert_output_sync]],
2239            [388, [revert_html_quotes]],
2240            [387, [revert_pagesizes]],
2241            [386, [revert_math_scale]],
2242            [385, [revert_lyx_version]],
2243            [384, [revert_shadedboxcolor]],
2244            [383, [revert_fontcolor]],
2245            [382, [revert_turkmen]],
2246            [381, [revert_notefontcolor]],
2247            [380, [revert_equalspacing_xymatrix]],
2248            [379, [revert_inset_preview]],
2249            [378, [revert_math_output]],
2250            [377, []],
2251            [376, [revert_multirow]],
2252            [375, [revert_includeall]],
2253            [374, [revert_includeonly]],
2254            [373, [revert_html_options]],
2255            [372, [revert_gbrief]],
2256            [371, [revert_fontenc]],
2257            [370, [revert_mhchem]],
2258            [369, [revert_suppress_date]],
2259            [368, [revert_author_id]],
2260            [367, [revert_hspace_glue_lengths]],
2261            [366, [revert_percent_vspace_lengths, revert_percent_hspace_lengths]],
2262            [365, [revert_percent_skip_lengths]],
2263            [364, [revert_paragraph_indentation]],
2264            [363, [revert_branch_filename]],
2265            [362, [revert_longtable_align]],
2266            [361, [revert_applemac]],
2267            [360, []],
2268            [359, [revert_nomencl_cwidth]],
2269            [358, [revert_nomencl_width]],
2270            [357, [revert_custom_processors]],
2271            [356, [revert_ulinelatex]],
2272            [355, []],
2273            [354, [revert_strikeout]],
2274            [353, [revert_printindexall]],
2275            [352, [revert_subindex]],
2276            [351, [revert_splitindex]],
2277            [350, [revert_backgroundcolor]],
2278            [349, [revert_outputformat]],
2279            [348, [revert_xetex]],
2280            [347, [revert_phantom, revert_hphantom, revert_vphantom]],
2281            [346, [revert_tabularvalign]],
2282            [345, [revert_swiss]]
2283           ]
2284
2285
2286 if __name__ == "__main__":
2287     pass