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 # Do not forget to document format change in Customization
114 # Manual (section "Declaring a new text class").
116 # You might also want to consider running the
117 # development/tools/updatelayouts.sh script to update all
118 # layout files to the new format.
123 def usage(prog_name):
124 return ("Usage: %s inputfile outputfile\n" % prog_name +
125 "or %s <inputfile >outputfile" % prog_name)
129 sys.stderr.write(message + '\n')
134 " Remove byte order mark."
135 if line[0:3] == "\357\273\277":
142 " Read input file and strip lineendings."
143 lines = source.read().splitlines()
144 lines[0] = trim_bom(lines[0])
148 def write(output, lines):
149 " Write output file with native lineendings."
150 output.write(os.linesep.join(lines) + os.linesep)
153 # Concatenates old and new in an intelligent way:
154 # If old is wrapped in ", they are stripped. The result is wrapped in ".
155 def concatenate_label(old, new):
156 # Don't use strip as long as we support python 1.5.2
158 return old[0:-1] + new + '"'
160 return '"' + old + new + '"'
162 # appends a string to a list unless it's already there
170 " Convert to new format."
171 re_Comment = re.compile(r'^(\s*)#')
172 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
173 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
174 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
175 re_Empty = re.compile(r'^(\s*)$')
176 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
177 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
178 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
179 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
180 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
181 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
182 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
183 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
184 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
185 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
186 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
187 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
188 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
189 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
190 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
191 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
192 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
193 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
194 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
195 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
196 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
197 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
198 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
199 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
200 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
201 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
202 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
203 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
204 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$')
206 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$')
208 # counters for sectioning styles (hardcoded in 1.3)
209 counters = {"part" : "\\Roman{part}",
210 "chapter" : "\\arabic{chapter}",
211 "section" : "\\arabic{section}",
212 "subsection" : "\\arabic{section}.\\arabic{subsection}",
213 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
214 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
215 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
217 # counters for sectioning styles in appendix (hardcoded in 1.3)
218 appendixcounters = {"chapter" : "\\Alph{chapter}",
219 "section" : "\\Alph{section}",
220 "subsection" : "\\arabic{section}.\\arabic{subsection}",
221 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
222 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
223 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
225 # Value of TocLevel for sectioning styles
226 toclevels = {"part" : 0,
240 labelstringappendix = ""
242 labelstring_line = -1
243 labelstringappendix_line = -1
253 while i < len(lines):
254 # Skip comments and empty lines
255 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
259 # insert file format if not already there
261 match = re_Format.match(lines[i])
264 format = int(match.group(4))
265 if format > 1 and format < currentFormat:
266 lines[i] = "Format %d" % (format + 1)
268 elif format == currentFormat:
272 error('Cannot convert file format %s' % format)
274 lines.insert(i, "Format 2")
278 # Don't get confused by LaTeX code
279 if re_Preamble.match(lines[i]):
281 while i < len(lines) and not re_EndPreamble.match(lines[i]):
284 if re_LangPreamble.match(lines[i]):
286 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
289 if re_BabelPreamble.match(lines[i]):
291 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
296 if format == 29 or format == 30:
301 match = re_InsetLayout.match(lines[i])
303 lines[i] = "InsetLayout Flex:" + match.group(1)
305 match = re_QInsetLayout.match(lines[i])
307 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
312 if format >= 24 and format <= 27:
317 match = re_Float.match(lines[i])
321 # we need to do two things:
322 # (i) Convert Builtin to NeedsFloatPkg
323 # (ii) Write ListCommand lines for the builtin floats table and figure
326 while True and i < len(lines):
327 m1 = re_End.match(lines[i])
330 line = " ListCommand " + cmd
331 lines.insert(i, line)
334 m2 = re_Builtin.match(lines[i])
340 if re_True.match(arg):
344 lines[i] = ws1 + "NeedsFloatPkg " + newarg
345 m3 = re_Type.match(lines[i])
348 fltype = fltype.lower()
349 if fltype == "table":
351 elif fltype == "figure":
352 cmd = "listoffigures"
353 # else unknown, which is why we're doing this
357 # This just involved new features, not any changes to old ones
358 if format >= 14 and format <= 22:
362 # Rename I18NPreamble to BabelPreamble
364 match = re_I18nPreamble.match(lines[i])
366 lines[i] = match.group(1) + "BabelPreamble"
368 match = re_EndI18nPreamble.match(lines[i])
369 while i < len(lines) and not match:
371 match = re_EndI18nPreamble.match(lines[i])
372 lines[i] = match.group(1) + "EndBabelPreamble"
376 # These just involved new features, not any changes to old ones
377 if format == 11 or format == 12:
382 match = re_UseMod.match(lines[i])
384 module = match.group(1)
385 lines[i] = "DefaultModule " + module
390 match = re_Counter.match(lines[i])
394 while i < len(lines):
395 namem = re_Name.match(lines[i])
397 name = namem.group(1)
399 lines[counterline] = "Counter %s" % name
400 # we don't need to increment i
402 endem = re_End.match(lines[i])
411 # We want to scan for ams-type includes and, if we find them,
412 # add corresponding UseModule tags to the layout.
413 match = re_AMSMaths.match(lines[i])
415 addstring("theorems-ams", usemodules)
416 addstring("theorems-ams-extended", usemodules)
417 addstring("theorems-sec", usemodules)
420 match = re_AMSMathsPlain.match(lines[i])
422 addstring("theorems-starred", usemodules)
425 match = re_AMSMathsSeq.match(lines[i])
427 addstring("theorems-ams", usemodules)
428 addstring("theorems-ams-extended", usemodules)
434 # These just involved new features, not any changes to old ones
435 if format >= 5 and format <= 7:
440 # Handle conversion to long CharStyle names
441 match = re_CharStyle.match(lines[i])
443 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
445 lines.insert(i, "\tLyXType charstyle")
448 lines[i] = "\tLabelString %s" % (match.group(3))
453 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
454 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
456 match = re_Provides.match(lines[i])
458 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
459 match.group(3), match.group(4))
466 # delete caption styles
467 match = re_Style.match(lines[i])
469 style = string.lower(match.group(4))
470 if style == "caption":
472 while i < len(lines) and not re_End.match(lines[i]):
473 caption.append(lines[i])
476 error('Incomplete caption style.')
481 # delete undefinition of caption styles
482 match = re_NoStyle.match(lines[i])
484 style = string.lower(match.group(4))
485 if style == "caption":
489 # replace the CopyStyle statement with the definition of the real
490 # style. This may result in duplicate statements, but that is OK
491 # since the second one will overwrite the first one.
492 match = re_CopyStyle.match(lines[i])
494 style = string.lower(match.group(4))
495 if style == "caption":
497 lines[i:i+1] = caption
499 # FIXME: This style comes from an include file, we
500 # should replace the real style and not this default.
501 lines[i:i+1] = [' Margin First_Dynamic',
502 ' LatexType Command',
503 ' LatexName caption',
509 ' AlignPossible Center',
510 ' LabelType Sensitive',
511 ' LabelString "Senseless!"',
520 # Delete MaxCounter and remember the value of it
521 match = re_MaxCounter.match(lines[i])
523 level = match.group(4)
524 if string.lower(level) == "counter_chapter":
526 elif string.lower(level) == "counter_section":
528 elif string.lower(level) == "counter_subsection":
530 elif string.lower(level) == "counter_subsubsection":
532 elif string.lower(level) == "counter_paragraph":
534 elif string.lower(level) == "counter_subparagraph":
536 elif string.lower(level) == "counter_enumi":
538 elif string.lower(level) == "counter_enumii":
540 elif string.lower(level) == "counter_enumiii":
547 # LabelType Counter_EnumI
554 match = re_LabelType.match(lines[i])
556 label = match.group(4)
557 # Remember indenting space for later reuse in added lines
558 space1 = match.group(1)
559 # Remember the line for adding the LabelCounter later.
560 # We can't do it here because it could shift latextype_line etc.
562 if string.lower(label[:8]) == "counter_":
563 counter = string.lower(label[8:])
564 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
566 # Remember the LabelString line
567 match = re_LabelString.match(lines[i])
569 labelstring = match.group(4)
572 # Remember the LabelStringAppendix line
573 match = re_LabelStringAppendix.match(lines[i])
575 labelstringappendix = match.group(4)
576 labelstringappendix_line = i
578 # Remember the LatexType line
579 match = re_LatexType.match(lines[i])
581 latextype = string.lower(match.group(4))
584 # Remember the TocLevel line
585 match = re_TocLevel.match(lines[i])
587 toclevel = string.lower(match.group(4))
589 # Reset variables at the beginning of a style definition
590 match = re_Style.match(lines[i])
592 style = string.lower(match.group(4))
598 labelstringappendix = ""
599 labelstring_line = -1
600 labelstringappendix_line = -1
605 if re_End.match(lines[i]):
607 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
608 # (or change the existing LatexType)
609 if string.lower(label) == "bibliography":
610 if (latextype_line < 0):
611 lines.insert(i, "%sLatexType Bib_Environment" % space1)
614 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
616 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
617 if latextype == "item_environment" and string.lower(label) == "static":
618 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
620 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
621 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
622 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
623 # Don't add the LabelCounter line later
628 # LabelString "Chapter"
632 # LabelString "Chapter \arabic{chapter}"
634 # if this style has a counter. Ditto for LabelStringAppendix.
635 # This emulates the hardcoded article style numbering of 1.3
638 if counters.has_key(style):
639 if labelstring_line < 0:
640 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
643 new_labelstring = concatenate_label(labelstring, counters[style])
644 lines[labelstring_line] = re_LabelString.sub(
645 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
646 lines[labelstring_line])
647 if appendixcounters.has_key(style):
648 if labelstringappendix_line < 0:
649 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
652 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
653 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
654 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
655 lines[labelstringappendix_line])
657 # Now we can safely add the LabelCounter line
658 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
661 # Add the TocLevel setting for sectioning styles
662 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
663 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
670 for mod in usemodules:
671 lines.insert(i, "UseModule " + mod)
684 source = open(argv[1], 'rb')
685 output = open(argv[2], 'wb')
687 error(usage(argv[0]))
692 while (format < currentFormat):
693 format = convert(lines)
704 if __name__ == "__main__":