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, find_tokens, find_end_of, find_end_of_inset
27 default_debug_level = 2
29 # Regular expressions used
30 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
31 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
32 original_version = re.compile(r"\#LyX (\S*)")
35 # file format information:
36 # file, supported formats, stable release versions
37 format_relation = [("0_10", [210], ["0.10.7","0.10"]),
38 ("0_12", [215], ["0.12","0.12.1","0.12"]),
39 ("1_0_0", [215], ["1.0.0","1.0"]),
40 ("1_0_1", [215], ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]),
41 ("1_1_4", [215], ["1.1.4","1.1"]),
42 ("1_1_5", [216], ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]),
43 ("1_1_6", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
44 ("1_1_6fix3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),
45 ("1_2", [220], ["1.2.0","1.2.1","1.2.3","1.2.4","1.2"]),
46 ("1_3", [221], ["1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3"]),
47 ("1_4", range(223,238), ["1.4.0cvs","1.4"])]
51 " Returns a list with supported file formats."
53 for version in format_relation:
54 for format in version[1]:
55 if format not in formats:
56 formats.append(format)
61 " Returns the more recent file format available."
62 return format_relation[-1][1][-1]
65 def get_backend(textclass):
66 " For _textclass_ returns its backend."
67 if textclass == "linuxdoc" or textclass == "manpage":
69 if textclass[:7] == "docbook":
78 """This class carries all the information of the LyX file."""
79 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level):
81 end_format: final format that the file should be converted. (integer)
82 input: the name of the input source, if empty resort to standard input.
83 output: the name of the output file, if empty use the standard output.
84 error: the name of the error file, if empty use the standard error.
85 debug: debug level, O means no debug, as its value increases be more verbose.
87 if input and input != '-':
88 self.input = self.open(input)
90 self.input = sys.stdin
92 self.output = open(output, "w")
94 self.output = sys.stdout
97 self.err = open(error, "w")
104 self.end_format = self.lyxformat(end_format)
106 self.end_format = get_end_format()
108 self.backend = "latex"
109 self.textclass = "article"
114 def warning(self, message, debug_level= default_debug_level):
115 " Emits warning to self.error, if the debug_level is less than the self.debug."
116 if debug_level <= self.debug:
117 self.err.write(message + "\n")
120 def error(self, message):
121 " Emits a warning and exist incondicionally."
122 self.warning(message)
123 self.warning("Quiting.")
128 """Reads a file into the self.header and self.body parts, from self.input."""
132 line = self.input.readline()
134 self.error("Invalid LyX file.")
137 # remove '\r' from line's end, if present
138 if line[-1:] == '\r':
141 if check_token(line, '\\begin_preamble'):
143 if check_token(line, '\\end_preamble'):
147 line = string.strip(line)
149 if not line and not preamble:
152 self.header.append(line)
155 line = self.input.readline()
158 # remove '\r' from line's end, if present
159 if line[-2:-1] == '\r':
160 self.body.append(line[:-2])
162 self.body.append(line[:-1])
164 self.textclass = get_value(self.header, "\\textclass", 0)
165 self.backend = get_backend(self.textclass)
166 self.format = self.read_format()
167 self.language = get_value(self.header, "\\language", 0)
168 if self.language == "":
169 self.language = "english"
170 self.initial_version = self.read_version()
174 " Writes the LyX file to self.output."
178 for line in self.header:
179 self.output.write(line+"\n")
180 self.output.write("\n")
181 for line in self.body:
182 self.output.write(line+"\n")
185 def open(self, file):
186 """Transparently deals with compressed files."""
188 self.dir = os.path.dirname(os.path.abspath(file))
190 gzip.open(file).readline()
191 self.output = gzip.GzipFile("","wb",6,self.output)
192 return gzip.open(file)
197 def lyxformat(self, format):
198 " Returns the file format representation, an integer."
199 result = format_re.match(format)
201 format = int(result.group(1) + result.group(2))
203 self.error(str(format) + ": " + "Invalid LyX file.")
205 if format in formats_list():
208 self.error(str(format) + ": " + "Format not supported.")
212 def read_version(self):
213 """ Searchs for clues of the LyX version used to write the file, returns the
214 most likely value, or None otherwise."""
215 for line in self.header:
219 result = original_version.match(line)
221 return result.group(1)
225 def set_version(self):
226 " Set the header with the version used."
227 self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version
228 if self.header[1][0] == '#':
232 def read_format(self):
233 " Read from the header the fileformat of the present LyX file."
234 for line in self.header:
235 result = fileformat.match(line)
237 return self.lyxformat(result.group(1))
239 self.error("Invalid LyX File.")
243 def set_format(self):
244 " Set the file format of the file, in the header."
245 if self.format <= 217:
246 format = str(float(format)/100)
248 format = str(self.format)
249 i = find_token(self.header, "\\lyxformat", 0)
250 self.header[i] = "\\lyxformat %s" % format
253 def set_parameter(self, param, value):
254 " Set the value of the header parameter."
255 i = find_token(self.header, '\\' + param, 0)
257 self.warning(3, 'Parameter not found in the header: %s' % param)
259 self.header[i] = '\\%s %s' % (param, str(value))
263 "Convert from current (self.format) to self.end_format."
264 mode, convertion_chain = self.chain()
265 self.warning("convertion chain: " + str(convertion_chain), 3)
267 for step in convertion_chain:
268 convert_step = getattr(__import__("lyx_" + step), mode)
273 """ This is where all the decisions related with the convertion are taken.
274 It returns a list of modules needed to convert the LyX file from
275 self.format to self.end_format"""
277 self.start = self.format
281 for rel in format_relation:
282 if self.initial_version in rel[2]:
284 initial_step = rel[0]
288 if not correct_version:
290 self.warning("Version does not match file format, discarding it.")
291 for rel in format_relation:
293 initial_step = rel[0]
296 # This should not happen, really.
297 self.error("Format not supported.")
299 # Find the final step
300 for rel in format_relation:
301 if self.end_format in rel[1]:
305 self.error("Format not supported.")
307 # Convertion mode, back or forth
309 if (initial_step, self.start) < (final_step, self.end_format):
312 for step in format_relation:
313 if initial_step <= step[0] <= final_step:
314 if first_step and len(step[1]) == 1:
317 steps.append(step[0])
320 relation_format = format_relation
321 relation_format.reverse()
324 for step in relation_format:
325 if final_step <= step[0] <= initial_step:
326 steps.append(step[0])
329 if last_step[1][-1] == self.end_format:
335 def get_toc(self, depth = 4):
336 " Returns the TOC of this LyX document."
337 paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, 'Subsection' : 3, 'Subsubsection': 4}
338 allowed_insets = ['Quotes']
341 for section in paragraphs_filter.keys():
342 sections.append('\\begin_layout %s' % section)
347 i = find_tokens(self.body, sections, i)
351 j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout')
353 self.warning('Incomplete file.', 0)
356 section = string.split(self.body[i])[1]
357 if section[-1] == '*':
358 section = section[:-1]
363 # skip paragraph parameters
364 while not self.body[k] or self.body[k][0] == '\\':
368 if check_token(self.body[k], '\\begin_inset'):
369 inset = string.split(self.body[k])[1]
370 end = find_end_of_inset(self.body, k)
371 if end == -1 or end > j:
372 self.warning('Malformed file.', 0)
374 if inset in allowed_insets:
375 par.extend(self.body[k: end+1])
378 par.append(self.body[k])
381 # trim empty lines in the end.
382 while string.strip(par[-1]) == '' and par:
385 toc_par.append(Paragraph(section, par))
392 class File(LyX_Base):
393 " This class reads existing LyX files."
394 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level):
395 LyX_Base.__init__(self, end_format, input, output, error, debug)
399 class NewFile(LyX_Base):
400 " This class is to create new LyX files."
401 def set_header(self, **params):
404 "#LyX xxxx created this file. For more info see http://www.lyx.org/",
408 "\\textclass article",
409 "\\language english",
410 "\\inputencoding auto",
411 "\\fontscheme default",
412 "\\graphics default",
413 "\\paperfontsize default",
414 "\\papersize default",
415 "\\paperpackage none",
416 "\\use_geometry false",
418 "\\cite_engine basic",
419 "\\use_bibtopic false",
420 "\\paperorientation portrait",
423 "\\paragraph_separation indent",
425 "\\quotes_language english",
429 "\\paperpagestyle default",
430 "\\tracking_changes false",
433 self.format = get_end_format()
435 self.set_parameter(param, params[param])
438 def set_body(self, paragraphs):
439 self.body.extend(['\\begin_body',''])
441 for par in paragraphs:
442 self.body.extend(par.asLines())
444 self.body.extend(['','\\end_body', '\\end_document'])
448 # unfinished implementation, it is missing the Text and Insets representation.
449 " This class represents the LyX paragraphs."
450 def __init__(self, name, body=[], settings = [], child = []):
452 name: paragraph name.
453 body: list of lines of body text.
454 child: list of paragraphs that descend from this paragraph.
458 self.settings = settings
462 " Converts the paragraph to a list of strings, representing it in the LyX file."
463 result = ['','\\begin_layout %s' % self.name]
464 result.extend(self.settings)
466 result.extend(self.body)
467 result.append('\\end_layout')
472 result.append('\\begin_deeper')
473 for node in self.child:
474 result.extend(node.asLines())
475 result.append('\\end_deeper')
481 " This class represents the LyX insets."
486 " This class represents simple chuncks of text."