#! /usr/bin/env python
-# -*- coding: iso-8859-1 -*-
+# -*- coding: utf-8 -*-
# file layout2layout.py
# This file is part of LyX, the document processor.
# Full author contact details are available in file CREDITS
-# This script will update a .layout file to format 2
+# This script will update a .layout file to format 3
import os, re, string, sys
output.write(line + os.linesep)
+# Concatenates old and new in an intelligent way:
+# If old is wrapped in ", they are stripped. The result is wrapped in ".
+def concatenate_label(old, new):
+ # Don't use strip as long as we support python 1.5.2
+ if old[0] == '"':
+ return old[0:-1] + new + '"'
+ else:
+ return '"' + old + new + '"'
+
+
def convert(lines):
" Convert to new format."
re_Comment = re.compile(r'^(\s*)#')
re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
- re_MaxCounter = re.compile(r'^\s*MaxCounter', re.IGNORECASE)
+ re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
+ re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
+ re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
+ re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
+ re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
+ re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
+
+ # counters for sectioning styles (hardcoded in 1.3)
+ counters = {"part" : "\\Roman{part}",
+ "chapter" : "\\arabic{chapter}",
+ "section" : "\\arabic{section}",
+ "subsection" : "\\arabic{section}.\\arabic{subsection}",
+ "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
+ "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
+ "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
+
+ # counters for sectioning styles in appendix (hardcoded in 1.3)
+ appendixcounters = {"chapter" : "\\Alph{chapter}",
+ "section" : "\\Alph{section}",
+ "subsection" : "\\arabic{section}.\\arabic{subsection}",
+ "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
+ "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
+ "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
+
+ # Value of TocLevel for sectioning styles
+ toclevels = {"part" : 0,
+ "chapter" : 0,
+ "section" : 1,
+ "subsection" : 2,
+ "subsubsection" : 3,
+ "paragraph" : 4,
+ "subparagraph" : 5}
i = 0
only_comment = 1
+ counter = ""
label = ""
+ labelstring = ""
+ labelstringappendix = ""
space1 = ""
+ labelstring_line = -1
+ labelstringappendix_line = -1
+ labeltype_line = -1
latextype = ""
+ latextype_line = -1
style = ""
+ maxcounter = 0
+ format = 1
while i < len(lines):
# Skip comments and empty lines
i = i + 1
continue
- # insert file format if not already there
+ # insert file format if not already there
if (only_comment):
match = re_Format.match(lines[i])
if match:
- format = match.group(4)
- if format == '2':
+ format = int(match.group(4))
+ if format > 1 and format < 4:
+ lines[i] = "Format %d" % (format + 1)
+ only_comment = 0
+ elif format == 4:
# nothing to do
- return
- error('Cannot convert file format %s' % format)
+ return format
+ else:
+ error('Cannot convert file format %s' % format)
else:
- lines.insert(i, "Format 2")
+ lines.insert(i, "Format 2")
only_comment = 0
continue
i = i + 1
continue
- # Delete MaxCounter
- if re_MaxCounter.match(lines[i]):
+ if format == 3:
+ # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
+ # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
+ # x is either 0 or 1
+ match = re_Provides.match(lines[i])
+ if match:
+ lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
+ match.group(3), match.group(4))
+ i = i + 1
+ continue
+
+ if format == 2:
+ caption = []
+
+ # delete caption styles
+ match = re_Style.match(lines[i])
+ if match:
+ style = string.lower(match.group(4))
+ if style == "caption":
+ del lines[i]
+ while i < len(lines) and not re_End.match(lines[i]):
+ caption.append(lines[i])
+ del lines[i]
+ if i == len(lines):
+ error('Incomplete caption style.')
+ else:
+ del lines[i]
+ continue
+
+ # delete undefinition of caption styles
+ match = re_NoStyle.match(lines[i])
+ if match:
+ style = string.lower(match.group(4))
+ if style == "caption":
+ del lines[i]
+ continue
+
+ # replace the CopyStyle statement with the definition of the real
+ # style. This may result in duplicate statements, but that is OK
+ # since the second one will overwrite the first one.
+ match = re_CopyStyle.match(lines[i])
+ if match:
+ style = string.lower(match.group(4))
+ if style == "caption":
+ if len(caption) > 0:
+ lines[i:i+1] = caption
+ else:
+ # FIXME: This style comes from an include file, we
+ # should replace the real style and not this default.
+ lines[i:i+1] = [' Margin First_Dynamic',
+ ' LatexType Command',
+ ' LatexName caption',
+ ' NeedProtect 1',
+ ' LabelSep xx',
+ ' ParSkip 0.4',
+ ' TopSep 0.5',
+ ' Align Center',
+ ' AlignPossible Center',
+ ' LabelType Sensitive',
+ ' LabelString "Senseless!"',
+ ' OptionalArgs 1',
+ ' LabelFont',
+ ' Series Bold',
+ ' EndFont']
+
+ i = i + 1
+ continue
+
+ # Delete MaxCounter and remember the value of it
+ match = re_MaxCounter.match(lines[i])
+ if match:
+ level = match.group(4)
+ if string.lower(level) == "counter_chapter":
+ maxcounter = 0
+ elif string.lower(level) == "counter_section":
+ maxcounter = 1
+ elif string.lower(level) == "counter_subsection":
+ maxcounter = 2
+ elif string.lower(level) == "counter_subsubsection":
+ maxcounter = 3
+ elif string.lower(level) == "counter_paragraph":
+ maxcounter = 4
+ elif string.lower(level) == "counter_subparagraph":
+ maxcounter = 5
+ elif string.lower(level) == "counter_enumi":
+ maxcounter = 6
+ elif string.lower(level) == "counter_enumii":
+ maxcounter = 7
+ elif string.lower(level) == "counter_enumiii":
+ maxcounter = 8
del lines[i]
continue
match = re_LabelType.match(lines[i])
if match:
label = match.group(4)
+ # Remember indenting space for later reuse in added lines
space1 = match.group(1)
+ # Remember the line for adding the LabelCounter later.
+ # We can't do it here because it could shift latextype_line etc.
+ labeltype_line = i
if string.lower(label[:8]) == "counter_":
- counter = label[8:]
+ counter = string.lower(label[8:])
lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
- # use the same indentation
- lines.insert(i + 1, "%sLabelCounter %s" % (space1, counter))
- # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
- # (or change the existing LatexType)
+ # Remember the LabelString line
+ match = re_LabelString.match(lines[i])
+ if match:
+ labelstring = match.group(4)
+ labelstring_line = i
+
+ # Remember the LabelStringAppendix line
+ match = re_LabelStringAppendix.match(lines[i])
+ if match:
+ labelstringappendix = match.group(4)
+ labelstringappendix_line = i
+
+ # Remember the LatexType line
match = re_LatexType.match(lines[i])
if match:
- latextype = match.group(4)
- lines[i] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[i])
+ latextype = string.lower(match.group(4))
+ latextype_line = i
+
+ # Reset variables at the beginning of a style definition
match = re_Style.match(lines[i])
if match:
- style = match.group(4)
+ style = string.lower(match.group(4))
+ counter = ""
label = ""
space1 = ""
+ labelstring = ""
+ labelstringappendix = ""
+ labelstring_line = -1
+ labelstringappendix_line = -1
+ labeltype_line = -1
latextype = ""
- if re_End.match(lines[i]) and string.lower(label) == "bibliography":
- if (latextype == ""):
- lines.insert(i, "%sLatexType Bib_Environment" % space1)
+ latextype_line = -1
+
+ if re_End.match(lines[i]):
+
+ # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
+ # (or change the existing LatexType)
+ if string.lower(label) == "bibliography":
+ if (latextype_line < 0):
+ lines.insert(i, "%sLatexType Bib_Environment" % space1)
+ i = i + 1
+ else:
+ lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
+
+ # Change "LabelType Static" to "LabelType Itemize" for itemize environments
+ if latextype == "item_environment" and string.lower(label) == "static":
+ lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
+
+ # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
+ if latextype == "item_environment" and string.lower(label) == "counter_enumi":
+ lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
+ # Don't add the LabelCounter line later
+ counter = ""
+
+ # Replace
+ #
+ # LabelString "Chapter"
+ #
+ # with
+ #
+ # LabelString "Chapter \arabic{chapter}"
+ #
+ # if this style has a counter. Ditto for LabelStringAppendix.
+ # This emulates the hardcoded article style numbering of 1.3
+ #
+ if counter != "":
+ if counters.has_key(style):
+ if labelstring_line < 0:
+ lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
+ i = i + 1
+ else:
+ new_labelstring = concatenate_label(labelstring, counters[style])
+ lines[labelstring_line] = re_LabelString.sub(
+ r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
+ lines[labelstring_line])
+ if appendixcounters.has_key(style):
+ if labelstringappendix_line < 0:
+ lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
+ i = i + 1
+ else:
+ new_labelstring = concatenate_label(labelstring, appendixcounters[style])
+ lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
+ r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
+ lines[labelstringappendix_line])
+
+ # Now we can safely add the LabelCounter line
+ lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
+ i = i + 1
+
+ # Add the TocLevel setting for sectioning styles
+ if toclevels.has_key(style) and maxcounter <= toclevels[style]:
+ lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
i = i + 1
i = i + 1
+ return format + 1
+
def main(argv):
# Do the real work
lines = read(input)
- convert(lines)
+ format = 1
+ while (format < 4):
+ format = convert(lines)
write(output, lines)
# Close files