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>
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.
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.
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.
20 " The LyX module has all the rules related with different lyx file formats."
22 from parser_tools import get_value, check_token, find_token, \
23 find_tokens, find_end_of
32 import lyx2lyx_version
33 version__ = lyx2lyx_version.version
34 except: # we are running from build directory so assume the last version
35 version__ = '1.6.0svn'
39 ####################################################################
40 # Private helper functions
42 def find_end_of_inset(lines, i):
43 " Find beginning of inset, where lines[i] is included."
44 return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
46 def minor_versions(major, last_minor_version):
47 """ Generate minor versions, using major as prefix and minor
48 versions from 0 until last_minor_version, plus the generic version.
52 minor_versions("1.2", 4) ->
53 [ "1.2", "1.2.0", "1.2.1", "1.2.2", "1.2.3"]
55 return [major] + [major + ".%d" % i for i in range(last_minor_version + 1)]
58 # End of helper functions
59 ####################################################################
62 # Regular expressions used
63 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
64 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
65 original_version = re.compile(r".*?LyX ([\d.]*)")
68 # file format information:
69 # file, supported formats, stable release versions
70 format_relation = [("0_06", [200], minor_versions("0.6" , 4)),
71 ("0_08", [210], minor_versions("0.8" , 6) + ["0.7"]),
72 ("0_10", [210], minor_versions("0.10", 7) + ["0.9"]),
73 ("0_12", [215], minor_versions("0.12", 1) + ["0.11"]),
74 ("1_0", [215], minor_versions("1.0" , 4)),
75 ("1_1", [215], minor_versions("1.1" , 4)),
76 ("1_1_5", [216], ["1.1.5","1.1.5.1","1.1.5.2","1.1"]),
77 ("1_1_6_0", [217], ["1.1.6","1.1.6.1","1.1.6.2","1.1"]),
78 ("1_1_6_3", [218], ["1.1.6.3","1.1.6.4","1.1"]),
79 ("1_2", [220], minor_versions("1.2" , 4)),
80 ("1_3", [221], minor_versions("1.3" , 7)),
81 ("1_4", range(222,246), minor_versions("1.4" , 5)),
82 ("1_5", range(246,277), minor_versions("1.5" , 2)),
83 ("1_6", range(277,317), minor_versions("1.6" , 0))] # jspitzm: subfig
87 " Returns a list with supported file formats."
89 for version in format_relation:
90 for format in version[1]:
91 if format not in formats:
92 formats.append(format)
97 " Returns the more recent file format available."
98 return format_relation[-1][1][-1]
101 def get_backend(textclass):
102 " For _textclass_ returns its backend."
103 if textclass == "linuxdoc" or textclass == "manpage":
105 if textclass[:7] == "docbook":
111 " Remove end of line char(s)."
112 if line[-2:-1] == '\r':
118 def get_encoding(language, inputencoding, format, cjk_encoding):
119 " Returns enconding of the lyx file"
122 # CJK-LyX encodes files using the current locale encoding.
123 # This means that files created by CJK-LyX can only be converted using
124 # the correct locale settings unless the encoding is given as commandline
126 if cjk_encoding == 'auto':
127 return locale.getpreferredencoding()
130 from lyx2lyx_lang import lang
131 if inputencoding == "auto" or inputencoding == "default":
132 return lang[language][3]
133 if inputencoding == "":
135 if inputencoding == "utf8x":
137 # python does not know the alias latin9
138 if inputencoding == "latin9":
146 """This class carries all the information of the LyX file."""
148 def __init__(self, end_format = 0, input = "", output = "", error = "",
149 debug = default_debug__, try_hard = 0, cjk_encoding = '',
150 language = "english", encoding = "auto"):
153 end_format: final format that the file should be converted. (integer)
154 input: the name of the input source, if empty resort to standard input.
155 output: the name of the output file, if empty use the standard output.
156 error: the name of the error file, if empty use the standard error.
157 debug: debug level, O means no debug, as its value increases be more verbose.
159 self.choose_io(input, output)
162 self.err = open(error, "w")
164 self.err = sys.stderr
167 self.try_hard = try_hard
168 self.cjk_encoding = cjk_encoding
171 self.end_format = self.lyxformat(end_format)
173 self.end_format = get_end_format()
175 self.backend = "latex"
176 self.textclass = "article"
177 # This is a hack: We use '' since we don't know the default
178 # layout of the text class. LyX will parse it as default layout.
179 # FIXME: Read the layout file and use the real default layout
180 self.default_layout = ''
185 self.encoding = encoding
186 self.language = language
189 def warning(self, message, debug_level= default_debug__):
190 """ Emits warning to self.error, if the debug_level is less
191 than the self.debug."""
192 if debug_level <= self.debug:
193 self.err.write("Warning: " + message + "\n")
196 def error(self, message):
197 " Emits a warning and exits if not in try_hard mode."
198 self.warning(message)
199 if not self.try_hard:
200 self.warning("Quiting.")
207 """Reads a file into the self.header and
208 self.body parts, from self.input."""
211 line = self.input.readline()
213 self.error("Invalid LyX file.")
215 line = trim_eol(line)
216 if check_token(line, '\\begin_preamble'):
218 line = self.input.readline()
220 self.error("Invalid LyX file.")
222 line = trim_eol(line)
223 if check_token(line, '\\end_preamble'):
226 if line.split()[:0] in ("\\layout",
227 "\\begin_layout", "\\begin_body"):
229 self.warning("Malformed LyX file:"
230 "Missing '\\end_preamble'."
231 "\nAdding it now and hoping"
234 self.preamble.append(line)
236 if check_token(line, '\\end_preamble'):
243 if line.split()[0] in ("\\layout", "\\begin_layout",
244 "\\begin_body", "\\begin_deeper"):
245 self.body.append(line)
248 self.header.append(line)
250 self.textclass = get_value(self.header, "\\textclass", 0)
251 self.backend = get_backend(self.textclass)
252 self.format = self.read_format()
253 self.language = get_value(self.header, "\\language", 0,
255 self.inputencoding = get_value(self.header, "\\inputencoding",
257 self.encoding = get_encoding(self.language,
258 self.inputencoding, self.format,
260 self.initial_version = self.read_version()
262 # Second pass over header and preamble, now we know the file encoding
263 for i in range(len(self.header)):
264 self.header[i] = self.header[i].decode(self.encoding)
265 for i in range(len(self.preamble)):
266 self.preamble[i] = self.preamble[i].decode(self.encoding)
270 line = self.input.readline().decode(self.encoding)
273 self.body.append(trim_eol(line))
277 " Writes the LyX file to self.output."
281 if self.encoding == "auto":
282 self.encoding = get_encoding(self.language, self.encoding,
283 self.format, self.cjk_encoding)
285 i = find_token(self.header, '\\textclass', 0) + 1
286 preamble = ['\\begin_preamble'] + self.preamble + ['\\end_preamble']
288 self.error("Malformed LyX file: Missing '\\textclass'.")
290 header = self.header[:i] + preamble + self.header[i:]
294 for line in header + [''] + self.body:
295 self.output.write(line.encode(self.encoding)+"\n")
298 def choose_io(self, input, output):
299 """Choose input and output streams, dealing transparently with
303 self.output = open(output, "wb")
305 self.output = sys.stdout
307 if input and input != '-':
308 self.dir = os.path.dirname(os.path.abspath(input))
310 gzip.open(input).readline()
311 self.input = gzip.open(input)
312 self.output = gzip.GzipFile(mode="wb", fileobj=self.output)
314 self.input = open(input)
317 self.input = sys.stdin
320 def lyxformat(self, format):
321 " Returns the file format representation, an integer."
322 result = format_re.match(format)
324 format = int(result.group(1) + result.group(2))
328 self.error(str(format) + ": " + "Invalid LyX file.")
330 if format in formats_list():
333 self.error(str(format) + ": " + "Format not supported.")
337 def read_version(self):
338 """ Searchs for clues of the LyX version used to write the
339 file, returns the most likely value, or None otherwise."""
341 for line in self.header:
345 line = line.replace("fix",".")
346 result = original_version.match(line)
348 # Special know cases: reLyX and KLyX
349 if line.find("reLyX") != -1 or line.find("KLyX") != -1:
352 res = result.group(1)
355 #self.warning("Version %s" % result.group(1))
357 self.warning(str(self.header[:2]))
361 def set_version(self):
362 " Set the header with the version used."
363 self.header[0] = " ".join(["#LyX %s created this file." % version__,
364 "For more info see http://www.lyx.org/"])
365 if self.header[1][0] == '#':
369 def read_format(self):
370 " Read from the header the fileformat of the present LyX file."
371 for line in self.header:
372 result = fileformat.match(line)
374 return self.lyxformat(result.group(1))
376 self.error("Invalid LyX File.")
380 def set_format(self):
381 " Set the file format of the file, in the header."
382 if self.format <= 217:
383 format = str(float(self.format)/100)
385 format = str(self.format)
386 i = find_token(self.header, "\\lyxformat", 0)
387 self.header[i] = "\\lyxformat %s" % format
390 def set_textclass(self):
391 i = find_token(self.header, "\\textclass", 0)
392 self.header[i] = "\\textclass %s" % self.textclass
395 #Note that the module will be added at the END of the extant ones
396 def add_module(self, module):
397 i = find_token(self.header, "\\begin_modules", 0)
399 #No modules yet included
400 i = find_token(self.header, "\\textclass", 0)
402 self.warning("Malformed LyX document: No \\textclass!!")
404 modinfo = ["\\begin_modules", module, "\\end_modules"]
405 self.header[i + 1: i + 1] = modinfo
407 j = find_token(self.header, "\\end_modules", i)
409 self.warning("(add_module)Malformed LyX document: No \\end_modules.")
411 k = find_token(self.header, module, i)
412 if k != -1 and k < j:
414 self.header.insert(j, module)
417 def get_module_list(self):
418 i = find_token(self.header, "\\begin_modules", 0)
421 j = find_token(self.header, "\\end_modules", i)
422 return self.header[i + 1 : j]
425 def set_module_list(self, mlist):
426 modbegin = find_token(self.header, "\\begin_modules", 0)
427 newmodlist = ['\\begin_modules'] + mlist + ['\\end_modules']
429 #No modules yet included
430 tclass = find_token(self.header, "\\textclass", 0)
432 self.warning("Malformed LyX document: No \\textclass!!")
434 modbegin = tclass + 1
435 self.header[modbegin:modbegin] = newmodlist
437 modend = find_token(self.header, "\\end_modules", modbegin)
439 self.warning("(set_module_list)Malformed LyX document: No \\end_modules.")
441 newmodlist = ['\\begin_modules'] + mlist + ['\\end_modules']
442 self.header[modbegin:modend + 1] = newmodlist
445 def set_parameter(self, param, value):
446 " Set the value of the header parameter."
447 i = find_token(self.header, '\\' + param, 0)
449 self.warning('Parameter not found in the header: %s' % param, 3)
451 self.header[i] = '\\%s %s' % (param, str(value))
454 def is_default_layout(self, layout):
455 " Check whether a layout is the default layout of this class."
456 # FIXME: Check against the real text class default layout
457 if layout == 'Standard' or layout == self.default_layout:
463 "Convert from current (self.format) to self.end_format."
464 mode, convertion_chain = self.chain()
465 self.warning("convertion chain: " + str(convertion_chain), 3)
467 for step in convertion_chain:
468 steps = getattr(__import__("lyx_" + step), mode)
470 self.warning("Convertion step: %s - %s" % (step, mode),
473 self.error("The convertion to an older "
474 "format (%s) is not implemented." % self.format)
476 multi_conv = len(steps) != 1
477 for version, table in steps:
479 (self.format >= version and mode == "convert") or\
480 (self.format <= version and mode == "revert"):
488 self.warning("An error ocurred in %s, %s" %
489 (version, str(conv)),
491 if not self.try_hard:
495 self.warning("%lf: Elapsed time on %s" %
496 (time.time() - init_t,
497 str(conv)), default_debug__ +
499 self.format = version
500 if self.end_format == self.format:
505 """ This is where all the decisions related with the
506 convertion are taken. It returns a list of modules needed to
507 convert the LyX file from self.format to self.end_format"""
509 self.start = self.format
513 for rel in format_relation:
514 if self.initial_version in rel[2]:
516 initial_step = rel[0]
520 if not correct_version:
522 self.warning("Version does not match file format, "
523 "discarding it. (Version %s, format %d)" %
524 (self.initial_version, self.format))
525 for rel in format_relation:
527 initial_step = rel[0]
530 # This should not happen, really.
531 self.error("Format not supported.")
533 # Find the final step
534 for rel in format_relation:
535 if self.end_format in rel[1]:
539 self.error("Format not supported.")
541 # Convertion mode, back or forth
543 if (initial_step, self.start) < (final_step, self.end_format):
546 for step in format_relation:
547 if initial_step <= step[0] <= final_step:
548 if first_step and len(step[1]) == 1:
551 steps.append(step[0])
554 relation_format = format_relation[:]
555 relation_format.reverse()
558 for step in relation_format:
559 if final_step <= step[0] <= initial_step:
560 steps.append(step[0])
563 if last_step[1][-1] == self.end_format:
566 self.warning("Convertion mode: %s\tsteps%s" %(mode, steps), 10)
570 def get_toc(self, depth = 4):
571 " Returns the TOC of this LyX document."
572 paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2,
573 'Subsection' : 3, 'Subsubsection': 4}
574 allowed_insets = ['Quotes']
575 allowed_parameters = ('\\paragraph_spacing', '\\noindent',
576 '\\align', '\\labelwidthstring',
577 "\\start_of_appendix", "\\leftindent")
579 for section in paragraphs_filter.keys():
580 sections.append('\\begin_layout %s' % section)
585 i = find_tokens(self.body, sections, i)
589 j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout')
591 self.warning('Incomplete file.', 0)
594 section = self.body[i].split()[1]
595 if section[-1] == '*':
596 section = section[:-1]
601 # skip paragraph parameters
602 while not self.body[k].strip() or self.body[k].split()[0] \
603 in allowed_parameters:
607 if check_token(self.body[k], '\\begin_inset'):
608 inset = self.body[k].split()[1]
609 end = find_end_of_inset(self.body, k)
610 if end == -1 or end > j:
611 self.warning('Malformed file.', 0)
613 if inset in allowed_insets:
614 par.extend(self.body[k: end+1])
617 par.append(self.body[k])
620 # trim empty lines in the end.
621 while par and par[-1].strip() == '':
624 toc_par.append(Paragraph(section, par))
631 class File(LyX_base):
632 " This class reads existing LyX files."
634 def __init__(self, end_format = 0, input = "", output = "", error = "",
635 debug = default_debug__, try_hard = 0, cjk_encoding = ''):
636 LyX_base.__init__(self, end_format, input, output, error,
637 debug, try_hard, cjk_encoding)
641 class NewFile(LyX_base):
642 " This class is to create new LyX files."
643 def set_header(self, **params):
646 "#LyX xxxx created this file."
647 "For more info see http://www.lyx.org/",
651 "\\textclass article",
652 "\\language english",
653 "\\inputencoding auto",
654 "\\font_roman default",
655 "\\font_sans default",
656 "\\font_typewriter default",
657 "\\font_default_family default",
660 "\\font_sf_scale 100",
661 "\\font_tt_scale 100",
662 "\\graphics default",
663 "\\paperfontsize default",
664 "\\papersize default",
665 "\\use_geometry false",
667 "\\cite_engine basic",
668 "\\use_bibtopic false",
669 "\\paperorientation portrait",
672 "\\paragraph_separation indent",
674 "\\quotes_language english",
677 "\\paperpagestyle default",
678 "\\tracking_changes false",
681 self.format = get_end_format()
683 self.set_parameter(param, params[param])
686 def set_body(self, paragraphs):
687 self.body.extend(['\\begin_body',''])
689 for par in paragraphs:
690 self.body.extend(par.asLines())
692 self.body.extend(['','\\end_body', '\\end_document'])
696 # unfinished implementation, it is missing the Text and Insets
698 " This class represents the LyX paragraphs."
699 def __init__(self, name, body=[], settings = [], child = []):
701 name: paragraph name.
702 body: list of lines of body text.
703 child: list of paragraphs that descend from this paragraph.
707 self.settings = settings
711 """ Converts the paragraph to a list of strings, representing
712 it in the LyX file."""
714 result = ['','\\begin_layout %s' % self.name]
715 result.extend(self.settings)
717 result.extend(self.body)
718 result.append('\\end_layout')
723 result.append('\\begin_deeper')
724 for node in self.child:
725 result.extend(node.asLines())
726 result.append('\\end_deeper')