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 # Do not forget to document format change in Customization
120 # Manual (section "Declaring a new text class").
122 # You might also want to consider running the
123 # development/tools/updatelayouts.sh script to update all
124 # layout files to the new format.
129 def usage(prog_name):
130 return ("Usage: %s inputfile outputfile\n" % prog_name +
131 "or %s <inputfile >outputfile" % prog_name)
135 sys.stderr.write(message + '\n')
140 " Remove byte order mark."
141 if line[0:3] == "\357\273\277":
148 " Read input file and strip lineendings."
149 lines = source.read().splitlines()
150 lines[0] = trim_bom(lines[0])
154 def write(output, lines):
155 " Write output file with native lineendings."
156 output.write(os.linesep.join(lines) + os.linesep)
159 # Concatenates old and new in an intelligent way:
160 # If old is wrapped in ", they are stripped. The result is wrapped in ".
161 def concatenate_label(old, new):
162 # Don't use strip as long as we support python 1.5.2
164 return old[0:-1] + new + '"'
166 return '"' + old + new + '"'
168 # appends a string to a list unless it's already there
176 " Convert to new format."
177 re_Comment = re.compile(r'^(\s*)#')
178 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
179 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
180 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
181 re_Empty = re.compile(r'^(\s*)$')
182 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
183 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
184 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
185 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
186 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
187 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
188 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
189 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
190 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
191 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
192 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
193 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
194 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
195 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
196 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
197 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
198 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
199 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
200 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
201 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
202 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
203 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
204 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
205 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
206 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
207 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
208 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
209 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
210 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$')
212 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$')
213 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$')
214 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$')
215 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$')
217 # counters for sectioning styles (hardcoded in 1.3)
218 counters = {"part" : "\\Roman{part}",
219 "chapter" : "\\arabic{chapter}",
220 "section" : "\\arabic{section}",
221 "subsection" : "\\arabic{section}.\\arabic{subsection}",
222 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
223 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
224 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
226 # counters for sectioning styles in appendix (hardcoded in 1.3)
227 appendixcounters = {"chapter" : "\\Alph{chapter}",
228 "section" : "\\Alph{section}",
229 "subsection" : "\\arabic{section}.\\arabic{subsection}",
230 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
231 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
232 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
234 # Value of TocLevel for sectioning styles
235 toclevels = {"part" : 0,
249 labelstringappendix = ""
251 labelstring_line = -1
252 labelstringappendix_line = -1
262 while i < len(lines):
263 # Skip comments and empty lines
264 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
268 # insert file format if not already there
270 match = re_Format.match(lines[i])
273 format = int(match.group(4))
274 if format > 1 and format < currentFormat:
275 lines[i] = "Format %d" % (format + 1)
277 elif format == currentFormat:
281 error('Cannot convert file format %s' % format)
283 lines.insert(i, "Format 2")
287 # Don't get confused by LaTeX code
288 if re_Preamble.match(lines[i]):
290 while i < len(lines) and not re_EndPreamble.match(lines[i]):
293 if re_LangPreamble.match(lines[i]):
295 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
298 if re_BabelPreamble.match(lines[i]):
300 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
305 match = re_NeedsFloatPkg.match(lines[i])
307 space = match.group(1)
309 lines[i] = space + "UsesFloatPkg " + val
311 if val == '1' or val.lower() == 'true':
313 lines.insert(i, space + "IsPredefined " + newval)
319 if format >= 29 and format <= 31:
324 match = re_InsetLayout.match(lines[i])
326 lines[i] = "InsetLayout Flex:" + match.group(1)
328 match = re_QInsetLayout.match(lines[i])
330 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
332 match = re_InsetLayout_CopyStyle.match(lines[i])
334 lines[i] = "\tCopyStyle Flex:" + match.group(1)
336 match = re_QInsetLayout_CopyStyle.match(lines[i])
338 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
343 if format >= 24 and format <= 27:
348 match = re_Float.match(lines[i])
352 # we need to do two things:
353 # (i) Convert Builtin to NeedsFloatPkg
354 # (ii) Write ListCommand lines for the builtin floats table and figure
357 while True and i < len(lines):
358 m1 = re_End.match(lines[i])
361 line = " ListCommand " + cmd
362 lines.insert(i, line)
365 m2 = re_Builtin.match(lines[i])
371 if re_True.match(arg):
375 lines[i] = ws1 + "NeedsFloatPkg " + newarg
376 m3 = re_Type.match(lines[i])
379 fltype = fltype.lower()
380 if fltype == "table":
382 elif fltype == "figure":
383 cmd = "listoffigures"
384 # else unknown, which is why we're doing this
388 # This just involved new features, not any changes to old ones
389 if format >= 14 and format <= 22:
393 # Rename I18NPreamble to BabelPreamble
395 match = re_I18nPreamble.match(lines[i])
397 lines[i] = match.group(1) + "BabelPreamble"
399 match = re_EndI18nPreamble.match(lines[i])
400 while i < len(lines) and not match:
402 match = re_EndI18nPreamble.match(lines[i])
403 lines[i] = match.group(1) + "EndBabelPreamble"
407 # These just involved new features, not any changes to old ones
408 if format == 11 or format == 12:
413 match = re_UseMod.match(lines[i])
415 module = match.group(1)
416 lines[i] = "DefaultModule " + module
421 match = re_Counter.match(lines[i])
425 while i < len(lines):
426 namem = re_Name.match(lines[i])
428 name = namem.group(1)
430 lines[counterline] = "Counter %s" % name
431 # we don't need to increment i
433 endem = re_End.match(lines[i])
442 # We want to scan for ams-type includes and, if we find them,
443 # add corresponding UseModule tags to the layout.
444 match = re_AMSMaths.match(lines[i])
446 addstring("theorems-ams", usemodules)
447 addstring("theorems-ams-extended", usemodules)
448 addstring("theorems-sec", usemodules)
451 match = re_AMSMathsPlain.match(lines[i])
453 addstring("theorems-starred", usemodules)
456 match = re_AMSMathsSeq.match(lines[i])
458 addstring("theorems-ams", usemodules)
459 addstring("theorems-ams-extended", usemodules)
465 # These just involved new features, not any changes to old ones
466 if format >= 5 and format <= 7:
471 # Handle conversion to long CharStyle names
472 match = re_CharStyle.match(lines[i])
474 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
476 lines.insert(i, "\tLyXType charstyle")
479 lines[i] = "\tLabelString %s" % (match.group(3))
484 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
485 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
487 match = re_Provides.match(lines[i])
489 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
490 match.group(3), match.group(4))
497 # delete caption styles
498 match = re_Style.match(lines[i])
500 style = string.lower(match.group(4))
501 if style == "caption":
503 while i < len(lines) and not re_End.match(lines[i]):
504 caption.append(lines[i])
507 error('Incomplete caption style.')
512 # delete undefinition of caption styles
513 match = re_NoStyle.match(lines[i])
515 style = string.lower(match.group(4))
516 if style == "caption":
520 # replace the CopyStyle statement with the definition of the real
521 # style. This may result in duplicate statements, but that is OK
522 # since the second one will overwrite the first one.
523 match = re_CopyStyle.match(lines[i])
525 style = string.lower(match.group(4))
526 if style == "caption":
528 lines[i:i+1] = caption
530 # FIXME: This style comes from an include file, we
531 # should replace the real style and not this default.
532 lines[i:i+1] = [' Margin First_Dynamic',
533 ' LatexType Command',
534 ' LatexName caption',
540 ' AlignPossible Center',
541 ' LabelType Sensitive',
542 ' LabelString "Senseless!"',
551 # Delete MaxCounter and remember the value of it
552 match = re_MaxCounter.match(lines[i])
554 level = match.group(4)
555 if string.lower(level) == "counter_chapter":
557 elif string.lower(level) == "counter_section":
559 elif string.lower(level) == "counter_subsection":
561 elif string.lower(level) == "counter_subsubsection":
563 elif string.lower(level) == "counter_paragraph":
565 elif string.lower(level) == "counter_subparagraph":
567 elif string.lower(level) == "counter_enumi":
569 elif string.lower(level) == "counter_enumii":
571 elif string.lower(level) == "counter_enumiii":
578 # LabelType Counter_EnumI
585 match = re_LabelType.match(lines[i])
587 label = match.group(4)
588 # Remember indenting space for later reuse in added lines
589 space1 = match.group(1)
590 # Remember the line for adding the LabelCounter later.
591 # We can't do it here because it could shift latextype_line etc.
593 if string.lower(label[:8]) == "counter_":
594 counter = string.lower(label[8:])
595 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
597 # Remember the LabelString line
598 match = re_LabelString.match(lines[i])
600 labelstring = match.group(4)
603 # Remember the LabelStringAppendix line
604 match = re_LabelStringAppendix.match(lines[i])
606 labelstringappendix = match.group(4)
607 labelstringappendix_line = i
609 # Remember the LatexType line
610 match = re_LatexType.match(lines[i])
612 latextype = string.lower(match.group(4))
615 # Remember the TocLevel line
616 match = re_TocLevel.match(lines[i])
618 toclevel = string.lower(match.group(4))
620 # Reset variables at the beginning of a style definition
621 match = re_Style.match(lines[i])
623 style = string.lower(match.group(4))
629 labelstringappendix = ""
630 labelstring_line = -1
631 labelstringappendix_line = -1
636 if re_End.match(lines[i]):
638 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
639 # (or change the existing LatexType)
640 if string.lower(label) == "bibliography":
641 if (latextype_line < 0):
642 lines.insert(i, "%sLatexType Bib_Environment" % space1)
645 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
647 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
648 if latextype == "item_environment" and string.lower(label) == "static":
649 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
651 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
652 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
653 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
654 # Don't add the LabelCounter line later
659 # LabelString "Chapter"
663 # LabelString "Chapter \arabic{chapter}"
665 # if this style has a counter. Ditto for LabelStringAppendix.
666 # This emulates the hardcoded article style numbering of 1.3
669 if counters.has_key(style):
670 if labelstring_line < 0:
671 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
674 new_labelstring = concatenate_label(labelstring, counters[style])
675 lines[labelstring_line] = re_LabelString.sub(
676 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
677 lines[labelstring_line])
678 if appendixcounters.has_key(style):
679 if labelstringappendix_line < 0:
680 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
683 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
684 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
685 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
686 lines[labelstringappendix_line])
688 # Now we can safely add the LabelCounter line
689 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
692 # Add the TocLevel setting for sectioning styles
693 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
694 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
701 for mod in usemodules:
702 lines.insert(i, "UseModule " + mod)
715 source = open(argv[1], 'rb')
716 output = open(argv[2], 'wb')
718 error(usage(argv[0]))
723 while (format < currentFormat):
724 format = convert(lines)
735 if __name__ == "__main__":