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 conditioned on feature
55 # Incremented to format 16, 5 June 2009 by rgh
56 # Add new tags for Text Class:
57 # HTMLPreamble, HTMLAddToPreamble
59 # HTMLTag, HTMLAttr, HTMLLabel, HTMLLabelAttr, HTMLItem, HTMLItemAttr
60 # HTMLStyle, and HTMLPreamble
62 # HTMLTag, HTMLAttr, HTMLStyle, and HTMLPreamble
64 # HTMLType, HTMLClass, HTMLStyle
66 # Incremented to format 17, 12 August 2009 by rgh
67 # Add IfStyle and IfCounter tags for layout.
69 # Incremented to format 18, 27 October 2009 by rgh
70 # Added some new tags for HTML output.
72 # Incremented to format 19, 17 November 2009 by rgh
73 # Added InPreamble tag.
75 # Incremented to format 20, 17 December 2009 by rgh
76 # Added ContentAsLabel tag.
78 # Incremented to format 21, 12 January 2010 by rgh
79 # Added HTMLTocLayout and HTMLTitle tags.
81 # Incremented to format 22, 20 January 2010 by rgh
82 # Added HTMLFormat tag to Counters.
84 # Incremented to format 23, 13 February 2010 by spitz
85 # Added Spellcheck tag.
87 # Do not forget to document format change in Customization
88 # Manual (section "Declaring a new text class").
90 # You might also want to consider running the
91 # development/tools/updatelayouts.sh script to update all
92 # layout files to the new format.
98 return ("Usage: %s inputfile outputfile\n" % prog_name +
99 "or %s <inputfile >outputfile" % prog_name)
103 sys.stderr.write(message + '\n')
108 " Remove byte order mark."
109 if line[0:3] == "\357\273\277":
116 " Read input file and strip lineendings."
117 lines = source.read().splitlines()
118 lines[0] = trim_bom(lines[0])
122 def write(output, lines):
123 " Write output file with native lineendings."
124 output.write(os.linesep.join(lines) + os.linesep)
127 # Concatenates old and new in an intelligent way:
128 # If old is wrapped in ", they are stripped. The result is wrapped in ".
129 def concatenate_label(old, new):
130 # Don't use strip as long as we support python 1.5.2
132 return old[0:-1] + new + '"'
134 return '"' + old + new + '"'
136 # appends a string to a list unless it's already there
144 " Convert to new format."
145 re_Comment = re.compile(r'^(\s*)#')
146 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
147 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
148 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
149 re_Empty = re.compile(r'^(\s*)$')
150 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
151 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
152 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
153 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
154 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
155 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
156 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
157 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
158 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
159 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
160 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
161 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
162 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
163 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
164 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
165 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
166 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
167 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
168 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
169 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
170 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
171 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
172 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
173 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
175 # counters for sectioning styles (hardcoded in 1.3)
176 counters = {"part" : "\\Roman{part}",
177 "chapter" : "\\arabic{chapter}",
178 "section" : "\\arabic{section}",
179 "subsection" : "\\arabic{section}.\\arabic{subsection}",
180 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
181 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
182 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
184 # counters for sectioning styles in appendix (hardcoded in 1.3)
185 appendixcounters = {"chapter" : "\\Alph{chapter}",
186 "section" : "\\Alph{section}",
187 "subsection" : "\\arabic{section}.\\arabic{subsection}",
188 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
189 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
190 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
192 # Value of TocLevel for sectioning styles
193 toclevels = {"part" : 0,
207 labelstringappendix = ""
209 labelstring_line = -1
210 labelstringappendix_line = -1
220 while i < len(lines):
221 # Skip comments and empty lines
222 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
226 # insert file format if not already there
228 match = re_Format.match(lines[i])
231 format = int(match.group(4))
232 if format > 1 and format < currentFormat:
233 lines[i] = "Format %d" % (format + 1)
235 elif format == currentFormat:
239 error('Cannot convert file format %s' % format)
241 lines.insert(i, "Format 2")
245 # Don't get confused by LaTeX code
246 if re_Preamble.match(lines[i]):
248 while i < len(lines) and not re_EndPreamble.match(lines[i]):
251 if re_LangPreamble.match(lines[i]):
253 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
256 if re_BabelPreamble.match(lines[i]):
258 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
262 # This just involved new features, not any changes to old ones
263 if format >= 14 and format <= 22:
267 # Rename I18NPreamble to BabelPreamble
269 match = re_I18nPreamble.match(lines[i])
271 lines[i] = match.group(1) + "BabelPreamble"
273 match = re_EndI18nPreamble.match(lines[i])
274 while i < len(lines) and not match:
276 match = re_EndI18nPreamble.match(lines[i])
277 lines[i] = match.group(1) + "EndBabelPreamble"
281 # These just involved new features, not any changes to old ones
282 if format == 11 or format == 12:
287 match = re_UseMod.match(lines[i])
289 module = match.group(1)
290 lines[i] = "DefaultModule " + module
295 match = re_Counter.match(lines[i])
299 while i < len(lines):
300 namem = re_Name.match(lines[i])
302 name = namem.group(1)
304 lines[counterline] = "Counter %s" % name
305 # we don't need to increment i
307 endem = re_End.match(lines[i])
316 # We want to scan for ams-type includes and, if we find them,
317 # add corresponding UseModule tags to the layout.
318 match = re_AMSMaths.match(lines[i])
320 addstring("theorems-ams", usemodules)
321 addstring("theorems-ams-extended", usemodules)
322 addstring("theorems-sec", usemodules)
325 match = re_AMSMathsPlain.match(lines[i])
327 addstring("theorems-starred", usemodules)
330 match = re_AMSMathsSeq.match(lines[i])
332 addstring("theorems-ams", usemodules)
333 addstring("theorems-ams-extended", usemodules)
339 # These just involved new features, not any changes to old ones
340 if format >= 5 and format <= 7:
345 # Handle conversion to long CharStyle names
346 match = re_CharStyle.match(lines[i])
348 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
350 lines.insert(i, "\tLyXType charstyle")
353 lines[i] = "\tLabelString %s" % (match.group(3))
358 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
359 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
361 match = re_Provides.match(lines[i])
363 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
364 match.group(3), match.group(4))
371 # delete caption styles
372 match = re_Style.match(lines[i])
374 style = string.lower(match.group(4))
375 if style == "caption":
377 while i < len(lines) and not re_End.match(lines[i]):
378 caption.append(lines[i])
381 error('Incomplete caption style.')
386 # delete undefinition of caption styles
387 match = re_NoStyle.match(lines[i])
389 style = string.lower(match.group(4))
390 if style == "caption":
394 # replace the CopyStyle statement with the definition of the real
395 # style. This may result in duplicate statements, but that is OK
396 # since the second one will overwrite the first one.
397 match = re_CopyStyle.match(lines[i])
399 style = string.lower(match.group(4))
400 if style == "caption":
402 lines[i:i+1] = caption
404 # FIXME: This style comes from an include file, we
405 # should replace the real style and not this default.
406 lines[i:i+1] = [' Margin First_Dynamic',
407 ' LatexType Command',
408 ' LatexName caption',
414 ' AlignPossible Center',
415 ' LabelType Sensitive',
416 ' LabelString "Senseless!"',
425 # Delete MaxCounter and remember the value of it
426 match = re_MaxCounter.match(lines[i])
428 level = match.group(4)
429 if string.lower(level) == "counter_chapter":
431 elif string.lower(level) == "counter_section":
433 elif string.lower(level) == "counter_subsection":
435 elif string.lower(level) == "counter_subsubsection":
437 elif string.lower(level) == "counter_paragraph":
439 elif string.lower(level) == "counter_subparagraph":
441 elif string.lower(level) == "counter_enumi":
443 elif string.lower(level) == "counter_enumii":
445 elif string.lower(level) == "counter_enumiii":
452 # LabelType Counter_EnumI
459 match = re_LabelType.match(lines[i])
461 label = match.group(4)
462 # Remember indenting space for later reuse in added lines
463 space1 = match.group(1)
464 # Remember the line for adding the LabelCounter later.
465 # We can't do it here because it could shift latextype_line etc.
467 if string.lower(label[:8]) == "counter_":
468 counter = string.lower(label[8:])
469 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
471 # Remember the LabelString line
472 match = re_LabelString.match(lines[i])
474 labelstring = match.group(4)
477 # Remember the LabelStringAppendix line
478 match = re_LabelStringAppendix.match(lines[i])
480 labelstringappendix = match.group(4)
481 labelstringappendix_line = i
483 # Remember the LatexType line
484 match = re_LatexType.match(lines[i])
486 latextype = string.lower(match.group(4))
489 # Remember the TocLevel line
490 match = re_TocLevel.match(lines[i])
492 toclevel = string.lower(match.group(4))
494 # Reset variables at the beginning of a style definition
495 match = re_Style.match(lines[i])
497 style = string.lower(match.group(4))
503 labelstringappendix = ""
504 labelstring_line = -1
505 labelstringappendix_line = -1
510 if re_End.match(lines[i]):
512 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
513 # (or change the existing LatexType)
514 if string.lower(label) == "bibliography":
515 if (latextype_line < 0):
516 lines.insert(i, "%sLatexType Bib_Environment" % space1)
519 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
521 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
522 if latextype == "item_environment" and string.lower(label) == "static":
523 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
525 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
526 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
527 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
528 # Don't add the LabelCounter line later
533 # LabelString "Chapter"
537 # LabelString "Chapter \arabic{chapter}"
539 # if this style has a counter. Ditto for LabelStringAppendix.
540 # This emulates the hardcoded article style numbering of 1.3
543 if counters.has_key(style):
544 if labelstring_line < 0:
545 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
548 new_labelstring = concatenate_label(labelstring, counters[style])
549 lines[labelstring_line] = re_LabelString.sub(
550 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
551 lines[labelstring_line])
552 if appendixcounters.has_key(style):
553 if labelstringappendix_line < 0:
554 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
557 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
558 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
559 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
560 lines[labelstringappendix_line])
562 # Now we can safely add the LabelCounter line
563 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
566 # Add the TocLevel setting for sectioning styles
567 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
568 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
575 for mod in usemodules:
576 lines.insert(i, "UseModule " + mod)
589 source = open(argv[1], 'rb')
590 output = open(argv[2], 'wb')
592 error(usage(argv[0]))
597 while (format < currentFormat):
598 format = convert(lines)
609 if __name__ == "__main__":