X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2Flyx2lyx%2FLyX.py;h=187a30821322fa0edc13db30ac5aff2ac16c7eb4;hb=b8227ebda0a2a8127731749d2caaa5dae45ef5d7;hp=41c12b63743d924fbe2e91496f392ab6575f0235;hpb=ba7ff6f4a13564dedeb3f5071753c8f1e88be10b;p=lyx.git

diff --git a/lib/lyx2lyx/LyX.py b/lib/lyx2lyx/LyX.py
index 41c12b6374..187a308213 100644
--- a/lib/lyx2lyx/LyX.py
+++ b/lib/lyx2lyx/LyX.py
@@ -16,22 +16,26 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-from parser_tools import get_value, check_token, find_token
+from parser_tools import get_value, check_token, find_token,\
+     find_tokens, find_end_of, find_end_of_inset
 import os.path
 import gzip
 import sys
 import re
 import string
+import time
 
-##
-# file format version
-#
-version = "1.4.0cvs"
+version_lyx2lyx = "1.4.0cvs"
 default_debug_level = 2
+
+# Regular expressions used
 format_re = re.compile(r"(\d)[\.,]?(\d\d)")
 fileformat = re.compile(r"\\lyxformat\s*(\S*)")
 original_version = re.compile(r"\#LyX (\S*)")
 
+##
+# file format information:
+#  file, supported formats, stable release versions
 format_relation = [("0_10",  [210], ["0.10.7","0.10"]),
                    ("0_12",  [215], ["0.12","0.12.1","0.12"]),
                    ("1_0_0", [215], ["1.0.0","1.0"]),
@@ -41,11 +45,12 @@ format_relation = [("0_10",  [210], ["0.10.7","0.10"]),
                    ("1_1_6", [217], ["1.1.6","1.1.6fix1","1.1.6fix2","1.1"]),
                    ("1_1_6fix3", [218], ["1.1.6fix3","1.1.6fix4","1.1"]),
                    ("1_2", [220], ["1.2.0","1.2.1","1.2.3","1.2.4","1.2"]),
-                   ("1_3", [221], ["1.3.0","1.3.1","1.3.2","1.3.3","1.3.4","1.3.5","1.3"]),
-                   ("1_4", range(223,238), ["1.4.0cvs","1.4"])]
+                   ("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"]),
+                   ("1_4", range(222,246), ["1.4.0cvs","1.4"])]
 
 
 def formats_list():
+    " Returns a list with supported file formats."
     formats = []
     for version in format_relation:
         for format in version[1]:
@@ -55,10 +60,12 @@ def formats_list():
 
 
 def get_end_format():
+    " Returns the more recent file format available."
     return format_relation[-1][1][-1]
 
 
 def get_backend(textclass):
+    " For _textclass_ returns its backend."
     if textclass == "linuxdoc" or textclass == "manpage":
         return "linuxdoc"
     if textclass[:7] == "docbook":
@@ -66,20 +73,28 @@ def get_backend(textclass):
     return "latex"
 
 
+def trim_eol(line):
+    " Remove end of line char(s)."
+    if line[-2:-1] == '\r':
+        return line[:-2]
+    else:
+        return line[:-1]
+
+
 ##
 # Class
 #
-class FileInfo:
+class LyX_Base:
     """This class carries all the information of the LyX file."""
-    def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level):
-        if input and input != '-':
-            self.input = self.open(input)
-        else:
-            self.input = sys.stdin
-        if output:
-            self.output = open(output, "w")
-        else:
-            self.output = sys.stdout
+    def __init__(self, end_format = 0, input = "", output = "", error = "", debug = default_debug_level, try_hard = 0):
+        """Arguments:
+        end_format: final format that the file should be converted. (integer)
+        input: the name of the input source, if empty resort to standard input.
+        output: the name of the output file, if empty use the standard output.
+        error: the name of the error file, if empty use the standard error.
+        debug: debug level, O means no debug, as its value increases be more verbose.
+        """
+        self.choose_io(input, output)
 
         if error:
             self.err = open(error, "w")
@@ -87,6 +102,7 @@ class FileInfo:
             self.err = sys.stderr
 
         self.debug = debug
+        self.try_hard = try_hard
 
         if end_format:
             self.end_format = self.lyxformat(end_format)
@@ -95,42 +111,66 @@ class FileInfo:
 
         self.backend = "latex"
         self.textclass = "article"
