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)
201 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
204 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
205 logger.info(msg + ' yes')
206 # deal with java and perl
207 if ac_word.endswith('.class'):
208 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
209 elif ac_word.endswith('.jar'):
210 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
211 elif ac_word.endswith('.pl'):
212 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
213 # write rc entries for this command
214 if len(rc_entry) == 1:
215 addToRC(rc_entry[0].replace('%%', ac_prog))
216 elif len(rc_entry) > 1:
217 addToRC(rc_entry[idx].replace('%%', ac_prog))
218 return [ac_dir, ac_word]
220 logger.info(msg + ' no')
221 # write rc entries for 'not found'
222 if len(rc_entry) > 0: # the last one.
223 addToRC(rc_entry[-1].replace('%%', not_found))
224 return ['', not_found]
227 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
229 The same as checkProg, but additionally, all found programs will be added
232 # one rc entry for each progs plus not_found entry
233 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
234 logger.error("rc entry should have one item or item for each prog and not_found.")
236 logger.info('checking for ' + description + '...')
237 ## print '(' + ','.join(progs) + ')',
240 real_ac_word = not_found
242 for idx in range(len(progs)):
243 # ac_prog may have options, ac_word is the command name
245 ac_word = ac_prog.split(' ')[0]
246 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
248 if ac_word.endswith('.pl') and perl == '':
250 msg = '+checking for "' + ac_word + '"... '
251 path = os.environ["PATH"].split(os.pathsep) + path
253 if "PATHEXT" in os.environ:
254 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
257 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
260 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
261 logger.info(msg + ' yes')
262 pr = re.compile(r'(\\\S+)(.*)$')
264 # deal with java and perl
265 if ac_word.endswith('.class'):
266 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
267 elif ac_word.endswith('.jar'):
268 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
269 elif ac_word.endswith('.pl'):
270 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
271 # write rc entries for this command
272 if found_prime == False:
273 if len(rc_entry) == 1:
274 addToRC(rc_entry[0].replace('%%', ac_prog))
275 elif len(rc_entry) > 1:
276 addToRC(rc_entry[idx].replace('%%', ac_prog))
278 real_ac_word = ac_word
280 if len(alt_rc_entry) == 1:
281 alt_rc = alt_rc_entry[0]
283 # if no explicit alt_rc is given, construct one
284 m = pr.match(rc_entry[0])
286 alt_rc = m.group(1) + "_alternatives" + m.group(2)
287 addToRC(alt_rc.replace('%%', ac_prog))
288 elif len(alt_rc_entry) > 1:
289 alt_rc = alt_rc_entry[idx]
291 # if no explicit alt_rc is given, construct one
292 m = pr.match(rc_entry[idx])
294 alt_rc = m.group(1) + "_alternatives" + m.group(2)
295 addToRC(alt_rc.replace('%%', ac_prog))
300 if found_alt == False:
302 logger.info(msg + ' no')
304 return [real_ac_dir, real_ac_word]
305 # write rc entries for 'not found'
306 if len(rc_entry) > 0: # the last one.
307 addToRC(rc_entry[-1].replace('%%', not_found))
308 return ['', not_found]
311 def addAlternatives(rcs, alt_type):
313 Returns a \\prog_alternatives string to be used as an alternative
314 rc entry. alt_type can be a string or a list of strings.
316 r = re.compile(r'\\Format (\S+).*$')
319 alt_token = '\\%s_alternatives '
320 if isinstance(alt_type, str):
321 alt_tokens = [alt_token % alt_type]
323 alt_tokens = map(lambda s: alt_token % s, alt_type)
324 for idxx in range(len(rcs)):
328 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
330 m = r.match(rcs[idxx])
334 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
338 def listAlternatives(progs, alt_type, rc_entry = []):
340 Returns a list of \\prog_alternatives strings to be used as alternative
341 rc entries. alt_type can be a string or a list of strings.
343 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
344 logger.error("rc entry should have one item or item for each prog and not_found.")
347 for idx in range(len(progs)):
348 if len(rc_entry) == 1:
349 rcs = rc_entry[0].split('\n')
350 alt = addAlternatives(rcs, alt_type)
351 alt_rc_entry.insert(0, alt)
352 elif len(rc_entry) > 1:
353 rcs = rc_entry[idx].split('\n')
354 alt = addAlternatives(rcs, alt_type)
355 alt_rc_entry.insert(idx, alt)
359 def checkViewer(description, progs, rc_entry = [], path = []):
360 ''' The same as checkProgAlternatives, but for viewers '''
361 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
362 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
365 def checkEditor(description, progs, rc_entry = [], path = []):
366 ''' The same as checkProgAlternatives, but for editors '''
367 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
368 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
371 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
372 ''' The same as checkViewer, but do not add rc entry '''
373 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
375 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
378 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
379 ''' The same as checkViewer, but do not add rc entry '''
380 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
382 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
385 def checkViewerEditor(description, progs, rc_entry = [], path = []):
386 ''' The same as checkProgAlternatives, but for viewers and editors '''
387 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
388 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
392 ''' Check whether DTL tools are available (Windows only) '''
393 # Find programs! Returned path is not used now
394 if ((os.name == 'nt' or sys.platform == 'cygwin') and
395 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
396 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
403 def checkLatex(dtl_tools):
404 ''' Check latex, return lyx_check_config '''
405 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
406 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
407 #-----------------------------------------------------------------
408 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
410 # check if PLATEX is pLaTeX2e
411 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
412 # run platex on chklatex.ltx and check result
413 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
414 # We have the Japanese pLaTeX2e
415 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
418 removeFiles(['chklatex.ltx', 'chklatex.log'])
419 #-----------------------------------------------------------------
420 # use LATEX to convert from latex to dvi if PPLATEX is not available
424 # Windows only: DraftDVI
425 addToRC(r'''\converter latex dvi2 "%s" "latex"
426 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
428 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
431 # Check if latex is usable
432 writeToFile('chklatex.ltx', r'''
434 \ifx\undefined\documentclass\else
435 \message{ThisIsLaTeX2e}
440 # run latex on chklatex.ltx and check result
441 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
445 logger.warning("Latex not usable (not LaTeX2e) ")
446 # remove temporary files
447 removeFiles(['chklatex.ltx', 'chklatex.log'])
452 ''' Check if luatex is there and usable '''
453 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
454 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
456 # luatex binary is there
457 msg = "checking if LuaTeX is usable ..."
458 # Check if luatex is usable
459 writeToFile('luatest.tex', r'''
461 \documentclass{minimal}
462 \usepackage{fontspec}
467 # run lualatex on luatest.tex and check result
468 luatest = cmdOutput(LUATEX + ' luatest.tex')
469 if luatest.find('XeTeX is required to compile this document') != -1:
470 # fontspec/luatex too old! We do not support this version.
471 logger.info(msg + ' no (probably not recent enough)')
472 elif luatest.find('! LaTeX Error: File `fontspec.sty\' not found') != -1:
474 logger.info(msg + ' no (missing fontspec)')
477 logger.info(msg + ' yes')
478 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
480 addToRC(r'\converter luatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
481 # remove temporary files
482 removeFiles(['luatest.tex', 'luatest.log', 'luatest.aux', 'luatest.pdf'])
485 def checkModule(module):
486 ''' Check for a Python module, return the status '''
487 msg = 'checking for "' + module + ' module"... '
490 logger.info(msg + ' yes')
493 logger.info(msg + ' no')
497 def checkFormatEntries(dtl_tools):
498 ''' Check all formats (\Format entries) '''
499 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
500 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
502 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
503 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
505 checkViewerEditor('a Dia viewer and editor', ['dia'],
506 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
508 checkViewerEditor('an OpenOffice drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
509 rc_entry = [r'\Format odg "odg, sxd" "OpenOffice drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
511 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
512 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
514 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
515 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
517 checkViewerEditor('a SVG viewer and editor', ['inkscape'],
518 rc_entry = [r'\Format svg svg SVG "" "%%" "%%" "vector" "image/svg+xml"'])
520 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
521 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
522 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
523 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
524 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
525 \Format png png PNG "" "%s" "%s" "" "image/x-png"
526 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
527 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
528 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
529 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
530 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
531 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
532 addToRC(imageformats % \
533 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
535 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
536 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
537 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
538 \Format asciiimage asc "Plain text (image)" "" "" "%%" "" ""
539 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" "" ""
540 \Format dateout tmp "date (output)" "" "" "%%" "" ""
541 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
542 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
543 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
544 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
545 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
546 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
547 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
548 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
549 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
550 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
551 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
552 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
553 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
554 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
555 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
556 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
557 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
558 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
559 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
560 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
561 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
562 #Spreadsheets using ssconvert from gnumeric
563 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
564 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
565 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
566 \Format oocalc ods "OpenOffice spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
568 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
569 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
571 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
572 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
573 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
574 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
575 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
576 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
577 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
579 #checkProg('a Postscript interpreter', ['gs'],
580 # rc_entry = [ r'\ps_command "%%"' ])
581 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
582 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
583 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
584 \Format eps3 eps "EPS (cropped)" "" "%%" "" "document,menu=export" ""
585 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
586 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
587 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
588 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', 'mupdf', \
590 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
591 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
592 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
593 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
594 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
595 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"
596 \Format pdf7 pdf "PDF (cropped)" "" "%%" "" "document,menu=export" ""'''])
598 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
599 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
600 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
602 # Windows only: DraftDVI
603 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
605 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
606 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
608 checkViewerEditor('Noteedit', ['noteedit'],
609 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
611 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
612 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
613 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
615 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
616 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
617 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"'''])
619 # entries that do not need checkProg
620 addToRC(r'''\Format date "" "date command" "" "" "" "" ""
621 \Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
622 \Format fax "" Fax "" "" "" "document" ""
623 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
624 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
625 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
626 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
627 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document,menu=export" ""
628 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document,menu=export" ""
629 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
630 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
631 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
632 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
633 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
634 \Format program "" Program "" "" "" "" ""
635 \Format pstex pstex_t PSTEX "" "" "" "" ""
636 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
637 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
638 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
642 def checkConverterEntries():
643 ''' Check all converters (\converter entries) '''
644 checkProg('the pdflatex program', ['pdflatex $$i'],
645 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
647 checkProg('XeTeX', ['xelatex $$i'],
648 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
652 # Look for tex2lyx in this order (see bugs #3308 and #6986):
653 # 1) If we're building LyX with autotools then tex2lyx is found
654 # in the subdirectory tex2lyx with respect to the binary dir.
655 # 2) If we're building LyX with cmake then tex2lyx is found
657 # 3) If LyX was configured with a version suffix then tex2lyx
658 # will also have this version suffix.
659 # 4) Otherwise always use tex2lyx.
660 in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
661 in_binary_subdir = os.path.abspath(in_binary_subdir)
663 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
664 in_binary_dir = os.path.abspath(in_binary_dir)
666 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_binary_subdir, in_binary_subdir + version_suffix, in_binary_dir, in_binary_dir + version_suffix, 'tex2lyx' + version_suffix, 'tex2lyx'],
667 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
668 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""'''], not_found = 'tex2lyx')
670 logger.warning("Failed to find tex2lyx on your system.")
673 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
674 rc_entry = [r'''\converter literate latex "%%" ""
675 \converter literate pdflatex "%%" ""
676 \converter literate luatex "%%" ""'''])
678 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
679 rc_entry = [r'''\converter sweave latex "%%" ""
680 \converter sweave pdflatex "%%" ""
681 \converter sweave xetex "%%" ""
682 \converter sweave luatex "%%" ""'''])
684 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
685 rc_entry = [r'''\converter knitr latex "%%" ""
686 \converter knitr pdflatex "%%" ""
687 \converter knitr xetex "%%" ""
688 \converter knitr luatex "%%" ""'''])
690 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
691 rc_entry = [ r'\converter sweave r "%%" ""' ])
693 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
694 rc_entry = [ r'\converter knitr r "%%" ""' ])
696 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
697 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
698 rc_entry = [ r'\converter html latex "%%" ""', \
699 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""', \
700 r'\converter html latex "%%" ""', \
701 r'\converter html latex "%%" ""', '' ])
703 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
704 rc_entry = [ r'\converter word latex "%%" ""' ])
706 # eLyXer: search as an executable (elyxer.py, elyxer)
707 path, elyxer = checkProg('a LyX -> HTML converter',
708 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
709 rc_entry = [ r'\converter lyx html "%%" ""' ])
710 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
711 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
712 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
713 if elyxer.find('elyxer') >= 0:
714 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
715 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
717 # search for HTML converters other than eLyXer
718 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
719 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
720 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
721 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
722 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
723 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
724 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
726 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
727 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
728 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
729 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
730 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
731 if htmlconv.find('htlatex') >= 0:
732 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
734 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
737 # Check if LyXBlogger is installed
738 lyxblogger_found = checkModule('lyxblogger')
740 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
741 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
744 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
745 rc_entry = [ r'\converter sxw latex "%%" ""' ])
747 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
748 rc_entry = [ r'\converter odt latex "%%" ""' ])
749 # Only define a converter to pdf6, otherwise the odt format could be
750 # used as an intermediate step for export to pdf, which is not wanted.
751 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
752 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
753 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
754 # the command mk4ht oolatex $$i has to be used as default,
755 # but as this would require to have Perl installed, in MiKTeX oolatex is
756 # directly available as application.
757 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
758 # Both SuSE and debian have oolatex
759 checkProg('a LaTeX -> Open Document converter', [
760 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
761 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
762 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
763 # On windows it is called latex2rt.exe
764 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
765 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
767 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
768 rc_entry = [ r'\converter rtf html "%%" ""' ])
769 # Do not define a converter to pdf6, ps is a pure export format
770 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
771 rc_entry = [ r'\converter ps pdf "%%" ""' ])
773 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
774 rc_entry = [ r'\converter ps text2 "%%" ""' ])
776 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
777 rc_entry = [ r'\converter ps text3 "%%" ""' ])
778 # Need to call ps2eps in a pipe, otherwise it would name the output file
779 # depending on the extension of the input file. We do not know the input
780 # file extension in general, so the resultfile= flag would not help.
781 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
782 # This would create additional paths in the converter graph with unwanted
783 # side effects (e.g. ps->pdf via ps2pdf would create a different result
784 # than ps->eps->pdf via ps2eps and epstopdf).
785 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
786 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
788 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
789 rc_entry = [ r'\converter pdf ps "%%" ""' ])
790 # Only define a converter from pdf6 for graphics
791 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
792 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
794 checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
795 rc_entry = [ r'\converter pdf2 pdf7 "%%" ""' ])
797 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
798 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
800 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
801 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
803 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
804 rc_entry = [ r'\converter dvi ps "%%" ""' ])
806 checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
807 rc_entry = [ r'\converter dvi eps3 "%%" ""' ])
809 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
810 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
812 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
813 rc_entry = [ r'\converter ps fax "%%" ""'])
815 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
816 if fig2dev == "fig2dev":
817 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
818 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
819 \converter fig png "fig2dev -L png $$i $$o" ""
820 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
821 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
823 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
824 rc_entry = [ r'\converter tiff eps "%%" ""'])
826 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
828 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
829 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
830 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
832 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
833 rc_entry = [ r'\converter wmf eps "%%" ""'])
835 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
836 rc_entry = [ r'\converter emf eps "%%" ""'])
837 # Only define a converter to pdf6 for graphics
838 checkProg('an EPS -> PDF converter', ['epstopdf'],
839 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
841 checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
842 rc_entry = [ r'\converter eps png "%%" ""'])
844 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
845 # free software and therefore not compiled in in many installations.
846 # Fortunately, this is not a big problem, because we will use epstopdf to
847 # convert from agr to pdf6 via eps without loss of quality.
848 checkProg('a Grace -> Image converter', ['gracebat'],
850 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
851 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
852 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
853 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
855 checkProg('a Dot -> Image converter', ['dot'],
857 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
858 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
860 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
861 rc_entry = [ r'\converter dia png "%%" ""'])
863 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
864 rc_entry = [ r'\converter dia eps "%%" ""'])
865 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
866 # The eps2->eps converter then fixes the bounding box by cropping.
867 # Although unoconv can convert to png and pdf as well, do not define
868 # odg->png and odg->pdf converters, since the bb would be too large as well.
869 checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
870 rc_entry = [ r'\converter odg eps2 "%%" ""'])
871 # Only define a converter to pdf6 for graphics
872 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
873 rc_entry = [ r'\converter svg pdf6 "%%" ""'])
875 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
876 rc_entry = [ r'\converter svg eps "%%" ""'])
878 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
879 rc_entry = [ r'\converter svg png "%%" ""'])
882 # gnumeric/xls/ods to tex
883 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
884 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
885 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
886 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
888 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
890 version_string = cmdOutput("lilypond --version")
891 match = re.match('GNU LilyPond (\S+)', version_string)
893 version_number = match.groups()[0]
894 version = version_number.split('.')
895 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
896 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
897 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
898 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
899 logger.info('+ found LilyPond version %s.' % version_number)
900 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
901 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
902 \converter lilypond png "lilypond -b eps --png $$i" ""''')
903 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
904 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
905 logger.info('+ found LilyPond version %s.' % version_number)
907 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
909 logger.info('+ found LilyPond, but could not extract version number.')
911 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
912 if (lilypond_book != ''):
913 version_string = cmdOutput("lilypond-book --version")
914 match = re.match('^(\S+)$', version_string)
916 version_number = match.groups()[0]
917 version = version_number.split('.')
918 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
919 # Note: The --lily-output-dir flag is required because lilypond-book
920 # does not process input again unless the input has changed,
921 # even if the output format being requested is different. So
922 # once a .eps file exists, lilypond-book won't create a .pdf
923 # even when requested with --pdf. This is a problem if a user
924 # clicks View PDF after having done a View DVI. To circumvent
925 # this, use different output folders for eps and pdf outputs.
926 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
927 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
928 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
929 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
930 logger.info('+ found LilyPond-book version %s.' % version_number)
932 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
934 logger.info('+ found LilyPond-book, but could not extract version number.')
936 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
937 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
939 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
940 # and a zip archive on Windows.
941 # So, we configure the appropriate version according to the platform.
942 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
944 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
945 addToRC(cmd % "lyxzip")
947 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
948 addToRC(cmd % "lyxgz")
951 # FIXME: no rc_entry? comment it out
952 # checkProg('Image converter', ['convert $$i $$o'])
954 # Entries that do not need checkProg
956 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
957 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
958 \converter docbook docbook-xml "cp $$i $$o" "xml"
959 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
960 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
961 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
962 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
963 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
964 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
965 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
966 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
967 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
968 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
969 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
970 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
971 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
972 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
977 ''' Check docbook '''
978 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
980 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
981 \converter docbook html "sgmltools -b html $$i" ""
982 \converter docbook ps "sgmltools -b ps $$i" ""''',
983 r'''\converter docbook dvi "db2dvi $$i" ""
984 \converter docbook html "db2html $$i" ""''',
985 r'''\converter docbook dvi "" ""
986 \converter docbook html "" ""''',
987 r'''\converter docbook dvi "" ""
988 \converter docbook html "" ""'''])
991 return ('yes', 'true', '\\def\\hasdocbook{yes}')
993 return ('no', 'false', '')
996 def checkOtherEntries():
997 ''' entries other than Format and Converter '''
998 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
999 rc_entry = [ r'\chktex_command "%%"' ])
1000 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
1001 rc_entry = [ r'\bibtex_command "%%"' ],
1002 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1003 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
1004 rc_entry = [ r'\jbibtex_command "%%"' ])
1005 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
1006 rc_entry = [ r'\index_command "%%"' ],
1007 alt_rc_entry = [ r'\index_alternatives "%%"' ])
1008 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1009 rc_entry = [ r'\jindex_command "%%"' ])
1010 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1011 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1012 checkProg('a nomenclature processor', ['makeindex'],
1013 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1014 ## FIXME: OCTAVE is not used anywhere
1015 # path, OCTAVE = checkProg('Octave', ['octave'])
1016 ## FIXME: MAPLE is not used anywhere
1017 # path, MAPLE = checkProg('Maple', ['maple'])
1018 checkProg('a spool command', ['lp', 'lpr'],
1020 r'''\print_spool_printerprefix "-d "
1021 \print_spool_command "lp"''',
1022 r'''\print_spool_printerprefix "-P",
1023 \print_spool_command "lpr"''',
1025 # Add the rest of the entries (no checkProg is required)
1026 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1027 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1028 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1029 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1033 def processLayoutFile(file, bool_docbook):
1034 ''' process layout file and get a line of result
1036 Declare lines look like this:
1038 \DeclareLaTeXClass[<requirements>]{<description>}
1040 Optionally, a \DeclareCategory line follows:
1042 \DeclareCategory{<category>}
1044 So for example (article.layout, scrbook.layout, svjog.layout)
1046 \DeclareLaTeXClass{article}
1047 \DeclareCategory{Articles}
1049 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1050 \DeclareCategory{Books}
1052 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1054 we'd expect this output:
1056 "article" "article" "article" "false" "article.cls" "Articles"
1057 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1058 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1060 def checkForClassExtension(x):
1061 '''if the extension for a latex class is not
1062 provided, add .cls to the classname'''
1064 return x.strip() + '.cls'
1067 classname = file.split(os.sep)[-1].split('.')[0]
1068 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1069 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1070 q = re.compile(r'\DeclareCategory{(.*)}')
1071 classdeclaration = ""
1072 categorydeclaration = '""'
1073 for line in open(file).readlines():
1074 res = p.search(line)
1075 qres = q.search(line)
1077 (classtype, optAll, opt, opt1, desc) = res.groups()
1078 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1081 prereq_latex = checkForClassExtension(classname)
1083 prereq_list = optAll[1:-1].split(',')
1084 prereq_list = map(checkForClassExtension, prereq_list)
1085 prereq_latex = ','.join(prereq_list)
1086 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1087 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1088 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1089 if categorydeclaration != '""':
1090 return classdeclaration + " " + categorydeclaration
1092 categorydeclaration = '"%s"' % (qres.groups()[0])
1093 if classdeclaration != "":
1094 return classdeclaration + " " + categorydeclaration
1095 if classdeclaration != "":
1096 return classdeclaration + " " + categorydeclaration
1097 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1101 def checkLatexConfig(check_config, bool_docbook):
1102 ''' Explore the LaTeX configuration
1103 Return None (will be passed to sys.exit()) for success.
1105 msg = 'checking LaTeX configuration... '
1106 # if --without-latex-config is forced, or if there is no previous
1107 # version of textclass.lst, re-generate a default file.
1108 if not os.path.isfile('textclass.lst') or not check_config:
1109 # remove the files only if we want to regenerate
1110 removeFiles(['textclass.lst', 'packages.lst'])
1112 # Then, generate a default textclass.lst. In case configure.py
1113 # fails, we still have something to start lyx.
1114 logger.info(msg + ' default values')
1115 logger.info('+checking list of textclasses... ')
1116 tx = open('textclass.lst', 'w')
1118 # This file declares layouts and their associated definition files
1119 # (include dir. relative to the place where this file is).
1120 # It contains only default values, since chkconfig.ltx could not be run
1121 # for some reason. Run ./configure.py if you need to update it after a
1122 # configuration change.
1124 # build the list of available layout files and convert it to commands
1127 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1128 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1130 if not os.path.isfile(file):
1132 # get stuff between /xxxx.layout .
1133 classname = file.split(os.sep)[-1].split('.')[0]
1135 cleanclass = classname.replace(' ', '_')
1136 cleanclass = cleanclass.replace('-', '_')
1137 # make sure the same class is not considered twice
1138 if foundClasses.count(cleanclass) == 0: # not found before
1139 foundClasses.append(cleanclass)
1140 retval = processLayoutFile(file, bool_docbook)
1144 logger.info('\tdone')
1145 if not os.path.isfile('packages.lst') or not check_config:
1146 logger.info('+generating default list of packages... ')
1147 removeFiles(['packages.lst'])
1148 tx = open('packages.lst', 'w')
1150 logger.info('\tdone')
1151 if not check_config:
1153 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1154 logger.info(msg + '\tauto')
1155 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1156 'wrap_chkconfig.ltx'])
1158 if not os.path.isfile( 'chkconfig.ltx' ):
1159 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1161 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1162 # Construct the list of classes to test for.
1163 # build the list of available layout files and convert it to commands
1165 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1166 category = re.compile(r'\DeclareCategory{(.*)}')
1167 empty = re.compile(r'^\s*$')
1168 testclasses = list()
1169 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1170 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1171 nodeclaration = False
1172 if not os.path.isfile(file):
1174 classname = file.split(os.sep)[-1].split('.')[0]
1177 for line in open(file).readlines():
1178 if not empty.match(line) and line[0] != '#':
1180 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1181 nodeclaration = True
1182 # A class, but no category declaration. Just break.
1184 if declare.search(line) != None:
1185 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1186 testclasses.append(decline)
1187 elif category.search(line) != None:
1188 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1189 testclasses.append(catline)
1190 if catline == "" or decline == "":
1196 cl = open('chklayouts.tex', 'w')
1197 for line in testclasses:
1198 cl.write(line + '\n')
1201 # we have chklayouts.tex, then process it
1202 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1204 line = latex_out.readline()
1207 if re.match('^\+', line):
1208 logger.info(line.strip())
1209 # if the command succeeds, None will be returned
1210 ret = latex_out.close()
1212 # remove the copied file
1214 removeFiles( [ 'chkconfig.ltx' ] )
1216 # currently, values in chkconfig are only used to set
1219 for line in open('chkconfig.vars').readlines():
1220 key, val = re.sub('-', '_', line).split('=')
1222 values[key] = val.strip("'")
1223 # chk_fontenc may not exist
1225 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1228 # if configure successed, move textclass.lst.tmp to textclass.lst
1229 # and packages.lst.tmp to packages.lst
1230 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1231 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1232 shutil.move('textclass.lst.tmp', 'textclass.lst')
1233 shutil.move('packages.lst.tmp', 'packages.lst')
1237 def checkModulesConfig():
1238 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1240 logger.info('+checking list of modules... ')
1241 tx = open('lyxmodules.lst', 'w')
1242 tx.write('''## This file declares modules and their associated definition files.
1243 ## It has been automatically generated by configure
1244 ## Use "Options/Reconfigure" if you need to update it after a
1245 ## configuration change.
1246 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1249 # build the list of available modules
1251 # note that this searches the local directory first, then the
1252 # system directory. that way, we pick up the user's version first.
1253 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1254 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1257 if not os.path.isfile(file):
1260 filename = file.split(os.sep)[-1]
1261 filename = filename[:-7]
1262 if seen.count(filename):
1265 seen.append(filename)
1266 retval = processModuleFile(file, filename, bool_docbook)
1270 logger.info('\tdone')
1273 def processModuleFile(file, filename, bool_docbook):
1274 ''' process module file and get a line of result
1276 The top of a module file should look like this:
1277 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1279 #...body of description...
1281 #Requires: [list of required modules]
1282 #Excludes: [list of excluded modules]
1283 #Category: [category name]
1284 The last three lines are optional (though do give a category).
1286 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1288 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1289 rereqs = re.compile(r'#+\s*Requires: (.*)')
1290 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1291 recaty = re.compile(r'#+\s*Category: (.*)')
1292 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1293 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1295 modname = desc = pkgs = req = excl = catgy = ""
1296 readingDescription = False
1299 for line in open(file).readlines():
1300 if readingDescription:
1301 res = redend.search(line)
1303 readingDescription = False
1304 desc = " ".join(descLines)
1306 desc = desc.replace('"', '\\"')
1308 descLines.append(line[1:].strip())
1310 res = redbeg.search(line)
1312 readingDescription = True
1314 res = remods.search(line)
1316 (pkgs, modname) = res.groups()
1320 tmp = [s.strip() for s in pkgs.split(",")]
1321 pkgs = ",".join(tmp)
1323 res = rereqs.search(line)
1326 tmp = [s.strip() for s in req.split("|")]
1329 res = reexcs.search(line)
1332 tmp = [s.strip() for s in excl.split("|")]
1333 excl = "|".join(tmp)
1335 res = recaty.search(line)
1337 catgy = res.group(1)
1341 logger.warning("Module file without \DeclareLyXModule line. ")
1345 # this module has some latex dependencies:
1346 # append the dependencies to chkmodules.tex,
1347 # which is \input'ed by chkconfig.ltx
1348 testpackages = list()
1349 for pkg in pkgs.split(","):
1351 # this is a converter dependency: skip
1353 if pkg.endswith(".sty"):
1355 testpackages.append("\\TestPackage{%s}" % (pkg,))
1356 cm = open('chkmodules.tex', 'a')
1357 for line in testpackages:
1358 cm.write(line + '\n')
1361 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1364 def checkTeXAllowSpaces():
1365 ''' Let's check whether spaces are allowed in TeX file names '''
1366 tex_allows_spaces = 'false'
1367 if lyx_check_config:
1368 msg = "Checking whether TeX allows spaces in file names... "
1369 writeToFile('a b.tex', r'\message{working^^J}' )
1371 if os.name == 'nt' or sys.platform == 'cygwin':
1372 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1374 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1377 if 'working' in latex_out:
1378 logger.info(msg + 'yes')
1379 tex_allows_spaces = 'true'
1381 logger.info(msg + 'no')
1382 tex_allows_spaces = 'false'
1383 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1384 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1387 def rescanTeXFiles():
1388 ''' Run kpsewhich to update information about TeX files '''
1389 logger.info("+Indexing TeX files... ")
1390 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1391 logger.error("configure: error: cannot find TeXFiles.py script")
1393 tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1395 logger.info("\tdone")
1398 def removeTempFiles():
1400 if not lyx_keep_temps:
1401 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1402 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1403 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1406 if __name__ == '__main__':
1407 lyx_check_config = True
1408 lyx_kpsewhich = True
1409 outfile = 'lyxrc.defaults'
1410 lyxrc_fileformat = 14
1412 lyx_keep_temps = False
1415 ## Parse the command line
1416 for op in sys.argv[1:]: # default shell/for list is $*, the options
1417 if op in [ '-help', '--help', '-h' ]:
1418 print '''Usage: configure [options]
1420 --help show this help lines
1421 --keep-temps keep temporary files (for debug. purposes)
1422 --without-kpsewhich do not update TeX files information via kpsewhich
1423 --without-latex-config do not run LaTeX to determine configuration
1424 --with-version-suffix=suffix suffix of binary installed files
1425 --binary-dir=directory directory of binary installed files
1428 elif op == '--without-kpsewhich':
1429 lyx_kpsewhich = False
1430 elif op == '--without-latex-config':
1431 lyx_check_config = False
1432 elif op == '--keep-temps':
1433 lyx_keep_temps = True
1434 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1435 version_suffix = op[22:]
1436 elif op[0:13] == '--binary-dir=':
1437 lyx_binary_dir = op[13:]
1439 print "Unknown option", op
1442 # check if we run from the right directory
1443 srcdir = os.path.dirname(sys.argv[0])
1446 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1447 logger.error("configure: error: cannot find chkconfig.ltx script")
1451 dtl_tools = checkDTLtools()
1452 ## Write the first part of outfile
1453 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1454 # script. It contains default settings that have been determined by
1455 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1456 # want to customize LyX, use LyX' Preferences dialog or modify directly
1457 # the "preferences" file instead. Any setting in that file will
1458 # override the values given here.
1462 ''' % lyxrc_fileformat)
1464 LATEX = checkLatex(dtl_tools)
1465 # check java and perl before any checkProg that may require them
1466 java = checkProg('a java interpreter', ['java'])[1]
1467 perl = checkProg('a perl interpreter', ['perl'])[1]
1468 checkFormatEntries(dtl_tools)
1469 checkConverterEntries()
1470 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1471 checkTeXAllowSpaces()
1472 windows_style_tex_paths = checkTeXPaths()
1473 if windows_style_tex_paths != '':
1474 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1478 checkModulesConfig()
1479 # --without-latex-config can disable lyx_check_config
1480 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1482 # The return error code can be 256. Because most systems expect an error code
1483 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1484 # a None for success, 'ret is not None' is used to exit.
1485 sys.exit(ret is not None)