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_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$')
215 # counters for sectioning styles (hardcoded in 1.3)
216 counters = {"part" : "\\Roman{part}",
217 "chapter" : "\\arabic{chapter}",
218 "section" : "\\arabic{section}",
219 "subsection" : "\\arabic{section}.\\arabic{subsection}",
220 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
221 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
222 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
224 # counters for sectioning styles in appendix (hardcoded in 1.3)
225 appendixcounters = {"chapter" : "\\Alph{chapter}",
226 "section" : "\\Alph{section}",
227 "subsection" : "\\arabic{section}.\\arabic{subsection}",
228 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
229 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
230 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
232 # Value of TocLevel for sectioning styles
233 toclevels = {"part" : 0,
247 labelstringappendix = ""
249 labelstring_line = -1
250 labelstringappendix_line = -1
260 while i < len(lines):
261 # Skip comments and empty lines
262 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
266 # insert file format if not already there
268 match = re_Format.match(lines[i])
271 format = int(match.group(4))
272 if format > 1 and format < currentFormat:
273 lines[i] = "Format %d" % (format + 1)
275 elif format == currentFormat:
279 error('Cannot convert file format %s' % format)
281 lines.insert(i, "Format 2")
285 # Don't get confused by LaTeX code
286 if re_Preamble.match(lines[i]):
288 while i < len(lines) and not re_EndPreamble.match(lines[i]):
291 if re_LangPreamble.match(lines[i]):
293 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
296 if re_BabelPreamble.match(lines[i]):
298 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
303 match = re_NeedsFloatPkg.match(lines[i])
305 space = match.group(1)
307 lines[i] = space + "UsesFloatPkg " + val
309 if val.lower() == 'true':
311 lines.insert(i, space + "IsPredefined " + newval)
317 if format >= 29 and format <= 31:
322 match = re_InsetLayout.match(lines[i])
324 lines[i] = "InsetLayout Flex:" + match.group(1)
326 match = re_QInsetLayout.match(lines[i])
328 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
333 if format >= 24 and format <= 27:
338 match = re_Float.match(lines[i])
342 # we need to do two things:
343 # (i) Convert Builtin to NeedsFloatPkg
344 # (ii) Write ListCommand lines for the builtin floats table and figure
347 while True and i < len(lines):
348 m1 = re_End.match(lines[i])
351 line = " ListCommand " + cmd
352 lines.insert(i, line)
355 m2 = re_Builtin.match(lines[i])
361 if re_True.match(arg):
365 lines[i] = ws1 + "NeedsFloatPkg " + newarg
366 m3 = re_Type.match(lines[i])
369 fltype = fltype.lower()
370 if fltype == "table":
372 elif fltype == "figure":
373 cmd = "listoffigures"
374 # else unknown, which is why we're doing this
378 # This just involved new features, not any changes to old ones
379 if format >= 14 and format <= 22:
383 # Rename I18NPreamble to BabelPreamble
385 match = re_I18nPreamble.match(lines[i])
387 lines[i] = match.group(1) + "BabelPreamble"
389 match = re_EndI18nPreamble.match(lines[i])
390 while i < len(lines) and not match:
392 match = re_EndI18nPreamble.match(lines[i])
393 lines[i] = match.group(1) + "EndBabelPreamble"
397 # These just involved new features, not any changes to old ones
398 if format == 11 or format == 12:
403 match = re_UseMod.match(lines[i])
405 module = match.group(1)
406 lines[i] = "DefaultModule " + module
411 match = re_Counter.match(lines[i])
415 while i < len(lines):
416 namem = re_Name.match(lines[i])
418 name = namem.group(1)
420 lines[counterline] = "Counter %s" % name
421 # we don't need to increment i
423 endem = re_End.match(lines[i])
432 # We want to scan for ams-type includes and, if we find them,
433 # add corresponding UseModule tags to the layout.
434 match = re_AMSMaths.match(lines[i])
436 addstring("theorems-ams", usemodules)
437 addstring("theorems-ams-extended", usemodules)
438 addstring("theorems-sec", usemodules)
441 match = re_AMSMathsPlain.match(lines[i])
443 addstring("theorems-starred", usemodules)
446 match = re_AMSMathsSeq.match(lines[i])
448 addstring("theorems-ams", usemodules)
449 addstring("theorems-ams-extended", usemodules)
455 # These just involved new features, not any changes to old ones
456 if format >= 5 and format <= 7:
461 # Handle conversion to long CharStyle names
462 match = re_CharStyle.match(lines[i])
464 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
466 lines.insert(i, "\tLyXType charstyle")
469 lines[i] = "\tLabelString %s" % (match.group(3))
474 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
475 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
477 match = re_Provides.match(lines[i])
479 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
480 match.group(3), match.group(4))
487 # delete caption styles
488 match = re_Style.match(lines[i])
490 style = string.lower(match.group(4))
491 if style == "caption":
493 while i < len(lines) and not re_End.match(lines[i]):
494 caption.append(lines[i])
497 error('Incomplete caption style.')
502 # delete undefinition of caption styles
503 match = re_NoStyle.match(lines[i])
505 style = string.lower(match.group(4))
506 if style == "caption":
510 # replace the CopyStyle statement with the definition of the real
511 # style. This may result in duplicate statements, but that is OK
512 # since the second one will overwrite the first one.
513 match = re_CopyStyle.match(lines[i])
515 style = string.lower(match.group(4))
516 if style == "caption":
518 lines[i:i+1] = caption
520 # FIXME: This style comes from an include file, we
521 # should replace the real style and not this default.
522 lines[i:i+1] = [' Margin First_Dynamic',
523 ' LatexType Command',
524 ' LatexName caption',
530 ' AlignPossible Center',
531 ' LabelType Sensitive',
532 ' LabelString "Senseless!"',
541 # Delete MaxCounter and remember the value of it
542 match = re_MaxCounter.match(lines[i])
544 level = match.group(4)
545 if string.lower(level) == "counter_chapter":
547 elif string.lower(level) == "counter_section":
549 elif string.lower(level) == "counter_subsection":
551 elif string.lower(level) == "counter_subsubsection":
553 elif string.lower(level) == "counter_paragraph":
555 elif string.lower(level) == "counter_subparagraph":
557 elif string.lower(level) == "counter_enumi":
559 elif string.lower(level) == "counter_enumii":
561 elif string.lower(level) == "counter_enumiii":
568 # LabelType Counter_EnumI
575 match = re_LabelType.match(lines[i])
577 label = match.group(4)
578 # Remember indenting space for later reuse in added lines
579 space1 = match.group(1)
580 # Remember the line for adding the LabelCounter later.
581 # We can't do it here because it could shift latextype_line etc.
583 if string.lower(label[:8]) == "counter_":
584 counter = string.lower(label[8:])
585 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
587 # Remember the LabelString line
588 match = re_LabelString.match(lines[i])
590 labelstring = match.group(4)
593 # Remember the LabelStringAppendix line
594 match = re_LabelStringAppendix.match(lines[i])
596 labelstringappendix = match.group(4)
597 labelstringappendix_line = i
599 # Remember the LatexType line
600 match = re_LatexType.match(lines[i])
602 latextype = string.lower(match.group(4))
605 # Remember the TocLevel line
606 match = re_TocLevel.match(lines[i])
608 toclevel = string.lower(match.group(4))
610 # Reset variables at the beginning of a style definition
611 match = re_Style.match(lines[i])
613 style = string.lower(match.group(4))
619 labelstringappendix = ""
620 labelstring_line = -1
621 labelstringappendix_line = -1
626 if re_End.match(lines[i]):
628 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
629 # (or change the existing LatexType)
630 if string.lower(label) == "bibliography":
631 if (latextype_line < 0):
632 lines.insert(i, "%sLatexType Bib_Environment" % space1)
635 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
637 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
638 if latextype == "item_environment" and string.lower(label) == "static":
639 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
641 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
642 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
643 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
644 # Don't add the LabelCounter line later
649 # LabelString "Chapter"
653 # LabelString "Chapter \arabic{chapter}"
655 # if this style has a counter. Ditto for LabelStringAppendix.
656 # This emulates the hardcoded article style numbering of 1.3
659 if counters.has_key(style):
660 if labelstring_line < 0:
661 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
664 new_labelstring = concatenate_label(labelstring, counters[style])
665 lines[labelstring_line] = re_LabelString.sub(
666 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
667 lines[labelstring_line])
668 if appendixcounters.has_key(style):
669 if labelstringappendix_line < 0:
670 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
673 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
674 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
675 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
676 lines[labelstringappendix_line])
678 # Now we can safely add the LabelCounter line
679 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
682 # Add the TocLevel setting for sectioning styles
683 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
684 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
691 for mod in usemodules:
692 lines.insert(i, "UseModule " + mod)
705 source = open(argv[1], 'rb')
706 output = open(argv[2], 'wb')
708 error(usage(argv[0]))
713 while (format < currentFormat):
714 format = convert(lines)
725 if __name__ == "__main__":