1 # -*- coding: utf-8 -*-
2 # This file is part of lyx2lyx
3 # -*- coding: utf-8 -*-
4 # Copyright (C) 2016 The LyX team
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License
8 # as published by the Free Software Foundation; either version 2
9 # of the License, or (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 """ Convert files to the file format generated by lyx 2.3"""
26 # Uncomment only what you need to import, please.
28 from parser_tools import find_end_of#, find_token, find_tokens, \
29 # find_token_exact, find_end_of_inset, find_end_of_layout, \
30 # find_token_backwards, is_in_inset, get_value, get_quoted_value, \
31 # del_token, check_token, get_option_value, get_bool_value
33 from parser_tools import find_token, find_end_of_inset, get_value, \
36 from lyx2lyx_tools import add_to_preamble, put_cmd_in_ert
37 # get_ert, lyx2latex, \
38 # lyx2verbatim, length_in_bp, convert_info_insets
39 # insert_to_preamble, latex_length, revert_flex_inset, \
40 # revert_font_attrs, hex2ratio, str2bool
42 from lyx2lyx_tools import add_to_preamble, put_cmd_in_ert
44 ####################################################################
45 # Private helper functions
49 ###############################################################################
51 ### Conversion and reversion routines
53 ###############################################################################
55 def convert_microtype(document):
56 " Add microtype settings. "
57 i = find_token(document.header, "\\font_tt_scale" , 0)
59 document.warning("Malformed LyX document: Can't find \\font_tt_scale.")
60 i = len(document.header) - 1
62 j = find_token(document.preamble, "\\usepackage{microtype}", 0)
64 document.header.insert(i + 1, "\\use_microtype false")
66 document.header.insert(i + 1, "\\use_microtype true")
67 del document.preamble[j]
70 def revert_microtype(document):
71 " Remove microtype settings. "
72 i = find_token(document.header, "\\use_microtype", 0)
75 use_microtype = get_bool_value(document.header, "\\use_microtype" , i)
76 del document.header[i]
78 add_to_preamble(document, ["\\usepackage{microtype}"])
81 def convert_dateinset(document):
82 ' Convert date external inset to ERT '
85 i = find_token(document.body, "\\begin_inset External", i)
88 j = find_end_of_inset(document.body, i)
90 document.warning("Malformed lyx document: Missing '\\end_inset' in convert_dateinset.")
93 if get_value(document.body, 'template', i, j) == "Date":
94 document.body[i : j + 1] = put_cmd_in_ert("\\today ")
99 def convert_ibranches(document):
100 ' Add "inverted 0" to branch insets'
103 i = find_token(document.body, "\\begin_inset Branch", i)
106 document.body.insert(i + 1, "inverted 0")
110 def revert_ibranches(document):
111 ' Convert inverted branches to explicit anti-branches'
112 # Get list of branches
116 i = find_token(document.header, "\\branch", i)
119 branch = document.header[i][8:].strip()
120 if document.header[i+1].startswith("\\selected "):
121 #document.warning(document.header[i+1])
122 #document.warning(document.header[i+1][10])
123 selected = int(document.header[i+1][10])
125 document.warning("Malformed LyX document: No selection indicator for branch " + branch)
128 # the value tells us whether the branch is selected
129 ourbranches[document.header[i][8:].strip()] = selected
132 # Figure out what inverted branches, if any, have been used
133 # and convert them to "Anti-OldBranch"
137 i = find_token(document.body, "\\begin_inset Branch", i)
140 if not document.body[i+1].startswith("inverted "):
141 document.warning("Malformed LyX document: Missing 'inverted' tag!")
144 inverted = document.body[i+1][9]
145 #document.warning(document.body[i+1])
148 branch = document.body[i][20:].strip()
149 #document.warning(branch)
150 if not branch in ibranches:
151 antibranch = "Anti-" + branch
152 while antibranch in ibranches:
153 antibranch = "x" + antibranch
154 ibranches[branch] = antibranch
156 antibranch = ibranches[branch]
157 #document.warning(antibranch)
158 document.body[i] = "\\begin_inset Branch " + antibranch
160 # remove "inverted" key
161 del document.body[i+1]
164 # now we need to add the new branches to the header
165 for old, new in ibranches.iteritems():
166 i = find_token(document.header, "\\branch " + old, 0)
168 document.warning("Can't find branch %s even though we found it before!" % (old))
170 j = find_token(document.header, "\\end_branch", i)
172 document.warning("Malformed LyX document! Can't find end of branch " + old)
174 # ourbranches[old] - 1 inverts the selection status of the old branch
175 lines = ["\\branch " + new,
176 "\\selected " + str(ourbranches[old] - 1)]
177 # these are the old lines telling us color, etc.
178 lines += document.header[i+2 : j+1]
179 document.header[i:i] = lines
182 def revert_beamer_article_styles(document):
183 " Include (scr)article styles in beamer article "
185 beamer_articles = ["article-beamer", "scrarticle-beamer"]
186 if document.textclass not in beamer_articles:
189 inclusion = "article.layout"
190 if document.textclass == "scrarticle-beamer":
191 inclusion = "scrartcl.layout"
194 i = find_token(document.header, "\\begin_local_layout", 0)
196 k = find_token(document.header, "\\language", 0)
198 # this should not happen
199 document.warning("Malformed LyX document! No \\language header found!")
201 document.header[k-1 : k-1] = ["\\begin_local_layout", "\\end_local_layout"]
202 i = find_token(document.header, "\\begin_local_layout", 0)
204 j = find_end_of(document.header, i, "\\begin_local_layout", "\\end_local_layout")
206 # this should not happen
209 document.header[i+1 : i+1] = ["### Inserted by lyx2lyx (more [scr]article styles) ###",
210 "Input " + inclusion,
211 "Input beamer.layout",
212 "Provides geometry 0",
213 "Provides hyperref 0",
222 " \\usepackage{beamerarticle,pgf}",
223 " % this default might be overridden by plain title style",
224 " \\newcommand\makebeamertitle{\\frame{\\maketitle}}%",
225 " \\AtBeginDocument{",
226 " \\let\\origtableofcontents=\\tableofcontents",
227 " \\def\\tableofcontents{\\@ifnextchar[{\\origtableofcontents}{\\gobbletableofcontents}}",
228 " \\def\\gobbletableofcontents#1{\\origtableofcontents}",
231 "### End of insertion by lyx2lyx (more [scr]article styles) ###"]
235 def convert_beamer_article_styles(document):
236 " Remove included (scr)article styles in beamer article "
238 beamer_articles = ["article-beamer", "scrarticle-beamer"]
239 if document.textclass not in beamer_articles:
243 i = find_token(document.header, "\\begin_local_layout", 0)
247 j = find_end_of(document.header, i, "\\begin_local_layout", "\\end_local_layout")
249 # this should not happen
252 k = find_token(document.header, "### Inserted by lyx2lyx (more [scr]article styles) ###", i, j)
254 l = find_token(document.header, "### End of insertion by lyx2lyx (more [scr]article styles) ###", i, j)
256 # this should not happen
257 document.warning("End of lyx2lyx local layout insertion not found!")
260 document.header[k : l + 1] = []
265 def revert_bosnian(document):
266 "Set the document language to English but assure Bosnian output"
268 if document.language == "bosnian":
269 document.language = "english"
270 i = find_token(document.header, "\\language bosnian", 0)
272 document.header[i] = "\\language english"
273 j = find_token(document.header, "\\language_package default", 0)
275 document.header[j] = "\\language_package babel"
276 k = find_token(document.header, "\\options", 0)
278 document.header[k] = document.header[k].replace("\\options", "\\options bosnian,")
280 l = find_token(document.header, "\\use_default_options", 0)
281 document.header.insert(l + 1, "\\options bosnian")
284 def revert_friulan(document):
285 "Set the document language to English but assure Friulan output"
287 if document.language == "friulan":
288 document.language = "english"
289 i = find_token(document.header, "\\language friulan", 0)
291 document.header[i] = "\\language english"
292 j = find_token(document.header, "\\language_package default", 0)
294 document.header[j] = "\\language_package babel"
295 k = find_token(document.header, "\\options", 0)
297 document.header[k] = document.header[k].replace("\\options", "\\options friulan,")
299 l = find_token(document.header, "\\use_default_options", 0)
300 document.header.insert(l + 1, "\\options friulan")
303 def revert_macedonian(document):
304 "Set the document language to English but assure Macedonian output"
306 if document.language == "macedonian":
307 document.language = "english"
308 i = find_token(document.header, "\\language macedonian", 0)
310 document.header[i] = "\\language english"
311 j = find_token(document.header, "\\language_package default", 0)
313 document.header[j] = "\\language_package babel"
314 k = find_token(document.header, "\\options", 0)
316 document.header[k] = document.header[k].replace("\\options", "\\options macedonian,")
318 l = find_token(document.header, "\\use_default_options", 0)
319 document.header.insert(l + 1, "\\options macedonian")
322 def revert_piedmontese(document):
323 "Set the document language to English but assure Piedmontese output"
325 if document.language == "piedmontese":
326 document.language = "english"
327 i = find_token(document.header, "\\language piedmontese", 0)
329 document.header[i] = "\\language english"
330 j = find_token(document.header, "\\language_package default", 0)
332 document.header[j] = "\\language_package babel"
333 k = find_token(document.header, "\\options", 0)
335 document.header[k] = document.header[k].replace("\\options", "\\options piedmontese,")
337 l = find_token(document.header, "\\use_default_options", 0)
338 document.header.insert(l + 1, "\\options piedmontese")
341 def revert_romansh(document):
342 "Set the document language to English but assure Romansh output"
344 if document.language == "romansh":
345 document.language = "english"
346 i = find_token(document.header, "\\language romansh", 0)
348 document.header[i] = "\\language english"
349 j = find_token(document.header, "\\language_package default", 0)
351 document.header[j] = "\\language_package babel"
352 k = find_token(document.header, "\\options", 0)
354 document.header[k] = document.header[k].replace("\\options", "\\options romansh,")
356 l = find_token(document.header, "\\use_default_options", 0)
357 document.header.insert(l + 1, "\\options romansh")
360 def revert_amharic(document):
361 "Set the document language to English but assure Amharic output"
363 if document.language == "amharic":
364 document.language = "english"
365 i = find_token(document.header, "\\language amharic", 0)
367 document.header[i] = "\\language english"
368 j = find_token(document.header, "\\language_package default", 0)
370 document.header[j] = "\\language_package default"
371 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{amharic}}"])
372 document.body[2 : 2] = ["\\begin_layout Standard",
373 "\\begin_inset ERT", "status open", "",
374 "\\begin_layout Plain Layout", "", "",
376 "resetdefaultlanguage{amharic}",
377 "\\end_layout", "", "\\end_inset", "", "",
381 def revert_asturian(document):
382 "Set the document language to English but assure Asturian output"
384 if document.language == "asturian":
385 document.language = "english"
386 i = find_token(document.header, "\\language asturian", 0)
388 document.header[i] = "\\language english"
389 j = find_token(document.header, "\\language_package default", 0)
391 document.header[j] = "\\language_package default"
392 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{asturian}}"])
393 document.body[2 : 2] = ["\\begin_layout Standard",
394 "\\begin_inset ERT", "status open", "",
395 "\\begin_layout Plain Layout", "", "",
397 "resetdefaultlanguage{asturian}",
398 "\\end_layout", "", "\\end_inset", "", "",
402 def revert_kannada(document):
403 "Set the document language to English but assure Kannada output"
405 if document.language == "kannada":
406 document.language = "english"
407 i = find_token(document.header, "\\language kannada", 0)
409 document.header[i] = "\\language english"
410 j = find_token(document.header, "\\language_package default", 0)
412 document.header[j] = "\\language_package default"
413 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{kannada}}"])
414 document.body[2 : 2] = ["\\begin_layout Standard",
415 "\\begin_inset ERT", "status open", "",
416 "\\begin_layout Plain Layout", "", "",
418 "resetdefaultlanguage{kannada}",
419 "\\end_layout", "", "\\end_inset", "", "",
423 def revert_khmer(document):
424 "Set the document language to English but assure Khmer output"
426 if document.language == "khmer":
427 document.language = "english"
428 i = find_token(document.header, "\\language khmer", 0)
430 document.header[i] = "\\language english"
431 j = find_token(document.header, "\\language_package default", 0)
433 document.header[j] = "\\language_package default"
434 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{khmer}}"])
435 document.body[2 : 2] = ["\\begin_layout Standard",
436 "\\begin_inset ERT", "status open", "",
437 "\\begin_layout Plain Layout", "", "",
439 "resetdefaultlanguage{khmer}",
440 "\\end_layout", "", "\\end_inset", "", "",
444 def revert_urdu(document):
445 "Set the document language to English but assure Urdu output"
447 if document.language == "urdu":
448 document.language = "english"
449 i = find_token(document.header, "\\language urdu", 0)
451 document.header[i] = "\\language english"
452 j = find_token(document.header, "\\language_package default", 0)
454 document.header[j] = "\\language_package default"
455 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{urdu}}"])
456 document.body[2 : 2] = ["\\begin_layout Standard",
457 "\\begin_inset ERT", "status open", "",
458 "\\begin_layout Plain Layout", "", "",
460 "resetdefaultlanguage{urdu}",
461 "\\end_layout", "", "\\end_inset", "", "",
465 def revert_syriac(document):
466 "Set the document language to English but assure Syriac output"
468 if document.language == "syriac":
469 document.language = "english"
470 i = find_token(document.header, "\\language syriac", 0)
472 document.header[i] = "\\language english"
473 j = find_token(document.header, "\\language_package default", 0)
475 document.header[j] = "\\language_package default"
476 add_to_preamble(document, ["\\AtBeginDocument{\setotherlanguage{syriac}}"])
477 document.body[2 : 2] = ["\\begin_layout Standard",
478 "\\begin_inset ERT", "status open", "",
479 "\\begin_layout Plain Layout", "", "",
481 "resetdefaultlanguage{syriac}",
482 "\\end_layout", "", "\\end_inset", "", "",
490 supported_versions = ["2.3.0", "2.3"]
492 [509, [convert_microtype]],
493 [510, [convert_dateinset]],
494 [511, [convert_ibranches]],
495 [512, [convert_beamer_article_styles]],
502 [514, [revert_urdu, revert_syriac]],
503 [513, [revert_amharic, revert_asturian, revert_kannada, revert_khmer]],
504 [512, [revert_bosnian, revert_friulan, revert_macedonian, revert_piedmontese, revert_romansh]],
505 [511, [revert_beamer_article_styles]],
506 [510, [revert_ibranches]],
508 [508, [revert_microtype]]
512 if __name__ == "__main__":