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
32 return ("Usage: %s inputfile outputfile\n" % prog_name +
33 "or %s <inputfile >outputfile" % prog_name)
37 sys.stderr.write(message + '\n')
42 " Remove end of line char(s)."
43 if line[-2:-1] == '\r':
45 elif line[-1:] == '\r' or line[-1:] == '\n':
48 # file with no EOL in last line
53 " Read input file and strip lineendings."
56 line = input.readline()
59 lines.append(trim_eol(line))
63 def write(output, lines):
64 " Write output file with native lineendings."
66 output.write(line + os.linesep)
69 # Concatenates old and new in an intelligent way:
70 # If old is wrapped in ", they are stripped. The result is wrapped in ".
71 def concatenate_label(old, new):
72 # Don't use strip as long as we support python 1.5.2
74 return old[0:-1] + new + '"'
76 return '"' + old + new + '"'
80 " Convert to new format."
81 re_Comment = re.compile(r'^(\s*)#')
82 re_Empty = re.compile(r'^(\s*)$')
83 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
84 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
85 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
86 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
87 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
88 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
89 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
90 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
91 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
92 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
93 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
94 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
95 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
96 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
98 # counters for sectioning styles (hardcoded in 1.3)
99 counters = {"part" : "\\Roman{part}",
100 "chapter" : "\\arabic{chapter}",
101 "section" : "\\arabic{section}",
102 "subsection" : "\\arabic{section}.\\arabic{subsection}",
103 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
104 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
105 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
107 # counters for sectioning styles in appendix (hardcoded in 1.3)
108 appendixcounters = {"chapter" : "\\Alph{chapter}",
109 "section" : "\\Alph{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 # Value of TocLevel for sectioning styles
116 toclevels = {"part" : 0,
129 labelstringappendix = ""
131 labelstring_line = -1
132 labelstringappendix_line = -1
139 while i < len(lines):
141 # Skip comments and empty lines
142 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
146 # insert file format if not already there
148 match = re_Format.match(lines[i])
150 format = int(match.group(4))
151 if format > 1 and format < currentFormat:
152 lines[i] = "Format %d" % (format + 1)
154 elif format == currentFormat:
158 error('Cannot convert file format %s' % format)
160 lines.insert(i, "Format 2")
164 # Don't get confused by LaTeX code
165 if re_Preamble.match(lines[i]):
167 while i < len(lines) and not re_EndPreamble.match(lines[i]):
180 # Handle conversion to long CharStyle names
181 match = re_CharStyle.match(lines[i])
183 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
185 lines.insert(i, "\tLyXType charstyle")
188 lines[i] = "\tLabelString %s" % (match.group(3))
193 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
194 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
196 match = re_Provides.match(lines[i])
198 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
199 match.group(3), match.group(4))
206 # delete caption styles
207 match = re_Style.match(lines[i])
209 style = string.lower(match.group(4))
210 if style == "caption":
212 while i < len(lines) and not re_End.match(lines[i]):
213 caption.append(lines[i])
216 error('Incomplete caption style.')
221 # delete undefinition of caption styles
222 match = re_NoStyle.match(lines[i])
224 style = string.lower(match.group(4))
225 if style == "caption":
229 # replace the CopyStyle statement with the definition of the real
230 # style. This may result in duplicate statements, but that is OK
231 # since the second one will overwrite the first one.
232 match = re_CopyStyle.match(lines[i])
234 style = string.lower(match.group(4))
235 if style == "caption":
237 lines[i:i+1] = caption
239 # FIXME: This style comes from an include file, we
240 # should replace the real style and not this default.
241 lines[i:i+1] = [' Margin First_Dynamic',
242 ' LatexType Command',
243 ' LatexName caption',
249 ' AlignPossible Center',
250 ' LabelType Sensitive',
251 ' LabelString "Senseless!"',
260 # Delete MaxCounter and remember the value of it
261 match = re_MaxCounter.match(lines[i])
263 level = match.group(4)
264 if string.lower(level) == "counter_chapter":
266 elif string.lower(level) == "counter_section":
268 elif string.lower(level) == "counter_subsection":
270 elif string.lower(level) == "counter_subsubsection":
272 elif string.lower(level) == "counter_paragraph":
274 elif string.lower(level) == "counter_subparagraph":
276 elif string.lower(level) == "counter_enumi":
278 elif string.lower(level) == "counter_enumii":
280 elif string.lower(level) == "counter_enumiii":
287 # LabelType Counter_EnumI
294 match = re_LabelType.match(lines[i])
296 label = match.group(4)
297 # Remember indenting space for later reuse in added lines
298 space1 = match.group(1)
299 # Remember the line for adding the LabelCounter later.
300 # We can't do it here because it could shift latextype_line etc.
302 if string.lower(label[:8]) == "counter_":
303 counter = string.lower(label[8:])
304 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
306 # Remember the LabelString line
307 match = re_LabelString.match(lines[i])
309 labelstring = match.group(4)
312 # Remember the LabelStringAppendix line
313 match = re_LabelStringAppendix.match(lines[i])
315 labelstringappendix = match.group(4)
316 labelstringappendix_line = i
318 # Remember the LatexType line
319 match = re_LatexType.match(lines[i])
321 latextype = string.lower(match.group(4))
324 # Reset variables at the beginning of a style definition
325 match = re_Style.match(lines[i])
327 style = string.lower(match.group(4))
332 labelstringappendix = ""
333 labelstring_line = -1
334 labelstringappendix_line = -1
339 if re_End.match(lines[i]):
341 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
342 # (or change the existing LatexType)
343 if string.lower(label) == "bibliography":
344 if (latextype_line < 0):
345 lines.insert(i, "%sLatexType Bib_Environment" % space1)
348 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
350 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
351 if latextype == "item_environment" and string.lower(label) == "static":
352 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
354 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
355 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
356 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
357 # Don't add the LabelCounter line later
362 # LabelString "Chapter"
366 # LabelString "Chapter \arabic{chapter}"
368 # if this style has a counter. Ditto for LabelStringAppendix.
369 # This emulates the hardcoded article style numbering of 1.3
372 if counters.has_key(style):
373 if labelstring_line < 0:
374 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
377 new_labelstring = concatenate_label(labelstring, counters[style])
378 lines[labelstring_line] = re_LabelString.sub(
379 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
380 lines[labelstring_line])
381 if appendixcounters.has_key(style):
382 if labelstringappendix_line < 0:
383 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
386 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
387 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
388 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
389 lines[labelstringappendix_line])
391 # Now we can safely add the LabelCounter line
392 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
395 # Add the TocLevel setting for sectioning styles
396 if toclevels.has_key(style) and maxcounter <= toclevels[style]:
397 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
412 input = open(argv[1], 'rb')
413 output = open(argv[2], 'wb')
415 error(usage(argv[0]))
420 while (format < currentFormat):
421 format = convert(lines)
432 if __name__ == "__main__":