X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Flyx2lyx%2FLyX.py;h=6bc0fb6f7c4bdec17bb3d5d13021744c03414217;hb=6e59aff511f5e74102c96ad2b63909c86e95187d;hp=f0aa236dbdf3399031eebd053569cee201bb7511;hpb=6c570057976c353d6c887dfa2e6dcadc969d7a00;p=lyx.git diff --git a/lib/lyx2lyx/LyX.py b/lib/lyx2lyx/LyX.py index f0aa236dbd..6bc0fb6f7c 100644 --- a/lib/lyx2lyx/LyX.py +++ b/lib/lyx2lyx/LyX.py @@ -1,5 +1,6 @@ # This file is part of lyx2lyx # -*- coding: utf-8 -*- +# Copyright (C) 2002-2015 The LyX Team # Copyright (C) 2002-2004 Dekel Tsur # Copyright (C) 2002-2006 José Matos # @@ -15,7 +16,7 @@ # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA " The LyX module has all the rules related with different lyx file formats." @@ -32,7 +33,7 @@ try: import lyx2lyx_version version__ = lyx2lyx_version.version except: # we are running from build directory so assume the last version - version__ = '1.6.0svn' + version__ = '2.2' default_debug__ = 2 @@ -63,6 +64,7 @@ def minor_versions(major, last_minor_version): format_re = re.compile(r"(\d)[\.,]?(\d\d)") fileformat = re.compile(r"\\lyxformat\s*(\S*)") original_version = re.compile(r".*?LyX ([\d.]*)") +original_tex2lyx_version = re.compile(r".*?tex2lyx ([\d.]*)") ## # file format information: @@ -73,15 +75,31 @@ format_relation = [("0_06", [200], minor_versions("0.6" , 4)), ("0_12", [215], minor_versions("0.12", 1) + ["0.11"]), ("1_0", [215], minor_versions("1.0" , 4)), ("1_1", [215], minor_versions("1.1" , 4)), - ("1_1_5", [216], ["1.1.5","1.1.5.1","1.1.5.2","1.1"]), - ("1_1_6_0", [217], ["1.1.6","1.1.6.1","1.1.6.2","1.1"]), - ("1_1_6_3", [218], ["1.1.6.3","1.1.6.4","1.1"]), + ("1_1_5", [216], ["1.1", "1.1.5","1.1.5.1","1.1.5.2"]), + ("1_1_6_0", [217], ["1.1", "1.1.6","1.1.6.1","1.1.6.2"]), + ("1_1_6_3", [218], ["1.1", "1.1.6.3","1.1.6.4"]), ("1_2", [220], minor_versions("1.2" , 4)), ("1_3", [221], minor_versions("1.3" , 7)), - ("1_4", range(222,246), minor_versions("1.4" , 5)), - ("1_5", range(246,277), minor_versions("1.5" , 2)), - ("1_6", range(277,322), minor_versions("1.6" , 0))] + # Note that range(i,j) is up to j *excluded*. + ("1_4", list(range(222,246)), minor_versions("1.4" , 5)), + ("1_5", list(range(246,277)), minor_versions("1.5" , 7)), + ("1_6", list(range(277,346)), minor_versions("1.6" , 10)), + ("2_0", list(range(346,414)), minor_versions("2.0" , 8)), + ("2_1", list(range(414,475)), minor_versions("2.1" , 0)), + ("2_2", list(range(475,505)), minor_versions("2.2" , 0)) + ] +#################################################################### +# This is useful just for development versions # +# if the list of supported formats is empty get it from last step # +if not format_relation[-1][1]: + step, mode = format_relation[-1][0], "convert" + convert = getattr(__import__("lyx_" + step), mode) + format_relation[-1] = (step, + [conv[0] for conv in convert], + format_relation[-1][2]) +# # +#################################################################### def formats_list(): " Returns a list with supported file formats." @@ -93,22 +111,46 @@ def formats_list(): return formats +def format_info(): + " Returns a list with supported file formats." + out = """Major version: + minor versions + formats +""" + for version in format_relation: + major = str(version[2][0]) + versions = str(version[2][1:]) + if len(version[1]) == 1: + formats = str(version[1][0]) + else: + formats = "%s - %s" % (version[1][-1], version[1][0]) + out += "%s\n\t%s\n\t%s\n\n" % (major, versions, formats) + return out + '\n' + + def get_end_format(): " Returns the more recent file format available." - return format_relation[-1][1][-1] + # this check will fail only when we have a new version + # and there is no format change yet. + if format_relation[-1][1]: + return format_relation[-1][1][-1] + return format_relation[-2][1][-1] def get_backend(textclass): " For _textclass_ returns its backend." if textclass == "linuxdoc" or textclass == "manpage": return "linuxdoc" - if textclass[:7] == "docbook": + if textclass.startswith("docbook") or textclass.startswith("agu-"): return "docbook" return "latex" def trim_eol(line): " Remove end of line char(s)." + if line[-1] != '\n' and line[-1] != '\r': + # May happen for the last line of a document + return line if line[-2:-1] == '\r': return line[:-2] else: @@ -147,7 +189,8 @@ class LyX_base: def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug__, try_hard = 0, cjk_encoding = '', - language = "english", encoding = "auto"): + final_version = "", systemlyxdir = '', language = "english", + encoding = "auto"): """Arguments: end_format: final format that the file should be converted. (integer) @@ -169,9 +212,37 @@ class LyX_base: if end_format: self.end_format = self.lyxformat(end_format) + + # In case the target version and format are both specified + # verify that they are compatible. If not send a warning + # and ignore the version. + if final_version: + message = "Incompatible version %s for specified format %d" % ( + final_version, self.end_format) + for version in format_relation: + if self.end_format in version[1]: + if final_version not in version[2]: + self.warning(message) + final_version = "" + elif final_version: + for version in format_relation: + if final_version in version[2]: + # set the last format for that version + self.end_format = version[1][-1] + break + else: + final_version = "" else: self.end_format = get_end_format() + if not final_version: + for step in format_relation: + if self.end_format in step[1]: + final_version = step[2][1] + self.final_version = final_version + self.warning("Final version: %s" % self.final_version, 10) + self.warning("Final format: %d" % self.end_format, 10) + self.backend = "latex" self.textclass = "article" # This is a hack: We use '' since we don't know the default @@ -184,6 +255,7 @@ class LyX_base: self.status = 0 self.encoding = encoding self.language = language + self.systemlyxdir = systemlyxdir def warning(self, message, debug_level= default_debug__): @@ -197,7 +269,7 @@ class LyX_base: " Emits a warning and exits if not in try_hard mode." self.warning(message) if not self.try_hard: - self.warning("Quiting.") + self.warning("Quitting.") sys.exit(1) self.status = 2 @@ -266,6 +338,8 @@ class LyX_base: self.initial_version = self.read_version() # Second pass over header and preamble, now we know the file encoding + # Do not forget the textclass (Debian bug #700828) + self.textclass = self.textclass.decode(self.encoding) for i in range(len(self.header)): self.header[i] = self.header[i].decode(self.encoding) for i in range(len(self.preamble)): @@ -346,12 +420,16 @@ class LyX_base: return None line = line.replace("fix",".") - result = original_version.match(line) + # need to test original_tex2lyx_version first because tex2lyx + # writes "#LyX file created by tex2lyx 2.2" + result = original_tex2lyx_version.match(line) + if not result: + result = original_version.match(line) + if result: + # Special know cases: reLyX and KLyX + if line.find("reLyX") != -1 or line.find("KLyX") != -1: + return "0.12" if result: - # Special know cases: reLyX and KLyX - if line.find("reLyX") != -1 or line.find("KLyX") != -1: - return "0.12" - res = result.group(1) if not res: self.warning(line) @@ -363,8 +441,22 @@ class LyX_base: def set_version(self): " Set the header with the version used." - self.header[0] = " ".join(["#LyX %s created this file." % version__, - "For more info see http://www.lyx.org/"]) + + initial_comment = " ".join(["#LyX %s created this file." % version__, + "For more info see http://www.lyx.org/"]) + + # Simple heuristic to determine the comment that always starts + # a lyx file + if self.header[0].startswith("#"): + self.header[0] = initial_comment + else: + self.header.insert(0, initial_comment) + + # Old lyx files had a two lines comment header: + # 1) the first line had the user who had created it + # 2) the second line had the lyx version used + # later we decided that 1) was a privacy risk for no gain + # here we remove the second line effectively erasing 1) if self.header[1][0] == '#': del self.header[1] @@ -464,16 +556,21 @@ class LyX_base: def convert(self): "Convert from current (self.format) to self.end_format." - mode, convertion_chain = self.chain() - self.warning("convertion chain: " + str(convertion_chain), 3) + if self.format == self.end_format: + self.warning("No conversion needed: Target format %s " + "same as current format!" % self.format, default_debug__) + return - for step in convertion_chain: + mode, conversion_chain = self.chain() + self.warning("conversion chain: " + str(conversion_chain), 3) + + for step in conversion_chain: steps = getattr(__import__("lyx_" + step), mode) self.warning("Convertion step: %s - %s" % (step, mode), default_debug__ + 1) if not steps: - self.error("The convertion to an older " + self.error("The conversion to an older " "format (%s) is not implemented." % self.format) multi_conv = len(steps) != 1 @@ -506,7 +603,7 @@ class LyX_base: def chain(self): """ This is where all the decisions related with the - convertion are taken. It returns a list of modules needed to + conversion are taken. It returns a list of modules needed to convert the LyX file from self.format to self.end_format""" self.start = self.format @@ -545,13 +642,14 @@ class LyX_base: steps = [] if (initial_step, self.start) < (final_step, self.end_format): mode = "convert" - first_step = 1 + full_steps = [] for step in format_relation: - if initial_step <= step[0] <= final_step: - if first_step and len(step[1]) == 1: - first_step = 0 - continue - steps.append(step[0]) + if initial_step <= step[0] <= final_step and step[2][0] <= self.final_version: + full_steps.append(step) + if full_steps[0][1][-1] == self.format: + full_steps = full_steps[1:] + for step in full_steps: + steps.append(step[0]) else: mode = "revert" relation_format = format_relation[:] @@ -570,162 +668,170 @@ class LyX_base: return mode, steps - def get_toc(self, depth = 4): - " Returns the TOC of this LyX document." - paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, - 'Subsection' : 3, 'Subsubsection': 4} - allowed_insets = ['Quotes'] - allowed_parameters = ('\\paragraph_spacing', '\\noindent', - '\\align', '\\labelwidthstring', - "\\start_of_appendix", "\\leftindent") - sections = [] - for section in paragraphs_filter.keys(): - sections.append('\\begin_layout %s' % section) - - toc_par = [] - i = 0 - while 1: - i = find_tokens(self.body, sections, i) - if i == -1: - break - - j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout') - if j == -1: - self.warning('Incomplete file.', 0) - break - - section = self.body[i].split()[1] - if section[-1] == '*': - section = section[:-1] - - par = [] - - k = i + 1 - # skip paragraph parameters - while not self.body[k].strip() or self.body[k].split()[0] \ - in allowed_parameters: - k += 1 - - while k < j: - if check_token(self.body[k], '\\begin_inset'): - inset = self.body[k].split()[1] - end = find_end_of_inset(self.body, k) - if end == -1 or end > j: - self.warning('Malformed file.', 0) - - if inset in allowed_insets: - par.extend(self.body[k: end+1]) - k = end + 1 - else: - par.append(self.body[k]) - k += 1 - - # trim empty lines in the end. - while par and par[-1].strip() == '': - par.pop() - - toc_par.append(Paragraph(section, par)) - - i = j + 1 - - return toc_par +# Part of an unfinished attempt to make lyx2lyx gave a more +# structured view of the document. +# def get_toc(self, depth = 4): +# " Returns the TOC of this LyX document." +# paragraphs_filter = {'Title' : 0,'Chapter' : 1, 'Section' : 2, +# 'Subsection' : 3, 'Subsubsection': 4} +# allowed_insets = ['Quotes'] +# allowed_parameters = ('\\paragraph_spacing', '\\noindent', +# '\\align', '\\labelwidthstring', +# "\\start_of_appendix", "\\leftindent") +# sections = [] +# for section in paragraphs_filter.keys(): +# sections.append('\\begin_layout %s' % section) + +# toc_par = [] +# i = 0 +# while 1: +# i = find_tokens(self.body, sections, i) +# if i == -1: +# break + +# j = find_end_of(self.body, i + 1, '\\begin_layout', '\\end_layout') +# if j == -1: +# self.warning('Incomplete file.', 0) +# break + +# section = self.body[i].split()[1] +# if section[-1] == '*': +# section = section[:-1] + +# par = [] + +# k = i + 1 +# # skip paragraph parameters +# while not self.body[k].strip() or self.body[k].split()[0] \ +# in allowed_parameters: +# k += 1 + +# while k < j: +# if check_token(self.body[k], '\\begin_inset'): +# inset = self.body[k].split()[1] +# end = find_end_of_inset(self.body, k) +# if end == -1 or end > j: +# self.warning('Malformed file.', 0) + +# if inset in allowed_insets: +# par.extend(self.body[k: end+1]) +# k = end + 1 +# else: +# par.append(self.body[k]) +# k += 1 + +# # trim empty lines in the end. +# while par and par[-1].strip() == '': +# par.pop() + +# toc_par.append(Paragraph(section, par)) + +# i = j + 1 + +# return toc_par class File(LyX_base): " This class reads existing LyX files." def __init__(self, end_format = 0, input = "", output = "", error = "", - debug = default_debug__, try_hard = 0, cjk_encoding = ''): + debug = default_debug__, try_hard = 0, cjk_encoding = '', + final_version = '', systemlyxdir = ''): LyX_base.__init__(self, end_format, input, output, error, - debug, try_hard, cjk_encoding) + debug, try_hard, cjk_encoding, final_version, + systemlyxdir) self.read() -class NewFile(LyX_base): - " This class is to create new LyX files." - def set_header(self, **params): - # set default values - self.header.extend([ - "#LyX xxxx created this file." - "For more info see http://www.lyx.org/", - "\\lyxformat xxx", - "\\begin_document", - "\\begin_header", - "\\textclass article", - "\\language english", - "\\inputencoding auto", - "\\font_roman default", - "\\font_sans default", - "\\font_typewriter default", - "\\font_default_family default", - "\\font_sc false", - "\\font_osf false", - "\\font_sf_scale 100", - "\\font_tt_scale 100", - "\\graphics default", - "\\paperfontsize default", - "\\papersize default", - "\\use_geometry false", - "\\use_amsmath 1", - "\\cite_engine basic", - "\\use_bibtopic false", - "\\paperorientation portrait", - "\\secnumdepth 3", - "\\tocdepth 3", - "\\paragraph_separation indent", - "\\defskip medskip", - "\\quotes_language english", - "\\papercolumns 1", - "\\papersides 1", - "\\paperpagestyle default", - "\\tracking_changes false", - "\\end_header"]) - - self.format = get_end_format() - for param in params: - self.set_parameter(param, params[param]) - - - def set_body(self, paragraphs): - self.body.extend(['\\begin_body','']) - - for par in paragraphs: - self.body.extend(par.asLines()) - - self.body.extend(['','\\end_body', '\\end_document']) - - -class Paragraph: - # unfinished implementation, it is missing the Text and Insets - # representation. - " This class represents the LyX paragraphs." - def __init__(self, name, body=[], settings = [], child = []): - """ Parameters: - name: paragraph name. - body: list of lines of body text. - child: list of paragraphs that descend from this paragraph. - """ - self.name = name - self.body = body - self.settings = settings - self.child = child - - def asLines(self): - """ Converts the paragraph to a list of strings, representing - it in the LyX file.""" - - result = ['','\\begin_layout %s' % self.name] - result.extend(self.settings) - result.append('') - result.extend(self.body) - result.append('\\end_layout') - - if not self.child: - return result - - result.append('\\begin_deeper') - for node in self.child: - result.extend(node.asLines()) - result.append('\\end_deeper') - - return result +# FIXME: header settings are completely outdated, don't use like this +#class NewFile(LyX_base): +# " This class is to create new LyX files." +# def set_header(self, **params): +# # set default values +# self.header.extend([ +# "#LyX xxxx created this file." +# "For more info see http://www.lyx.org/", +# "\\lyxformat xxx", +# "\\begin_document", +# "\\begin_header", +# "\\textclass article", +# "\\language english", +# "\\inputencoding auto", +# "\\font_roman default", +# "\\font_sans default", +# "\\font_typewriter default", +# "\\font_default_family default", +# "\\font_sc false", +# "\\font_osf false", +# "\\font_sf_scale 100", +# "\\font_tt_scale 100", +# "\\graphics default", +# "\\paperfontsize default", +# "\\papersize default", +# "\\use_geometry false", +# "\\use_amsmath 1", +# "\\cite_engine basic", +# "\\use_bibtopic false", +# "\\use_indices false", +# "\\paperorientation portrait", +# "\\secnumdepth 3", +# "\\tocdepth 3", +# "\\paragraph_separation indent", +# "\\defskip medskip", +# "\\quotes_language english", +# "\\papercolumns 1", +# "\\papersides 1", +# "\\paperpagestyle default", +# "\\tracking_changes false", +# "\\end_header"]) + +# self.format = get_end_format() +# for param in params: +# self.set_parameter(param, params[param]) + + +# def set_body(self, paragraphs): +# self.body.extend(['\\begin_body','']) + +# for par in paragraphs: +# self.body.extend(par.asLines()) + +# self.body.extend(['','\\end_body', '\\end_document']) + + +# Part of an unfinished attempt to make lyx2lyx gave a more +# structured view of the document. +#class Paragraph: +# # unfinished implementation, it is missing the Text and Insets +# # representation. +# " This class represents the LyX paragraphs." +# def __init__(self, name, body=[], settings = [], child = []): +# """ Parameters: +# name: paragraph name. +# body: list of lines of body text. +# child: list of paragraphs that descend from this paragraph. +# """ +# self.name = name +# self.body = body +# self.settings = settings +# self.child = child + +# def asLines(self): +# """ Converts the paragraph to a list of strings, representing +# it in the LyX file.""" + +# result = ['','\\begin_layout %s' % self.name] +# result.extend(self.settings) +# result.append('') +# result.extend(self.body) +# result.append('\\end_layout') + +# if not self.child: +# return result + +# result.append('\\begin_deeper') +# for node in self.child: +# result.extend(node.asLines()) +# result.append('\\end_deeper') + +# return result