layout2layout.py

   1 # -*- coding: utf-8 -*-
   2
   3 # file layout2layout.py
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6
   7 # author Georg Baum
   8
   9 # Full author contact details are available in file CREDITS
  10
  11 # This script will update a .layout file to current format
  12
  13 # The latest layout format is also defined in src/TextClass.cpp
  14 currentFormat = 60
  15
  16
  17 # Incremented to format 4, 6 April 2007, lasgouttes
  18 # Introduction of generic "Provides" declaration
  19
  20 # Incremented to format 5, 22 August 2007 by vermeer
  21 # InsetLayout material
  22
  23 # Incremented to format 6, 7 January 2008 by spitz
  24 # Requires tag added to layout files
  25
  26 # Incremented to format 7, 24 March 2008 by rgh
  27 # AddToPreamble tag added to layout files
  28
  29 # Incremented to format 8, 25 July 2008 by rgh
  30 # UseModule tag added to layout files
  31 # CopyStyle added to InsetLayout
  32
  33 # Incremented to format 9, 5 October 2008 by rgh
  34 # ForcePlain and CustomPars tags added to InsetLayout
  35
  36 # Incremented to format 10, 6 October 2008 by rgh
  37 # Change format of counters
  38
  39 # Incremented to format 11, 14 October 2008 by rgh
  40 # Add ProvidesModule, ExcludesModule tags
  41
  42 # Incremented to format 12, 10 January 2009 by gb
  43 # Add I18NPreamble tag
  44
  45 # Incremented to format 13, 5 February 2009 by rgh
  46 # Add InToc tag for InsetLayout
  47
  48 # Incremented to format 14, 14 February 2009 by gb
  49 # Rename I18NPreamble to BabelPreamble and add LangPreamble
  50
  51 # Incremented to format 15, 28 May 2009 by lasgouttes
  52 # Add new tag OutputFormat; modules can be conditioned on feature
  53 # "from->to".
  54
  55 # Incremented to format 16, 5 June 2009 by rgh
  56 # Add new tags for Text Class:
  57 #   HTMLPreamble, HTMLAddToPreamble
  58 # For Layout:
  59 #   HTMLTag, HTMLAttr, HTMLLabel, HTMLLabelAttr, HTMLItem, HTMLItemAttr
  60 #   HTMLStyle, and HTMLPreamble
  61 # For InsetLayout:
  62 #   HTMLTag, HTMLAttr, HTMLStyle, and HTMLPreamble
  63 # For Floats:
  64 #   HTMLType, HTMLClass, HTMLStyle
  65
  66 # Incremented to format 17, 12 August 2009 by rgh
  67 # Add IfStyle and IfCounter tags for layout.
  68
  69 # Incremented to format 18, 27 October 2009 by rgh
  70 # Added some new tags for HTML output.
  71
  72 # Incremented to format 19, 17 November 2009 by rgh
  73 # Added InPreamble tag.
  74
  75 # Incremented to format 20, 17 December 2009 by rgh
  76 # Added ContentAsLabel tag.
  77
  78 # Incremented to format 21, 12 January 2010 by rgh
  79 # Added HTMLTocLayout and HTMLTitle tags.
  80
  81 # Incremented to format 22, 20 January 2010 by rgh
  82 # Added HTMLFormat tag to Counters.
  83
  84 # Incremented to format 23, 13 February 2010 by spitz
  85 # Added Spellcheck tag.
  86
  87 # Incremented to format 24, 5 March 2010 by rgh
  88 # Changed LaTeXBuiltin tag to NeedsFloatPkg and
  89 # added new tag ListCommand.
  90
  91 # Incremented to format 25, 12 March 2010 by rgh
  92 # Added RefPrefix tag for layouts and floats.
  93
  94 # Incremented to format 26, 29 March 2010 by rgh
  95 # Added CiteFormat.
  96
  97 # Incremented to format 27, 4 June 2010 by rgh
  98 # Added RequiredArgs tag.
  99
 100 # Incremented to format 28, 6 August 2010 by lasgouttes
 101 # Added ParbreakIsNewline tag for Layout and InsetLayout.
 102
 103 # Incremented to format 29, 10 August 2010 by rgh
 104 # Changed Custom:Style, CharStyle:Style, and Element:Style
 105 # uniformly to Flex:Style.
 106
 107 # Incremented to format 30, 13 August 2010 by rgh
 108 # Introduced ResetsFont tag for InsetLayout.
 109
 110 # Incremented to format 31, 12 January 2011 by rgh
 111 # Introducted NoCounter tag.
 112
 113 # Incremented to format 32, 30 January 2011 by forenr
 114 # Added Display tag for InsetLayout
 115
 116 # Incremented to format 33, 2 February 2011 by rgh
 117 # Changed NeedsFloatPkg to UsesFloatPkg
 118
 119 # Incremented to format 34, 28 March 2011 by rgh
 120 # Remove obsolete Fill_(Top|Bottom) tags
 121
 122 # Incremented to format 35, 28 March 2011 by rgh
 123 # Try to add "Flex:" to any flex insets that don't have it.
 124
 125 # Incremented to format 36, 7 December 2011, by rgh
 126 # Added HTMLStyles and AddToHTMLStyles tags.
 127
 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).
 131
 132 # Incremented to format 38, 08 April 2012 by gb
 133 # Introduce LangPreamble and BabelPreamble for InsetLayout.
 134
 135 # Incremented to format 39, 15 April 2012 by sanda
 136 # Introduce styling of branches via "InsetLayout Branch:".
 137
 138 # Incremented to format 40, 10 October 2012 by rgh
 139 # Re-do layout names for layout categories
 140
 141 # Incremented to format 41, 20 November 2012 by spitz
 142 # New Argument syntax
 143
 144 # Incremented to format 42, 22 December 2012 by spitz
 145 # New Style tag "ItemCommand"
 146
 147 # Incremented to format 43, 30 December 2012 by spitz
 148 # Extended InsetCaption format
 149
 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
 153
 154 # Incremented to format 45, 12 February 2013 by rgh
 155 # New Tag "NoInsetLayout"
 156
 157 # Incremented to format 46, 15 May 2013 by gb
 158 # New Tag "ForceLocal"
 159
 160 # Incremented to format 47, 23 May 2013 by rgh
 161 # Add PackageOptions tag
 162
 163 # Incremented to format 48, 31 May 2013 by rgh
 164 # Add InitialValue tag for counters
 165
 166 # Incremented to format 49, 10 Feb 2014 by gb
 167 # Change default of "ResetsFont" tag to false
 168
 169 # Incremented to format 50, 9 May 2014 by forenr
 170 # Removal of "Separator" layouts
 171
 172 # Incremented to format 51, 29 May 2014 by spitz
 173 # New Style tag "ToggleIndent"
 174
 175 # Incremented to format 52, 1 December 2014 by spitz
 176 # New InsetLayout tag "ForceOwnlines"
 177
 178 # Incremented to format 53, 7 December 2014 by spitz
 179 # New InsetLayout tag "ObsoletedBy"
 180
 181 # Incremented to format 54, 11 Jan 2014 by gb
 182 # New InsetLayout tag "FixedWidthPreambleEncoding"
 183
 184 # Incremented to format 55, 20 April 2015 by spitz
 185 # New InsetLayout and Layout tags "PassThruChars"
 186
 187 # Incremented to format 56, 20 May 2015 by spitz
 188 # New Float tags "AllowedPlacement", "AllowsWide", "AllowsSideways"
 189
 190 # Incremented to format 57, 30 May 2015 by spitz
 191 # New Layout tag "ParagraphGroup"
 192
 193 # Incremented to format 58, 5 December 2015, by rgh
 194 # New Layout tag "ProvideStyle"
 195 # Change "IfStyle" to "ModifyStyle"
 196
 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"
 201
 202 # Incremented to format 60, 25 March 2016 by lasgouttes
 203 # Rename caption subtype LongTableNoNumber to Unnumbered
 204
 205 # Do not forget to document format change in Customization
 206 # Manual (section "Declaring a new text class").
 207
 208 # You might also want to consider running the
 209 # development/tools/updatelayouts.py script to update all
 210 # layout files to the new format.
 211
 212
 213 import os, re, string, sys
 214 import argparse
 215
 216 # Provide support for both python 2 and 3
 217 # (copied from lyx2lyx)
 218 PY2 = sys.version_info[0] == 2
 219 if PY2:
 220     # argparse returns strings in the commandline encoding, we need to convert.
 221     # sys.getdefaultencoding() would not always be correct, see
 222     # http://legacy.python.org/dev/peps/pep-0383/
 223     def cmd_arg(arg):
 224         return arg.decode(sys.getfilesystemencoding())
 225 else:
 226     cmd_arg = str
 227 # End of code to support for both python 2 and 3
 228
 229
 230 def error(message):
 231     sys.stderr.write(message + '\n')
 232     sys.exit(1)
 233
 234
 235 def trim_bom(line):
 236     " Remove byte order mark."
 237     if line[0:3] == "\357\273\277":
 238         return line[3:]
 239     else:
 240         return line
 241
 242
 243 def read(source):
 244     " Read input file and strip lineendings."
 245     lines = source.read().splitlines() or ['']
 246     lines[0] = trim_bom(lines[0])
 247     return lines
 248
 249
 250 def write(output, lines):
 251     " Write output file with native lineendings."
 252     output.write(os.linesep.join(lines) + os.linesep)
 253
 254
 255 # Concatenates old and new in an intelligent way:
 256 # If old is wrapped in ", they are stripped. The result is wrapped in ".
 257 def concatenate_label(old, new):
 258     # Don't use strip as long as we support python 1.5.2
 259     if old[0] == '"':
 260         return old[0:-1] + new + '"'
 261     else:
 262         return '"' + old + new + '"'
 263
 264 # appends a string to a list unless it's already there
 265 def addstring(s, l):
 266     if l.count(s) > 0:
 267         return
 268     l.append(s)
 269
 270
 271 def convert(lines, end_format):
 272     " Convert to new format."
 273     re_Comment = re.compile(r'^(\s*)#')
 274     re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
 275     re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
 276     re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
 277     re_Empty = re.compile(r'^(\s*)$')
 278     re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
 279     re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
 280     re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
 281     re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
 282     re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
 283     re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
 284     re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
 285     re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
 286     re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
 287     re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 288     re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 289     re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
 290     re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
 291     re_IfStyle = re.compile(r'^(\s*)IfStyle(\s+\S+)', re.IGNORECASE)
 292     re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
 293     re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
 294     re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
 295     re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
 296     re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
 297     re_CiteFormat = re.compile(r'^(\s*)(CiteFormat)(?:(\s*)()|(\s+)(default|authoryear|numerical))', re.IGNORECASE)
 298     re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
 299     re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
 300     re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
 301     re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
 302     re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
 303     re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
 304     re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
 305     re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
 306     re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
 307     re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
 308     re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
 309     re_ResetsFont = re.compile(r'^(\s*)ResetsFont(\s+)(\S+)$', re.IGNORECASE)
 310     # with quotes
 311     re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
 312     re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
 313     re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
 314     re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
 315     re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
 316     re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
 317     # with quotes
 318     re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
 319     re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
 320     re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
 321     re_Separator = re.compile(r'^(?:(-*)|(\s*))(Separator|EndOfSlide)(?:(-*)|(\s*))$', re.IGNORECASE)
 322     # for categories
 323     re_Declaration = re.compile(r'^#\s*\\Declare\w+Class.*$')
 324     re_ExtractCategory = re.compile(r'^(#\s*\\Declare\w+Class(?:\[[^]]*?\])?){([^(]+?)\s+\(([^)]+?)\)\s*}\s*$')
 325     ConvDict = {"article": "Articles", "book" : "Books", "letter" : "Letters", "report": "Reports", \
 326                 "presentation" : "Presentations", "curriculum vitae" : "Curricula Vitae", "handout" : "Handouts"}
 327     # Arguments
 328     re_OptArgs = re.compile(r'^(\s*)OptionalArgs(\s+)(\d+)\D*$', re.IGNORECASE)
 329     re_ReqArgs = re.compile(r'^(\s*)RequiredArgs(\s+)(\d+)\D*$', re.IGNORECASE)
 330
 331     # various changes associated with changing how chapters are handled
 332     re_LabelTypeIsCounter = re.compile(r'^(\s*)LabelType(\s*)Counter\s*$', re.IGNORECASE)
 333     re_TopEnvironment = re.compile(r'^(\s*)LabelType(\s+)Top_Environment\s*$', re.IGNORECASE)
 334     re_CenteredEnvironment = re.compile(r'^(\s*)LabelType(\s+)Centered_Top_Environment\s*$', re.IGNORECASE)
 335     re_ChapterStyle = re.compile(r'^\s*Style\s+Chapter\s*$', re.IGNORECASE)
 336     re_InsetLayout_CaptionLTNN = re.compile(r'^(\s*InsetLayout\s+)(Caption:LongTableNonumber)', re.IGNORECASE)
 337
 338
 339     # counters for sectioning styles (hardcoded in 1.3)
 340     counters = {"part"          : "\\Roman{part}",
 341                 "chapter"       : "\\arabic{chapter}",
 342                 "section"       : "\\arabic{section}",
 343                 "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 344                 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 345                 "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 346                 "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 347
 348     # counters for sectioning styles in appendix (hardcoded in 1.3)
 349     appendixcounters = {"chapter"       : "\\Alph{chapter}",
 350                         "section"       : "\\Alph{section}",
 351                         "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 352                         "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 353                         "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 354                         "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 355
 356     # Value of TocLevel for sectioning styles
 357     toclevels = {"part"          : -1,
 358                  "chapter"       : 0,
 359                  "section"       : 1,
 360                  "subsection"    : 2,
 361                  "subsubsection" : 3,
 362                  "paragraph"     : 4,
 363                  "subparagraph"  : 5}
 364
 365     i = 0
 366     only_comment = 1
 367     counter = ""
 368     toclevel = ""
 369     label = ""
 370     labelstring = ""
 371     labelstringappendix = ""
 372     space1 = ""
 373     labelstring_line = -1
 374     labelstringappendix_line = -1
 375     labeltype_line = -1
 376     latextype = ""
 377     latextype_line = -1
 378     style = ""
 379     maxcounter = 0
 380     format = 1
 381     formatline = 0
 382     usemodules = []
 383     flexstyles = []
 384     opts = 0
 385     reqs = 0
 386     inchapter = False
 387     isflexlayout = False         # only used for 48 -> 49
 388     # Whether a style is inherited (works only for CopyStyle currently,
 389     # not for true inherited styles, see bug 8920
 390     inherited = False        # only used for 48 -> 49
 391     resetsfont_found = False # only used for 48 -> 49
 392
 393     while i < len(lines):
 394         # Skip comments and empty lines
 395         if (re_Comment.match(lines[i]) or re_Empty.match(lines[i])):
 396           # We need to deal with this conversion here, because it happens
 397           # inside the initial comment block.
 398           if only_comment and format == 39:
 399               match = re_ExtractCategory.match(lines[i])
 400               if match:
 401                   lpre = match.group(1)
 402                   lcat = match.group(2)
 403                   lnam = match.group(3)
 404                   if lcat in ConvDict:
 405                       lcat = ConvDict[lcat]
 406                   lines[i] = lpre + "{" + lnam + "}"
 407                   lines.insert(i+1, "#  \\DeclareCategory{" + lcat + "}")
 408                   i += 1
 409           i += 1
 410           continue
 411
 412         # insert file format if not already there
 413         if (only_comment):
 414             match = re_Format.match(lines[i])
 415             if match:
 416                 formatline = i
 417                 format = int(match.group(4))
 418                 if format > 1 and format < end_format:
 419                     lines[i] = "Format %d" % (format + 1)
 420                     only_comment = 0
 421                 elif format == end_format:
 422                     # nothing to do
 423                     return format
 424                 else:
 425                     error('Cannot convert file format %s to %s' % (format, end_format))
 426             else:
 427                 lines.insert(i, "Format 2")
 428                 only_comment = 0
 429                 continue
 430
 431         # Don't get confused by LaTeX code
 432         if re_Preamble.match(lines[i]):
 433             i += 1
 434             while i < len(lines) and not re_EndPreamble.match(lines[i]):
 435                 i += 1
 436             continue
 437         if re_LangPreamble.match(lines[i]):
 438             i += 1
 439             while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
 440                 i += 1
 441             continue
 442         if re_BabelPreamble.match(lines[i]):
 443             i += 1
 444             while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
 445                 i += 1
 446             continue
 447
 448         if format == 59:
 449             match = re_InsetLayout_CaptionLTNN.match(lines[i])
 450             if not match:
 451                 i += 1
 452                 continue
 453             # '^(\s*InsetLayout\s+)(Caption:LongTableNonumber)'
 454             lead  = match.group(1)
 455             lines[i] = lead + "Caption:Unnumbered"
 456             i += 1
 457             continue
 458
 459         if format == 58:
 460             # nothing to do.
 461             i += 1
 462             continue
 463
 464         if format == 57:
 465             match = re_IfStyle.match(lines[i])
 466             if not match:
 467                 i += 1
 468                 continue
 469             # r'^(\s*)IfStyle(\s+\S+)
 470             lead  = match.group(1)
 471             trail = match.group(2)
 472             lines[i] = lead + "ModifyStyle" + trail
 473             i += 1
 474             continue
 475
 476         if format >= 50 and format <= 56:
 477             # nothing to do.
 478             i += 1
 479             continue
 480
 481         if format == 49:
 482             separator = []
 483
 484             # delete separator styles
 485             match = re_Style.match(lines[i])
 486             if match:
 487                 style = string.lower(match.group(4))
 488                 if re_Separator.match(style):
 489                     del lines[i]
 490                     while i < len(lines) and not re_End.match(lines[i]):
 491                         separator.append(lines[i])
 492                         del lines[i]
 493                     if i == len(lines):
 494                         error('Incomplete separator style.')
 495                     else:
 496                         del lines[i]
 497                         continue
 498
 499             # delete undefinition of separator styles
 500             match = re_NoStyle.match(lines[i])
 501             if match:
 502                 style = string.lower(match.group(4))
 503                 if re_Separator.match(style):
 504                     del lines[i]
 505                     continue
 506
 507             # replace the CopyStyle statement with the definition of the real
 508             # style. This may result in duplicate statements, but that is OK
 509             # since the second one will overwrite the first one.
 510             match = re_CopyStyle.match(lines[i])
 511             if match:
 512                 style = string.lower(match.group(4))
 513                 if re_Separator.match(style):
 514                     if len(separator) > 0:
 515                         lines[i:i+1] = separator
 516                     else:
 517                         # FIXME: If this style was redefined in an include file,
 518                         # we should replace the real style and not this default.
 519                         lines[i:i+1] = ['       Category              MainText',
 520                                         '       KeepEmpty             1',
 521                                         '       Margin                Dynamic',
 522                                         '       LatexType             Paragraph',
 523                                         '       LatexName             dummy',
 524                                         '       ParIndent             MM',
 525                                         '       Align                 Block',
 526                                         '       LabelType             Static',
 527                                         '       LabelString           "--- Separate Environment ---"',
 528                                         '       LabelFont',
 529                                         '         Family              Roman',
 530                                         '         Series              Medium',
 531                                         '         Size                Normal',
 532                                         '         Color               Blue',
 533                                         '       EndFont',
 534                                         '       HTMLLabel             NONE']
 535             i += 1
 536             continue
 537
 538         if format == 48:
 539             # The default of ResetsFont in LyX changed from true to false,
 540             # because it is now used for all InsetLayouts, not only flex ones.
 541             # Therefore we need to set it to true for all flex insets which do
 542             # do not already have a ResetsFont.
 543             match = re_InsetLayout2.match(lines[i])
 544             if not match:
 545                 i += 1
 546                 continue
 547
 548             name = string.lower(match.group(1))
 549             if name != "flex" and name != "\"flex\"" and name[0:5] != "flex:" and name [0:6] != "\"flex:":
 550                 i += 1
 551                 continue
 552
 553             resetsfont_found = False
 554             inherited = False
 555             notdone = True
 556             while i < len(lines):
 557               match = re_ResetsFont.match(lines[i])
 558               if match:
 559                   resetsfont_found = True
 560               else:
 561                 match = re_CopyStyle.match(lines[i])
 562                 if match:
 563                   inherited = True
 564                 else:
 565                   match = re_End.match(lines[i])
 566                   if match:
 567                     break
 568               i += 1
 569             if not resetsfont_found and not inherited:
 570               lines.insert(i, "\tResetsFont true")
 571
 572             continue
 573
 574         if format >= 44 and format <= 47:
 575             # nothing to do.
 576             i += 1
 577             continue
 578
 579         if format == 43:
 580           match = re_LabelTypeIsCounter.match(lines[i])
 581           if match:
 582             if inchapter:
 583              lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
 584             else:
 585               lines[i] = match.group(1) + "LabelType" + match.group(2) + "Static"
 586
 587           match = re_TopEnvironment.match(lines[i])
 588           if match:
 589             lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
 590
 591           match = re_CenteredEnvironment.match(lines[i])
 592           if match:
 593             lines[i] = match.group(1) + "LabelType" + match.group(2) + "Centered"
 594
 595           if inchapter:
 596             match = re_Style.match(lines[i])
 597             if match:
 598               inchapter = False
 599           else:
 600             match = re_ChapterStyle.match(lines[i])
 601             if match:
 602               inchapter = True
 603
 604           i += 1
 605           continue
 606
 607         if format == 42:
 608           if lines[i] == "InsetLayout Caption":
 609             lines[i] = "InsetLayout Caption:Standard"
 610           i += 1
 611           continue
 612
 613         if format == 41:
 614             # nothing to do.
 615             i += 1
 616             continue
 617
 618         if format == 40:
 619             # reset counters on Style beginning
 620             match = re_Style.match(lines[i])
 621             if match:
 622                 opts = 0
 623                 reqs = 0
 624                 i += 1
 625                 continue
 626             match = re_OptArgs.match(lines[i])
 627             if match:
 628                 # Save number of optional arguments
 629                 space1 = match.group(1)
 630                 opts = int(match.group(3))
 631                 # OptionalArgs 0 > ResetArgs 1
 632                 if opts == 0:
 633                     lines[i] = space1 + "ResetArgs\t1"
 634                     i += 1
 635                 else:
 636                     del lines[i]
 637                 continue
 638             match = re_ReqArgs.match(lines[i])
 639             if match:
 640                 # Save number of required arguments
 641                 space1 = match.group(1)
 642                 reqs = int(match.group(3))
 643                 del lines[i]
 644                 continue
 645             # Insert the required number of arguments at the end of the style definition
 646             match = re_End.match(lines[i])
 647             if match:
 648                 newarg = ['']
 649                 # First the optionals (this is the required order pre 2.1)
 650                 if opts > 0:
 651                     if opts == 1:
 652                         newarg = [ '%sArgument 1' % (space1),
 653                                    '%s\tLabelString\t\"Optional Layout Argument\"' % (space1),
 654                                    '%sEndArgument' % (space1)]
 655                     elif opts > 1:
 656                         actopt = 1
 657                         while actopt < (opts + 1):
 658                             newarg += [ '%sArgument %d' % (space1, actopt),
 659                                '%s\tLabelString\t\"Optional Layout Argument %d\"' % (space1, actopt),
 660                                '%sEndArgument' % (space1)]
 661                             actopt += 1
 662                 # Now the mandatories
 663                 if reqs > 0:
 664                     actopt = opts + 1
 665                     while actopt < (opts +  reqs + 1):
 666                         newarg += [ '%sArgument %d' % (space1, actopt),
 667                            '%s\tLabelString\t"Required Layout Argument %d"' % (space1, actopt - opts),
 668                            '%s\tMandatory\t1' % (space1),
 669                            '%sEndArgument' % (space1)]
 670                         actopt += 1
 671                 # Since we replace the "End" line, re-add this line
 672                 if len(newarg) > 1:
 673                     newarg += ['End']
 674                     lines[i:i+1] = newarg
 675                     i += len(newarg)
 676                 # Reset the counters
 677                 opts = 0
 678                 reqs = 0
 679             i += 1
 680             continue
 681
 682         if format == 39:
 683             # There is a conversion with format 40, but it is done within the
 684             # initial comment block and so is above.
 685             i += 1
 686             continue
 687
 688         if format == 37 or format == 38:
 689             i += 1
 690             continue
 691
 692         if format == 36:
 693             match = re_CiteFormat.match(lines[i]);
 694             if match and match.group(4) == "":
 695                 lines[i] = match.group(0) + " default"
 696             i += 1
 697             continue
 698
 699         if format == 35:
 700           i += 1
 701           continue
 702
 703         if format == 34:
 704           match = re_QInsetLayout2.match(lines[i])
 705           if not match:
 706             match = re_InsetLayout2.match(lines[i])
 707           if not match:
 708             match = re_CopyStyle2.match(lines[i])
 709             if not match:
 710               i += 1
 711               continue
 712             style = match.group(2)
 713
 714             if flexstyles.count(style):
 715               lines[i] = match.group(1) + "\"Flex:" + style + "\""
 716             i += 1
 717             continue
 718
 719           name = match.group(1)
 720           names = name.split(":", 1)
 721           if len(names) > 1 and names[0] == "Flex":
 722             i += 1
 723             continue
 724
 725           isflex = False
 726           for j in range(i + 1, len(lines)):
 727             if re_IsFlex.match(lines[j]):
 728               isflex = True
 729               break
 730             if re_End.match(lines[j]):
 731               break
 732
 733           if isflex:
 734             flexstyles.append(name)
 735             lines[i] = "InsetLayout \"Flex:" + name + "\""
 736
 737           i += 1
 738           continue
 739
 740         if format == 33:
 741           m = re_Fill.match(lines[i])
 742           if m:
 743             lines[i] = ""
 744           i += 1
 745           continue
 746
 747         if format == 32:
 748           match = re_NeedsFloatPkg.match(lines[i])
 749           if match:
 750             space = match.group(1)
 751             val = match.group(2)
 752             lines[i] = space + "UsesFloatPkg " + val
 753             newval = 'true'
 754             if val == '1' or val.lower() == 'true':
 755               newval = 'false'
 756             lines.insert(i, space + "IsPredefined " + newval)
 757             i += 1
 758           i += 1
 759           continue
 760
 761         # Only new features
 762         if format >= 29 and format <= 31:
 763           i += 1
 764           continue
 765
 766         if format == 28:
 767           match = re_InsetLayout.match(lines[i])
 768           if match:
 769             lines[i] = "InsetLayout Flex:" + match.group(1)
 770           else:
 771             match = re_QInsetLayout.match(lines[i])
 772             if match:
 773               lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
 774             else:
 775               match = re_InsetLayout_CopyStyle.match(lines[i])
 776               if match:
 777                 lines[i] = "\tCopyStyle Flex:" + match.group(1)
 778               else:
 779                 match = re_QInsetLayout_CopyStyle.match(lines[i])
 780                 if match:
 781                   lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
 782           i += 1
 783           continue
 784
 785         # Only new features
 786         if format >= 24 and format <= 27:
 787           i += 1
 788           continue
 789
 790         if format == 23:
 791           match = re_Float.match(lines[i])
 792           i += 1
 793           if not match:
 794             continue
 795           # we need to do two things:
 796           # (i)  Convert Builtin to NeedsFloatPkg
 797           # (ii) Write ListCommand lines for the builtin floats table and figure
 798           builtin = False
 799           cmd = ""
 800           while True and i < len(lines):
 801             m1 = re_End.match(lines[i])
 802             if m1:
 803               if builtin and cmd:
 804                 line = "    ListCommand " + cmd
 805                 lines.insert(i, line)
 806                 i += 1
 807               break
 808             m2 = re_Builtin.match(lines[i])
 809             if m2:
 810               builtin = True
 811               ws1 = m2.group(1)
 812               arg = m2.group(2)
 813               newarg = ""
 814               if re_True.match(arg):
 815                 newarg = "false"
 816               else:
 817                 newarg = "true"
 818               lines[i] = ws1 + "NeedsFloatPkg " + newarg
 819             m3 = re_Type.match(lines[i])
 820             if m3:
 821               fltype = m3.group(1)
 822               fltype = fltype.lower()
 823               if fltype == "table":
 824                 cmd = "listoftables"
 825               elif fltype == "figure":
 826                 cmd = "listoffigures"
 827               # else unknown, which is why we're doing this
 828             i += 1
 829           continue
 830
 831         # This just involved new features, not any changes to old ones
 832         if format >= 14 and format <= 22:
 833           i += 1
 834           continue
 835
 836         # Rename I18NPreamble to BabelPreamble
 837         if format == 13:
 838             match = re_I18nPreamble.match(lines[i])
 839             if match:
 840                 lines[i] = match.group(1) + "BabelPreamble"
 841                 i += 1
 842                 match = re_EndI18nPreamble.match(lines[i])
 843                 while i < len(lines) and not match:
 844                     i += 1
 845                     match = re_EndI18nPreamble.match(lines[i])
 846                 lines[i] = match.group(1) + "EndBabelPreamble"
 847                 i += 1
 848                 continue
 849
 850         # These just involved new features, not any changes to old ones
 851         if format == 11 or format == 12:
 852           i += 1
 853           continue
 854
 855         if format == 10:
 856             match = re_UseMod.match(lines[i])
 857             if match:
 858                 module = match.group(1)
 859                 lines[i] = "DefaultModule " + module
 860             i += 1
 861             continue
 862
 863         if format == 9:
 864             match = re_Counter.match(lines[i])
 865             if match:
 866                 counterline = i
 867                 i += 1
 868                 while i < len(lines):
 869                     namem = re_Name.match(lines[i])
 870                     if namem:
 871                         name = namem.group(1)
 872                         lines.pop(i)
 873                         lines[counterline] = "Counter %s" % name
 874                         # we don't need to increment i
 875                         continue
 876                     endem = re_End.match(lines[i])
 877                     if endem:
 878                         i += 1
 879                         break
 880                     i += 1
 881             i += 1
 882             continue
 883
 884         if format == 8:
 885             # We want to scan for ams-type includes and, if we find them,
 886             # add corresponding UseModule tags to the layout.
 887             match = re_AMSMaths.match(lines[i])
 888             if match:
 889                 addstring("theorems-ams", usemodules)
 890                 addstring("theorems-ams-extended", usemodules)
 891                 addstring("theorems-sec", usemodules)
 892                 lines.pop(i)
 893                 continue
 894             match = re_AMSMathsPlain.match(lines[i])
 895             if match:
 896                 addstring("theorems-starred", usemodules)
 897                 lines.pop(i)
 898                 continue
 899             match = re_AMSMathsSeq.match(lines[i])
 900             if match:
 901                 addstring("theorems-ams", usemodules)
 902                 addstring("theorems-ams-extended", usemodules)
 903                 lines.pop(i)
 904                 continue
 905             i += 1
 906             continue
 907
 908         # These just involved new features, not any changes to old ones
 909         if format >= 5 and format <= 7:
 910           i += 1
 911           continue
 912
 913         if format == 4:
 914             # Handle conversion to long CharStyle names
 915             match = re_CharStyle.match(lines[i])
 916             if match:
 917                 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
 918                 i += 1
 919                 lines.insert(i, "\tLyXType charstyle")
 920                 i += 1
 921                 lines.insert(i, "")
 922                 lines[i] = "\tLabelString %s" % (match.group(3))
 923             i += 1
 924             continue
 925
 926         if format == 3:
 927             # convert 'providesamsmath x',  'providesmakeidx x',  'providesnatbib x',  'providesurl x' to
 928             #         'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
 929             # x is either 0 or 1
 930             match = re_Provides.match(lines[i])
 931             if match:
 932                 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
 933                                                   match.group(3), match.group(4))
 934             i += 1
 935             continue
 936
 937         if format == 2:
 938             caption = []
 939
 940             # delete caption styles
 941             match = re_Style.match(lines[i])
 942             if match:
 943                 style = string.lower(match.group(4))
 944                 if style == "caption":
 945                     del lines[i]
 946                     while i < len(lines) and not re_End.match(lines[i]):
 947                         caption.append(lines[i])
 948                         del lines[i]
 949                     if i == len(lines):
 950                         error('Incomplete caption style.')
 951                     else:
 952                         del lines[i]
 953                         continue
 954
 955             # delete undefinition of caption styles
 956             match = re_NoStyle.match(lines[i])
 957             if match:
 958                 style = string.lower(match.group(4))
 959                 if style == "caption":
 960                     del lines[i]
 961                     continue
 962
 963             # replace the CopyStyle statement with the definition of the real
 964             # style. This may result in duplicate statements, but that is OK
 965             # since the second one will overwrite the first one.
 966             match = re_CopyStyle.match(lines[i])
 967             if match:
 968                 style = string.lower(match.group(4))
 969                 if style == "caption":
 970                     if len(caption) > 0:
 971                         lines[i:i+1] = caption
 972                     else:
 973                         # FIXME: This style comes from an include file, we
 974                         # should replace the real style and not this default.
 975                         lines[i:i+1] = ['       Margin                First_Dynamic',
 976                                         '       LatexType             Command',
 977                                         '       LatexName             caption',
 978                                         '       NeedProtect           1',
 979                                         '       LabelSep              xx',
 980                                         '       ParSkip               0.4',
 981                                         '       TopSep                0.5',
 982                                         '       Align                 Center',
 983                                         '       AlignPossible         Center',
 984                                         '       LabelType             Sensitive',
 985                                         '       LabelString           "Senseless!"',
 986                                         '       OptionalArgs          1',
 987                                         '       LabelFont',
 988                                         '         Series              Bold',
 989                                         '       EndFont']
 990
 991             i += 1
 992             continue
 993
 994         # Delete MaxCounter and remember the value of it
 995         match = re_MaxCounter.match(lines[i])
 996         if match:
 997             level = match.group(4)
 998             if string.lower(level) == "counter_chapter":
 999                 maxcounter = 0
1000             elif string.lower(level) == "counter_section":
1001                 maxcounter = 1
1002             elif string.lower(level) == "counter_subsection":
1003                 maxcounter = 2
1004             elif string.lower(level) == "counter_subsubsection":
1005                 maxcounter = 3
1006             elif string.lower(level) == "counter_paragraph":
1007                 maxcounter = 4
1008             elif string.lower(level) == "counter_subparagraph":
1009                 maxcounter = 5
1010             elif string.lower(level) == "counter_enumi":
1011                 maxcounter = 6
1012             elif string.lower(level) == "counter_enumii":
1013                 maxcounter = 7
1014             elif string.lower(level) == "counter_enumiii":
1015                 maxcounter = 8
1016             del lines[i]
1017             continue
1018
1019         # Replace line
1020         #
1021         # LabelType Counter_EnumI
1022         #
1023         # with two lines
1024         #
1025         # LabelType Counter
1026         # LabelCounter EnumI
1027         #
1028         match = re_LabelType.match(lines[i])
1029         if match:
1030             label = match.group(4)
1031             # Remember indenting space for later reuse in added lines
1032             space1 = match.group(1)
1033             # Remember the line for adding the LabelCounter later.
1034             # We can't do it here because it could shift latextype_line etc.
1035             labeltype_line = i
1036             if string.lower(label[:8]) == "counter_":
1037                 counter = string.lower(label[8:])
1038                 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
1039
1040         # Remember the LabelString line
1041         match = re_LabelString.match(lines[i])
1042         if match:
1043             labelstring = match.group(4)
1044             labelstring_line = i
1045
1046         # Remember the LabelStringAppendix line
1047         match = re_LabelStringAppendix.match(lines[i])
1048         if match:
1049             labelstringappendix = match.group(4)
1050             labelstringappendix_line = i
1051
1052         # Remember the LatexType line
1053         match = re_LatexType.match(lines[i])
1054         if match:
1055             latextype = string.lower(match.group(4))
1056             latextype_line = i
1057
1058         # Remember the TocLevel line
1059         match = re_TocLevel.match(lines[i])
1060         if match:
1061             toclevel = string.lower(match.group(4))
1062
1063         # Reset variables at the beginning of a style definition
1064         match = re_Style.match(lines[i])
1065         if match:
1066             style = string.lower(match.group(4))
1067             counter = ""
1068             toclevel = ""
1069             label = ""
1070             space1 = ""
1071             labelstring = ""
1072             labelstringappendix = ""
1073             labelstring_line = -1
1074             labelstringappendix_line = -1
1075             labeltype_line = -1
1076             latextype = ""
1077             latextype_line = -1
1078
1079         if re_End.match(lines[i]):
1080
1081             # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
1082             # (or change the existing LatexType)
1083             if string.lower(label) == "bibliography":
1084                 if (latextype_line < 0):
1085                     lines.insert(i, "%sLatexType Bib_Environment" % space1)
1086                     i += 1
1087                 else:
1088                     lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
1089
1090             # Change "LabelType Static" to "LabelType Itemize" for itemize environments
1091             if latextype == "item_environment" and string.lower(label) == "static":
1092                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
1093
1094             # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
1095             if latextype == "item_environment" and string.lower(label) == "counter_enumi":
1096                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
1097                 # Don't add the LabelCounter line later
1098                 counter = ""
1099
1100             # Replace
1101             #
1102             # LabelString "Chapter"
1103             #
1104             # with
1105             #
1106             # LabelString "Chapter \arabic{chapter}"
1107             #
1108             # if this style has a counter. Ditto for LabelStringAppendix.
1109             # This emulates the hardcoded article style numbering of 1.3
1110             #
1111             if counter != "":
1112                 if style in counters:
1113                     if labelstring_line < 0:
1114                         lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
1115                         i += 1
1116                     else:
1117                         new_labelstring = concatenate_label(labelstring, counters[style])
1118                         lines[labelstring_line] = re_LabelString.sub(
1119                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
1120                                 lines[labelstring_line])
1121                 if style in appendixcounters:
1122                     if labelstringappendix_line < 0:
1123                         lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
1124                         i += 1
1125                     else:
1126                         new_labelstring = concatenate_label(labelstring, appendixcounters[style])
1127                         lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
1128                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
1129                                 lines[labelstringappendix_line])
1130
1131                 # Now we can safely add the LabelCounter line
1132                 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
1133                 i += 1
1134
1135             # Add the TocLevel setting for sectioning styles
1136             if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
1137                 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
1138                 i += 1
1139
1140         i += 1
1141
1142     if only_comment:
1143         lines.insert(i, "Format 2")
1144     if usemodules:
1145         i = formatline + 1
1146         for mod in usemodules:
1147             lines.insert(i, "UseModule " + mod)
1148             i += 1
1149
1150     return format + 1
1151
1152
1153 def main(argv):
1154     args = {}
1155     args["description"] = "Convert layout file <inputfile> to a newer format."
1156
1157     parser = argparse.ArgumentParser(**args)
1158
1159     parser.add_argument("-t", "--to", type=int, dest="format",
1160                         help=("destination layout format, default %i (latest)") % currentFormat)
1161     parser.add_argument("input_file", nargs='?', type=cmd_arg, default=None,
1162                         help="input file (default stdin)")
1163     parser.add_argument("output_file", nargs='?', type=cmd_arg, default=None,
1164                         help="output file (default stdout)")
1165
1166     options = parser.parse_args()
1167
1168     # Open files
1169     if options.input_file:
1170         source = open(options.input_file, 'rb')
1171     else:
1172         source = sys.stdin
1173
1174     if options.output_file:
1175         output = open(options.output_file, 'wb')
1176     else:
1177         output = sys.stdout
1178
1179     if options.format:
1180         end_format = options.format
1181     else:
1182         end_format = currentFormat
1183
1184     if end_format > currentFormat:
1185         error("Format %i does not exist" % end_format);
1186
1187     # Do the real work
1188     lines = read(source)
1189     format = 1
1190     while (format < end_format):
1191         format = convert(lines, end_format)
1192     write(output, lines)
1193
1194     # Close files
1195     if options.input_file:
1196         source.close()
1197     if options.output_file:
1198         output.close()
1199
1200     return 0
1201
1202
1203 if __name__ == "__main__":
1204     main(sys.argv)