]> git.lyx.org Git - lyx.git/blobdiff - lib/scripts/prefs2prefs_prefs.py
update layout files to format 101
[lyx.git] / lib / scripts / prefs2prefs_prefs.py
index 8d02f711e37317731057df1ab9acc4f830a396a1..a5a3a7dbf1bc418bffd00c0afce51047520dd82f 100644 (file)
@@ -1,20 +1,35 @@
-#! /usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# file prefs2prefs-lfuns.py
+# file prefs2prefs-prefs.py
 # This file is part of LyX, the document processor.
 # Licence details can be found in the file COPYING.
 
-# author Richard Heck
+# author Richard Kimberly Heck
 
 # Full author contact details are available in file CREDITS
 
 # This file houses conversion information for the preferences file.
 
-# The converter functions take a line as argument and return a list: 
-#      (Bool, NewLine), 
-# where the Bool says if  we've modified anything and the NewLine is 
+# There are two kinds of converter functions.
+# 
+# Most of them take a line as argument and return a list:
+#     (Bool, NewLine),
+# where the Bool says if we've modified anything and the NewLine is
 # the new line, if so, which will be used to replace the old line.
+# This can be used to erase lines (return (True, "")) or to modify 
+# existing preference lines.
+# 
+# It is also possible for conversion routines to accept the whole
+# list of lines and process that. This is useful (as in the change
+# to format 35) when you need to add a preference if it's not already
+# there.
+
+
+######################################################################
+#
+# FORMAT CHANGES
+#
+######################################################################
 
 # Incremented to format 2, r39670 by jrioux
 #   Support for multiple file extensions per format.
 
 # Incremented to format 8, 288c1e0f by rgh
 #   Add "nice" flag for converters
+#   No conversion necessary.
+
+# Incremented to format 9, a18af620 by spitz
+#  Remove default_language rc.
+
+# Incremented to format 10, 4985015 by tommaso
+#  Add close_buffer_with_last_view in preferences.
+#  No conversion necessary.
+
+# Incremented to format 11, by gb
+#   Split pdf format into pdf and pdf6
+
+# Incremented to format 12, by vfr
+#   Add option to use the system's theme icons
+#   No conversion necessary.
+
+# Incremented to format 13, by bh
+#   Rename mac_like_word_movement to mac_like_cursor_movement
+
+# Incremented to format 14, by spitz
+#   New RC default_otf_view_format
+#   No conversion necessary.
+
+# Incremented to format 15, by prannoy
+#   Add fullscreen_statusbar
+#   No conversion necessary.
+
+# Incremented to format 16, by lasgouttes
+#  Remove force_paint_single_char rc.
+
+# Incremented to format 17, by lasgouttes
+#  Remove rtl_support rc.
+
+# Incremented to format 18, by ef
+#   Add option to allow saving the document directory
+#   No conversion necessary.
+
+# Incremented to format 19, by rgh
+#   remove print support
+
+# Incremented to format 20, by tommaso
+#   Add options to forbid/ignore 'needauth' option
+#   No conversion necessary.
+
+# Incremented to format 21, by spitz
+#   Add jbibtex_alternatives, allow "automatic" value
+#   of bibtex_command and jbibtex_command (actually the
+#   default now)
+#   No conversion necessary.
+
+# Incremented to format 22, by ef
+#   Add pygmentize_command for the python pygments syntax highlighter
+#   No conversion necessary.
+
+# Incremented to format 23, by spitz
+#   Add default_platex_view_format, a default output format for
+#   Japanese documents via pLaTeX.
+#   No conversion necessary.
+
+# Incremented to format 24, by spitz
+#   Rename collapsable to collapsible
+
+# Incremented to format 25, by lasgouttes
+#   Remove use_qimage preference
+
+# Incremented to format 26, by spitz
+#   Rename font_encoding preference
+
+# Incremented to format 27, by spitz
+#   Add optional flavor value to needaux flag
+
+# Incremented to format 28, by spitz
+#   Remove date_insert_format
+
+# Incremented to format 29, by lasgouttes
+#   Remove use_pixmap_cache
+
+# Incremented to format 30, by lasgouttes
+#   Add respect_os_kbd_language.
+#   No convergence necessary.
+
+# Incremented to format 31, by spitz
+#   Add ct_additions_underlined.
+#   No convergence necessary.
+
+# Incremented to format 32, by spitz
+#   Add ct_markup_copied.
+#   No convergence necessary.
+
+# Incremented to format 33, by sanda
+#   Add \citation_search, \citation_search_pattern
+#   and \citation_search_view.
+#   No conversion necessary.
+
+# Incremented to format 34, by yuriy
+#   Rename *.kmap files for Cyrillic languages
+
+# Incremented to format 35, by spitz
+#   \set_color now takes three arguments
+#   \set_color lyxname x11hexname x11darkhexname
+
+# Incremented to format 36, by rkh
+#   Set spellcheck_continuously to FALSE if it is not otherwise set
+#   (the new default is true, so this keeps behavior the same for 
+#   existing users)
+
+# Incremented to format 37, by chillenb
+#  Remove \fullscreen_width
+#  Remove \fullscreen_limit
+#  Add \screen_width
+#  Add \screen_limit
+
+# NOTE: The format should also be updated in LYXRC.cpp and
+# in configure.py (search for lyxrc_fileformat).
 
 import re
 
