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