1 # This file is part of lyx2lyx
2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2002 Dekel Tsur <dekel@lyx.org>
4 # Copyright (C) 2002-2004 José Matos <jamatos@lyx.org>
5 # Copyright (C) 2004-2005 Georg Baum <Georg.Baum@post.rwth-aachen.de>
7 # This program is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License
9 # as published by the Free Software Foundation; either version 2
10 # of the License, or (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 from os import access, F_OK
24 from parser_tools import find_token, find_end_of_inset, get_next_paragraph, \
25 get_paragraph, get_value, del_token, is_nonempty_line,\
26 find_tokens, find_end_of, find_token2, find_re
28 from string import replace, split, find, strip, join
30 from lyx_0_12 import update_latexaccents
33 # Remove \color default
35 def remove_color_default(file):
38 i = find_token(file.body, "\\color default", i)
41 file.body[i] = replace(file.body[i], "\\color default",
48 def add_end_header(file):
49 file.header.append("\\end_header");
52 def rm_end_header(file):
53 i = find_token(file.header, "\\end_header", 0)
60 # \SpecialChar ~ -> \InsetSpace ~
62 def convert_spaces(file):
63 for i in range(len(file.body)):
64 file.body[i] = replace(file.body[i],"\\SpecialChar ~","\\InsetSpace ~")
67 def revert_spaces(file):
68 for i in range(len(file.body)):
69 file.body[i] = replace(file.body[i],"\\InsetSpace ~", "\\SpecialChar ~")
73 # equivalent to lyx::support::escape()
75 def lyx_support_escape(lab):
76 hexdigit = ['0', '1', '2', '3', '4', '5', '6', '7',
77 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F']
81 if o >= 128 or c == '=' or c == '%':
83 enc = enc + hexdigit[o >> 4]
84 enc = enc + hexdigit[o & 15]
91 # \begin_inset LatexCommand \eqref -> ERT
93 def revert_eqref(file):
94 regexp = re.compile(r'^\\begin_inset\s+LatexCommand\s+\\eqref')
97 i = find_re(file.body, regexp, i)
100 eqref = lyx_support_escape(regexp.sub("", file.body[i]))
101 file.body[i:i+1] = ["\\begin_inset ERT", "status Collapsed", "",
102 "\\layout Standard", "", "\\backslash ",
110 def convert_bibtex(file):
111 for i in range(len(file.body)):
112 file.body[i] = replace(file.body[i],"\\begin_inset LatexCommand \\BibTeX",
113 "\\begin_inset LatexCommand \\bibtex")
116 def revert_bibtex(file):
117 for i in range(len(file.body)):
118 file.body[i] = replace(file.body[i], "\\begin_inset LatexCommand \\bibtex",
119 "\\begin_inset LatexCommand \\BibTeX")
125 def remove_insetparent(file):
128 i = find_token(file.body, "\\begin_inset LatexCommand \\lyxparent", i)
137 def convert_external(file):
138 external_rexp = re.compile(r'\\begin_inset External ([^,]*),"([^"]*)",')
139 external_header = "\\begin_inset External"
142 i = find_token(file.body, external_header, i)
145 look = external_rexp.search(file.body[i])
148 args[0] = look.group(1)
149 args[1] = look.group(2)
150 #FIXME: if the previous search fails then warn
152 if args[0] == "RasterImage":
153 # Convert a RasterImage External Inset to a Graphics Inset.
154 top = "\\begin_inset Graphics"
156 filename = "\tfilename " + args[1]
157 file.body[i:i+1] = [top, filename]
160 # Convert the old External Inset format to the new.
161 top = external_header
162 template = "\ttemplate " + args[0]
164 filename = "\tfilename " + args[1]
165 file.body[i:i+1] = [top, template, filename]
168 file.body[i:i+1] = [top, template]
172 def revert_external_1(file):
173 external_header = "\\begin_inset External"
176 i = find_token(file.body, external_header, i)
180 template = split(file.body[i+1])
184 filename = split(file.body[i+1])
188 params = split(file.body[i+1])
190 if file.body[i+1]: del file.body[i+1]
192 file.body[i] = file.body[i] + " " + template[0]+ ', "' + filename[0] + '", " '+ join(params[1:]) + '"'
196 def revert_external_2(file):
197 draft_token = '\tdraft'
200 i = find_token(file.body, '\\begin_inset External', i)
203 j = find_end_of_inset(file.body, i + 1)
205 #this should not happen
207 k = find_token(file.body, draft_token, i+1, j-1)
208 if (k != -1 and len(draft_token) == len(file.body[k])):
216 def convert_comment(file):
218 comment = "\\layout Comment"
220 i = find_token(file.body, comment, i)
224 file.body[i:i+1] = ["\\layout Standard","","",
225 "\\begin_inset Comment",
232 i = find_token(file.body, "\\layout", i)
234 i = len(file.body) - 1
235 file.body[i:i] = ["\\end_inset","",""]
238 j = find_token(file.body, '\\begin_deeper', old_i, i)
239 if j == -1: j = i + 1
240 k = find_token(file.body, '\\begin_inset', old_i, i)
241 if k == -1: k = i + 1
246 i = find_end_of( file.body, i, "\\begin_deeper","\\end_deeper")
248 #This case should not happen
249 #but if this happens deal with it greacefully adding
250 #the missing \end_deeper.
251 i = len(file.body) - 1
252 file.body[i:i] = ["\end_deeper",""]
260 i = find_end_of( file.body, i, "\\begin_inset","\\end_inset")
262 #This case should not happen
263 #but if this happens deal with it greacefully adding
264 #the missing \end_inset.
265 i = len(file.body) - 1
266 file.body[i:i] = ["\\end_inset","","","\\end_inset","",""]
272 if find(file.body[i], comment) == -1:
273 file.body[i:i] = ["\\end_inset"]
276 file.body[i:i+1] = ["\\layout Standard"]
280 def revert_comment(file):
283 i = find_tokens(file.body, ["\\begin_inset Comment", "\\begin_inset Greyedout"], i)
287 file.body[i] = "\\begin_inset Note"
294 def add_end_layout(file):
295 i = find_token(file.body, '\\layout', 0)
301 struct_stack = ["\\layout"]
304 i = find_tokens(file.body, ["\\begin_inset", "\\end_inset", "\\layout",
305 "\\begin_deeper", "\\end_deeper", "\\the_end"], i)
308 token = split(file.body[i])[0]
310 file.warning("Truncated file.")
312 file.body.insert(i, '\\the_end')
315 if token == "\\begin_inset":
316 struct_stack.append(token)
320 if token == "\\end_inset":
321 tail = struct_stack.pop()
322 if tail == "\\layout":
323 file.body.insert(i,"")
324 file.body.insert(i,"\\end_layout")
326 #Check if it is the correct tag
331 if token == "\\layout":
332 tail = struct_stack.pop()
334 file.body.insert(i,"")
335 file.body.insert(i,"\\end_layout")
338 struct_stack.append(tail)
340 struct_stack.append(token)
343 if token == "\\begin_deeper":
344 file.body.insert(i,"")
345 file.body.insert(i,"\\end_layout")
347 struct_stack.append(token)
350 if token == "\\end_deeper":
351 if struct_stack[-1] == '\\layout':
352 file.body.insert(i, '\\end_layout')
359 file.body.insert(i, "")
360 file.body.insert(i, "\\end_layout")
364 def rm_end_layout(file):
367 i = find_token(file.body, '\\end_layout', i)
376 # Handle change tracking keywords
378 def insert_tracking_changes(file):
379 i = find_token(file.header, "\\tracking_changes", 0)
381 file.header.append("\\tracking_changes 0")
384 def rm_tracking_changes(file):
385 i = find_token(file.header, "\\author", 0)
389 i = find_token(file.header, "\\tracking_changes", 0)
395 def rm_body_changes(file):
398 i = find_token(file.body, "\\change_", i)
406 # \layout -> \begin_layout
408 def layout2begin_layout(file):
411 i = find_token(file.body, '\\layout', i)
415 file.body[i] = replace(file.body[i], '\\layout', '\\begin_layout')
419 def begin_layout2layout(file):
422 i = find_token(file.body, '\\begin_layout', i)
426 file.body[i] = replace(file.body[i], '\\begin_layout', '\\layout')
431 # valignment="center" -> valignment="middle"
433 def convert_valignment_middle(body, start, end):
434 for i in range(start, end):
435 if re.search('^<(column|cell) .*valignment="center".*>$', body[i]):
436 body[i] = replace(body[i], 'valignment="center"', 'valignment="middle"')
439 def convert_table_valignment_middle(file):
440 regexp = re.compile(r'^\\begin_inset\s+Tabular')
443 i = find_re(file.body, regexp, i)
446 j = find_end_of_inset(file.body, i + 1)
448 #this should not happen
449 convert_valignment_middle(file.body, i + 1, len(file.body))
451 convert_valignment_middle(file.body, i + 1, j)
455 def revert_table_valignment_middle(body, start, end):
456 for i in range(start, end):
457 if re.search('^<(column|cell) .*valignment="middle".*>$', body[i]):
458 body[i] = replace(body[i], 'valignment="middle"', 'valignment="center"')
461 def revert_valignment_middle(file):
462 regexp = re.compile(r'^\\begin_inset\s+Tabular')
465 i = find_re(file.body, regexp, i)
468 j = find_end_of_inset(file.body, i + 1)
470 #this should not happen
471 revert_table_valignment_middle(file.body, i + 1, len(file.body))
473 revert_table_valignment_middle(file.body, i + 1, j)
478 # \the_end -> \end_document
480 def convert_end_document(file):
481 i = find_token(file.body, "\\the_end", 0)
483 file.body.append("\\end_document")
485 file.body[i] = "\\end_document"
488 def revert_end_document(file):
489 i = find_token(file.body, "\\end_document", 0)
491 file.body.append("\\the_end")
493 file.body[i] = "\\the_end"
497 # Convert line and page breaks
500 #\line_top \line_bottom \pagebreak_top \pagebreak_bottom \added_space_top xxx \added_space_bottom yyy
504 #\begin layout Standard
509 #\begin_inset VSpace xxx
513 #\begin_layout Standard
517 #\begin_layout Standard
519 #\begin_inset VSpace xxx
526 def convert_breaks(file):
527 par_params = ('added_space_bottom', 'added_space_top', 'align',
528 'labelwidthstring', 'line_bottom', 'line_top', 'noindent',
529 'pagebreak_bottom', 'pagebreak_top', 'paragraph_spacing',
533 i = find_token(file.body, "\\begin_layout", i)
538 # Merge all paragraph parameters into a single line
539 # We cannot check for '\\' only because paragraphs may start e.g.
541 while file.body[i + 1][:1] == '\\' and split(file.body[i + 1][1:])[0] in par_params:
542 file.body[i] = file.body[i + 1] + ' ' + file.body[i]
545 line_top = find(file.body[i],"\\line_top")
546 line_bot = find(file.body[i],"\\line_bottom")
547 pb_top = find(file.body[i],"\\pagebreak_top")
548 pb_bot = find(file.body[i],"\\pagebreak_bottom")
549 vspace_top = find(file.body[i],"\\added_space_top")
550 vspace_bot = find(file.body[i],"\\added_space_bottom")
552 if line_top == -1 and line_bot == -1 and pb_bot == -1 and pb_top == -1 and vspace_top == -1 and vspace_bot == -1:
555 for tag in "\\line_top", "\\line_bottom", "\\pagebreak_top", "\\pagebreak_bottom":
556 file.body[i] = replace(file.body[i], tag, "")
559 # the position could be change because of the removal of other
560 # paragraph properties above
561 vspace_top = find(file.body[i],"\\added_space_top")
562 tmp_list = split(file.body[i][vspace_top:])
563 vspace_top_value = tmp_list[1]
564 file.body[i] = file.body[i][:vspace_top] + join(tmp_list[2:])
567 # the position could be change because of the removal of other
568 # paragraph properties above
569 vspace_bot = find(file.body[i],"\\added_space_bottom")
570 tmp_list = split(file.body[i][vspace_bot:])
571 vspace_bot_value = tmp_list[1]
572 file.body[i] = file.body[i][:vspace_bot] + join(tmp_list[2:])
574 file.body[i] = strip(file.body[i])
577 # Create an empty paragraph for line and page break that belong
578 # above the paragraph
579 if pb_top !=-1 or line_top != -1 or vspace_top != -1:
581 paragraph_above = ['','\\begin_layout Standard','','']
584 paragraph_above.extend(['\\newpage ',''])
587 paragraph_above.extend(['\\begin_inset VSpace ' + vspace_top_value,'\\end_inset','',''])
590 paragraph_above.extend(['\\lyxline ',''])
592 paragraph_above.extend(['\\end_layout',''])
594 #inset new paragraph above the current paragraph
595 file.body[i-2:i-2] = paragraph_above
596 i = i + len(paragraph_above)
598 # Ensure that nested style are converted later.
599 k = find_end_of(file.body, i, "\\begin_layout", "\\end_layout")
604 if pb_bot !=-1 or line_bot != -1 or vspace_bot != -1:
606 paragraph_below = ['','\\begin_layout Standard','','']
609 paragraph_below.extend(['\\lyxline ',''])
612 paragraph_below.extend(['\\begin_inset VSpace ' + vspace_bot_value,'\\end_inset','',''])
615 paragraph_below.extend(['\\newpage ',''])
617 paragraph_below.extend(['\\end_layout',''])
619 #inset new paragraph above the current paragraph
620 file.body[k + 1: k + 1] = paragraph_below
626 def convert_note(file):
629 i = find_tokens(file.body, ["\\begin_inset Note",
630 "\\begin_inset Comment",
631 "\\begin_inset Greyedout"], i)
635 file.body[i] = file.body[i][0:13] + 'Note ' + file.body[i][13:]
639 def revert_note(file):
640 note_header = "\\begin_inset Note "
643 i = find_token(file.body, note_header, i)
647 file.body[i] = "\\begin_inset " + file.body[i][len(note_header):]
654 def convert_box(file):
657 i = find_tokens(file.body, ["\\begin_inset Boxed",
658 "\\begin_inset Doublebox",
659 "\\begin_inset Frameless",
660 "\\begin_inset ovalbox",
661 "\\begin_inset Ovalbox",
662 "\\begin_inset Shadowbox"], i)
666 file.body[i] = file.body[i][0:13] + 'Box ' + file.body[i][13:]
670 def revert_box(file):
671 box_header = "\\begin_inset Box "
674 i = find_token(file.body, box_header, i)
678 file.body[i] = "\\begin_inset " + file.body[i][len(box_header):]
685 def convert_collapsable(file):
688 i = find_tokens(file.body, ["\\begin_inset Box",
689 "\\begin_inset Branch",
690 "\\begin_inset CharStyle",
691 "\\begin_inset Float",
692 "\\begin_inset Foot",
693 "\\begin_inset Marginal",
694 "\\begin_inset Note",
695 "\\begin_inset OptArg",
696 "\\begin_inset Wrap"], i)
700 # Seach for a line starting 'collapsed'
701 # If, however, we find a line starting '\begin_layout'
702 # (_always_ present) then break with a warning message
705 if (file.body[i] == "collapsed false"):
706 file.body[i] = "status open"
708 elif (file.body[i] == "collapsed true"):
709 file.body[i] = "status collapsed"
711 elif (file.body[i][:13] == "\\begin_layout"):
712 file.warning("Malformed LyX file: Missing 'collapsed'.")
719 def revert_collapsable(file):
722 i = find_tokens(file.body, ["\\begin_inset Box",
723 "\\begin_inset Branch",
724 "\\begin_inset CharStyle",
725 "\\begin_inset Float",
726 "\\begin_inset Foot",
727 "\\begin_inset Marginal",
728 "\\begin_inset Note",
729 "\\begin_inset OptArg",
730 "\\begin_inset Wrap"], i)
734 # Seach for a line starting 'status'
735 # If, however, we find a line starting '\begin_layout'
736 # (_always_ present) then break with a warning message
739 if (file.body[i] == "status open"):
740 file.body[i] = "collapsed false"
742 elif (file.body[i] == "status collapsed" or
743 file.body[i] == "status inlined"):
744 file.body[i] = "collapsed true"
746 elif (file.body[i][:13] == "\\begin_layout"):
747 file.warning("Malformed LyX file: Missing 'status'.")
757 def convert_ert(file):
760 i = find_token(file.body, "\\begin_inset ERT", i)
764 # Seach for a line starting 'status'
765 # If, however, we find a line starting '\begin_layout'
766 # (_always_ present) then break with a warning message
769 if (file.body[i] == "status Open"):
770 file.body[i] = "status open"
772 elif (file.body[i] == "status Collapsed"):
773 file.body[i] = "status collapsed"
775 elif (file.body[i] == "status Inlined"):
776 file.body[i] = "status inlined"
778 elif (file.body[i][:13] == "\\begin_layout"):
779 file.warning("Malformed LyX file: Missing 'status'.")
786 def revert_ert(file):
789 i = find_token(file.body, "\\begin_inset ERT", i)
793 # Seach for a line starting 'status'
794 # If, however, we find a line starting '\begin_layout'
795 # (_always_ present) then break with a warning message
798 if (file.body[i] == "status open"):
799 file.body[i] = "status Open"
801 elif (file.body[i] == "status collapsed"):
802 file.body[i] = "status Collapsed"
804 elif (file.body[i] == "status inlined"):
805 file.body[i] = "status Inlined"
807 elif (file.body[i][:13] == "\\begin_layout"):
808 file.warning("Malformed LyX file : Missing 'status'.")
818 def convert_minipage(file):
819 """ Convert minipages to the box inset.
820 We try to use the same order of arguments as lyx does.
823 inner_pos = ["c","t","b","s"]
827 i = find_token(file.body, "\\begin_inset Minipage", i)
831 file.body[i] = "\\begin_inset Box Frameless"
834 # convert old to new position using the pos list
835 if file.body[i][:8] == "position":
836 file.body[i] = 'position "%s"' % pos[int(file.body[i][9])]
838 file.body.insert(i, 'position "%s"' % pos[0])
841 file.body.insert(i, 'hor_pos "c"')
843 file.body.insert(i, 'has_inner_box 1')
846 # convert the inner_position
847 if file.body[i][:14] == "inner_position":
848 file.body[i] = 'inner_pos "%s"' % inner_pos[int(file.body[i][15])]
850 file.body.insert('inner_pos "%s"' % inner_pos[0])
853 # We need this since the new file format has a height and width
854 # in a different order.
855 if file.body[i][:6] == "height":
856 height = file.body[i][6:]
857 # test for default value of 221 and convert it accordingly
858 if height == ' "0pt"' or height == ' "0"':
864 if file.body[i][:5] == "width":
865 width = file.body[i][5:]
870 if file.body[i][:9] == "collapsed":
871 if file.body[i][9:] == "true":
879 file.body.insert(i, 'use_parbox 0')
881 file.body.insert(i, 'width' + width)
883 file.body.insert(i, 'special "none"')
885 file.body.insert(i, 'height' + height)
887 file.body.insert(i, 'height_special "totalheight"')
889 file.body.insert(i, 'status ' + status)
893 # -------------------------------------------------------------------------------------------
894 # Convert backslashes and '\n' into valid ERT code, append the converted
895 # text to body[i] and return the (maybe incremented) line index i
896 def convert_ertbackslash(body, i, ert):
899 body[i] = body[i] + '\\backslash '
903 body[i+1:i+1] = ['\\newline ', '']
906 body[i] = body[i] + c
910 def convert_vspace(file):
912 # Get default spaceamount
913 i = find_token(file.header, '\\defskip', 0)
915 defskipamount = 'medskip'
917 defskipamount = split(file.header[i])[1]
922 i = find_token(file.body, '\\begin_inset VSpace', i)
925 spaceamount = split(file.body[i])[2]
927 # Are we at the beginning or end of a paragraph?
929 start = get_paragraph(file.body, i) + 1
930 for k in range(start, i):
931 if is_nonempty_line(file.body[k]):
935 j = find_end_of_inset(file.body, i)
937 file.warning("Malformed LyX file: Missing '\\end_inset'.")
940 end = get_next_paragraph(file.body, i)
941 for k in range(j + 1, end):
942 if is_nonempty_line(file.body[k]):
946 # Convert to paragraph formatting if we are at the beginning or end
947 # of a paragraph and the resulting paragraph would not be empty
948 if ((paragraph_start and not paragraph_end) or
949 (paragraph_end and not paragraph_start)):
950 # The order is important: del and insert invalidate some indices
954 file.body.insert(start, '\\added_space_top ' + spaceamount + ' ')
956 file.body.insert(start, '\\added_space_bottom ' + spaceamount + ' ')
960 file.body[i:i+1] = ['\\begin_inset ERT', 'status Collapsed', '',
961 '\\layout Standard', '', '\\backslash ']
963 if spaceamount[-1] == '*':
964 spaceamount = spaceamount[:-1]
969 # Replace defskip by the actual value
970 if spaceamount == 'defskip':
971 spaceamount = defskipamount
973 # LaTeX does not know \\smallskip* etc
975 if spaceamount == 'smallskip':
976 spaceamount = '\\smallskipamount'
977 elif spaceamount == 'medskip':
978 spaceamount = '\\medskipamount'
979 elif spaceamount == 'bigskip':
980 spaceamount = '\\bigskipamount'
981 elif spaceamount == 'vfill':
982 spaceamount = '\\fill'
984 # Finally output the LaTeX code
985 if (spaceamount == 'smallskip' or spaceamount == 'medskip' or
986 spaceamount == 'bigskip' or spaceamount == 'vfill'):
987 file.body.insert(i, spaceamount)
990 file.body.insert(i, 'vspace*{')
992 file.body.insert(i, 'vspace{')
993 i = convert_ertbackslash(file.body, i, spaceamount)
994 file.body[i] = file.body[i] + '}'
998 # Convert a LyX length into a LaTeX length
999 def convert_len(len, special):
1000 units = {"text%":"\\textwidth", "col%":"\\columnwidth",
1001 "page%":"\\pagewidth", "line%":"\\linewidth",
1002 "theight%":"\\textheight", "pheight%":"\\pageheight"}
1004 # Convert special lengths
1005 if special != 'none':
1006 len = '%f\\' % len2value(len) + special
1008 # Convert LyX units to LaTeX units
1009 for unit in units.keys():
1010 if find(len, unit) != -1:
1011 len = '%f' % (len2value(len) / 100) + units[unit]
1017 # Convert a LyX length into valid ERT code and append it to body[i]
1018 # Return the (maybe incremented) line index i
1019 def convert_ertlen(body, i, len, special):
1020 # Convert backslashes and insert the converted length into body
1021 return convert_ertbackslash(body, i, convert_len(len, special))
1024 # Return the value of len without the unit in numerical form
1026 result = re.search('([+-]?[0-9.]+)', len)
1028 return float(result.group(1))
1029 # No number means 1.0
1033 # Convert text to ERT and insert it at body[i]
1034 # Return the index of the line after the inserted ERT
1035 def insert_ert(body, i, status, text):
1036 body[i:i] = ['\\begin_inset ERT', 'status ' + status, '',
1037 '\\layout Standard', '']
1039 i = convert_ertbackslash(body, i, text) + 1
1040 body[i:i] = ['', '\\end_inset', '']
1045 # Add text to the preamble if it is not already there.
1046 # Only the first line is checked!
1047 def add_to_preamble(file, text):
1048 i = find_token(file.header, '\\begin_preamble', 0)
1050 file.header.extend(['\\begin_preamble'] + text + ['\\end_preamble'])
1053 j = find_token(file.header, '\\end_preamble', i)
1055 file.warning("Malformed LyX file: Missing '\\end_preamble'.")
1056 file.warning("Adding it now and hoping for the best.")
1057 file.header.append('\\end_preamble')
1058 j = len(file.header)
1060 if find_token(file.header, text[0], i, j) != -1:
1062 file.header[j:j] = text
1065 def convert_frameless_box(file):
1066 pos = ['t', 'c', 'b']
1067 inner_pos = ['c', 't', 'b', 's']
1070 i = find_token(file.body, '\\begin_inset Frameless', i)
1073 j = find_end_of_inset(file.body, i)
1075 file.warning("Malformed LyX file: Missing '\\end_inset'.")
1082 params = {'position':0, 'hor_pos':'c', 'has_inner_box':'1',
1083 'inner_pos':1, 'use_parbox':'0', 'width':'100col%',
1084 'special':'none', 'height':'1in',
1085 'height_special':'totalheight', 'collapsed':'false'}
1086 for key in params.keys():
1087 value = replace(get_value(file.body, key, i, j), '"', '')
1089 if key == 'position':
1090 # convert new to old position: 'position "t"' -> 0
1091 value = find_token(pos, value, 0)
1094 elif key == 'inner_pos':
1095 # convert inner position
1096 value = find_token(inner_pos, value, 0)
1101 j = del_token(file.body, key, i, j)
1104 # Convert to minipage or ERT?
1105 # Note that the inner_position and height parameters of a minipage
1106 # inset are ignored and not accessible for the user, although they
1107 # are present in the file format and correctly read in and written.
1108 # Therefore we convert to ERT if they do not have their LaTeX
1109 # defaults. These are:
1110 # - the value of "position" for "inner_pos"
1111 # - "\totalheight" for "height"
1112 if (params['use_parbox'] != '0' or
1113 params['has_inner_box'] != '1' or
1114 params['special'] != 'none' or
1115 params['height_special'] != 'totalheight' or
1116 len2value(params['height']) != 1.0):
1118 # Here we know that this box is not supported in file format 224.
1119 # Therefore we need to convert it to ERT. We can't simply convert
1120 # the beginning and end of the box to ERT, because the
1121 # box inset may contain layouts that are different from the
1122 # surrounding layout. After the conversion the contents of the
1123 # box inset is on the same level as the surrounding text, and
1124 # paragraph layouts and align parameters can get mixed up.
1126 # A possible solution for this problem:
1127 # Convert the box to a minipage and redefine the minipage
1128 # environment in ERT so that the original box is simulated.
1129 # For minipages we could do this in a way that the width and
1130 # position can still be set from LyX, but this did not work well.
1131 # This is not possible for parboxes either, so we convert the
1132 # original box to ERT, put the minipage inset inside the box
1133 # and redefine the minipage environment to be empty.
1135 # Commands that are independant of a particular box can go to
1137 # We need to define lyxtolyxrealminipage with 3 optional
1138 # arguments although LyX 1.3 uses only the first one.
1139 # Otherwise we will get LaTeX errors if this document is
1140 # converted to format 225 or above again (LyX 1.4 uses all
1141 # optional arguments).
1142 add_to_preamble(file,
1143 ['% Commands inserted by lyx2lyx for frameless boxes',
1144 '% Save the original minipage environment',
1145 '\\let\\lyxtolyxrealminipage\\minipage',
1146 '\\let\\endlyxtolyxrealminipage\\endminipage',
1147 '% Define an empty lyxtolyximinipage environment',
1148 '% with 3 optional arguments',
1149 '\\newenvironment{lyxtolyxiiiminipage}[4]{}{}',
1150 '\\newenvironment{lyxtolyxiiminipage}[2][\\lyxtolyxargi]%',
1151 ' {\\begin{lyxtolyxiiiminipage}{\\lyxtolyxargi}{\\lyxtolyxargii}{#1}{#2}}%',
1152 ' {\\end{lyxtolyxiiiminipage}}',
1153 '\\newenvironment{lyxtolyximinipage}[1][\\totalheight]%',
1154 ' {\\def\\lyxtolyxargii{{#1}}\\begin{lyxtolyxiiminipage}}%',
1155 ' {\\end{lyxtolyxiiminipage}}',
1156 '\\newenvironment{lyxtolyxminipage}[1][c]%',
1157 ' {\\def\\lyxtolyxargi{{#1}}\\begin{lyxtolyximinipage}}',
1158 ' {\\end{lyxtolyximinipage}}'])
1160 if params['use_parbox'] != '0':
1163 ert = '\\begin{lyxtolyxrealminipage}'
1165 # convert optional arguments only if not latex default
1166 if (pos[params['position']] != 'c' or
1167 inner_pos[params['inner_pos']] != pos[params['position']] or
1168 params['height_special'] != 'totalheight' or
1169 len2value(params['height']) != 1.0):
1170 ert = ert + '[' + pos[params['position']] + ']'
1171 if (inner_pos[params['inner_pos']] != pos[params['position']] or
1172 params['height_special'] != 'totalheight' or
1173 len2value(params['height']) != 1.0):
1174 ert = ert + '[' + convert_len(params['height'],
1175 params['height_special']) + ']'
1176 if inner_pos[params['inner_pos']] != pos[params['position']]:
1177 ert = ert + '[' + inner_pos[params['inner_pos']] + ']'
1179 ert = ert + '{' + convert_len(params['width'],
1180 params['special']) + '}'
1182 if params['use_parbox'] != '0':
1184 ert = ert + '\\let\\minipage\\lyxtolyxminipage%\n'
1185 ert = ert + '\\let\\endminipage\\endlyxtolyxminipage%\n'
1188 i = insert_ert(file.body, i, 'Collapsed', ert)
1189 j = j + i - old_i - 1
1191 file.body[i:i] = ['\\begin_inset Minipage',
1192 'position %d' % params['position'],
1195 'width "' + params['width'] + '"',
1196 'collapsed ' + params['collapsed']]
1200 # Restore the original minipage environment since we may have
1201 # minipages inside this box.
1202 # Start a new paragraph because the following may be nonstandard
1203 file.body[i:i] = ['\\layout Standard', '', '']
1206 ert = '\\let\\minipage\\lyxtolyxrealminipage%\n'
1207 ert = ert + '\\let\\endminipage\\lyxtolyxrealendminipage%'
1209 i = insert_ert(file.body, i, 'Collapsed', ert)
1210 j = j + i - old_i - 1
1212 # Redefine the minipage end before the inset end.
1213 # Start a new paragraph because the previous may be nonstandard
1214 file.body[j:j] = ['\\layout Standard', '', '']
1216 ert = '\\let\\endminipage\\endlyxtolyxminipage'
1217 j = insert_ert(file.body, j, 'Collapsed', ert)
1219 file.body.insert(j, '')
1222 # LyX writes '%\n' after each box. Therefore we need to end our
1223 # ERT with '%\n', too, since this may swallow a following space.
1224 if params['use_parbox'] != '0':
1227 ert = '\\end{lyxtolyxrealminipage}%\n'
1228 j = insert_ert(file.body, j, 'Collapsed', ert)
1230 # We don't need to restore the original minipage after the inset
1231 # end because the scope of the redefinition is the original box.
1235 # Convert to minipage
1236 file.body[i:i] = ['\\begin_inset Minipage',
1237 'position %d' % params['position'],
1238 'inner_position %d' % params['inner_pos'],
1239 'height "' + params['height'] + '"',
1240 'width "' + params['width'] + '"',
1241 'collapsed ' + params['collapsed']]
1248 def convert_jurabib(file):
1249 i = find_token(file.header, '\\use_numerical_citations', 0)
1251 file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
1253 file.header.insert(i + 1, '\\use_jurabib 0')
1256 def revert_jurabib(file):
1257 i = find_token(file.header, '\\use_jurabib', 0)
1259 file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1261 if get_value(file.header, '\\use_jurabib', 0) != "0":
1262 file.warning("Conversion of '\\use_jurabib = 1' not yet implemented.")
1263 # Don't remove '\\use_jurabib' so that people will get warnings by lyx
1271 def convert_bibtopic(file):
1272 i = find_token(file.header, '\\use_jurabib', 0)
1274 file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1276 file.header.insert(i + 1, '\\use_bibtopic 0')
1279 def revert_bibtopic(file):
1280 i = find_token(file.header, '\\use_bibtopic', 0)
1282 file.warning("Malformed lyx file: Missing '\\use_bibtopic'.")
1284 if get_value(file.header, '\\use_bibtopic', 0) != "0":
1285 file.warning("Conversion of '\\use_bibtopic = 1' not yet implemented.")
1286 # Don't remove '\\use_jurabib' so that people will get warnings by lyx
1293 def convert_float(file):
1296 i = find_token(file.body, '\\begin_inset Float', i)
1299 # Seach for a line starting 'wide'
1300 # If, however, we find a line starting '\begin_layout'
1301 # (_always_ present) then break with a warning message
1304 if (file.body[i][:4] == "wide"):
1305 file.body.insert(i + 1, 'sideways false')
1307 elif (file.body[i][:13] == "\\begin_layout"):
1308 file.warning("Malformed lyx file: Missing 'wide'.")
1314 def revert_float(file):
1317 i = find_token(file.body, '\\begin_inset Float', i)
1320 j = find_end_of_inset(file.body, i)
1322 file.warning("Malformed lyx file: Missing '\\end_inset'.")
1325 if get_value(file.body, 'sideways', i, j) != "false":
1326 file.warning("Conversion of 'sideways true' not yet implemented.")
1327 # Don't remove 'sideways' so that people will get warnings by lyx
1330 del_token(file.body, 'sideways', i, j)
1334 def convert_graphics(file):
1335 """ Add extension to filenames of insetgraphics if necessary.
1339 i = find_token(file.body, "\\begin_inset Graphics", i)
1343 j = find_token2(file.body, "filename", i)
1347 filename = split(file.body[j])[1]
1348 absname = os.path.normpath(os.path.join(file.dir, filename))
1349 if file.input == stdin and not os.path.isabs(filename):
1350 # We don't know the directory and cannot check the file.
1351 # We could use a heuristic and take the current directory,
1352 # and we could try to find out if filename has an extension,
1353 # but that would be just guesses and could be wrong.
1354 file.warning("""Warning: Can not determine whether file
1356 needs an extension when reading from standard input.
1357 You may need to correct the file manually or run
1358 lyx2lyx again with the .lyx file as commandline argument.""" % filename)
1360 # This needs to be the same algorithm as in pre 233 insetgraphics
1361 if access(absname, F_OK):
1363 if access(absname + ".ps", F_OK):
1364 file.body[j] = replace(file.body[j], filename, filename + ".ps")
1366 if access(absname + ".eps", F_OK):
1367 file.body[j] = replace(file.body[j], filename, filename + ".eps")
1371 # Convert firstname and surname from styles -> char styles
1373 def convert_names(file):
1374 """ Convert in the docbook backend from firstname and surname style
1377 if file.backend != "docbook":
1383 i = find_token(file.body, "\\begin_layout Author", i)
1388 while file.body[i] == "":
1391 if file.body[i][:11] != "\\end_layout" or file.body[i+2][:13] != "\\begin_deeper":
1396 i = find_end_of( file.body, i+3, "\\begin_deeper","\\end_deeper")
1398 # something is really wrong, abort
1399 file.warning("Missing \\end_deeper, after style Author.")
1400 file.warning("Aborted attempt to parse FirstName and Surname.")
1402 firstname, surname = "", ""
1404 name = file.body[k:i]
1406 j = find_token(name, "\\begin_layout FirstName", 0)
1409 while(name[j] != "\\end_layout"):
1410 firstname = firstname + name[j]
1413 j = find_token(name, "\\begin_layout Surname", 0)
1416 while(name[j] != "\\end_layout"):
1417 surname = surname + name[j]
1421 del file.body[k+2:i+1]
1423 file.body[k-1:k-1] = ["", "",
1424 "\\begin_inset CharStyle Firstname",
1427 "\\begin_layout Standard",
1435 "\\begin_inset CharStyle Surname",
1438 "\\begin_layout Standard",
1447 def revert_names(file):
1448 """ Revert in the docbook backend from firstname and surname char style
1451 if file.backend != "docbook":
1456 # \use_natbib 1 \cite_engine <style>
1457 # \use_numerical_citations 0 -> where <style> is one of
1458 # \use_jurabib 0 "basic", "natbib_authoryear",
1459 # "natbib_numerical" or "jurabib"
1460 def convert_cite_engine(file):
1461 a = find_token(file.header, "\\use_natbib", 0)
1463 file.warning("Malformed lyx file: Missing '\\use_natbib'.")
1466 b = find_token(file.header, "\\use_numerical_citations", 0)
1467 if b == -1 or b != a+1:
1468 file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
1471 c = find_token(file.header, "\\use_jurabib", 0)
1472 if c == -1 or c != b+1:
1473 file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1476 use_natbib = int(split(file.header[a])[1])
1477 use_numerical_citations = int(split(file.header[b])[1])
1478 use_jurabib = int(split(file.header[c])[1])
1480 cite_engine = "basic"
1482 if use_numerical_citations:
1483 cite_engine = "natbib_numerical"
1485 cite_engine = "natbib_authoryear"
1487 cite_engine = "jurabib"
1489 del file.header[a:c+1]
1490 file.header.insert(a, "\\cite_engine " + cite_engine)
1493 def revert_cite_engine(file):
1494 i = find_token(file.header, "\\cite_engine", 0)
1496 file.warning("Malformed lyx file: Missing '\\cite_engine'.")
1499 cite_engine = split(file.header[i])[1]
1504 if cite_engine == "natbib_numerical":
1507 elif cite_engine == "natbib_authoryear":
1509 elif cite_engine == "jurabib":
1513 file.header.insert(i, "\\use_jurabib " + use_jurabib)
1514 file.header.insert(i, "\\use_numerical_citations " + use_numerical)
1515 file.header.insert(i, "\\use_natbib " + use_natbib)
1521 def convert_paperpackage(file):
1522 i = find_token(file.header, "\\paperpackage", 0)
1526 packages = {'default':'none','a4':'none', 'a4wide':'a4', 'widemarginsa4':'a4wide'}
1527 if len(split(file.header[i])) > 1:
1528 paperpackage = split(file.header[i])[1]
1530 paperpackage = "default"
1531 file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
1534 def revert_paperpackage(file):
1535 i = find_token(file.header, "\\paperpackage", 0)
1539 packages = {'none':'a4', 'a4':'a4wide', 'a4wide':'widemarginsa4',
1540 'widemarginsa4':'', 'default': 'default'}
1541 if len(split(file.header[i])) > 1:
1542 paperpackage = split(file.header[i])[1]
1544 paperpackage = 'default'
1545 file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
1551 def convert_bullets(file):
1554 i = find_token(file.header, "\\bullet", i)
1557 if file.header[i][:12] == '\\bulletLaTeX':
1558 file.header[i] = file.header[i] + ' ' + strip(file.header[i+1])
1561 file.header[i] = file.header[i] + ' ' + strip(file.header[i+1]) +\
1562 ' ' + strip(file.header[i+2]) + ' ' + strip(file.header[i+3])
1564 del file.header[i+1:i + n]
1568 def revert_bullets(file):
1571 i = find_token(file.header, "\\bullet", i)
1574 if file.header[i][:12] == '\\bulletLaTeX':
1575 n = find(file.header[i], '"')
1577 file.warning("Malformed header.")
1580 file.header[i:i+1] = [file.header[i][:n-1],'\t' + file.header[i][n:], '\\end_bullet']
1583 frag = split(file.header[i])
1585 file.warning("Malformed header.")
1588 file.header[i:i+1] = [frag[0] + ' ' + frag[1],
1597 # \begin_header and \begin_document
1599 def add_begin_header(file):
1600 i = find_token(file.header, '\\lyxformat', 0)
1601 file.header.insert(i+1, '\\begin_header')
1602 file.header.insert(i+1, '\\begin_document')
1605 def remove_begin_header(file):
1606 i = find_token(file.header, "\\begin_document", 0)
1609 i = find_token(file.header, "\\begin_header", 0)
1615 # \begin_file.body and \end_file.body
1617 def add_begin_body(file):
1618 file.body.insert(0, '\\begin_body')
1619 file.body.insert(1, '')
1620 i = find_token(file.body, "\\end_document", 0)
1621 file.body.insert(i, '\\end_body')
1623 def remove_begin_body(file):
1624 i = find_token(file.body, "\\begin_body", 0)
1627 if not file.body[i]:
1629 i = find_token(file.body, "\\end_body", 0)
1637 def normalize_papersize(file):
1638 i = find_token(file.header, '\\papersize', 0)
1642 tmp = split(file.header[i])
1643 if tmp[1] == "Default":
1644 file.header[i] = '\\papersize default'
1646 if tmp[1] == "Custom":
1647 file.header[i] = '\\papersize custom'
1650 def denormalize_papersize(file):
1651 i = find_token(file.header, '\\papersize', 0)
1655 tmp = split(file.header[i])
1656 if tmp[1] == "custom":
1657 file.header[i] = '\\papersize Custom'
1661 # Strip spaces at end of command line
1663 def strip_end_space(file):
1664 for i in range(len(file.body)):
1665 if file.body[i][:1] == '\\':
1666 file.body[i] = strip(file.body[i])
1670 # Use boolean values for \use_geometry, \use_bibtopic and \tracking_changes
1672 def use_x_boolean(file):
1673 bin2bool = {'0': 'false', '1': 'true'}
1674 for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
1675 i = find_token(file.header, use, 0)
1678 decompose = split(file.header[i])
1679 file.header[i] = decompose[0] + ' ' + bin2bool[decompose[1]]
1682 def use_x_binary(file):
1683 bool2bin = {'false': '0', 'true': '1'}
1684 for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
1685 i = find_token(file.header, use, 0)
1688 decompose = split(file.header[i])
1689 file.header[i] = decompose[0] + ' ' + bool2bin[decompose[1]]
1692 # Place all the paragraph parameters in their own line
1694 def normalize_paragraph_params(file):
1696 allowed_parameters = '\\paragraph_spacing', '\\noindent', '\\align', '\\labelwidthstring', "\\start_of_appendix"
1700 i = find_token(file.body, '\\begin_layout', i)
1706 if strip(body[i]) and split(body[i])[0] not in allowed_parameters:
1709 j = find(body[i],'\\', 1)
1712 body[i:i+1] = [strip(body[i][:j]), body[i][j:]]
1718 # Add/remove output_changes parameter
1720 def convert_output_changes (file):
1721 i = find_token(file.header, '\\tracking_changes', 0)
1723 file.warning("Malformed lyx file: Missing '\\tracking_changes'.")
1725 file.header.insert(i+1, '\\output_changes true')
1728 def revert_output_changes (file):
1729 i = find_token(file.header, '\\output_changes', 0)
1736 # Convert paragraph breaks and sanitize paragraphs
1738 def convert_ert_paragraphs(file):
1739 forbidden_settings = [
1740 # paragraph parameters
1741 '\\paragraph_spacing', '\\labelwidthstring',
1742 '\\start_of_appendix', '\\noindent',
1743 '\\leftindent', '\\align',
1745 '\\family', '\\series', '\\shape', '\\size',
1746 '\\emph', '\\numeric', '\\bar', '\\noun',
1747 '\\color', '\\lang']
1750 i = find_token(file.body, '\\begin_inset ERT', i)
1753 j = find_end_of_inset(file.body, i)
1755 file.warning("Malformed lyx file: Missing '\\end_inset'.")
1759 # convert non-standard paragraphs to standard
1762 k = find_token(file.body, "\\begin_layout", k, j)
1765 file.body[k] = "\\begin_layout Standard"
1768 # remove all paragraph parameters and font settings
1771 if (strip(file.body[k]) and
1772 split(file.body[k])[0] in forbidden_settings):
1778 # insert an empty paragraph before each paragraph but the first
1782 k = find_token(file.body, "\\begin_layout Standard", k, j)
1789 file.body[k:k] = ["\\begin_layout Standard", "",
1794 # convert \\newline to new paragraph
1797 k = find_token(file.body, "\\newline", k, j)
1800 file.body[k:k+1] = ["\\end_layout", "", "\\begin_layout Standard"]
1807 # Remove double paragraph breaks
1809 def revert_ert_paragraphs(file):
1812 i = find_token(file.body, '\\begin_inset ERT', i)
1815 j = find_end_of_inset(file.body, i)
1817 file.warning("Malformed lyx file: Missing '\\end_inset'.")
1821 # replace paragraph breaks with \newline
1824 k = find_token(file.body, "\\end_layout", k, j)
1825 l = find_token(file.body, "\\begin_layout", k, j)
1826 if k == -1 or l == -1:
1828 file.body[k:l+1] = ["\\newline"]
1832 # replace double \newlines with paragraph breaks
1835 k = find_token(file.body, "\\newline", k, j)
1839 while file.body[l] == "":
1841 if strip(file.body[l]) and split(file.body[l])[0] == "\\newline":
1842 file.body[k:l+1] = ["\\end_layout", "",
1843 "\\begin_layout Standard"]
1851 def convert_french(file):
1852 regexp = re.compile(r'^\\language\s+frenchb')
1853 i = find_re(file.header, regexp, 0)
1855 file.header[i] = "\\language french"
1857 # Change language in the document body
1858 regexp = re.compile(r'^\\lang\s+frenchb')
1861 i = find_re(file.body, regexp, i)
1864 file.body[i] = "\\lang french"
1868 def remove_paperpackage(file):
1869 i = find_token(file.header, '\\paperpackage', 0)
1874 paperpackage = split(file.header[i])[1]
1876 if paperpackage in ("a4", "a4wide", "widemarginsa4"):
1877 j = find_token(file.header, '\\begin_preamble', 0)
1878 conv = {"a4":"\\usepackage{a4}","a4wide": "\\usepackage{a4wide}",
1879 "widemarginsa4": "\\usepackage[widemargins]{a4}"}
1882 j = len(file.header) - 2
1883 file.header[j:j]=["\\begin_preamble",
1884 conv[paperpackage],"\\end_preamble"]
1886 file.header[j+1:j+1] = conv[paperpackage]
1890 i = find_token(file.header, '\\papersize', 0)
1892 file.header[i] = "\\papersize default"
1899 convert = [[222, [insert_tracking_changes]],
1900 [223, [add_end_header, remove_color_default,
1901 convert_spaces, convert_bibtex, remove_insetparent]],
1902 [224, [convert_external, convert_comment]],
1903 [225, [add_end_layout, layout2begin_layout, convert_end_document,
1904 convert_table_valignment_middle, convert_breaks]],
1905 [226, [convert_note]],
1906 [227, [convert_box]],
1907 [228, [convert_collapsable, convert_ert]],
1908 [229, [convert_minipage]],
1909 [230, [convert_jurabib]],
1910 [231, [convert_float]],
1911 [232, [convert_bibtopic]],
1912 [233, [convert_graphics, convert_names]],
1913 [234, [convert_cite_engine]],
1914 [235, [convert_paperpackage]],
1915 [236, [convert_bullets, add_begin_header, add_begin_body,
1916 normalize_papersize, strip_end_space]],
1917 [237, [use_x_boolean]],
1918 [238, [update_latexaccents]],
1919 [239, [normalize_paragraph_params]],
1920 [240, [convert_output_changes]],
1921 [241, [convert_ert_paragraphs]],
1922 [242, [convert_french]],
1923 [243, [remove_paperpackage]]]
1925 revert = [[242, []],
1927 [240, [revert_ert_paragraphs]],
1928 [239, [revert_output_changes]],
1931 [236, [use_x_binary]],
1932 [235, [denormalize_papersize, remove_begin_body,remove_begin_header,
1934 [234, [revert_paperpackage]],
1935 [233, [revert_cite_engine]],
1936 [232, [revert_names]],
1937 [231, [revert_bibtopic]],
1938 [230, [revert_float]],
1939 [229, [revert_jurabib]],
1941 [227, [revert_collapsable, revert_ert]],
1942 [226, [revert_box, revert_external_2]],
1943 [225, [revert_note]],
1944 [224, [rm_end_layout, begin_layout2layout, revert_end_document,
1945 revert_valignment_middle, convert_vspace, convert_frameless_box]],
1946 [223, [revert_external_2, revert_comment, revert_eqref]],
1947 [222, [rm_end_header, revert_spaces, revert_bibtex]],
1948 [221, [rm_tracking_changes, rm_body_changes]]]
1951 if __name__ == "__main__":