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 # Incremented to format 37, 29 February 2012 by jrioux
129 # Implement the citation engine machinery in layouts.
130 # Change CiteFormat to CiteFormat (default|authoryear|numerical).
132 # Incremented to format 38, 08 April 2012 by gb
133 # Introduce LangPreamble and BabelPreamble for InsetLayout.
135 # Do not forget to document format change in Customization
136 # Manual (section "Declaring a new text class").
138 # You might also want to consider running the
139 # development/tools/updatelayouts.sh script to update all
140 # layout files to the new format.
145 def usage(prog_name):
146 return ("Usage: %s inputfile outputfile\n" % prog_name +
147 "or %s <inputfile >outputfile" % prog_name)
151 sys.stderr.write(message + '\n')
156 " Remove byte order mark."
157 if line[0:3] == "\357\273\277":
164 " Read input file and strip lineendings."
165 lines = source.read().splitlines() or ['']
166 lines[0] = trim_bom(lines[0])
170 def write(output, lines):
171 " Write output file with native lineendings."
172 output.write(os.linesep.join(lines) + os.linesep)
175 # Concatenates old and new in an intelligent way:
176 # If old is wrapped in ", they are stripped. The result is wrapped in ".
177 def concatenate_label(old, new):
178 # Don't use strip as long as we support python 1.5.2
180 return old[0:-1] + new + '"'
182 return '"' + old + new + '"'
184 # appends a string to a list unless it's already there
192 " Convert to new format."
193 re_Comment = re.compile(r'^(\s*)#')
194 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
195 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
196 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
197 re_Empty = re.compile(r'^(\s*)$')
198 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
199 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
200 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
201 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
202 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
203 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
204 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
205 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
206 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
207 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
208 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
209 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
210 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
211 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
212 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
213 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
214 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
215 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
216 re_CiteFormat = re.compile(r'^(\s*)(CiteFormat)(?:(\s*)()|(\s+)(default|authoryear|numerical))', re.IGNORECASE)
217 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
218 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
219 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
220 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
221 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
222 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
223 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
224 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
225 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
226 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
227 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
229 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
230 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
231 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
232 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
233 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
234 re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
236 re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
237 re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
238 re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
240 # counters for sectioning styles (hardcoded in 1.3)
241 counters = {"part" : "\\Roman{part}",
242 "chapter" : "\\arabic{chapter}",
243 "section" : "\\arabic{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 # counters for sectioning styles in appendix (hardcoded in 1.3)
250 appendixcounters = {"chapter" : "\\Alph{chapter}",
251 "section" : "\\Alph{section}",
252 "subsection" : "\\arabic{section}.\\arabic{subsection}",
253 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
254 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
255 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
257 # Value of TocLevel for sectioning styles
258 toclevels = {"part" : 0,
272 labelstringappendix = ""
274 labelstring_line = -1
275 labelstringappendix_line = -1
286 while i < len(lines):
287 # Skip comments and empty lines
288 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
292 # insert file format if not already there
294 match = re_Format.match(lines[i])
297 format = int(match.group(4))
298 if format > 1 and format < currentFormat:
299 lines[i] = "Format %d" % (format + 1)
301 elif format == currentFormat:
305 error('Cannot convert file format %s' % format)
307 lines.insert(i, "Format 2")
311 # Don't get confused by LaTeX code
312 if re_Preamble.match(lines[i]):
314 while i < len(lines) and not re_EndPreamble.match(lines[i]):
317 if re_LangPreamble.match(lines[i]):
319 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
322 if re_BabelPreamble.match(lines[i]):
324 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
333 match = re_CiteFormat.match(lines[i]);
334 if match and match.group(4) == "":
335 lines[i] = match.group(0) + " default"
344 match = re_InsetLayout2.match(lines[i])
346 match = re_QInsetLayout2.match(lines[i])
348 match = re_CopyStyle2.match(lines[i])
352 style = match.group(2)
354 if flexstyles.count(style):
355 lines[i] = match.group(1) + "\"Flex:" + style + "\""
359 name = match.group(1)
360 names = name.split(":", 1)
361 if len(names) > 1 and names[0] == "Flex":
366 for j in range(i + 1, len(lines)):
367 if re_IsFlex.match(lines[j]):
370 if re_End.match(lines[j]):
374 flexstyles.append(name)
375 lines[i] = "InsetLayout \"Flex:" + name + "\""
381 m = re_Fill.match(lines[i])
388 match = re_NeedsFloatPkg.match(lines[i])
390 space = match.group(1)
392 lines[i] = space + "UsesFloatPkg " + val
394 if val == '1' or val.lower() == 'true':
396 lines.insert(i, space + "IsPredefined " + newval)
402 if format >= 29 and format <= 31:
407 match = re_InsetLayout.match(lines[i])
409 lines[i] = "InsetLayout Flex:" + match.group(1)
411 match = re_QInsetLayout.match(lines[i])
413 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
415 match = re_InsetLayout_CopyStyle.match(lines[i])
417 lines[i] = "\tCopyStyle Flex:" + match.group(1)
419 match = re_QInsetLayout_CopyStyle.match(lines[i])
421 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
426 if format >= 24 and format <= 27:
431 match = re_Float.match(lines[i])
435 # we need to do two things:
436 # (i) Convert Builtin to NeedsFloatPkg
437 # (ii) Write ListCommand lines for the builtin floats table and figure
440 while True and i < len(lines):
441 m1 = re_End.match(lines[i])
444 line = " ListCommand " + cmd
445 lines.insert(i, line)
448 m2 = re_Builtin.match(lines[i])
454 if re_True.match(arg):
458 lines[i] = ws1 + "NeedsFloatPkg " + newarg
459 m3 = re_Type.match(lines[i])
462 fltype = fltype.lower()
463 if fltype == "table":
465 elif fltype == "figure":
466 cmd = "listoffigures"
467 # else unknown, which is why we're doing this
471 # This just involved new features, not any changes to old ones
472 if format >= 14 and format <= 22:
476 # Rename I18NPreamble to BabelPreamble
478 match = re_I18nPreamble.match(lines[i])
480 lines[i] = match.group(1) + "BabelPreamble"
482 match = re_EndI18nPreamble.match(lines[i])
483 while i < len(lines) and not match:
485 match = re_EndI18nPreamble.match(lines[i])
486 lines[i] = match.group(1) + "EndBabelPreamble"
490 # These just involved new features, not any changes to old ones
491 if format == 11 or format == 12:
496 match = re_UseMod.match(lines[i])
498 module = match.group(1)
499 lines[i] = "DefaultModule " + module
504 match = re_Counter.match(lines[i])
508 while i < len(lines):
509 namem = re_Name.match(lines[i])
511 name = namem.group(1)
513 lines[counterline] = "Counter %s" % name
514 # we don't need to increment i
516 endem = re_End.match(lines[i])
525 # We want to scan for ams-type includes and, if we find them,
526 # add corresponding UseModule tags to the layout.
527 match = re_AMSMaths.match(lines[i])
529 addstring("theorems-ams", usemodules)
530 addstring("theorems-ams-extended", usemodules)
531 addstring("theorems-sec", usemodules)
534 match = re_AMSMathsPlain.match(lines[i])
536 addstring("theorems-starred", usemodules)
539 match = re_AMSMathsSeq.match(lines[i])
541 addstring("theorems-ams", usemodules)
542 addstring("theorems-ams-extended", usemodules)
548 # These just involved new features, not any changes to old ones
549 if format >= 5 and format <= 7:
554 # Handle conversion to long CharStyle names
555 match = re_CharStyle.match(lines[i])
557 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
559 lines.insert(i, "\tLyXType charstyle")
562 lines[i] = "\tLabelString %s" % (match.group(3))
567 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
568 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
570 match = re_Provides.match(lines[i])
572 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
573 match.group(3), match.group(4))
580 # delete caption styles
581 match = re_Style.match(lines[i])
583 style = string.lower(match.group(4))
584 if style == "caption":
586 while i < len(lines) and not re_End.match(lines[i]):
587 caption.append(lines[i])
590 error('Incomplete caption style.')
595 # delete undefinition of caption styles
596 match = re_NoStyle.match(lines[i])
598 style = string.lower(match.group(4))
599 if style == "caption":
603 # replace the CopyStyle statement with the definition of the real
604 # style. This may result in duplicate statements, but that is OK
605 # since the second one will overwrite the first one.
606 match = re_CopyStyle.match(lines[i])
608 style = string.lower(match.group(4))
609 if style == "caption":
611 lines[i:i+1] = caption
613 # FIXME: This style comes from an include file, we
614 # should replace the real style and not this default.
615 lines[i:i+1] = [' Margin First_Dynamic',
616 ' LatexType Command',
617 ' LatexName caption',
623 ' AlignPossible Center',
624 ' LabelType Sensitive',
625 ' LabelString "Senseless!"',
634 # Delete MaxCounter and remember the value of it
635 match = re_MaxCounter.match(lines[i])
637 level = match.group(4)
638 if string.lower(level) == "counter_chapter":
640 elif string.lower(level) == "counter_section":
642 elif string.lower(level) == "counter_subsection":
644 elif string.lower(level) == "counter_subsubsection":
646 elif string.lower(level) == "counter_paragraph":
648 elif string.lower(level) == "counter_subparagraph":
650 elif string.lower(level) == "counter_enumi":
652 elif string.lower(level) == "counter_enumii":
654 elif string.lower(level) == "counter_enumiii":
661 # LabelType Counter_EnumI
668 match = re_LabelType.match(lines[i])
670 label = match.group(4)
671 # Remember indenting space for later reuse in added lines
672 space1 = match.group(1)
673 # Remember the line for adding the LabelCounter later.
674 # We can't do it here because it could shift latextype_line etc.
676 if string.lower(label[:8]) == "counter_":
677 counter = string.lower(label[8:])
678 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
680 # Remember the LabelString line
681 match = re_LabelString.match(lines[i])
683 labelstring = match.group(4)
686 # Remember the LabelStringAppendix line
687 match = re_LabelStringAppendix.match(lines[i])
689 labelstringappendix = match.group(4)
690 labelstringappendix_line = i
692 # Remember the LatexType line
693 match = re_LatexType.match(lines[i])
695 latextype = string.lower(match.group(4))
698 # Remember the TocLevel line
699 match = re_TocLevel.match(lines[i])
701 toclevel = string.lower(match.group(4))
703 # Reset variables at the beginning of a style definition
704 match = re_Style.match(lines[i])
706 style = string.lower(match.group(4))
712 labelstringappendix = ""
713 labelstring_line = -1
714 labelstringappendix_line = -1
719 if re_End.match(lines[i]):
721 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
722 # (or change the existing LatexType)
723 if string.lower(label) == "bibliography":
724 if (latextype_line < 0):
725 lines.insert(i, "%sLatexType Bib_Environment" % space1)
728 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
730 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
731 if latextype == "item_environment" and string.lower(label) == "static":
732 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
734 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
735 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
736 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
737 # Don't add the LabelCounter line later
742 # LabelString "Chapter"
746 # LabelString "Chapter \arabic{chapter}"
748 # if this style has a counter. Ditto for LabelStringAppendix.
749 # This emulates the hardcoded article style numbering of 1.3
752 if style in counters:
753 if labelstring_line < 0:
754 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
757 new_labelstring = concatenate_label(labelstring, counters[style])
758 lines[labelstring_line] = re_LabelString.sub(
759 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
760 lines[labelstring_line])
761 if style in appendixcounters:
762 if labelstringappendix_line < 0:
763 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
766 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
767 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
768 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
769 lines[labelstringappendix_line])
771 # Now we can safely add the LabelCounter line
772 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
775 # Add the TocLevel setting for sectioning styles
776 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
777 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
783 lines.insert(i, "Format 2")
786 for mod in usemodules:
787 lines.insert(i, "UseModule " + mod)
800 source = open(argv[1], 'rb')
801 output = open(argv[2], 'wb')
803 error(usage(argv[0]))
808 while (format < currentFormat):
809 format = convert(lines)
820 if __name__ == "__main__":