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 # Do not forget to document format change in Customization
123 # Manual (section "Declaring a new text class").
125 # You might also want to consider running the
126 # development/tools/updatelayouts.sh script to update all
127 # layout files to the new format.
132 def usage(prog_name):
133 return ("Usage: %s inputfile outputfile\n" % prog_name +
134 "or %s <inputfile >outputfile" % prog_name)
138 sys.stderr.write(message + '\n')
143 " Remove byte order mark."
144 if line[0:3] == "\357\273\277":
151 " Read input file and strip lineendings."
152 lines = source.read().splitlines()
153 lines[0] = trim_bom(lines[0])
157 def write(output, lines):
158 " Write output file with native lineendings."
159 output.write(os.linesep.join(lines) + os.linesep)
162 # Concatenates old and new in an intelligent way:
163 # If old is wrapped in ", they are stripped. The result is wrapped in ".
164 def concatenate_label(old, new):
165 # Don't use strip as long as we support python 1.5.2
167 return old[0:-1] + new + '"'
169 return '"' + old + new + '"'
171 # appends a string to a list unless it's already there
179 " Convert to new format."
180 re_Comment = re.compile(r'^(\s*)#')
181 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
182 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
183 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
184 re_Empty = re.compile(r'^(\s*)$')
185 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
186 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
187 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
188 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
189 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
190 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
191 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
192 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
193 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
194 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
195 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
196 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
197 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
198 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
199 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
200 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
201 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
202 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
203 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
204 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
205 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
206 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
207 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
208 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
209 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
210 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
211 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
212 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
213 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
215 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
216 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
217 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
218 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
219 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
221 # counters for sectioning styles (hardcoded in 1.3)
222 counters = {"part" : "\\Roman{part}",
223 "chapter" : "\\arabic{chapter}",
224 "section" : "\\arabic{section}",
225 "subsection" : "\\arabic{section}.\\arabic{subsection}",
226 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
227 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
228 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
230 # counters for sectioning styles in appendix (hardcoded in 1.3)
231 appendixcounters = {"chapter" : "\\Alph{chapter}",
232 "section" : "\\Alph{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 # Value of TocLevel for sectioning styles
239 toclevels = {"part" : 0,
253 labelstringappendix = ""
255 labelstring_line = -1
256 labelstringappendix_line = -1
266 while i < len(lines):
267 # Skip comments and empty lines
268 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
272 # insert file format if not already there
274 match = re_Format.match(lines[i])
277 format = int(match.group(4))
278 if format > 1 and format < currentFormat:
279 lines[i] = "Format %d" % (format + 1)
281 elif format == currentFormat:
285 error('Cannot convert file format %s' % format)
287 lines.insert(i, "Format 2")
291 # Don't get confused by LaTeX code
292 if re_Preamble.match(lines[i]):
294 while i < len(lines) and not re_EndPreamble.match(lines[i]):
297 if re_LangPreamble.match(lines[i]):
299 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
302 if re_BabelPreamble.match(lines[i]):
304 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
309 m = re_Fill.match(lines[i])
316 match = re_NeedsFloatPkg.match(lines[i])
318 space = match.group(1)
320 lines[i] = space + "UsesFloatPkg " + val
322 if val == '1' or val.lower() == 'true':
324 lines.insert(i, space + "IsPredefined " + newval)
330 if format >= 29 and format <= 31:
335 match = re_InsetLayout.match(lines[i])
337 lines[i] = "InsetLayout Flex:" + match.group(1)
339 match = re_QInsetLayout.match(lines[i])
341 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
343 match = re_InsetLayout_CopyStyle.match(lines[i])
345 lines[i] = "\tCopyStyle Flex:" + match.group(1)
347 match = re_QInsetLayout_CopyStyle.match(lines[i])
349 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
354 if format >= 24 and format <= 27:
359 match = re_Float.match(lines[i])
363 # we need to do two things:
364 # (i) Convert Builtin to NeedsFloatPkg
365 # (ii) Write ListCommand lines for the builtin floats table and figure
368 while True and i < len(lines):
369 m1 = re_End.match(lines[i])
372 line = " ListCommand " + cmd
373 lines.insert(i, line)
376 m2 = re_Builtin.match(lines[i])
382 if re_True.match(arg):
386 lines[i] = ws1 + "NeedsFloatPkg " + newarg
387 m3 = re_Type.match(lines[i])
390 fltype = fltype.lower()
391 if fltype == "table":
393 elif fltype == "figure":
394 cmd = "listoffigures"
395 # else unknown, which is why we're doing this
399 # This just involved new features, not any changes to old ones
400 if format >= 14 and format <= 22:
404 # Rename I18NPreamble to BabelPreamble
406 match = re_I18nPreamble.match(lines[i])
408 lines[i] = match.group(1) + "BabelPreamble"
410 match = re_EndI18nPreamble.match(lines[i])
411 while i < len(lines) and not match:
413 match = re_EndI18nPreamble.match(lines[i])
414 lines[i] = match.group(1) + "EndBabelPreamble"
418 # These just involved new features, not any changes to old ones
419 if format == 11 or format == 12:
424 match = re_UseMod.match(lines[i])
426 module = match.group(1)
427 lines[i] = "DefaultModule " + module
432 match = re_Counter.match(lines[i])
436 while i < len(lines):
437 namem = re_Name.match(lines[i])
439 name = namem.group(1)
441 lines[counterline] = "Counter %s" % name
442 # we don't need to increment i
444 endem = re_End.match(lines[i])
453 # We want to scan for ams-type includes and, if we find them,
454 # add corresponding UseModule tags to the layout.
455 match = re_AMSMaths.match(lines[i])
457 addstring("theorems-ams", usemodules)
458 addstring("theorems-ams-extended", usemodules)
459 addstring("theorems-sec", usemodules)
462 match = re_AMSMathsPlain.match(lines[i])
464 addstring("theorems-starred", usemodules)
467 match = re_AMSMathsSeq.match(lines[i])
469 addstring("theorems-ams", usemodules)
470 addstring("theorems-ams-extended", usemodules)
476 # These just involved new features, not any changes to old ones
477 if format >= 5 and format <= 7:
482 # Handle conversion to long CharStyle names
483 match = re_CharStyle.match(lines[i])
485 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
487 lines.insert(i, "\tLyXType charstyle")
490 lines[i] = "\tLabelString %s" % (match.group(3))
495 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
496 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
498 match = re_Provides.match(lines[i])
500 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
501 match.group(3), match.group(4))
508 # delete caption styles
509 match = re_Style.match(lines[i])
511 style = string.lower(match.group(4))
512 if style == "caption":
514 while i < len(lines) and not re_End.match(lines[i]):
515 caption.append(lines[i])
518 error('Incomplete caption style.')
523 # delete undefinition of caption styles
524 match = re_NoStyle.match(lines[i])
526 style = string.lower(match.group(4))
527 if style == "caption":
531 # replace the CopyStyle statement with the definition of the real
532 # style. This may result in duplicate statements, but that is OK
533 # since the second one will overwrite the first one.
534 match = re_CopyStyle.match(lines[i])
536 style = string.lower(match.group(4))
537 if style == "caption":
539 lines[i:i+1] = caption
541 # FIXME: This style comes from an include file, we
542 # should replace the real style and not this default.
543 lines[i:i+1] = [' Margin First_Dynamic',
544 ' LatexType Command',
545 ' LatexName caption',
551 ' AlignPossible Center',
552 ' LabelType Sensitive',
553 ' LabelString "Senseless!"',
562 # Delete MaxCounter and remember the value of it
563 match = re_MaxCounter.match(lines[i])
565 level = match.group(4)
566 if string.lower(level) == "counter_chapter":
568 elif string.lower(level) == "counter_section":
570 elif string.lower(level) == "counter_subsection":
572 elif string.lower(level) == "counter_subsubsection":
574 elif string.lower(level) == "counter_paragraph":
576 elif string.lower(level) == "counter_subparagraph":
578 elif string.lower(level) == "counter_enumi":
580 elif string.lower(level) == "counter_enumii":
582 elif string.lower(level) == "counter_enumiii":
589 # LabelType Counter_EnumI
596 match = re_LabelType.match(lines[i])
598 label = match.group(4)
599 # Remember indenting space for later reuse in added lines
600 space1 = match.group(1)
601 # Remember the line for adding the LabelCounter later.
602 # We can't do it here because it could shift latextype_line etc.
604 if string.lower(label[:8]) == "counter_":
605 counter = string.lower(label[8:])
606 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
608 # Remember the LabelString line
609 match = re_LabelString.match(lines[i])
611 labelstring = match.group(4)
614 # Remember the LabelStringAppendix line
615 match = re_LabelStringAppendix.match(lines[i])
617 labelstringappendix = match.group(4)
618 labelstringappendix_line = i
620 # Remember the LatexType line
621 match = re_LatexType.match(lines[i])
623 latextype = string.lower(match.group(4))
626 # Remember the TocLevel line
627 match = re_TocLevel.match(lines[i])
629 toclevel = string.lower(match.group(4))
631 # Reset variables at the beginning of a style definition
632 match = re_Style.match(lines[i])
634 style = string.lower(match.group(4))
640 labelstringappendix = ""
641 labelstring_line = -1
642 labelstringappendix_line = -1
647 if re_End.match(lines[i]):
649 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
650 # (or change the existing LatexType)
651 if string.lower(label) == "bibliography":
652 if (latextype_line < 0):
653 lines.insert(i, "%sLatexType Bib_Environment" % space1)
656 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
658 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
659 if latextype == "item_environment" and string.lower(label) == "static":
660 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
662 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
663 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
664 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
665 # Don't add the LabelCounter line later
670 # LabelString "Chapter"
674 # LabelString "Chapter \arabic{chapter}"
676 # if this style has a counter. Ditto for LabelStringAppendix.
677 # This emulates the hardcoded article style numbering of 1.3
680 if style in counters:
681 if labelstring_line < 0:
682 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
685 new_labelstring = concatenate_label(labelstring, counters[style])
686 lines[labelstring_line] = re_LabelString.sub(
687 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
688 lines[labelstring_line])
689 if style in appendixcounters:
690 if labelstringappendix_line < 0:
691 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
694 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
695 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
696 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
697 lines[labelstringappendix_line])
699 # Now we can safely add the LabelCounter line
700 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
703 # Add the TocLevel setting for sectioning styles
704 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
705 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
712 for mod in usemodules:
713 lines.insert(i, "UseModule " + mod)
726 source = open(argv[1], 'rb')
727 output = open(argv[2], 'wb')
729 error(usage(argv[0]))
734 while (format < currentFormat):
735 format = convert(lines)
746 if __name__ == "__main__":