lib/scripts/prefs2prefs_prefs.py

   1 # -*- coding: utf-8 -*-
   2
   3 # file prefs2prefs-prefs.py
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6
   7 # author Richard Heck
   8
   9 # Full author contact details are available in file CREDITS
  10
  11 # This file houses conversion information for the preferences file.
  12
  13 # The converter functions take a line as argument and return a list:
  14 #       (Bool, NewLine),
  15 # where the Bool says if  we've modified anything and the NewLine is
  16 # the new line, if so, which will be used to replace the old line.
  17
  18 # Incremented to format 2, r39670 by jrioux
  19 #   Support for multiple file extensions per format.
  20 #   No conversion necessary.
  21
  22 # Incremented to format 3, r39705 by tommaso
  23 #   Support for file formats that are natively (g)zipped.
  24 #   We must add the flag zipped=native to formats that
  25 #   were previously hardcoded in the C++ source: dia.
  26
  27 # Incremented to format 4, r40028 by vfr
  28 #   Remove support for default paper size.
  29
  30 # Incremented to format 5, r40030 by vfr
  31 #   Add a default length unit.
  32 #   No conversion necessary.
  33
  34 # Incremented to format 6, r40515 by younes
  35 #   Add use_qimage option.
  36 #   No conversion necessary.
  37
  38 # Incremented to format 7, r40789 by gb
  39 #   Add mime type to file format
  40
  41 # Incremented to format 8, 288c1e0f by rgh
  42 #   Add "nice" flag for converters
  43 #   No conversion necessary.
  44
  45 # Incremented to format 9, a18af620 by spitz
  46 #  Remove default_language rc.
  47
  48 # Incremented to format 10, 4985015 by tommaso
  49 #  Add close_buffer_with_last_view in preferences.
  50 #  No conversion necessary.
  51
  52 # Incremented to format 11, by gb
  53 #   Split pdf format into pdf and pdf6
  54
  55 # Incremented to format 12, by vfr
  56 #   Add option to use the system's theme icons
  57 #   No conversion necessary.
  58
  59 # Incremented to format 13, by bh
  60 #   Rename mac_like_word_movement to mac_like_cursor_movement
  61
  62 # Incremented to format 14, by spitz
  63 #   New RC default_otf_view_format
  64 #   No conversion necessary.
  65
  66 # Incremented to format 15, by prannoy
  67 #   Add fullscreen_statusbar
  68 #   No conversion necessary.
  69
  70 # Incremented to format 16, by lasgouttes
  71 #  Remove force_paint_single_char rc.
  72
  73 # Incremented to format 17, by lasgouttes
  74 #  Remove rtl_support rc.
  75
  76 # Incremented to format 18, by ef
  77 #   Add option to allow saving the document directory
  78 #   No conversion necessary.
  79
  80 # Incremented to format 19, by rgh
  81 #   remove print support
  82
  83 # Incremented to format 20, by tommaso
  84 #   Add options to forbid/ignore 'needauth' option
  85 #   No conversion necessary.
  86
  87 # Incremented to format 21, by spitz
  88 #   Add jbibtex_alternatives, allow "automatic" value
  89 #   of bibtex_command and jbibtex_command (actually the
  90 #   default now)
  91 #   No conversion necessary.
  92
  93 # Incremented to format 22, by ef
  94 #   Add pygmentize_command for the python pygments syntax highlighter
  95 #   No conversion necessary.
  96
  97 # Incremented to format 23, by spitz
  98 #   Add default_platex_view_format, a default output format for
  99 #   Japanese documents via pLaTeX.
 100 #   No conversion necessary.
 101
 102 # Incremented to format 24, by spitz
 103 #   Rename collapsable to collapsible
 104
 105 # Incremented to format 25, by lasgouttes
 106 #   Remove use_qimage preference
 107
 108 # Incremented to format 26, by spitz
 109 #   Rename font_encoding preference
 110
 111 # Incremented to format 27, by spitz
 112 #   Add optional flavor value to needaux flag
 113
 114 # Incremented to format 28, by spitz
 115 #   Remove date_insert_format
 116
 117 # Incremented to format 29, by lasgouttes
 118 #   Remove use_pixmap_cache
 119
 120 # Incremented to format 30, by lasgouttes
 121 #   Add respect_os_kbd_language.
 122 #   No convergence necessary.
 123
 124 # Incremented to format 31, by spitz
 125 #   Add ct_additions_underlined.
 126 #   No convergence necessary.
 127
 128 # Incremented to format 32, by spitz
 129 #   Add ct_markup_copied.
 130 #   No convergence necessary.
 131
 132 # NOTE: The format should also be updated in LYXRC.cpp and
 133 # in configure.py.
 134
 135 import re
 136
 137 ###########################################################
 138 #
 139 # Conversion chain
 140
 141 def get_format(line):
 142         entries = []
 143         i = 0
 144         while i < len(line):
 145                 if line[i] == '"':
 146                         beg = i + 1
 147                         i = i + 1
 148                         while i < len(line) and line[i] != '"':
 149                                 if line[i] == '\\' and i < len(line) - 1 and line[i+1] == '"':
 150                                         # convert \" to "
 151                                         i = i + 1
 152                                 i = i + 1
 153                         end = i
 154                         entries.append(line[beg:end].replace('\\"', '"'))
 155                 elif line[i] == '#':
 156                         return entries
 157                 elif not line[i].isspace():
 158                         beg = i
 159                         while i < len(line) and not line[i].isspace():
 160                                 i = i + 1
 161                         end = i
 162                         entries.append(line[beg:end])
 163                 i = i + 1
 164         return entries
 165
 166
 167 def simple_renaming(line, old, new):
 168         i = line.lower().find(old.lower())
 169         if i == -1:
 170                 return no_match
 171         line = line[:i] + new + line[i+len(old):]
 172         return (True, line)
 173
 174 no_match = (False, [])
 175
 176 ######################################
 177 ### Format 1 conversions (for LyX 2.0)
 178
 179 def remove_obsolete(line):
 180         tags = ("\\use_tempdir", "\\spell_command", "\\personal_dictionary",
 181                 "\\plaintext_roff_command", "\\use_alt_language",
 182                 "\\use_escape_chars", "\\use_input_encoding",
 183                 "\\use_personal_dictionary", "\\use_pspell",
 184                 "\\use_spell_lib")
 185         line = line.lower().lstrip()
 186         for tag in tags:
 187                 if line.lower().startswith(tag):
 188                         return (True, "")
 189         return no_match
 190
 191
 192 def language_use_babel(line):
 193         if not line.lower().startswith("\language_use_babel"):
 194                 return no_match
 195         re_lub = re.compile(r'^\\language_use_babel\s+"?(true|false)', re.IGNORECASE)
 196         m = re_lub.match(line)
 197         val = m.group(1)
 198         newval = '0'
 199         if val == 'false':
 200                 newval = '3'
 201         newline = "\\language_package_selection " + newval
 202         return (True, newline)
 203
 204
 205 def language_package(line):
 206         return simple_renaming(line, "\\language_package", "\\language_custom_package")
 207
 208
 209 lfre = re.compile(r'^\\converter\s+"?(\w+)"?\s+"?(\w+)"?\s+"([^"]*?)"\s+"latex"', re.IGNORECASE)
 210 def latex_flavor(line):
 211         if not line.lower().startswith("\\converter"):
 212                 return no_match
 213         m = lfre.match(line)
 214         if not m:
 215                 return no_match
 216         conv = m.group(1)
 217         fmat = m.group(2)
 218         args = m.group(3)
 219         conv2fl = {
 220                    "luatex":   "lualatex",
 221                    "pplatex":  "latex",
 222                    "xetex":    "xelatex",
 223                   }
 224         if conv in conv2fl.keys():
 225                 flavor = conv2fl[conv]
 226         else:
 227                 flavor = conv
 228         if flavor == "latex":
 229                 return no_match
 230         return (True,
 231                 "\\converter \"%s\" \"%s\" \"%s\" \"latex=%s\"" % (conv, fmat, args, flavor))
 232
 233
 234 emre = re.compile(r'^\\format\s+(.*)\s+"(document[^"]*?)"', re.IGNORECASE)
 235 def export_menu(line):
 236         if not line.lower().startswith("\\format"):
 237                 return no_match
 238         m = emre.match(line)
 239         if not m:
 240                 return no_match
 241         fmat = m.group(1)
 242         opts = m.group(2)
 243         return (True,
 244                 "\\Format %s \"%s,menu=export\"" % (fmat, opts))
 245
 246 # End format 1 conversions (for LyX 2.0)
 247 ########################################
 248
 249 #################################
 250 # Conversions from LyX 2.0 to 2.1
 251 zipre = re.compile(r'^\\format\s+("?dia"?\s+.*)\s+"([^"]*?)"', re.IGNORECASE)
 252 def zipped_native(line):
 253         if not line.lower().startswith("\\format"):
 254                 return no_match
 255         m = zipre.match(line)
 256         if not m:
 257                 return no_match
 258         fmat = m.group(1)
 259         opts = m.group(2)
 260         return (True,
 261                 "\\Format %s \"%s,zipped=native\"" % (fmat, opts))
 262
 263 def remove_default_papersize(line):
 264         if not line.lower().startswith("\\default_papersize"):
 265                 return no_match
 266         return (True, "")
 267
 268 def add_mime_types(line):
 269         if not line.lower().startswith("\\format"):
 270                 return no_match
 271         entries = get_format(line)
 272         converted = line
 273         i = len(entries)
 274         while i < 7:
 275                 converted = converted + '       ""'
 276                 i = i + 1
 277         formats = {'tgif':'application/x-tgif', \
 278                 'fig':'application/x-xfig', \
 279                 'dia':'application/x-dia-diagram', \
 280                 'odg':'application/vnd.oasis.opendocument.graphics', \
 281                 'svg':'image/svg+xml', \
 282                 'bmp':'image/x-bmp', \
 283                 'gif':'image/gif', \
 284                 'jpg':'image/jpeg', \
 285                 'pbm':'image/x-portable-bitmap', \
 286                 'pgm':'image/x-portable-graymap', \
 287                 'png':'image/x-png', \
 288                 'ppm':'image/x-portable-pixmap', \
 289                 'tiff':'image/tiff', \
 290                 'xbm':'image/x-xbitmap', \
 291                 'xpm':'image/x-xpixmap', \
 292                 'docbook-xml':'application/docbook+xml', \
 293                 'dot':'text/vnd.graphviz', \
 294                 'ly':'text/x-lilypond', \
 295                 'latex':'text/x-tex', \
 296                 'text':'text/plain', \
 297                 'gnumeric':'application/x-gnumeric', \
 298                 'excel':'application/vnd.ms-excel', \
 299                 'oocalc':'application/vnd.oasis.opendocument.spreadsheet', \
 300                 'xhtml':'application/xhtml+xml', \
 301                 'bib':'text/x-bibtex', \
 302                 'eps':'image/x-eps', \
 303                 'ps':'application/postscript', \
 304                 'pdf':'application/pdf', \
 305                 'dvi':'application/x-dvi', \
 306                 'html':'text/html', \
 307                 'odt':'application/vnd.oasis.opendocument.text', \
 308                 'sxw':'application/vnd.sun.xml.writer', \
 309                 'rtf':'application/rtf', \
 310                 'doc':'application/msword', \
 311                 'csv':'text/csv', \
 312                 'lyx':'application/x-lyx', \
 313                 'wmf':'image/x-wmf', \
 314                 'emf':'image/x-emf'}
 315         if entries[1] in formats.keys():
 316                 converted = converted + '       "' + formats[entries[1]] + '"'
 317         else:
 318                 converted = converted + '       ""'
 319         return (True, converted)
 320
 321 re_converter = re.compile(r'^\\converter\s+', re.IGNORECASE)
 322
 323 def split_pdf_format(line):
 324         # strictly speaking, a new format would not require to bump the
 325         # version number, but the old pdf format was hardcoded at several
 326         # places in the C++ code, so an update seemed like a good idea.
 327         if line.lower().startswith("\\format"):
 328                 entries = get_format(line)
 329                 if entries[1] == 'pdf':
 330                         if len(entries) < 6:
 331                                 viewer = ''
 332                         else:
 333                                 viewer = entries[5]
 334                         converted = line.replace('application/pdf', '') + '''
 335 \Format pdf6       pdf    "PDF (graphics)"        "" "''' + viewer + '" ""      "vector"        "application/pdf"'
 336                         return (True, converted)
 337         elif line.lower().startswith("\\viewer_alternatives") or \
 338              line.lower().startswith("\\editor_alternatives"):
 339                 entries = get_format(line)
 340                 if entries[1] == 'pdf':
 341                         converted = line + "\n" + entries[0] + ' pdf6 "' + entries[2] + '"'
 342                         return (True, converted)
 343         elif re_converter.match(line):
 344                 entries = get_format(line)
 345                 # The only converter from pdf that is touched is pdf->eps:
 346                 # All other converters are likely meant for further processing on export.
 347                 # The only converter to pdf that stays untouched is dvi->pdf:
 348                 # All other converters are likely meant for graphics.
 349                 if len(entries) > 2 and \
 350                    ((entries[1] == 'pdf' and entries[2] == 'eps') or \
 351                    (entries[1] != 'ps'  and entries[2] == 'pdf')):
 352                         if entries[1] == 'pdf':
 353                                 converted = entries[0] + ' pdf6 ' + entries[2]
 354                         else:
 355                                 converted = entries[0] + ' ' + entries[1] + ' pdf6'
 356                         i = 3
 357                         while i < len(entries):
 358                                 converted = converted + ' "' + entries[i] + '"'
 359                                 i = i + 1
 360                         return (True, converted)
 361         return no_match
 362
 363 def remove_default_language(line):
 364         if not line.lower().startswith("\\default_language"):
 365                 return no_match
 366         return (True, "")
 367
 368 def mac_cursor_movement(line):
 369         return simple_renaming(line, "\\mac_like_word_movement", "\\mac_like_cursor_movement")
 370
 371 # End conversions for LyX 2.0 to 2.1
 372 ####################################
 373
 374
 375 #################################
 376 # Conversions from LyX 2.1 to 2.2
 377
 378 def remove_force_paint_single_char(line):
 379         if not line.lower().startswith("\\force_paint_single_char"):
 380                 return no_match
 381         return (True, "")
 382
 383 def remove_rtl(line):
 384         if not line.lower().startswith("\\rtl "):
 385                 return no_match
 386         return (True, "")
 387
 388 def remove_print_support(line):
 389         tags = ("\\printer", "\\print_adapt_output", "\\print_command",
 390                 "\\print_evenpage_flag", "\\print_oddpage_flag", "\\print_pagerange_flag",
 391                 "\\print_copies_flag", "\\print_collcopies_flag", "\\print_reverse_flag",
 392                 "\\print_to_printer", "\\print_to_file", "\\print_file_extension")
 393         line = line.lower().lstrip()
 394         for tag in tags:
 395                 if line.lower().startswith(tag):
 396                         return (True, "")
 397         return no_match
 398
 399 # End conversions for LyX 2.1 to 2.2
 400 ####################################
 401
 402
 403 #################################
 404 # Conversions from LyX 2.2 to 2.3
 405
 406 def rename_collapsible(line):
 407         return simple_renaming(line, "\\set_color \"collapsable", "\\set_color \"collapsible")
 408
 409 # End conversions for LyX 2.2 to 2.3
 410 ####################################
 411
 412
 413 #################################
 414 # Conversions from LyX 2.3 to 2.4
 415
 416 def remove_use_qimage(line):
 417         if not line.lower().startswith("\\use_qimage "):
 418                 return no_match
 419         return (True, "")
 420
 421 def remove_font_encoding(line):
 422         if not line.lower().startswith("\\font_encoding "):
 423                 return no_match
 424         return (True, "")
 425
 426 def remove_date_insert_format(line):
 427         if not line.lower().startswith("\\date_insert_format "):
 428                 return no_match
 429         return (True, "")
 430
 431 def remove_use_pixmap_cache(line):
 432         if not line.lower().startswith("\\use_pixmap_cache "):
 433                 return no_match
 434         return (True, "")
 435
 436 # End conversions for LyX 2.3 to 2.4
 437 ####################################
 438
 439
 440
 441 ############################################################
 442 # Format-conversion map. Also add empty format changes here.
 443
 444 conversions = [
 445         [  1, [ # there were several conversions for format 1
 446                 export_menu,
 447                 latex_flavor,
 448                 remove_obsolete,
 449                 language_use_babel,
 450                 language_package
 451         ]],
 452         [ 2, []],
 453         [ 3, [ zipped_native ]],
 454         [ 4, [ remove_default_papersize ]],
 455         [ 5, []],
 456         [ 6, []],
 457         [ 7, [add_mime_types]],
 458         [ 8, []],
 459         [ 9, [ remove_default_language ]],
 460         [ 10, []],
 461         [ 11, [split_pdf_format]],
 462         [ 12, []],
 463         [ 13, [mac_cursor_movement]],
 464         [ 14, []],
 465         [ 15, []],
 466         [ 16, [remove_force_paint_single_char]],
 467         [ 17, [remove_rtl]],
 468         [ 18, []],
 469         [ 19, [remove_print_support]],
 470         [ 20, []],
 471         [ 21, []],
 472         [ 22, []],
 473         [ 23, []],
 474         [ 24, [rename_collapsible]],
 475         [ 25, [remove_use_qimage]],
 476         [ 26, [remove_font_encoding]],
 477         [ 27, []],
 478         [ 28, [remove_date_insert_format]],
 479         [ 29, [remove_use_pixmap_cache]],
 480         [ 30, []],
 481         [ 31, []],
 482         [ 32, []]
 483 ]