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 # Incremented to format 33, by sanda
 133 #   Add \citation_search_view.
 134 #   No conversion necessary.
 135
 136
 137 # NOTE: The format should also be updated in LYXRC.cpp and
 138 # in configure.py.
 139
 140 import re
 141
 142 ###########################################################
 143 #
 144 # Conversion chain
 145
 146 def get_format(line):
 147         entries = []
 148         i = 0
 149         while i < len(line):
 150                 if line[i] == '"':
 151                         beg = i + 1
 152                         i = i + 1
 153                         while i < len(line) and line[i] != '"':
 154                                 if line[i] == '\\' and i < len(line) - 1 and line[i+1] == '"':
 155                                         # convert \" to "
 156                                         i = i + 1
 157                                 i = i + 1
 158                         end = i
 159                         entries.append(line[beg:end].replace('\\"', '"'))
 160                 elif line[i] == '#':
 161                         return entries
 162                 elif not line[i].isspace():
 163                         beg = i
 164                         while i < len(line) and not line[i].isspace():
 165                                 i = i + 1
 166                         end = i
 167                         entries.append(line[beg:end])
 168                 i = i + 1
 169         return entries
 170
 171
 172 def simple_renaming(line, old, new):
 173         i = line.lower().find(old.lower())
 174         if i == -1:
 175                 return no_match
 176         line = line[:i] + new + line[i+len(old):]
 177         return (True, line)
 178
 179 no_match = (False, [])
 180
 181 ######################################
 182 ### Format 1 conversions (for LyX 2.0)
 183
 184 def remove_obsolete(line):
 185         tags = ("\\use_tempdir", "\\spell_command", "\\personal_dictionary",
 186                 "\\plaintext_roff_command", "\\use_alt_language",
 187                 "\\use_escape_chars", "\\use_input_encoding",
 188                 "\\use_personal_dictionary", "\\use_pspell",
 189                 "\\use_spell_lib")
 190         line = line.lower().lstrip()
 191         for tag in tags:
 192                 if line.lower().startswith(tag):
 193                         return (True, "")
 194         return no_match
 195
 196
 197 def language_use_babel(line):
 198         if not line.lower().startswith("\language_use_babel"):
 199                 return no_match
 200         re_lub = re.compile(r'^\\language_use_babel\s+"?(true|false)', re.IGNORECASE)
 201         m = re_lub.match(line)
 202         val = m.group(1)
 203         newval = '0'
 204         if val == 'false':
 205                 newval = '3'
 206         newline = "\\language_package_selection " + newval
 207         return (True, newline)
 208
 209
 210 def language_package(line):
 211         return simple_renaming(line, "\\language_package", "\\language_custom_package")
 212
 213
 214 lfre = re.compile(r'^\\converter\s+"?(\w+)"?\s+"?(\w+)"?\s+"([^"]*?)"\s+"latex"', re.IGNORECASE)
 215 def latex_flavor(line):
 216         if not line.lower().startswith("\\converter"):
 217                 return no_match
 218         m = lfre.match(line)
 219         if not m:
 220                 return no_match
 221         conv = m.group(1)
 222         fmat = m.group(2)
 223         args = m.group(3)
 224         conv2fl = {
 225                    "luatex":   "lualatex",
 226                    "pplatex":  "latex",
 227                    "xetex":    "xelatex",
 228                   }
 229         if conv in conv2fl.keys():
 230                 flavor = conv2fl[conv]
 231         else:
 232                 flavor = conv
 233         if flavor == "latex":
 234                 return no_match
 235         return (True,
 236                 "\\converter \"%s\" \"%s\" \"%s\" \"latex=%s\"" % (conv, fmat, args, flavor))
 237
 238
 239 emre = re.compile(r'^\\format\s+(.*)\s+"(document[^"]*?)"', re.IGNORECASE)
 240 def export_menu(line):
 241         if not line.lower().startswith("\\format"):
 242                 return no_match
 243         m = emre.match(line)
 244         if not m:
 245                 return no_match
 246         fmat = m.group(1)
 247         opts = m.group(2)
 248         return (True,
 249                 "\\Format %s \"%s,menu=export\"" % (fmat, opts))
 250
 251 # End format 1 conversions (for LyX 2.0)
 252 ########################################
 253
 254 #################################
 255 # Conversions from LyX 2.0 to 2.1
 256 zipre = re.compile(r'^\\format\s+("?dia"?\s+.*)\s+"([^"]*?)"', re.IGNORECASE)
 257 def zipped_native(line):
 258         if not line.lower().startswith("\\format"):
 259                 return no_match
 260         m = zipre.match(line)
 261         if not m:
 262                 return no_match
 263         fmat = m.group(1)
 264         opts = m.group(2)
 265         return (True,
 266                 "\\Format %s \"%s,zipped=native\"" % (fmat, opts))
 267
 268 def remove_default_papersize(line):
 269         if not line.lower().startswith("\\default_papersize"):
 270                 return no_match
 271         return (True, "")
 272
 273 def add_mime_types(line):
 274         if not line.lower().startswith("\\format"):
 275                 return no_match
 276         entries = get_format(line)
 277         converted = line
 278         i = len(entries)
 279         while i < 7:
 280                 converted = converted + '       ""'
 281                 i = i + 1
 282         formats = {'tgif':'application/x-tgif', \
 283                 'fig':'application/x-xfig', \
 284                 'dia':'application/x-dia-diagram', \
 285                 'odg':'application/vnd.oasis.opendocument.graphics', \
 286                 'svg':'image/svg+xml', \
 287                 'bmp':'image/x-bmp', \
 288                 'gif':'image/gif', \
 289                 'jpg':'image/jpeg', \
 290                 'pbm':'image/x-portable-bitmap', \
 291                 'pgm':'image/x-portable-graymap', \
 292                 'png':'image/x-png', \
 293                 'ppm':'image/x-portable-pixmap', \
 294                 'tiff':'image/tiff', \
 295                 'xbm':'image/x-xbitmap', \
 296                 'xpm':'image/x-xpixmap', \
 297                 'docbook-xml':'application/docbook+xml', \
 298                 'dot':'text/vnd.graphviz', \
 299                 'ly':'text/x-lilypond', \
 300                 'latex':'text/x-tex', \
 301                 'text':'text/plain', \
 302                 'gnumeric':'application/x-gnumeric', \
 303                 'excel':'application/vnd.ms-excel', \
 304                 'oocalc':'application/vnd.oasis.opendocument.spreadsheet', \
 305                 'xhtml':'application/xhtml+xml', \
 306                 'bib':'text/x-bibtex', \
 307                 'eps':'image/x-eps', \
 308                 'ps':'application/postscript', \
 309                 'pdf':'application/pdf', \
 310                 'dvi':'application/x-dvi', \
 311                 'html':'text/html', \
 312                 'odt':'application/vnd.oasis.opendocument.text', \
 313                 'sxw':'application/vnd.sun.xml.writer', \
 314                 'rtf':'application/rtf', \
 315                 'doc':'application/msword', \
 316                 'csv':'text/csv', \
 317                 'lyx':'application/x-lyx', \
 318                 'wmf':'image/x-wmf', \
 319                 'emf':'image/x-emf'}
 320         if entries[1] in formats.keys():
 321                 converted = converted + '       "' + formats[entries[1]] + '"'
 322         else:
 323                 converted = converted + '       ""'
 324         return (True, converted)
 325
 326 re_converter = re.compile(r'^\\converter\s+', re.IGNORECASE)
 327
 328 def split_pdf_format(line):
 329         # strictly speaking, a new format would not require to bump the
 330         # version number, but the old pdf format was hardcoded at several
 331         # places in the C++ code, so an update seemed like a good idea.
 332         if line.lower().startswith("\\format"):
 333                 entries = get_format(line)
 334                 if entries[1] == 'pdf':
 335                         if len(entries) < 6:
 336                                 viewer = ''
 337                         else:
 338                                 viewer = entries[5]
 339                         converted = line.replace('application/pdf', '') + '''
 340 \Format pdf6       pdf    "PDF (graphics)"        "" "''' + viewer + '" ""      "vector"        "application/pdf"'
 341                         return (True, converted)
 342         elif line.lower().startswith("\\viewer_alternatives") or \
 343              line.lower().startswith("\\editor_alternatives"):
 344                 entries = get_format(line)
 345                 if entries[1] == 'pdf':
 346                         converted = line + "\n" + entries[0] + ' pdf6 "' + entries[2] + '"'
 347                         return (True, converted)
 348         elif re_converter.match(line):
 349                 entries = get_format(line)
 350                 # The only converter from pdf that is touched is pdf->eps:
 351                 # All other converters are likely meant for further processing on export.
 352                 # The only converter to pdf that stays untouched is dvi->pdf:
 353                 # All other converters are likely meant for graphics.
 354                 if len(entries) > 2 and \
 355                    ((entries[1] == 'pdf' and entries[2] == 'eps') or \
 356                    (entries[1] != 'ps'  and entries[2] == 'pdf')):
 357                         if entries[1] == 'pdf':
 358                                 converted = entries[0] + ' pdf6 ' + entries[2]
 359                         else:
 360                                 converted = entries[0] + ' ' + entries[1] + ' pdf6'
 361                         i = 3
 362                         while i < len(entries):
 363                                 converted = converted + ' "' + entries[i] + '"'
 364                                 i = i + 1
 365                         return (True, converted)
 366         return no_match
 367
 368 def remove_default_language(line):
 369         if not line.lower().startswith("\\default_language"):
 370                 return no_match
 371         return (True, "")
 372
 373 def mac_cursor_movement(line):
 374         return simple_renaming(line, "\\mac_like_word_movement", "\\mac_like_cursor_movement")
 375
 376 # End conversions for LyX 2.0 to 2.1
 377 ####################################
 378
 379
 380 #################################
 381 # Conversions from LyX 2.1 to 2.2
 382
 383 def remove_force_paint_single_char(line):
 384         if not line.lower().startswith("\\force_paint_single_char"):
 385                 return no_match
 386         return (True, "")
 387
 388 def remove_rtl(line):
 389         if not line.lower().startswith("\\rtl "):
 390                 return no_match
 391         return (True, "")
 392
 393 def remove_print_support(line):
 394         tags = ("\\printer", "\\print_adapt_output", "\\print_command",
 395                 "\\print_evenpage_flag", "\\print_oddpage_flag", "\\print_pagerange_flag",
 396                 "\\print_copies_flag", "\\print_collcopies_flag", "\\print_reverse_flag",
 397                 "\\print_to_printer", "\\print_to_file", "\\print_file_extension")
 398         line = line.lower().lstrip()
 399         for tag in tags:
 400                 if line.lower().startswith(tag):
 401                         return (True, "")
 402         return no_match
 403
 404 # End conversions for LyX 2.1 to 2.2
 405 ####################################
 406
 407
 408 #################################
 409 # Conversions from LyX 2.2 to 2.3
 410
 411 def rename_collapsible(line):
 412         return simple_renaming(line, "\\set_color \"collapsable", "\\set_color \"collapsible")
 413
 414 # End conversions for LyX 2.2 to 2.3
 415 ####################################
 416
 417
 418 #################################
 419 # Conversions from LyX 2.3 to 2.4
 420
 421 def remove_use_qimage(line):
 422         if not line.lower().startswith("\\use_qimage "):
 423                 return no_match
 424         return (True, "")
 425
 426 def remove_font_encoding(line):
 427         if not line.lower().startswith("\\font_encoding "):
 428                 return no_match
 429         return (True, "")
 430
 431 def remove_date_insert_format(line):
 432         if not line.lower().startswith("\\date_insert_format "):
 433                 return no_match
 434         return (True, "")
 435
 436 def remove_use_pixmap_cache(line):
 437         if not line.lower().startswith("\\use_pixmap_cache "):
 438                 return no_match
 439         return (True, "")
 440
 441 # End conversions for LyX 2.3 to 2.4
 442 ####################################
 443
 444
 445
 446 ############################################################
 447 # Format-conversion map. Also add empty format changes here.
 448
 449 conversions = [
 450         [  1, [ # there were several conversions for format 1
 451                 export_menu,
 452                 latex_flavor,
 453                 remove_obsolete,
 454                 language_use_babel,
 455                 language_package
 456         ]],
 457         [ 2, []],
 458         [ 3, [ zipped_native ]],
 459         [ 4, [ remove_default_papersize ]],
 460         [ 5, []],
 461         [ 6, []],
 462         [ 7, [add_mime_types]],
 463         [ 8, []],
 464         [ 9, [ remove_default_language ]],
 465         [ 10, []],
 466         [ 11, [split_pdf_format]],
 467         [ 12, []],
 468         [ 13, [mac_cursor_movement]],
 469         [ 14, []],
 470         [ 15, []],
 471         [ 16, [remove_force_paint_single_char]],
 472         [ 17, [remove_rtl]],
 473         [ 18, []],
 474         [ 19, [remove_print_support]],
 475         [ 20, []],
 476         [ 21, []],
 477         [ 22, []],
 478         [ 23, []],
 479         [ 24, [rename_collapsible]],
 480         [ 25, [remove_use_qimage]],
 481         [ 26, [remove_font_encoding]],
 482         [ 27, []],
 483         [ 28, [remove_date_insert_format]],
 484         [ 29, [remove_use_pixmap_cache]],
 485         [ 30, []],
 486         [ 31, []],
 487         [ 32, []],
 488         [ 33, []]
 489 ]