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 tag.
81 # Do not forget to document format change in Customization
82 # Manual (section "Declaring a new text class").
84 # You might also want to consider running the
85 # development/tools/updatelayouts.sh script to update all
86 # layout files to the new format.
92 return ("Usage: %s inputfile outputfile\n" % prog_name +
93 "or %s <inputfile >outputfile" % prog_name)
97 sys.stderr.write(message + '\n')
102 " Remove byte order mark."
103 if line[0:3] == "\357\273\277":
110 " Read input file and strip lineendings."
111 lines = source.read().splitlines()
112 lines[0] = trim_bom(lines[0])
116 def write(output, lines):
117 " Write output file with native lineendings."
118 output.write(os.linesep.join(lines) + os.linesep)
121 # Concatenates old and new in an intelligent way:
122 # If old is wrapped in ", they are stripped. The result is wrapped in ".
123 def concatenate_label(old, new):
124 # Don't use strip as long as we support python 1.5.2
126 return old[0:-1] + new + '"'
128 return '"' + old + new + '"'
130 # appends a string to a list unless it's already there
138 " Convert to new format."
139 re_Comment = re.compile(r'^(\s*)#')
140 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
141 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
142 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
143 re_Empty = re.compile(r'^(\s*)$')
144 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
145 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
146 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
147 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
148 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
149 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
150 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
151 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
152 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
153 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
154 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
155 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
156 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
157 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
158 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
159 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
160 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
161 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
162 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
163 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
164 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
165 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
166 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
167 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
169 # counters for sectioning styles (hardcoded in 1.3)
170 counters = {"part" : "\\Roman{part}",
171 "chapter" : "\\arabic{chapter}",
172 "section" : "\\arabic{section}",
173 "subsection" : "\\arabic{section}.\\arabic{subsection}",
174 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
175 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
176 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
178 # counters for sectioning styles in appendix (hardcoded in 1.3)
179 appendixcounters = {"chapter" : "\\Alph{chapter}",
180 "section" : "\\Alph{section}",
181 "subsection" : "\\arabic{section}.\\arabic{subsection}",
182 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
183 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
184 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
186 # Value of TocLevel for sectioning styles
187 toclevels = {"part" : 0,
201 labelstringappendix = ""
203 labelstring_line = -1
204 labelstringappendix_line = -1
214 while i < len(lines):
215 # Skip comments and empty lines
216 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
220 # insert file format if not already there
222 match = re_Format.match(lines[i])
225 format = int(match.group(4))
226 if format > 1 and format < currentFormat:
227 lines[i] = "Format %d" % (format + 1)
229 elif format == currentFormat:
233 error('Cannot convert file format %s' % format)
235 lines.insert(i, "Format 2")
239 # Don't get confused by LaTeX code
240 if re_Preamble.match(lines[i]):
242 while i < len(lines) and not re_EndPreamble.match(lines[i]):
245 if re_LangPreamble.match(lines[i]):
247 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
250 if re_BabelPreamble.match(lines[i]):
252 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
256 # This just involved new features, not any changes to old ones
257 if format >= 14 and format <= 20:
261 # Rename I18NPreamble to BabelPreamble
263 match = re_I18nPreamble.match(lines[i])
265 lines[i] = match.group(1) + "BabelPreamble"
267 match = re_EndI18nPreamble.match(lines[i])
268 while i < len(lines) and not match:
270 match = re_EndI18nPreamble.match(lines[i])
271 lines[i] = match.group(1) + "EndBabelPreamble"
275 # These just involved new features, not any changes to old ones
276 if format == 11 or format == 12:
281 match = re_UseMod.match(lines[i])
283 module = match.group(1)
284 lines[i] = "DefaultModule " + module
289 match = re_Counter.match(lines[i])
293 while i < len(lines):
294 namem = re_Name.match(lines[i])
296 name = namem.group(1)
298 lines[counterline] = "Counter %s" % name
299 # we don't need to increment i
301 endem = re_End.match(lines[i])
310 # We want to scan for ams-type includes and, if we find them,
311 # add corresponding UseModule tags to the layout.
312 match = re_AMSMaths.match(lines[i])
314 addstring("theorems-ams", usemodules)
315 addstring("theorems-ams-extended", usemodules)
316 addstring("theorems-sec", usemodules)
319 match = re_AMSMathsPlain.match(lines[i])
321 addstring("theorems-starred", usemodules)
324 match = re_AMSMathsSeq.match(lines[i])
326 addstring("theorems-ams", usemodules)
327 addstring("theorems-ams-extended", usemodules)
333 # These just involved new features, not any changes to old ones
334 if format >= 5 and format <= 7:
339 # Handle conversion to long CharStyle names
340 match = re_CharStyle.match(lines[i])
342 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
344 lines.insert(i, "\tLyXType charstyle")
347 lines[i] = "\tLabelString %s" % (match.group(3))
352 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
353 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
355 match = re_Provides.match(lines[i])
357 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
358 match.group(3), match.group(4))
365 # delete caption styles
366 match = re_Style.match(lines[i])
368 style = string.lower(match.group(4))
369 if style == "caption":
371 while i < len(lines) and not re_End.match(lines[i]):
372 caption.append(lines[i])
375 error('Incomplete caption style.')
380 # delete undefinition of caption styles
381 match = re_NoStyle.match(lines[i])
383 style = string.lower(match.group(4))
384 if style == "caption":
388 # replace the CopyStyle statement with the definition of the real
389 # style. This may result in duplicate statements, but that is OK
390 # since the second one will overwrite the first one.
391 match = re_CopyStyle.match(lines[i])
393 style = string.lower(match.group(4))
394 if style == "caption":
396 lines[i:i+1] = caption
398 # FIXME: This style comes from an include file, we
399 # should replace the real style and not this default.
400 lines[i:i+1] = [' Margin First_Dynamic',
401 ' LatexType Command',
402 ' LatexName caption',
408 ' AlignPossible Center',
409 ' LabelType Sensitive',
410 ' LabelString "Senseless!"',
419 # Delete MaxCounter and remember the value of it
420 match = re_MaxCounter.match(lines[i])
422 level = match.group(4)
423 if string.lower(level) == "counter_chapter":
425 elif string.lower(level) == "counter_section":
427 elif string.lower(level) == "counter_subsection":
429 elif string.lower(level) == "counter_subsubsection":
431 elif string.lower(level) == "counter_paragraph":
433 elif string.lower(level) == "counter_subparagraph":
435 elif string.lower(level) == "counter_enumi":
437 elif string.lower(level) == "counter_enumii":
439 elif string.lower(level) == "counter_enumiii":
446 # LabelType Counter_EnumI
453 match = re_LabelType.match(lines[i])
455 label = match.group(4)
456 # Remember indenting space for later reuse in added lines
457 space1 = match.group(1)
458 # Remember the line for adding the LabelCounter later.
459 # We can't do it here because it could shift latextype_line etc.
461 if string.lower(label[:8]) == "counter_":
462 counter = string.lower(label[8:])
463 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
465 # Remember the LabelString line
466 match = re_LabelString.match(lines[i])
468 labelstring = match.group(4)
471 # Remember the LabelStringAppendix line
472 match = re_LabelStringAppendix.match(lines[i])
474 labelstringappendix = match.group(4)
475 labelstringappendix_line = i
477 # Remember the LatexType line
478 match = re_LatexType.match(lines[i])
480 latextype = string.lower(match.group(4))
483 # Remember the TocLevel line
484 match = re_TocLevel.match(lines[i])
486 toclevel = string.lower(match.group(4))
488 # Reset variables at the beginning of a style definition
489 match = re_Style.match(lines[i])
491 style = string.lower(match.group(4))
497 labelstringappendix = ""
498 labelstring_line = -1
499 labelstringappendix_line = -1
504 if re_End.match(lines[i]):
506 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
507 # (or change the existing LatexType)
508 if string.lower(label) == "bibliography":
509 if (latextype_line < 0):
510 lines.insert(i, "%sLatexType Bib_Environment" % space1)
513 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
515 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
516 if latextype == "item_environment" and string.lower(label) == "static":
517 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
519 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
520 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
521 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
522 # Don't add the LabelCounter line later
527 # LabelString "Chapter"
531 # LabelString "Chapter \arabic{chapter}"
533 # if this style has a counter. Ditto for LabelStringAppendix.
534 # This emulates the hardcoded article style numbering of 1.3
537 if counters.has_key(style):
538 if labelstring_line < 0:
539 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
542 new_labelstring = concatenate_label(labelstring, counters[style])
543 lines[labelstring_line] = re_LabelString.sub(
544 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
545 lines[labelstring_line])
546 if appendixcounters.has_key(style):
547 if labelstringappendix_line < 0:
548 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
551 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
552 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
553 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
554 lines[labelstringappendix_line])
556 # Now we can safely add the LabelCounter line
557 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
560 # Add the TocLevel setting for sectioning styles
561 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
562 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
569 for mod in usemodules:
570 lines.insert(i, "UseModule " + mod)
583 source = open(argv[1], 'rb')
584 output = open(argv[2], 'wb')
586 error(usage(argv[0]))
591 while (format < currentFormat):
592 format = convert(lines)
603 if __name__ == "__main__":