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 # Incremented to format 24, 5 March 2010 by rgh
88 # Changed LaTeXBuiltin tag to NeedsFloatPkg and
89 # added new tag ListCommand.
91 # Incremented to format 25, 12 March 2010 by rgh
92 # Added RefPrefix tag for layouts and floats.
94 # Incremented to format 26, 29 March 2010 by rgh
97 # Incremented to format 27, 4 June 2010 by rgh
98 # Added RequiredArgs tag.
100 # Incremented to format 28, 6 August 2010 by lasgouttes
101 # Added ParbreakIsNewline tag for Layout and InsetLayout.
103 # Incremented to format 29, 10 August 2010 by rgh
104 # Changed Custom:Style, CharStyle:Style, and Element:Style
105 # uniformly to Flex:Style.
107 # Incremented to format 30, 13 August 2010 by rgh
108 # Introduced ResetsFont tag for InsetLayout.
110 # Incremented to format 31, 12 January 2011 by rgh
111 # Introducted NoCounter tag.
113 # Incremented to format 32, 30 January 2011 by forenr
114 # Added Display tag for InsetLayout
116 # Incremented to format 33, 2 February 2011 by rgh
117 # Changed NeedsFloatPkg to UsesFloatPkg
119 # Incremented to format 34, 28 March 2011 by rgh
120 # Remove obsolete Fill_(Top|Bottom) tags
122 # Incremented to format 35, 28 March 2011 by rgh
123 # Try to add "Flex:" to any flex insets that don't have it.
125 # Do not forget to document format change in Customization
126 # Manual (section "Declaring a new text class").
128 # You might also want to consider running the
129 # development/tools/updatelayouts.sh script to update all
130 # layout files to the new format.
135 def usage(prog_name):
136 return ("Usage: %s inputfile outputfile\n" % prog_name +
137 "or %s <inputfile >outputfile" % prog_name)
141 sys.stderr.write(message + '\n')
146 " Remove byte order mark."
147 if line[0:3] == "\357\273\277":
154 " Read input file and strip lineendings."
155 lines = source.read().splitlines() or ['']
156 lines[0] = trim_bom(lines[0])
160 def write(output, lines):
161 " Write output file with native lineendings."
162 output.write(os.linesep.join(lines) + os.linesep)
165 # Concatenates old and new in an intelligent way:
166 # If old is wrapped in ", they are stripped. The result is wrapped in ".
167 def concatenate_label(old, new):
168 # Don't use strip as long as we support python 1.5.2
170 return old[0:-1] + new + '"'
172 return '"' + old + new + '"'
174 # appends a string to a list unless it's already there
182 " Convert to new format."
183 re_Comment = re.compile(r'^(\s*)#')
184 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
185 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
186 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
187 re_Empty = re.compile(r'^(\s*)$')
188 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
189 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
190 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
191 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
192 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
193 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
194 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
195 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
196 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
197 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
198 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
199 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
200 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
201 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
202 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
203 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
204 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
205 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
206 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
207 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
208 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
209 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
210 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
211 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
212 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
213 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
214 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
215 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
216 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
218 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
219 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
220 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
221 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
222 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
223 re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
225 re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
226 re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
227 re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
229 # counters for sectioning styles (hardcoded in 1.3)
230 counters = {"part" : "\\Roman{part}",
231 "chapter" : "\\arabic{chapter}",
232 "section" : "\\arabic{section}",
233 "subsection" : "\\arabic{section}.\\arabic{subsection}",
234 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
235 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
236 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
238 # counters for sectioning styles in appendix (hardcoded in 1.3)
239 appendixcounters = {"chapter" : "\\Alph{chapter}",
240 "section" : "\\Alph{section}",
241 "subsection" : "\\arabic{section}.\\arabic{subsection}",
242 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
243 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
244 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
246 # Value of TocLevel for sectioning styles
247 toclevels = {"part" : 0,
261 labelstringappendix = ""
263 labelstring_line = -1
264 labelstringappendix_line = -1
275 while i < len(lines):
276 # Skip comments and empty lines
277 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
281 # insert file format if not already there
283 match = re_Format.match(lines[i])
286 format = int(match.group(4))
287 if format > 1 and format < currentFormat:
288 lines[i] = "Format %d" % (format + 1)
290 elif format == currentFormat:
294 error('Cannot convert file format %s' % format)
296 lines.insert(i, "Format 2")
300 # Don't get confused by LaTeX code
301 if re_Preamble.match(lines[i]):
303 while i < len(lines) and not re_EndPreamble.match(lines[i]):
306 if re_LangPreamble.match(lines[i]):
308 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
311 if re_BabelPreamble.match(lines[i]):
313 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
322 match = re_InsetLayout2.match(lines[i])
324 match = re_QInsetLayout2.match(lines[i])
326 match = re_CopyStyle2.match(lines[i])
330 style = match.group(2)
332 if flexstyles.count(style):
333 lines[i] = match.group(1) + "\"Flex:" + style + "\""
337 name = match.group(1)
338 names = name.split(":", 1)
339 if len(names) > 1 and names[0] == "Flex":
344 for j in range(i + 1, len(lines)):
345 if re_IsFlex.match(lines[j]):
348 if re_End.match(lines[j]):
352 flexstyles.append(name)
353 lines[i] = "InsetLayout \"Flex:" + name + "\""
359 m = re_Fill.match(lines[i])
366 match = re_NeedsFloatPkg.match(lines[i])
368 space = match.group(1)
370 lines[i] = space + "UsesFloatPkg " + val
372 if val == '1' or val.lower() == 'true':
374 lines.insert(i, space + "IsPredefined " + newval)
380 if format >= 29 and format <= 31:
385 match = re_InsetLayout.match(lines[i])
387 lines[i] = "InsetLayout Flex:" + match.group(1)
389 match = re_QInsetLayout.match(lines[i])
391 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
393 match = re_InsetLayout_CopyStyle.match(lines[i])
395 lines[i] = "\tCopyStyle Flex:" + match.group(1)
397 match = re_QInsetLayout_CopyStyle.match(lines[i])
399 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
404 if format >= 24 and format <= 27:
409 match = re_Float.match(lines[i])
413 # we need to do two things:
414 # (i) Convert Builtin to NeedsFloatPkg
415 # (ii) Write ListCommand lines for the builtin floats table and figure
418 while True and i < len(lines):
419 m1 = re_End.match(lines[i])
422 line = " ListCommand " + cmd
423 lines.insert(i, line)
426 m2 = re_Builtin.match(lines[i])
432 if re_True.match(arg):
436 lines[i] = ws1 + "NeedsFloatPkg " + newarg
437 m3 = re_Type.match(lines[i])
440 fltype = fltype.lower()
441 if fltype == "table":
443 elif fltype == "figure":
444 cmd = "listoffigures"
445 # else unknown, which is why we're doing this
449 # This just involved new features, not any changes to old ones
450 if format >= 14 and format <= 22:
454 # Rename I18NPreamble to BabelPreamble
456 match = re_I18nPreamble.match(lines[i])
458 lines[i] = match.group(1) + "BabelPreamble"
460 match = re_EndI18nPreamble.match(lines[i])
461 while i < len(lines) and not match:
463 match = re_EndI18nPreamble.match(lines[i])
464 lines[i] = match.group(1) + "EndBabelPreamble"
468 # These just involved new features, not any changes to old ones
469 if format == 11 or format == 12:
474 match = re_UseMod.match(lines[i])
476 module = match.group(1)
477 lines[i] = "DefaultModule " + module
482 match = re_Counter.match(lines[i])
486 while i < len(lines):
487 namem = re_Name.match(lines[i])
489 name = namem.group(1)
491 lines[counterline] = "Counter %s" % name
492 # we don't need to increment i
494 endem = re_End.match(lines[i])
503 # We want to scan for ams-type includes and, if we find them,
504 # add corresponding UseModule tags to the layout.
505 match = re_AMSMaths.match(lines[i])
507 addstring("theorems-ams", usemodules)
508 addstring("theorems-ams-extended", usemodules)
509 addstring("theorems-sec", usemodules)
512 match = re_AMSMathsPlain.match(lines[i])
514 addstring("theorems-starred", usemodules)
517 match = re_AMSMathsSeq.match(lines[i])
519 addstring("theorems-ams", usemodules)
520 addstring("theorems-ams-extended", usemodules)
526 # These just involved new features, not any changes to old ones
527 if format >= 5 and format <= 7:
532 # Handle conversion to long CharStyle names
533 match = re_CharStyle.match(lines[i])
535 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
537 lines.insert(i, "\tLyXType charstyle")
540 lines[i] = "\tLabelString %s" % (match.group(3))
545 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
546 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
548 match = re_Provides.match(lines[i])
550 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
551 match.group(3), match.group(4))
558 # delete caption styles
559 match = re_Style.match(lines[i])
561 style = string.lower(match.group(4))
562 if style == "caption":
564 while i < len(lines) and not re_End.match(lines[i]):
565 caption.append(lines[i])
568 error('Incomplete caption style.')
573 # delete undefinition of caption styles
574 match = re_NoStyle.match(lines[i])
576 style = string.lower(match.group(4))
577 if style == "caption":
581 # replace the CopyStyle statement with the definition of the real
582 # style. This may result in duplicate statements, but that is OK
583 # since the second one will overwrite the first one.
584 match = re_CopyStyle.match(lines[i])
586 style = string.lower(match.group(4))
587 if style == "caption":
589 lines[i:i+1] = caption
591 # FIXME: This style comes from an include file, we
592 # should replace the real style and not this default.
593 lines[i:i+1] = [' Margin First_Dynamic',
594 ' LatexType Command',
595 ' LatexName caption',
601 ' AlignPossible Center',
602 ' LabelType Sensitive',
603 ' LabelString "Senseless!"',
612 # Delete MaxCounter and remember the value of it
613 match = re_MaxCounter.match(lines[i])
615 level = match.group(4)
616 if string.lower(level) == "counter_chapter":
618 elif string.lower(level) == "counter_section":
620 elif string.lower(level) == "counter_subsection":
622 elif string.lower(level) == "counter_subsubsection":
624 elif string.lower(level) == "counter_paragraph":
626 elif string.lower(level) == "counter_subparagraph":
628 elif string.lower(level) == "counter_enumi":
630 elif string.lower(level) == "counter_enumii":
632 elif string.lower(level) == "counter_enumiii":
639 # LabelType Counter_EnumI
646 match = re_LabelType.match(lines[i])
648 label = match.group(4)
649 # Remember indenting space for later reuse in added lines
650 space1 = match.group(1)
651 # Remember the line for adding the LabelCounter later.
652 # We can't do it here because it could shift latextype_line etc.
654 if string.lower(label[:8]) == "counter_":
655 counter = string.lower(label[8:])
656 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
658 # Remember the LabelString line
659 match = re_LabelString.match(lines[i])
661 labelstring = match.group(4)
664 # Remember the LabelStringAppendix line
665 match = re_LabelStringAppendix.match(lines[i])
667 labelstringappendix = match.group(4)
668 labelstringappendix_line = i
670 # Remember the LatexType line
671 match = re_LatexType.match(lines[i])
673 latextype = string.lower(match.group(4))
676 # Remember the TocLevel line
677 match = re_TocLevel.match(lines[i])
679 toclevel = string.lower(match.group(4))
681 # Reset variables at the beginning of a style definition
682 match = re_Style.match(lines[i])
684 style = string.lower(match.group(4))
690 labelstringappendix = ""
691 labelstring_line = -1
692 labelstringappendix_line = -1
697 if re_End.match(lines[i]):
699 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
700 # (or change the existing LatexType)
701 if string.lower(label) == "bibliography":
702 if (latextype_line < 0):
703 lines.insert(i, "%sLatexType Bib_Environment" % space1)
706 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
708 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
709 if latextype == "item_environment" and string.lower(label) == "static":
710 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
712 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
713 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
714 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
715 # Don't add the LabelCounter line later
720 # LabelString "Chapter"
724 # LabelString "Chapter \arabic{chapter}"
726 # if this style has a counter. Ditto for LabelStringAppendix.
727 # This emulates the hardcoded article style numbering of 1.3
730 if style in counters:
731 if labelstring_line < 0:
732 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
735 new_labelstring = concatenate_label(labelstring, counters[style])
736 lines[labelstring_line] = re_LabelString.sub(
737 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
738 lines[labelstring_line])
739 if style in appendixcounters:
740 if labelstringappendix_line < 0:
741 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
744 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
745 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
746 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
747 lines[labelstringappendix_line])
749 # Now we can safely add the LabelCounter line
750 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
753 # Add the TocLevel setting for sectioning styles
754 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
755 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
761 lines.insert(i, "Format 2")
764 for mod in usemodules:
765 lines.insert(i, "UseModule " + mod)
778 source = open(argv[1], 'rb')
779 output = open(argv[2], 'wb')
781 error(usage(argv[0]))
786 while (format < currentFormat):
787 format = convert(lines)
798 if __name__ == "__main__":