]> git.lyx.org Git - lyx.git/blob - lib/lyx2lyx/lyx_1_4.py
lyx_1_4.lyx (paperpackage): Fix empty paperpackage case.
[lyx.git] / lib / lyx2lyx / lyx_1_4.py
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>
6 #
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.
11 #
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.
16 #
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.
20
21 import re
22 from os import access, F_OK
23 import os.path
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
27 from sys import stdin
28 from string import replace, split, find, strip, join
29
30 from lyx_0_12 import update_latexaccents
31
32 ##
33 # Remove \color default
34 #
35 def remove_color_default(file):
36     i = 0
37     while 1:
38         i = find_token(file.body, "\\color default", i)
39         if i == -1:
40             return
41         file.body[i] = replace(file.body[i], "\\color default",
42                            "\\color inherit")
43
44
45 ##
46 # Add \end_header
47 #
48 def add_end_header(file):
49     file.header.append("\\end_header");
50
51
52 def rm_end_header(file):
53     i = find_token(file.header, "\\end_header", 0)
54     if i == -1:
55         return
56     del file.header[i]
57
58
59 ##
60 # \SpecialChar ~ -> \InsetSpace ~
61 #
62 def convert_spaces(file):
63     for i in range(len(file.body)):
64         file.body[i] = replace(file.body[i],"\\SpecialChar ~","\\InsetSpace ~")
65
66
67 def revert_spaces(file):
68     for i in range(len(file.body)):
69         file.body[i] = replace(file.body[i],"\\InsetSpace ~", "\\SpecialChar ~")
70
71
72 ##
73 # equivalent to lyx::support::escape()
74 #
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']
78     enc = ""
79     for c in lab:
80         o = ord(c)
81         if o >= 128 or c == '=' or c == '%':
82             enc = enc + '='
83             enc = enc + hexdigit[o >> 4]
84             enc = enc + hexdigit[o & 15]
85         else:
86             enc = enc + c
87     return enc;
88
89
90 ##
91 # \begin_inset LatexCommand \eqref -> ERT
92 #
93 def revert_eqref(file):
94     regexp = re.compile(r'^\\begin_inset\s+LatexCommand\s+\\eqref')
95     i = 0
96     while 1:
97         i = find_re(file.body, regexp, i)
98         if i == -1:
99             break
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 ",
103                             "eqref" + eqref]
104         i = i + 7
105
106
107 ##
108 # BibTeX changes
109 #
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")
114
115
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")
120
121
122 ##
123 # Remove \lyxparent
124 #
125 def remove_insetparent(file):
126     i = 0
127     while 1:
128         i = find_token(file.body, "\\begin_inset LatexCommand \\lyxparent", i)
129         if i == -1:
130             break
131         del file.body[i:i+3]
132
133
134 ##
135 #  Inset External
136 #
137 def convert_external(file):
138     external_rexp = re.compile(r'\\begin_inset External ([^,]*),"([^"]*)",')
139     external_header = "\\begin_inset External"
140     i = 0
141     while 1:
142         i = find_token(file.body, external_header, i)
143         if i == -1:
144             break
145         look = external_rexp.search(file.body[i])
146         args = ['','']
147         if look:
148             args[0] = look.group(1)
149             args[1] = look.group(2)
150         #FIXME: if the previous search fails then warn
151
152         if args[0] == "RasterImage":
153             # Convert a RasterImage External Inset to a Graphics Inset.
154             top = "\\begin_inset Graphics"
155             if args[1]:
156                 filename = "\tfilename " + args[1]
157             file.body[i:i+1] = [top, filename]
158             i = i + 1
159         else:
160             # Convert the old External Inset format to the new.
161             top = external_header
162             template = "\ttemplate " + args[0]
163             if args[1]:
164                 filename = "\tfilename " + args[1]
165                 file.body[i:i+1] = [top, template, filename]
166                 i = i + 2
167             else:
168                 file.body[i:i+1] = [top, template]
169                 i = i + 1
170
171
172 def revert_external_1(file):
173     external_header = "\\begin_inset External"
174     i = 0
175     while 1:
176         i = find_token(file.body, external_header, i)
177         if i == -1:
178             break
179
180         template = split(file.body[i+1])
181         template.reverse()
182         del file.body[i+1]
183
184         filename = split(file.body[i+1])
185         filename.reverse()
186         del file.body[i+1]
187
188         params = split(file.body[i+1])
189         params.reverse()
190         if file.body[i+1]: del file.body[i+1]
191
192         file.body[i] = file.body[i] + " " + template[0]+ ', "' + filename[0] + '", " '+ join(params[1:]) + '"'
193         i = i + 1
194
195
196 def revert_external_2(file):
197     draft_token = '\tdraft'
198     i = 0
199     while 1:
200         i = find_token(file.body, '\\begin_inset External', i)
201         if i == -1:
202             break
203         j = find_end_of_inset(file.body, i + 1)
204         if j == -1:
205             #this should not happen
206             break
207         k = find_token(file.body, draft_token, i+1, j-1)
208         if (k != -1 and len(draft_token) == len(file.body[k])):
209             del file.body[k]
210         i = j + 1
211
212
213 ##
214 # Comment
215 #
216 def convert_comment(file):
217     i = 0
218     comment = "\\layout Comment"
219     while 1:
220         i = find_token(file.body, comment, i)
221         if i == -1:
222             return
223
224         file.body[i:i+1] = ["\\layout Standard","","",
225                         "\\begin_inset Comment",
226                         "collapsed true","",
227                         "\\layout Standard"]
228         i = i + 7
229
230         while 1:
231                 old_i = i
232                 i = find_token(file.body, "\\layout", i)
233                 if i == -1:
234                     i = len(file.body) - 1
235                     file.body[i:i] = ["\\end_inset","",""]
236                     return
237
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
242
243                 if j < i and j < k:
244                     i = j
245                     del file.body[i]
246                     i = find_end_of( file.body, i, "\\begin_deeper","\\end_deeper")
247                     if i == -1:
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",""]
253                         return
254                     else:
255                         del file.body[i]
256                         continue
257
258                 if k < i:
259                     i = k
260                     i = find_end_of( file.body, i, "\\begin_inset","\\end_inset")
261                     if i == -1:
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","",""]
267                         return
268                     else:
269                         i = i + 1
270                         continue
271
272                 if find(file.body[i], comment) == -1:
273                     file.body[i:i] = ["\\end_inset"]
274                     i = i + 1
275                     break
276                 file.body[i:i+1] = ["\\layout Standard"]
277                 i = i + 1
278
279
280 def revert_comment(file):
281     i = 0
282     while 1:
283         i = find_tokens(file.body, ["\\begin_inset Comment", "\\begin_inset Greyedout"], i)
284
285         if i == -1:
286             return
287         file.body[i] = "\\begin_inset Note"
288         i = i + 1
289
290
291 ##
292 # Add \end_layout
293 #
294 def add_end_layout(file):
295     i = find_token(file.body, '\\layout', 0)
296
297     if i == -1:
298         return
299
300     i = i + 1
301     struct_stack = ["\\layout"]
302
303     while 1:
304         i = find_tokens(file.body, ["\\begin_inset", "\\end_inset", "\\layout",
305                                 "\\begin_deeper", "\\end_deeper", "\\the_end"], i)
306
307         if i != -1:
308             token = split(file.body[i])[0]
309         else:
310             file.warning("Truncated file.")
311             i = len(file.body)
312             file.body.insert(i, '\\the_end')
313             token = ""
314
315         if token == "\\begin_inset":
316             struct_stack.append(token)
317             i = i + 1
318             continue
319
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")
325                 i = i + 2
326                 #Check if it is the correct tag
327                 struct_stack.pop()
328             i = i + 1
329             continue
330
331         if token == "\\layout":
332             tail = struct_stack.pop()
333             if tail == token:
334                 file.body.insert(i,"")
335                 file.body.insert(i,"\\end_layout")
336                 i = i + 3
337             else:
338                 struct_stack.append(tail)
339                 i = i + 1
340             struct_stack.append(token)
341             continue
342
343         if token == "\\begin_deeper":
344             file.body.insert(i,"")
345             file.body.insert(i,"\\end_layout")
346             i = i + 3
347             struct_stack.append(token)
348             continue
349
350         if token == "\\end_deeper":
351             if struct_stack[-1] == '\\layout':
352                 file.body.insert(i, '\\end_layout')
353                 i = i + 1
354                 struct_stack.pop()
355             i = i + 1
356             continue
357
358         #case \end_document
359         file.body.insert(i, "")
360         file.body.insert(i, "\\end_layout")
361         return
362
363
364 def rm_end_layout(file):
365     i = 0
366     while 1:
367         i = find_token(file.body, '\\end_layout', i)
368
369         if i == -1:
370             return
371
372         del file.body[i]
373
374
375 ##
376 # Handle change tracking keywords
377 #
378 def insert_tracking_changes(file):
379     i = find_token(file.header, "\\tracking_changes", 0)
380     if i == -1:
381         file.header.append("\\tracking_changes 0")
382
383
384 def rm_tracking_changes(file):
385     i = find_token(file.header, "\\author", 0)
386     if i != -1:
387         del file.header[i]
388
389     i = find_token(file.header, "\\tracking_changes", 0)
390     if i == -1:
391         return
392     del file.header[i]
393
394
395 def rm_body_changes(file):
396     i = 0
397     while 1:
398         i = find_token(file.body, "\\change_", i)
399         if i == -1:
400             return
401
402         del file.body[i]
403
404
405 ##
406 # \layout -> \begin_layout
407 #
408 def layout2begin_layout(file):
409     i = 0
410     while 1:
411         i = find_token(file.body, '\\layout', i)
412         if i == -1:
413             return
414
415         file.body[i] = replace(file.body[i], '\\layout', '\\begin_layout')
416         i = i + 1
417
418
419 def begin_layout2layout(file):
420     i = 0
421     while 1:
422         i = find_token(file.body, '\\begin_layout', i)
423         if i == -1:
424             return
425
426         file.body[i] = replace(file.body[i], '\\begin_layout', '\\layout')
427         i = i + 1
428
429
430 ##
431 # valignment="center" -> valignment="middle"
432 #
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"')
437
438
439 def convert_table_valignment_middle(file):
440     regexp = re.compile(r'^\\begin_inset\s+Tabular')
441     i = 0
442     while 1:
443         i = find_re(file.body, regexp, i)
444         if i == -1:
445             return
446         j = find_end_of_inset(file.body, i + 1)
447         if j == -1:
448             #this should not happen
449             convert_valignment_middle(file.body, i + 1, len(file.body))
450             return
451         convert_valignment_middle(file.body, i + 1, j)
452         i = j + 1
453
454
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"')
459
460
461 def revert_valignment_middle(file):
462     regexp = re.compile(r'^\\begin_inset\s+Tabular')
463     i = 0
464     while 1:
465         i = find_re(file.body, regexp, i)
466         if i == -1:
467             return
468         j = find_end_of_inset(file.body, i + 1)
469         if j == -1:
470             #this should not happen
471             revert_table_valignment_middle(file.body, i + 1, len(file.body))
472             return
473         revert_table_valignment_middle(file.body, i + 1, j)
474         i = j + 1
475
476
477 ##
478 #  \the_end -> \end_document
479 #
480 def convert_end_document(file):
481     i = find_token(file.body, "\\the_end", 0)
482     if i == -1:
483         file.body.append("\\end_document")
484         return
485     file.body[i] = "\\end_document"
486
487
488 def revert_end_document(file):
489     i = find_token(file.body, "\\end_document", 0)
490     if i == -1:
491         file.body.append("\\the_end")
492         return
493     file.body[i] = "\\the_end"
494
495
496 ##
497 # Convert line and page breaks
498 # Old:
499 #\layout Standard
500 #\line_top \line_bottom \pagebreak_top \pagebreak_bottom \added_space_top xxx \added_space_bottom yyy
501 #0
502 #
503 # New:
504 #\begin layout Standard
505 #
506 #\newpage
507 #
508 #\lyxline
509 #\begin_inset VSpace xxx
510 #\end_inset
511 #
512 #\end_layout
513 #\begin_layout Standard
514 #
515 #0
516 #\end_layout
517 #\begin_layout Standard
518 #
519 #\begin_inset VSpace xxx
520 #\end_inset
521 #\lyxline
522 #
523 #\newpage
524 #
525 #\end_layout
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',
530                  'start_of_appendix')
531     i = 0
532     while 1:
533         i = find_token(file.body, "\\begin_layout", i)
534         if i == -1:
535             return
536         i = i + 1
537
538         # Merge all paragraph parameters into a single line
539         # We cannot check for '\\' only because paragraphs may start e.g.
540         # with '\\backslash'
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]
543             del file.body[i+1]
544
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")
551
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:
553             continue
554
555         for tag in "\\line_top", "\\line_bottom", "\\pagebreak_top", "\\pagebreak_bottom":
556             file.body[i] = replace(file.body[i], tag, "")
557
558         if vspace_top != -1:
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:])
565
566         if vspace_bot != -1:
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:])
573
574         file.body[i] = strip(file.body[i])
575         i = i + 1
576
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:
580
581             paragraph_above = ['','\\begin_layout Standard','','']
582
583             if pb_top != -1:
584                 paragraph_above.extend(['\\newpage ',''])
585
586             if vspace_top != -1:
587                 paragraph_above.extend(['\\begin_inset VSpace ' + vspace_top_value,'\\end_inset','',''])
588
589             if line_top != -1:
590                 paragraph_above.extend(['\\lyxline ',''])
591
592             paragraph_above.extend(['\\end_layout',''])
593
594             #inset new paragraph above the current paragraph
595             file.body[i-2:i-2] = paragraph_above
596             i = i + len(paragraph_above)
597
598         # Ensure that nested style are converted later.
599         k = find_end_of(file.body, i, "\\begin_layout", "\\end_layout")
600
601         if k == -1:
602             return
603
604         if pb_bot !=-1 or line_bot != -1 or vspace_bot != -1:
605
606             paragraph_below = ['','\\begin_layout Standard','','']
607
608             if line_bot != -1:
609                 paragraph_below.extend(['\\lyxline ',''])
610
611             if vspace_bot != -1:
612                 paragraph_below.extend(['\\begin_inset VSpace ' + vspace_bot_value,'\\end_inset','',''])
613
614             if pb_bot != -1:
615                 paragraph_below.extend(['\\newpage ',''])
616
617             paragraph_below.extend(['\\end_layout',''])
618
619             #inset new paragraph above the current paragraph
620             file.body[k + 1: k + 1] = paragraph_below
621
622
623 ##
624 #  Notes
625 #
626 def convert_note(file):
627     i = 0
628     while 1:
629         i = find_tokens(file.body, ["\\begin_inset Note",
630                                 "\\begin_inset Comment",
631                                 "\\begin_inset Greyedout"], i)
632         if i == -1:
633             break
634
635         file.body[i] = file.body[i][0:13] + 'Note ' + file.body[i][13:]
636         i = i + 1
637
638
639 def revert_note(file):
640     note_header = "\\begin_inset Note "
641     i = 0
642     while 1:
643         i = find_token(file.body, note_header, i)
644         if i == -1:
645             break
646
647         file.body[i] = "\\begin_inset " + file.body[i][len(note_header):]
648         i = i + 1
649
650
651 ##
652 # Box
653 #
654 def convert_box(file):
655     i = 0
656     while 1:
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)
663         if i == -1:
664             break
665
666         file.body[i] = file.body[i][0:13] + 'Box ' + file.body[i][13:]
667         i = i + 1
668
669
670 def revert_box(file):
671     box_header = "\\begin_inset Box "
672     i = 0
673     while 1:
674         i = find_token(file.body, box_header, i)
675         if i == -1:
676             break
677
678         file.body[i] = "\\begin_inset " + file.body[i][len(box_header):]
679         i = i + 1
680
681
682 ##
683 # Collapse
684 #
685 def convert_collapsable(file):
686     i = 0
687     while 1:
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)
697         if i == -1:
698             break
699
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
703         i = i + 1
704         while 1:
705             if (file.body[i] == "collapsed false"):
706                 file.body[i] = "status open"
707                 break
708             elif (file.body[i] == "collapsed true"):
709                 file.body[i] = "status collapsed"
710                 break
711             elif (file.body[i][:13] == "\\begin_layout"):
712                 file.warning("Malformed LyX file: Missing 'collapsed'.")
713                 break
714             i = i + 1
715
716         i = i + 1
717
718
719 def revert_collapsable(file):
720     i = 0
721     while 1:
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)
731         if i == -1:
732             break
733
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
737         i = i + 1
738         while 1:
739             if (file.body[i] == "status open"):
740                 file.body[i] = "collapsed false"
741                 break
742             elif (file.body[i] == "status collapsed" or
743                   file.body[i] == "status inlined"):
744                 file.body[i] = "collapsed true"
745                 break
746             elif (file.body[i][:13] == "\\begin_layout"):
747                 file.warning("Malformed LyX file: Missing 'status'.")
748                 break
749             i = i + 1
750
751         i = i + 1
752
753
754 ##
755 #  ERT
756 #
757 def convert_ert(file):
758     i = 0
759     while 1:
760         i = find_token(file.body, "\\begin_inset ERT", i)
761         if i == -1:
762             break
763
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
767         i = i + 1
768         while 1:
769             if (file.body[i] == "status Open"):
770                 file.body[i] = "status open"
771                 break
772             elif (file.body[i] == "status Collapsed"):
773                 file.body[i] = "status collapsed"
774                 break
775             elif (file.body[i] == "status Inlined"):
776                 file.body[i] = "status inlined"
777                 break
778             elif (file.body[i][:13] == "\\begin_layout"):
779                 file.warning("Malformed LyX file: Missing 'status'.")
780                 break
781             i = i + 1
782
783         i = i + 1
784
785
786 def revert_ert(file):
787     i = 0
788     while 1:
789         i = find_token(file.body, "\\begin_inset ERT", i)
790         if i == -1:
791             break
792
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
796         i = i + 1
797         while 1:
798             if (file.body[i] == "status open"):
799                 file.body[i] = "status Open"
800                 break
801             elif (file.body[i] == "status collapsed"):
802                 file.body[i] = "status Collapsed"
803                 break
804             elif (file.body[i] == "status inlined"):
805                 file.body[i] = "status Inlined"
806                 break
807             elif (file.body[i][:13] == "\\begin_layout"):
808                 file.warning("Malformed LyX file : Missing 'status'.")
809                 break
810             i = i + 1
811
812         i = i + 1
813
814
815 ##
816 # Minipages
817 #
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.
821     """
822     pos = ["t","c","b"]
823     inner_pos = ["c","t","b","s"]
824
825     i = 0
826     while 1:
827         i = find_token(file.body, "\\begin_inset Minipage", i)
828         if i == -1:
829             return
830
831         file.body[i] = "\\begin_inset Box Frameless"
832         i = i + 1
833
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])]
837         else:
838             file.body.insert(i, 'position "%s"' % pos[0])
839         i = i + 1
840
841         file.body.insert(i, 'hor_pos "c"')
842         i = i + 1
843         file.body.insert(i, 'has_inner_box 1')
844         i = i + 1
845
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])]
849         else:
850             file.body.insert('inner_pos "%s"' % inner_pos[0])
851         i = i + 1
852
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"':
859                 height = ' "1pt"'
860             del file.body[i]
861         else:
862             height = ' "1pt"'
863
864         if file.body[i][:5] == "width":
865             width = file.body[i][5:]
866             del file.body[i]
867         else:
868             width = ' "0"'
869
870         if file.body[i][:9] == "collapsed":
871             if file.body[i][9:] == "true":
872                 status = "collapsed"
873             else:
874                 status = "open"
875             del file.body[i]
876         else:
877             status = "collapsed"
878
879         file.body.insert(i, 'use_parbox 0')
880         i = i + 1
881         file.body.insert(i, 'width' + width)
882         i = i + 1
883         file.body.insert(i, 'special "none"')
884         i = i + 1
885         file.body.insert(i, 'height' + height)
886         i = i + 1
887         file.body.insert(i, 'height_special "totalheight"')
888         i = i + 1
889         file.body.insert(i, 'status ' + status)
890         i = i + 1
891
892
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):
897     for c in ert:
898         if c == '\\':
899             body[i] = body[i] + '\\backslash '
900             i = i + 1
901             body.insert(i, '')
902         elif c == '\n':
903             body[i+1:i+1] = ['\\newline ', '']
904             i = i + 2
905         else:
906             body[i] = body[i] + c
907     return i
908
909
910 def convert_vspace(file):
911
912     # Get default spaceamount
913     i = find_token(file.header, '\\defskip', 0)
914     if i == -1:
915         defskipamount = 'medskip'
916     else:
917         defskipamount = split(file.header[i])[1]
918
919     # Convert the insets
920     i = 0
921     while 1:
922         i = find_token(file.body, '\\begin_inset VSpace', i)
923         if i == -1:
924             return
925         spaceamount = split(file.body[i])[2]
926
927         # Are we at the beginning or end of a paragraph?
928         paragraph_start = 1
929         start = get_paragraph(file.body, i) + 1
930         for k in range(start, i):
931             if is_nonempty_line(file.body[k]):
932                 paragraph_start = 0
933                 break
934         paragraph_end = 1
935         j = find_end_of_inset(file.body, i)
936         if j == -1:
937             file.warning("Malformed LyX file: Missing '\\end_inset'.")
938             i = i + 1
939             continue
940         end = get_next_paragraph(file.body, i)
941         for k in range(j + 1, end):
942             if is_nonempty_line(file.body[k]):
943                 paragraph_end = 0
944                 break
945
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
951             del file.body[j]
952             del file.body[i]
953             if paragraph_start:
954                 file.body.insert(start, '\\added_space_top ' + spaceamount + ' ')
955             else:
956                 file.body.insert(start, '\\added_space_bottom ' + spaceamount + ' ')
957             continue
958
959         # Convert to ERT
960         file.body[i:i+1] = ['\\begin_inset ERT', 'status Collapsed', '',
961                         '\\layout Standard', '', '\\backslash ']
962         i = i + 6
963         if spaceamount[-1] == '*':
964             spaceamount = spaceamount[:-1]
965             keep = 1
966         else:
967             keep = 0
968
969         # Replace defskip by the actual value
970         if spaceamount == 'defskip':
971             spaceamount = defskipamount
972
973         # LaTeX does not know \\smallskip* etc
974         if keep:
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'
983
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)
988         else :
989             if keep:
990                 file.body.insert(i, 'vspace*{')
991             else:
992                 file.body.insert(i, 'vspace{')
993             i = convert_ertbackslash(file.body, i, spaceamount)
994             file.body[i] =  file.body[i] + '}'
995         i = i + 1
996
997
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"}
1003
1004     # Convert special lengths
1005     if special != 'none':
1006         len = '%f\\' % len2value(len) + special
1007
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]
1012             break
1013
1014     return len
1015
1016
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))
1022
1023
1024 # Return the value of len without the unit in numerical form
1025 def len2value(len):
1026     result = re.search('([+-]?[0-9.]+)', len)
1027     if result:
1028         return float(result.group(1))
1029     # No number means 1.0
1030     return 1.0
1031
1032
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', '']
1038     i = i + 5
1039     i = convert_ertbackslash(body, i, text) + 1
1040     body[i:i] = ['', '\\end_inset', '']
1041     i = i + 3
1042     return i
1043
1044
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)
1049     if i == -1:
1050         file.warning("Malformed LyX file: Missing '\\begin_preamble'.")
1051         return
1052     j = find_token(file.header, '\\end_preamble', i)
1053     if j == -1:
1054         file.warning("Malformed LyX file: Missing '\\end_preamble'.")
1055         return
1056     if find_token(file.header, text[0], i, j) != -1:
1057         return
1058     file.header[j:j] = text
1059
1060
1061 def convert_frameless_box(file):
1062     pos = ['t', 'c', 'b']
1063     inner_pos = ['c', 't', 'b', 's']
1064     i = 0
1065     while 1:
1066         i = find_token(file.body, '\\begin_inset Frameless', i)
1067         if i == -1:
1068             return
1069         j = find_end_of_inset(file.body, i)
1070         if j == -1:
1071             file.warning("Malformed LyX file: Missing '\\end_inset'.")
1072             i = i + 1
1073             continue
1074         del file.body[i]
1075         j = j - 1
1076
1077         # Gather parameters
1078         params = {'position':'0', 'hor_pos':'c', 'has_inner_box':'1',
1079                   'inner_pos':'1', 'use_parbox':'0', 'width':'100col%',
1080                   'special':'none', 'height':'1in',
1081                   'height_special':'totalheight', 'collapsed':'false'}
1082         for key in params.keys():
1083             value = replace(get_value(file.body, key, i, j), '"', '')
1084             if value != "":
1085                 if key == 'position':
1086                     # convert new to old position: 'position "t"' -> 0
1087                     value = find_token(pos, value, 0)
1088                     if value != -1:
1089                         params[key] = value
1090                 elif key == 'inner_pos':
1091                     # convert inner position
1092                     value = find_token(inner_pos, value, 0)
1093                     if value != -1:
1094                         params[key] = value
1095                 else:
1096                     params[key] = value
1097                 j = del_token(file.body, key, i, j)
1098         i = i + 1
1099
1100         # Convert to minipage or ERT?
1101         # Note that the inner_position and height parameters of a minipage
1102         # inset are ignored and not accessible for the user, although they
1103         # are present in the file format and correctly read in and written.
1104         # Therefore we convert to ERT if they do not have their LaTeX
1105         # defaults. These are:
1106         # - the value of "position" for "inner_pos"
1107         # - "\totalheight"          for "height"
1108         if (params['use_parbox'] != '0' or
1109             params['has_inner_box'] != '1' or
1110             params['special'] != 'none' or
1111             inner_pos[params['inner_pos']] != pos[params['position']] or
1112             params['height_special'] != 'totalheight' or
1113             len2value(params['height']) != 1.0):
1114
1115             # Here we know that this box is not supported in file format 224.
1116             # Therefore we need to convert it to ERT. We can't simply convert
1117             # the beginning and end of the box to ERT, because the
1118             # box inset may contain layouts that are different from the
1119             # surrounding layout. After the conversion the contents of the
1120             # box inset is on the same level as the surrounding text, and
1121             # paragraph layouts and align parameters can get mixed up.
1122
1123             # A possible solution for this problem:
1124             # Convert the box to a minipage and redefine the minipage
1125             # environment in ERT so that the original box is simulated.
1126             # For minipages we could do this in a way that the width and
1127             # position can still be set from LyX, but this did not work well.
1128             # This is not possible for parboxes either, so we convert the
1129             # original box to ERT, put the minipage inset inside the box
1130             # and redefine the minipage environment to be empty.
1131
1132             # Commands that are independant of a particular box can go to
1133             # the preamble.
1134             # We need to define lyxtolyxrealminipage with 3 optional
1135             # arguments although LyX 1.3 uses only the first one.
1136             # Otherwise we will get LaTeX errors if this document is
1137             # converted to format 225 or above again (LyX 1.4 uses all
1138             # optional arguments).
1139             add_to_preamble(file,
1140                 ['% Commands inserted by lyx2lyx for frameless boxes',
1141                  '% Save the original minipage environment',
1142                  '\\let\\lyxtolyxrealminipage\\minipage',
1143                  '\\let\\endlyxtolyxrealminipage\\endminipage',
1144                  '% Define an empty lyxtolyximinipage environment',
1145                  '% with 3 optional arguments',
1146                  '\\newenvironment{lyxtolyxiiiminipage}[4]{}{}',
1147                  '\\newenvironment{lyxtolyxiiminipage}[2][\\lyxtolyxargi]%',
1148                  '  {\\begin{lyxtolyxiiiminipage}{\\lyxtolyxargi}{\\lyxtolyxargii}{#1}{#2}}%',
1149                  '  {\\end{lyxtolyxiiiminipage}}',
1150                  '\\newenvironment{lyxtolyximinipage}[1][\\totalheight]%',
1151                  '  {\\def\\lyxtolyxargii{{#1}}\\begin{lyxtolyxiiminipage}}%',
1152                  '  {\\end{lyxtolyxiiminipage}}',
1153                  '\\newenvironment{lyxtolyxminipage}[1][c]%',
1154                  '  {\\def\\lyxtolyxargi{{#1}}\\begin{lyxtolyximinipage}}',
1155                  '  {\\end{lyxtolyximinipage}}'])
1156
1157             if params['use_parbox'] != '0':
1158                 ert = '\\parbox'
1159             else:
1160                 ert = '\\begin{lyxtolyxrealminipage}'
1161
1162             # convert optional arguments only if not latex default
1163             if (pos[params['position']] != 'c' or
1164                 inner_pos[params['inner_pos']] != pos[params['position']] or
1165                 params['height_special'] != 'totalheight' or
1166                 len2value(params['height']) != 1.0):
1167                 ert = ert + '[' + pos[params['position']] + ']'
1168             if (inner_pos[params['inner_pos']] != pos[params['position']] or
1169                 params['height_special'] != 'totalheight' or
1170                 len2value(params['height']) != 1.0):
1171                 ert = ert + '[' + convert_len(params['height'],
1172                                               params['height_special']) + ']'
1173             if inner_pos[params['inner_pos']] != pos[params['position']]:
1174                 ert = ert + '[' + inner_pos[params['inner_pos']] + ']'
1175
1176             ert = ert + '{' + convert_len(params['width'],
1177                                           params['special']) + '}'
1178
1179             if params['use_parbox'] != '0':
1180                 ert = ert + '{'
1181             ert = ert + '\\let\\minipage\\lyxtolyxminipage%\n'
1182             ert = ert + '\\let\\endminipage\\endlyxtolyxminipage%\n'
1183
1184             old_i = i
1185             i = insert_ert(file.body, i, 'Collapsed', ert)
1186             j = j + i - old_i - 1
1187
1188             file.body[i:i] = ['\\begin_inset Minipage',
1189                               'position %d' % params['position'],
1190                               'inner_position 1',
1191                               'height "1in"',
1192                               'width "' + params['width'] + '"',
1193                               'collapsed ' + params['collapsed']]
1194             i = i + 6
1195             j = j + 6
1196
1197             # Restore the original minipage environment since we may have
1198             # minipages inside this box.
1199             # Start a new paragraph because the following may be nonstandard
1200             file.body[i:i] = ['\\layout Standard', '', '']
1201             i = i + 2
1202             j = j + 3
1203             ert = '\\let\\minipage\\lyxtolyxrealminipage%\n'
1204             ert = ert + '\\let\\endminipage\\lyxtolyxrealendminipage%'
1205             old_i = i
1206             i = insert_ert(file.body, i, 'Collapsed', ert)
1207             j = j + i - old_i - 1
1208
1209             # Redefine the minipage end before the inset end.
1210             # Start a new paragraph because the previous may be nonstandard
1211             file.body[j:j] = ['\\layout Standard', '', '']
1212             j = j + 2
1213             ert = '\\let\\endminipage\\endlyxtolyxminipage'
1214             j = insert_ert(file.body, j, 'Collapsed', ert)
1215             j = j + 1
1216             file.body.insert(j, '')
1217             j = j + 1
1218
1219             # LyX writes '%\n' after each box. Therefore we need to end our
1220             # ERT with '%\n', too, since this may swallow a following space.
1221             if params['use_parbox'] != '0':
1222                 ert = '}%\n'
1223             else:
1224                 ert = '\\end{lyxtolyxrealminipage}%\n'
1225             j = insert_ert(file.body, j, 'Collapsed', ert)
1226
1227             # We don't need to restore the original minipage after the inset
1228             # end because the scope of the redefinition is the original box.
1229
1230         else:
1231
1232             # Convert to minipage
1233             file.body[i:i] = ['\\begin_inset Minipage',
1234                               'position %d' % params['position'],
1235                               'inner_position %d' % params['inner_pos'],
1236                               'height "' + params['height'] + '"',
1237                               'width "' + params['width'] + '"',
1238                               'collapsed ' + params['collapsed']]
1239             i = i + 6
1240
1241 ##
1242 # Convert jurabib
1243 #
1244
1245 def convert_jurabib(file):
1246     i = find_token(file.header, '\\use_numerical_citations', 0)
1247     if i == -1:
1248         file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
1249         return
1250     file.header.insert(i + 1, '\\use_jurabib 0')
1251
1252
1253 def revert_jurabib(file):
1254     i = find_token(file.header, '\\use_jurabib', 0)
1255     if i == -1:
1256         file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1257         return
1258     if get_value(file.header, '\\use_jurabib', 0) != "0":
1259         file.warning("Conversion of '\\use_jurabib = 1' not yet implemented.")
1260         # Don't remove '\\use_jurabib' so that people will get warnings by lyx
1261         return
1262     del file.header[i]
1263
1264 ##
1265 # Convert bibtopic
1266 #
1267
1268 def convert_bibtopic(file):
1269     i = find_token(file.header, '\\use_jurabib', 0)
1270     if i == -1:
1271         file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1272         return
1273     file.header.insert(i + 1, '\\use_bibtopic 0')
1274
1275
1276 def revert_bibtopic(file):
1277     i = find_token(file.header, '\\use_bibtopic', 0)
1278     if i == -1:
1279         file.warning("Malformed lyx file: Missing '\\use_bibtopic'.")
1280         return
1281     if get_value(file.header, '\\use_bibtopic', 0) != "0":
1282         file.warning("Conversion of '\\use_bibtopic = 1' not yet implemented.")
1283         # Don't remove '\\use_jurabib' so that people will get warnings by lyx
1284     del file.header[i]
1285
1286 ##
1287 # Sideway Floats
1288 #
1289
1290 def convert_float(file):
1291     i = 0
1292     while 1:
1293         i = find_token(file.body, '\\begin_inset Float', i)
1294         if i == -1:
1295             return
1296         # Seach for a line starting 'wide'
1297         # If, however, we find a line starting '\begin_layout'
1298         # (_always_ present) then break with a warning message
1299         i = i + 1
1300         while 1:
1301             if (file.body[i][:4] == "wide"):
1302                 file.body.insert(i + 1, 'sideways false')
1303                 break
1304             elif (file.body[i][:13] == "\\begin_layout"):
1305                 file.warning("Malformed lyx file: Missing 'wide'.")
1306                 break
1307             i = i + 1
1308         i = i + 1
1309
1310
1311 def revert_float(file):
1312     i = 0
1313     while 1:
1314         i = find_token(file.body, '\\begin_inset Float', i)
1315         if i == -1:
1316             return
1317         j = find_end_of_inset(file.body, i)
1318         if j == -1:
1319             file.warning("Malformed lyx file: Missing '\\end_inset'.")
1320             i = i + 1
1321             continue
1322         if get_value(file.body, 'sideways', i, j) != "false":
1323             file.warning("Conversion of 'sideways true' not yet implemented.")
1324             # Don't remove 'sideways' so that people will get warnings by lyx
1325             i = i + 1
1326             continue
1327         del_token(file.body, 'sideways', i, j)
1328         i = i + 1
1329
1330
1331 def convert_graphics(file):
1332     """ Add extension to filenames of insetgraphics if necessary.
1333     """
1334     i = 0
1335     while 1:
1336         i = find_token(file.body, "\\begin_inset Graphics", i)
1337         if i == -1:
1338             return
1339
1340         j = find_token2(file.body, "filename", i)
1341         if j == -1:
1342             return
1343         i = i + 1
1344         filename = split(file.body[j])[1]
1345         absname = os.path.normpath(os.path.join(file.dir, filename))
1346         if file.input == stdin and not os.path.isabs(filename):
1347             # We don't know the directory and cannot check the file.
1348             # We could use a heuristic and take the current directory,
1349             # and we could try to find out if filename has an extension,
1350             # but that would be just guesses and could be wrong.
1351             file.warning("""Warning: Can not determine whether file
1352          %s
1353          needs an extension when reading from standard input.
1354          You may need to correct the file manually or run
1355          lyx2lyx again with the .lyx file as commandline argument.""" % filename)
1356             continue
1357         # This needs to be the same algorithm as in pre 233 insetgraphics
1358         if access(absname, F_OK):
1359             continue
1360         if access(absname + ".ps", F_OK):
1361             file.body[j] = replace(file.body[j], filename, filename + ".ps")
1362             continue
1363         if access(absname + ".eps", F_OK):
1364             file.body[j] = replace(file.body[j], filename, filename + ".eps")
1365
1366
1367 ##
1368 # Convert firstname and surname from styles -> char styles
1369 #
1370 def convert_names(file):
1371     """ Convert in the docbook backend from firstname and surname style
1372     to charstyles.
1373     """
1374     if file.backend != "docbook":
1375         return
1376
1377     i = 0
1378
1379     while 1:
1380         i = find_token(file.body, "\\begin_layout Author", i)
1381         if i == -1:
1382             return
1383
1384         i = i + 1
1385         while file.body[i] == "":
1386             i = i + 1
1387
1388         if file.body[i][:11] != "\\end_layout" or file.body[i+2][:13] != "\\begin_deeper":
1389             i = i + 1
1390             continue
1391
1392         k = i
1393         i = find_end_of( file.body, i+3, "\\begin_deeper","\\end_deeper")
1394         if i == -1:
1395             # something is really wrong, abort
1396             file.warning("Missing \\end_deeper, after style Author.")
1397             file.warning("Aborted attempt to parse FirstName and Surname.")
1398             return
1399         firstname, surname = "", ""
1400
1401         name = file.body[k:i]
1402
1403         j = find_token(name, "\\begin_layout FirstName", 0)
1404         if j != -1:
1405             j = j + 1
1406             while(name[j] != "\\end_layout"):
1407                 firstname = firstname + name[j]
1408                 j = j + 1
1409
1410         j = find_token(name, "\\begin_layout Surname", 0)
1411         if j != -1:
1412             j = j + 1
1413             while(name[j] != "\\end_layout"):
1414                 surname = surname + name[j]
1415                 j = j + 1
1416
1417         # delete name
1418         del file.body[k+2:i+1]
1419
1420         file.body[k-1:k-1] = ["", "",
1421                           "\\begin_inset CharStyle Firstname",
1422                           "status inlined",
1423                           "",
1424                           "\\begin_layout Standard",
1425                           "",
1426                           "%s" % firstname,
1427                           "\end_layout",
1428                           "",
1429                           "\end_inset",
1430                           "",
1431                           "",
1432                           "\\begin_inset CharStyle Surname",
1433                           "status inlined",
1434                           "",
1435                           "\\begin_layout Standard",
1436                           "",
1437                           "%s" % surname,
1438                           "\\end_layout",
1439                           "",
1440                           "\\end_inset",
1441                           ""]
1442
1443
1444 def revert_names(file):
1445     """ Revert in the docbook backend from firstname and surname char style
1446     to styles.
1447     """
1448     if file.backend != "docbook":
1449         return
1450
1451
1452 ##
1453 #    \use_natbib 1                       \cite_engine <style>
1454 #    \use_numerical_citations 0     ->   where <style> is one of
1455 #    \use_jurabib 0                      "basic", "natbib_authoryear",
1456 #                                        "natbib_numerical" or "jurabib"
1457 def convert_cite_engine(file):
1458     a = find_token(file.header, "\\use_natbib", 0)
1459     if a == -1:
1460         file.warning("Malformed lyx file: Missing '\\use_natbib'.")
1461         return
1462
1463     b = find_token(file.header, "\\use_numerical_citations", 0)
1464     if b == -1 or b != a+1:
1465         file.warning("Malformed lyx file: Missing '\\use_numerical_citations'.")
1466         return
1467
1468     c = find_token(file.header, "\\use_jurabib", 0)
1469     if c == -1 or c != b+1:
1470         file.warning("Malformed lyx file: Missing '\\use_jurabib'.")
1471         return
1472
1473     use_natbib = int(split(file.header[a])[1])
1474     use_numerical_citations = int(split(file.header[b])[1])
1475     use_jurabib = int(split(file.header[c])[1])
1476
1477     cite_engine = "basic"
1478     if use_natbib:
1479         if use_numerical_citations:
1480             cite_engine = "natbib_numerical"
1481         else:
1482              cite_engine = "natbib_authoryear"
1483     elif use_jurabib:
1484         cite_engine = "jurabib"
1485
1486     del file.header[a:c+1]
1487     file.header.insert(a, "\\cite_engine " + cite_engine)
1488
1489
1490 def revert_cite_engine(file):
1491     i = find_token(file.header, "\\cite_engine", 0)
1492     if i == -1:
1493         file.warning("Malformed lyx file: Missing '\\cite_engine'.")
1494         return
1495
1496     cite_engine = split(file.header[i])[1]
1497
1498     use_natbib = '0'
1499     use_numerical = '0'
1500     use_jurabib = '0'
1501     if cite_engine == "natbib_numerical":
1502         use_natbib = '1'
1503         use_numerical = '1'
1504     elif cite_engine == "natbib_authoryear":
1505         use_natbib = '1'
1506     elif cite_engine == "jurabib":
1507         use_jurabib = '1'
1508
1509     del file.header[i]
1510     file.header.insert(i, "\\use_jurabib " + use_jurabib)
1511     file.header.insert(i, "\\use_numerical_citations " + use_numerical)
1512     file.header.insert(i, "\\use_natbib " + use_natbib)
1513
1514
1515 ##
1516 # Paper package
1517 #
1518 def convert_paperpackage(file):
1519     i = find_token(file.header, "\\paperpackage", 0)
1520     if i == -1:
1521         file.warning("Malformed lyx file: Missing '\\paperpackage'.")
1522         return
1523
1524     packages = {'default':'none','a4':'none', 'a4wide':'a4', 'widemarginsa4':'a4wide'}
1525     if len(split(file.header[i])) > 1:
1526         paperpackage = split(file.header[i])[1]
1527     else:
1528         paperpackage = "default"
1529     file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
1530
1531
1532 def revert_paperpackage(file):
1533     i = find_token(file.header, "\\paperpackage", 0)
1534     if i == -1:
1535         file.warning("Malformed lyx file: Missing '\\paperpackage'.")
1536         return
1537
1538     packages = {'none':'a4', 'a4':'a4wide', 'a4wide':'widemarginsa4',
1539                 'widemarginsa4':''}
1540     paperpackage = split(file.header[i])[1]
1541     file.header[i] = replace(file.header[i], paperpackage, packages[paperpackage])
1542
1543
1544 ##
1545 # Bullets
1546 #
1547 def convert_bullets(file):
1548     i = 0
1549     while 1:
1550         i = find_token(file.header, "\\bullet", i)
1551         if i == -1:
1552             return
1553         if file.header[i][:12] == '\\bulletLaTeX':
1554             file.header[i] = file.header[i] + ' ' + strip(file.header[i+1])
1555             n = 3
1556         else:
1557             file.header[i] = file.header[i] + ' ' + strip(file.header[i+1]) +\
1558                         ' ' + strip(file.header[i+2]) + ' ' + strip(file.header[i+3])
1559             n = 5
1560         del file.header[i+1:i + n]
1561         i = i + 1
1562
1563
1564 def revert_bullets(file):
1565     i = 0
1566     while 1:
1567         i = find_token(file.header, "\\bullet", i)
1568         if i == -1:
1569             return
1570         if file.header[i][:12] == '\\bulletLaTeX':
1571             n = find(file.header[i], '"')
1572             if n == -1:
1573                 file.warning("Malformed header.")
1574                 return
1575             else:
1576                 file.header[i:i+1] = [file.header[i][:n-1],'\t' + file.header[i][n:], '\\end_bullet']
1577             i = i + 3
1578         else:
1579             frag = split(file.header[i])
1580             if len(frag) != 5:
1581                 file.warning("Malformed header.")
1582                 return
1583             else:
1584                 file.header[i:i+1] = [frag[0] + ' ' + frag[1],
1585                                  '\t' + frag[2],
1586                                  '\t' + frag[3],
1587                                  '\t' + frag[4],
1588                                  '\\end_bullet']
1589                 i = i + 5
1590
1591
1592 ##
1593 # \begin_header and \begin_document
1594 #
1595 def add_begin_header(file):
1596     i = find_token(file.header, '\\lyxformat', 0)
1597     file.header.insert(i+1, '\\begin_header')
1598     file.header.insert(i+1, '\\begin_document')
1599
1600
1601 def remove_begin_header(file):
1602     i = find_token(file.header, "\\begin_document", 0)
1603     if i != -1:
1604         del file.header[i]
1605     i = find_token(file.header, "\\begin_header", 0)
1606     if i != -1:
1607         del file.header[i]
1608
1609
1610 ##
1611 # \begin_file.body and \end_file.body
1612 #
1613 def add_begin_body(file):
1614     file.body.insert(0, '\\begin_body')
1615     file.body.insert(1, '')
1616     i = find_token(file.body, "\\end_document", 0)
1617     file.body.insert(i, '\\end_body')
1618
1619 def remove_begin_body(file):
1620     i = find_token(file.body, "\\begin_body", 0)
1621     if i != -1:
1622         del file.body[i]
1623         if not file.body[i]:
1624             del file.body[i]
1625     i = find_token(file.body, "\\end_body", 0)
1626     if i != -1:
1627         del file.body[i]
1628
1629
1630 ##
1631 # \papersize
1632 #
1633 def normalize_papersize(file):
1634     i = find_token(file.header, '\\papersize', 0)
1635     if i == -1:
1636         return
1637
1638     tmp = split(file.header[i])
1639     if tmp[1] == "Default":
1640         file.header[i] = '\\papersize default'
1641         return
1642     if tmp[1] == "Custom":
1643         file.header[i] = '\\papersize custom'
1644
1645
1646 def denormalize_papersize(file):
1647     i = find_token(file.header, '\\papersize', 0)
1648     if i == -1:
1649         return
1650
1651     tmp = split(file.header[i])
1652     if tmp[1] == "custom":
1653         file.header[i] = '\\papersize Custom'
1654
1655
1656 ##
1657 # Strip spaces at end of command line
1658 #
1659 def strip_end_space(file):
1660     for i in range(len(file.body)):
1661         if file.body[i][:1] == '\\':
1662             file.body[i] = strip(file.body[i])
1663
1664
1665 ##
1666 # Use boolean values for \use_geometry, \use_bibtopic and \tracking_changes
1667 #
1668 def use_x_boolean(file):
1669     bin2bool = {'0': 'false', '1': 'true'}
1670     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
1671         i = find_token(file.header, use, 0)
1672         if i == -1:
1673             continue
1674         decompose = split(file.header[i])
1675         file.header[i] = decompose[0] + ' ' + bin2bool[decompose[1]]
1676
1677
1678 def use_x_binary(file):
1679     bool2bin = {'false': '0', 'true': '1'}
1680     for use in '\\use_geometry', '\\use_bibtopic', '\\tracking_changes':
1681         i = find_token(file.header, use, 0)
1682         if i == -1:
1683             continue
1684         decompose = split(file.header[i])
1685         file.header[i] = decompose[0] + ' ' + bool2bin[decompose[1]]
1686
1687 ##
1688 # Place all the paragraph parameters in their own line
1689 #
1690 def normalize_paragraph_params(file):
1691     body = file.body
1692     allowed_parameters = '\\paragraph_spacing', '\\noindent', '\\align', '\\labelwidthstring', "\\start_of_appendix"
1693
1694     i = 0
1695     while 1:
1696         i = find_token(file.body, '\\begin_layout', i)
1697         if i == -1:
1698             return
1699
1700         i = i + 1
1701         while 1:
1702             if strip(body[i]) and split(body[i])[0] not in allowed_parameters:
1703                 break
1704
1705             j = find(body[i],'\\', 1)
1706
1707             if j != -1:
1708                 body[i:i+1] = [strip(body[i][:j]), body[i][j:]]
1709
1710             i = i + 1
1711
1712
1713 ##
1714 # Add/remove output_changes parameter
1715 #
1716 def convert_output_changes (file):
1717     i = find_token(file.header, '\\tracking_changes', 0)
1718     if i == -1:
1719         file.warning("Malformed lyx file: Missing '\\tracking_changes'.")
1720         return
1721     file.header.insert(i+1, '\\output_changes true')
1722
1723
1724 def revert_output_changes (file):
1725     i = find_token(file.header, '\\output_changes', 0)
1726     if i == -1:
1727         return
1728     del file.header[i]
1729
1730
1731 ##
1732 # Convert paragraph breaks and sanitize paragraphs
1733 #
1734 def convert_ert_paragraphs(file):
1735     forbidden_settings = [
1736                           # paragraph parameters
1737                           '\\paragraph_spacing', '\\labelwidthstring',
1738                           '\\start_of_appendix', '\\noindent',
1739                           '\\leftindent', '\\align',
1740                           # font settings
1741                           '\\family', '\\series', '\\shape', '\\size',
1742                           '\\emph', '\\numeric', '\\bar', '\\noun',
1743                           '\\color', '\\lang']
1744     i = 0
1745     while 1:
1746         i = find_token(file.body, '\\begin_inset ERT', i)
1747         if i == -1:
1748             return
1749         j = find_end_of_inset(file.body, i)
1750         if j == -1:
1751             file.warning("Malformed lyx file: Missing '\\end_inset'.")
1752             i = i + 1
1753             continue
1754
1755         # convert non-standard paragraphs to standard
1756         k = i
1757         while 1:
1758             k = find_token(file.body, "\\begin_layout", k, j)
1759             if k == -1:
1760                 break
1761             file.body[k] = "\\begin_layout Standard"
1762             k = k + 1
1763
1764         # remove all paragraph parameters and font settings
1765         k = i
1766         while k < j:
1767             if (strip(file.body[k]) and
1768                 split(file.body[k])[0] in forbidden_settings):
1769                 del file.body[k]
1770                 j = j - 1
1771             else:
1772                 k = k + 1
1773
1774         # insert an empty paragraph before each paragraph but the first
1775         k = i
1776         first_pagraph = 1
1777         while 1:
1778             k = find_token(file.body, "\\begin_layout Standard", k, j)
1779             if k == -1:
1780                 break
1781             if first_pagraph:
1782                 first_pagraph = 0
1783                 k = k + 1
1784                 continue
1785             file.body[k:k] = ["\\begin_layout Standard", "",
1786                               "\\end_layout", ""]
1787             k = k + 5
1788             j = j + 4
1789
1790         # convert \\newline to new paragraph
1791         k = i
1792         while 1:
1793             k = find_token(file.body, "\\newline", k, j)
1794             if k == -1:
1795                 break
1796             file.body[k:k+1] = ["\\end_layout", "", "\\begin_layout Standard"]
1797             k = k + 4
1798             j = j + 3
1799         i = i + 1
1800
1801
1802 ##
1803 # Remove double paragraph breaks
1804 #
1805 def revert_ert_paragraphs(file):
1806     i = 0
1807     while 1:
1808         i = find_token(file.body, '\\begin_inset ERT', i)
1809         if i == -1:
1810             return
1811         j = find_end_of_inset(file.body, i)
1812         if j == -1:
1813             file.warning("Malformed lyx file: Missing '\\end_inset'.")
1814             i = i + 1
1815             continue
1816
1817         # replace paragraph breaks with \newline
1818         k = i
1819         while 1:
1820             k = find_token(file.body, "\\end_layout", k, j)
1821             l = find_token(file.body, "\\begin_layout", k, j)
1822             if k == -1 or l == -1:
1823                 break
1824             file.body[k:l+1] = ["\\newline"]
1825             j = j - l + k
1826             k = k + 1
1827
1828         # replace double \newlines with paragraph breaks
1829         k = i
1830         while 1:
1831             k = find_token(file.body, "\\newline", k, j)
1832             if k == -1:
1833                 break
1834             l = k + 1
1835             while file.body[l] == "":
1836                 l = l + 1
1837             if strip(file.body[l]) and split(file.body[l])[0] == "\\newline":
1838                 file.body[k:l+1] = ["\\end_layout", "",
1839                                     "\\begin_layout Standard"]
1840                 j = j - l + k + 2
1841                 k = k + 3
1842             else:
1843                 k = k + 1
1844         i = i + 1
1845
1846
1847 ##
1848 # Convertion hub
1849 #
1850
1851 convert = [[223, [insert_tracking_changes, add_end_header, remove_color_default,
1852                   convert_spaces, convert_bibtex, remove_insetparent]],
1853            [224, [convert_external, convert_comment]],
1854            [225, [add_end_layout, layout2begin_layout, convert_end_document,
1855                   convert_table_valignment_middle, convert_breaks]],
1856            [226, [convert_note]],
1857            [227, [convert_box]],
1858            [228, [convert_collapsable, convert_ert]],
1859            [229, [convert_minipage]],
1860            [230, [convert_jurabib]],
1861            [231, [convert_float]],
1862            [232, [convert_bibtopic]],
1863            [233, [convert_graphics, convert_names]],
1864            [234, [convert_cite_engine]],
1865            [235, [convert_paperpackage]],
1866            [236, [convert_bullets, add_begin_header, add_begin_body,
1867                   normalize_papersize, strip_end_space]],
1868            [237, [use_x_boolean]],
1869            [238, [update_latexaccents]],
1870            [239, [normalize_paragraph_params]],
1871            [240, [convert_output_changes]],
1872            [241, [convert_ert_paragraphs]]]
1873
1874 revert =  [[240, [revert_ert_paragraphs]],
1875            [239, [revert_output_changes]],
1876            [238, []],
1877            [237, []],
1878            [236, [use_x_binary]],
1879            [235, [denormalize_papersize, remove_begin_body,remove_begin_header,
1880                   revert_bullets]],
1881            [234, [revert_paperpackage]],
1882            [233, [revert_cite_engine]],
1883            [232, [revert_names]],
1884            [231, [revert_bibtopic]],
1885            [230, [revert_float]],
1886            [229, [revert_jurabib]],
1887            [228, []],
1888            [227, [revert_collapsable, revert_ert]],
1889            [226, [revert_box, revert_external_2]],
1890            [225, [revert_note]],
1891            [224, [rm_end_layout, begin_layout2layout, revert_end_document,
1892                   revert_valignment_middle, convert_vspace, convert_frameless_box]],
1893            [223, [revert_external_2, revert_comment, revert_eqref]],
1894            [221, [rm_end_header, revert_spaces, revert_bibtex,
1895                   rm_tracking_changes, rm_body_changes]]]
1896
1897
1898 if __name__ == "__main__":
1899     pass