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 tag "AutoNests ... EndAutoNests"
226 # Do not forget to document format change in Customization
227 # Manual (section "Declaring a new text class").
229 # You might also want to consider running the
230 # development/tools/updatelayouts.py script to update all
231 # layout files to the new format.
237 # Provide support for both python 2 and 3
238 # (copied from lyx2lyx)
239 PY2 = sys.version_info[0] == 2
241 # argparse returns strings in the commandline encoding, we need to convert.
242 # sys.getdefaultencoding() would not always be correct, see
243 # http://legacy.python.org/dev/peps/pep-0383/
245 return arg.decode(sys.getfilesystemencoding())
248 # End of code to support for both python 2 and 3
252 sys.stderr.write(message + '\n')
257 " Remove byte order mark."
258 if line[0:3] == "\357\273\277":
265 " Read input file and strip lineendings."
266 lines = source.read().splitlines() or ['']
267 lines[0] = trim_bom(lines[0])
271 def write(output, lines):
272 " Write output file with native lineendings."
273 output.write(os.linesep.encode('ascii').join(lines)
274 + os.linesep.encode('ascii'))
277 # Concatenates old and new in an intelligent way:
278 # If old is wrapped in ", they are stripped. The result is wrapped in ".
279 def concatenate_label(old, new):
280 # Don't use strip as long as we support python 1.5.2
282 return old[0:-1] + new + b'"'
284 return b'"' + old + new + b'"'
286 # appends a string to a list unless it's already there
293 def convert(lines, end_format):
294 " Convert to new format."
295 re_Comment = re.compile(b'^(\\s*)#')
296 re_Counter = re.compile(b'\\s*Counter\\s*', re.IGNORECASE)
297 re_Name = re.compile(b'\\s*Name\\s+(\\S+)\\s*', re.IGNORECASE)
298 re_UseMod = re.compile(b'^\\s*UseModule\\s+(.*)', re.IGNORECASE)
299 re_Empty = re.compile(b'^(\\s*)$')
300 re_Format = re.compile(b'^(\\s*)(Format)(\\s+)(\\S+)', re.IGNORECASE)
301 re_Preamble = re.compile(b'^(\\s*)Preamble', re.IGNORECASE)
302 re_EndPreamble = re.compile(b'^(\\s*)EndPreamble', re.IGNORECASE)
303 re_LangPreamble = re.compile(b'^(\\s*)LangPreamble', re.IGNORECASE)
304 re_EndLangPreamble = re.compile(b'^(\\s*)EndLangPreamble', re.IGNORECASE)
305 re_BabelPreamble = re.compile(b'^(\\s*)BabelPreamble', re.IGNORECASE)
306 re_EndBabelPreamble = re.compile(b'^(\\s*)EndBabelPreamble', re.IGNORECASE)
307 re_MaxCounter = re.compile(b'^(\\s*)(MaxCounter)(\\s+)(\\S+)', re.IGNORECASE)
308 re_LabelType = re.compile(b'^(\\s*)(LabelType)(\\s+)(\\S+)', re.IGNORECASE)
309 re_LabelString = re.compile(b'^(\\s*)(LabelString)(\\s+)(("[^"]+")|(\\S+))', re.IGNORECASE)
310 re_LabelStringAppendix = re.compile(b'^(\\s*)(LabelStringAppendix)(\\s+)(("[^"]+")|(\\S+))', re.IGNORECASE)
311 re_LatexType = re.compile(b'^(\\s*)(LatexType)(\\s+)(\\S+)', re.IGNORECASE)
312 re_Style = re.compile(b'^(\\s*)(Style)(\\s+)(\\S+)', re.IGNORECASE)
313 re_IfStyle = re.compile(b'^(\\s*)IfStyle(\\s+\\S+)', re.IGNORECASE)
314 re_CopyStyle = re.compile(b'^(\\s*)(CopyStyle)(\\s+)(\\S+)', re.IGNORECASE)
315 re_NoStyle = re.compile(b'^(\\s*)(NoStyle)(\\s+)(\\S+)', re.IGNORECASE)
316 re_End = re.compile(b'^(\\s*)(End)(\\s*)$', re.IGNORECASE)
317 re_Provides = re.compile(b'^(\\s*)Provides(\\S+)(\\s+)(\\S+)', re.IGNORECASE)
318 re_CharStyle = re.compile(b'^(\\s*)CharStyle(\\s+)(\\S+)$', re.IGNORECASE)
319 re_CiteFormat = re.compile(b'^(\\s*)(CiteFormat)(?:(\\s*)()|(\\s+)(default|authoryear|numerical))', re.IGNORECASE)
320 re_AMSMaths = re.compile(b'^\\s*Input ams(?:math|def)s.inc\\s*')
321 re_AMSMathsPlain = re.compile(b'^\\s*Input amsmaths-plain.inc\\s*')
322 re_AMSMathsSeq = re.compile(b'^\\s*Input amsmaths-seq.inc\\s*')
323 re_TocLevel = re.compile(b'^(\\s*)(TocLevel)(\\s+)(\\S+)', re.IGNORECASE)
324 re_I18nPreamble = re.compile(b'^(\\s*)I18nPreamble', re.IGNORECASE)
325 re_EndI18nPreamble = re.compile(b'^(\\s*)EndI18nPreamble', re.IGNORECASE)
326 re_Float = re.compile(b'^\\s*Float\\s*$', re.IGNORECASE)
327 re_Type = re.compile(b'\\s*Type\\s+(\\w+)', re.IGNORECASE)
328 re_Builtin = re.compile(b'^(\\s*)LaTeXBuiltin\\s+(\\w*)', re.IGNORECASE)
329 re_True = re.compile(b'^\\s*(?:true|1)\\s*$', re.IGNORECASE)
330 re_InsetLayout = re.compile(b'^\\s*InsetLayout\\s+(?:Custom|CharStyle|Element):(\\S+)\\s*$', re.IGNORECASE)
331 re_ResetsFont = re.compile(b'^(\\s*)ResetsFont(\\s+)(\\S+)$', re.IGNORECASE)
333 re_QInsetLayout = re.compile(b'^\\s*InsetLayout\\s+"(?:Custom|CharStyle|Element):([^"]+)"\\s*$', re.IGNORECASE)
334 re_InsetLayout_CopyStyle = re.compile(b'^\\s*CopyStyle\\s+(?:Custom|CharStyle|Element):(\\S+)\\s*$', re.IGNORECASE)
335 re_QInsetLayout_CopyStyle = re.compile(b'^\\s*CopyStyle\\s+"(?:Custom|CharStyle|Element):([^"]+)"\\s*$', re.IGNORECASE)
336 re_NeedsFloatPkg = re.compile(b'^(\\s*)NeedsFloatPkg\\s+(\\w+)\\s*$', re.IGNORECASE)
337 re_Fill = re.compile(b'^\\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
338 re_InsetLayout2 = re.compile(b'^\\s*InsetLayout\\s+(\\S+)\\s*$', re.IGNORECASE)
340 re_QInsetLayout2 = re.compile(b'^\\s*InsetLayout\\s+"([^"]+)"\\s*$', re.IGNORECASE)
341 re_IsFlex = re.compile(b'\\s*LyXType.*$', re.IGNORECASE)
342 re_CopyStyle2 = re.compile(b'(\\s*CopyStyle\\s+)"?([^"]+)"?\\s*$')
343 re_Separator = re.compile(b'^(?:(-*)|(\\s*))(Separator|EndOfSlide)(?:(-*)|(\\s*))$', re.IGNORECASE)
345 re_Declaration = re.compile(b'^#\\s*\\Declare\\w+Class.*$')
346 re_ExtractCategory = re.compile(b'^(#\\s*\\Declare\\w+Class(?:\\[[^]]*?\\])?){([^(]+?)\\s+\\(([^)]+?)\\)\\s*}\\s*$')
347 ConvDict = {"article": "Articles", "book" : "Books", "letter" : "Letters", "report": "Reports", \
348 "presentation" : "Presentations", "curriculum vitae" : "Curricula Vitae", "handout" : "Handouts"}
350 re_OptArgs = re.compile(b'^(\\s*)OptionalArgs(\\s+)(\\d+)\\D*$', re.IGNORECASE)
351 re_ReqArgs = re.compile(b'^(\\s*)RequiredArgs(\\s+)(\\d+)\\D*$', re.IGNORECASE)
353 # various changes associated with changing how chapters are handled
354 re_LabelTypeIsCounter = re.compile(b'^(\\s*)LabelType(\\s*)Counter\\s*$', re.IGNORECASE)
355 re_TopEnvironment = re.compile(b'^(\\s*)LabelType(\\s+)Top_Environment\\s*$', re.IGNORECASE)
356 re_CenteredEnvironment = re.compile(b'^(\\s*)LabelType(\\s+)Centered_Top_Environment\\s*$', re.IGNORECASE)
357 re_ChapterStyle = re.compile(b'^\\s*Style\\s+Chapter\\s*$', re.IGNORECASE)
358 re_InsetLayout_CaptionLTNN = re.compile(b'^(\\s*InsetLayout\\s+)(Caption:LongTableNonumber)', re.IGNORECASE)
360 re_trimLabelString = re.compile(b'^(\\s*LabelString\s+)"\\s*(.*?)\\s*"\\s*$')
361 re_trimLabelStringAppendix = re.compile(b'^(\\s*LabelStringAppendix\s+)"\\s*(.*?)\\s*"\\s*$')
362 re_trimEndLabelString = re.compile(b'^(\\s*EndLabelString\s+)"\\s*(.*?)\\s*"\\s*$')
363 re_trimLabelCounter = re.compile(b'^(\\s*LabelCounter\s+)"\\s*(.*?)\\s*"\\s*$')
366 # counters for sectioning styles (hardcoded in 1.3)
367 counters = {b"part" : b"\\Roman{part}",
368 b"chapter" : b"\\arabic{chapter}",
369 b"section" : b"\\arabic{section}",
370 b"subsection" : b"\\arabic{section}.\\arabic{subsection}",
371 b"subsubsection" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
372 b"paragraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
373 b"subparagraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
375 # counters for sectioning styles in appendix (hardcoded in 1.3)
376 appendixcounters = {b"chapter" : b"\\Alph{chapter}",
377 b"section" : b"\\Alph{section}",
378 b"subsection" : b"\\arabic{section}.\\arabic{subsection}",
379 b"subsubsection" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
380 b"paragraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
381 b"subparagraph" : b"\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
383 # Value of TocLevel for sectioning styles
384 toclevels = {b"part" : -1,
388 b"subsubsection" : 3,
398 labelstringappendix = b""
400 labelstring_line = -1
401 labelstringappendix_line = -1
414 isflexlayout = False # only used for 48 -> 49
415 # Whether a style is inherited (works only for CopyStyle currently,
416 # not for true inherited styles, see bug 8920
417 inherited = False # only used for 48 -> 49
418 resetsfont_found = False # only used for 48 -> 49
420 while i < len(lines):
421 # Skip comments and empty lines
422 if (re_Comment.match(lines[i]) or re_Empty.match(lines[i])):
423 # We need to deal with this conversion here, because it happens
424 # inside the initial comment block.
425 if only_comment and format == 39:
426 match = re_ExtractCategory.match(lines[i])
428 lpre = match.group(1)
429 lcat = match.group(2)
430 lnam = match.group(3)
432 lcat = ConvDict[lcat]
433 lines[i] = lpre + b"{" + lnam + b"}"
434 lines.insert(i+1, b"# \\DeclareCategory{" + lcat + b"}")
439 # insert file format if not already there
441 match = re_Format.match(lines[i])
444 format = int(match.group(4))
445 if format > 1 and format < end_format:
446 lines[i] = b"Format %d" % (format + 1)
448 elif format == end_format:
452 error('Cannot convert file format %s to %s' % (format, end_format))
454 lines.insert(i, b"Format 2")
458 # Don't get confused by LaTeX code
459 if re_Preamble.match(lines[i]):
461 while i < len(lines) and not re_EndPreamble.match(lines[i]):
464 if re_LangPreamble.match(lines[i]):
466 while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
469 if re_BabelPreamble.match(lines[i]):
471 while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
481 match = re.compile(b'(\\s*Color\\s+)(\\w+)', re.IGNORECASE).match(lines[i])
486 if col == "collapsable":
487 lines[i] = match.group(1) + "collapsible"
492 for r in (re_trimLabelString, re_trimLabelStringAppendix,\
493 re_trimEndLabelString, re_trimLabelCounter):
494 m = r.match(lines[i])
496 lines[i] = m.group(1) + b'"' + m.group(2) + b'"'
500 if format >= 60 and format <= 62:
506 match = re_InsetLayout_CaptionLTNN.match(lines[i])
510 # '^(\s*InsetLayout\s+)(Caption:LongTableNonumber)'
511 lead = match.group(1)
512 lines[i] = lead + b"Caption:Unnumbered"
522 match = re_IfStyle.match(lines[i])
526 # b'^(\\s*)IfStyle(\\s+\\S+)
527 lead = match.group(1)
528 trail = match.group(2)
529 lines[i] = lead + b"ModifyStyle" + trail
533 if format >= 50 and format <= 56:
541 # delete separator styles
542 match = re_Style.match(lines[i])
544 style = match.group(4).lower()
545 if re_Separator.match(style):
547 while i < len(lines) and not re_End.match(lines[i]):
548 separator.append(lines[i])
551 error('Incomplete separator style.')
556 # delete undefinition of separator styles
557 match = re_NoStyle.match(lines[i])
559 style = match.group(4).lower()
560 if re_Separator.match(style):
564 # replace the CopyStyle statement with the definition of the real
565 # style. This may result in duplicate statements, but that is OK
566 # since the second one will overwrite the first one.
567 match = re_CopyStyle.match(lines[i])
569 style = match.group(4).lower()
570 if re_Separator.match(style):
571 if len(separator) > 0:
572 lines[i:i+1] = separator
574 # FIXME: If this style was redefined in an include file,
575 # we should replace the real style and not this default.
576 lines[i:i+1] = [b' Category MainText',
579 b' LatexType Paragraph',
583 b' LabelType Static',
584 b' LabelString "--- Separate Environment ---"',
596 # The default of ResetsFont in LyX changed from true to false,
597 # because it is now used for all InsetLayouts, not only flex ones.
598 # Therefore we need to set it to true for all flex insets which do
599 # do not already have a ResetsFont.
600 match = re_InsetLayout2.match(lines[i])
605 name = match.group(1).lower()
606 if name != b"flex" and name != b"\"flex\"" and name[0:5] != b"flex:" and name [0:6] != b"\"flex:":
610 resetsfont_found = False
613 while i < len(lines):
614 match = re_ResetsFont.match(lines[i])
616 resetsfont_found = True
618 match = re_CopyStyle.match(lines[i])
622 match = re_End.match(lines[i])
626 if not resetsfont_found and not inherited:
627 lines.insert(i, b"\tResetsFont true")
631 if format >= 44 and format <= 47:
637 match = re_LabelTypeIsCounter.match(lines[i])
640 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Above"
642 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Static"
644 match = re_TopEnvironment.match(lines[i])
646 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Above"
648 match = re_CenteredEnvironment.match(lines[i])
650 lines[i] = match.group(1) + b"LabelType" + match.group(2) + b"Centered"
653 match = re_Style.match(lines[i])
657 match = re_ChapterStyle.match(lines[i])
665 if lines[i] == b"InsetLayout Caption":
666 lines[i] = b"InsetLayout Caption:Standard"
676 # reset counters on Style beginning
677 match = re_Style.match(lines[i])
683 match = re_OptArgs.match(lines[i])
685 # Save number of optional arguments
686 space1 = match.group(1)
687 opts = int(match.group(3))
688 # OptionalArgs 0 > ResetArgs 1
690 lines[i] = space1 + b"ResetArgs\t1"
695 match = re_ReqArgs.match(lines[i])
697 # Save number of required arguments
698 space1 = match.group(1)
699 reqs = int(match.group(3))
702 # Insert the required number of arguments at the end of the style definition
703 match = re_End.match(lines[i])
706 # First the optionals (this is the required order pre 2.1)
709 newarg = [ b'%sArgument 1' % (space1),
710 b'%s\tLabelString\t\"Optional Layout Argument\"' % (space1),
711 b'%sEndArgument' % (space1)]
714 while actopt < (opts + 1):
715 newarg += [ b'%sArgument %d' % (space1, actopt),
716 b'%s\tLabelString\t\"Optional Layout Argument %d\"' % (space1, actopt),
717 b'%sEndArgument' % (space1)]
719 # Now the mandatories
722 while actopt < (opts + reqs + 1):
723 newarg += [ b'%sArgument %d' % (space1, actopt),
724 b'%s\tLabelString\t"Required Layout Argument %d"' % (space1, actopt - opts),
725 b'%s\tMandatory\t1' % (space1),
726 b'%sEndArgument' % (space1)]
728 # Since we replace the "End" line, re-add this line
731 lines[i:i+1] = newarg
740 # There is a conversion with format 40, but it is done within the
741 # initial comment block and so is above.
745 if format == 37 or format == 38:
750 match = re_CiteFormat.match(lines[i]);
751 if match and match.group(4) == b"":
752 lines[i] = match.group(0) + b" default"
761 match = re_QInsetLayout2.match(lines[i])
763 match = re_InsetLayout2.match(lines[i])
765 match = re_CopyStyle2.match(lines[i])
769 style = match.group(2)
771 if flexstyles.count(style):
772 lines[i] = match.group(1) + b"\"Flex:" + style + b"\""
776 name = match.group(1)
777 names = name.split(b":", 1)
778 if len(names) > 1 and names[0] == b"Flex":
783 for j in range(i + 1, len(lines)):
784 if re_IsFlex.match(lines[j]):
787 if re_End.match(lines[j]):
791 flexstyles.append(name)
792 lines[i] = b"InsetLayout \"Flex:" + name + b"\""
798 m = re_Fill.match(lines[i])
805 match = re_NeedsFloatPkg.match(lines[i])
807 space = match.group(1)
809 lines[i] = space + b"UsesFloatPkg " + val
811 if val == b'1' or val.lower() == b'true':
813 lines.insert(i, space + b"IsPredefined " + newval)
819 if format >= 29 and format <= 31:
824 match = re_InsetLayout.match(lines[i])
826 lines[i] = b"InsetLayout Flex:" + match.group(1)
828 match = re_QInsetLayout.match(lines[i])
830 lines[i] = b"InsetLayout \"Flex:" + match.group(1) + b"\""
832 match = re_InsetLayout_CopyStyle.match(lines[i])
834 lines[i] = b"\tCopyStyle Flex:" + match.group(1)
836 match = re_QInsetLayout_CopyStyle.match(lines[i])
838 lines[i] = b"\tCopyStyle \"Flex:" + match.group(1) + b"\""
843 if format >= 24 and format <= 27:
848 match = re_Float.match(lines[i])
852 # we need to do two things:
853 # (i) Convert Builtin to NeedsFloatPkg
854 # (ii) Write ListCommand lines for the builtin floats table and figure
857 while True and i < len(lines):
858 m1 = re_End.match(lines[i])
861 line = b" ListCommand " + cmd
862 lines.insert(i, line)
865 m2 = re_Builtin.match(lines[i])
871 if re_True.match(arg):
875 lines[i] = ws1 + b"NeedsFloatPkg " + newarg
876 m3 = re_Type.match(lines[i])
879 fltype = fltype.lower()
880 if fltype == b"table":
881 cmd = b"listoftables"
882 elif fltype == b"figure":
883 cmd = b"listoffigures"
884 # else unknown, which is why we're doing this
888 # This just involved new features, not any changes to old ones
889 if format >= 14 and format <= 22:
893 # Rename I18NPreamble to BabelPreamble
895 match = re_I18nPreamble.match(lines[i])
897 lines[i] = match.group(1) + b"BabelPreamble"
899 match = re_EndI18nPreamble.match(lines[i])
900 while i < len(lines) and not match:
902 match = re_EndI18nPreamble.match(lines[i])
903 lines[i] = match.group(1) + b"EndBabelPreamble"
907 # These just involved new features, not any changes to old ones
908 if format == 11 or format == 12:
913 match = re_UseMod.match(lines[i])
915 module = match.group(1)
916 lines[i] = b"DefaultModule " + module
921 match = re_Counter.match(lines[i])
925 while i < len(lines):
926 namem = re_Name.match(lines[i])
928 name = namem.group(1)
930 lines[counterline] = b"Counter %s" % name
931 # we don't need to increment i
933 endem = re_End.match(lines[i])
942 # We want to scan for ams-type includes and, if we find them,
943 # add corresponding UseModule tags to the layout.
944 match = re_AMSMaths.match(lines[i])
946 addstring(b"theorems-ams", usemodules)
947 addstring(b"theorems-ams-extended", usemodules)
948 addstring(b"theorems-sec", usemodules)
951 match = re_AMSMathsPlain.match(lines[i])
953 addstring(b"theorems-starred", usemodules)
956 match = re_AMSMathsSeq.match(lines[i])
958 addstring(b"theorems-ams", usemodules)
959 addstring(b"theorems-ams-extended", usemodules)
965 # These just involved new features, not any changes to old ones
966 if format >= 5 and format <= 7:
971 # Handle conversion to long CharStyle names
972 match = re_CharStyle.match(lines[i])
974 lines[i] = b"InsetLayout CharStyle:%s" % (match.group(3))
976 lines.insert(i, b"\tLyXType charstyle")
979 lines[i] = b"\tLabelString %s" % (match.group(3))
984 # convert 'providesamsmath x', 'providesmakeidx x', 'providesnatbib x', 'providesurl x' to
985 # 'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
987 match = re_Provides.match(lines[i])
989 lines[i] = b"%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
990 match.group(3), match.group(4))
997 # delete caption styles
998 match = re_Style.match(lines[i])
1000 style = match.group(4).lower()
1001 if style == b"caption":
1003 while i < len(lines) and not re_End.match(lines[i]):
1004 caption.append(lines[i])
1007 error('Incomplete caption style.')
1012 # delete undefinition of caption styles
1013 match = re_NoStyle.match(lines[i])
1015 style = match.group(4).lower()
1016 if style == b"caption":
1020 # replace the CopyStyle statement with the definition of the real
1021 # style. This may result in duplicate statements, but that is OK
1022 # since the second one will overwrite the first one.
1023 match = re_CopyStyle.match(lines[i])
1025 style = match.group(4).lower()
1026 if style == b"caption":
1027 if len(caption) > 0:
1028 lines[i:i+1] = caption
1030 # FIXME: This style comes from an include file, we
1031 # should replace the real style and not this default.
1032 lines[i:i+1] = [b' Margin First_Dynamic',
1033 b' LatexType Command',
1034 b' LatexName caption',
1040 b' AlignPossible Center',
1041 b' LabelType Sensitive',
1042 b' LabelString "Senseless!"',
1051 # Delete MaxCounter and remember the value of it
1052 match = re_MaxCounter.match(lines[i])
1054 level = match.group(4).lower()
1055 if level == b"counter_chapter":
1057 elif level == b"counter_section":
1059 elif level == b"counter_subsection":
1061 elif level == b"counter_subsubsection":
1063 elif level == b"counter_paragraph":
1065 elif level == b"counter_subparagraph":
1067 elif level == b"counter_enumi":
1069 elif level == b"counter_enumii":
1071 elif level == b"counter_enumiii":
1078 # LabelType Counter_EnumI
1083 # LabelCounter EnumI
1085 match = re_LabelType.match(lines[i])
1087 label = match.group(4)
1088 # Remember indenting space for later reuse in added lines
1089 space1 = match.group(1)
1090 # Remember the line for adding the LabelCounter later.
1091 # We can't do it here because it could shift latextype_line etc.
1093 if label[:8].lower() == b"counter_":
1094 counter = label[8:].lower()
1095 lines[i] = re_LabelType.sub(b'\\1\\2\\3Counter', lines[i])
1097 # Remember the LabelString line
1098 match = re_LabelString.match(lines[i])
1100 labelstring = match.group(4)
1101 labelstring_line = i
1103 # Remember the LabelStringAppendix line
1104 match = re_LabelStringAppendix.match(lines[i])
1106 labelstringappendix = match.group(4)
1107 labelstringappendix_line = i
1109 # Remember the LatexType line
1110 match = re_LatexType.match(lines[i])
1112 latextype = match.group(4).lower()
1115 # Remember the TocLevel line
1116 match = re_TocLevel.match(lines[i])
1118 toclevel = match.group(4).lower()
1120 # Reset variables at the beginning of a style definition
1121 match = re_Style.match(lines[i])
1123 style = match.group(4).lower()
1129 labelstringappendix = b""
1130 labelstring_line = -1
1131 labelstringappendix_line = -1
1136 if re_End.match(lines[i]):
1138 # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
1139 # (or change the existing LatexType)
1140 if label.lower() == b"bibliography":
1141 if (latextype_line < 0):
1142 lines.insert(i, b"%sLatexType Bib_Environment" % space1)
1145 lines[latextype_line] = re_LatexType.sub(b'\\1\\2\\3Bib_Environment', lines[latextype_line])
1147 # Change "LabelType Static" to "LabelType Itemize" for itemize environments
1148 if latextype == b"item_environment" and label.lower() == b"static":
1149 lines[labeltype_line] = re_LabelType.sub(b'\\1\\2\\3Itemize', lines[labeltype_line])
1151 # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
1152 if latextype == b"item_environment" and label.lower() == b"counter_enumi":
1153 lines[labeltype_line] = re_LabelType.sub(b'\\1\\2\\3Enumerate', lines[labeltype_line])
1154 # Don't add the LabelCounter line later
1159 # LabelString "Chapter"
1163 # LabelString "Chapter \arabic{chapter}"
1165 # if this style has a counter. Ditto for LabelStringAppendix.
1166 # This emulates the hardcoded article style numbering of 1.3
1169 if style in counters:
1170 if labelstring_line < 0:
1171 lines.insert(i, b'%sLabelString "%s"' % (space1, counters[style]))
1174 new_labelstring = concatenate_label(labelstring, counters[style])
1175 lines[labelstring_line] = re_LabelString.sub(
1176 b'\\1\\2\\3%s' % new_labelstring.replace(b"\\", b"\\\\"),
1177 lines[labelstring_line])
1178 if style in appendixcounters:
1179 if labelstringappendix_line < 0:
1180 lines.insert(i, b'%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
1183 new_labelstring = concatenate_label(labelstring, appendixcounters[style])
1184 lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
1185 b'\\1\\2\\3%s' % new_labelstring.replace(b"\\", b"\\\\"),
1186 lines[labelstringappendix_line])
1188 # Now we can safely add the LabelCounter line
1189 lines.insert(labeltype_line + 1, b"%sLabelCounter %s" % (space1, counter))
1192 # Add the TocLevel setting for sectioning styles
1193 if toclevel == b"" and style in toclevels and maxcounter <= toclevels[style]:
1194 lines.insert(i, b'%s\tTocLevel %d' % (space1, toclevels[style]))
1200 lines.insert(i, b"Format 2")
1203 for mod in usemodules:
1204 lines.insert(i, b"UseModule " + mod)
1212 args["description"] = "Convert layout file <inputfile> to a newer format."
1214 parser = argparse.ArgumentParser(**args)
1216 parser.add_argument("-t", "--to", type=int, dest="format", default= currentFormat,
1217 help=("destination layout format, default %i (latest)") % currentFormat)
1218 parser.add_argument("input_file", nargs='?', type=cmd_arg, default=None,
1219 help="input file (default stdin)")
1220 parser.add_argument("output_file", nargs='?', type=cmd_arg, default=None,
1221 help="output file (default stdout)")
1223 options = parser.parse_args(argv[1:])
1226 if options.input_file:
1227 source = open(options.input_file, 'rb')
1231 if options.output_file:
1232 output = open(options.output_file, 'wb')
1236 if options.format > currentFormat:
1237 error("Format %i does not exist" % options.format);
1240 lines = read(source)
1242 while (format < options.format):
1243 format = convert(lines, options.format)
1244 write(output, lines)
1247 if options.input_file:
1249 if options.output_file:
1255 if __name__ == "__main__":