2 # -*- coding: utf-8 -*-
4 # file layout2layout.py
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
10 # Full author contact details are available in file CREDITS
12 # This script will update a .layout file to format 6
15 import os, re, string, sys
17 # Incremented to format 4, 6 April 2007, lasgouttes
18 # Introduction of generic "Provides" declaration
20 # Incremented to format 5, 22 August 2007 by vermeer
21 # InsetLayout material
23 # Incremented to format 6, 7 January 2008 by spitz
24 # Requires tag added to layout files
26 # Incremented to format 7, 24 March 2008 by rgh
27 # AddToPreamble tag added to layout files
29 # Incremented to format 8, 25 July 2008 by rgh
30 # UseModule tag added to layout files
31 # CopyStyle added to InsetLayout
33 # Incremented to format 9, 5 October 2008 by rgh
34 # ForcePlain and CustomPars tags added to InsetLayout
40 return ("Usage: %s inputfile outputfile\n" % prog_name +
41 "or %s <inputfile >outputfile" % prog_name)
45 sys.stderr.write(message + '\n')
50 " Remove end of line char(s)."
51 if line[-2:-1] == '\r':
53 elif line[-1:] == '\r' or line[-1:] == '\n':
56 # file with no EOL in last line
61 " Read input file and strip lineendings."
64 line = input.readline()
67 lines.append(trim_eol(line))
71 def write(output, lines):
72 " Write output file with native lineendings."
74 output.write(line + os.linesep)
77 # Concatenates old and new in an intelligent way:
78 # If old is wrapped in ", they are stripped. The result is wrapped in ".
79 def concatenate_label(old, new):
80 # Don't use strip as long as we support python 1.5.2
82 return old[0:-1] + new + '"'
84 return '"' + old + new + '"'
88 " Convert to new format."
89 re_Comment = re.compile(r'^(\s*)#')
90 re_Empty = re.compile(r'^(\s*)$')
91 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
92 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
93 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
94 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
95 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
96 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
97 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
98 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
99 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
100 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
101 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
102 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
103 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
104 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
106 # counters for sectioning styles (hardcoded in 1.3)
107 counters = {"part" : "\\Roman{part}",
108 "chapter" : "\\arabic{chapter}",
109 "section" : "\\arabic{section}",
110 "subsection" : "\\arabic{section}.\\arabic{subsection}",
111 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
112 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
113 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
115 # counters for sectioning styles in appendix (hardcoded in 1.3)
116 appendixcounters = {"chapter" : "\\Alph{chapter}",
117 "section" : "\\Alph{section}",
118 "subsection" : "\\arabic{section}.\\arabic{subsection}",
119 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
120 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
121 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
123 # Value of TocLevel for sectioning styles
124 toclevels = {"part" : 0,
137 labelstringappendix = ""
139 labelstring_line = -1
140 labelstringappendix_line = -1
147 while i < len(lines):
149 # Skip comments and empty lines
150 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
154 # insert file format if not already there
156 match = re_Format.match(lines[i])
158 format = int(match.group(4))
159 if format > 1 and format < currentFormat:
160 lines[i] = "Format %d" % (format + 1)
162 elif format == currentFormat:
166 error('Cannot convert file format %s' % format)
168 lines.insert(i, "Format 2")
172 # Don't get confused by LaTeX code
173 if re_Preamble.match(lines[i]):
175 while i < len(lines) and not re_EndPreamble.match(lines[i]):
179 # These just involved new features, not any changes to old ones
180 if format >= 5 and format <= 8:
185 # Handle conversion to long CharStyle names
186 match = re_CharStyle.match(lines[i])
188 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
190 lines.insert(i, "\tLyXType charstyle")
193 lines[i] = "\tLabelString %s" % (match.group(3))
198 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
199 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
201 match = re_Provides.match(lines[i])
203 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
204 match.group(3), match.group(4))
211 # delete caption styles
212 match = re_Style.match(lines[i])
214 style = string.lower(match.group(4))
215 if style == "caption":
217 while i < len(lines) and not re_End.match(lines[i]):
218 caption.append(lines[i])
221 error('Incomplete caption style.')
226 # delete undefinition of caption styles
227 match = re_NoStyle.match(lines[i])
229 style = string.lower(match.group(4))
230 if style == "caption":
234 # replace the CopyStyle statement with the definition of the real
235 # style. This may result in duplicate statements, but that is OK
236 # since the second one will overwrite the first one.
237 match = re_CopyStyle.match(lines[i])
239 style = string.lower(match.group(4))
240 if style == "caption":
242 lines[i:i+1] = caption
244 # FIXME: This style comes from an include file, we
245 # should replace the real style and not this default.
246 lines[i:i+1] = [' Margin First_Dynamic',
247 ' LatexType Command',
248 ' LatexName caption',
254 ' AlignPossible Center',
255 ' LabelType Sensitive',
256 ' LabelString "Senseless!"',
265 # Delete MaxCounter and remember the value of it
266 match = re_MaxCounter.match(lines[i])
268 level = match.group(4)
269 if string.lower(level) == "counter_chapter":
271 elif string.lower(level) == "counter_section":
273 elif string.lower(level) == "counter_subsection":
275 elif string.lower(level) == "counter_subsubsection":
277 elif string.lower(level) == "counter_paragraph":
279 elif string.lower(level) == "counter_subparagraph":
281 elif string.lower(level) == "counter_enumi":
283 elif string.lower(level) == "counter_enumii":
285 elif string.lower(level) == "counter_enumiii":
292 # LabelType Counter_EnumI
299 match = re_LabelType.match(lines[i])
301 label = match.group(4)
302 # Remember indenting space for later reuse in added lines
303 space1 = match.group(1)
304 # Remember the line for adding the LabelCounter later.
305 # We can't do it here because it could shift latextype_line etc.
307 if string.lower(label[:8]) == "counter_":
308 counter = string.lower(label[8:])
309 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
311 # Remember the LabelString line
312 match = re_LabelString.match(lines[i])
314 labelstring = match.group(4)
317 # Remember the LabelStringAppendix line
318 match = re_LabelStringAppendix.match(lines[i])
320 labelstringappendix = match.group(4)
321 labelstringappendix_line = i
323 # Remember the LatexType line
324 match = re_LatexType.match(lines[i])
326 latextype = string.lower(match.group(4))
329 # Reset variables at the beginning of a style definition
330 match = re_Style.match(lines[i])
332 style = string.lower(match.group(4))
337 labelstringappendix = ""
338 labelstring_line = -1
339 labelstringappendix_line = -1
344 if re_End.match(lines[i]):
346 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
347 # (or change the existing LatexType)
348 if string.lower(label) == "bibliography":
349 if (latextype_line < 0):
350 lines.insert(i, "%sLatexType Bib_Environment" % space1)
353 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
355 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
356 if latextype == "item_environment" and string.lower(label) == "static":
357 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
359 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
360 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
361 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
362 # Don't add the LabelCounter line later
367 # LabelString "Chapter"
371 # LabelString "Chapter \arabic{chapter}"
373 # if this style has a counter. Ditto for LabelStringAppendix.
374 # This emulates the hardcoded article style numbering of 1.3
377 if counters.has_key(style):
378 if labelstring_line < 0:
379 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
382 new_labelstring = concatenate_label(labelstring, counters[style])
383 lines[labelstring_line] = re_LabelString.sub(
384 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
385 lines[labelstring_line])
386 if appendixcounters.has_key(style):
387 if labelstringappendix_line < 0:
388 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
391 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
392 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
393 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
394 lines[labelstringappendix_line])
396 # Now we can safely add the LabelCounter line
397 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
400 # Add the TocLevel setting for sectioning styles
401 if toclevels.has_key(style) and maxcounter <= toclevels[style]:
402 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
417 input = open(argv[1], 'rb')
418 output = open(argv[2], 'wb')
420 error(usage(argv[0]))
425 while (format < currentFormat):
426 format = convert(lines)
437 if __name__ == "__main__":