lib/lyx2lyx/LyX.py

   1 # This file is part of lyx2lyx
   2 # -*- coding: utf-8 -*-
   3 # Copyright (C) 2002-2004 Dekel Tsur <dekel@lyx.org>
   4 # Copyright (C) 2002-2006 José Matos <jamatos@lyx.org>
   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 from parser_tools import get_value, check_token, find_token,\
  21      find_tokens, find_end_of
  22 import os.path
  23 import gzip
  24 import sys
  25 import re
  26 import time
  27
  28 import lyx2lyx_version
  29 version_lyx2lyx = lyx2lyx_version.version
  30
  31 default_debug_level = 2
  32
  33 ####################################################################
  34 # Private helper functions
  35
  36 def find_end_of_inset(lines, i):
  37     " Find beginning of inset, where lines[i] is included."
  38     return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
  39
  40 def generate_minor_versions(major, last_minor_version):
  41     """ Generate minor versions, using major as prefix and minor
  42     versions from 0 until last_minor_version, plus the generic version.
  43
  44     Example:
  45
  46       generate_minor_versions("1.2", 4) ->
  47       [ "1.2", "1.2.0", "1.2.1", "1.2.2", "1.2.3"]
  48     """
  49     return [major] + [major + ".%d" % i for i in range(last_minor_version + 1)]
  50
  51
  52 # End of helper functions
  53 ####################################################################
  54
  55
  56 # Regular expressions used
  57 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
  58 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
  59 original_version = re.compile(r".*?LyX ([\d.]*)")
  60
  61 ##
  62 # file format information:
  63 #  file, supported formats, stable release versions
  64 format_relation = [("0_06",    [200], generate_minor_versions("0.6" , 4)),
  65                    ("0_08",    [210], generate_minor_versions("0.8" , 6) + ["0.7"]),
  66                    ("0_10",    [210], generate_minor_versions("0.10", 7) + ["0.9"]),
  67                    ("0_12",    [215], generate_minor_versions("0.12", 1) + ["0.11"]),
  68                    ("1_0",     [215], generate_minor_versions("1.0" , 4)),
  69                    ("1_1",     [215], generate_minor_versions("1.1" , 4)),
  70                    ("1_1_5",   [216], ["1.1.5","1.1.5.1","1.1.5.2","1.1"]),
  71                    ("1_1_6_0", [217], ["1.1.6","1.1.6.1","1.1.6.2","1.1"]),
  72                    ("1_1_6_3", [218], ["1.1.6.3","1.1.6.4","1.1"]),
  73                    ("1_2",     [220], generate_minor_versions("1.2" , 4)),
  74                    ("1_3",     [221], generate_minor_versions("1.3" , 7)),
  75                    ("1_4", range(222,246), generate_minor_versions("1.4" , 3)),
  76                    ("1_5", range(246,249), generate_minor_versions("1.5" , 0))]
  77
  78
  79 def formats_list():
  80     " Returns a list with supported file formats."
  81     formats = []
  82     for version in format_relation:
  83         for format in version[1]:
  84             if format not in formats:
  85                 formats.append(format)
  86     return formats
  87
  88
  89 def get_end_format():
  90     " Returns the more recent file format available."
  91     return format_relation[-1][1][-1]
  92
  93
  94 def get_backend(textclass):
  95     " For _textclass_ returns its backend."
  96     if textclass == "linuxdoc" or textclass == "manpage":
  97         return "linuxdoc"
  98     if textclass[:7] == "docbook":
  99         return "docbook"
 100     return "latex"
 101
 102
 103 def trim_eol(line):
 104     " Remove end of line char(s)."
 105     if line[-2:-1] == '\r':
 106         return line[:-2]
 107     else:
 108         return line[:-1]
 109
 110
 111 def get_encoding(language, inputencoding):
 112     from lyx2lyx_lang import lang
 113     if inputencoding == "auto":
 114         return lang[language][3]
 115     if inputencoding == "default" or inputencoding == "":
 116         return "latin1"
 117     # python does not know the alias latin9
 118     if inputencoding == "latin9":
 119         return "iso-8859-15"
 120     return inputencoding
 121
 122 ##
 123 # Class
 124 #
 125 class LyX_Base:
 126     """This class carries all the information of the LyX file."""
 127     def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level, try_hard = 0):
 128         """Arguments:
 129         end_format: final format that the file should be converted. (integer)
 130         input: the name of the input source, if empty resort to standard input.
 131         output: the name of the output file, if empty use the standard output.
 132         error: the name of the error file, if empty use the standard error.
 133         debug: debug level, O means no debug, as its value increases be more verbose.
 134         """
 135         self.choose_io(input, output)
 136
 137         if error:
 138             self.err = open(error, "w")
 139         else:
 140             self.err = sys.stderr
 141
 142         self.debug = debug
 143         self.try_hard = try_hard
 144
 145         if end_format:
 146             self.end_format = self.lyxformat(end_format)
 147         else:
 148             self.end_format = get_end_format()
 149
 150         self.backend = "latex"
 151         self.textclass = "article"
 152         # This is a hack: We use '' since we don't know the default
 153         # layout of the text class. LyX will parse it as default layout.
 154         # FIXME: Read the layout file and use the real default layout
 155         self.default_layout = ''
 156         self.header = []
 157         self.preamble = []
 158         self.body = []
 159         self.status = 0
 160         self.encoding = "auto"
 161
 162
 163     def warning(self, message, debug_level= default_debug_level):
 164         " Emits warning to self.error, if the debug_level is less than the self.debug."
 165         if debug_level <= self.debug:
 166             self.err.write("Warning: " + message + "\n")
 167
 168
 169     def error(self, message):
 170         " Emits a warning and exits if not in try_hard mode."
 171         self.warning(message)
 172         if not self.try_hard:
 173             self.warning("Quiting.")
 174             sys.exit(1)
 175
 176         self.status = 2
 177
 178
 179     def read(self):
 180         """Reads a file into the self.header and self.body parts, from self.input."""
 181
 182         while 1:
 183             line = self.input.readline()
 184             if not line:
 185                 self.error("Invalid LyX file.")
 186
 187             line = trim_eol(line)
 188             if check_token(line, '\\begin_preamble'):
 189                 while 1:
 190                     line = self.input.readline()
 191                     if not line:
 192                         self.error("Invalid LyX file.")
 193
 194                     line = trim_eol(line)
 195                     if check_token(line, '\\end_preamble'):
 196                         break
 197
 198                     if line.split()[:0] in ("\\layout", "\\begin_layout", "\\begin_body"):
 199                         self.warning("Malformed LyX file: Missing '\\end_preamble'.")
 200                         self.warning("Adding it now and hoping for the best.")
 201
 202                     self.preamble.append(line)
 203
 204             if check_token(line, '\\end_preamble'):
 205                 continue
 206
 207             line = line.strip()
 208             if not line:
 209                 continue
 210
 211             if line.split()[0] in ("\\layout", "\\begin_layout", "\\begin_body"):
 212                 self.body.append(line)
 213                 break
 214
 215             self.header.append(line)
 216
 217         self.textclass = get_value(self.header, "\\textclass", 0)
 218         self.backend = get_backend(self.textclass)
 219         self.format  = self.read_format()
 220         self.language = get_value(self.header, "\\language", 0, default = "english")
 221         self.inputencoding = get_value(self.header, "\\inputencoding", 0, default = "auto")
 222         self.encoding = get_encoding(self.language, self.inputencoding)
 223         self.initial_version = self.read_version()
 224
 225         # Second pass over header and preamble, now we know the file encoding
 226         for i in range(len(self.header)):
 227             self.header[i] = self.header[i].decode(self.encoding)
 228         for i in range(len(self.preamble)):
 229             self.preamble[i] = self.preamble[i].decode(self.encoding)
 230
 231         # Read document body
 232         while 1:
 233             line = self.input.readline().decode(self.encoding)
 234             if not line:
 235                 break
 236             self.body.append(trim_eol(line))
 237
 238
 239     def write(self):
 240         " Writes the LyX file to self.output."
 241         self.set_version()
 242         self.set_format()
 243
 244         if self.preamble:
 245             i = find_token(self.header, '\\textclass', 0) + 1
 246             preamble = ['\\begin_preamble'] + self.preamble + ['\\end_preamble']
 247             if i == 0:
 248                 self.error("Malformed LyX file: Missing '\\textclass'.")
 249             else:
 250                 header = self.header[:i] + preamble + self.header[i:]
 251         else:
 252             header = self.header
 253
 254         for line in header + [''] + self.body:
 255             self.output.write(line.encode(self.encoding)+"\n")
 256
 257
 258     def choose_io(self, input, output):
 259         """Choose input and output streams, dealing transparently with
 260         compressed files."""
 261
 262         if output:
 263             self.output = open(output, "wb")
 264         else:
 265             self.output = sys.stdout
 266
 267         if input and input != '-':
 268             self.dir = os.path.dirname(os.path.abspath(input))
 269             try:
 270                 gzip.open(input).readline()
 271                 self.input = gzip.open(input)
 272                 self.output = gzip.GzipFile(mode="wb", fileobj=self.output)
 273             except:
 274                 self.input = open(input)
 275         else:
 276             self.dir = ''
 277             self.input = sys.stdin
 278
 279
 280     def lyxformat(self, format):
 281         " Returns the file format representation, an integer."
 282         result = format_re.match(format)
 283         if result:
 284             format = int(result.group(1) + result.group(2))
 285         elif format == '2':
 286             format = 200
 287         else:
 288             self.error(str(format) + ": " + "Invalid LyX file.")
 289
 290         if format in formats_list():
 291             return format
 292
 293         self.error(str(format) + ": " + "Format not supported.")
 294         return None
 295
 296
 297     def read_version(self):
 298         """ Searchs for clues of the LyX version used to write the file, returns the
 299         most likely value, or None otherwise."""
 300         for line in self.header:
 301             if line[0] != "#":
 302                 return None
 303
 304             line = line.replace("fix",".")
 305             result = original_version.match(line)
 306             if result:
 307                 # Special know cases: reLyX and KLyX
 308                 if line.find("reLyX") != -1 or line.find("KLyX") != -1:
 309                     return "0.12"
 310
 311                 res = result.group(1)
 312                 if not res:
 313                     self.warning(line)
 314                 #self.warning("Version %s" % result.group(1))
 315                 return res
 316         self.warning(str(self.header[:2]))
 317         return None
 318
 319
 320     def set_version(self):
 321         " Set the header with the version used."
 322         self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version_lyx2lyx
 323         if self.header[1][0] == '#':
 324             del self.header[1]
 325
 326
 327     def read_format(self):
 328         " Read from the header the fileformat of the present LyX file."
 329         for line in self.header:
 330             result = fileformat.match(line)
 331             if result:
 332                 return self.lyxformat(result.group(1))
 333         else:
 334             self.error("Invalid LyX File.")
 335         return None
 336
 337
 338     def set_format(self):
 339         " Set the file format of the file, in the header."
 340         if self.format <= 217:
 341             format = str(float(self.format)/100)
 342         else:
 343             format = str(self.format)
 344         i = find_token(self.header, "\\lyxformat", 0)
 345         self.header[i] = "\\lyxformat %s" % format
 346
 347
 348     def set_parameter(self, param, value):
 349         " Set the value of the header parameter."
 350         i = find_token(self.header, '\\' + param, 0)
 351         if i == -1:
 352             self.warning('Parameter not found in the header: %s' % param, 3)
 353             return
 354         self.header[i] = '\\%s %s' % (param, str(value))
 355
 356
 357     def is_default_layout(self, layout):
 358         " Check whether a layout is the default layout of this class."
 359         # FIXME: Check against the real text class default layout
 360         if layout == 'Standard' or layout == self.default_layout:
 361             return 1
 362         return 0
 363
 364
 365     def convert(self):
 366         "Convert from current (self.format) to self.end_format."
 367         mode, convertion_chain = self.chain()
 368         self.warning("convertion chain: " + str(convertion_chain), 3)
 369
 370         for step in convertion_chain:
 371             steps = getattr(__import__("lyx_" + step), mode)
 372
 373             self.warning("Convertion step: %s - %s" % (step, mode), default_debug_level + 1)
 374             if not steps:
 375                     self.error("The convertion to an older format (%s) is not implemented." % self.format)
 376
 377             multi_conv = len(steps) != 1
 378             for version, table in steps:
 379                 if multi_conv and \
 380                    (self.format >= version and mode == "convert") or\
 381                    (self.format <= version and mode == "revert"):
 382                     continue
 383
 384                 for conv in table:
 385                     init_t = time.time()
 386                     try:
 387                         conv(self)
 388                     except:
 389                         self.warning("An error ocurred in %s, %s" % (version, str(conv)),
 390                                      default_debug_level)
 391                         if not self.try_hard:
 392                             raise
 393                         self.status = 2
 394                     else:
 395                         self.warning("%lf: Elapsed time on %s"  % (time.time() - init_t, str(conv)),
 396                                      default_debug_level + 1)
 397
 398                 self.format = version
 399                 if self.end_format == self.format:
 400                     return
 401
 402
 403     def chain(self):
 404         """ This is where all the decisions related with the convertion are taken.
 405         It returns a list of modules needed to convert the LyX file from
 406         self.format to self.end_format"""
 407
 408         self.start =  self.format
 409         format = self.format
 410         correct_version = 0
 411
 412         for rel in format_relation:
 413             if self.initial_version in rel[2]:
 414                 if format in rel[1]:
 415                     initial_step = rel[0]
 416                     correct_version = 1
 417                     break
 418
 419         if not correct_version:
 420             if format <= 215:
 421                 self.warning("Version does not match file format, discarding it. (Version %s, format %d)" %(self.initial_version, self.format))
 422             for rel in format_relation:
 423                 if format in rel[1]:
 424                     initial_step = rel[0]
 425                     break
 426             else:
 427                 # This should not happen, really.
 428                 self.error("Format not supported.")
 429
 430         # Find the final step
 431         for rel in format_relation:
 432             if self.end_format in rel[1]:
 433                 final_step = rel[0]
 434                 break
 435         else:
 436             self.error("Format not supported.")
 437
 438         # Convertion mode, back or forth
 439         steps = []
 440         if (initial_step, self.start) < (final_step, self.end_format):
 441             mode = "convert"
 442             first_step = 1
 443             for step in format_relation:
 444                 if  initial_step <= step[0] <= final_step:
 445                     if first_step and len(step[1]) == 1:
 446                         first_step = 0
 447                         continue
 448                     steps.append(step[0])
 449         else:
 450             mode = "revert"
 451             relation_format = format_relation[:]
 452             relation_format.reverse()
 453             last_step = None
 454
 455             for step in relation_format:
 456                 if  final_step <= step[0] <= initial_step:
 457                     steps.append(step[0])
 458                     last_step = step
 459
 460             if last_step[1][-1] == self.end_format:
 461                 steps.pop()
 462
 463         return mode, steps
 464
 465
 466     def get_toc(self, depth = 4):
 467         " Returns the TOC of this LyX document."
 468         paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, 'Subsection' : 3, 'Subsubsection': 4}
 469         allowed_insets = ['Quotes']
 470         allowed_parameters = '\\paragraph_spacing', '\\noindent', '\\align', '\\labelwidthstring', "\\start_of_appendix", "\\leftindent"
 471
 472         sections = []
 473         for section in paragraphs_filter.keys():
 474             sections.append('\\begin_layout %s' % section)
 475
 476         toc_par = []
 477         i = 0
 478         while 1:
 479             i = find_tokens(self.body, sections, i)
 480             if i == -1:
 481                 break
 482
 483             j = find_end_of(self.body,  i + 1, '\\begin_layout', '\\end_layout')
 484             if j == -1:
 485                 self.warning('Incomplete file.', 0)
 486                 break
 487
 488             section = self.body[i].split()[1]
 489             if section[-1] == '*':
 490                 section = section[:-1]
 491
 492             par = []
 493
 494             k = i + 1
 495             # skip paragraph parameters
 496             while not self.body[k].strip() or self.body[k].split()[0] in allowed_parameters:
 497                 k = k +1
 498
 499             while k < j:
 500                 if check_token(self.body[k], '\\begin_inset'):
 501                     inset = self.body[k].split()[1]
 502                     end = find_end_of_inset(self.body, k)
 503                     if end == -1 or end > j:
 504                         self.warning('Malformed file.', 0)
 505
 506                     if inset in allowed_insets:
 507                         par.extend(self.body[k: end+1])
 508                     k = end + 1
 509                 else:
 510                     par.append(self.body[k])
 511                     k = k + 1
 512
 513             # trim empty lines in the end.
 514             while par[-1].strip() == '' and par:
 515                 par.pop()
 516
 517             toc_par.append(Paragraph(section, par))
 518
 519             i = j + 1
 520
 521         return toc_par
 522
 523
 524 class File(LyX_Base):
 525     " This class reads existing LyX files."
 526     def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level, try_hard = 0):
 527         LyX_Base.__init__(self, end_format, input, output, error, debug, try_hard)
 528         self.read()
 529
 530
 531 class NewFile(LyX_Base):
 532     " This class is to create new LyX files."
 533     def set_header(self, **params):
 534         # set default values
 535         self.header.extend([
 536             "#LyX xxxx created this file. For more info see http://www.lyx.org/",
 537             "\\lyxformat xxx",
 538             "\\begin_document",
 539             "\\begin_header",
 540             "\\textclass article",
 541             "\\language english",
 542             "\\inputencoding auto",
 543             "\\font_roman default",
 544             "\\font_sans default",
 545             "\\font_typewriter default",
 546             "\\font_default_family default",
 547             "\\font_sc false",
 548             "\\font_osf false",
 549             "\\font_sf_scale 100",
 550             "\\font_tt_scale 100",
 551             "\\graphics default",
 552             "\\paperfontsize default",
 553             "\\papersize default",
 554             "\\use_geometry false",
 555             "\\use_amsmath 1",
 556             "\\cite_engine basic",
 557             "\\use_bibtopic false",
 558             "\\paperorientation portrait",
 559             "\\secnumdepth 3",
 560             "\\tocdepth 3",
 561             "\\paragraph_separation indent",
 562             "\\defskip medskip",
 563             "\\quotes_language english",
 564             "\\papercolumns 1",
 565             "\\papersides 1",
 566             "\\paperpagestyle default",
 567             "\\tracking_changes false",
 568             "\\end_header"])
 569
 570         self.format = get_end_format()
 571         for param in params:
 572             self.set_parameter(param, params[param])
 573
 574
 575     def set_body(self, paragraphs):
 576         self.body.extend(['\\begin_body',''])
 577
 578         for par in paragraphs:
 579             self.body.extend(par.asLines())
 580
 581         self.body.extend(['','\\end_body', '\\end_document'])
 582
 583
 584 class Paragraph:
 585     # unfinished implementation, it is missing the Text and Insets representation.
 586     " This class represents the LyX paragraphs."
 587     def __init__(self, name, body=[], settings = [], child = []):
 588         """ Parameters:
 589         name: paragraph name.
 590         body: list of lines of body text.
 591         child: list of paragraphs that descend from this paragraph.
 592         """
 593         self.name = name
 594         self.body = body
 595         self.settings = settings
 596         self.child = child
 597
 598     def asLines(self):
 599         " Converts the paragraph to a list of strings, representing it in the LyX file."
 600         result = ['','\\begin_layout %s' % self.name]
 601         result.extend(self.settings)
 602         result.append('')
 603         result.extend(self.body)
 604         result.append('\\end_layout')
 605
 606         if not self.child:
 607             return result
 608
 609         result.append('\\begin_deeper')
 610         for node in self.child:
 611             result.extend(node.asLines())
 612         result.append('\\end_deeper')
 613
 614         return result
 615
 616
 617 class Inset:
 618     " This class represents the LyX insets."
 619     pass
 620
 621
 622 class Text:
 623     " This class represents simple chuncks of text."
 624     pass