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
36 # Incremented to format 10, 6 October 2008 by rgh
37 # Change format of counters
43 return ("Usage: %s inputfile outputfile\n" % prog_name +
44 "or %s <inputfile >outputfile" % prog_name)
48 sys.stderr.write(message + '\n')
53 " Remove end of line char(s)."
54 if line[-2:-1] == '\r':
56 elif line[-1:] == '\r' or line[-1:] == '\n':
59 # file with no EOL in last line
64 " Read input file and strip lineendings."
67 line = input.readline()
70 lines.append(trim_eol(line))
74 def write(output, lines):
75 " Write output file with native lineendings."
77 output.write(line + os.linesep)
80 # Concatenates old and new in an intelligent way:
81 # If old is wrapped in ", they are stripped. The result is wrapped in ".
82 def concatenate_label(old, new):
83 # Don't use strip as long as we support python 1.5.2
85 return old[0:-1] + new + '"'
87 return '"' + old + new + '"'
89 # appends a string to a list unless it's already there
97 " Convert to new format."
98 re_Comment = re.compile(r'^(\s*)#')
99 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
100 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
101 re_Empty = re.compile(r'^(\s*)$')
102 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
103 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
104 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
105 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
106 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
107 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
108 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
109 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
110 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
111 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
112 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
113 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
114 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
115 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
116 re_AMSMaths = re.compile(r'^\s*Input amsmaths.inc\s*')
117 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
118 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
120 # counters for sectioning styles (hardcoded in 1.3)
121 counters = {"part" : "\\Roman{part}",
122 "chapter" : "\\arabic{chapter}",
123 "section" : "\\arabic{section}",
124 "subsection" : "\\arabic{section}.\\arabic{subsection}",
125 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
126 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
127 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
129 # counters for sectioning styles in appendix (hardcoded in 1.3)
130 appendixcounters = {"chapter" : "\\Alph{chapter}",
131 "section" : "\\Alph{section}",
132 "subsection" : "\\arabic{section}.\\arabic{subsection}",
133 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
134 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
135 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
137 # Value of TocLevel for sectioning styles
138 toclevels = {"part" : 0,
151 labelstringappendix = ""
153 labelstring_line = -1
154 labelstringappendix_line = -1
164 while i < len(lines):
165 # Skip comments and empty lines
166 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
170 # insert file format if not already there
172 match = re_Format.match(lines[i])
175 format = int(match.group(4))
176 if format > 1 and format < currentFormat:
177 lines[i] = "Format %d" % (format + 1)
179 elif format == currentFormat:
183 error('Cannot convert file format %s' % format)
185 lines.insert(i, "Format 2")
189 # Don't get confused by LaTeX code
190 if re_Preamble.match(lines[i]):
192 while i < len(lines) and not re_EndPreamble.match(lines[i]):
197 match = re_Counter.match(lines[i])
201 while i < len(lines):
202 namem = re_Name.match(lines[i])
204 name = namem.group(1)
206 lines[counterline] = "Counter %s" % name
207 # we don't need to increment i
209 endem = re_End.match(lines[i])
218 # We want to scan for ams-type includes and, if we find them,
219 # add corresponding UseModule tags to the layout.
220 match = re_AMSMaths.match(lines[i])
222 addstring("theorems-ams", usemodules)
223 addstring("theorems-ams-extended", usemodules)
224 addstring("theorems-sec", usemodules)
227 match = re_AMSMathsPlain.match(lines[i])
229 addstring("theorems-starred", usemodules)
232 match = re_AMSMathsSeq.match(lines[i])
234 addstring("theorems-ams", usemodules)
235 addstring("theorems-ams-extended", usemodules)
241 # These just involved new features, not any changes to old ones
242 if format >= 5 and format <= 7:
247 # Handle conversion to long CharStyle names
248 match = re_CharStyle.match(lines[i])
250 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
252 lines.insert(i, "\tLyXType charstyle")
255 lines[i] = "\tLabelString %s" % (match.group(3))
260 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
261 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
263 match = re_Provides.match(lines[i])
265 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
266 match.group(3), match.group(4))
273 # delete caption styles
274 match = re_Style.match(lines[i])
276 style = string.lower(match.group(4))
277 if style == "caption":
279 while i < len(lines) and not re_End.match(lines[i]):
280 caption.append(lines[i])
283 error('Incomplete caption style.')
288 # delete undefinition of caption styles
289 match = re_NoStyle.match(lines[i])
291 style = string.lower(match.group(4))
292 if style == "caption":
296 # replace the CopyStyle statement with the definition of the real
297 # style. This may result in duplicate statements, but that is OK
298 # since the second one will overwrite the first one.
299 match = re_CopyStyle.match(lines[i])
301 style = string.lower(match.group(4))
302 if style == "caption":
304 lines[i:i+1] = caption
306 # FIXME: This style comes from an include file, we
307 # should replace the real style and not this default.
308 lines[i:i+1] = [' Margin First_Dynamic',
309 ' LatexType Command',
310 ' LatexName caption',
316 ' AlignPossible Center',
317 ' LabelType Sensitive',
318 ' LabelString "Senseless!"',
327 # Delete MaxCounter and remember the value of it
328 match = re_MaxCounter.match(lines[i])
330 level = match.group(4)
331 if string.lower(level) == "counter_chapter":
333 elif string.lower(level) == "counter_section":
335 elif string.lower(level) == "counter_subsection":
337 elif string.lower(level) == "counter_subsubsection":
339 elif string.lower(level) == "counter_paragraph":
341 elif string.lower(level) == "counter_subparagraph":
343 elif string.lower(level) == "counter_enumi":
345 elif string.lower(level) == "counter_enumii":
347 elif string.lower(level) == "counter_enumiii":
354 # LabelType Counter_EnumI
361 match = re_LabelType.match(lines[i])
363 label = match.group(4)
364 # Remember indenting space for later reuse in added lines
365 space1 = match.group(1)
366 # Remember the line for adding the LabelCounter later.
367 # We can't do it here because it could shift latextype_line etc.
369 if string.lower(label[:8]) == "counter_":
370 counter = string.lower(label[8:])
371 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
373 # Remember the LabelString line
374 match = re_LabelString.match(lines[i])
376 labelstring = match.group(4)
379 # Remember the LabelStringAppendix line
380 match = re_LabelStringAppendix.match(lines[i])
382 labelstringappendix = match.group(4)
383 labelstringappendix_line = i
385 # Remember the LatexType line
386 match = re_LatexType.match(lines[i])
388 latextype = string.lower(match.group(4))
391 # Reset variables at the beginning of a style definition
392 match = re_Style.match(lines[i])
394 style = string.lower(match.group(4))
399 labelstringappendix = ""
400 labelstring_line = -1
401 labelstringappendix_line = -1
406 if re_End.match(lines[i]):
408 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
409 # (or change the existing LatexType)
410 if string.lower(label) == "bibliography":
411 if (latextype_line < 0):
412 lines.insert(i, "%sLatexType Bib_Environment" % space1)
415 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
417 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
418 if latextype == "item_environment" and string.lower(label) == "static":
419 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
421 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
422 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
423 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
424 # Don't add the LabelCounter line later
429 # LabelString "Chapter"
433 # LabelString "Chapter \arabic{chapter}"
435 # if this style has a counter. Ditto for LabelStringAppendix.
436 # This emulates the hardcoded article style numbering of 1.3
439 if counters.has_key(style):
440 if labelstring_line < 0:
441 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
444 new_labelstring = concatenate_label(labelstring, counters[style])
445 lines[labelstring_line] = re_LabelString.sub(
446 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
447 lines[labelstring_line])
448 if appendixcounters.has_key(style):
449 if labelstringappendix_line < 0:
450 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
453 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
454 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
455 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
456 lines[labelstringappendix_line])
458 # Now we can safely add the LabelCounter line
459 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
462 # Add the TocLevel setting for sectioning styles
463 if toclevels.has_key(style) and maxcounter <= toclevels[style]:
464 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
471 for mod in usemodules:
472 lines.insert(i, "UseModule " + mod)
485 input = open(argv[1], 'rb')
486 output = open(argv[2], 'wb')
488 error(usage(argv[0]))
493 while (format < currentFormat):
494 format = convert(lines)
505 if __name__ == "__main__":