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