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