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
45 # Incremented to format 13, 5 February 2009 by rgh
46 # Add InToc tag for InsetLayout
48 # Incremented to format 14, 14 February 2009 by gb
49 # Rename I18NPreamble to BabelPreamble and add LangPreamble
51 # Incremented to format 15, 28 May 2009 by lasgouttes
52 # Add new tag OutputFormat; modules can be conditionned on feature
55 # Do not forget to document format change in Customization
56 # Manual (section "Declaring a new text class").
62 return ("Usage: %s inputfile outputfile\n" % prog_name +
63 "or %s <inputfile >outputfile" % prog_name)
67 sys.stderr.write(message + '\n')
72 " Remove end of line char(s)."
73 if line[-2:-1] == '\r':
75 elif line[-1:] == '\r' or line[-1:] == '\n':
78 # file with no EOL in last line
83 " Read input file and strip lineendings."
86 line = input.readline()
89 lines.append(trim_eol(line))
93 def write(output, lines):
94 " Write output file with native lineendings."
96 output.write(line + os.linesep)
99 # Concatenates old and new in an intelligent way:
100 # If old is wrapped in ", they are stripped. The result is wrapped in ".
101 def concatenate_label(old, new):
102 # Don't use strip as long as we support python 1.5.2
104 return old[0:-1] + new + '"'
106 return '"' + old + new + '"'
108 # appends a string to a list unless it's already there
116 " Convert to new format."
117 re_Comment = re.compile(r'^(\s*)#')
118 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
119 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
120 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
121 re_Empty = re.compile(r'^(\s*)$')
122 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
123 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
124 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
125 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
126 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
127 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
128 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
129 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
130 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
131 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
132 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
133 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
134 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
135 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
136 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
137 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
138 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
139 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
140 re_AMSMaths = re.compile(r'^\s*Input amsmaths.inc\s*')
141 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
142 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
143 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
144 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
145 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
147 # counters for sectioning styles (hardcoded in 1.3)
148 counters = {"part" : "\\Roman{part}",
149 "chapter" : "\\arabic{chapter}",
150 "section" : "\\arabic{section}",
151 "subsection" : "\\arabic{section}.\\arabic{subsection}",
152 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
153 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
154 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
156 # counters for sectioning styles in appendix (hardcoded in 1.3)
157 appendixcounters = {"chapter" : "\\Alph{chapter}",
158 "section" : "\\Alph{section}",
159 "subsection" : "\\arabic{section}.\\arabic{subsection}",
160 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
161 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
162 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
164 # Value of TocLevel for sectioning styles
165 toclevels = {"part" : 0,
179 labelstringappendix = ""
181 labelstring_line = -1
182 labelstringappendix_line = -1
192 while i < len(lines):
193 # Skip comments and empty lines
194 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
198 # insert file format if not already there
200 match = re_Format.match(lines[i])
203 format = int(match.group(4))
204 if format > 1 and format < currentFormat:
205 lines[i] = "Format %d" % (format + 1)
207 elif format == currentFormat:
211 error('Cannot convert file format %s' % format)
213 lines.insert(i, "Format 2")
217 # Don't get confused by LaTeX code
218 if re_Preamble.match(lines[i]):
220 while i < len(lines) and not re_EndPreamble.match(lines[i]):
223 if re_LangPreamble.match(lines[i]):
225 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
228 if re_BabelPreamble.match(lines[i]):
230 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
234 # This just involved new features, not any changes to old ones
239 # Rename I18NPreamble to BabelPreamble
241 match = re_I18nPreamble.match(lines[i])
243 lines[i] = match.group(1) + "BabelPreamble"
245 match = re_EndI18nPreamble.match(lines[i])
246 while i < len(lines) and not match:
248 match = re_EndI18nPreamble.match(lines[i])
249 lines[i] = match.group(1) + "EndBabelPreamble"
253 # These just involved new features, not any changes to old ones
254 if format == 11 or format == 12:
259 match = re_UseMod.match(lines[i])
261 module = match.group(1)
262 lines[i] = "DefaultModule " + module
267 match = re_Counter.match(lines[i])
271 while i < len(lines):
272 namem = re_Name.match(lines[i])
274 name = namem.group(1)
276 lines[counterline] = "Counter %s" % name
277 # we don't need to increment i
279 endem = re_End.match(lines[i])
288 # We want to scan for ams-type includes and, if we find them,
289 # add corresponding UseModule tags to the layout.
290 match = re_AMSMaths.match(lines[i])
292 addstring("theorems-ams", usemodules)
293 addstring("theorems-ams-extended", usemodules)
294 addstring("theorems-sec", usemodules)
297 match = re_AMSMathsPlain.match(lines[i])
299 addstring("theorems-starred", usemodules)
302 match = re_AMSMathsSeq.match(lines[i])
304 addstring("theorems-ams", usemodules)
305 addstring("theorems-ams-extended", usemodules)
311 # These just involved new features, not any changes to old ones
312 if format >= 5 and format <= 7:
317 # Handle conversion to long CharStyle names
318 match = re_CharStyle.match(lines[i])
320 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
322 lines.insert(i, "\tLyXType charstyle")
325 lines[i] = "\tLabelString %s" % (match.group(3))
330 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
331 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
333 match = re_Provides.match(lines[i])
335 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
336 match.group(3), match.group(4))
343 # delete caption styles
344 match = re_Style.match(lines[i])
346 style = string.lower(match.group(4))
347 if style == "caption":
349 while i < len(lines) and not re_End.match(lines[i]):
350 caption.append(lines[i])
353 error('Incomplete caption style.')
358 # delete undefinition of caption styles
359 match = re_NoStyle.match(lines[i])
361 style = string.lower(match.group(4))
362 if style == "caption":
366 # replace the CopyStyle statement with the definition of the real
367 # style. This may result in duplicate statements, but that is OK
368 # since the second one will overwrite the first one.
369 match = re_CopyStyle.match(lines[i])
371 style = string.lower(match.group(4))
372 if style == "caption":
374 lines[i:i+1] = caption
376 # FIXME: This style comes from an include file, we
377 # should replace the real style and not this default.
378 lines[i:i+1] = [' Margin First_Dynamic',
379 ' LatexType Command',
380 ' LatexName caption',
386 ' AlignPossible Center',
387 ' LabelType Sensitive',
388 ' LabelString "Senseless!"',
397 # Delete MaxCounter and remember the value of it
398 match = re_MaxCounter.match(lines[i])
400 level = match.group(4)
401 if string.lower(level) == "counter_chapter":
403 elif string.lower(level) == "counter_section":
405 elif string.lower(level) == "counter_subsection":
407 elif string.lower(level) == "counter_subsubsection":
409 elif string.lower(level) == "counter_paragraph":
411 elif string.lower(level) == "counter_subparagraph":
413 elif string.lower(level) == "counter_enumi":
415 elif string.lower(level) == "counter_enumii":
417 elif string.lower(level) == "counter_enumiii":
424 # LabelType Counter_EnumI
431 match = re_LabelType.match(lines[i])
433 label = match.group(4)
434 # Remember indenting space for later reuse in added lines
435 space1 = match.group(1)
436 # Remember the line for adding the LabelCounter later.
437 # We can't do it here because it could shift latextype_line etc.
439 if string.lower(label[:8]) == "counter_":
440 counter = string.lower(label[8:])
441 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
443 # Remember the LabelString line
444 match = re_LabelString.match(lines[i])
446 labelstring = match.group(4)
449 # Remember the LabelStringAppendix line
450 match = re_LabelStringAppendix.match(lines[i])
452 labelstringappendix = match.group(4)
453 labelstringappendix_line = i
455 # Remember the LatexType line
456 match = re_LatexType.match(lines[i])
458 latextype = string.lower(match.group(4))
461 # Remember the TocLevel line
462 match = re_TocLevel.match(lines[i])
464 toclevel = string.lower(match.group(4))
466 # Reset variables at the beginning of a style definition
467 match = re_Style.match(lines[i])
469 style = string.lower(match.group(4))
475 labelstringappendix = ""
476 labelstring_line = -1
477 labelstringappendix_line = -1
482 if re_End.match(lines[i]):
484 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
485 # (or change the existing LatexType)
486 if string.lower(label) == "bibliography":
487 if (latextype_line < 0):
488 lines.insert(i, "%sLatexType Bib_Environment" % space1)
491 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
493 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
494 if latextype == "item_environment" and string.lower(label) == "static":
495 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
497 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
498 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
499 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
500 # Don't add the LabelCounter line later
505 # LabelString "Chapter"
509 # LabelString "Chapter \arabic{chapter}"
511 # if this style has a counter. Ditto for LabelStringAppendix.
512 # This emulates the hardcoded article style numbering of 1.3
515 if counters.has_key(style):
516 if labelstring_line < 0:
517 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
520 new_labelstring = concatenate_label(labelstring, counters[style])
521 lines[labelstring_line] = re_LabelString.sub(
522 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
523 lines[labelstring_line])
524 if appendixcounters.has_key(style):
525 if labelstringappendix_line < 0:
526 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
529 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
530 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
531 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
532 lines[labelstringappendix_line])
534 # Now we can safely add the LabelCounter line
535 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
538 # Add the TocLevel setting for sectioning styles
539 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
540 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
547 for mod in usemodules:
548 lines.insert(i, "UseModule " + mod)
561 input = open(argv[1], 'rb')
562 output = open(argv[2], 'wb')
564 error(usage(argv[0]))
569 while (format < currentFormat):
570 format = convert(lines)
581 if __name__ == "__main__":