1 # -*- coding: utf-8 -*-
3 # file layout2layout.py
4 # This file is part of LyX, the document processor.
5 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS
11 # This script will update a .layout file to current format
13 # The latest layout format is also defined in src/TextClass.cpp
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 # Incremented to format 32, 30 January 2011 by forenr
114 # Added Display tag for InsetLayout
116 # Incremented to format 33, 2 February 2011 by rgh
117 # Changed NeedsFloatPkg to UsesFloatPkg
119 # Incremented to format 34, 28 March 2011 by rgh
120 # Remove obsolete Fill_(Top|Bottom) tags
122 # Incremented to format 35, 28 March 2011 by rgh
123 # Try to add "Flex:" to any flex insets that don't have it.
125 # Incremented to format 36, 7 December 2011, by rgh
126 # Added HTMLStyles and AddToHTMLStyles tags.
128 # Incremented to format 37, 29 February 2012 by jrioux
129 # Implement the citation engine machinery in layouts.
130 # Change CiteFormat to CiteFormat (default|authoryear|numerical).
132 # Incremented to format 38, 08 April 2012 by gb
133 # Introduce LangPreamble and BabelPreamble for InsetLayout.
135 # Incremented to format 39, 15 April 2012 by sanda
136 # Introduce styling of branches via "InsetLayout Branch:".
138 # Incremented to format 40, 10 October 2012 by rgh
139 # Re-do layout names for layout categories
141 # Incremented to format 41, 20 November 2012 by spitz
142 # New Argument syntax
144 # Incremented to format 42, 22 December 2012 by spitz
145 # New Style tag "ItemCommand"
147 # Incremented to format 43, 30 December 2012 by spitz
148 # Extended InsetCaption format
150 # Incremented to format 44, 9 February 2013 by rgh
151 # Remove COUNTER label style; rename as STATIC
152 # Rename TOP_ENVIRONMENT to ABOVE and CENTERED_TOP_ENVIRONMENT to CENTERED
154 # Incremented to format 45, 12 February 2013 by rgh
155 # New Tag "NoInsetLayout"
157 # Incremented to format 46, 15 May 2013 by gb
158 # New Tag "ForceLocal"
160 # Incremented to format 47, 23 May 2013 by rgh
161 # Add PackageOptions tag
163 # Incremented to format 48, 31 May 2013 by rgh
164 # Add InitialValue tag for counters
166 # Incremented to format 49, 10 Feb 2014 by gb
167 # Change default of "ResetsFont" tag to false
169 # Incremented to format 50, 9 May 2014 by forenr
170 # Removal of "Separator" layouts
172 # Incremented to format 51, 29 May 2014 by spitz
173 # New Style tag "ToggleIndent"
175 # Incremented to format 52, 1 December 2014 by spitz
176 # New InsetLayout tag "ForceOwnlines"
178 # Incremented to format 53, 7 December 2014 by spitz
179 # New InsetLayout tag "ObsoletedBy"
181 # Incremented to format 54, 11 Jan 2014 by gb
182 # New InsetLayout tag "FixedWidthPreambleEncoding"
184 # Incremented to format 55, 20 April 2015 by spitz
185 # New InsetLayout and Layout tags "PassThruChars"
187 # Incremented to format 56, 20 May 2015 by spitz
188 # New Float tags "AllowedPlacement", "AllowsWide", "AllowsSideways"
190 # Incremented to format 57, 30 May 2015 by spitz
191 # New Layout tag "ParagraphGroup"
193 # Incremented to format 58, 5 December 2015, by rgh
194 # New Layout tag "ProvideStyle"
195 # Change "IfStyle" to "ModifyStyle"
197 # Incremented to format 59, 22 November 2015 by gm
198 # New Tag "OutlinerName"
199 # New Layout tags "AddToToc", "IsTocCaption"
200 # New Layout argument tag "IsTocCaption"
202 # Incremented to format 60, 25 March 2016 by lasgouttes
203 # Rename caption subtype LongTableNoNumber to Unnumbered
205 # Incremented to format 61, 14 October 2016 by spitz
206 # New Layout tags "ResumeCounter", "StepMasterCounter"
208 # Incremented to format 62, 21 October 2016 by spitz
209 # New Layout argument tag "PassThru"
211 # Do not forget to document format change in Customization
212 # Manual (section "Declaring a new text class").
214 # You might also want to consider running the
215 # development/tools/updatelayouts.py script to update all
216 # layout files to the new format.
219 import os, re, string, sys
222 # Provide support for both python 2 and 3
223 # (copied from lyx2lyx)
224 PY2 = sys.version_info[0] == 2
226 # argparse returns strings in the commandline encoding, we need to convert.
227 # sys.getdefaultencoding() would not always be correct, see
228 # http://legacy.python.org/dev/peps/pep-0383/
230 return arg.decode(sys.getfilesystemencoding())
233 # End of code to support for both python 2 and 3
237 sys.stderr.write(message + '\n')
242 " Remove byte order mark."
243 if line[0:3] == "\357\273\277":
250 " Read input file and strip lineendings."
251 lines = source.read().splitlines() or ['']
252 lines[0] = trim_bom(lines[0])
256 def write(output, lines):
257 " Write output file with native lineendings."
258 output.write(os.linesep.join(lines) + os.linesep)
261 # Concatenates old and new in an intelligent way:
262 # If old is wrapped in ", they are stripped. The result is wrapped in ".
263 def concatenate_label(old, new):
264 # Don't use strip as long as we support python 1.5.2
266 return old[0:-1] + new + '"'
268 return '"' + old + new + '"'
270 # appends a string to a list unless it's already there
277 def convert(lines, end_format):
278 " Convert to new format."
279 re_Comment = re.compile(r'^(\s*)#')
280 re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
281 re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
282 re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
283 re_Empty = re.compile(r'^(\s*)$')
284 re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
285 re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
286 re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
287 re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
288 re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
289 re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
290 re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
291 re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
292 re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
293 re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
294 re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
295 re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
296 re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
297 re_IfStyle = re.compile(r'^(\s*)IfStyle(\s+\S+)', re.IGNORECASE)
298 re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
299 re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
300 re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
301 re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
302 re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
303 re_CiteFormat = re.compile(r'^(\s*)(CiteFormat)(?:(\s*)()|(\s+)(default|authoryear|numerical))', re.IGNORECASE)
304 re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
305 re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
306 re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
307 re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
308 re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
309 re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
310 re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
311 re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
312 re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
313 re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
314 re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
315 re_ResetsFont = re.compile(r'^(\s*)ResetsFont(\s+)(\S+)$', re.IGNORECASE)
317 re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
318 re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
319 re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
320 re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
321 re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
322 re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
324 re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
325 re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
326 re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
327 re_Separator = re.compile(r'^(?:(-*)|(\s*))(Separator|EndOfSlide)(?:(-*)|(\s*))$', re.IGNORECASE)
329 re_Declaration = re.compile(r'^#\s*\\Declare\w+Class.*$')
330 re_ExtractCategory = re.compile(r'^(#\s*\\Declare\w+Class(?:\[[^]]*?\])?){([^(]+?)\s+\(([^)]+?)\)\s*}\s*$')
331 ConvDict = {"article": "Articles", "book" : "Books", "letter" : "Letters", "report": "Reports", \
332 "presentation" : "Presentations", "curriculum vitae" : "Curricula Vitae", "handout" : "Handouts"}
334 re_OptArgs = re.compile(r'^(\s*)OptionalArgs(\s+)(\d+)\D*$', re.IGNORECASE)
335 re_ReqArgs = re.compile(r'^(\s*)RequiredArgs(\s+)(\d+)\D*$', re.IGNORECASE)
337 # various changes associated with changing how chapters are handled
338 re_LabelTypeIsCounter = re.compile(r'^(\s*)LabelType(\s*)Counter\s*$', re.IGNORECASE)
339 re_TopEnvironment = re.compile(r'^(\s*)LabelType(\s+)Top_Environment\s*$', re.IGNORECASE)
340 re_CenteredEnvironment = re.compile(r'^(\s*)LabelType(\s+)Centered_Top_Environment\s*$', re.IGNORECASE)
341 re_ChapterStyle = re.compile(r'^\s*Style\s+Chapter\s*$', re.IGNORECASE)
342 re_InsetLayout_CaptionLTNN = re.compile(r'^(\s*InsetLayout\s+)(Caption:LongTableNonumber)', re.IGNORECASE)
345 # counters for sectioning styles (hardcoded in 1.3)
346 counters = {"part" : "\\Roman{part}",
347 "chapter" : "\\arabic{chapter}",
348 "section" : "\\arabic{section}",
349 "subsection" : "\\arabic{section}.\\arabic{subsection}",
350 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
351 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
352 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
354 # counters for sectioning styles in appendix (hardcoded in 1.3)
355 appendixcounters = {"chapter" : "\\Alph{chapter}",
356 "section" : "\\Alph{section}",
357 "subsection" : "\\arabic{section}.\\arabic{subsection}",
358 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
359 "paragraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
360 "subparagraph" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
362 # Value of TocLevel for sectioning styles
363 toclevels = {"part" : -1,
377 labelstringappendix = ""
379 labelstring_line = -1
380 labelstringappendix_line = -1
393 isflexlayout = False # only used for 48 -> 49
394 # Whether a style is inherited (works only for CopyStyle currently,
395 # not for true inherited styles, see bug 8920
396 inherited = False # only used for 48 -> 49
397 resetsfont_found = False # only used for 48 -> 49
399 while i < len(lines):
400 # Skip comments and empty lines
401 if (re_Comment.match(lines[i]) or re_Empty.match(lines[i])):
402 # We need to deal with this conversion here, because it happens
403 # inside the initial comment block.
404 if only_comment and format == 39:
405 match = re_ExtractCategory.match(lines[i])
407 lpre = match.group(1)
408 lcat = match.group(2)
409 lnam = match.group(3)
411 lcat = ConvDict[lcat]
412 lines[i] = lpre + "{" + lnam + "}"
413 lines.insert(i+1, "# \\DeclareCategory{" + lcat + "}")
418 # insert file format if not already there
420 match = re_Format.match(lines[i])
423 format = int(match.group(4))
424 if format > 1 and format < end_format:
425 lines[i] = "Format %d" % (format + 1)
427 elif format == end_format:
431 error('Cannot convert file format %s to %s' % (format, end_format))
433 lines.insert(i, "Format 2")
437 # Don't get confused by LaTeX code
438 if re_Preamble.match(lines[i]):
440 while i < len(lines) and not re_EndPreamble.match(lines[i]):
443 if re_LangPreamble.match(lines[i]):
445 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
448 if re_BabelPreamble.match(lines[i]):
450 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
454 if format >= 60 and format <= 61:
460 match = re_InsetLayout_CaptionLTNN.match(lines[i])
464 # '^(\s*InsetLayout\s+)(Caption:LongTableNonumber)'
465 lead = match.group(1)
466 lines[i] = lead + "Caption:Unnumbered"
476 match = re_IfStyle.match(lines[i])
480 # r'^(\s*)IfStyle(\s+\S+)
481 lead = match.group(1)
482 trail = match.group(2)
483 lines[i] = lead + "ModifyStyle" + trail
487 if format >= 50 and format <= 56:
495 # delete separator styles
496 match = re_Style.match(lines[i])
498 style = string.lower(match.group(4))
499 if re_Separator.match(style):
501 while i < len(lines) and not re_End.match(lines[i]):
502 separator.append(lines[i])
505 error('Incomplete separator style.')
510 # delete undefinition of separator styles
511 match = re_NoStyle.match(lines[i])
513 style = string.lower(match.group(4))
514 if re_Separator.match(style):
518 # replace the CopyStyle statement with the definition of the real
519 # style. This may result in duplicate statements, but that is OK
520 # since the second one will overwrite the first one.
521 match = re_CopyStyle.match(lines[i])
523 style = string.lower(match.group(4))
524 if re_Separator.match(style):
525 if len(separator) > 0:
526 lines[i:i+1] = separator
528 # FIXME: If this style was redefined in an include file,
529 # we should replace the real style and not this default.
530 lines[i:i+1] = [' Category MainText',
533 ' LatexType Paragraph',
538 ' LabelString "--- Separate Environment ---"',
550 # The default of ResetsFont in LyX changed from true to false,
551 # because it is now used for all InsetLayouts, not only flex ones.
552 # Therefore we need to set it to true for all flex insets which do
553 # do not already have a ResetsFont.
554 match = re_InsetLayout2.match(lines[i])
559 name = string.lower(match.group(1))
560 if name != "flex" and name != "\"flex\"" and name[0:5] != "flex:" and name [0:6] != "\"flex:":
564 resetsfont_found = False
567 while i < len(lines):
568 match = re_ResetsFont.match(lines[i])
570 resetsfont_found = True
572 match = re_CopyStyle.match(lines[i])
576 match = re_End.match(lines[i])
580 if not resetsfont_found and not inherited:
581 lines.insert(i, "\tResetsFont true")
585 if format >= 44 and format <= 47:
591 match = re_LabelTypeIsCounter.match(lines[i])
594 lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
596 lines[i] = match.group(1) + "LabelType" + match.group(2) + "Static"
598 match = re_TopEnvironment.match(lines[i])
600 lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
602 match = re_CenteredEnvironment.match(lines[i])
604 lines[i] = match.group(1) + "LabelType" + match.group(2) + "Centered"
607 match = re_Style.match(lines[i])
611 match = re_ChapterStyle.match(lines[i])
619 if lines[i] == "InsetLayout Caption":
620 lines[i] = "InsetLayout Caption:Standard"
630 # reset counters on Style beginning
631 match = re_Style.match(lines[i])
637 match = re_OptArgs.match(lines[i])
639 # Save number of optional arguments
640 space1 = match.group(1)
641 opts = int(match.group(3))
642 # OptionalArgs 0 > ResetArgs 1
644 lines[i] = space1 + "ResetArgs\t1"
649 match = re_ReqArgs.match(lines[i])
651 # Save number of required arguments
652 space1 = match.group(1)
653 reqs = int(match.group(3))
656 # Insert the required number of arguments at the end of the style definition
657 match = re_End.match(lines[i])
660 # First the optionals (this is the required order pre 2.1)
663 newarg = [ '%sArgument 1' % (space1),
664 '%s\tLabelString\t\"Optional Layout Argument\"' % (space1),
665 '%sEndArgument' % (space1)]
668 while actopt < (opts + 1):
669 newarg += [ '%sArgument %d' % (space1, actopt),
670 '%s\tLabelString\t\"Optional Layout Argument %d\"' % (space1, actopt),
671 '%sEndArgument' % (space1)]
673 # Now the mandatories
676 while actopt < (opts + reqs + 1):
677 newarg += [ '%sArgument %d' % (space1, actopt),
678 '%s\tLabelString\t"Required Layout Argument %d"' % (space1, actopt - opts),
679 '%s\tMandatory\t1' % (space1),
680 '%sEndArgument' % (space1)]
682 # Since we replace the "End" line, re-add this line
685 lines[i:i+1] = newarg
694 # There is a conversion with format 40, but it is done within the
695 # initial comment block and so is above.
699 if format == 37 or format == 38:
704 match = re_CiteFormat.match(lines[i]);
705 if match and match.group(4) == "":
706 lines[i] = match.group(0) + " default"
715 match = re_QInsetLayout2.match(lines[i])
717 match = re_InsetLayout2.match(lines[i])
719 match = re_CopyStyle2.match(lines[i])
723 style = match.group(2)
725 if flexstyles.count(style):
726 lines[i] = match.group(1) + "\"Flex:" + style + "\""
730 name = match.group(1)
731 names = name.split(":", 1)
732 if len(names) > 1 and names[0] == "Flex":
737 for j in range(i + 1, len(lines)):
738 if re_IsFlex.match(lines[j]):
741 if re_End.match(lines[j]):
745 flexstyles.append(name)
746 lines[i] = "InsetLayout \"Flex:" + name + "\""
752 m = re_Fill.match(lines[i])
759 match = re_NeedsFloatPkg.match(lines[i])
761 space = match.group(1)
763 lines[i] = space + "UsesFloatPkg " + val
765 if val == '1' or val.lower() == 'true':
767 lines.insert(i, space + "IsPredefined " + newval)
773 if format >= 29 and format <= 31:
778 match = re_InsetLayout.match(lines[i])
780 lines[i] = "InsetLayout Flex:" + match.group(1)
782 match = re_QInsetLayout.match(lines[i])
784 lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
786 match = re_InsetLayout_CopyStyle.match(lines[i])
788 lines[i] = "\tCopyStyle Flex:" + match.group(1)
790 match = re_QInsetLayout_CopyStyle.match(lines[i])
792 lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
797 if format >= 24 and format <= 27:
802 match = re_Float.match(lines[i])
806 # we need to do two things:
807 # (i) Convert Builtin to NeedsFloatPkg
808 # (ii) Write ListCommand lines for the builtin floats table and figure
811 while True and i < len(lines):
812 m1 = re_End.match(lines[i])
815 line = " ListCommand " + cmd
816 lines.insert(i, line)
819 m2 = re_Builtin.match(lines[i])
825 if re_True.match(arg):
829 lines[i] = ws1 + "NeedsFloatPkg " + newarg
830 m3 = re_Type.match(lines[i])
833 fltype = fltype.lower()
834 if fltype == "table":
836 elif fltype == "figure":
837 cmd = "listoffigures"
838 # else unknown, which is why we're doing this
842 # This just involved new features, not any changes to old ones
843 if format >= 14 and format <= 22:
847 # Rename I18NPreamble to BabelPreamble
849 match = re_I18nPreamble.match(lines[i])
851 lines[i] = match.group(1) + "BabelPreamble"
853 match = re_EndI18nPreamble.match(lines[i])
854 while i < len(lines) and not match:
856 match = re_EndI18nPreamble.match(lines[i])
857 lines[i] = match.group(1) + "EndBabelPreamble"
861 # These just involved new features, not any changes to old ones
862 if format == 11 or format == 12:
867 match = re_UseMod.match(lines[i])
869 module = match.group(1)
870 lines[i] = "DefaultModule " + module
875 match = re_Counter.match(lines[i])
879 while i < len(lines):
880 namem = re_Name.match(lines[i])
882 name = namem.group(1)
884 lines[counterline] = "Counter %s" % name
885 # we don't need to increment i
887 endem = re_End.match(lines[i])
896 # We want to scan for ams-type includes and, if we find them,
897 # add corresponding UseModule tags to the layout.
898 match = re_AMSMaths.match(lines[i])
900 addstring("theorems-ams", usemodules)
901 addstring("theorems-ams-extended", usemodules)
902 addstring("theorems-sec", usemodules)
905 match = re_AMSMathsPlain.match(lines[i])
907 addstring("theorems-starred", usemodules)
910 match = re_AMSMathsSeq.match(lines[i])
912 addstring("theorems-ams", usemodules)
913 addstring("theorems-ams-extended", usemodules)
919 # These just involved new features, not any changes to old ones
920 if format >= 5 and format <= 7:
925 # Handle conversion to long CharStyle names
926 match = re_CharStyle.match(lines[i])
928 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
930 lines.insert(i, "\tLyXType charstyle")
933 lines[i] = "\tLabelString %s" % (match.group(3))
938 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
939 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
941 match = re_Provides.match(lines[i])
943 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
944 match.group(3), match.group(4))
951 # delete caption styles
952 match = re_Style.match(lines[i])
954 style = string.lower(match.group(4))
955 if style == "caption":
957 while i < len(lines) and not re_End.match(lines[i]):
958 caption.append(lines[i])
961 error('Incomplete caption style.')
966 # delete undefinition of caption styles
967 match = re_NoStyle.match(lines[i])
969 style = string.lower(match.group(4))
970 if style == "caption":
974 # replace the CopyStyle statement with the definition of the real
975 # style. This may result in duplicate statements, but that is OK
976 # since the second one will overwrite the first one.
977 match = re_CopyStyle.match(lines[i])
979 style = string.lower(match.group(4))
980 if style == "caption":
982 lines[i:i+1] = caption
984 # FIXME: This style comes from an include file, we
985 # should replace the real style and not this default.
986 lines[i:i+1] = [' Margin First_Dynamic',
987 ' LatexType Command',
988 ' LatexName caption',
994 ' AlignPossible Center',
995 ' LabelType Sensitive',
996 ' LabelString "Senseless!"',
1005 # Delete MaxCounter and remember the value of it
1006 match = re_MaxCounter.match(lines[i])
1008 level = match.group(4)
1009 if string.lower(level) == "counter_chapter":
1011 elif string.lower(level) == "counter_section":
1013 elif string.lower(level) == "counter_subsection":
1015 elif string.lower(level) == "counter_subsubsection":
1017 elif string.lower(level) == "counter_paragraph":
1019 elif string.lower(level) == "counter_subparagraph":
1021 elif string.lower(level) == "counter_enumi":
1023 elif string.lower(level) == "counter_enumii":
1025 elif string.lower(level) == "counter_enumiii":
1032 # LabelType Counter_EnumI
1037 # LabelCounter EnumI
1039 match = re_LabelType.match(lines[i])
1041 label = match.group(4)
1042 # Remember indenting space for later reuse in added lines
1043 space1 = match.group(1)
1044 # Remember the line for adding the LabelCounter later.
1045 # We can't do it here because it could shift latextype_line etc.
1047 if string.lower(label[:8]) == "counter_":
1048 counter = string.lower(label[8:])
1049 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
1051 # Remember the LabelString line
1052 match = re_LabelString.match(lines[i])
1054 labelstring = match.group(4)
1055 labelstring_line = i
1057 # Remember the LabelStringAppendix line
1058 match = re_LabelStringAppendix.match(lines[i])
1060 labelstringappendix = match.group(4)
1061 labelstringappendix_line = i
1063 # Remember the LatexType line
1064 match = re_LatexType.match(lines[i])
1066 latextype = string.lower(match.group(4))
1069 # Remember the TocLevel line
1070 match = re_TocLevel.match(lines[i])
1072 toclevel = string.lower(match.group(4))
1074 # Reset variables at the beginning of a style definition
1075 match = re_Style.match(lines[i])
1077 style = string.lower(match.group(4))
1083 labelstringappendix = ""
1084 labelstring_line = -1
1085 labelstringappendix_line = -1
1090 if re_End.match(lines[i]):
1092 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
1093 # (or change the existing LatexType)
1094 if string.lower(label) == "bibliography":
1095 if (latextype_line < 0):
1096 lines.insert(i, "%sLatexType Bib_Environment" % space1)
1099 lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
1101 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
1102 if latextype == "item_environment" and string.lower(label) == "static":
1103 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
1105 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
1106 if latextype == "item_environment" and string.lower(label) == "counter_enumi":
1107 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
1108 # Don't add the LabelCounter line later
1113 # LabelString "Chapter"
1117 # LabelString "Chapter \arabic{chapter}"
1119 # if this style has a counter. Ditto for LabelStringAppendix.
1120 # This emulates the hardcoded article style numbering of 1.3
1123 if style in counters:
1124 if labelstring_line < 0:
1125 lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
1128 new_labelstring = concatenate_label(labelstring, counters[style])
1129 lines[labelstring_line] = re_LabelString.sub(
1130 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
1131 lines[labelstring_line])
1132 if style in appendixcounters:
1133 if labelstringappendix_line < 0:
1134 lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
1137 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
1138 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
1139 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
1140 lines[labelstringappendix_line])
1142 # Now we can safely add the LabelCounter line
1143 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
1146 # Add the TocLevel setting for sectioning styles
1147 if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
1148 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
1154 lines.insert(i, "Format 2")
1157 for mod in usemodules:
1158 lines.insert(i, "UseModule " + mod)
1166 args["description"] = "Convert layout file <inputfile> to a newer format."
1168 parser = argparse.ArgumentParser(**args)
1170 parser.add_argument("-t", "--to", type=int, dest="format",
1171 help=("destination layout format, default %i (latest)") % currentFormat)
1172 parser.add_argument("input_file", nargs='?', type=cmd_arg, default=None,
1173 help="input file (default stdin)")
1174 parser.add_argument("output_file", nargs='?', type=cmd_arg, default=None,
1175 help="output file (default stdout)")
1177 options = parser.parse_args()
1180 if options.input_file:
1181 source = open(options.input_file, 'rb')
1185 if options.output_file:
1186 output = open(options.output_file, 'wb')
1191 end_format = options.format
1193 end_format = currentFormat
1195 if end_format > currentFormat:
1196 error("Format %i does not exist" % end_format);
1199 lines = read(source)
1201 while (format < end_format):
1202 format = convert(lines, end_format)
1203 write(output, lines)
1206 if options.input_file:
1208 if options.output_file:
1214 if __name__ == "__main__":