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