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