@@ -66,7 +195,7 @@ def get_format(line):
                        return entries
                elif not line[i].isspace():
                        beg = i
-                       while not line[i].isspace():
+                       while i < len(line) and not line[i].isspace():
                                i = i + 1
                        end = i
                        entries.append(line[beg:end])
@@ -83,23 +212,24 @@ def simple_renaming(line, old, new):
 
 no_match = (False, [])
 
-########################
-### Format 1 conversions
+######################################
+### Format 1 conversions (for LyX 2.0)
 
 def remove_obsolete(line):
        tags = ("\\use_tempdir", "\\spell_command", "\\personal_dictionary",
-                               "\\plaintext_roff_command", "\\use_alt_language", 
-                               "\\use_escape_chars", "\\use_input_encoding",
-                               "\\use_personal_dictionary", "\\use_pspell",
-                               "\\use_spell_lib")
+               "\\plaintext_roff_command", "\\use_alt_language",
+               "\\use_escape_chars", "\\use_input_encoding",
+               "\\use_personal_dictionary", "\\use_pspell",
+               "\\use_spell_lib")
        line = line.lower().lstrip()
        for tag in tags:
                if line.lower().startswith(tag):
                        return (True, "")
        return no_match
 
+
 def language_use_babel(line):
-       if not line.lower().startswith("\language_use_babel"):
+       if not line.lower().startswith(r"\language_use_babel"):
                return no_match
        re_lub = re.compile(r'^\\language_use_babel\s+"?(true|false)', re.IGNORECASE)
        m = re_lub.match(line)
@@ -110,9 +240,11 @@ def language_use_babel(line):
        newline = "\\language_package_selection " + newval
        return (True, newline)
 
+
 def language_package(line):
        return simple_renaming(line, "\\language_package", "\\language_custom_package")
 
+
 lfre = re.compile(r'^\\converter\s+"?(\w+)"?\s+"?(\w+)"?\s+"([^"]*?)"\s+"latex"', re.IGNORECASE)
 def latex_flavor(line):
        if not line.lower().startswith("\\converter"):
@@ -137,6 +269,7 @@ def latex_flavor(line):
        return (True,
                "\\converter \"%s\" \"%s\" \"%s\" \"latex=%s\"" % (conv, fmat, args, flavor))
 
+
 emre = re.compile(r'^\\format\s+(.*)\s+"(document[^"]*?)"', re.IGNORECASE)
 def export_menu(line):
        if not line.lower().startswith("\\format"):
