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
30 default_debug_level = 2
31 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
32 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
33 original_version = re.compile(r"\#LyX (\S*)")
35 format_relation = [("0_10", [210], ["0.10.7","0.10"]),
36 ("0_12", [215], ["0.12","0.12.1","0.12"]),
37 ("1_0_0", [215], ["1.0.0","1.0"]),
38 ("1_0_1", [215], ["1.0.1","1.0.2","1.0.3","1.0.4", "1.1.2","1.1"]),
39 ("1_1_4", [215], ["1.1.4","1.1"]),
40 ("1_1_5", [216], ["1.1.5","1.1.5fix1","1.1.5fix2","1.1"]),
41 ("1_1_6", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
42 ("1_1_6fix3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),
43 ("1_2", [220], ["1.2.0","1.2.1","1.2.3","1.2.4","1.2"]),
44 ("1_3", [221], ["1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3"]),
45 ("1_4", range(223,238), ["1.4.0cvs","1.4"])]
50 for version in format_relation:
51 for format in version[1]:
52 if format not in formats:
53 formats.append(format)
58 return format_relation[-1][1][-1]
61 def get_backend(textclass):
62 if textclass == "linuxdoc" or textclass == "manpage":
64 if textclass[:7] == "docbook":
73 """This class carries all the information of the LyX file."""
74 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level):
75 if input and input != '-':
76 self.input = self.open(input)
78 self.input = sys.stdin
80 self.output = open(output, "w")
82 self.output = sys.stdout
85 self.err = open(error, "w")
92 self.end_format = self.lyxformat(end_format)
94 self.end_format = get_end_format()
96 self.backend = "latex"
97 self.textclass = "article"
102 def warning(self, message, debug_level= default_debug_level):
103 if debug_level <= self.debug:
104 self.err.write(message + "\n")
107 def error(self, message):
108 self.warning(message)
109 self.warning("Quiting.")
114 """Reads a file into the self.header and self.body parts"""
118 line = self.input.readline()
120 self.error("Invalid LyX file.")
123 # remove '\r' from line's end, if present
124 if line[-1:] == '\r':
127 if check_token(line, '\\begin_preamble'):
129 if check_token(line, '\\end_preamble'):
133 line = string.strip(line)
135 if not line and not preamble:
138 self.header.append(line)
141 line = self.input.readline()
144 # remove '\r' from line's end, if present
145 if line[-2:-1] == '\r':
146 self.body.append(line[:-2])
148 self.body.append(line[:-1])
150 self.textclass = get_value(self.header, "\\textclass", 0)
151 self.backend = get_backend(self.textclass)
152 self.format = self.read_format()
153 self.language = get_value(self.header, "\\language", 0)
154 if self.language == "":
155 self.language = "english"
156 self.initial_version = self.read_version()
163 for line in self.header:
164 self.output.write(line+"\n")
165 self.output.write("\n")
166 for line in self.body:
167 self.output.write(line+"\n")
170 def open(self, file):
171 """Transparently deals with compressed files."""
173 self.dir = os.path.dirname(os.path.abspath(file))
175 gzip.open(file).readline()
176 self.output = gzip.GzipFile("","wb",6,self.output)
177 return gzip.open(file)
182 def lyxformat(self, format):
183 result = format_re.match(format)
185 format = int(result.group(1) + result.group(2))
187 self.error(str(format) + ": " + "Invalid LyX file.")
189 if format in formats_list():
192 self.error(str(format) + ": " + "Format not supported.")
196 def read_version(self):
197 for line in self.header:
201 result = original_version.match(line)
203 return result.group(1)
207 def set_version(self):
208 self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version
209 if self.header[1][0] == '#':
213 def read_format(self):
214 for line in self.header:
215 result = fileformat.match(line)
217 return self.lyxformat(result.group(1))
219 self.error("Invalid LyX File.")
223 def set_format(self):
224 if self.format <= 217:
225 format = str(float(format)/100)
227 format = str(self.format)
228 i = find_token(self.header, "\\lyxformat", 0)
229 self.header[i] = "\\lyxformat %s" % format
232 def set_parameter(self, param, value):
233 i = find_token(self.header, '\\' + param, 0)
235 self.warning(3, 'Parameter not found in the header: %s' % param)
237 self.header[i] = '\\%s %s' % (param, str(value))
241 "Convert from old to new format."
242 mode, convertion_chain = self.chain()
243 self.warning("convertion chain: " + str(convertion_chain), 3)
245 for step in convertion_chain:
246 convert_step = getattr(__import__("lyx_" + step), mode)
251 """ This is where all the decisions related with the convertion are taken"""
253 self.start = self.format
257 for rel in format_relation:
258 if self.initial_version in rel[2]:
260 initial_step = rel[0]
264 if not correct_version:
266 self.warning("Version does not match file format, discarding it.")
267 for rel in format_relation:
269 initial_step = rel[0]
272 # This should not happen, really.
273 self.error("Format not supported.")
275 # Find the final step
276 for rel in format_relation:
277 if self.end_format in rel[1]:
281 self.error("Format not supported.")
283 # Convertion mode, back or forth
285 if (initial_step, self.start) < (final_step, self.end_format):
288 for step in format_relation:
289 if initial_step <= step[0] <= final_step:
290 if first_step and len(step[1]) == 1:
293 steps.append(step[0])
296 relation_format = format_relation
297 relation_format.reverse()
300 for step in relation_format:
301 if final_step <= step[0] <= initial_step:
302 steps.append(step[0])
305 if last_step[1][-1] == self.end_format:
311 def get_toc(self, depth = 4):
312 " Returns the TOC of a lyx document."
313 paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, 'Subsection' : 3, 'Subsubsection': 4}
314 allowed_insets = ['Quotes']
317 for section in paragraphs_filter.keys():
318 sections.append('\\begin_layout %s' % section)
323 i = find_tokens(self.body, sections, i)
327 j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout')
329 self.warning('Incomplete file.', 0)
332 section = string.split(self.body[i])[1]
333 if section[-1] == '*':
334 section = section[:-1]
339 # skip paragraph parameters
340 while not self.body[k] or self.body[k][0] == '\\':
344 if check_token(self.body[k], '\\begin_inset'):
345 inset = string.split(self.body[k])[1]
346 end = find_end_of_inset(self.body, k)
347 if end == -1 or end > j:
348 self.warning('Malformed file.', 0)
350 if inset in allowed_insets:
351 par.extend(self.body[k: end+1])
354 par.append(self.body[k])
357 # trim empty lines in the end.
358 while string.strip(par[-1]) == '' and par:
361 toc_par.append(Paragraph(section, par))
368 class File(LyX_Base):
369 def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level):
370 LyX_Base.__init__(self, end_format, input, output, error, debug)
374 class NewFile(LyX_Base):
375 def set_header(self, **params):
378 "#LyX xxxx created this file. For more info see http://www.lyx.org/",
382 "\\textclass article",
383 "\\language english",
384 "\\inputencoding auto",
385 "\\fontscheme default",
386 "\\graphics default",
387 "\\paperfontsize default",
388 "\\papersize default",
389 "\\paperpackage none",
390 "\\use_geometry false",
392 "\\cite_engine basic",
393 "\\use_bibtopic false",
394 "\\paperorientation portrait",
397 "\\paragraph_separation indent",
399 "\\quotes_language english",
403 "\\paperpagestyle default",
404 "\\tracking_changes false",
407 self.format = get_end_format()
409 self.set_parameter(param, params[param])
412 def set_body(self, paragraphs):
413 self.body.extend(['\\begin_body',''])
415 for par in paragraphs:
416 self.body.extend(par.asLines())
418 self.body.extend(['','\\end_body', '\\end_document'])
422 def __init__(self, name, body=[], settings = [], child = []):
425 self.settings = settings
429 result = ['','\\begin_layout %s' % self.name]
430 result.extend(self.settings)
432 result.extend(self.body)
433 result.append('\\end_layout')
438 result.append('\\begin_deeper')
439 for node in self.child:
440 result.extend(node.asLines())
441 result.append('\\end_deeper')