+        # This is a hack: We use '' since we don't know the default
+        # layout of the text class. LyX will parse it as default layout.
+        # FIXME: Read the layout file and use the real default layout
+        self.default_layout = ''
         self.header = []
+        self.preamble = []
         self.body = []
-        self.read()
+        self.status = 0
+
 
     def warning(self, message, debug_level= default_debug_level):
+        " Emits warning to self.error, if the debug_level is less than the self.debug."
         if debug_level <= self.debug:
-            self.err.write(message + "\n")
+            self.err.write("Warning: " + message + "\n")
+
 
     def error(self, message):
+        " Emits a warning and exits if not in try_hard mode."
         self.warning(message)
-        self.warning("Quiting.")
-        sys.exit(1)
+        if not self.try_hard:
+            self.warning("Quiting.")
+            sys.exit(1)
+
+        self.status = 2
+
 
     def read(self):
-        """Reads a file into the self.header and self.body parts"""
-        preamble = 0
+        """Reads a file into the self.header and self.body parts, from self.input."""
 
         while 1:
             line = self.input.readline()
             if not line:
                 self.error("Invalid LyX file.")
 
-            line = line[:-1]
-            # remove '\r' from line's end, if present
-            if line[-1:] == '\r':
-                line = line[:-1]
-
+            line = trim_eol(line)
             if check_token(line, '\\begin_preamble'):
-                preamble = 1
+                while 1:
+                    line = self.input.readline()
+                    if not line:
+                        self.error("Invalid LyX file.")
+
+                    line = trim_eol(line)
+                    if check_token(line, '\\end_preamble'):
+                        break
+                    
+                    if string.split(line)[:0] in ("\\layout", "\\begin_layout", "\\begin_body"):
+                        self.warning("Malformed LyX file: Missing '\\end_preamble'.")
+                        self.warning("Adding it now and hoping for the best.")
+
+                    self.preamble.append(line)
+
             if check_token(line, '\\end_preamble'):
-                preamble = 0
+                continue
 
-            if not preamble:
-                line = string.strip(line)
+            line = string.strip(line)
+            if not line:
+                continue
 
-            if not line and not preamble:
+            if string.split(line)[0] in ("\\layout", "\\begin_layout", "\\begin_body"):
+                self.body.append(line)
                 break
 
             self.header.append(line)
@@ -139,11 +179,7 @@ class FileInfo:
             line = self.input.readline()
             if not line:
                 break
-            # remove '\r' from line's end, if present
-            if line[-2:-1] == '\r':
-                self.body.append(line[:-2])
-            else:
-                self.body.append(line[:-1])
+            self.body.append(trim_eol(line))
 
         self.textclass = get_value(self.header, "\\textclass", 0)
         self.backend = get_backend(self.textclass)
@@ -153,29 +189,49 @@ class FileInfo:
             self.language = "english"
         self.initial_version = self.read_version()
 
+
     def write(self):
+        " Writes the LyX file to self.output."
         self.set_version()
         self.set_format()
 
-        for line in self.header:
-            self.output.write(line+"\n")
-        self.output.write("\n")
-        for line in self.body:
+        if self.preamble:
+            i = find_token(self.header, '\\textclass', 0) + 1
+            preamble = ['\\begin_preamble'] + self.preamble + ['\\end_preamble']
+            if i == 0:
+                self.error("Malformed LyX file: Missing '\\textclass'.")
+            else:
+                header = self.header[:i] + preamble + self.header[i:]
+        else:
+            header = self.header
+
+        for line in header + [''] + self.body:
             self.output.write(line+"\n")
 
 
-    def open(self, file):
-        """Transparently deals with compressed files."""
+    def choose_io(self, input, output):
+        """Choose input and output streams, dealing transparently with
+        compressed files."""
+
+        if output:
+            self.output = open(output, "wb")
+        else:
+            self.output = sys.stdout
+
+        if input and input != '-':
+            self.dir = os.path.dirname(os.path.abspath(input))
+            try:
+                gzip.open(input).readline()
+                self.input = gzip.open(input)
+                self.output = gzip.GzipFile(mode="wb", fileobj=self.output) 
+            except:
+                self.input = open(input)
+        else:
+            self.input = sys.stdin
 
-        self.dir = os.path.dirname(os.path.abspath(file))
-        try:
-            gzip.open(file).readline()
-            self.output = gzip.GzipFile("","wb",6,self.output)
-            return gzip.open(file)
-        except:
-            return open(file)
 
     def lyxformat(self, format):
