2 # -*- coding: utf-8 -*-
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 import glob, logging, os, re, shutil, subprocess, sys
14 logging.basicConfig(level = logging.DEBUG,
15 format = '%(levelname)s: %(message)s', # ignore application name
16 filename = 'configure.log',
19 # Add a handler to log to console
20 console = logging.StreamHandler()
21 console.setLevel(logging.INFO) # the console only print out general information
22 formatter = logging.Formatter('%(message)s') # only print out the message itself
23 console.setFormatter(formatter)
24 logger = logging.getLogger('LyX')
25 logger.addHandler(console)
27 def writeToFile(filename, lines, append = False):
28 " utility function: write or append lines to filename "
30 file = open(filename, 'a')
32 file = open(filename, 'w')
38 ''' utility function: shortcut for appending lines to outfile
39 add newline at the end of lines.
41 if lines.strip() != '':
42 writeToFile(outfile, lines + '\n', append = True)
43 logger.debug('Add to RC:\n' + lines + '\n\n')
46 def removeFiles(filenames):
47 '''utility function: 'rm -f'
48 ignore errors when file does not exist, or is a directory.
50 for file in filenames:
53 logger.debug('Removing file %s' % file)
55 logger.debug('Failed to remove file %s' % file)
60 '''utility function: run a command and get its output as a string
65 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
68 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
69 stdout=subprocess.PIPE, universal_newlines=True)
71 output = pipe.stdout.read()
77 ''' On Windows, return the short version of "path" if possible '''
79 from ctypes import windll, create_unicode_buffer
80 GetShortPathName = windll.kernel32.GetShortPathNameW
81 shortlen = GetShortPathName(path, 0, 0)
82 shortpath = create_unicode_buffer(shortlen)
83 if GetShortPathName(path, shortpath, shortlen):
84 return shortpath.value
89 ''' I do not really know why this is useful, but we might as well keep it.
91 Only set these to C if already set. These must not be set unconditionally
92 because not all systems understand e.g. LANG=C (notably SCO).
93 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
94 Non-C LC_CTYPE values break the ctype check.
96 os.environ['LANG'] = os.getenv('LANG', 'C')
97 os.environ['LC'] = os.getenv('LC_ALL', 'C')
98 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
99 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
102 def createDirectories():
103 ''' Create the build directories if necessary '''
104 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
105 'layouts', 'scripts', 'templates', 'ui' ]:
106 if not os.path.isdir( dir ):
109 logger.debug('Create directory %s.' % dir)
111 logger.error('Failed to create directory %s.' % dir)
116 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
117 windows_style_tex_paths = ''
119 return windows_style_tex_paths
120 if os.name == 'nt' or sys.platform == 'cygwin':
121 from tempfile import mkstemp
122 fd, tmpfname = mkstemp(suffix='.ltx')
124 from locale import getdefaultlocale
125 language, encoding = getdefaultlocale()
128 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
130 inpname = cmdOutput('cygpath -m ' + tmpfname)
131 logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
132 inpname = inpname.replace('~', '\\string~')
133 os.write(fd, r'\relax')
135 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
136 if 'Error' in latex_out:
137 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
138 if 'Error' in latex_out:
139 logger.warning("configure: TeX engine needs posix-style paths in latex files")
140 windows_style_tex_paths = 'false'
142 logger.info("configure: TeX engine needs windows-style paths in latex files")
143 windows_style_tex_paths = 'true'
144 removeFiles([tmpfname, logname, 'texput.log'])
145 return windows_style_tex_paths
148 ## Searching some useful programs
149 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
151 This function will search a program in $PATH plus given path
152 If found, return directory and program name (not the options).
154 description: description of the program
156 progs: check programs, for each prog, the first word is used
157 for searching but the whole string is used to replace
158 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
160 path: additional pathes
162 rc_entry: entry to outfile, can be
163 1. emtpy: no rc entry will be added
164 2. one pattern: %% will be replaced by the first found program,
165 or '' if no program is found.
166 3. several patterns for each prog and not_found. This is used
167 when different programs have different usages. If you do not
168 want not_found entry to be added to the RC file, you can specify
169 an entry for each prog and use '' for the not_found entry.
171 not_found: the value that should be used instead of '' if no program
175 # one rc entry for each progs plus not_found entry
176 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
177 logger.error("rc entry should have one item or item for each prog and not_found.")
179 logger.info('checking for ' + description + '...')
180 ## print '(' + ','.join(progs) + ')',
182 for idx in range(len(progs)):
183 # ac_prog may have options, ac_word is the command name
185 ac_word = ac_prog.split(' ')[0]
186 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
188 if ac_word.endswith('.pl') and perl == '':
190 msg = '+checking for "' + ac_word + '"... '
191 path = os.environ["PATH"].split(os.pathsep) + path
193 if "PATHEXT" in os.environ:
194 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
197 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
198 logger.info(msg + ' yes')
199 # deal with java and perl
200 if ac_word.endswith('.class'):
201 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
202 elif ac_word.endswith('.jar'):
203 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
204 elif ac_word.endswith('.pl'):
205 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
206 # write rc entries for this command
207 if len(rc_entry) == 1:
208 addToRC(rc_entry[0].replace('%%', ac_prog))
209 elif len(rc_entry) > 1:
210 addToRC(rc_entry[idx].replace('%%', ac_prog))
211 return [ac_dir, ac_word]
213 logger.info(msg + ' no')
214 # write rc entries for 'not found'
215 if len(rc_entry) > 0: # the last one.
216 addToRC(rc_entry[-1].replace('%%', not_found))
217 return ['', not_found]
220 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
222 The same as checkProg, but additionally, all found programs will be added
225 # one rc entry for each progs plus not_found entry
226 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
227 logger.error("rc entry should have one item or item for each prog and not_found.")
229 logger.info('checking for ' + description + '...')
230 ## print '(' + ','.join(progs) + ')',
233 real_ac_word = not_found
235 for idx in range(len(progs)):
236 # ac_prog may have options, ac_word is the command name
238 ac_word = ac_prog.split(' ')[0]
239 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
241 if ac_word.endswith('.pl') and perl == '':
243 msg = '+checking for "' + ac_word + '"... '
244 path = os.environ["PATH"].split(os.pathsep) + path
246 if "PATHEXT" in os.environ:
247 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
251 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
252 logger.info(msg + ' yes')
253 pr = re.compile(r'(\\\S+)(.*)$')
255 # deal with java and perl
256 if ac_word.endswith('.class'):
257 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
258 elif ac_word.endswith('.jar'):
259 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
260 elif ac_word.endswith('.pl'):
261 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
262 # write rc entries for this command
263 if found_prime == False:
264 if len(rc_entry) == 1:
265 addToRC(rc_entry[0].replace('%%', ac_prog))
266 elif len(rc_entry) > 1:
267 addToRC(rc_entry[idx].replace('%%', ac_prog))
269 real_ac_word = ac_word
271 if len(alt_rc_entry) == 1:
272 alt_rc = alt_rc_entry[0]
274 # if no explicit alt_rc is given, construct one
275 m = pr.match(rc_entry[0])
277 alt_rc = m.group(1) + "_alternatives" + m.group(2)
278 addToRC(alt_rc.replace('%%', ac_prog))
279 elif len(alt_rc_entry) > 1:
280 alt_rc = alt_rc_entry[idx]
282 # if no explicit alt_rc is given, construct one
283 m = pr.match(rc_entry[idx])
285 alt_rc = m.group(1) + "_alternatives" + m.group(2)
286 addToRC(alt_rc.replace('%%', ac_prog))
291 if found_alt == False:
293 logger.info(msg + ' no')
295 return [real_ac_dir, real_ac_word]
296 # write rc entries for 'not found'
297 if len(rc_entry) > 0: # the last one.
298 addToRC(rc_entry[-1].replace('%%', not_found))
299 return ['', not_found]
302 def addAlternatives(rcs, alt_type):
304 Returns a \\prog_alternatives string to be used as an alternative
305 rc entry. alt_type can be a string or a list of strings.
307 r = re.compile(r'\\Format (\S+).*$')
310 alt_token = '\\%s_alternatives '
311 if isinstance(alt_type, str):
312 alt_tokens = [alt_token % alt_type]
314 alt_tokens = map(lambda s: alt_token % s, alt_type)
315 for idxx in range(len(rcs)):
319 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
321 m = r.match(rcs[idxx])
325 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
329 def listAlternatives(progs, alt_type, rc_entry = []):
331 Returns a list of \\prog_alternatives strings to be used as alternative
332 rc entries. alt_type can be a string or a list of strings.
334 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
335 logger.error("rc entry should have one item or item for each prog and not_found.")
338 for idx in range(len(progs)):
339 if len(rc_entry) == 1:
340 rcs = rc_entry[0].split('\n')
341 alt = addAlternatives(rcs, alt_type)
342 alt_rc_entry.insert(0, alt)
343 elif len(rc_entry) > 1:
344 rcs = rc_entry[idx].split('\n')
345 alt = addAlternatives(rcs, alt_type)
346 alt_rc_entry.insert(idx, alt)
350 def checkViewer(description, progs, rc_entry = [], path = []):
351 ''' The same as checkProgAlternatives, but for viewers '''
352 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
353 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
356 def checkEditor(description, progs, rc_entry = [], path = []):
357 ''' The same as checkProgAlternatives, but for editors '''
358 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
359 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
362 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
363 ''' The same as checkViewer, but do not add rc entry '''
364 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
366 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
369 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
370 ''' The same as checkViewer, but do not add rc entry '''
371 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
373 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
376 def checkViewerEditor(description, progs, rc_entry = [], path = []):
377 ''' The same as checkProgAlternatives, but for viewers and editors '''
378 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
379 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
383 ''' Check whether DTL tools are available (Windows only) '''
384 # Find programs! Returned path is not used now
385 if ((os.name == 'nt' or sys.platform == 'cygwin') and
386 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
387 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
394 def checkLatex(dtl_tools):
395 ''' Check latex, return lyx_check_config '''
396 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
397 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
398 #-----------------------------------------------------------------
399 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
401 # check if PLATEX is pLaTeX2e
402 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
403 # run platex on chklatex.ltx and check result
404 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
405 # We have the Japanese pLaTeX2e
406 addToRC(r'\converter platex dvi "%s -kanji=$$E $$i" "latex=platex"' % PLATEX)
409 removeFiles(['chklatex.ltx', 'chklatex.log'])
410 #-----------------------------------------------------------------
411 # use LATEX to convert from latex to dvi if PPLATEX is not available
415 # Windows only: DraftDVI
416 addToRC(r'''\converter latex dvi2 "%s" "latex"
417 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
419 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
422 # Check if latex is usable
423 writeToFile('chklatex.ltx', r'''
425 \ifx\undefined\documentclass\else
426 \message{ThisIsLaTeX2e}
431 # run latex on chklatex.ltx and check result
432 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
436 logger.warning("Latex not usable (not LaTeX2e) ")
437 # remove temporary files
438 removeFiles(['chklatex.ltx', 'chklatex.log'])
443 ''' Check if luatex is there and usable '''
444 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
445 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
447 # luatex binary is there
448 msg = "checking if LuaTeX is usable ..."
449 # Check if luatex is usable
450 writeToFile('luatest.tex', r'''
452 \documentclass{minimal}
453 \usepackage{fontspec}
458 # run lualatex on luatest.tex and check result
459 luatest = cmdOutput(LUATEX + ' luatest.tex')
460 if luatest.find('XeTeX is required to compile this document') != -1:
461 # fontspec/luatex too old! We do not support this version.
462 logger.info(msg + ' no (probably not recent enough)')
463 elif luatest.find('! LaTeX Error: File `fontspec.sty\' not found') != -1:
465 logger.info(msg + ' no (missing fontspec)')
468 logger.info(msg + ' yes')
469 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
471 addToRC(r'\converter luatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
472 # remove temporary files
473 removeFiles(['luatest.tex', 'luatest.log', 'luatest.aux', 'luatest.pdf'])
476 def checkModule(module):
477 ''' Check for a Python module, return the status '''
478 msg = 'checking for "' + module + ' module"... '
481 logger.info(msg + ' yes')
484 logger.info(msg + ' no')
488 def checkFormatEntries(dtl_tools):
489 ''' Check all formats (\Format entries) '''
490 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
491 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
493 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
494 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
496 checkViewerEditor('a Dia viewer and editor', ['dia'],
497 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
499 checkViewerEditor('an OpenOffice drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
500 rc_entry = [r'\Format odg "odg, sxd" "OpenOffice drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
502 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
503 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
505 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
506 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
508 checkViewerEditor('a SVG viewer and editor', ['inkscape'],
509 rc_entry = [r'\Format svg svg SVG "" "%%" "%%" "vector" "image/svg+xml"'])
511 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
512 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
513 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
514 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
515 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
516 \Format png png PNG "" "%s" "%s" "" "image/x-png"
517 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
518 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
519 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
520 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
521 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
522 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
523 addToRC(imageformats % \
524 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
526 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
527 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
528 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
529 \Format asciiimage asc "Plain text (image)" "" "" "%%" "" ""
530 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" "" ""
531 \Format dateout tmp "date (output)" "" "" "%%" "" ""
532 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
533 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
534 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
535 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
536 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
537 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
538 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
539 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
540 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
541 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
542 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
543 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
544 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
545 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
546 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
547 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
548 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
549 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
550 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
551 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
552 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
553 #Spreadsheets using ssconvert from gnumeric
554 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
555 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
556 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
557 \Format oocalc ods "OpenOffice spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
559 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
560 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
562 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
563 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
564 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
565 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
566 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
567 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
568 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
570 #checkProg('a Postscript interpreter', ['gs'],
571 # rc_entry = [ r'\ps_command "%%"' ])
572 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
573 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
574 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
575 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
576 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
577 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
579 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" "application/pdf"
580 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
581 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
582 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
583 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""'''])
585 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
586 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
587 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
589 # Windows only: DraftDVI
590 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
592 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
593 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
595 checkViewerEditor('Noteedit', ['noteedit'],
596 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
598 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
599 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
600 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
602 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
603 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
604 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"'''])
606 # entries that do not need checkProg
607 addToRC(r'''\Format date "" "date command" "" "" "" "" ""
608 \Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
609 \Format fax "" Fax "" "" "" "document" ""
610 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
611 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
612 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
613 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
614 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document,menu=export" ""
615 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document,menu=export" ""
616 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
617 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
618 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
619 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
620 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
621 \Format program "" Program "" "" "" "" ""
622 \Format pstex pstex_t PSTEX "" "" "" "" ""
623 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
624 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
625 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
629 def checkConverterEntries():
630 ''' Check all converters (\converter entries) '''
631 checkProg('the pdflatex program', ['pdflatex $$i'],
632 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
634 checkProg('XeTeX', ['xelatex $$i'],
635 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
639 # Look for tex2lyx in this order (see bugs #3308 and #6986):
640 # 1) If we're running LyX in-place then tex2lyx will be found
641 # in ../src/tex2lyx with respect to the srcdir.
642 # 2) If LyX was configured with a version suffix then tex2lyx
643 # will also have this version suffix.
644 # 3) Otherwise always use tex2lyx.
645 in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
646 in_place = os.path.abspath(in_place)
648 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_place, 'tex2lyx' + version_suffix, 'tex2lyx'],
649 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
650 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""'''], not_found = 'tex2lyx')
652 logger.warning("Failed to find tex2lyx on your system.")
655 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
656 rc_entry = [r'''\converter literate latex "%%" ""
657 \converter literate pdflatex "%%" ""'''])
659 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
660 rc_entry = [r'''\converter sweave latex "%%" ""
661 \converter sweave pdflatex "%%" ""
662 \converter sweave xetex "%%" ""
663 \converter sweave luatex "%%" ""'''])
665 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
666 rc_entry = [r'''\converter knitr latex "%%" ""
667 \converter knitr pdflatex "%%" ""
668 \converter knitr xetex "%%" ""
669 \converter knitr luatex "%%" ""'''])
671 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
672 rc_entry = [ r'\converter sweave r "%%" ""' ])
674 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
675 rc_entry = [ r'\converter knitr r "%%" ""' ])
677 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i',
678 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
679 rc_entry = [ r'\converter html latex "%%" ""' ])
681 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
682 rc_entry = [ r'\converter word latex "%%" ""' ])
684 # eLyXer: search as an executable (elyxer.py, elyxer)
685 path, elyxer = checkProg('a LyX -> HTML converter',
686 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
687 rc_entry = [ r'\converter lyx html "%%" ""' ])
688 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
689 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
690 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
691 if elyxer.find('elyxer') >= 0:
692 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
693 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
695 # search for HTML converters other than eLyXer
696 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
697 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
698 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
699 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
700 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
701 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
702 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
704 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
705 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
706 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
707 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
708 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
709 if htmlconv.find('htlatex') >= 0:
710 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
712 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
715 # Check if LyXBlogger is installed
716 lyxblogger_found = checkModule('lyxblogger')
718 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
719 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
722 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
723 rc_entry = [ r'\converter sxw latex "%%" ""' ])
725 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
726 rc_entry = [ r'\converter odt latex "%%" ""' ])
728 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
729 rc_entry = [ r'\converter odt pdf "%%" ""' ])
730 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
731 # the command mk4ht oolatex $$i has to be used as default,
732 # but as this would require to have Perl installed, in MiKTeX oolatex is
733 # directly available as application.
734 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
735 # Both SuSE and debian have oolatex
736 checkProg('a LaTeX -> Open Document converter', [
737 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
738 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
739 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
740 # On windows it is called latex2rt.exe
741 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
742 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
744 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
745 rc_entry = [ r'\converter rtf html "%%" ""' ])
747 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
748 rc_entry = [ r'\converter ps pdf "%%" ""' ])
750 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
751 rc_entry = [ r'\converter ps text2 "%%" ""' ])
753 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
754 rc_entry = [ r'\converter ps text3 "%%" ""' ])
755 # Need to call ps2eps in a pipe, otherwise it would name the output file
756 # depending on the extension of the input file. We do not know the input
757 # file extension in general, so the resultfile= flag would not help.
758 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
759 # This would create additional paths in the converter graph with unwanted
760 # side effects (e.g. ps->pdf via ps2pdf would create a different result
761 # than ps->eps->pdf via ps2eps and epstopdf).
762 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
763 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
765 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
766 rc_entry = [ r'\converter pdf ps "%%" ""' ])
768 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
769 rc_entry = [ r'\converter pdf eps "%%" ""' ])
771 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
772 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
774 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
775 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
777 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
778 rc_entry = [ r'\converter dvi ps "%%" ""' ])
780 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
781 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
783 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
784 rc_entry = [ r'\converter ps fax "%%" ""'])
786 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
787 if fig2dev == "fig2dev":
788 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
789 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
790 \converter fig png "fig2dev -L png $$i $$o" ""
791 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
792 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
794 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
795 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
797 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
799 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
800 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
801 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
804 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
805 rc_entry = [ r'\converter wmf eps "%%" ""'])
807 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
808 rc_entry = [ r'\converter emf eps "%%" ""'])
810 checkProg('an EPS -> PDF converter', ['epstopdf'],
811 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
813 checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
814 rc_entry = [ r'\converter eps png "%%" ""', ''])
816 # no agr -> pdf converter, since the pdf library used by gracebat is not
817 # free software and therefore not compiled in in many installations.
818 # Fortunately, this is not a big problem, because we will use epstopdf to
819 # convert from agr to pdf via eps without loss of quality.
820 checkProg('a Grace -> Image converter', ['gracebat'],
822 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
823 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
824 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
825 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
828 checkProg('a Dot -> Image converter', ['dot'],
830 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
831 \converter dot png "dot -Tpng $$i -o $$o" ""''',
834 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
835 rc_entry = [ r'\converter dia png "%%" ""'])
837 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
838 rc_entry = [ r'\converter dia eps "%%" ""'])
839 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
840 # The eps2->eps converter then fixes the bounding box by cropping.
841 # Although unoconv can convert to png and pdf as well, do not define
842 # odg->png and odg->pdf converters, since the bb would be too large as well.
843 checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
844 rc_entry = [ r'\converter odg eps2 "%%" ""'])
846 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
847 rc_entry = [ r'\converter svg pdf "%%" ""'])
849 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
850 rc_entry = [ r'\converter svg eps "%%" ""'])
852 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
853 rc_entry = [ r'\converter svg png "%%" ""'])
856 # gnumeric/xls/ods to tex
857 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
858 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
859 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
860 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
863 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
865 version_string = cmdOutput("lilypond --version")
866 match = re.match('GNU LilyPond (\S+)', version_string)
868 version_number = match.groups()[0]
869 version = version_number.split('.')
870 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
871 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
872 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
873 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
874 logger.info('+ found LilyPond version %s.' % version_number)
875 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
876 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
877 \converter lilypond png "lilypond -b eps --png $$i" ""''')
878 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
879 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf --safe $$i" ""')
880 logger.info('+ found LilyPond version %s.' % version_number)
882 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
884 logger.info('+ found LilyPond, but could not extract version number.')
886 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
887 if (lilypond_book != ''):
888 version_string = cmdOutput("lilypond-book --version")
889 match = re.match('^(\S+)$', version_string)
891 version_number = match.groups()[0]
892 version = version_number.split('.')
893 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
894 # Note: The --lily-output-dir flag is required because lilypond-book
895 # does not process input again unless the input has changed,
896 # even if the output format being requested is different. So
897 # once a .eps file exists, lilypond-book won't create a .pdf
898 # even when requested with --pdf. This is a problem if a user
899 # clicks View PDF after having done a View DVI. To circumvent
900 # this, use different output folders for eps and pdf outputs.
901 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
902 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
903 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
904 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
905 logger.info('+ found LilyPond-book version %s.' % version_number)
907 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
909 logger.info('+ found LilyPond-book, but could not extract version number.')
911 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
912 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
914 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
915 # and a zip archive on Windows.
916 # So, we configure the appropriate version according to the platform.
917 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
919 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
920 addToRC(cmd % "lyxzip")
922 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
923 addToRC(cmd % "lyxgz")
926 # FIXME: no rc_entry? comment it out
927 # checkProg('Image converter', ['convert $$i $$o'])
929 # Entries that do not need checkProg
931 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
932 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
933 \converter docbook docbook-xml "cp $$i $$o" "xml"
934 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
935 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
936 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
937 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
938 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
939 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
940 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
941 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
942 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
943 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
944 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
945 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
946 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
947 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
952 ''' Check docbook '''
953 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
955 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
956 \converter docbook html "sgmltools -b html $$i" ""''',
957 r'''\converter docbook dvi "db2dvi $$i" ""
958 \converter docbook html "db2html $$i" ""''',
959 r'''\converter docbook dvi "" ""
960 \converter docbook html "" ""''',
961 r'''\converter docbook dvi "" ""
962 \converter docbook html "" ""'''])
965 return ('yes', 'true', '\\def\\hasdocbook{yes}')
967 return ('no', 'false', '')
970 def checkOtherEntries():
971 ''' entries other than Format and Converter '''
972 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
973 rc_entry = [ r'\chktex_command "%%"' ])
974 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
975 rc_entry = [ r'\bibtex_command "%%"' ],
976 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
977 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
978 rc_entry = [ r'\jbibtex_command "%%"' ])
979 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
980 rc_entry = [ r'\index_command "%%"' ],
981 alt_rc_entry = [ r'\index_alternatives "%%"' ])
982 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
983 rc_entry = [ r'\jindex_command "%%"' ])
984 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
985 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
986 checkProg('a nomenclature processor', ['makeindex'],
987 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
988 ## FIXME: OCTAVE is not used anywhere
989 # path, OCTAVE = checkProg('Octave', ['octave'])
990 ## FIXME: MAPLE is not used anywhere
991 # path, MAPLE = checkProg('Maple', ['maple'])
992 checkProg('a spool command', ['lp', 'lpr'],
994 r'''\print_spool_printerprefix "-d "
995 \print_spool_command "lp"''',
996 r'''\print_spool_printerprefix "-P",
997 \print_spool_command "lpr"''',
999 # Add the rest of the entries (no checkProg is required)
1000 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1001 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1002 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1003 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1007 def processLayoutFile(file, bool_docbook):
1008 ''' process layout file and get a line of result
1010 Declare lines look like this:
1012 \DeclareLaTeXClass[<requirements>]{<description>}
1014 Optionally, a \DeclareCategory line follows:
1016 \DeclareCategory{<category>}
1018 So for example (article.layout, scrbook.layout, svjog.layout)
1020 \DeclareLaTeXClass{article}
1021 \DeclareCategory{Articles}
1023 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1024 \DeclareCategory{Books}
1026 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1028 we'd expect this output:
1030 "article" "article" "article" "false" "article.cls" "Articles"
1031 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1032 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1034 def checkForClassExtension(x):
1035 '''if the extension for a latex class is not
1036 provided, add .cls to the classname'''
1038 return x.strip() + '.cls'
1041 classname = file.split(os.sep)[-1].split('.')[0]
1042 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1043 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1044 q = re.compile(r'\DeclareCategory{(.*)}')
1045 classdeclaration = ""
1046 categorydeclaration = '""'
1047 for line in open(file).readlines():
1048 res = p.search(line)
1049 qres = q.search(line)
1051 (classtype, optAll, opt, opt1, desc) = res.groups()
1052 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1055 prereq_latex = checkForClassExtension(classname)
1057 prereq_list = optAll[1:-1].split(',')
1058 prereq_list = map(checkForClassExtension, prereq_list)
1059 prereq_latex = ','.join(prereq_list)
1060 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1061 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1062 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1063 if categorydeclaration != '""':
1064 return classdeclaration + " " + categorydeclaration
1066 categorydeclaration = '"%s"' % (qres.groups()[0])
1067 if classdeclaration != "":
1068 return classdeclaration + " " + categorydeclaration
1069 if classdeclaration != "":
1070 return classdeclaration + " " + categorydeclaration
1071 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1075 def checkLatexConfig(check_config, bool_docbook):
1076 ''' Explore the LaTeX configuration
1077 Return None (will be passed to sys.exit()) for success.
1079 msg = 'checking LaTeX configuration... '
1080 # if --without-latex-config is forced, or if there is no previous
1081 # version of textclass.lst, re-generate a default file.
1082 if not os.path.isfile('textclass.lst') or not check_config:
1083 # remove the files only if we want to regenerate
1084 removeFiles(['textclass.lst', 'packages.lst'])
1086 # Then, generate a default textclass.lst. In case configure.py
1087 # fails, we still have something to start lyx.
1088 logger.info(msg + ' default values')
1089 logger.info('+checking list of textclasses... ')
1090 tx = open('textclass.lst', 'w')
1092 # This file declares layouts and their associated definition files
1093 # (include dir. relative to the place where this file is).
1094 # It contains only default values, since chkconfig.ltx could not be run
1095 # for some reason. Run ./configure.py if you need to update it after a
1096 # configuration change.
1098 # build the list of available layout files and convert it to commands
1101 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1102 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1104 if not os.path.isfile(file):
1106 # get stuff between /xxxx.layout .
1107 classname = file.split(os.sep)[-1].split('.')[0]
1109 cleanclass = classname.replace(' ', '_')
1110 cleanclass = cleanclass.replace('-', '_')
1111 # make sure the same class is not considered twice
1112 if foundClasses.count(cleanclass) == 0: # not found before
1113 foundClasses.append(cleanclass)
1114 retval = processLayoutFile(file, bool_docbook)
1118 logger.info('\tdone')
1119 if not os.path.isfile('packages.lst') or not check_config:
1120 logger.info('+generating default list of packages... ')
1121 removeFiles(['packages.lst'])
1122 tx = open('packages.lst', 'w')
1124 logger.info('\tdone')
1125 if not check_config:
1127 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1128 logger.info(msg + '\tauto')
1129 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1130 'wrap_chkconfig.ltx'])
1132 if not os.path.isfile( 'chkconfig.ltx' ):
1133 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1135 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1136 # Construct the list of classes to test for.
1137 # build the list of available layout files and convert it to commands
1139 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1140 category = re.compile(r'\DeclareCategory{(.*)}')
1141 empty = re.compile(r'^\s*$')
1142 testclasses = list()
1143 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1144 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1145 nodeclaration = False
1146 if not os.path.isfile(file):
1148 classname = file.split(os.sep)[-1].split('.')[0]
1151 for line in open(file).readlines():
1152 if not empty.match(line) and line[0] != '#':
1154 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1155 nodeclaration = True
1156 # A class, but no category declaration. Just break.
1158 if declare.search(line) != None:
1159 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1160 testclasses.append(decline)
1161 elif category.search(line) != None:
1162 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1163 testclasses.append(catline)
1164 if catline == "" or decline == "":
1170 cl = open('chklayouts.tex', 'w')
1171 for line in testclasses:
1172 cl.write(line + '\n')
1175 # we have chklayouts.tex, then process it
1177 latex_out = os.popen(LATEX + ' wrap_chkconfig.ltx')
1179 line = latex_out.readline()
1182 if re.match('^\+', line):
1183 logger.info(line.strip())
1184 # return None if the command succeeds
1185 if line == "+Inspection done.":
1188 # remove the copied file
1190 removeFiles( [ 'chkconfig.ltx' ] )
1192 # currently, values in chkconfig are only used to set
1195 for line in open('chkconfig.vars').readlines():
1196 key, val = re.sub('-', '_', line).split('=')
1198 values[key] = val.strip("'")
1199 # chk_fontenc may not exist
1201 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1204 # if configure successed, move textclass.lst.tmp to textclass.lst
1205 # and packages.lst.tmp to packages.lst
1206 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1207 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1208 shutil.move('textclass.lst.tmp', 'textclass.lst')
1209 shutil.move('packages.lst.tmp', 'packages.lst')
1213 def checkModulesConfig():
1214 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1216 logger.info('+checking list of modules... ')
1217 tx = open('lyxmodules.lst', 'w')
1218 tx.write('''## This file declares modules and their associated definition files.
1219 ## It has been automatically generated by configure
1220 ## Use "Options/Reconfigure" if you need to update it after a
1221 ## configuration change.
1222 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1225 # build the list of available modules
1227 # note that this searches the local directory first, then the
1228 # system directory. that way, we pick up the user's version first.
1229 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1230 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1233 if not os.path.isfile(file):
1236 filename = file.split(os.sep)[-1]
1237 filename = filename[:-7]
1238 if seen.count(filename):
1241 seen.append(filename)
1242 retval = processModuleFile(file, filename, bool_docbook)
1246 logger.info('\tdone')
1249 def processModuleFile(file, filename, bool_docbook):
1250 ''' process module file and get a line of result
1252 The top of a module file should look like this:
1253 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1255 #...body of description...
1257 #Requires: [list of required modules]
1258 #Excludes: [list of excluded modules]
1259 #Category: [category name]
1260 The last three lines are optional (though do give a category).
1262 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1264 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1265 rereqs = re.compile(r'#+\s*Requires: (.*)')
1266 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1267 recaty = re.compile(r'#+\s*Category: (.*)')
1268 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1269 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1271 modname = desc = pkgs = req = excl = catgy = ""
1272 readingDescription = False
1275 for line in open(file).readlines():
1276 if readingDescription:
1277 res = redend.search(line)
1279 readingDescription = False
1280 desc = " ".join(descLines)
1282 desc = desc.replace('"', '\\"')
1284 descLines.append(line[1:].strip())
1286 res = redbeg.search(line)
1288 readingDescription = True
1290 res = remods.search(line)
1292 (pkgs, modname) = res.groups()
1296 tmp = [s.strip() for s in pkgs.split(",")]
1297 pkgs = ",".join(tmp)
1299 res = rereqs.search(line)
1302 tmp = [s.strip() for s in req.split("|")]
1305 res = reexcs.search(line)
1308 tmp = [s.strip() for s in excl.split("|")]
1309 excl = "|".join(tmp)
1311 res = recaty.search(line)
1313 catgy = res.group(1)
1317 logger.warning("Module file without \DeclareLyXModule line. ")
1321 # this module has some latex dependencies:
1322 # append the dependencies to chkmodules.tex,
1323 # which is \input'ed by chkconfig.ltx
1324 testpackages = list()
1325 for pkg in pkgs.split(","):
1327 # this is a converter dependency: skip
1329 if pkg.endswith(".sty"):
1331 testpackages.append("\\TestPackage{%s}" % (pkg,))
1332 cm = open('chkmodules.tex', 'a')
1333 for line in testpackages:
1334 cm.write(line + '\n')
1337 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1340 def checkTeXAllowSpaces():
1341 ''' Let's check whether spaces are allowed in TeX file names '''
1342 tex_allows_spaces = 'false'
1343 if lyx_check_config:
1344 msg = "Checking whether TeX allows spaces in file names... "
1345 writeToFile('a b.tex', r'\message{working^^J}' )
1347 if os.name == 'nt' or sys.platform == 'cygwin':
1348 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1350 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1353 if 'working' in latex_out:
1354 logger.info(msg + 'yes')
1355 tex_allows_spaces = 'true'
1357 logger.info(msg + 'no')
1358 tex_allows_spaces = 'false'
1359 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1360 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1363 def rescanTeXFiles():
1364 ''' Run kpsewhich to update information about TeX files '''
1365 logger.info("+Indexing TeX files... ")
1366 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1367 logger.error("configure: error: cannot find TeXFiles.py script")
1369 tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1371 logger.info("\tdone")
1374 def removeTempFiles():
1376 if not lyx_keep_temps:
1377 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1378 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1379 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1382 if __name__ == '__main__':
1383 lyx_check_config = True
1384 lyx_kpsewhich = True
1385 outfile = 'lyxrc.defaults'
1386 lyxrc_fileformat = 7
1388 lyx_keep_temps = False
1390 ## Parse the command line
1391 for op in sys.argv[1:]: # default shell/for list is $*, the options
1392 if op in [ '-help', '--help', '-h' ]:
1393 print '''Usage: configure [options]
1395 --help show this help lines
1396 --keep-temps keep temporary files (for debug. purposes)
1397 --without-kpsewhich do not update TeX files information via kpsewhich
1398 --without-latex-config do not run LaTeX to determine configuration
1399 --with-version-suffix=suffix suffix of binary installed files
1402 elif op == '--without-kpsewhich':
1403 lyx_kpsewhich = False
1404 elif op == '--without-latex-config':
1405 lyx_check_config = False
1406 elif op == '--keep-temps':
1407 lyx_keep_temps = True
1408 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1409 version_suffix = op[22:]
1411 print "Unknown option", op
1414 # check if we run from the right directory
1415 srcdir = os.path.dirname(sys.argv[0])
1418 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1419 logger.error("configure: error: cannot find chkconfig.ltx script")
1423 dtl_tools = checkDTLtools()
1424 ## Write the first part of outfile
1425 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1426 # script. It contains default settings that have been determined by
1427 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1428 # want to customize LyX, use LyX' Preferences dialog or modify directly
1429 # the "preferences" file instead. Any setting in that file will
1430 # override the values given here.
1434 ''' % lyxrc_fileformat)
1436 LATEX = checkLatex(dtl_tools)
1437 # check java and perl before any checkProg that may require them
1438 java = checkProg('a java interpreter', ['java'])[1]
1439 perl = checkProg('a perl interpreter', ['perl'])[1]
1440 checkFormatEntries(dtl_tools)
1441 checkConverterEntries()
1442 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1443 checkTeXAllowSpaces()
1444 windows_style_tex_paths = checkTeXPaths()
1445 if windows_style_tex_paths != '':
1446 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1450 checkModulesConfig()
1451 # --without-latex-config can disable lyx_check_config
1452 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1454 # The return error code can be 256. Because most systems expect an error code
1455 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1456 # a None for success, 'ret is not None' is used to exit.
1457 sys.exit(ret is not None)