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