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