+        " Returns the file format representation, an integer."
         result = format_re.match(format)
         if result:
             format = int(result.group(1) + result.group(2))
@@ -188,7 +244,10 @@ class FileInfo:
         self.error(str(format) + ": " + "Format not supported.")
         return None
 
+
     def read_version(self):
+        """ Searchs for clues of the LyX version used to write the file, returns the
+        most likely value, or None otherwise."""
         for line in self.header:
             if line[0] != "#":
                 return None
@@ -198,12 +257,16 @@ class FileInfo:
                 return result.group(1)
         return None
 
+
     def set_version(self):
-        self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version
+        " Set the header with the version used."
+        self.header[0] = "#LyX %s created this file. For more info see http://www.lyx.org/" % version_lyx2lyx
         if self.header[1][0] == '#':
             del self.header[1]
 
+
     def read_format(self):
+        " Read from the header the fileformat of the present LyX file."
         for line in self.header:
             result = fileformat.match(line)
             if result:
@@ -214,16 +277,74 @@ class FileInfo:
 
 
     def set_format(self):
+        " Set the file format of the file, in the header."
         if self.format <= 217:
-            format = str(float(format)/100)
+            format = str(float(self.format)/100)
         else:
             format = str(self.format)
         i = find_token(self.header, "\\lyxformat", 0)
         self.header[i] = "\\lyxformat %s" % format
 
 
+    def set_parameter(self, param, value):
+        " Set the value of the header parameter."
+        i = find_token(self.header, '\\' + param, 0)
+        if i == -1:
+            self.warning('Parameter not found in the header: %s' % param, 3)
+            return
+        self.header[i] = '\\%s %s' % (param, str(value))
+
+
+    def is_default_layout(self, layout):
+        " Check whether a layout is the default layout of this class."
+        # FIXME: Check against the real text class default layout
+        if layout == 'Standard' or layout == self.default_layout:
+            return 1
+        return 0
+
+
+    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)
+
+        for step in convertion_chain:
+            steps = getattr(__import__("lyx_" + step), mode)
+
+            self.warning("Convertion step: %s - %s" % (step, mode), default_debug_level + 1)
+            if not steps:
+                    self.error("The convertion to an older format (%s) is not implemented." % self.format)
+
+            multi_conv = len(steps) != 1
+            for version, table in steps:
+                if multi_conv and \
+                   (self.format >= version and mode == "convert") or\
+                   (self.format <= version and mode == "revert"):
+                    continue
+
+                for conv in table:
+                    init_t = time.time()
+                    try:
+                        conv(self)
+                    except:
+                        self.warning("An error ocurred in %s, %s" % (version, str(conv)),
+                                     default_debug_level)
+                        if not self.try_hard:
+                            raise
+                        self.status = 2
+                    else:
+                        self.warning("%lf: Elapsed time on %s"  % (time.time() - init_t, str(conv)),
+                                     default_debug_level + 1)
+
+                self.format = version
+                if self.end_format == self.format:
+                    return
+
+
     def chain(self):
-        """ This is where all the decisions related with the convertion are taken"""
+        """ This is where all the decisions related with the convertion 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
         format = self.format
@@ -268,7 +389,7 @@ class FileInfo:
                     steps.append(step[0])
         else:
             mode = "revert"
-            relation_format = format_relation
+            relation_format = format_relation[:]
             relation_format.reverse()
             last_step = None
 
@@ -281,3 +402,157 @@ class FileInfo:
                 steps.pop()
 
         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 = string.split(self.body[i])[1]
+            if section[-1] == '*':
+                section = section[:-1]
+
+            par = []
+
+            k = i + 1
+            # skip paragraph parameters
+            while not string.strip(self.body[k]) or string.split(self.body[k])[0] in allowed_parameters:
+                k = k +1
+
+            while k < j:
+                if check_token(self.body[k], '\\begin_inset'):
+                    inset = string.split(self.body[k])[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 = k + 1
+
+            # trim empty lines in the end.
+            while string.strip(par[-1]) == '' and par:
+                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_level, try_hard = 0):
+        LyX_Base.__init__(self, end_format, input, output, error, debug, try_hard)
+        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",
+            "\\fontscheme default",
+            "\\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
+
+
+class Inset:
+    " This class represents the LyX insets."
+    pass
+
+
+class Text:
+    " This class represents simple chuncks of text."
+    pass