lib/scripts/layout2layout.py

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