lib/scripts/layout2layout.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file layout2layout.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Georg Baum
   9
  10 # Full author contact details are available in file CREDITS
  11
  12 # This script will update a .layout file to current format
  13
  14
  15 import os, re, string, sys
  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 # Do not forget to document format change in Customization
 161 # Manual (section "Declaring a new text class").
 162
 163 # You might also want to consider running the
 164 # development/tools/updatelayouts.sh script to update all
 165 # layout files to the new format.
 166
 167 currentFormat = 46
 168
 169
 170 def usage(prog_name):
 171     return ("Usage: %s inputfile outputfile\n" % prog_name +
 172             "or     %s <inputfile >outputfile" % prog_name)
 173
 174
 175 def error(message):
 176     sys.stderr.write(message + '\n')
 177     sys.exit(1)
 178
 179
 180 def trim_bom(line):
 181     " Remove byte order mark."
 182     if line[0:3] == "\357\273\277":
 183         return line[3:]
 184     else:
 185         return line
 186
 187
 188 def read(source):
 189     " Read input file and strip lineendings."
 190     lines = source.read().splitlines() or ['']
 191     lines[0] = trim_bom(lines[0])
 192     return lines
 193
 194
 195 def write(output, lines):
 196     " Write output file with native lineendings."
 197     output.write(os.linesep.join(lines) + os.linesep)
 198
 199
 200 # Concatenates old and new in an intelligent way:
 201 # If old is wrapped in ", they are stripped. The result is wrapped in ".
 202 def concatenate_label(old, new):
 203     # Don't use strip as long as we support python 1.5.2
 204     if old[0] == '"':
 205         return old[0:-1] + new + '"'
 206     else:
 207         return '"' + old + new + '"'
 208
 209 # appends a string to a list unless it's already there
 210 def addstring(s, l):
 211     if l.count(s) > 0:
 212         return
 213     l.append(s)
 214
 215
 216 def convert(lines):
 217     " Convert to new format."
 218     re_Comment = re.compile(r'^(\s*)#')
 219     re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
 220     re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
 221     re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
 222     re_Empty = re.compile(r'^(\s*)$')
 223     re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
 224     re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
 225     re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
 226     re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
 227     re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
 228     re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
 229     re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
 230     re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
 231     re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
 232     re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 233     re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 234     re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
 235     re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
 236     re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
 237     re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
 238     re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
 239     re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
 240     re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
 241     re_CiteFormat = re.compile(r'^(\s*)(CiteFormat)(?:(\s*)()|(\s+)(default|authoryear|numerical))', re.IGNORECASE)
 242     re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
 243     re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
 244     re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
 245     re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
 246     re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
 247     re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
 248     re_Float = re.compile(r'^\s*Float\s*$', re.IGNORECASE)
 249     re_Type = re.compile(r'\s*Type\s+(\w+)', re.IGNORECASE)
 250     re_Builtin = re.compile(r'^(\s*)LaTeXBuiltin\s+(\w*)', re.IGNORECASE)
 251     re_True = re.compile(r'^\s*(?:true|1)\s*$', re.IGNORECASE)
 252     re_InsetLayout = re.compile(r'^\s*InsetLayout\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
 253     # with quotes
 254     re_QInsetLayout = re.compile(r'^\s*InsetLayout\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
 255     re_InsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+(?:Custom|CharStyle|Element):(\S+)\s*$', re.IGNORECASE)
 256     re_QInsetLayout_CopyStyle = re.compile(r'^\s*CopyStyle\s+"(?:Custom|CharStyle|Element):([^"]+)"\s*$', re.IGNORECASE)
 257     re_NeedsFloatPkg = re.compile(r'^(\s*)NeedsFloatPkg\s+(\w+)\s*$', re.IGNORECASE)
 258     re_Fill = re.compile(r'^\s*Fill_(?:Top|Bottom).*$', re.IGNORECASE)
 259     re_InsetLayout2 = re.compile(r'^\s*InsetLayout\s+(\S+)\s*$', re.IGNORECASE)
 260     # with quotes
 261     re_QInsetLayout2 = re.compile(r'^\s*InsetLayout\s+"([^"]+)"\s*$', re.IGNORECASE)
 262     re_IsFlex = re.compile(r'\s*LyXType.*$', re.IGNORECASE)
 263     re_CopyStyle2 = re.compile(r'(\s*CopyStyle\s+)"?([^"]+)"?\s*$')
 264     # for categories
 265     re_Declaration = re.compile(r'^#\s*\\Declare\w+Class.*$')
 266     re_ExtractCategory = re.compile(r'^(#\s*\\Declare\w+Class(?:\[[^]]*?\])?){([^(]+?)\s+\(([^)]+?)\)\s*}\s*$')
 267     ConvDict = {"article": "Articles", "book" : "Books", "letter" : "Letters", "report": "Reports", \
 268                 "presentation" : "Presentations", "curriculum vitae" : "Curricula Vitae", "handout" : "Handouts"}
 269     # Arguments
 270     re_OptArgs = re.compile(r'^(\s*)OptionalArgs(\s+)(\d+)\D*$', re.IGNORECASE)
 271     re_ReqArgs = re.compile(r'^(\s*)RequiredArgs(\s+)(\d+)\D*$', re.IGNORECASE)
 272
 273     # various changes associated with changing how chapters are handled
 274     re_LabelTypeIsCounter = re.compile(r'^(\s*)LabelType(\s*)Counter\s*$', re.IGNORECASE)
 275     re_TopEnvironment = re.compile(r'^(\s*)LabelType(\s+)Top_Environment\s*$', re.IGNORECASE)
 276     re_CenteredEnvironment = re.compile(r'^(\s*)LabelType(\s+)Centered_Top_Environment\s*$', re.IGNORECASE)
 277     re_ChapterStyle = re.compile(r'^\s*Style\s+Chapter\s*$', re.IGNORECASE)
 278
 279
 280     # counters for sectioning styles (hardcoded in 1.3)
 281     counters = {"part"          : "\\Roman{part}",
 282                 "chapter"       : "\\arabic{chapter}",
 283                 "section"       : "\\arabic{section}",
 284                 "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 285                 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 286                 "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 287                 "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 288
 289     # counters for sectioning styles in appendix (hardcoded in 1.3)
 290     appendixcounters = {"chapter"       : "\\Alph{chapter}",
 291                         "section"       : "\\Alph{section}",
 292                         "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 293                         "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 294                         "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 295                         "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 296
 297     # Value of TocLevel for sectioning styles
 298     toclevels = {"part"          : -1,
 299                  "chapter"       : 0,
 300                  "section"       : 1,
 301                  "subsection"    : 2,
 302                  "subsubsection" : 3,
 303                  "paragraph"     : 4,
 304                  "subparagraph"  : 5}
 305
 306     i = 0
 307     only_comment = 1
 308     counter = ""
 309     toclevel = ""
 310     label = ""
 311     labelstring = ""
 312     labelstringappendix = ""
 313     space1 = ""
 314     labelstring_line = -1
 315     labelstringappendix_line = -1
 316     labeltype_line = -1
 317     latextype = ""
 318     latextype_line = -1
 319     style = ""
 320     maxcounter = 0
 321     format = 1
 322     formatline = 0
 323     usemodules = []
 324     flexstyles = []
 325     opts = 0
 326     reqs = 0
 327     inchapter = False
 328
 329     while i < len(lines):
 330         # Skip comments and empty lines
 331         if (re_Comment.match(lines[i]) or re_Empty.match(lines[i])):
 332           # We need to deal with this conversion here, because it happens
 333           # inside the initial comment block.
 334           if only_comment and format == 39:
 335               match = re_ExtractCategory.match(lines[i])
 336               if match:
 337                   lpre = match.group(1)
 338                   lcat = match.group(2)
 339                   lnam = match.group(3)
 340                   if lcat in ConvDict:
 341                       lcat = ConvDict[lcat]
 342                   lines[i] = lpre + "{" + lnam + "}"
 343                   lines.insert(i+1, "#  \\DeclareCategory{" + lcat + "}")
 344                   i += 1
 345           i += 1
 346           continue
 347
 348         # insert file format if not already there
 349         if (only_comment):
 350             match = re_Format.match(lines[i])
 351             if match:
 352                 formatline = i
 353                 format = int(match.group(4))
 354                 if format > 1 and format < currentFormat:
 355                     lines[i] = "Format %d" % (format + 1)
 356                     only_comment = 0
 357                 elif format == currentFormat:
 358                     # nothing to do
 359                     return format
 360                 else:
 361                     error('Cannot convert file format %s to %s' % (format, currentFormat))
 362             else:
 363                 lines.insert(i, "Format 2")
 364                 only_comment = 0
 365                 continue
 366
 367         # Don't get confused by LaTeX code
 368         if re_Preamble.match(lines[i]):
 369             i += 1
 370             while i < len(lines) and not re_EndPreamble.match(lines[i]):
 371                 i += 1
 372             continue
 373         if re_LangPreamble.match(lines[i]):
 374             i += 1
 375             while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
 376                 i += 1
 377             continue
 378         if re_BabelPreamble.match(lines[i]):
 379             i += 1
 380             while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
 381                 i += 1
 382             continue
 383
 384         if format == 44 or format == 45:
 385             # nothing to do.
 386             i += 1
 387             continue
 388
 389         if format == 43:
 390           match = re_LabelTypeIsCounter.match(lines[i])
 391           if match:
 392             if inchapter:
 393              lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
 394             else:
 395               lines[i] = match.group(1) + "LabelType" + match.group(2) + "Static"
 396
 397           match = re_TopEnvironment.match(lines[i])
 398           if match:
 399             lines[i] = match.group(1) + "LabelType" + match.group(2) + "Above"
 400
 401           match = re_CenteredEnvironment.match(lines[i])
 402           if match:
 403             lines[i] = match.group(1) + "LabelType" + match.group(2) + "Centered"
 404
 405           if inchapter:
 406             match = re_Style.match(lines[i])
 407             if match:
 408               inchapter = False
 409           else:
 410             match = re_ChapterStyle.match(lines[i])
 411             if match:
 412               inchapter = True
 413
 414           i += 1
 415           continue
 416
 417         if format == 42:
 418           if lines[i] == "InsetLayout Caption":
 419             lines[i] = "InsetLayout Caption:Standard"
 420           i += 1
 421           continue
 422
 423         if format == 41:
 424             # nothing to do.
 425             i += 1
 426             continue
 427
 428         if format == 40:
 429             # reset counters on Style beginning
 430             match = re_Style.match(lines[i])
 431             if match:
 432                 opts = 0
 433                 reqs = 0
 434                 i += 1
 435                 continue
 436             match = re_OptArgs.match(lines[i])
 437             if match:
 438                 # Save number of optional arguments
 439                 space1 = match.group(1)
 440                 opts = int(match.group(3))
 441                 # OptionalArgs 0 > ResetArgs 1
 442                 if opts == 0:
 443                     lines[i] = space1 + "ResetArgs\t1"
 444                     i += 1
 445                 else:
 446                     del lines[i]
 447                 continue
 448             match = re_ReqArgs.match(lines[i])
 449             if match:
 450                 # Save number of required arguments
 451                 space1 = match.group(1)
 452                 reqs = int(match.group(3))
 453                 del lines[i]
 454                 continue
 455             # Insert the required number of arguments at the end of the style definition
 456             match = re_End.match(lines[i])
 457             if match:
 458                 newarg = ['']
 459                 # First the optionals (this is the required order pre 2.1)
 460                 if opts > 0:
 461                     if opts == 1:
 462                         newarg = [ '%sArgument 1' % (space1),
 463                                    '%s\tLabelString\t\"Optional Layout Argument\"' % (space1),
 464                                    '%sEndArgument' % (space1)]
 465                     elif opts > 1:
 466                         actopt = 1
 467                         while actopt < (opts + 1):
 468                             newarg += [ '%sArgument %d' % (space1, actopt),
 469                                '%s\tLabelString\t\"Optional Layout Argument %d\"' % (space1, actopt),
 470                                '%sEndArgument' % (space1)]
 471                             actopt += 1
 472                 # Now the mandatories
 473                 if reqs > 0:
 474                     actopt = opts + 1
 475                     while actopt < (opts +  reqs + 1):
 476                         newarg += [ '%sArgument %d' % (space1, actopt),
 477                            '%s\tLabelString\t"Required Layout Argument %d"' % (space1, actopt - opts),
 478                            '%s\tMandatory\t1' % (space1),
 479                            '%sEndArgument' % (space1)]
 480                         actopt += 1
 481                 # Since we replace the "End" line, re-add this line
 482                 if len(newarg) > 1:
 483                     newarg += ['End']
 484                     lines[i:i+1] = newarg
 485                     i += len(newarg)
 486                 # Reset the counters
 487                 opts = 0
 488                 reqs = 0
 489             i += 1
 490             continue
 491
 492         if format == 39:
 493             # There is a conversion with format 40, but it is done within the
 494             # initial comment block and so is above.
 495             i += 1
 496             continue
 497
 498         if format == 37 or format == 38:
 499             i += 1
 500             continue
 501
 502         if format == 36:
 503             match = re_CiteFormat.match(lines[i]);
 504             if match and match.group(4) == "":
 505                 lines[i] = match.group(0) + " default"
 506             i += 1
 507             continue
 508
 509         if format == 35:
 510           i += 1
 511           continue
 512
 513         if format == 34:
 514           match = re_QInsetLayout2.match(lines[i])
 515           if not match:
 516             match = re_InsetLayout2.match(lines[i])
 517           if not match:
 518             match = re_CopyStyle2.match(lines[i])
 519             if not match:
 520               i += 1
 521               continue
 522             style = match.group(2)
 523
 524             if flexstyles.count(style):
 525               lines[i] = match.group(1) + "\"Flex:" + style + "\""
 526             i += 1
 527             continue
 528
 529           name = match.group(1)
 530           names = name.split(":", 1)
 531           if len(names) > 1 and names[0] == "Flex":
 532             i += 1
 533             continue
 534
 535           isflex = False
 536           for j in range(i + 1, len(lines)):
 537             if re_IsFlex.match(lines[j]):
 538               isflex = True
 539               break
 540             if re_End.match(lines[j]):
 541               break
 542
 543           if isflex:
 544             flexstyles.append(name)
 545             lines[i] = "InsetLayout \"Flex:" + name + "\""
 546
 547           i += 1
 548           continue
 549
 550         if format == 33:
 551           m = re_Fill.match(lines[i])
 552           if m:
 553             lines[i] = ""
 554           i += 1
 555           continue
 556
 557         if format == 32:
 558           match = re_NeedsFloatPkg.match(lines[i])
 559           if match:
 560             space = match.group(1)
 561             val = match.group(2)
 562             lines[i] = space + "UsesFloatPkg " + val
 563             newval = 'true'
 564             if val == '1' or val.lower() == 'true':
 565               newval = 'false'
 566             lines.insert(i, space + "IsPredefined " + newval)
 567             i += 1
 568           i += 1
 569           continue
 570
 571         # Only new features
 572         if format >= 29 and format <= 31:
 573           i += 1
 574           continue
 575
 576         if format == 28:
 577           match = re_InsetLayout.match(lines[i])
 578           if match:
 579             lines[i] = "InsetLayout Flex:" + match.group(1)
 580           else:
 581             match = re_QInsetLayout.match(lines[i])
 582             if match:
 583               lines[i] = "InsetLayout \"Flex:" + match.group(1) + "\""
 584             else:
 585               match = re_InsetLayout_CopyStyle.match(lines[i])
 586               if match:
 587                 lines[i] = "\tCopyStyle Flex:" + match.group(1)
 588               else:
 589                 match = re_QInsetLayout_CopyStyle.match(lines[i])
 590                 if match:
 591                   lines[i] = "\tCopyStyle \"Flex:" + match.group(1) + "\""
 592           i += 1
 593           continue
 594
 595         # Only new features
 596         if format >= 24 and format <= 27:
 597           i += 1
 598           continue
 599
 600         if format == 23:
 601           match = re_Float.match(lines[i])
 602           i += 1
 603           if not match:
 604             continue
 605           # we need to do two things:
 606           # (i)  Convert Builtin to NeedsFloatPkg
 607           # (ii) Write ListCommand lines for the builtin floats table and figure
 608           builtin = False
 609           cmd = ""
 610           while True and i < len(lines):
 611             m1 = re_End.match(lines[i])
 612             if m1:
 613               if builtin and cmd:
 614                 line = "    ListCommand " + cmd
 615                 lines.insert(i, line)
 616                 i += 1
 617               break
 618             m2 = re_Builtin.match(lines[i])
 619             if m2:
 620               builtin = True
 621               ws1 = m2.group(1)
 622               arg = m2.group(2)
 623               newarg = ""
 624               if re_True.match(arg):
 625                 newarg = "false"
 626               else:
 627                 newarg = "true"
 628               lines[i] = ws1 + "NeedsFloatPkg " + newarg
 629             m3 = re_Type.match(lines[i])
 630             if m3:
 631               fltype = m3.group(1)
 632               fltype = fltype.lower()
 633               if fltype == "table":
 634                 cmd = "listoftables"
 635               elif fltype == "figure":
 636                 cmd = "listoffigures"
 637               # else unknown, which is why we're doing this
 638             i += 1
 639           continue
 640
 641         # This just involved new features, not any changes to old ones
 642         if format >= 14 and format <= 22:
 643           i += 1
 644           continue
 645
 646         # Rename I18NPreamble to BabelPreamble
 647         if format == 13:
 648             match = re_I18nPreamble.match(lines[i])
 649             if match:
 650                 lines[i] = match.group(1) + "BabelPreamble"
 651                 i += 1
 652                 match = re_EndI18nPreamble.match(lines[i])
 653                 while i < len(lines) and not match:
 654                     i += 1
 655                     match = re_EndI18nPreamble.match(lines[i])
 656                 lines[i] = match.group(1) + "EndBabelPreamble"
 657                 i += 1
 658                 continue
 659
 660         # These just involved new features, not any changes to old ones
 661         if format == 11 or format == 12:
 662           i += 1
 663           continue
 664
 665         if format == 10:
 666             match = re_UseMod.match(lines[i])
 667             if match:
 668                 module = match.group(1)
 669                 lines[i] = "DefaultModule " + module
 670             i += 1
 671             continue
 672
 673         if format == 9:
 674             match = re_Counter.match(lines[i])
 675             if match:
 676                 counterline = i
 677                 i += 1
 678                 while i < len(lines):
 679                     namem = re_Name.match(lines[i])
 680                     if namem:
 681                         name = namem.group(1)
 682                         lines.pop(i)
 683                         lines[counterline] = "Counter %s" % name
 684                         # we don't need to increment i
 685                         continue
 686                     endem = re_End.match(lines[i])
 687                     if endem:
 688                         i += 1
 689                         break
 690                     i += 1
 691             i += 1
 692             continue
 693
 694         if format == 8:
 695             # We want to scan for ams-type includes and, if we find them,
 696             # add corresponding UseModule tags to the layout.
 697             match = re_AMSMaths.match(lines[i])
 698             if match:
 699                 addstring("theorems-ams", usemodules)
 700                 addstring("theorems-ams-extended", usemodules)
 701                 addstring("theorems-sec", usemodules)
 702                 lines.pop(i)
 703                 continue
 704             match = re_AMSMathsPlain.match(lines[i])
 705             if match:
 706                 addstring("theorems-starred", usemodules)
 707                 lines.pop(i)
 708                 continue
 709             match = re_AMSMathsSeq.match(lines[i])
 710             if match:
 711                 addstring("theorems-ams", usemodules)
 712                 addstring("theorems-ams-extended", usemodules)
 713                 lines.pop(i)
 714                 continue
 715             i += 1
 716             continue
 717
 718         # These just involved new features, not any changes to old ones
 719         if format >= 5 and format <= 7:
 720           i += 1
 721           continue
 722
 723         if format == 4:
 724             # Handle conversion to long CharStyle names
 725             match = re_CharStyle.match(lines[i])
 726             if match:
 727                 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
 728                 i += 1
 729                 lines.insert(i, "\tLyXType charstyle")
 730                 i += 1
 731                 lines.insert(i, "")
 732                 lines[i] = "\tLabelString %s" % (match.group(3))
 733             i += 1
 734             continue
 735
 736         if format == 3:
 737             # convert 'providesamsmath x',  'providesmakeidx x',  'providesnatbib x',  'providesurl x' to
 738             #         'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
 739             # x is either 0 or 1
 740             match = re_Provides.match(lines[i])
 741             if match:
 742                 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
 743                                                   match.group(3), match.group(4))
 744             i += 1
 745             continue
 746
 747         if format == 2:
 748             caption = []
 749
 750             # delete caption styles
 751             match = re_Style.match(lines[i])
 752             if match:
 753                 style = string.lower(match.group(4))
 754                 if style == "caption":
 755                     del lines[i]
 756                     while i < len(lines) and not re_End.match(lines[i]):
 757                         caption.append(lines[i])
 758                         del lines[i]
 759                     if i == len(lines):
 760                         error('Incomplete caption style.')
 761                     else:
 762                         del lines[i]
 763                         continue
 764
 765             # delete undefinition of caption styles
 766             match = re_NoStyle.match(lines[i])
 767             if match:
 768                 style = string.lower(match.group(4))
 769                 if style == "caption":
 770                     del lines[i]
 771                     continue
 772
 773             # replace the CopyStyle statement with the definition of the real
 774             # style. This may result in duplicate statements, but that is OK
 775             # since the second one will overwrite the first one.
 776             match = re_CopyStyle.match(lines[i])
 777             if match:
 778                 style = string.lower(match.group(4))
 779                 if style == "caption":
 780                     if len(caption) > 0:
 781                         lines[i:i+1] = caption
 782                     else:
 783                         # FIXME: This style comes from an include file, we
 784                         # should replace the real style and not this default.
 785                         lines[i:i+1] = ['       Margin                First_Dynamic',
 786                                         '       LatexType             Command',
 787                                         '       LatexName             caption',
 788                                         '       NeedProtect           1',
 789                                         '       LabelSep              xx',
 790                                         '       ParSkip               0.4',
 791                                         '       TopSep                0.5',
 792                                         '       Align                 Center',
 793                                         '       AlignPossible         Center',
 794                                         '       LabelType             Sensitive',
 795                                         '       LabelString           "Senseless!"',
 796                                         '       OptionalArgs          1',
 797                                         '       LabelFont',
 798                                         '         Series              Bold',
 799                                         '       EndFont']
 800
 801             i += 1
 802             continue
 803
 804         # Delete MaxCounter and remember the value of it
 805         match = re_MaxCounter.match(lines[i])
 806         if match:
 807             level = match.group(4)
 808             if string.lower(level) == "counter_chapter":
 809                 maxcounter = 0
 810             elif string.lower(level) == "counter_section":
 811                 maxcounter = 1
 812             elif string.lower(level) == "counter_subsection":
 813                 maxcounter = 2
 814             elif string.lower(level) == "counter_subsubsection":
 815                 maxcounter = 3
 816             elif string.lower(level) == "counter_paragraph":
 817                 maxcounter = 4
 818             elif string.lower(level) == "counter_subparagraph":
 819                 maxcounter = 5
 820             elif string.lower(level) == "counter_enumi":
 821                 maxcounter = 6
 822             elif string.lower(level) == "counter_enumii":
 823                 maxcounter = 7
 824             elif string.lower(level) == "counter_enumiii":
 825                 maxcounter = 8
 826             del lines[i]
 827             continue
 828
 829         # Replace line
 830         #
 831         # LabelType Counter_EnumI
 832         #
 833         # with two lines
 834         #
 835         # LabelType Counter
 836         # LabelCounter EnumI
 837         #
 838         match = re_LabelType.match(lines[i])
 839         if match:
 840             label = match.group(4)
 841             # Remember indenting space for later reuse in added lines
 842             space1 = match.group(1)
 843             # Remember the line for adding the LabelCounter later.
 844             # We can't do it here because it could shift latextype_line etc.
 845             labeltype_line = i
 846             if string.lower(label[:8]) == "counter_":
 847                 counter = string.lower(label[8:])
 848                 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
 849
 850         # Remember the LabelString line
 851         match = re_LabelString.match(lines[i])
 852         if match:
 853             labelstring = match.group(4)
 854             labelstring_line = i
 855
 856         # Remember the LabelStringAppendix line
 857         match = re_LabelStringAppendix.match(lines[i])
 858         if match:
 859             labelstringappendix = match.group(4)
 860             labelstringappendix_line = i
 861
 862         # Remember the LatexType line
 863         match = re_LatexType.match(lines[i])
 864         if match:
 865             latextype = string.lower(match.group(4))
 866             latextype_line = i
 867
 868         # Remember the TocLevel line
 869         match = re_TocLevel.match(lines[i])
 870         if match:
 871             toclevel = string.lower(match.group(4))
 872
 873         # Reset variables at the beginning of a style definition
 874         match = re_Style.match(lines[i])
 875         if match:
 876             style = string.lower(match.group(4))
 877             counter = ""
 878             toclevel = ""
 879             label = ""
 880             space1 = ""
 881             labelstring = ""
 882             labelstringappendix = ""
 883             labelstring_line = -1
 884             labelstringappendix_line = -1
 885             labeltype_line = -1
 886             latextype = ""
 887             latextype_line = -1
 888
 889         if re_End.match(lines[i]):
 890
 891             # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
 892             # (or change the existing LatexType)
 893             if string.lower(label) == "bibliography":
 894                 if (latextype_line < 0):
 895                     lines.insert(i, "%sLatexType Bib_Environment" % space1)
 896                     i += 1
 897                 else:
 898                     lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
 899
 900             # Change "LabelType Static" to "LabelType Itemize" for itemize environments
 901             if latextype == "item_environment" and string.lower(label) == "static":
 902                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
 903
 904             # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
 905             if latextype == "item_environment" and string.lower(label) == "counter_enumi":
 906                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
 907                 # Don't add the LabelCounter line later
 908                 counter = ""
 909
 910             # Replace
 911             #
 912             # LabelString "Chapter"
 913             #
 914             # with
 915             #
 916             # LabelString "Chapter \arabic{chapter}"
 917             #
 918             # if this style has a counter. Ditto for LabelStringAppendix.
 919             # This emulates the hardcoded article style numbering of 1.3
 920             #
 921             if counter != "":
 922                 if style in counters:
 923                     if labelstring_line < 0:
 924                         lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
 925                         i += 1
 926                     else:
 927                         new_labelstring = concatenate_label(labelstring, counters[style])
 928                         lines[labelstring_line] = re_LabelString.sub(
 929                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
 930                                 lines[labelstring_line])
 931                 if style in appendixcounters:
 932                     if labelstringappendix_line < 0:
 933                         lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
 934                         i += 1
 935                     else:
 936                         new_labelstring = concatenate_label(labelstring, appendixcounters[style])
 937                         lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
 938                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
 939                                 lines[labelstringappendix_line])
 940
 941                 # Now we can safely add the LabelCounter line
 942                 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
 943                 i += 1
 944
 945             # Add the TocLevel setting for sectioning styles
 946             if toclevel == "" and style in toclevels and maxcounter <= toclevels[style]:
 947                 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
 948                 i += 1
 949
 950         i += 1
 951
 952     if only_comment:
 953         lines.insert(i, "Format 2")
 954     if usemodules:
 955         i = formatline + 1
 956         for mod in usemodules:
 957             lines.insert(i, "UseModule " + mod)
 958             i += 1
 959
 960     return format + 1
 961
 962
 963 def main(argv):
 964
 965     # Open files
 966     if len(argv) == 1:
 967         source = sys.stdin
 968         output = sys.stdout
 969     elif len(argv) == 3:
 970         source = open(argv[1], 'rb')
 971         output = open(argv[2], 'wb')
 972     else:
 973         error(usage(argv[0]))
 974
 975     # Do the real work
 976     lines = read(source)
 977     format = 1
 978     while (format < currentFormat):
 979         format = convert(lines)
 980     write(output, lines)
 981
 982     # Close files
 983     if len(argv) == 3:
 984         source.close()
 985         output.close()
 986
 987     return 0
 988
 989
 990 if __name__ == "__main__":
 991     main(sys.argv)