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 # Incremented to format 63, 7 January 2017 by spitz
212 # - New textclass tags CiteFramework, MaxCiteNames (for cite engines)
213 # - Extended InsetCite syntax.
215 # Incremented to format 64, 30 August 2017 by rgh
216 # Strip leading and trailing spaces from LabelString,
217 # LabelStringAppendix, and EndLabelString, and LabelCounter,
218 # to conform to what we used to do.
220 # Incremented to format 65, 16 October 2017 by spitz
221 # Color collapsable -> collapsible
223 # Incremented to format 66, 28 December 2017 by spitz
224 # New Layout tags "AutoNests ... EndAutoNests" and
225 # "IsAutoNestedBy ... EndIsAutoNestedBy"
227 # Do not forget to document format change in Customization
228 # Manual (section "Declaring a new text class").
230 # You might also want to consider running the
231 # development/tools/updatelayouts.py script to update all
232 # layout files to the new format.
238 # Provide support for both python 2 and 3
239 # (copied from lyx2lyx)
240 PY2 = sys.version_info[0] == 2
242 # argparse returns strings in the commandline encoding, we need to convert.
243 # sys.getdefaultencoding() would not always be correct, see
244 # http://legacy.python.org/dev/peps/pep-0383/
246 return arg.decode(sys.getfilesystemencoding())
249 # End of code to support for both python 2 and 3
253 sys.stderr.write(message + '\n')
258 " Remove byte order mark."
259 if line[0:3] == "\357\273\277":
266 " Read input file and strip lineendings."
267 lines = source.read().splitlines() or ['']
268 lines[0] = trim_bom(lines[0])
272 def write(output, lines):
273 " Write output file with native lineendings."
274 output.write(os.linesep.encode('ascii').join(lines)
275 + os.linesep.encode('ascii'))
278 # Concatenates old and new in an intelligent way:
279 # If old is wrapped in ", they are stripped. The result is wrapped in ".
280 def concatenate_label(old, new):
281 # Don't use strip as long as we support python 1.5.2
283 return old[0:-1] + new + b'"'
285 return b'"' + old + new + b'"'
287 # appends a string to a list unless it's already there
294 def convert(lines, end_format):
295 " Convert to new format."
296 re_Comment = re.compile(b'^(\\s*)#')
297 re_Counter = re.compile(b'\\s*Counter\\s*', re.IGNORECASE)
298 re_Name = re.compile(b'\\s*Name\\s+(\\S+)\\s*', re.IGNORECASE)
299 re_UseMod = re.compile(b'^\\s*UseModule\\s+(.*)', re.IGNORECASE)
300 re_Empty = re.compile(b'^(\\s*)$')
301 re_Format = re.compile(b'^(\\s*)(Format)(\\s+)(\\S+)', re.IGNORECASE)
302 re_Preamble = re.compile(b'^(\\s*)Preamble', re.IGNORECASE)
303 re_EndPreamble = re.compile(b'^(\\s*)EndPreamble', re.IGNORECASE)
304 re_LangPreamble = re.compile(b'^(\\s*)LangPreamble', re.IGNORECASE)
305 re_EndLangPreamble = re.compile(b'^(\\s*)EndLangPreamble', re.IGNORECASE)
306 re_BabelPreamble = re.compile(b'^(\\s*)BabelPreamble', re.IGNORECASE)
307 re_EndBabelPreamble = re.compile(b'^(\\s*)EndBabelPreamble', re.IGNORECASE)
308 re_MaxCounter = re.compile(b'^(\\s*)(MaxCounter)(\\s+)(\\S+)', re.IGNORECASE)
309 re_LabelType = re.compile(b'^(\\s*)(LabelType)(\\s+)(\\S+)', re.IGNORECASE)
310 re_LabelString = re.compile(b'^(\\s*)(LabelString)(\\s+)(("[^"]+")|(\\S+))', re.IGNORECASE)
311 re_LabelStringAppendix = re.compile(b'^(\\s*)(LabelStringAppendix)(\\s+)(("[^"]+")|(\\S+))', re.IGNORECASE)
312 re_LatexType = re.compile(b'^(\\s*)(LatexType)(\\s+)(\\S+)', re.IGNORECASE)
313 re_Style = re.compile(b'^(\\s*)(Style)(\\s+)(\\S+)', re.IGNORECASE)
314 re_IfStyle = re.compile(b'^(\\s*)IfStyle(\\s+\\S+)', re.IGNORECASE)
315 re_CopyStyle = re.compile(b'^(\\s*)(CopyStyle)(\\s+)(\\S+)', re.IGNORECASE)
316 re_NoStyle = re.compile(b'^(\\s*)(NoStyle)(\\s+)(\\S+)', re.IGNORECASE)
317 re_End = re.compile(b'^(\\s*)(End)(\\s*)$', re.IGNORECASE)
318 re_Provides = re.compile(b'^(\\s*)Provides(\\S+)(\\s+)(\\S+)', re.IGNORECASE)
319 re_CharStyle = re.compile(b'^(\\s*)CharStyle(\\s+)(\\S+)$', re.IGNORECASE)
320 re_CiteFormat = re.compile(b'^(\\s*)(CiteFormat)(?:(\\s*)()|(\\s+)(default|authoryear|numerical))', re.IGNORECASE)
321 re_AMSMaths = re.compile(b'^\\s*Input ams(?:math|def)s.inc\\s*')
322 re_AMSMathsPlain = re.compile(b'^\\s*Input amsmaths-plain.inc\\s*')
323 re_AMSMathsSeq = re.compile(b'^\\s*Input amsmaths-seq.inc\\s*')
324 re_TocLevel = re.compile(b'^(\\s*)(TocLevel)(\\s+)(\\S+)', re.IGNORECASE)
325 re_I18nPreamble = re.compile(b'^(\\s*)I18nPreamble', re.IGNORECASE)
326 re_EndI18nPreamble = re.compile(b'^(\\s*)EndI18nPreamble', re.IGNORECASE)
327 re_Float = re.compile(b'^\\s*Float\\s*$', re.IGNORECASE)
328 re_Type = re.compile(b'\\s*Type\\s+(\\w+)', re.IGNORECASE)
329 re_Builtin = re.compile(b'^(\\s*)LaTeXBuiltin\\s+(\\w*)', re.IGNORECASE)
330 re_True = re.compile(b'^\\s*(?:true|1)\\s*$', re.IGNORECASE)
331 re_InsetLayout = re.compile(b'^\\s*InsetLayout\\s+(?:Custom|CharStyle|Element):(\\S+)\\s*$', re.IGNORECASE)
332 re_ResetsFont = re.compile(b'^(\\s*)ResetsFont(\\s+)(\\S+)$', re.IGNORECASE)
334 re_QInsetLayout = re.compile(b'^\\s*InsetLayout\\s+"(?:Custom|CharStyle|Element):([^"]+)"\\s*$', re.IGNORECASE)
335 re_InsetLayout_CopyStyle = re.compile(b'^\\s*CopyStyle\\s+(?:Custom|CharStyle|Element):(\\S+)\\s*$', re.IGNORECASE)
336 re_QInsetLayout_CopyStyle = re.compile(b'^\\s*CopyStyle\\s+"(?:Custom|CharStyle|Element):([^"]+)"\\s*$', re.IGNORECASE)
337 re_NeedsFloatPkg = re.compile(b'^(\\s*)NeedsFloatPkg\\s+(\\w+)\\s*$', re.IGNORECASE)
338 re_Fill = re.compile(b'^\\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
339 re_InsetLayout2 = re.compile(b'^\\s*InsetLayout\\s+(\\S+)\\s*$', re.IGNORECASE)
341 re_QInsetLayout2 = re.compile(b'^\\s*InsetLayout\\s+"([^"]+)"\\s*$', re.IGNORECASE)
342 re_IsFlex = re.compile(b'\\s*LyXType.*$', re.IGNORECASE)
343 re_CopyStyle2 = re.compile(b'(\\s*CopyStyle\\s+)"?([^"]+)"?\\s*$')
344 re_Separator = re.compile(b'^(?:(-*)|(\\s*))(Separator|EndOfSlide)(?:(-*)|(\\s*))$', re.IGNORECASE)
346 re_Declaration = re.compile(b'^#\\s*\\Declare\\w+Class.*$')
347 re_ExtractCategory = re.compile(b'^(#\\s*\\Declare\\w+Class(?:\\[[^]]*?\\])?){([^(]+?)\\s+\\(([^)]+?)\\)\\s*}\\s*$')
348 ConvDict = {"article": "Articles", "book" : "Books", "letter" : "Letters", "report": "Reports", \
349 "presentation" : "Presentations", "curriculum vitae" : "Curricula Vitae", "handout" : "Handouts"}
351 re_OptArgs = re.compile(b'^(\\s*)OptionalArgs(\\s+)(\\d+)\\D*$', re.IGNORECASE)
352 re_ReqArgs = re.compile(b'^(\\s*)RequiredArgs(\\s+)(\\d+)\\D*$', re.IGNORECASE)
354 # various changes associated with changing how chapters are handled
355 re_LabelTypeIsCounter = re.compile(b'^(\\s*)LabelType(\\s*)Counter\\s*$', re.IGNORECASE)
356 re_TopEnvironment = re.compile(b'^(\\s*)LabelType(\\s+)Top_Environment\\s*$', re.IGNORECASE)
357 re_CenteredEnvironment = re.compile(b'^(\\s*)LabelType(\\s+)Centered_Top_Environment\\s*$', re.IGNORECASE)
358 re_ChapterStyle = re.compile(b'^\\s*Style\\s+Chapter\\s*$', re.IGNORECASE)
359 re_InsetLayout_CaptionLTNN = re.compile(b'^(\\s*InsetLayout\\s+)(Caption:LongTableNonumber)', re.IGNORECASE)
361 re_trimLabelString = re.compile(b'^(\\s*LabelString\s+)"\\s*(.*?)\\s*"\\s*$')
362 re_trimLabelStringAppendix = re.compile(b'^(\\s*LabelStringAppendix\s+)"\\s*(.*?)\\s*"\\s*$')
363 re_trimEndLabelString = re.compile(b'^(\\s*EndLabelString\s+)"\\s*(.*?)\\s*"\\s*$')
364 re_trimLabelCounter = re.compile(b'^(\\s*LabelCounter\s+)"\\s*(.*?)\\s*"\\s*$')
367 # counters for sectioning styles (hardcoded in 1.3)
368 counters = {b"part" : b"\\Roman{part}",
369 b"chapter" : b"\\arabic{chapter}",
370 b"section" : b"\\arabic{section}",
371 b"subsection" : b"\\arabic{section}.\\arabic{subsection}",
372 b"subsubsection" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
373 b"paragraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
374 b"subparagraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
376 # counters for sectioning styles in appendix (hardcoded in 1.3)
377 appendixcounters = {b"chapter" : b"\\Alph{chapter}",
378 b"section" : b"\\Alph{section}",
379 b"subsection" : b"\\arabic{section}.\\arabic{subsection}",
380 b"subsubsection" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
381 b"paragraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
382 b"subparagraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
384 # Value of TocLevel for sectioning styles
385 toclevels = {b"part" : -1,
389 b"subsubsection" : 3,
399 labelstringappendix = b""
401 labelstring_line = -1
402 labelstringappendix_line = -1
415 isflexlayout = False # only used for 48 -> 49
416 # Whether a style is inherited (works only for CopyStyle currently,
417 # not for true inherited styles, see bug 8920
418 inherited = False # only used for 48 -> 49
419 resetsfont_found = False # only used for 48 -> 49
421 while i < len(lines):
422 # Skip comments and empty lines
423 if (re_Comment.match(lines[i]) or re_Empty.match(lines[i])):
424 # We need to deal with this conversion here, because it happens
425 # inside the initial comment block.
426 if only_comment and format == 39:
427 match = re_ExtractCategory.match(lines[i])
429 lpre = match.group(1)
430 lcat = match.group(2)
431 lnam = match.group(3)
433 lcat = ConvDict[lcat]
434 lines[i] = lpre + b"{" + lnam + b"}"
435 lines.insert(i+1, b"# \\DeclareCategory{" + lcat + b"}")
440 # insert file format if not already there
442 match = re_Format.match(lines[i])
445 format = int(match.group(4))
446 if format > 1 and format < end_format:
447 lines[i] = b"Format %d" % (format + 1)
449 elif format == end_format:
453 error('Cannot convert file format %s to %s' % (format, end_format))
455 lines.insert(i, b"Format 2")
459 # Don't get confused by LaTeX code
460 if re_Preamble.match(lines[i]):
462 while i < len(lines) and not re_EndPreamble.match(lines[i]):
465 if re_LangPreamble.match(lines[i]):
467 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
470 if re_BabelPreamble.match(lines[i]):
472 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
482 match = re.compile(b'(\\s*Color\\s+)(\\w+)', re.IGNORECASE).match(lines[i])
487 if col == "collapsable":
488 lines[i] = match.group(1) + "collapsible"
493 for r in (re_trimLabelString, re_trimLabelStringAppendix,\
494 re_trimEndLabelString, re_trimLabelCounter):
495 m = r.match(lines[i])
497 lines[i] = m.group(1) + b'"' + m.group(2) + b'"'
501 if format >= 60 and format <= 62:
507 match = re_InsetLayout_CaptionLTNN.match(lines[i])
511 # '^(\s*InsetLayout\s+)(Caption:LongTableNonumber)'
512 lead = match.group(1)
513 lines[i] = lead + b"Caption:Unnumbered"
523 match = re_IfStyle.match(lines[i])
527 # b'^(\\s*)IfStyle(\\s+\\S+)
528 lead = match.group(1)
529 trail = match.group(2)
530 lines[i] = lead + b"ModifyStyle" + trail
534 if format >= 50 and format <= 56:
542 # delete separator styles
543 match = re_Style.match(lines[i])
545 style = match.group(4).lower()
546 if re_Separator.match(style):
548 while i < len(lines) and not re_End.match(lines[i]):
549 separator.append(lines[i])
552 error('Incomplete separator style.')
557 # delete undefinition of separator styles
558 match = re_NoStyle.match(lines[i])
560 style = match.group(4).lower()
561 if re_Separator.match(style):
565 # replace the CopyStyle statement with the definition of the real
566 # style. This may result in duplicate statements, but that is OK
567 # since the second one will overwrite the first one.
568 match = re_CopyStyle.match(lines[i])
570 style = match.group(4).lower()
571 if re_Separator.match(style):
572 if len(separator) > 0:
573 lines[i:i+1] = separator
575 # FIXME: If this style was redefined in an include file,
576 # we should replace the real style and not this default.
577 lines[i:i+1] = [b' Category MainText',
580 b' LatexType Paragraph',
584 b' LabelType Static',
585 b' LabelString "--- Separate Environment ---"',
597 # The default of ResetsFont in LyX changed from true to false,
598 # because it is now used for all InsetLayouts, not only flex ones.
599 # Therefore we need to set it to true for all flex insets which do
600 # do not already have a ResetsFont.
601 match = re_InsetLayout2.match(lines[i])
606 name = match.group(1).lower()
607 if name != b"flex" and name != b"\"flex\"" and name[0:5] != b"flex:" and name [0:6] != b"\"flex:":
611 resetsfont_found = False
614 while i < len(lines):
615 match = re_ResetsFont.match(lines[i])
617 resetsfont_found = True
619 match = re_CopyStyle.match(lines[i])
623 match = re_End.match(lines[i])
627 if not resetsfont_found and not inherited:
628 lines.insert(i, b"\tResetsFont true")
632 if format >= 44 and format <= 47:
638 match = re_LabelTypeIsCounter.match(lines[i])
641 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Above"
643 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Static"
645 match = re_TopEnvironment.match(lines[i])
647 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Above"
649 match = re_CenteredEnvironment.match(lines[i])
651 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Centered"
654 match = re_Style.match(lines[i])
658 match = re_ChapterStyle.match(lines[i])
666 if lines[i] == b"InsetLayout Caption":
667 lines[i] = b"InsetLayout Caption:Standard"
677 # reset counters on Style beginning
678 match = re_Style.match(lines[i])
684 match = re_OptArgs.match(lines[i])
686 # Save number of optional arguments
687 space1 = match.group(1)
688 opts = int(match.group(3))
689 # OptionalArgs 0 > ResetArgs 1
691 lines[i] = space1 + b"ResetArgs\t1"
696 match = re_ReqArgs.match(lines[i])
698 # Save number of required arguments
699 space1 = match.group(1)
700 reqs = int(match.group(3))
703 # Insert the required number of arguments at the end of the style definition
704 match = re_End.match(lines[i])
707 # First the optionals (this is the required order pre 2.1)
710 newarg = [ b'%sArgument 1' % (space1),
711 b'%s\tLabelString\t\"Optional Layout Argument\"' % (space1),
712 b'%sEndArgument' % (space1)]
715 while actopt < (opts + 1):
716 newarg += [ b'%sArgument %d' % (space1, actopt),
717 b'%s\tLabelString\t\"Optional Layout Argument %d\"' % (space1, actopt),
718 b'%sEndArgument' % (space1)]
720 # Now the mandatories
723 while actopt < (opts + reqs + 1):
724 newarg += [ b'%sArgument %d' % (space1, actopt),
725 b'%s\tLabelString\t"Required Layout Argument %d"' % (space1, actopt - opts),
726 b'%s\tMandatory\t1' % (space1),
727 b'%sEndArgument' % (space1)]
729 # Since we replace the "End" line, re-add this line
732 lines[i:i+1] = newarg
741 # There is a conversion with format 40, but it is done within the
742 # initial comment block and so is above.
746 if format == 37 or format == 38:
751 match = re_CiteFormat.match(lines[i]);
752 if match and match.group(4) == b"":
753 lines[i] = match.group(0) + b" default"
762 match = re_QInsetLayout2.match(lines[i])
764 match = re_InsetLayout2.match(lines[i])
766 match = re_CopyStyle2.match(lines[i])
770 style = match.group(2)
772 if flexstyles.count(style):
773 lines[i] = match.group(1) + b"\"Flex:" + style + b"\""
777 name = match.group(1)
778 names = name.split(b":", 1)
779 if len(names) > 1 and names[0] == b"Flex":
784 for j in range(i + 1, len(lines)):
785 if re_IsFlex.match(lines[j]):
788 if re_End.match(lines[j]):
792 flexstyles.append(name)
793 lines[i] = b"InsetLayout \"Flex:" + name + b"\""
799 m = re_Fill.match(lines[i])
806 match = re_NeedsFloatPkg.match(lines[i])
808 space = match.group(1)
810 lines[i] = space + b"UsesFloatPkg " + val
812 if val == b'1' or val.lower() == b'true':
814 lines.insert(i, space + b"IsPredefined " + newval)
820 if format >= 29 and format <= 31:
825 match = re_InsetLayout.match(lines[i])
827 lines[i] = b"InsetLayout Flex:" + match.group(1)
829 match = re_QInsetLayout.match(lines[i])
831 lines[i] = b"InsetLayout \"Flex:" + match.group(1) + b"\""
833 match = re_InsetLayout_CopyStyle.match(lines[i])
835 lines[i] = b"\tCopyStyle Flex:" + match.group(1)
837 match = re_QInsetLayout_CopyStyle.match(lines[i])
839 lines[i] = b"\tCopyStyle \"Flex:" + match.group(1) + b"\""
844 if format >= 24 and format <= 27:
849 match = re_Float.match(lines[i])
853 # we need to do two things:
854 # (i) Convert Builtin to NeedsFloatPkg
855 # (ii) Write ListCommand lines for the builtin floats table and figure
858 while True and i < len(lines):
859 m1 = re_End.match(lines[i])
862 line = b" ListCommand " + cmd
863 lines.insert(i, line)
866 m2 = re_Builtin.match(lines[i])
872 if re_True.match(arg):
876 lines[i] = ws1 + b"NeedsFloatPkg " + newarg
877 m3 = re_Type.match(lines[i])
880 fltype = fltype.lower()
881 if fltype == b"table":
882 cmd = b"listoftables"
883 elif fltype == b"figure":
884 cmd = b"listoffigures"
885 # else unknown, which is why we're doing this
889 # This just involved new features, not any changes to old ones
890 if format >= 14 and format <= 22:
894 # Rename I18NPreamble to BabelPreamble
896 match = re_I18nPreamble.match(lines[i])
898 lines[i] = match.group(1) + b"BabelPreamble"
900 match = re_EndI18nPreamble.match(lines[i])
901 while i < len(lines) and not match:
903 match = re_EndI18nPreamble.match(lines[i])
904 lines[i] = match.group(1) + b"EndBabelPreamble"
908 # These just involved new features, not any changes to old ones
909 if format == 11 or format == 12:
914 match = re_UseMod.match(lines[i])
916 module = match.group(1)
917 lines[i] = b"DefaultModule " + module
922 match = re_Counter.match(lines[i])
926 while i < len(lines):
927 namem = re_Name.match(lines[i])
929 name = namem.group(1)
931 lines[counterline] = b"Counter %s" % name
932 # we don't need to increment i
934 endem = re_End.match(lines[i])
943 # We want to scan for ams-type includes and, if we find them,
944 # add corresponding UseModule tags to the layout.
945 match = re_AMSMaths.match(lines[i])
947 addstring(b"theorems-ams", usemodules)
948 addstring(b"theorems-ams-extended", usemodules)
949 addstring(b"theorems-sec", usemodules)
952 match = re_AMSMathsPlain.match(lines[i])
954 addstring(b"theorems-starred", usemodules)
957 match = re_AMSMathsSeq.match(lines[i])
959 addstring(b"theorems-ams", usemodules)
960 addstring(b"theorems-ams-extended", usemodules)
966 # These just involved new features, not any changes to old ones
967 if format >= 5 and format <= 7:
972 # Handle conversion to long CharStyle names
973 match = re_CharStyle.match(lines[i])
975 lines[i] = b"InsetLayout CharStyle:%s" % (match.group(3))
977 lines.insert(i, b"\tLyXType charstyle")
980 lines[i] = b"\tLabelString %s" % (match.group(3))
985 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
986 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
988 match = re_Provides.match(lines[i])
990 lines[i] = b"%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
991 match.group(3), match.group(4))
998 # delete caption styles
999 match = re_Style.match(lines[i])
1001 style = match.group(4).lower()
1002 if style == b"caption":
1004 while i < len(lines) and not re_End.match(lines[i]):
1005 caption.append(lines[i])
1008 error('Incomplete caption style.')
1013 # delete undefinition of caption styles
1014 match = re_NoStyle.match(lines[i])
1016 style = match.group(4).lower()
1017 if style == b"caption":
1021 # replace the CopyStyle statement with the definition of the real
1022 # style. This may result in duplicate statements, but that is OK
1023 # since the second one will overwrite the first one.
1024 match = re_CopyStyle.match(lines[i])
1026 style = match.group(4).lower()
1027 if style == b"caption":
1028 if len(caption) > 0:
1029 lines[i:i+1] = caption
1031 # FIXME: This style comes from an include file, we
1032 # should replace the real style and not this default.
1033 lines[i:i+1] = [b' Margin First_Dynamic',
1034 b' LatexType Command',
1035 b' LatexName caption',
1041 b' AlignPossible Center',
1042 b' LabelType Sensitive',
1043 b' LabelString "Senseless!"',
1052 # Delete MaxCounter and remember the value of it
1053 match = re_MaxCounter.match(lines[i])
1055 level = match.group(4).lower()
1056 if level == b"counter_chapter":
1058 elif level == b"counter_section":
1060 elif level == b"counter_subsection":
1062 elif level == b"counter_subsubsection":
1064 elif level == b"counter_paragraph":
1066 elif level == b"counter_subparagraph":
1068 elif level == b"counter_enumi":
1070 elif level == b"counter_enumii":
1072 elif level == b"counter_enumiii":
1079 # LabelType Counter_EnumI
1084 # LabelCounter EnumI
1086 match = re_LabelType.match(lines[i])
1088 label = match.group(4)
1089 # Remember indenting space for later reuse in added lines
1090 space1 = match.group(1)
1091 # Remember the line for adding the LabelCounter later.
1092 # We can't do it here because it could shift latextype_line etc.
1094 if label[:8].lower() == b"counter_":
1095 counter = label[8:].lower()
1096 lines[i] = re_LabelType.sub(b'\\1\\2\\3Counter', lines[i])
1098 # Remember the LabelString line
1099 match = re_LabelString.match(lines[i])
1101 labelstring = match.group(4)
1102 labelstring_line = i
1104 # Remember the LabelStringAppendix line
1105 match = re_LabelStringAppendix.match(lines[i])
1107 labelstringappendix = match.group(4)
1108 labelstringappendix_line = i
1110 # Remember the LatexType line
1111 match = re_LatexType.match(lines[i])
1113 latextype = match.group(4).lower()
1116 # Remember the TocLevel line
1117 match = re_TocLevel.match(lines[i])
1119 toclevel = match.group(4).lower()
1121 # Reset variables at the beginning of a style definition
1122 match = re_Style.match(lines[i])
1124 style = match.group(4).lower()
1130 labelstringappendix = b""
1131 labelstring_line = -1
1132 labelstringappendix_line = -1
1137 if re_End.match(lines[i]):
1139 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
1140 # (or change the existing LatexType)
1141 if label.lower() == b"bibliography":
1142 if (latextype_line < 0):
1143 lines.insert(i, b"%sLatexType Bib_Environment" % space1)
1146 lines[latextype_line] = re_LatexType.sub(b'\\1\\2\\3Bib_Environment', lines[latextype_line])
1148 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
1149 if latextype == b"item_environment" and label.lower() == b"static":
1150 lines[labeltype_line] = re_LabelType.sub(b'\\1\\2\\3Itemize', lines[labeltype_line])
1152 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
1153 if latextype == b"item_environment" and label.lower() == b"counter_enumi":
1154 lines[labeltype_line] = re_LabelType.sub(b'\\1\\2\\3Enumerate', lines[labeltype_line])
1155 # Don't add the LabelCounter line later
1160 # LabelString "Chapter"
1164 # LabelString "Chapter \arabic{chapter}"
1166 # if this style has a counter. Ditto for LabelStringAppendix.
1167 # This emulates the hardcoded article style numbering of 1.3
1170 if style in counters:
1171 if labelstring_line < 0:
1172 lines.insert(i, b'%sLabelString "%s"' % (space1, counters[style]))
1175 new_labelstring = concatenate_label(labelstring, counters[style])
1176 lines[labelstring_line] = re_LabelString.sub(
1177 b'\\1\\2\\3%s' % new_labelstring.replace(b"\\", b"\\\\"),
1178 lines[labelstring_line])
1179 if style in appendixcounters:
1180 if labelstringappendix_line < 0:
1181 lines.insert(i, b'%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
1184 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
1185 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
1186 b'\\1\\2\\3%s' % new_labelstring.replace(b"\\", b"\\\\"),
1187 lines[labelstringappendix_line])
1189 # Now we can safely add the LabelCounter line
1190 lines.insert(labeltype_line + 1, b"%sLabelCounter %s" % (space1, counter))
1193 # Add the TocLevel setting for sectioning styles
1194 if toclevel == b"" and style in toclevels and maxcounter <= toclevels[style]:
1195 lines.insert(i, b'%s\tTocLevel %d' % (space1, toclevels[style]))
1201 lines.insert(i, b"Format 2")
1204 for mod in usemodules:
1205 lines.insert(i, b"UseModule " + mod)
1213 args["description"] = "Convert layout file <inputfile> to a newer format."
1215 parser = argparse.ArgumentParser(**args)
1217 parser.add_argument("-t", "--to", type=int, dest="format", default= currentFormat,
1218 help=("destination layout format, default %i (latest)") % currentFormat)
1219 parser.add_argument("input_file", nargs='?', type=cmd_arg, default=None,
1220 help="input file (default stdin)")
1221 parser.add_argument("output_file", nargs='?', type=cmd_arg, default=None,
1222 help="output file (default stdout)")
1224 options = parser.parse_args(argv[1:])
1227 if options.input_file:
1228 source = open(options.input_file, 'rb')
1232 if options.output_file:
1233 output = open(options.output_file, 'wb')
1237 if options.format > currentFormat:
1238 error("Format %i does not exist" % options.format);
1241 lines = read(source)
1243 while (format < options.format):
1244 format = convert(lines, options.format)
1245 write(output, lines)
1248 if options.input_file:
1250 if options.output_file:
1256 if __name__ == "__main__":