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 # Do not forget to document format change in Customization
101 # Manual (section "Declaring a new text class").
103 # You might also want to consider running the
104 # development/tools/updatelayouts.sh script to update all
105 # layout files to the new format.
110 def usage(prog_name):
111 return ("Usage: %s inputfile outputfile\n" % prog_name +
112 "or %s <inputfile >outputfile" % prog_name)
116 sys.stderr.write(message + '\n')
121 " Remove byte order mark."
122 if line[0:3] == "\357\273\277":
129 " Read input file and strip lineendings."
130 lines = source.read().splitlines()
131 lines[0] = trim_bom(lines[0])
135 def write(output, lines):
136 " Write output file with native lineendings."
137 output.write(os.linesep.join(lines) + os.linesep)
140 # Concatenates old and new in an intelligent way:
141 # If old is wrapped in ", they are stripped. The result is wrapped in ".
142 def concatenate_label(old, new):
143 # Don't use strip as long as we support python 1.5.2
145 return old[0:-1] + new + '"'
147 return '"' + old + new + '"'
149 # appends a string to a list unless it's already there
157 " Convert to new format."
158 re_Comment = re.compile(r'^(\s*)#')
159 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
160 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
161 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
162 re_Empty = re.compile(r'^(\s*)$')
163 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
164 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
165 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
166 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
167 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
168 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
169 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
170 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
171 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
172 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
173 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
174 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
175 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
176 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
177 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
178 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
179 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
180 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
181 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
182 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
183 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
184 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
185 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
186 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
187 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
188 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
189 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
190 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
192 # counters for sectioning styles (hardcoded in 1.3)
193 counters = {"part" : "\\Roman{part}",
194 "chapter" : "\\arabic{chapter}",
195 "section" : "\\arabic{section}",
196 "subsection" : "\\arabic{section}.\\arabic{subsection}",
197 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
198 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
199 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
201 # counters for sectioning styles in appendix (hardcoded in 1.3)
202 appendixcounters = {"chapter" : "\\Alph{chapter}",
203 "section" : "\\Alph{section}",
204 "subsection" : "\\arabic{section}.\\arabic{subsection}",
205 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
206 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
207 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
209 # Value of TocLevel for sectioning styles
210 toclevels = {"part" : 0,
224 labelstringappendix = ""
226 labelstring_line = -1
227 labelstringappendix_line = -1
237 while i < len(lines):
238 # Skip comments and empty lines
239 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
243 # insert file format if not already there
245 match = re_Format.match(lines[i])
248 format = int(match.group(4))
249 if format > 1 and format < currentFormat:
250 lines[i] = "Format %d" % (format + 1)
252 elif format == currentFormat:
256 error('Cannot convert file format %s' % format)
258 lines.insert(i, "Format 2")
262 # Don't get confused by LaTeX code
263 if re_Preamble.match(lines[i]):
265 while i < len(lines) and not re_EndPreamble.match(lines[i]):
268 if re_LangPreamble.match(lines[i]):
270 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
273 if re_BabelPreamble.match(lines[i]):
275 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
280 if format >= 24 and format <= 26:
285 match = re_Float.match(lines[i])
289 # we need to do two things:
290 # (i) Convert Builtin to NeedsFloatPkg
291 # (ii) Write ListCommand lines for the builtin floats table and figure
294 while True and i < len(lines):
295 m1 = re_End.match(lines[i])
298 line = " ListCommand " + cmd
299 lines.insert(i, line)
302 m2 = re_Builtin.match(lines[i])
308 if re_True.match(arg):
312 lines[i] = ws1 + "NeedsFloatPkg " + newarg
313 m3 = re_Type.match(lines[i])
316 fltype = fltype.lower()
317 if fltype == "table":
319 elif fltype == "figure":
320 cmd = "listoffigures"
321 # else unknown, which is why we're doing this
325 # This just involved new features, not any changes to old ones
326 if format >= 14 and format <= 22:
330 # Rename I18NPreamble to BabelPreamble
332 match = re_I18nPreamble.match(lines[i])
334 lines[i] = match.group(1) + "BabelPreamble"
336 match = re_EndI18nPreamble.match(lines[i])
337 while i < len(lines) and not match:
339 match = re_EndI18nPreamble.match(lines[i])
340 lines[i] = match.group(1) + "EndBabelPreamble"
344 # These just involved new features, not any changes to old ones
345 if format == 11 or format == 12:
350 match = re_UseMod.match(lines[i])
352 module = match.group(1)
353 lines[i] = "DefaultModule " + module
358 match = re_Counter.match(lines[i])
362 while i < len(lines):
363 namem = re_Name.match(lines[i])
365 name = namem.group(1)
367 lines[counterline] = "Counter %s" % name
368 # we don't need to increment i
370 endem = re_End.match(lines[i])
379 # We want to scan for ams-type includes and, if we find them,
380 # add corresponding UseModule tags to the layout.
381 match = re_AMSMaths.match(lines[i])
383 addstring("theorems-ams", usemodules)
384 addstring("theorems-ams-extended", usemodules)
385 addstring("theorems-sec", usemodules)
388 match = re_AMSMathsPlain.match(lines[i])
390 addstring("theorems-starred", usemodules)
393 match = re_AMSMathsSeq.match(lines[i])
395 addstring("theorems-ams", usemodules)
396 addstring("theorems-ams-extended", usemodules)
402 # These just involved new features, not any changes to old ones
403 if format >= 5 and format <= 7:
408 # Handle conversion to long CharStyle names
409 match = re_CharStyle.match(lines[i])
411 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
413 lines.insert(i, "\tLyXType charstyle")
416 lines[i] = "\tLabelString %s" % (match.group(3))
421 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
422 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
424 match = re_Provides.match(lines[i])
426 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
427 match.group(3), match.group(4))
434 # delete caption styles
435 match = re_Style.match(lines[i])
437 style = string.lower(match.group(4))
438 if style == "caption":
440 while i < len(lines) and not re_End.match(lines[i]):
441 caption.append(lines[i])
444 error('Incomplete caption style.')
449 # delete undefinition of caption styles
450 match = re_NoStyle.match(lines[i])
452 style = string.lower(match.group(4))
453 if style == "caption":
457 # replace the CopyStyle statement with the definition of the real
458 # style. This may result in duplicate statements, but that is OK
459 # since the second one will overwrite the first one.
460 match = re_CopyStyle.match(lines[i])
462 style = string.lower(match.group(4))
463 if style == "caption":
465 lines[i:i+1] = caption
467 # FIXME: This style comes from an include file, we
468 # should replace the real style and not this default.
469 lines[i:i+1] = [' Margin First_Dynamic',
470 ' LatexType Command',
471 ' LatexName caption',
477 ' AlignPossible Center',
478 ' LabelType Sensitive',
479 ' LabelString "Senseless!"',
488 # Delete MaxCounter and remember the value of it
489 match = re_MaxCounter.match(lines[i])
491 level = match.group(4)
492 if string.lower(level) == "counter_chapter":
494 elif string.lower(level) == "counter_section":
496 elif string.lower(level) == "counter_subsection":
498 elif string.lower(level) == "counter_subsubsection":
500 elif string.lower(level) == "counter_paragraph":
502 elif string.lower(level) == "counter_subparagraph":
504 elif string.lower(level) == "counter_enumi":
506 elif string.lower(level) == "counter_enumii":
508 elif string.lower(level) == "counter_enumiii":
515 # LabelType Counter_EnumI
522 match = re_LabelType.match(lines[i])
524 label = match.group(4)
525 # Remember indenting space for later reuse in added lines
526 space1 = match.group(1)
527 # Remember the line for adding the LabelCounter later.
528 # We can't do it here because it could shift latextype_line etc.
530 if string.lower(label[:8]) == "counter_":
531 counter = string.lower(label[8:])
532 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
534 # Remember the LabelString line
535 match = re_LabelString.match(lines[i])
537 labelstring = match.group(4)
540 # Remember the LabelStringAppendix line
541 match = re_LabelStringAppendix.match(lines[i])
543 labelstringappendix = match.group(4)
544 labelstringappendix_line = i
546 # Remember the LatexType line
547 match = re_LatexType.match(lines[i])
549 latextype = string.lower(match.group(4))
552 # Remember the TocLevel line
553 match = re_TocLevel.match(lines[i])
555 toclevel = string.lower(match.group(4))
557 # Reset variables at the beginning of a style definition
558 match = re_Style.match(lines[i])
560 style = string.lower(match.group(4))
566 labelstringappendix = ""
567 labelstring_line = -1
568 labelstringappendix_line = -1
573 if re_End.match(lines[i]):
575 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
576 # (or change the existing LatexType)
577 if string.lower(label) == "bibliography":
578 if (latextype_line < 0):
579 lines.insert(i, "%sLatexType Bib_Environment" % space1)
582 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
584 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
585 if latextype == "item_environment" and string.lower(label) == "static":
586 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
588 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
589 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
590 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
591 # Don't add the LabelCounter line later
596 # LabelString "Chapter"
600 # LabelString "Chapter \arabic{chapter}"
602 # if this style has a counter. Ditto for LabelStringAppendix.
603 # This emulates the hardcoded article style numbering of 1.3
606 if counters.has_key(style):
607 if labelstring_line < 0:
608 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
611 new_labelstring = concatenate_label(labelstring, counters[style])
612 lines[labelstring_line] = re_LabelString.sub(
613 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
614 lines[labelstring_line])
615 if appendixcounters.has_key(style):
616 if labelstringappendix_line < 0:
617 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
620 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
621 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
622 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
623 lines[labelstringappendix_line])
625 # Now we can safely add the LabelCounter line
626 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
629 # Add the TocLevel setting for sectioning styles
630 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
631 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
638 for mod in usemodules:
639 lines.insert(i, "UseModule " + mod)
652 source = open(argv[1], 'rb')
653 output = open(argv[2], 'wb')
655 error(usage(argv[0]))
660 while (format < currentFormat):
661 format = convert(lines)
672 if __name__ == "__main__":