@@ -149,6 +282,11 @@ def export_menu(line):
        return (True,
                "\\Format %s \"%s,menu=export\"" % (fmat, opts))
 
+# End format 1 conversions (for LyX 2.0)
+########################################
+
+#################################
+# Conversions from LyX 2.0 to 2.1
 zipre = re.compile(r'^\\format\s+("?dia"?\s+.*)\s+"([^"]*?)"', re.IGNORECASE)
 def zipped_native(line):
        if not line.lower().startswith("\\format"):
@@ -219,12 +357,163 @@ def add_mime_types(line):
                converted = converted + '       ""'
        return (True, converted)
 
+re_converter = re.compile(r'^\\converter\s+', re.IGNORECASE)
+
+def split_pdf_format(line):
+       # strictly speaking, a new format would not require to bump the
+       # version number, but the old pdf format was hardcoded at several
+       # places in the C++ code, so an update seemed like a good idea.
+       if line.lower().startswith("\\format"):
+               entries = get_format(line)
+               if entries[1] == 'pdf':
+                       if len(entries) < 6:
+                               viewer = ''
+                       else:
+                               viewer = entries[5]
+                       converted = line.replace('application/pdf', '') + r'''
+\Format pdf6       pdf    "PDF (graphics)"        "" "''' + viewer + '"        ""      "vector"        "application/pdf"'
+                       return (True, converted)
+       elif line.lower().startswith("\\viewer_alternatives") or \
+            line.lower().startswith("\\editor_alternatives"):
+               entries = get_format(line)
+               if entries[1] == 'pdf':
+                       converted = line + "\n" + entries[0] + ' pdf6 "' + entries[2] + '"'
+                       return (True, converted)
+       elif re_converter.match(line):
+               entries = get_format(line)
+               # The only converter from pdf that is touched is pdf->eps:
+               # All other converters are likely meant for further processing on export.
+               # The only converter to pdf that stays untouched is dvi->pdf:
+               # All other converters are likely meant for graphics.
+               if len(entries) > 2 and \
+                  ((entries[1] == 'pdf' and entries[2] == 'eps') or \
+                  (entries[1] != 'ps'  and entries[2] == 'pdf')):
+                       if entries[1] == 'pdf':
+                               converted = entries[0] + ' pdf6 ' + entries[2]
+                       else:
+                               converted = entries[0] + ' ' + entries[1] + ' pdf6'
+                       i = 3
+                       while i < len(entries):
+                               converted = converted + ' "' + entries[i] + '"'
+                               i = i + 1
+                       return (True, converted)
+       return no_match
+
+def remove_default_language(line):
+       if not line.lower().startswith("\\default_language"):
+               return no_match
+       return (True, "")
+
+def mac_cursor_movement(line):
+       return simple_renaming(line, "\\mac_like_word_movement", "\\mac_like_cursor_movement")
+
+# End conversions for LyX 2.0 to 2.1
+####################################
+
+
+#################################
+# Conversions from LyX 2.1 to 2.2
+
+def remove_force_paint_single_char(line):
+       if not line.lower().startswith("\\force_paint_single_char"):
+               return no_match
+       return (True, "")
+
+def remove_rtl(line):
+       if not line.lower().startswith("\\rtl "):
+               return no_match
+       return (True, "")
+
+def remove_print_support(line):
+       tags = ("\\printer", "\\print_adapt_output", "\\print_command",
+               "\\print_evenpage_flag", "\\print_oddpage_flag", "\\print_pagerange_flag",
+               "\\print_copies_flag", "\\print_collcopies_flag", "\\print_reverse_flag",
+               "\\print_to_printer", "\\print_to_file", "\\print_file_extension")
+       line = line.lower().lstrip()
+       for tag in tags:
+               if line.lower().startswith(tag):
+                       return (True, "")
+       return no_match
+
+# End conversions for LyX 2.1 to 2.2
+####################################
+
+
+#################################
+# Conversions from LyX 2.2 to 2.3
+
+def rename_collapsible(line):
+       return simple_renaming(line, "\\set_color \"collapsable", "\\set_color \"collapsible")
+
+# End conversions for LyX 2.2 to 2.3
+####################################
+
+
+#################################
+# Conversions from LyX 2.3 to 2.4
+
+def remove_use_qimage(line):
+       if not line.lower().startswith("\\use_qimage "):
+               return no_match
+       return (True, "")
+
+def remove_font_encoding(line):
+       if not line.lower().startswith("\\font_encoding "):
+               return no_match
+       return (True, "")
+
+def remove_date_insert_format(line):
+       if not line.lower().startswith("\\date_insert_format "):
+               return no_match
+       return (True, "")
+
+def remove_use_pixmap_cache(line):
+       if not line.lower().startswith("\\use_pixmap_cache "):
+               return no_match
+       return (True, "")
+
+def rename_cyrillic_kmap_files(line):
+       line = line.lower()
+       if not (line.startswith("\\kbmap_primary ")
+                       or line.startswith("\\kbmap_secondary ")):
+               return no_match
+       line = line.replace('"bg-bds-1251"', '"bulgarian"')
+       line = line.replace('"koi8-r"', '"russian"')
+       line = line.replace('"koi8-u"', '"ukrainian"')
+       return (True, line)
+
+def add_dark_color(line):
+       if not line.lower().startswith("\\set_color "):
+               return no_match
+       colre = re.compile(r'^\\set_color\s+("[^"]+")\s+("[^"]+")\s*$', re.IGNORECASE)
+       m = colre.match(line)
+       if not m:
+               return no_match
+       line += " " + m.group(2)
+       return (True, line)
+
+def add_spellcheck_default(lines):
+       for l in lines:
+               if l.startswith("\\spellcheck_continuously"):
+                       return
+       lines.append("\\spellcheck_continuously false")
+
+def remove_fullscreen_widthlimit(line):
+       lower = line.lower()
+       if lower.startswith("\\fullscreen_width") or lower.startswith("\\fullscreen_limit"):
+               return (True, "")
+       return no_match
+
+# End conversions for LyX 2.3 to 2.4
+####################################
+
 
