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 # Do not forget to document format change in Customization
133 # Manual (section "Declaring a new text class").
135 # You might also want to consider running the
136 # development/tools/updatelayouts.sh script to update all
137 # layout files to the new format.
142 def usage(prog_name):
143 return ("Usage: %s inputfile outputfile\n" % prog_name +
144 "or %s <inputfile >outputfile" % prog_name)
148 sys.stderr.write(message + '\n')
153 " Remove byte order mark."
154 if line[0:3] == "\357\273\277":
161 " Read input file and strip lineendings."
162 lines = source.read().splitlines() or ['']
163 lines[0] = trim_bom(lines[0])
167 def write(output, lines):
168 " Write output file with native lineendings."
169 output.write(os.linesep.join(lines) + os.linesep)
172 # Concatenates old and new in an intelligent way:
173 # If old is wrapped in ", they are stripped. The result is wrapped in ".
174 def concatenate_label(old, new):
175 # Don't use strip as long as we support python 1.5.2
177 return old[0:-1] + new + '"'
179 return '"' + old + new + '"'
181 # appends a string to a list unless it's already there
189 " Convert to new format."
190 re_Comment = re.compile(r'^(\s*)#')
191 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
192 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
193 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
194 re_Empty = re.compile(r'^(\s*)$')
195 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
196 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
197 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
198 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
199 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
200 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
201 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
202 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
203 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
204 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
205 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
206 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
207 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
208 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
209 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
210 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
211 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
212 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
213 re_CiteFormat = re.compile(r'^(\s*)(CiteFormat)(?:(\s*)()|(\s+)(default|authoryear|numerical))', re.IGNORECASE)
214 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
215 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
216 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
217 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
218 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
219 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
220 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
221 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
222 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
223 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
224 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
226 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
227 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
228 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
229 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
230 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
231 re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
233 re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
234 re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
235 re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
237 # counters for sectioning styles (hardcoded in 1.3)
238 counters = {"part" : "\\Roman{part}",
239 "chapter" : "\\arabic{chapter}",
240 "section" : "\\arabic{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 # counters for sectioning styles in appendix (hardcoded in 1.3)
247 appendixcounters = {"chapter" : "\\Alph{chapter}",
248 "section" : "\\Alph{section}",
249 "subsection" : "\\arabic{section}.\\arabic{subsection}",
250 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
251 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
252 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
254 # Value of TocLevel for sectioning styles
255 toclevels = {"part" : 0,
269 labelstringappendix = ""
271 labelstring_line = -1
272 labelstringappendix_line = -1
283 while i < len(lines):
284 # Skip comments and empty lines
285 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
289 # insert file format if not already there
291 match = re_Format.match(lines[i])
294 format = int(match.group(4))
295 if format > 1 and format < currentFormat:
296 lines[i] = "Format %d" % (format + 1)
298 elif format == currentFormat:
302 error('Cannot convert file format %s' % format)
304 lines.insert(i, "Format 2")
308 # Don't get confused by LaTeX code
309 if re_Preamble.match(lines[i]):
311 while i < len(lines) and not re_EndPreamble.match(lines[i]):
314 if re_LangPreamble.match(lines[i]):
316 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
319 if re_BabelPreamble.match(lines[i]):
321 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
326 match = re_CiteFormat.match(lines[i]);
327 if match and match.group(4) == "":
328 lines[i] = match.group(0) + " default"
337 match = re_InsetLayout2.match(lines[i])
339 match = re_QInsetLayout2.match(lines[i])
341 match = re_CopyStyle2.match(lines[i])
345 style = match.group(2)
347 if flexstyles.count(style):
348 lines[i] = match.group(1) + "\"Flex:" + style + "\""
352 name = match.group(1)
353 names = name.split(":", 1)
354 if len(names) > 1 and names[0] == "Flex":
359 for j in range(i + 1, len(lines)):
360 if re_IsFlex.match(lines[j]):
363 if re_End.match(lines[j]):
367 flexstyles.append(name)
368 lines[i] = "InsetLayout \"Flex:" + name + "\""
374 m = re_Fill.match(lines[i])
381 match = re_NeedsFloatPkg.match(lines[i])
383 space = match.group(1)
385 lines[i] = space + "UsesFloatPkg " + val
387 if val == '1' or val.lower() == 'true':
389 lines.insert(i, space + "IsPredefined " + newval)
395 if format >= 29 and format <= 31:
400 match = re_InsetLayout.match(lines[i])
402 lines[i] = "InsetLayout Flex:" + match.group(1)
404 match = re_QInsetLayout.match(lines[i])
406 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
408 match = re_InsetLayout_CopyStyle.match(lines[i])
410 lines[i] = "\tCopyStyle Flex:" + match.group(1)
412 match = re_QInsetLayout_CopyStyle.match(lines[i])
414 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
419 if format >= 24 and format <= 27:
424 match = re_Float.match(lines[i])
428 # we need to do two things:
429 # (i) Convert Builtin to NeedsFloatPkg
430 # (ii) Write ListCommand lines for the builtin floats table and figure
433 while True and i < len(lines):
434 m1 = re_End.match(lines[i])
437 line = " ListCommand " + cmd
438 lines.insert(i, line)
441 m2 = re_Builtin.match(lines[i])
447 if re_True.match(arg):
451 lines[i] = ws1 + "NeedsFloatPkg " + newarg
452 m3 = re_Type.match(lines[i])
455 fltype = fltype.lower()
456 if fltype == "table":
458 elif fltype == "figure":
459 cmd = "listoffigures"
460 # else unknown, which is why we're doing this
464 # This just involved new features, not any changes to old ones
465 if format >= 14 and format <= 22:
469 # Rename I18NPreamble to BabelPreamble
471 match = re_I18nPreamble.match(lines[i])
473 lines[i] = match.group(1) + "BabelPreamble"
475 match = re_EndI18nPreamble.match(lines[i])
476 while i < len(lines) and not match:
478 match = re_EndI18nPreamble.match(lines[i])
479 lines[i] = match.group(1) + "EndBabelPreamble"
483 # These just involved new features, not any changes to old ones
484 if format == 11 or format == 12:
489 match = re_UseMod.match(lines[i])
491 module = match.group(1)
492 lines[i] = "DefaultModule " + module
497 match = re_Counter.match(lines[i])
501 while i < len(lines):
502 namem = re_Name.match(lines[i])
504 name = namem.group(1)
506 lines[counterline] = "Counter %s" % name
507 # we don't need to increment i
509 endem = re_End.match(lines[i])
518 # We want to scan for ams-type includes and, if we find them,
519 # add corresponding UseModule tags to the layout.
520 match = re_AMSMaths.match(lines[i])
522 addstring("theorems-ams", usemodules)
523 addstring("theorems-ams-extended", usemodules)
524 addstring("theorems-sec", usemodules)
527 match = re_AMSMathsPlain.match(lines[i])
529 addstring("theorems-starred", usemodules)
532 match = re_AMSMathsSeq.match(lines[i])
534 addstring("theorems-ams", usemodules)
535 addstring("theorems-ams-extended", usemodules)
541 # These just involved new features, not any changes to old ones
542 if format >= 5 and format <= 7:
547 # Handle conversion to long CharStyle names
548 match = re_CharStyle.match(lines[i])
550 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
552 lines.insert(i, "\tLyXType charstyle")
555 lines[i] = "\tLabelString %s" % (match.group(3))
560 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
561 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
563 match = re_Provides.match(lines[i])
565 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
566 match.group(3), match.group(4))
573 # delete caption styles
574 match = re_Style.match(lines[i])
576 style = string.lower(match.group(4))
577 if style == "caption":
579 while i < len(lines) and not re_End.match(lines[i]):
580 caption.append(lines[i])
583 error('Incomplete caption style.')
588 # delete undefinition of caption styles
589 match = re_NoStyle.match(lines[i])
591 style = string.lower(match.group(4))
592 if style == "caption":
596 # replace the CopyStyle statement with the definition of the real
597 # style. This may result in duplicate statements, but that is OK
598 # since the second one will overwrite the first one.
599 match = re_CopyStyle.match(lines[i])
601 style = string.lower(match.group(4))
602 if style == "caption":
604 lines[i:i+1] = caption
606 # FIXME: This style comes from an include file, we
607 # should replace the real style and not this default.
608 lines[i:i+1] = [' Margin First_Dynamic',
609 ' LatexType Command',
610 ' LatexName caption',
616 ' AlignPossible Center',
617 ' LabelType Sensitive',
618 ' LabelString "Senseless!"',
627 # Delete MaxCounter and remember the value of it
628 match = re_MaxCounter.match(lines[i])
630 level = match.group(4)
631 if string.lower(level) == "counter_chapter":
633 elif string.lower(level) == "counter_section":
635 elif string.lower(level) == "counter_subsection":
637 elif string.lower(level) == "counter_subsubsection":
639 elif string.lower(level) == "counter_paragraph":
641 elif string.lower(level) == "counter_subparagraph":
643 elif string.lower(level) == "counter_enumi":
645 elif string.lower(level) == "counter_enumii":
647 elif string.lower(level) == "counter_enumiii":
654 # LabelType Counter_EnumI
661 match = re_LabelType.match(lines[i])
663 label = match.group(4)
664 # Remember indenting space for later reuse in added lines
665 space1 = match.group(1)
666 # Remember the line for adding the LabelCounter later.
667 # We can't do it here because it could shift latextype_line etc.
669 if string.lower(label[:8]) == "counter_":
670 counter = string.lower(label[8:])
671 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
673 # Remember the LabelString line
674 match = re_LabelString.match(lines[i])
676 labelstring = match.group(4)
679 # Remember the LabelStringAppendix line
680 match = re_LabelStringAppendix.match(lines[i])
682 labelstringappendix = match.group(4)
683 labelstringappendix_line = i
685 # Remember the LatexType line
686 match = re_LatexType.match(lines[i])
688 latextype = string.lower(match.group(4))
691 # Remember the TocLevel line
692 match = re_TocLevel.match(lines[i])
694 toclevel = string.lower(match.group(4))
696 # Reset variables at the beginning of a style definition
697 match = re_Style.match(lines[i])
699 style = string.lower(match.group(4))
705 labelstringappendix = ""
706 labelstring_line = -1
707 labelstringappendix_line = -1
712 if re_End.match(lines[i]):
714 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
715 # (or change the existing LatexType)
716 if string.lower(label) == "bibliography":
717 if (latextype_line < 0):
718 lines.insert(i, "%sLatexType Bib_Environment" % space1)
721 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
723 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
724 if latextype == "item_environment" and string.lower(label) == "static":
725 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
727 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
728 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
729 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
730 # Don't add the LabelCounter line later
735 # LabelString "Chapter"
739 # LabelString "Chapter \arabic{chapter}"
741 # if this style has a counter. Ditto for LabelStringAppendix.
742 # This emulates the hardcoded article style numbering of 1.3
745 if style in counters:
746 if labelstring_line < 0:
747 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
750 new_labelstring = concatenate_label(labelstring, counters[style])
751 lines[labelstring_line] = re_LabelString.sub(
752 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
753 lines[labelstring_line])
754 if style in appendixcounters:
755 if labelstringappendix_line < 0:
756 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
759 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
760 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
761 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
762 lines[labelstringappendix_line])
764 # Now we can safely add the LabelCounter line
765 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
768 # Add the TocLevel setting for sectioning styles
769 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
770 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
776 lines.insert(i, "Format 2")
779 for mod in usemodules:
780 lines.insert(i, "UseModule " + mod)
793 source = open(argv[1], 'rb')
794 output = open(argv[2], 'wb')
796 error(usage(argv[0]))
801 while (format < currentFormat):
802 format = convert(lines)
813 if __name__ == "__main__":