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)
59 def cmdOutput(cmd, async = False):
60 '''utility function: run a command and get its output as a string
62 async: if False, return whole output as a string, otherwise
63 return the stdout handle from which the output can be
64 read (the caller is then responsible for closing it)
68 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
71 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
72 stdout=subprocess.PIPE, universal_newlines=True)
76 output = pipe.stdout.read()
82 ''' On Windows, return the short version of "path" if possible '''
84 from ctypes import windll, create_unicode_buffer
85 GetShortPathName = windll.kernel32.GetShortPathNameW
86 shortlen = GetShortPathName(path, 0, 0)
87 shortpath = create_unicode_buffer(shortlen)
88 if GetShortPathName(path, shortpath, shortlen):
89 return shortpath.value
94 ''' I do not really know why this is useful, but we might as well keep it.
96 Only set these to C if already set. These must not be set unconditionally
97 because not all systems understand e.g. LANG=C (notably SCO).
98 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
99 Non-C LC_CTYPE values break the ctype check.
101 os.environ['LANG'] = os.getenv('LANG', 'C')
102 os.environ['LC'] = os.getenv('LC_ALL', 'C')
103 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
104 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
107 def createDirectories():
108 ''' Create the build directories if necessary '''
109 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
110 'layouts', 'scripts', 'templates', 'ui' ]:
111 if not os.path.isdir( dir ):
114 logger.debug('Create directory %s.' % dir)
116 logger.error('Failed to create directory %s.' % dir)
121 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
122 windows_style_tex_paths = ''
124 return windows_style_tex_paths
125 if os.name == 'nt' or sys.platform == 'cygwin':
126 from tempfile import mkstemp
127 fd, tmpfname = mkstemp(suffix='.ltx')
129 from locale import getdefaultlocale
130 language, encoding = getdefaultlocale()
133 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
135 inpname = cmdOutput('cygpath -m ' + tmpfname)
136 logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
137 inpname = inpname.replace('~', '\\string~')
138 os.write(fd, r'\relax')
140 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
141 if 'Error' in latex_out:
142 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
143 if 'Error' in latex_out:
144 logger.warning("configure: TeX engine needs posix-style paths in latex files")
145 windows_style_tex_paths = 'false'
147 logger.info("configure: TeX engine needs windows-style paths in latex files")
148 windows_style_tex_paths = 'true'
149 removeFiles([tmpfname, logname, 'texput.log'])
150 return windows_style_tex_paths
153 ## Searching some useful programs
154 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
156 This function will search a program in $PATH plus given path
157 If found, return directory and program name (not the options).
159 description: description of the program
161 progs: check programs, for each prog, the first word is used
162 for searching but the whole string is used to replace
163 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
165 path: additional pathes
167 rc_entry: entry to outfile, can be
168 1. emtpy: no rc entry will be added
169 2. one pattern: %% will be replaced by the first found program,
170 or '' if no program is found.
171 3. several patterns for each prog and not_found. This is used
172 when different programs have different usages. If you do not
173 want not_found entry to be added to the RC file, you can specify
174 an entry for each prog and use '' for the not_found entry.
176 not_found: the value that should be used instead of '' if no program
180 # one rc entry for each progs plus not_found entry
181 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
182 logger.error("rc entry should have one item or item for each prog and not_found.")
184 logger.info('checking for ' + description + '...')
185 ## print '(' + ','.join(progs) + ')',
187 for idx in range(len(progs)):
188 # ac_prog may have options, ac_word is the command name
190 ac_word = ac_prog.split(' ')[0]
191 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
193 if ac_word.endswith('.pl') and perl == '':
195 msg = '+checking for "' + ac_word + '"... '
196 path = os.environ["PATH"].split(os.pathsep) + path
198 if "PATHEXT" in os.environ:
199 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
202 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
203 logger.info(msg + ' yes')
204 # deal with java and perl
205 if ac_word.endswith('.class'):
206 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
207 elif ac_word.endswith('.jar'):
208 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
209 elif ac_word.endswith('.pl'):
210 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
211 # write rc entries for this command
212 if len(rc_entry) == 1:
213 addToRC(rc_entry[0].replace('%%', ac_prog))
214 elif len(rc_entry) > 1:
215 addToRC(rc_entry[idx].replace('%%', ac_prog))
216 return [ac_dir, ac_word]
218 logger.info(msg + ' no')
219 # write rc entries for 'not found'
220 if len(rc_entry) > 0: # the last one.
221 addToRC(rc_entry[-1].replace('%%', not_found))
222 return ['', not_found]
225 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
227 The same as checkProg, but additionally, all found programs will be added
230 # one rc entry for each progs plus not_found entry
231 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
232 logger.error("rc entry should have one item or item for each prog and not_found.")
234 logger.info('checking for ' + description + '...')
235 ## print '(' + ','.join(progs) + ')',
238 real_ac_word = not_found
240 for idx in range(len(progs)):
241 # ac_prog may have options, ac_word is the command name
243 ac_word = ac_prog.split(' ')[0]
244 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
246 if ac_word.endswith('.pl') and perl == '':
248 msg = '+checking for "' + ac_word + '"... '
249 path = os.environ["PATH"].split(os.pathsep) + path
251 if "PATHEXT" in os.environ:
252 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
256 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
257 logger.info(msg + ' yes')
258 pr = re.compile(r'(\\\S+)(.*)$')
260 # deal with java and perl
261 if ac_word.endswith('.class'):
262 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
263 elif ac_word.endswith('.jar'):
264 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
265 elif ac_word.endswith('.pl'):
266 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
267 # write rc entries for this command
268 if found_prime == False:
269 if len(rc_entry) == 1:
270 addToRC(rc_entry[0].replace('%%', ac_prog))
271 elif len(rc_entry) > 1:
272 addToRC(rc_entry[idx].replace('%%', ac_prog))
274 real_ac_word = ac_word
276 if len(alt_rc_entry) == 1:
277 alt_rc = alt_rc_entry[0]
279 # if no explicit alt_rc is given, construct one
280 m = pr.match(rc_entry[0])
282 alt_rc = m.group(1) + "_alternatives" + m.group(2)
283 addToRC(alt_rc.replace('%%', ac_prog))
284 elif len(alt_rc_entry) > 1:
285 alt_rc = alt_rc_entry[idx]
287 # if no explicit alt_rc is given, construct one
288 m = pr.match(rc_entry[idx])
290 alt_rc = m.group(1) + "_alternatives" + m.group(2)
291 addToRC(alt_rc.replace('%%', ac_prog))
296 if found_alt == False:
298 logger.info(msg + ' no')
300 return [real_ac_dir, real_ac_word]
301 # write rc entries for 'not found'
302 if len(rc_entry) > 0: # the last one.
303 addToRC(rc_entry[-1].replace('%%', not_found))
304 return ['', not_found]
307 def addAlternatives(rcs, alt_type):
309 Returns a \\prog_alternatives string to be used as an alternative
310 rc entry. alt_type can be a string or a list of strings.
312 r = re.compile(r'\\Format (\S+).*$')
315 alt_token = '\\%s_alternatives '
316 if isinstance(alt_type, str):
317 alt_tokens = [alt_token % alt_type]
319 alt_tokens = map(lambda s: alt_token % s, alt_type)
320 for idxx in range(len(rcs)):
324 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
326 m = r.match(rcs[idxx])
330 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
334 def listAlternatives(progs, alt_type, rc_entry = []):
336 Returns a list of \\prog_alternatives strings to be used as alternative
337 rc entries. alt_type can be a string or a list of strings.
339 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
340 logger.error("rc entry should have one item or item for each prog and not_found.")
343 for idx in range(len(progs)):
344 if len(rc_entry) == 1:
345 rcs = rc_entry[0].split('\n')
346 alt = addAlternatives(rcs, alt_type)
347 alt_rc_entry.insert(0, alt)
348 elif len(rc_entry) > 1:
349 rcs = rc_entry[idx].split('\n')
350 alt = addAlternatives(rcs, alt_type)
351 alt_rc_entry.insert(idx, alt)
355 def checkViewer(description, progs, rc_entry = [], path = []):
356 ''' The same as checkProgAlternatives, but for viewers '''
357 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
358 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
361 def checkEditor(description, progs, rc_entry = [], path = []):
362 ''' The same as checkProgAlternatives, but for editors '''
363 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
364 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
367 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
368 ''' The same as checkViewer, but do not add rc entry '''
369 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
371 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
374 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
375 ''' The same as checkViewer, but do not add rc entry '''
376 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
378 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
381 def checkViewerEditor(description, progs, rc_entry = [], path = []):
382 ''' The same as checkProgAlternatives, but for viewers and editors '''
383 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
384 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
388 ''' Check whether DTL tools are available (Windows only) '''
389 # Find programs! Returned path is not used now
390 if ((os.name == 'nt' or sys.platform == 'cygwin') and
391 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
392 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
399 def checkLatex(dtl_tools):
400 ''' Check latex, return lyx_check_config '''
401 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
402 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
403 #-----------------------------------------------------------------
404 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
406 # check if PLATEX is pLaTeX2e
407 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
408 # run platex on chklatex.ltx and check result
409 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
410 # We have the Japanese pLaTeX2e
411 addToRC(r'\converter platex dvi "%s -kanji=$$E $$i" "latex=platex"' % PLATEX)
414 removeFiles(['chklatex.ltx', 'chklatex.log'])
415 #-----------------------------------------------------------------
416 # use LATEX to convert from latex to dvi if PPLATEX is not available
420 # Windows only: DraftDVI
421 addToRC(r'''\converter latex dvi2 "%s" "latex"
422 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
424 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
427 # Check if latex is usable
428 writeToFile('chklatex.ltx', r'''
430 \ifx\undefined\documentclass\else
431 \message{ThisIsLaTeX2e}
436 # run latex on chklatex.ltx and check result
437 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
441 logger.warning("Latex not usable (not LaTeX2e) ")
442 # remove temporary files
443 removeFiles(['chklatex.ltx', 'chklatex.log'])
448 ''' Check if luatex is there and usable '''
449 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
450 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
452 # luatex binary is there
453 msg = "checking if LuaTeX is usable ..."
454 # Check if luatex is usable
455 writeToFile('luatest.tex', r'''
457 \documentclass{minimal}
458 \usepackage{fontspec}
463 # run lualatex on luatest.tex and check result
464 luatest = cmdOutput(LUATEX + ' luatest.tex')
465 if luatest.find('XeTeX is required to compile this document') != -1:
466 # fontspec/luatex too old! We do not support this version.
467 logger.info(msg + ' no (probably not recent enough)')
468 elif luatest.find('! LaTeX Error: File `fontspec.sty\' not found') != -1:
470 logger.info(msg + ' no (missing fontspec)')
473 logger.info(msg + ' yes')
474 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
476 addToRC(r'\converter luatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
477 # remove temporary files
478 removeFiles(['luatest.tex', 'luatest.log', 'luatest.aux', 'luatest.pdf'])
481 def checkModule(module):
482 ''' Check for a Python module, return the status '''
483 msg = 'checking for "' + module + ' module"... '
486 logger.info(msg + ' yes')
489 logger.info(msg + ' no')
493 def checkFormatEntries(dtl_tools):
494 ''' Check all formats (\Format entries) '''
495 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
496 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
498 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
499 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
501 checkViewerEditor('a Dia viewer and editor', ['dia'],
502 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
504 checkViewerEditor('an OpenOffice drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
505 rc_entry = [r'\Format odg "odg, sxd" "OpenOffice drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
507 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
508 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
510 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
511 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
513 checkViewerEditor('a SVG viewer and editor', ['inkscape'],
514 rc_entry = [r'\Format svg svg SVG "" "%%" "%%" "vector" "image/svg+xml"'])
516 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
517 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
518 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
519 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
520 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
521 \Format png png PNG "" "%s" "%s" "" "image/x-png"
522 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
523 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
524 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
525 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
526 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
527 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
528 addToRC(imageformats % \
529 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
531 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
532 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
533 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
534 \Format asciiimage asc "Plain text (image)" "" "" "%%" "" ""
535 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" "" ""
536 \Format dateout tmp "date (output)" "" "" "%%" "" ""
537 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
538 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
539 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
540 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
541 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
542 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
543 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
544 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
545 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
546 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
547 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
548 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
549 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
550 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
551 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
552 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
553 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
554 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
555 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
556 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
557 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
558 #Spreadsheets using ssconvert from gnumeric
559 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
560 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
561 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
562 \Format oocalc ods "OpenOffice spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
564 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
565 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
567 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
568 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
569 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
570 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
571 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
572 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
573 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
575 #checkProg('a Postscript interpreter', ['gs'],
576 # rc_entry = [ r'\ps_command "%%"' ])
577 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
578 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
579 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
580 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
581 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
582 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
583 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', 'mupdf', \
585 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
586 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
587 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
588 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
589 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
590 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"'''])
592 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
593 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
594 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
596 # Windows only: DraftDVI
597 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
599 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
600 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
602 checkViewerEditor('Noteedit', ['noteedit'],
603 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
605 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
606 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
607 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
609 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
610 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
611 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"'''])
613 # entries that do not need checkProg
614 addToRC(r'''\Format date "" "date command" "" "" "" "" ""
615 \Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
616 \Format fax "" Fax "" "" "" "document" ""
617 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
618 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
619 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
620 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
621 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document,menu=export" ""
622 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document,menu=export" ""
623 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
624 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
625 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
626 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
627 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
628 \Format program "" Program "" "" "" "" ""
629 \Format pstex pstex_t PSTEX "" "" "" "" ""
630 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
631 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
632 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
636 def checkConverterEntries():
637 ''' Check all converters (\converter entries) '''
638 checkProg('the pdflatex program', ['pdflatex $$i'],
639 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
641 checkProg('XeTeX', ['xelatex $$i'],
642 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
646 # Look for tex2lyx in this order (see bugs #3308 and #6986):
647 # 1) If we're running LyX in-place then tex2lyx will be found
648 # in ../src/tex2lyx with respect to the srcdir.
649 # 2) If LyX was configured with a version suffix then tex2lyx
650 # will also have this version suffix.
651 # 3) Otherwise always use tex2lyx.
652 in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
653 in_place = os.path.abspath(in_place)
655 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
656 in_binary_dir = os.path.abspath(in_binary_dir)
658 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_place, in_place + version_suffix, in_binary_dir, in_binary_dir + version_suffix, 'tex2lyx' + version_suffix, 'tex2lyx'],
659 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
660 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""'''], not_found = 'tex2lyx')
662 logger.warning("Failed to find tex2lyx on your system.")
665 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
666 rc_entry = [r'''\converter literate latex "%%" ""
667 \converter literate pdflatex "%%" ""
668 \converter literate luatex "%%" ""'''])
670 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
671 rc_entry = [r'''\converter sweave latex "%%" ""
672 \converter sweave pdflatex "%%" ""
673 \converter sweave xetex "%%" ""
674 \converter sweave luatex "%%" ""'''])
676 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
677 rc_entry = [r'''\converter knitr latex "%%" ""
678 \converter knitr pdflatex "%%" ""
679 \converter knitr xetex "%%" ""
680 \converter knitr luatex "%%" ""'''])
682 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
683 rc_entry = [ r'\converter sweave r "%%" ""' ])
685 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
686 rc_entry = [ r'\converter knitr r "%%" ""' ])
688 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
689 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
690 rc_entry = [ r'\converter html latex "%%" ""', \
691 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""', \
692 r'\converter html latex "%%" ""', \
693 r'\converter html latex "%%" ""', '' ])
695 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
696 rc_entry = [ r'\converter word latex "%%" ""' ])
698 # eLyXer: search as an executable (elyxer.py, elyxer)
699 path, elyxer = checkProg('a LyX -> HTML converter',
700 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
701 rc_entry = [ r'\converter lyx html "%%" ""' ])
702 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
703 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
704 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
705 if elyxer.find('elyxer') >= 0:
706 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
707 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
709 # search for HTML converters other than eLyXer
710 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
711 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
712 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
713 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
714 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
715 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
716 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
718 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
719 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
720 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
721 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
722 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
723 if htmlconv.find('htlatex') >= 0:
724 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
726 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
729 # Check if LyXBlogger is installed
730 lyxblogger_found = checkModule('lyxblogger')
732 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
733 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
736 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
737 rc_entry = [ r'\converter sxw latex "%%" ""' ])
739 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
740 rc_entry = [ r'\converter odt latex "%%" ""' ])
741 # Only define a converter to pdf6, otherwise the odt format could be
742 # used as an intermediate step for export to pdf, which is not wanted.
743 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
744 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
745 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
746 # the command mk4ht oolatex $$i has to be used as default,
747 # but as this would require to have Perl installed, in MiKTeX oolatex is
748 # directly available as application.
749 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
750 # Both SuSE and debian have oolatex
751 checkProg('a LaTeX -> Open Document converter', [
752 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
753 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
754 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
755 # On windows it is called latex2rt.exe
756 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
757 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
759 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
760 rc_entry = [ r'\converter rtf html "%%" ""' ])
761 # Do not define a converter to pdf6, ps is a pure export format
762 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
763 rc_entry = [ r'\converter ps pdf "%%" ""' ])
765 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
766 rc_entry = [ r'\converter ps text2 "%%" ""' ])
768 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
769 rc_entry = [ r'\converter ps text3 "%%" ""' ])
770 # Need to call ps2eps in a pipe, otherwise it would name the output file
771 # depending on the extension of the input file. We do not know the input
772 # file extension in general, so the resultfile= flag would not help.
773 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
774 # This would create additional paths in the converter graph with unwanted
775 # side effects (e.g. ps->pdf via ps2pdf would create a different result
776 # than ps->eps->pdf via ps2eps and epstopdf).
777 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
778 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
780 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
781 rc_entry = [ r'\converter pdf ps "%%" ""' ])
782 # Only define a converter from pdf6 for graphics
783 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
784 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
786 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
787 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
789 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
790 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
792 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
793 rc_entry = [ r'\converter dvi ps "%%" ""' ])
795 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
796 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
798 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
799 rc_entry = [ r'\converter ps fax "%%" ""'])
801 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
802 if fig2dev == "fig2dev":
803 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
804 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
805 \converter fig png "fig2dev -L png $$i $$o" ""
806 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
807 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
809 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
810 rc_entry = [ r'\converter tiff eps "%%" ""'])
812 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
814 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
815 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
816 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
818 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
819 rc_entry = [ r'\converter wmf eps "%%" ""'])
821 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
822 rc_entry = [ r'\converter emf eps "%%" ""'])
823 # Only define a converter to pdf6 for graphics
824 checkProg('an EPS -> PDF converter', ['epstopdf'],
825 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
827 checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
828 rc_entry = [ r'\converter eps png "%%" ""'])
830 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
831 # free software and therefore not compiled in in many installations.
832 # Fortunately, this is not a big problem, because we will use epstopdf to
833 # convert from agr to pdf6 via eps without loss of quality.
834 checkProg('a Grace -> Image converter', ['gracebat'],
836 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
837 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
838 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
839 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
841 checkProg('a Dot -> Image converter', ['dot'],
843 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
844 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
846 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
847 rc_entry = [ r'\converter dia png "%%" ""'])
849 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
850 rc_entry = [ r'\converter dia eps "%%" ""'])
851 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
852 # The eps2->eps converter then fixes the bounding box by cropping.
853 # Although unoconv can convert to png and pdf as well, do not define
854 # odg->png and odg->pdf converters, since the bb would be too large as well.
855 checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
856 rc_entry = [ r'\converter odg eps2 "%%" ""'])
857 # Only define a converter to pdf6 for graphics
858 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
859 rc_entry = [ r'\converter svg pdf6 "%%" ""'])
861 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
862 rc_entry = [ r'\converter svg eps "%%" ""'])
864 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
865 rc_entry = [ r'\converter svg png "%%" ""'])
868 # gnumeric/xls/ods to tex
869 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
870 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
871 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
872 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
874 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
876 version_string = cmdOutput("lilypond --version")
877 match = re.match('GNU LilyPond (\S+)', version_string)
879 version_number = match.groups()[0]
880 version = version_number.split('.')
881 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
882 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
883 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
884 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
885 logger.info('+ found LilyPond version %s.' % version_number)
886 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
887 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
888 \converter lilypond png "lilypond -b eps --png $$i" ""''')
889 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
890 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
891 logger.info('+ found LilyPond version %s.' % version_number)
893 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
895 logger.info('+ found LilyPond, but could not extract version number.')
897 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
898 if (lilypond_book != ''):
899 version_string = cmdOutput("lilypond-book --version")
900 match = re.match('^(\S+)$', version_string)
902 version_number = match.groups()[0]
903 version = version_number.split('.')
904 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
905 # Note: The --lily-output-dir flag is required because lilypond-book
906 # does not process input again unless the input has changed,
907 # even if the output format being requested is different. So
908 # once a .eps file exists, lilypond-book won't create a .pdf
909 # even when requested with --pdf. This is a problem if a user
910 # clicks View PDF after having done a View DVI. To circumvent
911 # this, use different output folders for eps and pdf outputs.
912 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
913 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
914 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
915 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
916 logger.info('+ found LilyPond-book version %s.' % version_number)
918 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
920 logger.info('+ found LilyPond-book, but could not extract version number.')
922 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
923 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
925 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
926 # and a zip archive on Windows.
927 # So, we configure the appropriate version according to the platform.
928 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
930 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
931 addToRC(cmd % "lyxzip")
933 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
934 addToRC(cmd % "lyxgz")
937 # FIXME: no rc_entry? comment it out
938 # checkProg('Image converter', ['convert $$i $$o'])
940 # Entries that do not need checkProg
942 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
943 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
944 \converter docbook docbook-xml "cp $$i $$o" "xml"
945 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
946 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
947 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
948 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
949 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
950 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
951 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
952 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
953 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
954 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
955 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
956 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
957 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
958 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
963 ''' Check docbook '''
964 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
966 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
967 \converter docbook html "sgmltools -b html $$i" ""
968 \converter docbook ps "sgmltools -b ps $$i" ""''',
969 r'''\converter docbook dvi "db2dvi $$i" ""
970 \converter docbook html "db2html $$i" ""''',
971 r'''\converter docbook dvi "" ""
972 \converter docbook html "" ""''',
973 r'''\converter docbook dvi "" ""
974 \converter docbook html "" ""'''])
977 return ('yes', 'true', '\\def\\hasdocbook{yes}')
979 return ('no', 'false', '')
982 def checkOtherEntries():
983 ''' entries other than Format and Converter '''
984 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
985 rc_entry = [ r'\chktex_command "%%"' ])
986 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
987 rc_entry = [ r'\bibtex_command "%%"' ],
988 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
989 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
990 rc_entry = [ r'\jbibtex_command "%%"' ])
991 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
992 rc_entry = [ r'\index_command "%%"' ],
993 alt_rc_entry = [ r'\index_alternatives "%%"' ])
994 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
995 rc_entry = [ r'\jindex_command "%%"' ])
996 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
997 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
998 checkProg('a nomenclature processor', ['makeindex'],
999 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1000 ## FIXME: OCTAVE is not used anywhere
1001 # path, OCTAVE = checkProg('Octave', ['octave'])
1002 ## FIXME: MAPLE is not used anywhere
1003 # path, MAPLE = checkProg('Maple', ['maple'])
1004 checkProg('a spool command', ['lp', 'lpr'],
1006 r'''\print_spool_printerprefix "-d "
1007 \print_spool_command "lp"''',
1008 r'''\print_spool_printerprefix "-P",
1009 \print_spool_command "lpr"''',
1011 # Add the rest of the entries (no checkProg is required)
1012 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1013 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1014 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1015 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1019 def processLayoutFile(file, bool_docbook):
1020 ''' process layout file and get a line of result
1022 Declare lines look like this:
1024 \DeclareLaTeXClass[<requirements>]{<description>}
1026 Optionally, a \DeclareCategory line follows:
1028 \DeclareCategory{<category>}
1030 So for example (article.layout, scrbook.layout, svjog.layout)
1032 \DeclareLaTeXClass{article}
1033 \DeclareCategory{Articles}
1035 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1036 \DeclareCategory{Books}
1038 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1040 we'd expect this output:
1042 "article" "article" "article" "false" "article.cls" "Articles"
1043 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1044 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1046 def checkForClassExtension(x):
1047 '''if the extension for a latex class is not
1048 provided, add .cls to the classname'''
1050 return x.strip() + '.cls'
1053 classname = file.split(os.sep)[-1].split('.')[0]
1054 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1055 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1056 q = re.compile(r'\DeclareCategory{(.*)}')
1057 classdeclaration = ""
1058 categorydeclaration = '""'
1059 for line in open(file).readlines():
1060 res = p.search(line)
1061 qres = q.search(line)
1063 (classtype, optAll, opt, opt1, desc) = res.groups()
1064 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1067 prereq_latex = checkForClassExtension(classname)
1069 prereq_list = optAll[1:-1].split(',')
1070 prereq_list = map(checkForClassExtension, prereq_list)
1071 prereq_latex = ','.join(prereq_list)
1072 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1073 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1074 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1075 if categorydeclaration != '""':
1076 return classdeclaration + " " + categorydeclaration
1078 categorydeclaration = '"%s"' % (qres.groups()[0])
1079 if classdeclaration != "":
1080 return classdeclaration + " " + categorydeclaration
1081 if classdeclaration != "":
1082 return classdeclaration + " " + categorydeclaration
1083 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1087 def checkLatexConfig(check_config, bool_docbook):
1088 ''' Explore the LaTeX configuration
1089 Return None (will be passed to sys.exit()) for success.
1091 msg = 'checking LaTeX configuration... '
1092 # if --without-latex-config is forced, or if there is no previous
1093 # version of textclass.lst, re-generate a default file.
1094 if not os.path.isfile('textclass.lst') or not check_config:
1095 # remove the files only if we want to regenerate
1096 removeFiles(['textclass.lst', 'packages.lst'])
1098 # Then, generate a default textclass.lst. In case configure.py
1099 # fails, we still have something to start lyx.
1100 logger.info(msg + ' default values')
1101 logger.info('+checking list of textclasses... ')
1102 tx = open('textclass.lst', 'w')
1104 # This file declares layouts and their associated definition files
1105 # (include dir. relative to the place where this file is).
1106 # It contains only default values, since chkconfig.ltx could not be run
1107 # for some reason. Run ./configure.py if you need to update it after a
1108 # configuration change.
1110 # build the list of available layout files and convert it to commands
1113 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1114 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1116 if not os.path.isfile(file):
1118 # get stuff between /xxxx.layout .
1119 classname = file.split(os.sep)[-1].split('.')[0]
1121 cleanclass = classname.replace(' ', '_')
1122 cleanclass = cleanclass.replace('-', '_')
1123 # make sure the same class is not considered twice
1124 if foundClasses.count(cleanclass) == 0: # not found before
1125 foundClasses.append(cleanclass)
1126 retval = processLayoutFile(file, bool_docbook)
1130 logger.info('\tdone')
1131 if not os.path.isfile('packages.lst') or not check_config:
1132 logger.info('+generating default list of packages... ')
1133 removeFiles(['packages.lst'])
1134 tx = open('packages.lst', 'w')
1136 logger.info('\tdone')
1137 if not check_config:
1139 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1140 logger.info(msg + '\tauto')
1141 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1142 'wrap_chkconfig.ltx'])
1144 if not os.path.isfile( 'chkconfig.ltx' ):
1145 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1147 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1148 # Construct the list of classes to test for.
1149 # build the list of available layout files and convert it to commands
1151 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1152 category = re.compile(r'\DeclareCategory{(.*)}')
1153 empty = re.compile(r'^\s*$')
1154 testclasses = list()
1155 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1156 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1157 nodeclaration = False
1158 if not os.path.isfile(file):
1160 classname = file.split(os.sep)[-1].split('.')[0]
1163 for line in open(file).readlines():
1164 if not empty.match(line) and line[0] != '#':
1166 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1167 nodeclaration = True
1168 # A class, but no category declaration. Just break.
1170 if declare.search(line) != None:
1171 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1172 testclasses.append(decline)
1173 elif category.search(line) != None:
1174 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1175 testclasses.append(catline)
1176 if catline == "" or decline == "":
1182 cl = open('chklayouts.tex', 'w')
1183 for line in testclasses:
1184 cl.write(line + '\n')
1187 # we have chklayouts.tex, then process it
1188 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1190 line = latex_out.readline()
1193 if re.match('^\+', line):
1194 logger.info(line.strip())
1195 # if the command succeeds, None will be returned
1196 ret = latex_out.close()
1198 # remove the copied file
1200 removeFiles( [ 'chkconfig.ltx' ] )
1202 # currently, values in chkconfig are only used to set
1205 for line in open('chkconfig.vars').readlines():
1206 key, val = re.sub('-', '_', line).split('=')
1208 values[key] = val.strip("'")
1209 # chk_fontenc may not exist
1211 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1214 # if configure successed, move textclass.lst.tmp to textclass.lst
1215 # and packages.lst.tmp to packages.lst
1216 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1217 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1218 shutil.move('textclass.lst.tmp', 'textclass.lst')
1219 shutil.move('packages.lst.tmp', 'packages.lst')
1223 def checkModulesConfig():
1224 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1226 logger.info('+checking list of modules... ')
1227 tx = open('lyxmodules.lst', 'w')
1228 tx.write('''## This file declares modules and their associated definition files.
1229 ## It has been automatically generated by configure
1230 ## Use "Options/Reconfigure" if you need to update it after a
1231 ## configuration change.
1232 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1235 # build the list of available modules
1237 # note that this searches the local directory first, then the
1238 # system directory. that way, we pick up the user's version first.
1239 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1240 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1243 if not os.path.isfile(file):
1246 filename = file.split(os.sep)[-1]
1247 filename = filename[:-7]
1248 if seen.count(filename):
1251 seen.append(filename)
1252 retval = processModuleFile(file, filename, bool_docbook)
1256 logger.info('\tdone')
1259 def processModuleFile(file, filename, bool_docbook):
1260 ''' process module file and get a line of result
1262 The top of a module file should look like this:
1263 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1265 #...body of description...
1267 #Requires: [list of required modules]
1268 #Excludes: [list of excluded modules]
1269 #Category: [category name]
1270 The last three lines are optional (though do give a category).
1272 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1274 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1275 rereqs = re.compile(r'#+\s*Requires: (.*)')
1276 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1277 recaty = re.compile(r'#+\s*Category: (.*)')
1278 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1279 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1281 modname = desc = pkgs = req = excl = catgy = ""
1282 readingDescription = False
1285 for line in open(file).readlines():
1286 if readingDescription:
1287 res = redend.search(line)
1289 readingDescription = False
1290 desc = " ".join(descLines)
1292 desc = desc.replace('"', '\\"')
1294 descLines.append(line[1:].strip())
1296 res = redbeg.search(line)
1298 readingDescription = True
1300 res = remods.search(line)
1302 (pkgs, modname) = res.groups()
1306 tmp = [s.strip() for s in pkgs.split(",")]
1307 pkgs = ",".join(tmp)
1309 res = rereqs.search(line)
1312 tmp = [s.strip() for s in req.split("|")]
1315 res = reexcs.search(line)
1318 tmp = [s.strip() for s in excl.split("|")]
1319 excl = "|".join(tmp)
1321 res = recaty.search(line)
1323 catgy = res.group(1)
1327 logger.warning("Module file without \DeclareLyXModule line. ")
1331 # this module has some latex dependencies:
1332 # append the dependencies to chkmodules.tex,
1333 # which is \input'ed by chkconfig.ltx
1334 testpackages = list()
1335 for pkg in pkgs.split(","):
1337 # this is a converter dependency: skip
1339 if pkg.endswith(".sty"):
1341 testpackages.append("\\TestPackage{%s}" % (pkg,))
1342 cm = open('chkmodules.tex', 'a')
1343 for line in testpackages:
1344 cm.write(line + '\n')
1347 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1350 def checkTeXAllowSpaces():
1351 ''' Let's check whether spaces are allowed in TeX file names '''
1352 tex_allows_spaces = 'false'
1353 if lyx_check_config:
1354 msg = "Checking whether TeX allows spaces in file names... "
1355 writeToFile('a b.tex', r'\message{working^^J}' )
1357 if os.name == 'nt' or sys.platform == 'cygwin':
1358 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1360 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1363 if 'working' in latex_out:
1364 logger.info(msg + 'yes')
1365 tex_allows_spaces = 'true'
1367 logger.info(msg + 'no')
1368 tex_allows_spaces = 'false'
1369 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1370 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1373 def rescanTeXFiles():
1374 ''' Run kpsewhich to update information about TeX files '''
1375 logger.info("+Indexing TeX files... ")
1376 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1377 logger.error("configure: error: cannot find TeXFiles.py script")
1379 tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1381 logger.info("\tdone")
1384 def removeTempFiles():
1386 if not lyx_keep_temps:
1387 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1388 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1389 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1392 if __name__ == '__main__':
1393 lyx_check_config = True
1394 lyx_kpsewhich = True
1395 outfile = 'lyxrc.defaults'
1396 lyxrc_fileformat = 11
1398 lyx_keep_temps = False
1401 ## Parse the command line
1402 for op in sys.argv[1:]: # default shell/for list is $*, the options
1403 if op in [ '-help', '--help', '-h' ]:
1404 print '''Usage: configure [options]
1406 --help show this help lines
1407 --keep-temps keep temporary files (for debug. purposes)
1408 --without-kpsewhich do not update TeX files information via kpsewhich
1409 --without-latex-config do not run LaTeX to determine configuration
1410 --with-version-suffix=suffix suffix of binary installed files
1411 --binary-dir=directory directory of binary installed files
1414 elif op == '--without-kpsewhich':
1415 lyx_kpsewhich = False
1416 elif op == '--without-latex-config':
1417 lyx_check_config = False
1418 elif op == '--keep-temps':
1419 lyx_keep_temps = True
1420 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1421 version_suffix = op[22:]
1422 elif op[0:13] == '--binary-dir=':
1423 lyx_binary_dir = op[13:]
1425 print "Unknown option", op
1428 # check if we run from the right directory
1429 srcdir = os.path.dirname(sys.argv[0])
1432 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1433 logger.error("configure: error: cannot find chkconfig.ltx script")
1437 dtl_tools = checkDTLtools()
1438 ## Write the first part of outfile
1439 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1440 # script. It contains default settings that have been determined by
1441 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1442 # want to customize LyX, use LyX' Preferences dialog or modify directly
1443 # the "preferences" file instead. Any setting in that file will
1444 # override the values given here.
1448 ''' % lyxrc_fileformat)
1450 LATEX = checkLatex(dtl_tools)
1451 # check java and perl before any checkProg that may require them
1452 java = checkProg('a java interpreter', ['java'])[1]
1453 perl = checkProg('a perl interpreter', ['perl'])[1]
1454 checkFormatEntries(dtl_tools)
1455 checkConverterEntries()
1456 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1457 checkTeXAllowSpaces()
1458 windows_style_tex_paths = checkTeXPaths()
1459 if windows_style_tex_paths != '':
1460 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1464 checkModulesConfig()
1465 # --without-latex-config can disable lyx_check_config
1466 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1468 # The return error code can be 256. Because most systems expect an error code
1469 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1470 # a None for success, 'ret is not None' is used to exit.
1471 sys.exit(ret is not None)