-########################
 
+############################################################
+# Format-conversion map. Also add empty format changes here.
 
 conversions = [
-       [  1, [ # this will be a long list of conversions to format 1
+       [  1, [ # there were several conversions for format 1
                export_menu,
                latex_flavor,
                remove_obsolete,
@@ -237,5 +526,34 @@ conversions = [
        [ 5, []],
        [ 6, []],
        [ 7, [add_mime_types]],
-       [ 8, []]
+       [ 8, []],
+       [ 9, [ remove_default_language ]],
+       [ 10, []],
+       [ 11, [split_pdf_format]],
+       [ 12, []],
+       [ 13, [mac_cursor_movement]],
+       [ 14, []],
+       [ 15, []],
+       [ 16, [remove_force_paint_single_char]],
+       [ 17, [remove_rtl]],
+       [ 18, []],
+       [ 19, [remove_print_support]],
+       [ 20, []],
+       [ 21, []],
+       [ 22, []],
+       [ 23, []],
+       [ 24, [rename_collapsible]],
+       [ 25, [remove_use_qimage]],
+       [ 26, [remove_font_encoding]],
+       [ 27, []],
+       [ 28, [remove_date_insert_format]],
+       [ 29, [remove_use_pixmap_cache]],
+       [ 30, []],
+       [ 31, []],
+       [ 32, []],
+       [ 33, []],
+       [ 34, [rename_cyrillic_kmap_files]],
+       [ 35, [add_dark_color]],
+       [ 36, [add_spellcheck_default]],
+       [ 37, [remove_fullscreen_widthlimit]]
 ]