lib/scripts/layout2layout.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file layout2layout.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # author Georg Baum
   9
  10 # Full author contact details are available in file CREDITS
  11
  12 # This script will update a .layout file to current format
  13
  14
  15 import os, re, string, sys
  16
  17 # Incremented to format 4, 6 April 2007, lasgouttes
  18 # Introduction of generic "Provides" declaration
  19
  20 # Incremented to format 5, 22 August 2007 by vermeer
  21 # InsetLayout material
  22
  23 # Incremented to format 6, 7 January 2008 by spitz
  24 # Requires tag added to layout files
  25
  26 # Incremented to format 7, 24 March 2008 by rgh
  27 # AddToPreamble tag added to layout files
  28
  29 # Incremented to format 8, 25 July 2008 by rgh
  30 # UseModule tag added to layout files
  31 # CopyStyle added to InsetLayout
  32
  33 # Incremented to format 9, 5 October 2008 by rgh
  34 # ForcePlain and CustomPars tags added to InsetLayout
  35
  36 # Incremented to format 10, 6 October 2008 by rgh
  37 # Change format of counters
  38
  39 # Incremented to format 11, 14 October 2008 by rgh
  40 # Add ProvidesModule, ExcludesModule tags
  41
  42 # Incremented to format 12, 10 January 2009 by gb
  43 # Add I18NPreamble tag
  44
  45 # Incremented to format 13, 5 February 2009 by rgh
  46 # Add InToc tag for InsetLayout
  47
  48 # Incremented to format 14, 14 February 2009 by gb
  49 # Rename I18NPreamble to BabelPreamble and add LangPreamble
  50
  51 # Incremented to format 15, 28 May 2009 by lasgouttes
  52 # Add new tag OutputFormat; modules can be conditioned on feature
  53 # "from->to".
  54
  55 # Incremented to format 16, 5 June 2009 by rgh
  56 # Add new tags for Text Class:
  57 #   HTMLPreamble, HTMLAddToPreamble
  58 # For Layout:
  59 #   HTMLTag, HTMLAttr, HTMLLabel, HTMLLabelAttr, HTMLItem, HTMLItemAttr
  60 #   HTMLStyle, and HTMLPreamble
  61 # For InsetLayout:
  62 #   HTMLTag, HTMLAttr, HTMLStyle, and HTMLPreamble
  63 # For Floats:
  64 #   HTMLType, HTMLClass, HTMLStyle
  65
  66 # Incremented to format 17, 12 August 2009 by rgh
  67 # Add IfStyle and IfCounter tags for layout.
  68
  69 # Incremented to format 18, 27 October 2009 by rgh
  70 # Added some new tags for HTML output.
  71
  72 # Incremented to format 19, 17 November 2009 by rgh
  73 # Added InPreamble tag.
  74
  75 # Incremented to format 20, 17 December 2009 by rgh
  76 # Added ContentAsLabel tag.
  77
  78 # Do not forget to document format change in Customization
  79 # Manual (section "Declaring a new text class").
  80
  81 currentFormat = 20
  82
  83
  84 def usage(prog_name):
  85     return ("Usage: %s inputfile outputfile\n" % prog_name +
  86             "or     %s <inputfile >outputfile" % prog_name)
  87
  88
  89 def error(message):
  90     sys.stderr.write(message + '\n')
  91     sys.exit(1)
  92
  93
  94 def trim_bom(line):
  95     " Remove byte order mark."
  96     if line[0:3] == "\357\273\277":
  97         return line[3:]
  98     else:
  99         return line
 100
 101
 102 def read(source):
 103     " Read input file and strip lineendings."
 104     lines = source.read().splitlines()
 105     lines[0] = trim_bom(lines[0])
 106     return lines
 107
 108
 109 def write(output, lines):
 110     " Write output file with native lineendings."
 111     output.write(os.linesep.join(lines) + os.linesep)
 112
 113
 114 # Concatenates old and new in an intelligent way:
 115 # If old is wrapped in ", they are stripped. The result is wrapped in ".
 116 def concatenate_label(old, new):
 117     # Don't use strip as long as we support python 1.5.2
 118     if old[0] == '"':
 119         return old[0:-1] + new + '"'
 120     else:
 121         return '"' + old + new + '"'
 122
 123 # appends a string to a list unless it's already there
 124 def addstring(s, l):
 125     if l.count(s) > 0:
 126         return
 127     l.append(s)
 128
 129
 130 def convert(lines):
 131     " Convert to new format."
 132     re_Comment = re.compile(r'^(\s*)#')
 133     re_Counter = re.compile(r'\s*Counter\s*', re.IGNORECASE)
 134     re_Name = re.compile(r'\s*Name\s+(\S+)\s*', re.IGNORECASE)
 135     re_UseMod = re.compile(r'^\s*UseModule\s+(.*)', re.IGNORECASE)
 136     re_Empty = re.compile(r'^(\s*)$')
 137     re_Format = re.compile(r'^(\s*)(Format)(\s+)(\S+)', re.IGNORECASE)
 138     re_Preamble = re.compile(r'^(\s*)Preamble', re.IGNORECASE)
 139     re_EndPreamble = re.compile(r'^(\s*)EndPreamble', re.IGNORECASE)
 140     re_LangPreamble = re.compile(r'^(\s*)LangPreamble', re.IGNORECASE)
 141     re_EndLangPreamble = re.compile(r'^(\s*)EndLangPreamble', re.IGNORECASE)
 142     re_BabelPreamble = re.compile(r'^(\s*)BabelPreamble', re.IGNORECASE)
 143     re_EndBabelPreamble = re.compile(r'^(\s*)EndBabelPreamble', re.IGNORECASE)
 144     re_MaxCounter = re.compile(r'^(\s*)(MaxCounter)(\s+)(\S+)', re.IGNORECASE)
 145     re_LabelType = re.compile(r'^(\s*)(LabelType)(\s+)(\S+)', re.IGNORECASE)
 146     re_LabelString = re.compile(r'^(\s*)(LabelString)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 147     re_LabelStringAppendix = re.compile(r'^(\s*)(LabelStringAppendix)(\s+)(("[^"]+")|(\S+))', re.IGNORECASE)
 148     re_LatexType = re.compile(r'^(\s*)(LatexType)(\s+)(\S+)', re.IGNORECASE)
 149     re_Style = re.compile(r'^(\s*)(Style)(\s+)(\S+)', re.IGNORECASE)
 150     re_CopyStyle = re.compile(r'^(\s*)(CopyStyle)(\s+)(\S+)', re.IGNORECASE)
 151     re_NoStyle = re.compile(r'^(\s*)(NoStyle)(\s+)(\S+)', re.IGNORECASE)
 152     re_End = re.compile(r'^(\s*)(End)(\s*)$', re.IGNORECASE)
 153     re_Provides = re.compile(r'^(\s*)Provides(\S+)(\s+)(\S+)', re.IGNORECASE)
 154     re_CharStyle = re.compile(r'^(\s*)CharStyle(\s+)(\S+)$', re.IGNORECASE)
 155     re_AMSMaths = re.compile(r'^\s*Input ams(?:math|def)s.inc\s*')
 156     re_AMSMathsPlain = re.compile(r'^\s*Input amsmaths-plain.inc\s*')
 157     re_AMSMathsSeq = re.compile(r'^\s*Input amsmaths-seq.inc\s*')
 158     re_TocLevel = re.compile(r'^(\s*)(TocLevel)(\s+)(\S+)', re.IGNORECASE)
 159     re_I18nPreamble = re.compile(r'^(\s*)I18nPreamble', re.IGNORECASE)
 160     re_EndI18nPreamble = re.compile(r'^(\s*)EndI18nPreamble', re.IGNORECASE)
 161
 162     # counters for sectioning styles (hardcoded in 1.3)
 163     counters = {"part"          : "\\Roman{part}",
 164                 "chapter"       : "\\arabic{chapter}",
 165                 "section"       : "\\arabic{section}",
 166                 "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 167                 "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 168                 "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 169                 "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 170
 171     # counters for sectioning styles in appendix (hardcoded in 1.3)
 172     appendixcounters = {"chapter"       : "\\Alph{chapter}",
 173                         "section"       : "\\Alph{section}",
 174                         "subsection"    : "\\arabic{section}.\\arabic{subsection}",
 175                         "subsubsection" : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}",
 176                         "paragraph"     : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}",
 177                         "subparagraph"  : "\\arabic{section}.\\arabic{subsection}.\\arabic{subsubsection}.\\arabic{paragraph}.\\arabic{subparagraph}"}
 178
 179     # Value of TocLevel for sectioning styles
 180     toclevels = {"part"          : 0,
 181                  "chapter"       : 0,
 182                  "section"       : 1,
 183                  "subsection"    : 2,
 184                  "subsubsection" : 3,
 185                  "paragraph"     : 4,
 186                  "subparagraph"  : 5}
 187
 188     i = 0
 189     only_comment = 1
 190     counter = ""
 191     toclevel = ""
 192     label = ""
 193     labelstring = ""
 194     labelstringappendix = ""
 195     space1 = ""
 196     labelstring_line = -1
 197     labelstringappendix_line = -1
 198     labeltype_line = -1
 199     latextype = ""
 200     latextype_line = -1
 201     style = ""
 202     maxcounter = 0
 203     format = 1
 204     formatline = 0
 205     usemodules = []
 206
 207     while i < len(lines):
 208         # Skip comments and empty lines
 209         if re_Comment.match(lines[i]) or re_Empty.match(lines[i]):
 210             i += 1
 211             continue
 212
 213         # insert file format if not already there
 214         if (only_comment):
 215             match = re_Format.match(lines[i])
 216             if match:
 217                 formatline = i
 218                 format = int(match.group(4))
 219                 if format > 1 and format < currentFormat:
 220                     lines[i] = "Format %d" % (format + 1)
 221                     only_comment = 0
 222                 elif format == currentFormat:
 223                     # nothing to do
 224                     return format
 225                 else:
 226                     error('Cannot convert file format %s' % format)
 227             else:
 228                 lines.insert(i, "Format 2")
 229                 only_comment = 0
 230                 continue
 231
 232         # Don't get confused by LaTeX code
 233         if re_Preamble.match(lines[i]):
 234             i += 1
 235             while i < len(lines) and not re_EndPreamble.match(lines[i]):
 236                 i += 1
 237             continue
 238         if re_LangPreamble.match(lines[i]):
 239             i += 1
 240             while i < len(lines) and not re_EndLangPreamble.match(lines[i]):
 241                 i += 1
 242             continue
 243         if re_BabelPreamble.match(lines[i]):
 244             i += 1
 245             while i < len(lines) and not re_EndBabelPreamble.match(lines[i]):
 246                 i += 1
 247             continue
 248
 249         # This just involved new features, not any changes to old ones
 250         if format >= 14 and format <= 19:
 251           i += 1
 252           continue
 253
 254         # Rename I18NPreamble to BabelPreamble
 255         if format == 13:
 256             match = re_I18nPreamble.match(lines[i])
 257             if match:
 258                 lines[i] = match.group(1) + "BabelPreamble"
 259                 i += 1
 260                 match = re_EndI18nPreamble.match(lines[i])
 261                 while i < len(lines) and not match:
 262                     i += 1
 263                     match = re_EndI18nPreamble.match(lines[i])
 264                 lines[i] = match.group(1) + "EndBabelPreamble"
 265                 i += 1
 266                 continue
 267
 268         # These just involved new features, not any changes to old ones
 269         if format == 11 or format == 12:
 270           i += 1
 271           continue
 272
 273         if format == 10:
 274             match = re_UseMod.match(lines[i])
 275             if match:
 276                 module = match.group(1)
 277                 lines[i] = "DefaultModule " + module
 278             i += 1
 279             continue
 280
 281         if format == 9:
 282             match = re_Counter.match(lines[i])
 283             if match:
 284                 counterline = i
 285                 i += 1
 286                 while i < len(lines):
 287                     namem = re_Name.match(lines[i])
 288                     if namem:
 289                         name = namem.group(1)
 290                         lines.pop(i)
 291                         lines[counterline] = "Counter %s" % name
 292                         # we don't need to increment i
 293                         continue
 294                     endem = re_End.match(lines[i])
 295                     if endem:
 296                         i += 1
 297                         break
 298                     i += 1
 299             i += 1
 300             continue
 301
 302         if format == 8:
 303             # We want to scan for ams-type includes and, if we find them,
 304             # add corresponding UseModule tags to the layout.
 305             match = re_AMSMaths.match(lines[i])
 306             if match:
 307                 addstring("theorems-ams", usemodules)
 308                 addstring("theorems-ams-extended", usemodules)
 309                 addstring("theorems-sec", usemodules)
 310                 lines.pop(i)
 311                 continue
 312             match = re_AMSMathsPlain.match(lines[i])
 313             if match:
 314                 addstring("theorems-starred", usemodules)
 315                 lines.pop(i)
 316                 continue
 317             match = re_AMSMathsSeq.match(lines[i])
 318             if match:
 319                 addstring("theorems-ams", usemodules)
 320                 addstring("theorems-ams-extended", usemodules)
 321                 lines.pop(i)
 322                 continue
 323             i += 1
 324             continue
 325
 326         # These just involved new features, not any changes to old ones
 327         if format >= 5 and format <= 7:
 328           i += 1
 329           continue
 330
 331         if format == 4:
 332             # Handle conversion to long CharStyle names
 333             match = re_CharStyle.match(lines[i])
 334             if match:
 335                 lines[i] = "InsetLayout CharStyle:%s" % (match.group(3))
 336                 i += 1
 337                 lines.insert(i, "\tLyXType charstyle")
 338                 i += 1
 339                 lines.insert(i, "")
 340                 lines[i] = "\tLabelString %s" % (match.group(3))
 341             i += 1
 342             continue
 343
 344         if format == 3:
 345             # convert 'providesamsmath x',  'providesmakeidx x',  'providesnatbib x',  'providesurl x' to
 346             #         'provides amsmath x', 'provides makeidx x', 'provides natbib x', 'provides url x'
 347             # x is either 0 or 1
 348             match = re_Provides.match(lines[i])
 349             if match:
 350                 lines[i] = "%sProvides %s%s%s" % (match.group(1), match.group(2).lower(),
 351                                                   match.group(3), match.group(4))
 352             i += 1
 353             continue
 354
 355         if format == 2:
 356             caption = []
 357
 358             # delete caption styles
 359             match = re_Style.match(lines[i])
 360             if match:
 361                 style = string.lower(match.group(4))
 362                 if style == "caption":
 363                     del lines[i]
 364                     while i < len(lines) and not re_End.match(lines[i]):
 365                         caption.append(lines[i])
 366                         del lines[i]
 367                     if i == len(lines):
 368                         error('Incomplete caption style.')
 369                     else:
 370                         del lines[i]
 371                         continue
 372
 373             # delete undefinition of caption styles
 374             match = re_NoStyle.match(lines[i])
 375             if match:
 376                 style = string.lower(match.group(4))
 377                 if style == "caption":
 378                     del lines[i]
 379                     continue
 380
 381             # replace the CopyStyle statement with the definition of the real
 382             # style. This may result in duplicate statements, but that is OK
 383             # since the second one will overwrite the first one.
 384             match = re_CopyStyle.match(lines[i])
 385             if match:
 386                 style = string.lower(match.group(4))
 387                 if style == "caption":
 388                     if len(caption) > 0:
 389                         lines[i:i+1] = caption
 390                     else:
 391                         # FIXME: This style comes from an include file, we
 392                         # should replace the real style and not this default.
 393                         lines[i:i+1] = ['       Margin                First_Dynamic',
 394                                         '       LatexType             Command',
 395                                         '       LatexName             caption',
 396                                         '       NeedProtect           1',
 397                                         '       LabelSep              xx',
 398                                         '       ParSkip               0.4',
 399                                         '       TopSep                0.5',
 400                                         '       Align                 Center',
 401                                         '       AlignPossible         Center',
 402                                         '       LabelType             Sensitive',
 403                                         '       LabelString           "Senseless!"',
 404                                         '       OptionalArgs          1',
 405                                         '       LabelFont',
 406                                         '         Series              Bold',
 407                                         '       EndFont']
 408
 409             i += 1
 410             continue
 411
 412         # Delete MaxCounter and remember the value of it
 413         match = re_MaxCounter.match(lines[i])
 414         if match:
 415             level = match.group(4)
 416             if string.lower(level) == "counter_chapter":
 417                 maxcounter = 0
 418             elif string.lower(level) == "counter_section":
 419                 maxcounter = 1
 420             elif string.lower(level) == "counter_subsection":
 421                 maxcounter = 2
 422             elif string.lower(level) == "counter_subsubsection":
 423                 maxcounter = 3
 424             elif string.lower(level) == "counter_paragraph":
 425                 maxcounter = 4
 426             elif string.lower(level) == "counter_subparagraph":
 427                 maxcounter = 5
 428             elif string.lower(level) == "counter_enumi":
 429                 maxcounter = 6
 430             elif string.lower(level) == "counter_enumii":
 431                 maxcounter = 7
 432             elif string.lower(level) == "counter_enumiii":
 433                 maxcounter = 8
 434             del lines[i]
 435             continue
 436
 437         # Replace line
 438         #
 439         # LabelType Counter_EnumI
 440         #
 441         # with two lines
 442         #
 443         # LabelType Counter
 444         # LabelCounter EnumI
 445         #
 446         match = re_LabelType.match(lines[i])
 447         if match:
 448             label = match.group(4)
 449             # Remember indenting space for later reuse in added lines
 450             space1 = match.group(1)
 451             # Remember the line for adding the LabelCounter later.
 452             # We can't do it here because it could shift latextype_line etc.
 453             labeltype_line = i
 454             if string.lower(label[:8]) == "counter_":
 455                 counter = string.lower(label[8:])
 456                 lines[i] = re_LabelType.sub(r'\1\2\3Counter', lines[i])
 457
 458         # Remember the LabelString line
 459         match = re_LabelString.match(lines[i])
 460         if match:
 461             labelstring = match.group(4)
 462             labelstring_line = i
 463
 464         # Remember the LabelStringAppendix line
 465         match = re_LabelStringAppendix.match(lines[i])
 466         if match:
 467             labelstringappendix = match.group(4)
 468             labelstringappendix_line = i
 469
 470         # Remember the LatexType line
 471         match = re_LatexType.match(lines[i])
 472         if match:
 473             latextype = string.lower(match.group(4))
 474             latextype_line = i
 475
 476         # Remember the TocLevel line
 477         match = re_TocLevel.match(lines[i])
 478         if match:
 479             toclevel = string.lower(match.group(4))
 480
 481         # Reset variables at the beginning of a style definition
 482         match = re_Style.match(lines[i])
 483         if match:
 484             style = string.lower(match.group(4))
 485             counter = ""
 486             toclevel = ""
 487             label = ""
 488             space1 = ""
 489             labelstring = ""
 490             labelstringappendix = ""
 491             labelstring_line = -1
 492             labelstringappendix_line = -1
 493             labeltype_line = -1
 494             latextype = ""
 495             latextype_line = -1
 496
 497         if re_End.match(lines[i]):
 498
 499             # Add a line "LatexType Bib_Environment" if LabelType is Bibliography
 500             # (or change the existing LatexType)
 501             if string.lower(label) == "bibliography":
 502                 if (latextype_line < 0):
 503                     lines.insert(i, "%sLatexType Bib_Environment" % space1)
 504                     i += 1
 505                 else:
 506                     lines[latextype_line] = re_LatexType.sub(r'\1\2\3Bib_Environment', lines[latextype_line])
 507
 508             # Change "LabelType Static" to "LabelType Itemize" for itemize environments
 509             if latextype == "item_environment" and string.lower(label) == "static":
 510                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Itemize', lines[labeltype_line])
 511
 512             # Change "LabelType Counter_EnumI" to "LabelType Enumerate" for enumerate environments
 513             if latextype == "item_environment" and string.lower(label) == "counter_enumi":
 514                 lines[labeltype_line] = re_LabelType.sub(r'\1\2\3Enumerate', lines[labeltype_line])
 515                 # Don't add the LabelCounter line later
 516                 counter = ""
 517
 518             # Replace
 519             #
 520             # LabelString "Chapter"
 521             #
 522             # with
 523             #
 524             # LabelString "Chapter \arabic{chapter}"
 525             #
 526             # if this style has a counter. Ditto for LabelStringAppendix.
 527             # This emulates the hardcoded article style numbering of 1.3
 528             #
 529             if counter != "":
 530                 if counters.has_key(style):
 531                     if labelstring_line < 0:
 532                         lines.insert(i, '%sLabelString "%s"' % (space1, counters[style]))
 533                         i += 1
 534                     else:
 535                         new_labelstring = concatenate_label(labelstring, counters[style])
 536                         lines[labelstring_line] = re_LabelString.sub(
 537                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
 538                                 lines[labelstring_line])
 539                 if appendixcounters.has_key(style):
 540                     if labelstringappendix_line < 0:
 541                         lines.insert(i, '%sLabelStringAppendix "%s"' % (space1, appendixcounters[style]))
 542                         i += 1
 543                     else:
 544                         new_labelstring = concatenate_label(labelstring, appendixcounters[style])
 545                         lines[labelstringappendix_line] = re_LabelStringAppendix.sub(
 546                                 r'\1\2\3%s' % new_labelstring.replace("\\", "\\\\"),
 547                                 lines[labelstringappendix_line])
 548
 549                 # Now we can safely add the LabelCounter line
 550                 lines.insert(labeltype_line + 1, "%sLabelCounter %s" % (space1, counter))
 551                 i += 1
 552
 553             # Add the TocLevel setting for sectioning styles
 554             if toclevel == "" and toclevels.has_key(style) and maxcounter <= toclevels[style]:
 555                 lines.insert(i, '%s\tTocLevel %d' % (space1, toclevels[style]))
 556                 i += 1
 557
 558         i += 1
 559
 560     if usemodules:
 561         i = formatline + 1
 562         for mod in usemodules:
 563             lines.insert(i, "UseModule " + mod)
 564             i += 1
 565
 566     return format + 1
 567
 568
 569 def main(argv):
 570
 571     # Open files
 572     if len(argv) == 1:
 573         source = sys.stdin
 574         output = sys.stdout
 575     elif len(argv) == 3:
 576         source = open(argv[1], 'rb')
 577         output = open(argv[2], 'wb')
 578     else:
 579         error(usage(argv[0]))
 580
 581     # Do the real work
 582     lines = read(source)
 583     format = 1
 584     while (format < currentFormat):
 585         format = convert(lines)
 586     write(output, lines)
 587
 588     # Close files
 589     if len(argv) == 3:
 590         source.close()
 591         output.close()
 592
 593     return 0
 594
 595
 596 if __name__ == "__main__":
 597     main(sys.argv)