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
65 # These are still to be documented, once everything stabilizes.
67 # Incremented to format 17, 12 August 2009 by rgh
68 # Add IfStyle and IfCounter tags for layout.
70 # Incremented to format 18, 27 October 2009 by rgh
71 # Added some new tags for HTML output. Documentation still to follow.
73 # Do not forget to document format change in Customization
74 # Manual (section "Declaring a new text class").
80 return ("Usage: %s inputfile outputfile\n" % prog_name +
81 "or %s <inputfile >outputfile" % prog_name)
85 sys.stderr.write(message + '\n')
90 " Remove byte order mark."
91 if line[0:3] == "\357\273\277":
98 " Read input file and strip lineendings."
99 lines = source.read().splitlines()
100 lines[0] = trim_bom(lines[0])
104 def write(output, lines):
105 " Write output file with native lineendings."
106 output.write(os.linesep.join(lines) + os.linesep)
109 # Concatenates old and new in an intelligent way:
110 # If old is wrapped in ", they are stripped. The result is wrapped in ".
111 def concatenate_label(old, new):
112 # Don't use strip as long as we support python 1.5.2
114 return old[0:-1] + new + '"'
116 return '"' + old + new + '"'
118 # appends a string to a list unless it's already there
126 " Convert to new format."
127 re_Comment = re.compile(r'^(\s*)#')
128 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
129 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
130 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
131 re_Empty = re.compile(r'^(\s*)$')
132 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
133 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
134 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
135 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
136 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
137 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
138 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
139 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
140 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
141 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
142 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
143 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
144 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
145 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
146 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
147 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
148 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
149 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
150 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
151 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
152 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
153 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
154 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
155 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
157 # counters for sectioning styles (hardcoded in 1.3)
158 counters = {"part" : "\\Roman{part}",
159 "chapter" : "\\arabic{chapter}",
160 "section" : "\\arabic{section}",
161 "subsection" : "\\arabic{section}.\\arabic{subsection}",
162 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
163 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
164 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
166 # counters for sectioning styles in appendix (hardcoded in 1.3)
167 appendixcounters = {"chapter" : "\\Alph{chapter}",
168 "section" : "\\Alph{section}",
169 "subsection" : "\\arabic{section}.\\arabic{subsection}",
170 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
171 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
172 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
174 # Value of TocLevel for sectioning styles
175 toclevels = {"part" : 0,
189 labelstringappendix = ""
191 labelstring_line = -1
192 labelstringappendix_line = -1
202 while i < len(lines):
203 # Skip comments and empty lines
204 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
208 # insert file format if not already there
210 match = re_Format.match(lines[i])
213 format = int(match.group(4))
214 if format > 1 and format < currentFormat:
215 lines[i] = "Format %d" % (format + 1)
217 elif format == currentFormat:
221 error('Cannot convert file format %s' % format)
223 lines.insert(i, "Format 2")
227 # Don't get confused by LaTeX code
228 if re_Preamble.match(lines[i]):
230 while i < len(lines) and not re_EndPreamble.match(lines[i]):
233 if re_LangPreamble.match(lines[i]):
235 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
238 if re_BabelPreamble.match(lines[i]):
240 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
244 # This just involved new features, not any changes to old ones
245 if format == 14 or format == 15 or format == 16 or format == 17:
249 # Rename I18NPreamble to BabelPreamble
251 match = re_I18nPreamble.match(lines[i])
253 lines[i] = match.group(1) + "BabelPreamble"
255 match = re_EndI18nPreamble.match(lines[i])
256 while i < len(lines) and not match:
258 match = re_EndI18nPreamble.match(lines[i])
259 lines[i] = match.group(1) + "EndBabelPreamble"
263 # These just involved new features, not any changes to old ones
264 if format == 11 or format == 12:
269 match = re_UseMod.match(lines[i])
271 module = match.group(1)
272 lines[i] = "DefaultModule " + module
277 match = re_Counter.match(lines[i])
281 while i < len(lines):
282 namem = re_Name.match(lines[i])
284 name = namem.group(1)
286 lines[counterline] = "Counter %s" % name
287 # we don't need to increment i
289 endem = re_End.match(lines[i])
298 # We want to scan for ams-type includes and, if we find them,
299 # add corresponding UseModule tags to the layout.
300 match = re_AMSMaths.match(lines[i])
302 addstring("theorems-ams", usemodules)
303 addstring("theorems-ams-extended", usemodules)
304 addstring("theorems-sec", usemodules)
307 match = re_AMSMathsPlain.match(lines[i])
309 addstring("theorems-starred", usemodules)
312 match = re_AMSMathsSeq.match(lines[i])
314 addstring("theorems-ams", usemodules)
315 addstring("theorems-ams-extended", usemodules)
321 # These just involved new features, not any changes to old ones
322 if format >= 5 and format <= 7:
327 # Handle conversion to long CharStyle names
328 match = re_CharStyle.match(lines[i])
330 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
332 lines.insert(i, "\tLyXType charstyle")
335 lines[i] = "\tLabelString %s" % (match.group(3))
340 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
341 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
343 match = re_Provides.match(lines[i])
345 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
346 match.group(3), match.group(4))
353 # delete caption styles
354 match = re_Style.match(lines[i])
356 style = string.lower(match.group(4))
357 if style == "caption":
359 while i < len(lines) and not re_End.match(lines[i]):
360 caption.append(lines[i])
363 error('Incomplete caption style.')
368 # delete undefinition of caption styles
369 match = re_NoStyle.match(lines[i])
371 style = string.lower(match.group(4))
372 if style == "caption":
376 # replace the CopyStyle statement with the definition of the real
377 # style. This may result in duplicate statements, but that is OK
378 # since the second one will overwrite the first one.
379 match = re_CopyStyle.match(lines[i])
381 style = string.lower(match.group(4))
382 if style == "caption":
384 lines[i:i+1] = caption
386 # FIXME: This style comes from an include file, we
387 # should replace the real style and not this default.
388 lines[i:i+1] = [' Margin First_Dynamic',
389 ' LatexType Command',
390 ' LatexName caption',
396 ' AlignPossible Center',
397 ' LabelType Sensitive',
398 ' LabelString "Senseless!"',
407 # Delete MaxCounter and remember the value of it
408 match = re_MaxCounter.match(lines[i])
410 level = match.group(4)
411 if string.lower(level) == "counter_chapter":
413 elif string.lower(level) == "counter_section":
415 elif string.lower(level) == "counter_subsection":
417 elif string.lower(level) == "counter_subsubsection":
419 elif string.lower(level) == "counter_paragraph":
421 elif string.lower(level) == "counter_subparagraph":
423 elif string.lower(level) == "counter_enumi":
425 elif string.lower(level) == "counter_enumii":
427 elif string.lower(level) == "counter_enumiii":
434 # LabelType Counter_EnumI
441 match = re_LabelType.match(lines[i])
443 label = match.group(4)
444 # Remember indenting space for later reuse in added lines
445 space1 = match.group(1)
446 # Remember the line for adding the LabelCounter later.
447 # We can't do it here because it could shift latextype_line etc.
449 if string.lower(label[:8]) == "counter_":
450 counter = string.lower(label[8:])
451 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
453 # Remember the LabelString line
454 match = re_LabelString.match(lines[i])
456 labelstring = match.group(4)
459 # Remember the LabelStringAppendix line
460 match = re_LabelStringAppendix.match(lines[i])
462 labelstringappendix = match.group(4)
463 labelstringappendix_line = i
465 # Remember the LatexType line
466 match = re_LatexType.match(lines[i])
468 latextype = string.lower(match.group(4))
471 # Remember the TocLevel line
472 match = re_TocLevel.match(lines[i])
474 toclevel = string.lower(match.group(4))
476 # Reset variables at the beginning of a style definition
477 match = re_Style.match(lines[i])
479 style = string.lower(match.group(4))
485 labelstringappendix = ""
486 labelstring_line = -1
487 labelstringappendix_line = -1
492 if re_End.match(lines[i]):
494 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
495 # (or change the existing LatexType)
496 if string.lower(label) == "bibliography":
497 if (latextype_line < 0):
498 lines.insert(i, "%sLatexType Bib_Environment" % space1)
501 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
503 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
504 if latextype == "item_environment" and string.lower(label) == "static":
505 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
507 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
508 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
509 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
510 # Don't add the LabelCounter line later
515 # LabelString "Chapter"
519 # LabelString "Chapter \arabic{chapter}"
521 # if this style has a counter. Ditto for LabelStringAppendix.
522 # This emulates the hardcoded article style numbering of 1.3
525 if counters.has_key(style):
526 if labelstring_line < 0:
527 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
530 new_labelstring = concatenate_label(labelstring, counters[style])
531 lines[labelstring_line] = re_LabelString.sub(
532 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
533 lines[labelstring_line])
534 if appendixcounters.has_key(style):
535 if labelstringappendix_line < 0:
536 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
539 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
540 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
541 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
542 lines[labelstringappendix_line])
544 # Now we can safely add the LabelCounter line
545 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
548 # Add the TocLevel setting for sectioning styles
549 if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
550 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
557 for mod in usemodules:
558 lines.insert(i, "UseModule " + mod)
571 source = open(argv[1], 'rb')
572 output = open(argv[2], 'wb')
574 error(usage(argv[0]))
579 while (format < currentFormat):
580 format = convert(lines)
591 if __name__ == "__main__":