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 # Do not forget to document format change in Customization
108 # Manual (section "Declaring a new text class").
110 # You might also want to consider running the
111 # development/tools/updatelayouts.sh script to update all
112 # layout files to the new format.
117 def usage(prog_name):
118 return ("Usage: %s inputfile outputfile\n" % prog_name +
119 "or %s <inputfile >outputfile" % prog_name)
123 sys.stderr.write(message + '\n')
128 " Remove byte order mark."
129 if line[0:3] == "\357\273\277":
136 " Read input file and strip lineendings."
137 lines = source.read().splitlines()
138 lines[0] = trim_bom(lines[0])
142 def write(output, lines):
143 " Write output file with native lineendings."
144 output.write(os.linesep.join(lines) + os.linesep)
147 # Concatenates old and new in an intelligent way:
148 # If old is wrapped in ", they are stripped. The result is wrapped in ".
149 def concatenate_label(old, new):
150 # Don't use strip as long as we support python 1.5.2
152 return old[0:-1] + new + '"'
154 return '"' + old + new + '"'
156 # appends a string to a list unless it's already there
164 " Convert to new format."
165 re_Comment = re.compile(r'^(\s*)#')
166 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
167 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
168 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
169 re_Empty = re.compile(r'^(\s*)$')
170 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
171 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
172 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
173 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
174 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
175 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
176 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
177 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
178 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
179 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
180 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
181 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
182 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
183 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
184 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
185 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
186 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
187 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
188 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
189 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
190 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
191 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
192 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
193 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
194 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
195 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
196 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
197 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
198 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$')
200 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$')
202 # counters for sectioning styles (hardcoded in 1.3)
203 counters = {"part" : "\\Roman{part}",
204 "chapter" : "\\arabic{chapter}",
205 "section" : "\\arabic{section}",
206 "subsection" : "\\arabic{section}.\\arabic{subsection}",
207 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
208 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
209 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
211 # counters for sectioning styles in appendix (hardcoded in 1.3)
212 appendixcounters = {"chapter" : "\\Alph{chapter}",
213 "section" : "\\Alph{section}",
214 "subsection" : "\\arabic{section}.\\arabic{subsection}",
215 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
216 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
217 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
219 # Value of TocLevel for sectioning styles
220 toclevels = {"part" : 0,
234 labelstringappendix = ""
236 labelstring_line = -1
237 labelstringappendix_line = -1
247 while i < len(lines):
248 # Skip comments and empty lines
249 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
253 # insert file format if not already there
255 match = re_Format.match(lines[i])
258 format = int(match.group(4))
259 if format > 1 and format < currentFormat:
260 lines[i] = "Format %d" % (format + 1)
262 elif format == currentFormat:
266 error('Cannot convert file format %s' % format)
268 lines.insert(i, "Format 2")
272 # Don't get confused by LaTeX code
273 if re_Preamble.match(lines[i]):
275 while i < len(lines) and not re_EndPreamble.match(lines[i]):
278 if re_LangPreamble.match(lines[i]):
280 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
283 if re_BabelPreamble.match(lines[i]):
285 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
290 match = re_InsetLayout.match(lines[i])
292 lines[i] = "InsetLayout Flex:" + match.group(1)
294 match = re_QInsetLayout.match(lines[i])
296 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
301 if format >= 24 and format <= 27:
306 match = re_Float.match(lines[i])
310 # we need to do two things:
311 # (i) Convert Builtin to NeedsFloatPkg
312 # (ii) Write ListCommand lines for the builtin floats table and figure
315 while True and i < len(lines):
316 m1 = re_End.match(lines[i])
319 line = " ListCommand " + cmd
320 lines.insert(i, line)
323 m2 = re_Builtin.match(lines[i])
329 if re_True.match(arg):
333 lines[i] = ws1 + "NeedsFloatPkg " + newarg
334 m3 = re_Type.match(lines[i])
337 fltype = fltype.lower()
338 if fltype == "table":
340 elif fltype == "figure":
341 cmd = "listoffigures"
342 # else unknown, which is why we're doing this
346 # This just involved new features, not any changes to old ones
347 if format >= 14 and format <= 22:
351 # Rename I18NPreamble to BabelPreamble
353 match = re_I18nPreamble.match(lines[i])
355 lines[i] = match.group(1) + "BabelPreamble"
357 match = re_EndI18nPreamble.match(lines[i])
358 while i < len(lines) and not match:
360 match = re_EndI18nPreamble.match(lines[i])
361 lines[i] = match.group(1) + "EndBabelPreamble"
365 # These just involved new features, not any changes to old ones
366 if format == 11 or format == 12:
371 match = re_UseMod.match(lines[i])
373 module = match.group(1)
374 lines[i] = "DefaultModule " + module
379 match = re_Counter.match(lines[i])
383 while i < len(lines):
384 namem = re_Name.match(lines[i])
386 name = namem.group(1)
388 lines[counterline] = "Counter %s" % name
389 # we don't need to increment i
391 endem = re_End.match(lines[i])
400 # We want to scan for ams-type includes and, if we find them,
401 # add corresponding UseModule tags to the layout.
402 match = re_AMSMaths.match(lines[i])
404 addstring("theorems-ams", usemodules)
405 addstring("theorems-ams-extended", usemodules)
406 addstring("theorems-sec", usemodules)
409 match = re_AMSMathsPlain.match(lines[i])
411 addstring("theorems-starred", usemodules)
414 match = re_AMSMathsSeq.match(lines[i])
416 addstring("theorems-ams", usemodules)
417 addstring("theorems-ams-extended", usemodules)
423 # These just involved new features, not any changes to old ones
424 if format >= 5 and format <= 7:
429 # Handle conversion to long CharStyle names
430 match = re_CharStyle.match(lines[i])
432 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
434 lines.insert(i, "\tLyXType charstyle")
437 lines[i] = "\tLabelString %s" % (match.group(3))
442 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
443 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
445 match = re_Provides.match(lines[i])
447 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
448 match.group(3), match.group(4))
455 # delete caption styles
456 match = re_Style.match(lines[i])
458 style = string.lower(match.group(4))
459 if style == "caption":
461 while i < len(lines) and not re_End.match(lines[i]):
462 caption.append(lines[i])
465 error('Incomplete caption style.')
470 # delete undefinition of caption styles
471 match = re_NoStyle.match(lines[i])
473 style = string.lower(match.group(4))
474 if style == "caption":
478 # replace the CopyStyle statement with the definition of the real
479 # style. This may result in duplicate statements, but that is OK
480 # since the second one will overwrite the first one.
481 match = re_CopyStyle.match(lines[i])
483 style = string.lower(match.group(4))
484 if style == "caption":
486 lines[i:i+1] = caption
488 # FIXME: This style comes from an include file, we
489 # should replace the real style and not this default.
490 lines[i:i+1] = [' Margin First_Dynamic',
491 ' LatexType Command',
492 ' LatexName caption',
498 ' AlignPossible Center',
499 ' LabelType Sensitive',
500 ' LabelString "Senseless!"',
509 # Delete MaxCounter and remember the value of it
510 match = re_MaxCounter.match(lines[i])
512 level = match.group(4)
513 if string.lower(level) == "counter_chapter":
515 elif string.lower(level) == "counter_section":
517 elif string.lower(level) == "counter_subsection":
519 elif string.lower(level) == "counter_subsubsection":
521 elif string.lower(level) == "counter_paragraph":
523 elif string.lower(level) == "counter_subparagraph":
525 elif string.lower(level) == "counter_enumi":
527 elif string.lower(level) == "counter_enumii":
529 elif string.lower(level) == "counter_enumiii":
536 # LabelType Counter_EnumI
543 match = re_LabelType.match(lines[i])
545 label = match.group(4)
546 # Remember indenting space for later reuse in added lines
547 space1 = match.group(1)
548 # Remember the line for adding the LabelCounter later.
549 # We can't do it here because it could shift latextype_line etc.
551 if string.lower(label[:8]) == "counter_":
552 counter = string.lower(label[8:])
553 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
555 # Remember the LabelString line
556 match = re_LabelString.match(lines[i])
558 labelstring = match.group(4)
561 # Remember the LabelStringAppendix line
562 match = re_LabelStringAppendix.match(lines[i])
564 labelstringappendix = match.group(4)
565 labelstringappendix_line = i
567 # Remember the LatexType line
568 match = re_LatexType.match(lines[i])
570 latextype = string.lower(match.group(4))
573 # Remember the TocLevel line
574 match = re_TocLevel.match(lines[i])
576 toclevel = string.lower(match.group(4))
578 # Reset variables at the beginning of a style definition
579 match = re_Style.match(lines[i])
581 style = string.lower(match.group(4))
587 labelstringappendix = ""
588 labelstring_line = -1
589 labelstringappendix_line = -1
594 if re_End.match(lines[i]):
596 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
597 # (or change the existing LatexType)
598 if string.lower(label) == "bibliography":
599 if (latextype_line < 0):
600 lines.insert(i, "%sLatexType Bib_Environment" % space1)
603 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
605 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
606 if latextype == "item_environment" and string.lower(label) == "static":
607 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
609 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
610 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
611 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
612 # Don't add the LabelCounter line later
617 # LabelString "Chapter"
621 # LabelString "Chapter \arabic{chapter}"
623 # if this style has a counter. Ditto for LabelStringAppendix.
624 # This emulates the hardcoded article style numbering of 1.3
627 if counters.has_key(style):
628 if labelstring_line < 0:
629 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
632 new_labelstring = concatenate_label(labelstring, counters[style])
633 lines[labelstring_line] = re_LabelString.sub(
634 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
635 lines[labelstring_line])
636 if appendixcounters.has_key(style):
637 if labelstringappendix_line < 0:
638 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
641 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
642 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
643 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
644 lines[labelstringappendix_line])
646 # Now we can safely add the LabelCounter line
647 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
650 # Add the TocLevel setting for sectioning styles
651 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
652 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
659 for mod in usemodules:
660 lines.insert(i, "UseModule " + mod)
673 source = open(argv[1], 'rb')
674 output = open(argv[2], 'wb')
676 error(usage(argv[0]))
681 while (format < currentFormat):
682 format = convert(lines)
693 if __name__ == "__main__":