lib/lyx2lyx/lyxconvert_218.py

   1 # This file is part of lyx2lyx
   2 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>
   3 #
   4 # This program is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU General Public License
   6 # as published by the Free Software Foundation; either version 2
   7 # of the License, or (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17
  18
  19 import sys,string,re
  20 from parser_tools import *
  21
  22 floats = {
  23     "footnote": ["\\begin_inset Foot",
  24                  "collapsed true"],
  25     "margin":   ["\\begin_inset Marginal",
  26                  "collapsed true"],
  27     "fig":      ["\\begin_inset Float figure",
  28                  "wide false",
  29                  "collapsed false"],
  30     "tab":      ["\\begin_inset Float table",
  31                  "wide false",
  32                  "collapsed false"],
  33     "alg":      ["\\begin_inset Float algorithm",
  34                  "wide false",
  35                  "collapsed false"],
  36     "wide-fig": ["\\begin_inset Float figure",
  37                  "wide true",
  38                  "collapsed false"],
  39     "wide-tab": ["\\begin_inset Float table",
  40                  "wide true",
  41                  "collapsed false"]
  42 }
  43
  44 font_tokens = ["\\family", "\\series", "\\shape", "\\size", "\\emph",
  45                "\\bar", "\\noun", "\\color", "\\lang", "\\latex"]
  46
  47 pextra_type3_rexp = re.compile(r".*\\pextra_type\s+3")
  48 pextra_rexp = re.compile(r"\\pextra_type\s+(\S+)"+\
  49                          r"(\s+\\pextra_alignment\s+(\S+))?"+\
  50                          r"(\s+\\pextra_hfill\s+(\S+))?"+\
  51                          r"(\s+\\pextra_start_minipage\s+(\S+))?"+\
  52                          r"(\s+(\\pextra_widthp?)\s+(\S*))?")
  53
  54 def get_width(mo):
  55     if mo.group(10):
  56         if mo.group(9) == "\\pextra_widthp":
  57             return mo.group(10)+"col%"
  58         else:
  59             return mo.group(10)
  60     else:
  61         return "100col%"
  62
  63 #
  64 # Change \begin_float .. \end_float into \begin_inset Float .. \end_inset
  65 #
  66
  67 def remove_oldfloat(lines, language):
  68     i = 0
  69     while 1:
  70         i = find_token(lines, "\\begin_float", i)
  71         if i == -1:
  72             break
  73         # There are no nested floats, so finding the end of the float is simple
  74         j = find_token(lines, "\\end_float", i+1)
  75
  76         floattype = string.split(lines[i])[1]
  77         if not floats.has_key(floattype):
  78             sys.stderr.write("Error! Unknown float type "+floattype+"\n")
  79             floattype = "fig"
  80
  81         # skip \end_deeper tokens
  82         i2 = i+1
  83         while check_token(lines[i2], "\\end_deeper"):
  84             i2 = i2+1
  85         if i2 > i+1:
  86             j2 = get_next_paragraph(lines, j+1)
  87             lines[j2:j2] = ["\\end_deeper "]*(i2-(i+1))
  88
  89         new = floats[floattype]+[""]
  90
  91         # Check if the float is floatingfigure
  92         k = find_re(lines, pextra_type3_rexp, i, j)
  93         if k != -1:
  94             mo = pextra_rexp.search(lines[k])
  95             width = get_width(mo)
  96             lines[k] = re.sub(pextra_rexp, "", lines[k])
  97             new = ["\\begin_inset Wrap figure",
  98                    'width "%s"' % width,
  99                    "collapsed false",
 100                    ""]
 101
 102         new = new+lines[i2:j]+["\\end_inset ", ""]
 103
 104         # After a float, all font attributes are reseted.
 105         # We need to output '\foo default' for every attribute foo
 106         # whose value is not default before the float.
 107         # The check here is not accurate, but it doesn't matter
 108         # as extra '\foo default' commands are ignored.
 109         # In fact, it might be safer to output '\foo default' for all
 110         # font attributes.
 111         k = get_paragraph(lines, i)
 112         flag = 0
 113         for token in font_tokens:
 114             if find_token(lines, token, k, i) != -1:
 115                 if not flag:
 116                     # This is not necessary, but we want the output to be
 117                     # as similar as posible to the lyx format
 118                     flag = 1
 119                     new.append("")
 120                 if token == "\\lang":
 121                     new.append(token+" "+language)
 122                 else:
 123                     new.append(token+" default ")
 124
 125         lines[i:j+1] = new
 126         i = i+1
 127
 128 pextra_type2_rexp = re.compile(r".*\\pextra_type\s+[12]")
 129 pextra_type2_rexp2 = re.compile(r".*(\\layout|\\pextra_type\s+2)")
 130
 131 def remove_pextra(lines):
 132     i = 0
 133     flag = 0
 134     while 1:
 135         i = find_re(lines, pextra_type2_rexp, i)
 136         if i == -1:
 137             break
 138
 139         mo = pextra_rexp.search(lines[i])
 140         width = get_width(mo)
 141
 142         if mo.group(1) == "1":
 143             # handle \pextra_type 1 (indented paragraph)
 144             lines[i] = re.sub(pextra_rexp, "\\leftindent "+width+" ", lines[i])
 145             i = i+1
 146             continue
 147
 148         # handle \pextra_type 2 (minipage)
 149         position = mo.group(3)
 150         hfill = mo.group(5)
 151         lines[i] = re.sub(pextra_rexp, "", lines[i])
 152
 153         start = ["\\begin_inset Minipage",
 154                  "position " + position,
 155                  "inner_position 0",
 156                  'height "0pt"',
 157                  'width "%s"' % width,
 158                  "collapsed false"
 159                  ]
 160         if flag:
 161             flag = 0
 162             if hfill:
 163                 start = ["","\hfill",""]+start
 164         else:
 165             start = ["\\layout Standard"] + start
 166
 167         j = find_token_backwards(lines,"\\layout", i-1)
 168         j0 = j
 169
 170         j = find_tokens(lines, ["\\layout", "\\end_float"], i+1)
 171         # j can be -1
 172
 173         count = 0
 174         while 1:
 175             # collect more paragraphs to the minipage
 176             count = count+1
 177             if j == -1 or not check_token(lines[j], "\\layout"):
 178                 break
 179             i = find_re(lines, pextra_type2_rexp2, j+1)
 180             if i == -1:
 181                 break
 182             mo = pextra_rexp.search(lines[i])
 183             if not mo:
 184                 break
 185             if mo.group(7) == "1":
 186                 flag = 1
 187                 break
 188             lines[i] = re.sub(pextra_rexp, "", lines[i])
 189             j = find_tokens(lines, ["\\layout", "\\end_float"], i+1)
 190
 191         mid = lines[j0:j]
 192         end = ["\\end_inset "]
 193
 194         lines[j0:j] = start+mid+end
 195         i = i+1
 196
 197 def is_empty(lines):
 198     return filter(is_nonempty_line, lines) == []
 199
 200 move_rexp =  re.compile(r"\\(family|series|shape|size|emph|numeric|bar|noun|end_deeper)")
 201 ert_rexp = re.compile(r"\\begin_inset|.*\\SpecialChar")
 202 spchar_rexp = re.compile(r"(.*)(\\SpecialChar.*)")
 203 ert_begin = ["\\begin_inset ERT",
 204              "status Collapsed",
 205              "",
 206              "\\layout Standard"]
 207
 208 def remove_oldert(lines):
 209     i = 0
 210     while 1:
 211         i = find_tokens(lines, ["\\latex latex", "\\layout LaTeX"], i)
 212         if i == -1:
 213             break
 214         j = i+1
 215         while 1:
 216             # \end_inset is for ert inside a tabular cell. The other tokens
 217             # are obvious.
 218             j = find_tokens(lines, ["\\latex default", "\\layout", "\\begin_inset", "\\end_inset", "\\end_float", "\\the_end"],
 219                             j)
 220             if check_token(lines[j], "\\begin_inset"):
 221                 j = find_end_of_inset(lines, j)+1
 222             else:
 223                 break
 224
 225         if check_token(lines[j], "\\layout"):
 226             while j-1 >= 0 and check_token(lines[j-1], "\\begin_deeper"):
 227                 j = j-1
 228
 229         # We need to remove insets, special chars & font commands from ERT text
 230         new = []
 231         new2 = []
 232         if check_token(lines[i], "\\layout LaTeX"):
 233             new = ["\layout Standard", "", ""]
 234             # We have a problem with classes in which Standard is not the default layout!
 235
 236         k = i+1
 237         while 1:
 238             k2 = find_re(lines, ert_rexp, k, j)
 239             inset = specialchar = 0
 240             if k2 == -1:
 241                 k2 = j
 242             elif check_token(lines[k2], "\\begin_inset"):
 243                 inset = 1
 244             else:
 245                 specialchar = 1
 246                 mo = spchar_rexp.match(lines[k2])
 247                 lines[k2] = mo.group(1)
 248                 specialchar_str = mo.group(2)
 249                 k2 = k2+1
 250
 251             tmp = []
 252             for line in lines[k:k2]:
 253                 # Move some lines outside the ERT inset:
 254                 if move_rexp.match(line):
 255                     if new2 == []:
 256                         # This is not necessary, but we want the output to be
 257                         # as similar as posible to the lyx format
 258                         new2 = [""]
 259                     new2.append(line)
 260                 elif not check_token(line, "\\latex"):
 261                     tmp.append(line)
 262
 263             if is_empty(tmp):
 264                 if filter(lambda x:x != "", tmp) != []:
 265                     if new == []:
 266                         # This is not necessary, but we want the output to be
 267                         # as similar as posible to the lyx format
 268                         lines[i-1] = lines[i-1]+" "
 269                     else:
 270                         new = new+[" "]
 271             else:
 272                 new = new+ert_begin+tmp+["\\end_inset ", ""]
 273
 274             if inset:
 275                 k3 = find_end_of_inset(lines, k2)
 276                 new = new+[""]+lines[k2:k3+1]+[""] # Put an empty line after \end_inset
 277                 k = k3+1
 278                 # Skip the empty line after \end_inset
 279                 if not is_nonempty_line(lines[k]):
 280                     k = k+1
 281                     new.append("")
 282             elif specialchar:
 283                 if new == []:
 284                     # This is not necessary, but we want the output to be
 285                     # as similar as posible to the lyx format
 286                     lines[i-1] = lines[i-1]+specialchar_str
 287                     new = [""]
 288                 else:
 289                     new = new+[specialchar_str, ""]
 290                 k = k2
 291             else:
 292                 break
 293
 294         new = new+new2
 295         if not check_token(lines[j], "\\latex "):
 296             new = new+[""]+[lines[j]]
 297         lines[i:j+1] = new
 298         i = i+1
 299
 300     # Delete remaining "\latex xxx" tokens
 301     i = 0
 302     while 1:
 303         i = find_token(lines, "\\latex ", i)
 304         if i == -1:
 305             break
 306         del lines[i]
 307
 308 # ERT insert are hidden feature of lyx 1.1.6. This might be removed in the future.
 309 def remove_oldertinset(lines):
 310     i = 0
 311     while 1:
 312         i = find_token(lines, "\\begin_inset ERT", i)
 313         if i == -1:
 314             break
 315         j = find_end_of_inset(lines, i)
 316         k = find_token(lines, "\\layout", i+1)
 317         l = get_paragraph(lines, i)
 318         if lines[k] == lines[l]: # same layout
 319             k = k+1
 320         new = lines[k:j]
 321         lines[i:j+1] = new
 322         i = i+1
 323
 324 def is_ert_paragraph(lines, i):
 325     if not check_token(lines[i], "\\layout Standard"):
 326         return 0
 327
 328     i = find_nonempty_line(lines, i+1)
 329     if not check_token(lines[i], "\\begin_inset ERT"):
 330         return 0
 331
 332     j = find_end_of_inset(lines, i)
 333     k = find_nonempty_line(lines, j+1)
 334     return check_token(lines[k], "\\layout")
 335
 336 def combine_ert(lines):
 337     i = 0
 338     while 1:
 339         i = find_token(lines, "\\begin_inset ERT", i)
 340         if i == -1:
 341             break
 342         j = get_paragraph(lines, i)
 343         count = 0
 344         text = []
 345         while is_ert_paragraph(lines, j):
 346
 347             count = count+1
 348             i2 = find_token(lines, "\\layout", j+1)
 349             k = find_token(lines, "\\end_inset", i2+1)
 350             text = text+lines[i2:k]
 351             j = find_token(lines, "\\layout", k+1)
 352             if j == -1:
 353                 break
 354
 355         if count >= 2:
 356             j = find_token(lines, "\\layout", i+1)
 357             lines[j:k] = text
 358
 359         i = i+1
 360
 361 oldunits = ["pt", "cm", "in", "text%", "col%"]
 362
 363 def get_length(lines, name, start, end):
 364     i = find_token(lines, name, start, end)
 365     if i == -1:
 366         return ""
 367     x = string.split(lines[i])
 368     return x[2]+oldunits[int(x[1])]
 369
 370 def write_attribute(x, token, value):
 371     if value != "":
 372         x.append("\t"+token+" "+value)
 373
 374 def remove_figinset(lines):
 375     i = 0
 376     while 1:
 377         i = find_token(lines, "\\begin_inset Figure", i)
 378         if i == -1:
 379             break
 380         j = find_end_of_inset(lines, i)
 381
 382         lyxwidth = string.split(lines[i])[3]+"pt"
 383         lyxheight = string.split(lines[i])[4]+"pt"
 384
 385         filename = get_value(lines, "file", i+1, j)
 386
 387         width = get_length(lines, "width", i+1, j)
 388         # what does width=5 mean ?
 389         height = get_length(lines, "height", i+1, j)
 390         rotateAngle = get_value(lines, "angle", i+1, j)
 391         if width == "" and height == "":
 392             size_type = "0"
 393         else:
 394             size_type = "1"
 395
 396         flags = get_value(lines, "flags", i+1, j)
 397         x = int(flags)%4
 398         if x == 1:
 399             display = "monochrome"
 400         elif x == 2:
 401             display = "gray"
 402         else:
 403             display = "color"
 404
 405         subcaptionText = get_value(lines, "subcaption", i+1, j)
 406         if subcaptionText != "":
 407             subcaptionText = '"'+subcaptionText+'"'
 408         k = find_token(lines, "subfigure", i+1,j)
 409         if k == -1:
 410             subcaption = 0
 411         else:
 412             subcaption = 1
 413
 414         new = ["\\begin_inset Graphics FormatVersion 1"]
 415         write_attribute(new, "filename", filename)
 416         write_attribute(new, "display", display)
 417         if subcaption:
 418             new.append("\tsubcaption")
 419         write_attribute(new, "subcaptionText", subcaptionText)
 420         write_attribute(new, "size_type", size_type)
 421         write_attribute(new, "width", width)
 422         write_attribute(new, "height", height)
 423         if rotateAngle != "":
 424             new.append("\trotate")
 425             write_attribute(new, "rotateAngle", rotateAngle)
 426         write_attribute(new, "rotateOrigin", "leftBaseline")
 427         write_attribute(new, "lyxsize_type", "1")
 428         write_attribute(new, "lyxwidth", lyxwidth)
 429         write_attribute(new, "lyxheight", lyxheight)
 430         new = new + ["\end_inset"]
 431         lines[i:j+1] = new
 432
 433 attr_re = re.compile(r' \w*="(false|0|)"')
 434 line_re = re.compile(r'<(features|column|row|cell)')
 435
 436 def update_tabular(lines):
 437     i = 0
 438     while 1:
 439         i = find_token(lines, '\\begin_inset  Tabular', i)
 440         if i == -1:
 441             break
 442
 443         for k in get_tabular_lines(lines, i):
 444             if check_token(lines[k], "<lyxtabular"):
 445                 lines[k] = string.replace(lines[k], 'version="2"', 'version="3"')
 446             elif check_token(lines[k], "<column"):
 447                 lines[k] = string.replace(lines[k], 'width=""', 'width="0pt"')
 448
 449             if line_re.match(lines[k]):
 450                 lines[k] = re.sub(attr_re, "", lines[k])
 451
 452         i = i+1
 453
 454 # Figure insert are hidden feature of lyx 1.1.6. This might be removed in the future.
 455 def fix_oldfloatinset(lines):
 456     i = 0
 457     while 1:
 458         i = find_token(lines, "\\begin_inset Float ", i)
 459         if i == -1:
 460             break
 461         j = find_token(lines, "collapsed", i)
 462         if j != -1:
 463             lines[j:j] = ["wide false"]
 464         i = i+1
 465
 466 def change_listof(lines):
 467     i = 0
 468     while 1:
 469         i = find_token(lines, "\\begin_inset LatexCommand \\listof", i)
 470         if i == -1:
 471             break
 472         type = lines[i][33:-3]
 473         lines[i] = "\\begin_inset FloatList "+type
 474         i = i+1
 475
 476 def change_preamble(lines):
 477     i = find_token(lines, "\\use_amsmath", 0)
 478     if i == -1:
 479         return
 480     lines[i+1:i+1] = ["\\use_natbib 0",
 481                       "\use_numerical_citations 0"]
 482
 483 def convert(header, body):
 484     language = get_value(header, "\\language", 0)
 485     if language == "":
 486         language = "english"
 487
 488     change_preamble(header)
 489     change_listof(body)
 490     fix_oldfloatinset(body)
 491     update_tabular(body)
 492     remove_pextra(body)
 493     remove_oldfloat(body, language)
 494     remove_figinset(body)
 495     remove_oldertinset(body)
 496     remove_oldert(body)
 497     combine_ert(body)
 498
 499 if __name__ == "__main__":
 500     pass