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 format 6
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
46 return ("Usage: %s inputfile outputfile\n" % prog_name +
47 "or %s <inputfile >outputfile" % prog_name)
51 sys.stderr.write(message + '\n')
56 " Remove end of line char(s)."
57 if line[-2:-1] == '\r':
59 elif line[-1:] == '\r' or line[-1:] == '\n':
62 # file with no EOL in last line
67 " Read input file and strip lineendings."
70 line = input.readline()
73 lines.append(trim_eol(line))
77 def write(output, lines):
78 " Write output file with native lineendings."
80 output.write(line + os.linesep)
83 # Concatenates old and new in an intelligent way:
84 # If old is wrapped in ", they are stripped. The result is wrapped in ".
85 def concatenate_label(old, new):
86 # Don't use strip as long as we support python 1.5.2
88 return old[0:-1] + new + '"'
90 return '"' + old + new + '"'
92 # appends a string to a list unless it's already there
100 " Convert to new format."
101 re_Comment = re.compile(r'^(\s*)#')
102 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
103 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
104 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
105 re_Empty = re.compile(r'^(\s*)$')
106 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
107 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
108 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
109 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
110 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
111 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
112 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
113 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
114 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
115 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
116 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
117 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
118 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
119 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
120 re_AMSMaths = re.compile(r'^\s*Input amsmaths.inc\s*')
121 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
122 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
124 # counters for sectioning styles (hardcoded in 1.3)
125 counters = {"part" : "\\Roman{part}",
126 "chapter" : "\\arabic{chapter}",
127 "section" : "\\arabic{section}",
128 "subsection" : "\\arabic{section}.\\arabic{subsection}",
129 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
130 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
131 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
133 # counters for sectioning styles in appendix (hardcoded in 1.3)
134 appendixcounters = {"chapter" : "\\Alph{chapter}",
135 "section" : "\\Alph{section}",
136 "subsection" : "\\arabic{section}.\\arabic{subsection}",
137 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
138 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
139 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
141 # Value of TocLevel for sectioning styles
142 toclevels = {"part" : 0,
155 labelstringappendix = ""
157 labelstring_line = -1
158 labelstringappendix_line = -1
168 while i < len(lines):
169 # Skip comments and empty lines
170 if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
174 # insert file format if not already there
176 match = re_Format.match(lines[i])
179 format = int(match.group(4))
180 if format > 1 and format < currentFormat:
181 lines[i] = "Format %d" % (format + 1)
183 elif format == currentFormat:
187 error('Cannot convert file format %s' % format)
189 lines.insert(i, "Format 2")
193 # Don't get confused by LaTeX code
194 if re_Preamble.match(lines[i]):
196 while i < len(lines) and not re_EndPreamble.match(lines[i]):
201 match = re_UseMod.match(lines[i])
203 module = match.group(1)
204 lines[i] = "DefaultModule " + module
209 match = re_Counter.match(lines[i])
213 while i < len(lines):
214 namem = re_Name.match(lines[i])
216 name = namem.group(1)
218 lines[counterline] = "Counter %s" % name
219 # we don't need to increment i
221 endem = re_End.match(lines[i])
230 # We want to scan for ams-type includes and, if we find them,
231 # add corresponding UseModule tags to the layout.
232 match = re_AMSMaths.match(lines[i])
234 addstring("theorems-ams", usemodules)
235 addstring("theorems-ams-extended", usemodules)
236 addstring("theorems-sec", usemodules)
239 match = re_AMSMathsPlain.match(lines[i])
241 addstring("theorems-starred", usemodules)
244 match = re_AMSMathsSeq.match(lines[i])
246 addstring("theorems-ams", usemodules)
247 addstring("theorems-ams-extended", usemodules)
253 # These just involved new features, not any changes to old ones
254 if format >= 5 and format <= 7:
259 # Handle conversion to long CharStyle names
260 match = re_CharStyle.match(lines[i])
262 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
264 lines.insert(i, "\tLyXType charstyle")
267 lines[i] = "\tLabelString %s" % (match.group(3))
272 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
273 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
275 match = re_Provides.match(lines[i])
277 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
278 match.group(3), match.group(4))
285 # delete caption styles
286 match = re_Style.match(lines[i])
288 style = string.lower(match.group(4))
289 if style == "caption":
291 while i < len(lines) and not re_End.match(lines[i]):
292 caption.append(lines[i])
295 error('Incomplete caption style.')
300 # delete undefinition of caption styles
301 match = re_NoStyle.match(lines[i])
303 style = string.lower(match.group(4))
304 if style == "caption":
308 # replace the CopyStyle statement with the definition of the real
309 # style. This may result in duplicate statements, but that is OK
310 # since the second one will overwrite the first one.
311 match = re_CopyStyle.match(lines[i])
313 style = string.lower(match.group(4))
314 if style == "caption":
316 lines[i:i+1] = caption
318 # FIXME: This style comes from an include file, we
319 # should replace the real style and not this default.
320 lines[i:i+1] = [' Margin First_Dynamic',
321 ' LatexType Command',
322 ' LatexName caption',
328 ' AlignPossible Center',
329 ' LabelType Sensitive',
330 ' LabelString "Senseless!"',
339 # Delete MaxCounter and remember the value of it
340 match = re_MaxCounter.match(lines[i])
342 level = match.group(4)
343 if string.lower(level) == "counter_chapter":
345 elif string.lower(level) == "counter_section":
347 elif string.lower(level) == "counter_subsection":
349 elif string.lower(level) == "counter_subsubsection":
351 elif string.lower(level) == "counter_paragraph":
353 elif string.lower(level) == "counter_subparagraph":
355 elif string.lower(level) == "counter_enumi":
357 elif string.lower(level) == "counter_enumii":
359 elif string.lower(level) == "counter_enumiii":
366 # LabelType Counter_EnumI
373 match = re_LabelType.match(lines[i])
375 label = match.group(4)
376 # Remember indenting space for later reuse in added lines
377 space1 = match.group(1)
378 # Remember the line for adding the LabelCounter later.
379 # We can't do it here because it could shift latextype_line etc.
381 if string.lower(label[:8]) == "counter_":
382 counter = string.lower(label[8:])
383 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
385 # Remember the LabelString line
386 match = re_LabelString.match(lines[i])
388 labelstring = match.group(4)
391 # Remember the LabelStringAppendix line
392 match = re_LabelStringAppendix.match(lines[i])
394 labelstringappendix = match.group(4)
395 labelstringappendix_line = i
397 # Remember the LatexType line
398 match = re_LatexType.match(lines[i])
400 latextype = string.lower(match.group(4))
403 # Reset variables at the beginning of a style definition
404 match = re_Style.match(lines[i])
406 style = string.lower(match.group(4))
411 labelstringappendix = ""
412 labelstring_line = -1
413 labelstringappendix_line = -1
418 if re_End.match(lines[i]):
420 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
421 # (or change the existing LatexType)
422 if string.lower(label) == "bibliography":
423 if (latextype_line < 0):
424 lines.insert(i, "%sLatexType Bib_Environment" % space1)
427 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
429 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
430 if latextype == "item_environment" and string.lower(label) == "static":
431 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
433 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
434 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
435 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
436 # Don't add the LabelCounter line later
441 # LabelString "Chapter"
445 # LabelString "Chapter \arabic{chapter}"
447 # if this style has a counter. Ditto for LabelStringAppendix.
448 # This emulates the hardcoded article style numbering of 1.3
451 if counters.has_key(style):
452 if labelstring_line < 0:
453 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
456 new_labelstring = concatenate_label(labelstring, counters[style])
457 lines[labelstring_line] = re_LabelString.sub(
458 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
459 lines[labelstring_line])
460 if appendixcounters.has_key(style):
461 if labelstringappendix_line < 0:
462 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
465 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
466 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
467 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
468 lines[labelstringappendix_line])
470 # Now we can safely add the LabelCounter line
471 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
474 # Add the TocLevel setting for sectioning styles
475 if toclevels.has_key(style) and maxcounter <= toclevels[style]:
476 lines.insert(i, '%sTocLevel %d' % (space1, toclevels[style]))
483 for mod in usemodules:
484 lines.insert(i, "UseModule " + mod)
497 input = open(argv[1], 'rb')
498 output = open(argv[2], 'wb')
500 error(usage(argv[0]))
505 while (format < currentFormat):
506 format = convert(lines)
517 if __name__ == "__main__":