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 # Incremented to format 36, 7 December 2011, by rgh
126 # Added HTMLStyles and AddToHTMLStyles tags.
128 # Do not forget to document format change in Customization
129 # Manual (section "Declaring a new text class").
131 # You might also want to consider running the
132 # development/tools/updatelayouts.sh script to update all
133 # layout files to the new format.
138 def usage(prog_name):
139 return ("Usage: %s inputfile outputfile\n" % prog_name +
140 "or %s <inputfile >outputfile" % prog_name)
144 sys.stderr.write(message + '\n')
149 " Remove byte order mark."
150 if line[0:3] == "\357\273\277":
157 " Read input file and strip lineendings."
158 lines = source.read().splitlines() or ['']
159 lines[0] = trim_bom(lines[0])
163 def write(output, lines):
164 " Write output file with native lineendings."
165 output.write(os.linesep.join(lines) + os.linesep)
168 # Concatenates old and new in an intelligent way:
169 # If old is wrapped in ", they are stripped. The result is wrapped in ".
170 def concatenate_label(old, new):
171 # Don't use strip as long as we support python 1.5.2
173 return old[0:-1] + new + '"'
175 return '"' + old + new + '"'
177 # appends a string to a list unless it's already there
185 " Convert to new format."
186 re_Comment = re.compile(r'^(\s*)#')
187 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
188 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
189 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
190 re_Empty = re.compile(r'^(\s*)$')
191 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
192 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
193 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
194 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
195 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
196 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
197 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
198 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
199 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
200 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
201 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
202 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
203 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
204 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
205 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
206 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
207 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
208 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
209 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
210 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
211 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
212 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
213 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
214 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
215 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
216 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
217 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
218 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
219 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
221 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
222 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
223 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
224 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
225 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
226 re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
228 re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
229 re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
230 re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
232 # counters for sectioning styles (hardcoded in 1.3)
233 counters = {"part" : "\\Roman{part}",
234 "chapter" : "\\arabic{chapter}",
235 "section" : "\\arabic{section}",
236 "subsection" : "\\arabic{section}.\\arabic{subsection}",
237 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
238 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
239 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
241 # counters for sectioning styles in appendix (hardcoded in 1.3)
242 appendixcounters = {"chapter" : "\\Alph{chapter}",
243 "section" : "\\Alph{section}",
244 "subsection" : "\\arabic{section}.\\arabic{subsection}",
245 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
246 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
247 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
249 # Value of TocLevel for sectioning styles
250 toclevels = {"part" : 0,
264 labelstringappendix = ""
266 labelstring_line = -1
267 labelstringappendix_line = -1
278 while i < len(lines):
279 # Skip comments and empty lines
280 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
284 # insert file format if not already there
286 match = re_Format.match(lines[i])
289 format = int(match.group(4))
290 if format > 1 and format < currentFormat:
291 lines[i] = "Format %d" % (format + 1)
293 elif format == currentFormat:
297 error('Cannot convert file format %s' % format)
299 lines.insert(i, "Format 2")
303 # Don't get confused by LaTeX code
304 if re_Preamble.match(lines[i]):
306 while i < len(lines) and not re_EndPreamble.match(lines[i]):
309 if re_LangPreamble.match(lines[i]):
311 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
314 if re_BabelPreamble.match(lines[i]):
316 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
325 match = re_InsetLayout2.match(lines[i])
327 match = re_QInsetLayout2.match(lines[i])
329 match = re_CopyStyle2.match(lines[i])
333 style = match.group(2)
335 if flexstyles.count(style):
336 lines[i] = match.group(1) + "\"Flex:" + style + "\""
340 name = match.group(1)
341 names = name.split(":", 1)
342 if len(names) > 1 and names[0] == "Flex":
347 for j in range(i + 1, len(lines)):
348 if re_IsFlex.match(lines[j]):
351 if re_End.match(lines[j]):
355 flexstyles.append(name)
356 lines[i] = "InsetLayout \"Flex:" + name + "\""
362 m = re_Fill.match(lines[i])
369 match = re_NeedsFloatPkg.match(lines[i])
371 space = match.group(1)
373 lines[i] = space + "UsesFloatPkg " + val
375 if val == '1' or val.lower() == 'true':
377 lines.insert(i, space + "IsPredefined " + newval)
383 if format >= 29 and format <= 31:
388 match = re_InsetLayout.match(lines[i])
390 lines[i] = "InsetLayout Flex:" + match.group(1)
392 match = re_QInsetLayout.match(lines[i])
394 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
396 match = re_InsetLayout_CopyStyle.match(lines[i])
398 lines[i] = "\tCopyStyle Flex:" + match.group(1)
400 match = re_QInsetLayout_CopyStyle.match(lines[i])
402 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
407 if format >= 24 and format <= 27:
412 match = re_Float.match(lines[i])
416 # we need to do two things:
417 # (i) Convert Builtin to NeedsFloatPkg
418 # (ii) Write ListCommand lines for the builtin floats table and figure
421 while True and i < len(lines):
422 m1 = re_End.match(lines[i])
425 line = " ListCommand " + cmd
426 lines.insert(i, line)
429 m2 = re_Builtin.match(lines[i])
435 if re_True.match(arg):
439 lines[i] = ws1 + "NeedsFloatPkg " + newarg
440 m3 = re_Type.match(lines[i])
443 fltype = fltype.lower()
444 if fltype == "table":
446 elif fltype == "figure":
447 cmd = "listoffigures"
448 # else unknown, which is why we're doing this
452 # This just involved new features, not any changes to old ones
453 if format >= 14 and format <= 22:
457 # Rename I18NPreamble to BabelPreamble
459 match = re_I18nPreamble.match(lines[i])
461 lines[i] = match.group(1) + "BabelPreamble"
463 match = re_EndI18nPreamble.match(lines[i])
464 while i < len(lines) and not match:
466 match = re_EndI18nPreamble.match(lines[i])
467 lines[i] = match.group(1) + "EndBabelPreamble"
471 # These just involved new features, not any changes to old ones
472 if format == 11 or format == 12:
477 match = re_UseMod.match(lines[i])
479 module = match.group(1)
480 lines[i] = "DefaultModule " + module
485 match = re_Counter.match(lines[i])
489 while i < len(lines):
490 namem = re_Name.match(lines[i])
492 name = namem.group(1)
494 lines[counterline] = "Counter %s" % name
495 # we don't need to increment i
497 endem = re_End.match(lines[i])
506 # We want to scan for ams-type includes and, if we find them,
507 # add corresponding UseModule tags to the layout.
508 match = re_AMSMaths.match(lines[i])
510 addstring("theorems-ams", usemodules)
511 addstring("theorems-ams-extended", usemodules)
512 addstring("theorems-sec", usemodules)
515 match = re_AMSMathsPlain.match(lines[i])
517 addstring("theorems-starred", usemodules)
520 match = re_AMSMathsSeq.match(lines[i])
522 addstring("theorems-ams", usemodules)
523 addstring("theorems-ams-extended", usemodules)
529 # These just involved new features, not any changes to old ones
530 if format >= 5 and format <= 7:
535 # Handle conversion to long CharStyle names
536 match = re_CharStyle.match(lines[i])
538 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
540 lines.insert(i, "\tLyXType charstyle")
543 lines[i] = "\tLabelString %s" % (match.group(3))
548 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
549 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
551 match = re_Provides.match(lines[i])
553 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
554 match.group(3), match.group(4))
561 # delete caption styles
562 match = re_Style.match(lines[i])
564 style = string.lower(match.group(4))
565 if style == "caption":
567 while i < len(lines) and not re_End.match(lines[i]):
568 caption.append(lines[i])
571 error('Incomplete caption style.')
576 # delete undefinition of caption styles
577 match = re_NoStyle.match(lines[i])
579 style = string.lower(match.group(4))
580 if style == "caption":
584 # replace the CopyStyle statement with the definition of the real
585 # style. This may result in duplicate statements, but that is OK
586 # since the second one will overwrite the first one.
587 match = re_CopyStyle.match(lines[i])
589 style = string.lower(match.group(4))
590 if style == "caption":
592 lines[i:i+1] = caption
594 # FIXME: This style comes from an include file, we
595 # should replace the real style and not this default.
596 lines[i:i+1] = [' Margin First_Dynamic',
597 ' LatexType Command',
598 ' LatexName caption',
604 ' AlignPossible Center',
605 ' LabelType Sensitive',
606 ' LabelString "Senseless!"',
615 # Delete MaxCounter and remember the value of it
616 match = re_MaxCounter.match(lines[i])
618 level = match.group(4)
619 if string.lower(level) == "counter_chapter":
621 elif string.lower(level) == "counter_section":
623 elif string.lower(level) == "counter_subsection":
625 elif string.lower(level) == "counter_subsubsection":
627 elif string.lower(level) == "counter_paragraph":
629 elif string.lower(level) == "counter_subparagraph":
631 elif string.lower(level) == "counter_enumi":
633 elif string.lower(level) == "counter_enumii":
635 elif string.lower(level) == "counter_enumiii":
642 # LabelType Counter_EnumI
649 match = re_LabelType.match(lines[i])
651 label = match.group(4)
652 # Remember indenting space for later reuse in added lines
653 space1 = match.group(1)
654 # Remember the line for adding the LabelCounter later.
655 # We can't do it here because it could shift latextype_line etc.
657 if string.lower(label[:8]) == "counter_":
658 counter = string.lower(label[8:])
659 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
661 # Remember the LabelString line
662 match = re_LabelString.match(lines[i])
664 labelstring = match.group(4)
667 # Remember the LabelStringAppendix line
668 match = re_LabelStringAppendix.match(lines[i])
670 labelstringappendix = match.group(4)
671 labelstringappendix_line = i
673 # Remember the LatexType line
674 match = re_LatexType.match(lines[i])
676 latextype = string.lower(match.group(4))
679 # Remember the TocLevel line
680 match = re_TocLevel.match(lines[i])
682 toclevel = string.lower(match.group(4))
684 # Reset variables at the beginning of a style definition
685 match = re_Style.match(lines[i])
687 style = string.lower(match.group(4))
693 labelstringappendix = ""
694 labelstring_line = -1
695 labelstringappendix_line = -1
700 if re_End.match(lines[i]):
702 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
703 # (or change the existing LatexType)
704 if string.lower(label) == "bibliography":
705 if (latextype_line < 0):
706 lines.insert(i, "%sLatexType Bib_Environment" % space1)
709 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
711 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
712 if latextype == "item_environment" and string.lower(label) == "static":
713 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
715 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
716 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
717 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
718 # Don't add the LabelCounter line later
723 # LabelString "Chapter"
727 # LabelString "Chapter \arabic{chapter}"
729 # if this style has a counter. Ditto for LabelStringAppendix.
730 # This emulates the hardcoded article style numbering of 1.3
733 if style in counters:
734 if labelstring_line < 0:
735 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
738 new_labelstring = concatenate_label(labelstring, counters[style])
739 lines[labelstring_line] = re_LabelString.sub(
740 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
741 lines[labelstring_line])
742 if style in appendixcounters:
743 if labelstringappendix_line < 0:
744 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
747 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
748 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
749 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
750 lines[labelstringappendix_line])
752 # Now we can safely add the LabelCounter line
753 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
756 # Add the TocLevel setting for sectioning styles
757 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
758 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
764 lines.insert(i, "Format 2")
767 for mod in usemodules:
768 lines.insert(i, "UseModule " + mod)
781 source = open(argv[1], 'rb')
782 output = open(argv[2], 'wb')
784 error(usage(argv[0]))
789 while (format < currentFormat):
790 format = convert(lines)
801 if __name__ == "__main__":