1 # This file is part of lyx2lyx
2 # -*- coding: utf-8 -*-
3 # Copyright (C) 2007 José Matos <jamatos@lyx.org>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 """ Convert files to the file format generated by lyx 1.6"""
25 from parser_tools import find_token, find_end_of, find_tokens
27 ####################################################################
28 # Private helper functions
30 def find_end_of_inset(lines, i):
31 " Find end of inset, where lines[i] is included."
32 return find_end_of(lines, i, "\\begin_inset", "\\end_inset")
35 ####################################################################
37 def fix_wrong_tables(document):
40 i = find_token(document.body, "\\begin_inset Tabular", i)
43 j = find_end_of_inset(document.body, i + 1)
45 document.warning("Malformed LyX document: Could not find end of tabular.")
49 nrows = int(document.body[i+1].split('"')[3])
50 ncols = int(document.body[i+1].split('"')[5])
52 for l in range(nrows):
54 for k in range(ncols):
55 m = find_token(document.body, '<cell', m)
57 if document.body[m].find('multicolumn') != -1:
58 multicol_cont = int(document.body[m].split('"')[1])
60 if multicol_cont == 2 and (k == 0 or prev_multicolumn == 0):
61 document.body[m] = document.body[m][:5] + document.body[m][21:]
64 prev_multicolumn = multicol_cont
71 def close_begin_deeper(document):
75 i = find_tokens(document.body, ["\\begin_deeper", "\\end_deeper"], i)
80 if document.body[i][:13] == "\\begin_deeper":
87 document.body[-2:-2] = ['\\end_deeper' for i in range(depth)]
90 def long_charstyle_names(document):
93 i = find_token(document.body, "\\begin_inset CharStyle", i)
96 document.body[i] = document.body[i].replace("CharStyle ", "CharStyle CharStyle:")
99 def revert_long_charstyle_names(document):
102 i = find_token(document.body, "\\begin_inset CharStyle", i)
105 document.body[i] = document.body[i].replace("CharStyle CharStyle:", "CharStyle")
109 def axe_show_label(document):
112 i = find_token(document.body, "\\begin_inset CharStyle", i)
115 if document.body[i + 1].find("show_label") != -1:
116 if document.body[i + 1].find("true") != -1:
117 document.body[i + 1] = "status open"
118 del document.body[ i + 2]
120 if document.body[i + 1].find("false") != -1:
121 document.body[i + 1] = "status collapsed"
122 del document.body[ i + 2]
124 document.warning("Malformed LyX document: show_label neither false nor true.")
126 document.warning("Malformed LyX document: show_label missing in CharStyle.")
131 def revert_show_label(document):
134 i = find_token(document.body, "\\begin_inset CharStyle", i)
137 if document.body[i + 1].find("status open") != -1:
138 document.body.insert(i + 1, "show_label true")
140 if document.body[i + 1].find("status collapsed") != -1:
141 document.body.insert(i + 1, "show_label false")
143 document.warning("Malformed LyX document: no legal status line in CharStyle.")
146 def revert_begin_modules(document):
149 i = find_token(document.header, "\\begin_modules", i)
152 j = find_end_of(document.header, i, "\\begin_modules", "\\end_modules")
154 # this should not happen
156 document.header[i : j + 1] = []
158 def convert_flex(document):
159 "Convert CharStyle to Flex"
162 i = find_token(document.body, "\\begin_inset CharStyle", i)
165 document.body[i] = document.body[i].replace('\\begin_inset CharStyle', '\\begin_inset Flex')
167 def revert_flex(document):
168 "Convert Flex to CharStyle"
171 i = find_token(document.body, "\\begin_inset Flex", i)
174 document.body[i] = document.body[i].replace('\\begin_inset Flex', '\\begin_inset CharStyle')
177 def remove_manifest(document):
178 "Remove the manifest section"
179 document.manifest = None
182 # Discard PDF options for hyperref
183 def revert_pdf_options(document):
184 "Revert PDF options for hyperref."
186 i = find_token(document.header, "\\use_hyperref", i)
188 del document.header[i]
189 i = find_token(document.header, "\\pdf_store_options", i)
191 del document.header[i]
192 i = find_token(document.header, "\\pdf_title", 0)
194 del document.header[i]
195 i = find_token(document.header, "\\pdf_author", 0)
197 del document.header[i]
198 i = find_token(document.header, "\\pdf_subject", 0)
200 del document.header[i]
201 i = find_token(document.header, "\\pdf_keywords", 0)
203 del document.header[i]
204 i = find_token(document.header, "\\pdf_bookmarks", 0)
206 del document.header[i]
207 i = find_token(document.header, "\\pdf_bookmarksnumbered", i)
209 del document.header[i]
210 i = find_token(document.header, "\\pdf_bookmarksopen", i)
212 del document.header[i]
213 i = find_token(document.header, "\\pdf_bookmarksopenlevel", i)
215 del document.header[i]
216 i = find_token(document.header, "\\pdf_breaklinks", i)
218 del document.header[i]
219 i = find_token(document.header, "\\pdf_pdfborder", i)
221 del document.header[i]
222 i = find_token(document.header, "\\pdf_colorlinks", i)
224 del document.header[i]
225 i = find_token(document.header, "\\pdf_backref", i)
227 del document.header[i]
228 i = find_token(document.header, "\\pdf_pagebackref", i)
230 del document.header[i]
231 i = find_token(document.header, "\\pdf_pagemode", 0)
233 del document.header[i]
234 i = find_token(document.header, "\\pdf_quoted_options", 0)
236 del document.header[i]
239 def remove_inzip_options(document):
240 "Remove inzipName and embed options from the Graphics inset"
243 i = find_token(document.body, "\\begin_inset Graphics", i)
246 j = find_end_of_inset(document.body, i + 1)
249 document.warning("Malformed LyX document: Could not find end of graphics inset.")
250 # If there's a inzip param, just remove that
251 k = find_token(document.body, "\tinzipName", i + 1, j)
254 # embed option must follow the inzipName option
255 del document.body[k+1]
259 def convert_inset_command(document):
262 \begin_inset LatexCommand cmd
264 \begin_inset CommandInset InsetType
269 i = find_token(document.body, "\\begin_inset LatexCommand", i)
272 line = document.body[i]
273 r = re.compile(r'\\begin_inset LatexCommand (.*)$')
277 #this is adapted from factory.cpp
278 if cmdName[0:4].lower() == "cite":
279 insetName = "citation"
280 elif cmdName == "url" or cmdName == "htmlurl":
282 elif cmdName[-3:] == "ref":
284 elif cmdName == "tableofcontents":
286 elif cmdName == "printnomenclature":
287 insetName = "nomencl_print"
288 elif cmdName == "printindex":
289 insetName = "index_print"
292 insertion = ["\\begin_inset CommandInset " + insetName, "LatexCommand " + cmdName]
293 document.body[i : i+1] = insertion
296 def revert_inset_command(document):
299 \begin_inset CommandInset InsetType
302 \begin_inset LatexCommand cmd
303 Some insets may end up being converted to insets earlier versions of LyX
304 will not be able to recognize. Not sure what to do about that.
306 # FIXME, this routine doesn't work, must be fixed before LyX 1.6.0, see
307 # http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg128426.html
310 i = find_token(document.body, "\\begin_inset CommandInset", i)
311 nextline = document.body[i+1]
312 r = re.compile(r'LatexCommand\s+(.*)$')
313 m = r.match(nextline)
315 document.warning("Malformed LyX document: Missing LatexCommand in " + document.body[i] + ".")
318 insertion = ["\\begin_inset LatexCommand " + cmdName]
319 document.body[i : i+2] = insertion
322 def convert_wrapfig_options(document):
323 "Convert optional options for wrap floats (wrapfig)."
324 # adds the tokens "lines", "placement", and "overhang"
327 i = find_token(document.body, "\\begin_inset Wrap figure", i)
330 document.body.insert(i + 1, "lines 0")
331 j = find_token(document.body, "placement", i)
332 # placement can be already set or not; if not, set it
334 document.body.insert(i + 3, "overhang 0col%")
336 document.body.insert(i + 2, "placement o")
337 document.body.insert(i + 3, "overhang 0col%")
341 def revert_wrapfig_options(document):
342 "Revert optional options for wrap floats (wrapfig)."
345 i = find_token(document.body, "lines", i)
349 j = find_token(document.body, "overhang", i+1)
350 if j != i + 1 and j != -1:
351 document.warning("Malformed LyX document: Couldn't find overhang parameter of wrap float.")
362 supported_versions = ["1.6.0","1.6"]
364 [277, [fix_wrong_tables]],
365 [278, [close_begin_deeper]],
366 [279, [long_charstyle_names]],
367 [280, [axe_show_label]],
370 [283, [convert_flex]],
372 [285, []], # an empty manifest is automatically added
374 [287, [convert_wrapfig_options]],
375 [288, [convert_inset_command]]
379 [287, [revert_inset_command]],
380 [286, [revert_wrapfig_options]],
381 [285, [revert_pdf_options]],
382 [284, [remove_manifest, remove_inzip_options]],
384 [282, [revert_flex]],
386 [280, [revert_begin_modules]],
387 [279, [revert_show_label]],
388 [278, [revert_long_charstyle_names]],
394 if __name__ == "__main__":