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 current format
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
39 # Incremented to format 11, 14 October 2008 by rgh
40 # Add ProvidesModule, ExcludesModule tags
42 # Incremented to format 12, 10 January 2009 by gb
43 # Add I18NPreamble tag
49 return ("Usage: %s inputfile outputfile\n" % prog_name +
50 "or %s <inputfile >outputfile" % prog_name)
54 sys.stderr.write(message + '\n')
59 " Remove end of line char(s)."
60 if line[-2:-1] == '\r':
62 elif line[-1:] == '\r' or line[-1:] == '\n':
65 # file with no EOL in last line
70 " Read input file and strip lineendings."
73 line = input.readline()
76 lines.append(trim_eol(line))
80 def write(output, lines):
81 " Write output file with native lineendings."
83 output.write(line + os.linesep)
86 # Concatenates old and new in an intelligent way:
87 # If old is wrapped in ", they are stripped. The result is wrapped in ".
88 def concatenate_label(old, new):
89 # Don't use strip as long as we support python 1.5.2
91 return old[0:-1] + new + '"'
93 return '"' + old + new + '"'
95 # appends a string to a list unless it's already there
103 " Convert to new format."
104 re_Comment = re.compile(r'^(\s*)#')
105 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
106 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
107 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
108 re_Empty = re.compile(r'^(\s*)$')
109 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
110 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
111 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
112 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
113 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
114 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
115 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
116 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
117 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
118 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
119 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
120 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
121 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
122 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
123 re_AMSMaths = re.compile(r'^\s*Input amsmaths.inc\s*')
124 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
125 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
126 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
128 # counters for sectioning styles (hardcoded in 1.3)
129 counters = {"part" : "\\Roman{part}",
130 "chapter" : "\\arabic{chapter}",
131 "section" : "\\arabic{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 # counters for sectioning styles in appendix (hardcoded in 1.3)
138 appendixcounters = {"chapter" : "\\Alph{chapter}",
139 "section" : "\\Alph{section}",
140 "subsection" : "\\arabic{section}.\\arabic{subsection}",
141 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
142 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
143 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
145 # Value of TocLevel for sectioning styles
146 toclevels = {"part" : 0,
160 labelstringappendix = ""
162 labelstring_line = -1
163 labelstringappendix_line = -1
173 while i < len(lines):
174 # Skip comments and empty lines
175 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
179 # insert file format if not already there
181 match = re_Format.match(lines[i])
184 format = int(match.group(4))
185 if format > 1 and format < currentFormat:
186 lines[i] = "Format %d" % (format + 1)
188 elif format == currentFormat:
192 error('Cannot convert file format %s' % format)
194 lines.insert(i, "Format 2")
198 # Don't get confused by LaTeX code
199 if re_Preamble.match(lines[i]):
201 while i < len(lines) and not re_EndPreamble.match(lines[i]):
205 # This just involved new features, not any changes to old ones
211 match = re_UseMod.match(lines[i])
213 module = match.group(1)
214 lines[i] = "DefaultModule " + module
219 match = re_Counter.match(lines[i])
223 while i < len(lines):
224 namem = re_Name.match(lines[i])
226 name = namem.group(1)
228 lines[counterline] = "Counter %s" % name
229 # we don't need to increment i
231 endem = re_End.match(lines[i])
240 # We want to scan for ams-type includes and, if we find them,
241 # add corresponding UseModule tags to the layout.
242 match = re_AMSMaths.match(lines[i])
244 addstring("theorems-ams", usemodules)
245 addstring("theorems-ams-extended", usemodules)
246 addstring("theorems-sec", usemodules)
249 match = re_AMSMathsPlain.match(lines[i])
251 addstring("theorems-starred", usemodules)
254 match = re_AMSMathsSeq.match(lines[i])
256 addstring("theorems-ams", usemodules)
257 addstring("theorems-ams-extended", usemodules)
263 # These just involved new features, not any changes to old ones
264 if format >= 5 and format <= 7:
269 # Handle conversion to long CharStyle names
270 match = re_CharStyle.match(lines[i])
272 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
274 lines.insert(i, "\tLyXType charstyle")
277 lines[i] = "\tLabelString %s" % (match.group(3))
282 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
283 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
285 match = re_Provides.match(lines[i])
287 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
288 match.group(3), match.group(4))
295 # delete caption styles
296 match = re_Style.match(lines[i])
298 style = string.lower(match.group(4))
299 if style == "caption":
301 while i < len(lines) and not re_End.match(lines[i]):
302 caption.append(lines[i])
305 error('Incomplete caption style.')
310 # delete undefinition of caption styles
311 match = re_NoStyle.match(lines[i])
313 style = string.lower(match.group(4))
314 if style == "caption":
318 # replace the CopyStyle statement with the definition of the real
319 # style. This may result in duplicate statements, but that is OK
320 # since the second one will overwrite the first one.
321 match = re_CopyStyle.match(lines[i])
323 style = string.lower(match.group(4))
324 if style == "caption":
326 lines[i:i+1] = caption
328 # FIXME: This style comes from an include file, we
329 # should replace the real style and not this default.
330 lines[i:i+1] = [' Margin First_Dynamic',
331 ' LatexType Command',
332 ' LatexName caption',
338 ' AlignPossible Center',
339 ' LabelType Sensitive',
340 ' LabelString "Senseless!"',
349 # Delete MaxCounter and remember the value of it
350 match = re_MaxCounter.match(lines[i])
352 level = match.group(4)
353 if string.lower(level) == "counter_chapter":
355 elif string.lower(level) == "counter_section":
357 elif string.lower(level) == "counter_subsection":
359 elif string.lower(level) == "counter_subsubsection":
361 elif string.lower(level) == "counter_paragraph":
363 elif string.lower(level) == "counter_subparagraph":
365 elif string.lower(level) == "counter_enumi":
367 elif string.lower(level) == "counter_enumii":
369 elif string.lower(level) == "counter_enumiii":
376 # LabelType Counter_EnumI
383 match = re_LabelType.match(lines[i])
385 label = match.group(4)
386 # Remember indenting space for later reuse in added lines
387 space1 = match.group(1)
388 # Remember the line for adding the LabelCounter later.
389 # We can't do it here because it could shift latextype_line etc.
391 if string.lower(label[:8]) == "counter_":
392 counter = string.lower(label[8:])
393 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
395 # Remember the LabelString line
396 match = re_LabelString.match(lines[i])
398 labelstring = match.group(4)
401 # Remember the LabelStringAppendix line
402 match = re_LabelStringAppendix.match(lines[i])
404 labelstringappendix = match.group(4)
405 labelstringappendix_line = i
407 # Remember the LatexType line
408 match = re_LatexType.match(lines[i])
410 latextype = string.lower(match.group(4))
413 # Remember the TocLevel line
414 match = re_TocLevel.match(lines[i])
416 toclevel = string.lower(match.group(4))
418 # Reset variables at the beginning of a style definition
419 match = re_Style.match(lines[i])
421 style = string.lower(match.group(4))
427 labelstringappendix = ""
428 labelstring_line = -1
429 labelstringappendix_line = -1
434 if re_End.match(lines[i]):
436 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
437 # (or change the existing LatexType)
438 if string.lower(label) == "bibliography":
439 if (latextype_line < 0):
440 lines.insert(i, "%sLatexType Bib_Environment" % space1)
443 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
445 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
446 if latextype == "item_environment" and string.lower(label) == "static":
447 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
449 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
450 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
451 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
452 # Don't add the LabelCounter line later
457 # LabelString "Chapter"
461 # LabelString "Chapter \arabic{chapter}"
463 # if this style has a counter. Ditto for LabelStringAppendix.
464 # This emulates the hardcoded article style numbering of 1.3
467 if counters.has_key(style):
468 if labelstring_line < 0:
469 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
472 new_labelstring = concatenate_label(labelstring, counters[style])
473 lines[labelstring_line] = re_LabelString.sub(
474 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
475 lines[labelstring_line])
476 if appendixcounters.has_key(style):
477 if labelstringappendix_line < 0:
478 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
481 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
482 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
483 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
484 lines[labelstringappendix_line])
486 # Now we can safely add the LabelCounter line
487 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
490 # Add the TocLevel setting for sectioning styles
491 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
492 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
499 for mod in usemodules:
500 lines.insert(i, "UseModule " + mod)
513 input = open(argv[1], 'rb')
514 output = open(argv[2], 'wb')
516 error(usage(argv[0]))
521 while (format < currentFormat):
522 format = convert(lines)
533 if __name__ == "__main__":