lib/scripts/layout2layout.py

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