1 # This file is part of lyx2lyx
2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2002-2004 Dekel Tsur <dekel@lyx.org>, José Matos <jamatos@lyx.org>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 from parser_tools import get_value, check_token, find_token,\
20 find_tokens, find_end_of, find_end_of_inset
28 version_lyx2lyx = "1.5.0svn"
29 default_debug_level = 2
31 # Regular expressions used
32 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
33 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
34 original_version = re.compile(r"\#LyX (\S*)")
37 # file format information:
38 # file, supported formats, stable release versions
39 format_relation = [("0_10", [210], ["0.10.7","0.10"]),
40 ("0_12", [215], ["0.12","0.12.1","0.12"]),
41 ("1_0_0", [215], ["1.0.0","1.0"]),
42 ("1_0_1", [215], ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]),
43 ("1_1_4", [215], ["1.1.4","1.1"]),
44 ("1_1_5", [216], ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]),
45 ("1_1_6", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
46 ("1_1_6fix3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),
47 ("1_2", [220], ["1.2.0","1.2.1","1.2.3","1.2.4","1.2"]),
48 ("1_3", [221], ["1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3.6","1.3"]),
49 ("1_4", range(222,246), ["1.4.0cvs","1.4"])]
53 " Returns a list with supported file formats."
55 for version in format_relation:
56 for format in version[1]:
57 if format not in formats:
58 formats.append(format)
63 " Returns the more recent file format available."
64 return format_relation[-1][1][-1]
67 def get_backend(textclass):
68 " For _textclass_ returns its backend."
69 if textclass == "linuxdoc" or textclass == "manpage":
71 if textclass[:7] == "docbook":
77 " Remove end of line char(s)."
78 if line[-2:-1] == '\r':
88 """This class carries all the information of the LyX file."""
89 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level, try_hard = 0):
91 end_format: final format that the file should be converted. (integer)
92 input: the name of the input source, if empty resort to standard input.
93 output: the name of the output file, if empty use the standard output.
94 error: the name of the error file, if empty use the standard error.
95 debug: debug level, O means no debug, as its value increases be more verbose.
97 self.choose_io(input, output)
100 self.err = open(error, "w")
102 self.err = sys.stderr
105 self.try_hard = try_hard
108 self.end_format = self.lyxformat(end_format)
110 self.end_format = get_end_format()
112 self.backend = "latex"
113 self.textclass = "article"
114 # This is a hack: We use '' since we don't know the default
115 # layout of the text class. LyX will parse it as default layout.
116 # FIXME: Read the layout file and use the real default layout
117 self.default_layout = ''
124 def warning(self, message, debug_level= default_debug_level):
125 " Emits warning to self.error, if the debug_level is less than the self.debug."
126 if debug_level <= self.debug:
127 self.err.write("Warning: " + message + "\n")
130 def error(self, message):
131 " Emits a warning and exits if not in try_hard mode."
132 self.warning(message)
133 if not self.try_hard:
134 self.warning("Quiting.")
141 """Reads a file into the self.header and self.body parts, from self.input."""
144 line = self.input.readline()
146 self.error("Invalid LyX file.")
148 line = trim_eol(line)
149 if check_token(line, '\\begin_preamble'):
151 line = self.input.readline()
153 self.error("Invalid LyX file.")
155 line = trim_eol(line)
156 if check_token(line, '\\end_preamble'):
159 if string.split(line)[:0] in ("\\layout", "\\begin_layout", "\\begin_body"):
160 self.warning("Malformed LyX file: Missing '\\end_preamble'.")
161 self.warning("Adding it now and hoping for the best.")
163 self.preamble.append(line)
165 if check_token(line, '\\end_preamble'):
168 line = string.strip(line)
172 if string.split(line)[0] in ("\\layout", "\\begin_layout", "\\begin_body"):
173 self.body.append(line)
176 self.header.append(line)
179 line = self.input.readline()
182 self.body.append(trim_eol(line))
184 self.textclass = get_value(self.header, "\\textclass", 0)
185 self.backend = get_backend(self.textclass)
186 self.format = self.read_format()
187 self.language = get_value(self.header, "\\language", 0)
188 if self.language == "":
189 self.language = "english"
190 self.initial_version = self.read_version()
194 " Writes the LyX file to self.output."
199 i = find_token(self.header, '\\textclass', 0) + 1
200 preamble = ['\\begin_preamble'] + self.preamble + ['\\end_preamble']
202 self.error("Malformed LyX file: Missing '\\textclass'.")
204 header = self.header[:i] + preamble + self.header[i:]
208 for line in header + [''] + self.body:
209 self.output.write(line+"\n")
212 def choose_io(self, input, output):
213 """Choose input and output streams, dealing transparently with
217 self.output = open(output, "wb")
219 self.output = sys.stdout
221 if input and input != '-':
222 self.dir = os.path.dirname(os.path.abspath(input))
224 gzip.open(input).readline()
225 self.input = gzip.open(input)
226 self.output = gzip.GzipFile(mode="wb", fileobj=self.output)
228 self.input = open(input)
230 self.input = sys.stdin
233 def lyxformat(self, format):
234 " Returns the file format representation, an integer."
235 result = format_re.match(format)
237 format = int(result.group(1) + result.group(2))
239 self.error(str(format) + ": " + "Invalid LyX file.")
241 if format in formats_list():
244 self.error(str(format) + ": " + "Format not supported.")
248 def read_version(self):
249 """ Searchs for clues of the LyX version used to write the file, returns the
250 most likely value, or None otherwise."""
251 for line in self.header:
255 result = original_version.match(line)
257 return result.group(1)
261 def set_version(self):
262 " Set the header with the version used."
263 self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version_lyx2lyx
264 if self.header[1][0] == '#':
268 def read_format(self):
269 " Read from the header the fileformat of the present LyX file."
270 for line in self.header:
271 result = fileformat.match(line)
273 return self.lyxformat(result.group(1))
275 self.error("Invalid LyX File.")
279 def set_format(self):
280 " Set the file format of the file, in the header."
281 if self.format <= 217:
282 format = str(float(self.format)/100)
284 format = str(self.format)
285 i = find_token(self.header, "\\lyxformat", 0)
286 self.header[i] = "\\lyxformat %s" % format
289 def set_parameter(self, param, value):
290 " Set the value of the header parameter."
291 i = find_token(self.header, '\\' + param, 0)
293 self.warning('Parameter not found in the header: %s' % param, 3)
295 self.header[i] = '\\%s %s' % (param, str(value))
298 def is_default_layout(self, layout):
299 " Check whether a layout is the default layout of this class."
300 # FIXME: Check against the real text class default layout
301 if layout == 'Standard' or layout == self.default_layout:
307 "Convert from current (self.format) to self.end_format."
308 mode, convertion_chain = self.chain()
309 self.warning("convertion chain: " + str(convertion_chain), 3)
311 for step in convertion_chain:
312 steps = getattr(__import__("lyx_" + step), mode)
314 self.warning("Convertion step: %s - %s" % (step, mode), default_debug_level + 1)
316 self.error("The convertion to an older format (%s) is not implemented." % self.format)
318 multi_conv = len(steps) != 1
319 for version, table in steps:
321 (self.format >= version and mode == "convert") or\
322 (self.format <= version and mode == "revert"):
330 self.warning("An error ocurred in %s, %s" % (version, str(conv)),
332 if not self.try_hard:
336 self.warning("%lf: Elapsed time on %s" % (time.time() - init_t, str(conv)),
337 default_debug_level + 1)
339 self.format = version
340 if self.end_format == self.format:
345 """ This is where all the decisions related with the convertion are taken.
346 It returns a list of modules needed to convert the LyX file from
347 self.format to self.end_format"""
349 self.start = self.format
353 for rel in format_relation:
354 if self.initial_version in rel[2]:
356 initial_step = rel[0]
360 if not correct_version:
362 self.warning("Version does not match file format, discarding it.")
363 for rel in format_relation:
365 initial_step = rel[0]
368 # This should not happen, really.
369 self.error("Format not supported.")
371 # Find the final step
372 for rel in format_relation:
373 if self.end_format in rel[1]:
377 self.error("Format not supported.")
379 # Convertion mode, back or forth
381 if (initial_step, self.start) < (final_step, self.end_format):
384 for step in format_relation:
385 if initial_step <= step[0] <= final_step:
386 if first_step and len(step[1]) == 1:
389 steps.append(step[0])
392 relation_format = format_relation[:]
393 relation_format.reverse()
396 for step in relation_format:
397 if final_step <= step[0] <= initial_step:
398 steps.append(step[0])
401 if last_step[1][-1] == self.end_format:
407 def get_toc(self, depth = 4):
408 " Returns the TOC of this LyX document."
409 paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, 'Subsection' : 3, 'Subsubsection': 4}
410 allowed_insets = ['Quotes']
411 allowed_parameters = '\\paragraph_spacing', '\\noindent', '\\align', '\\labelwidthstring', "\\start_of_appendix", "\\leftindent"
414 for section in paragraphs_filter.keys():
415 sections.append('\\begin_layout %s' % section)
420 i = find_tokens(self.body, sections, i)
424 j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout')
426 self.warning('Incomplete file.', 0)
429 section = string.split(self.body[i])[1]
430 if section[-1] == '*':
431 section = section[:-1]
436 # skip paragraph parameters
437 while not string.strip(self.body[k]) or string.split(self.body[k])[0] in allowed_parameters:
441 if check_token(self.body[k], '\\begin_inset'):
442 inset = string.split(self.body[k])[1]
443 end = find_end_of_inset(self.body, k)
444 if end == -1 or end > j:
445 self.warning('Malformed file.', 0)
447 if inset in allowed_insets:
448 par.extend(self.body[k: end+1])
451 par.append(self.body[k])
454 # trim empty lines in the end.
455 while string.strip(par[-1]) == '' and par:
458 toc_par.append(Paragraph(section, par))
465 class File(LyX_Base):
466 " This class reads existing LyX files."
467 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level, try_hard = 0):
468 LyX_Base.__init__(self, end_format, input, output, error, debug, try_hard)
472 class NewFile(LyX_Base):
473 " This class is to create new LyX files."
474 def set_header(self, **params):
477 "#LyX xxxx created this file. For more info see http://www.lyx.org/",
481 "\\textclass article",
482 "\\language english",
483 "\\inputencoding auto",
484 "\\fontscheme default",
485 "\\graphics default",
486 "\\paperfontsize default",
487 "\\papersize default",
488 "\\use_geometry false",
490 "\\cite_engine basic",
491 "\\use_bibtopic false",
492 "\\paperorientation portrait",
495 "\\paragraph_separation indent",
497 "\\quotes_language english",
500 "\\paperpagestyle default",
501 "\\tracking_changes false",
504 self.format = get_end_format()
506 self.set_parameter(param, params[param])
509 def set_body(self, paragraphs):
510 self.body.extend(['\\begin_body',''])
512 for par in paragraphs:
513 self.body.extend(par.asLines())
515 self.body.extend(['','\\end_body', '\\end_document'])
519 # unfinished implementation, it is missing the Text and Insets representation.
520 " This class represents the LyX paragraphs."
521 def __init__(self, name, body=[], settings = [], child = []):
523 name: paragraph name.
524 body: list of lines of body text.
525 child: list of paragraphs that descend from this paragraph.
529 self.settings = settings
533 " Converts the paragraph to a list of strings, representing it in the LyX file."
534 result = ['','\\begin_layout %s' % self.name]
535 result.extend(self.settings)
537 result.extend(self.body)
538 result.append('\\end_layout')
543 result.append('\\begin_deeper')
544 for node in self.child:
545 result.extend(node.asLines())
546 result.append('\\end_deeper')
552 " This class represents the LyX insets."
557 " This class represents simple chuncks of text."