1 # -*- coding: utf-8 -*-
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.
9 # Full author contact details are available in file CREDITS
11 # This file houses conversion information for the preferences file.
13 # The converter functions take a line as argument and return a list:
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.
18 # Incremented to format 2, r39670 by jrioux
19 # Support for multiple file extensions per format.
20 # No conversion necessary.
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.
27 # Incremented to format 4, r40028 by vfr
28 # Remove support for default paper size.
30 # Incremented to format 5, r40030 by vfr
31 # Add a default length unit.
32 # No conversion necessary.
34 # Incremented to format 6, r40515 by younes
35 # Add use_qimage option.
36 # No conversion necessary.
38 # Incremented to format 7, r40789 by gb
39 # Add mime type to file format
41 # Incremented to format 8, 288c1e0f by rgh
42 # Add "nice" flag for converters
43 # No conversion necessary.
45 # Incremented to format 9, a18af620 by spitz
46 # Remove default_language rc.
48 # Incremented to format 10, 4985015 by tommaso
49 # Add close_buffer_with_last_view in preferences.
50 # No conversion necessary.
52 # Incremented to format 11, by gb
53 # Split pdf format into pdf and pdf6
55 # Incremented to format 12, by vfr
56 # Add option to use the system's theme icons
57 # No conversion necessary.
59 # Incremented to format 13, by bh
60 # Rename mac_like_word_movement to mac_like_cursor_movement
62 # Incremented to format 14, by spitz
63 # New RC default_otf_view_format
64 # No conversion necessary.
66 # Incremented to format 15, by prannoy
67 # Add fullscreen_statusbar
68 # No conversion necessary.
70 # Incremented to format 16, by lasgouttes
71 # Remove force_paint_single_char rc.
73 # Incremented to format 17, by lasgouttes
74 # Remove rtl_support rc.
76 # Incremented to format 18, by ef
77 # Add option to allow saving the document directory
78 # No conversion necessary.
80 # Incremented to format 19, by rgh
81 # remove print support
83 # Incremented to format 20, by tommaso
84 # Add options to forbid/ignore 'needauth' option
85 # No conversion necessary.
87 # Incremented to format 21, by spitz
88 # Add jbibtex_alternatives, allow "automatic" value
89 # of bibtex_command and jbibtex_command (actually the
91 # No conversion necessary.
93 # Incremented to format 22, by ef
94 # Add pygmentize_command for the python pygments syntax highlighter
95 # No conversion necessary.
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.
102 # Incremented to format 24, by spitz
103 # Rename collapsable to collapsible
105 # Incremented to format 25, by lasgouttes
106 # Remove use_qimage preference
108 # Incremented to format 26, by spitz
109 # Rename font_encoding preference
111 # Incremented to format 27, by spitz
112 # Add optional flavor value to needaux flag
114 # Incremented to format 28, by spitz
115 # Remove date_insert_format
117 # Incremented to format 29, by lasgouttes
118 # Remove use_pixmap_cache
120 # NOTE: The format should also be updated in LYXRC.cpp and
125 ###########################################################
129 def get_format(line):
136 while i < len(line) and line[i] != '"':
137 if line[i] == '\\' and i < len(line) - 1 and line[i+1] == '"':
142 entries.append(line[beg:end].replace('\\"', '"'))
145 elif not line[i].isspace():
147 while i < len(line) and not line[i].isspace():
150 entries.append(line[beg:end])
155 def simple_renaming(line, old, new):
156 i = line.lower().find(old.lower())
159 line = line[:i] + new + line[i+len(old):]
162 no_match = (False, [])
164 ######################################
165 ### Format 1 conversions (for LyX 2.0)
167 def remove_obsolete(line):
168 tags = ("\\use_tempdir", "\\spell_command", "\\personal_dictionary",
169 "\\plaintext_roff_command", "\\use_alt_language",
170 "\\use_escape_chars", "\\use_input_encoding",
171 "\\use_personal_dictionary", "\\use_pspell",
173 line = line.lower().lstrip()
175 if line.lower().startswith(tag):
180 def language_use_babel(line):
181 if not line.lower().startswith("\language_use_babel"):
183 re_lub = re.compile(r'^\\language_use_babel\s+"?(true|false)', re.IGNORECASE)
184 m = re_lub.match(line)
189 newline = "\\language_package_selection " + newval
190 return (True, newline)
193 def language_package(line):
194 return simple_renaming(line, "\\language_package", "\\language_custom_package")
197 lfre = re.compile(r'^\\converter\s+"?(\w+)"?\s+"?(\w+)"?\s+"([^"]*?)"\s+"latex"', re.IGNORECASE)
198 def latex_flavor(line):
199 if not line.lower().startswith("\\converter"):
208 "luatex": "lualatex",
212 if conv in conv2fl.keys():
213 flavor = conv2fl[conv]
216 if flavor == "latex":
219 "\\converter \"%s\" \"%s\" \"%s\" \"latex=%s\"" % (conv, fmat, args, flavor))
222 emre = re.compile(r'^\\format\s+(.*)\s+"(document[^"]*?)"', re.IGNORECASE)
223 def export_menu(line):
224 if not line.lower().startswith("\\format"):
232 "\\Format %s \"%s,menu=export\"" % (fmat, opts))
234 # End format 1 conversions (for LyX 2.0)
235 ########################################
237 #################################
238 # Conversions from LyX 2.0 to 2.1
239 zipre = re.compile(r'^\\format\s+("?dia"?\s+.*)\s+"([^"]*?)"', re.IGNORECASE)
240 def zipped_native(line):
241 if not line.lower().startswith("\\format"):
243 m = zipre.match(line)
249 "\\Format %s \"%s,zipped=native\"" % (fmat, opts))
251 def remove_default_papersize(line):
252 if not line.lower().startswith("\\default_papersize"):
256 def add_mime_types(line):
257 if not line.lower().startswith("\\format"):
259 entries = get_format(line)
263 converted = converted + ' ""'
265 formats = {'tgif':'application/x-tgif', \
266 'fig':'application/x-xfig', \
267 'dia':'application/x-dia-diagram', \
268 'odg':'application/vnd.oasis.opendocument.graphics', \
269 'svg':'image/svg+xml', \
270 'bmp':'image/x-bmp', \
272 'jpg':'image/jpeg', \
273 'pbm':'image/x-portable-bitmap', \
274 'pgm':'image/x-portable-graymap', \
275 'png':'image/x-png', \
276 'ppm':'image/x-portable-pixmap', \
277 'tiff':'image/tiff', \
278 'xbm':'image/x-xbitmap', \
279 'xpm':'image/x-xpixmap', \
280 'docbook-xml':'application/docbook+xml', \
281 'dot':'text/vnd.graphviz', \
282 'ly':'text/x-lilypond', \
283 'latex':'text/x-tex', \
284 'text':'text/plain', \
285 'gnumeric':'application/x-gnumeric', \
286 'excel':'application/vnd.ms-excel', \
287 'oocalc':'application/vnd.oasis.opendocument.spreadsheet', \
288 'xhtml':'application/xhtml+xml', \
289 'bib':'text/x-bibtex', \
290 'eps':'image/x-eps', \
291 'ps':'application/postscript', \
292 'pdf':'application/pdf', \
293 'dvi':'application/x-dvi', \
294 'html':'text/html', \
295 'odt':'application/vnd.oasis.opendocument.text', \
296 'sxw':'application/vnd.sun.xml.writer', \
297 'rtf':'application/rtf', \
298 'doc':'application/msword', \
300 'lyx':'application/x-lyx', \
301 'wmf':'image/x-wmf', \
303 if entries[1] in formats.keys():
304 converted = converted + ' "' + formats[entries[1]] + '"'
306 converted = converted + ' ""'
307 return (True, converted)
309 re_converter = re.compile(r'^\\converter\s+', re.IGNORECASE)
311 def split_pdf_format(line):
312 # strictly speaking, a new format would not require to bump the
313 # version number, but the old pdf format was hardcoded at several
314 # places in the C++ code, so an update seemed like a good idea.
315 if line.lower().startswith("\\format"):
316 entries = get_format(line)
317 if entries[1] == 'pdf':
322 converted = line.replace('application/pdf', '') + '''
323 \Format pdf6 pdf "PDF (graphics)" "" "''' + viewer + '" "" "vector" "application/pdf"'
324 return (True, converted)
325 elif line.lower().startswith("\\viewer_alternatives") or \
326 line.lower().startswith("\\editor_alternatives"):
327 entries = get_format(line)
328 if entries[1] == 'pdf':
329 converted = line + "\n" + entries[0] + ' pdf6 "' + entries[2] + '"'
330 return (True, converted)
331 elif re_converter.match(line):
332 entries = get_format(line)
333 # The only converter from pdf that is touched is pdf->eps:
334 # All other converters are likely meant for further processing on export.
335 # The only converter to pdf that stays untouched is dvi->pdf:
336 # All other converters are likely meant for graphics.
337 if len(entries) > 2 and \
338 ((entries[1] == 'pdf' and entries[2] == 'eps') or \
339 (entries[1] != 'ps' and entries[2] == 'pdf')):
340 if entries[1] == 'pdf':
341 converted = entries[0] + ' pdf6 ' + entries[2]
343 converted = entries[0] + ' ' + entries[1] + ' pdf6'
345 while i < len(entries):
346 converted = converted + ' "' + entries[i] + '"'
348 return (True, converted)
351 def remove_default_language(line):
352 if not line.lower().startswith("\\default_language"):
356 def mac_cursor_movement(line):
357 return simple_renaming(line, "\\mac_like_word_movement", "\\mac_like_cursor_movement")
359 # End conversions for LyX 2.0 to 2.1
360 ####################################
363 #################################
364 # Conversions from LyX 2.1 to 2.2
366 def remove_force_paint_single_char(line):
367 if not line.lower().startswith("\\force_paint_single_char"):
371 def remove_rtl(line):
372 if not line.lower().startswith("\\rtl "):
376 def remove_print_support(line):
377 tags = ("\\printer", "\\print_adapt_output", "\\print_command",
378 "\\print_evenpage_flag", "\\print_oddpage_flag", "\\print_pagerange_flag",
379 "\\print_copies_flag", "\\print_collcopies_flag", "\\print_reverse_flag",
380 "\\print_to_printer", "\\print_to_file", "\\print_file_extension")
381 line = line.lower().lstrip()
383 if line.lower().startswith(tag):
387 # End conversions for LyX 2.1 to 2.2
388 ####################################
391 #################################
392 # Conversions from LyX 2.2 to 2.3
394 def rename_collapsible(line):
395 return simple_renaming(line, "\\set_color \"collapsable", "\\set_color \"collapsible")
397 # End conversions for LyX 2.2 to 2.3
398 ####################################
401 #################################
402 # Conversions from LyX 2.3 to 2.4
404 def remove_use_qimage(line):
405 if not line.lower().startswith("\\use_qimage "):
409 def remove_font_encoding(line):
410 if not line.lower().startswith("\\font_encoding "):
414 def remove_date_insert_format(line):
415 if not line.lower().startswith("\\date_insert_format "):
419 def remove_use_pixmap_cache(line):
420 if not line.lower().startswith("\\use_pixmap_cache "):
424 # End conversions for LyX 2.3 to 2.4
425 ####################################
429 ############################################################
430 # Format-conversion map. Also add empty format changes here.
433 [ 1, [ # there were several conversions for format 1
441 [ 3, [ zipped_native ]],
442 [ 4, [ remove_default_papersize ]],
445 [ 7, [add_mime_types]],
447 [ 9, [ remove_default_language ]],
449 [ 11, [split_pdf_format]],
451 [ 13, [mac_cursor_movement]],
454 [ 16, [remove_force_paint_single_char]],
457 [ 19, [remove_print_support]],
462 [ 24, [rename_collapsible]],
463 [ 25, [remove_use_qimage]],
464 [ 26, [remove_font_encoding]],
466 [ 28, [remove_date_insert_format]],
467 [ 29, [remove_use_pixmap_cache]]