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 -kanji=$$E $$i" "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 ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
585 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
586 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
587 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', 'mupdf', \
589 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
590 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
591 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
592 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
593 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
594 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"'''])
596 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
597 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
598 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
600 # Windows only: DraftDVI
601 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
603 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
604 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
606 checkViewerEditor('Noteedit', ['noteedit'],
607 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
609 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
610 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
611 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
613 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
614 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
615 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"'''])
617 # entries that do not need checkProg
618 addToRC(r'''\Format date "" "date command" "" "" "" "" ""
619 \Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
620 \Format fax "" Fax "" "" "" "document" ""
621 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
622 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
623 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
624 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
625 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document,menu=export" ""
626 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document,menu=export" ""
627 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
628 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
629 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
630 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
631 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
632 \Format program "" Program "" "" "" "" ""
633 \Format pstex pstex_t PSTEX "" "" "" "" ""
634 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
635 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
636 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
640 def checkConverterEntries():
641 ''' Check all converters (\converter entries) '''
642 checkProg('the pdflatex program', ['pdflatex $$i'],
643 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
645 checkProg('XeTeX', ['xelatex $$i'],
646 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
650 # Look for tex2lyx in this order (see bugs #3308 and #6986):
651 # 1) If we're running LyX in-place then tex2lyx will be found
652 # in ../src/tex2lyx with respect to the srcdir.
653 # 2) If LyX was configured with a version suffix then tex2lyx
654 # will also have this version suffix.
655 # 3) Otherwise always use tex2lyx.
656 in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
657 in_place = os.path.abspath(in_place)
659 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
660 in_binary_dir = os.path.abspath(in_binary_dir)
662 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'],
663 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
664 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""'''], not_found = 'tex2lyx')
666 logger.warning("Failed to find tex2lyx on your system.")
669 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
670 rc_entry = [r'''\converter literate latex "%%" ""
671 \converter literate pdflatex "%%" ""
672 \converter literate luatex "%%" ""'''])
674 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
675 rc_entry = [r'''\converter sweave latex "%%" ""
676 \converter sweave pdflatex "%%" ""
677 \converter sweave xetex "%%" ""
678 \converter sweave luatex "%%" ""'''])
680 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
681 rc_entry = [r'''\converter knitr latex "%%" ""
682 \converter knitr pdflatex "%%" ""
683 \converter knitr xetex "%%" ""
684 \converter knitr luatex "%%" ""'''])
686 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
687 rc_entry = [ r'\converter sweave r "%%" ""' ])
689 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
690 rc_entry = [ r'\converter knitr r "%%" ""' ])
692 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
693 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
694 rc_entry = [ r'\converter html latex "%%" ""', \
695 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""', \
696 r'\converter html latex "%%" ""', \
697 r'\converter html latex "%%" ""', '' ])
699 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
700 rc_entry = [ r'\converter word latex "%%" ""' ])
702 # eLyXer: search as an executable (elyxer.py, elyxer)
703 path, elyxer = checkProg('a LyX -> HTML converter',
704 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
705 rc_entry = [ r'\converter lyx html "%%" ""' ])
706 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
707 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
708 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
709 if elyxer.find('elyxer') >= 0:
710 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
711 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
713 # search for HTML converters other than eLyXer
714 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
715 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
716 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
717 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
718 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
719 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
720 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
722 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
723 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
724 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
725 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
726 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
727 if htmlconv.find('htlatex') >= 0:
728 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
730 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
733 # Check if LyXBlogger is installed
734 lyxblogger_found = checkModule('lyxblogger')
736 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
737 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
740 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
741 rc_entry = [ r'\converter sxw latex "%%" ""' ])
743 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
744 rc_entry = [ r'\converter odt latex "%%" ""' ])
745 # Only define a converter to pdf6, otherwise the odt format could be
746 # used as an intermediate step for export to pdf, which is not wanted.
747 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
748 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
749 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
750 # the command mk4ht oolatex $$i has to be used as default,
751 # but as this would require to have Perl installed, in MiKTeX oolatex is
752 # directly available as application.
753 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
754 # Both SuSE and debian have oolatex
755 checkProg('a LaTeX -> Open Document converter', [
756 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
757 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
758 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
759 # On windows it is called latex2rt.exe
760 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
761 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
763 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
764 rc_entry = [ r'\converter rtf html "%%" ""' ])
765 # Do not define a converter to pdf6, ps is a pure export format
766 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
767 rc_entry = [ r'\converter ps pdf "%%" ""' ])
769 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
770 rc_entry = [ r'\converter ps text2 "%%" ""' ])
772 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
773 rc_entry = [ r'\converter ps text3 "%%" ""' ])
774 # Need to call ps2eps in a pipe, otherwise it would name the output file
775 # depending on the extension of the input file. We do not know the input
776 # file extension in general, so the resultfile= flag would not help.
777 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
778 # This would create additional paths in the converter graph with unwanted
779 # side effects (e.g. ps->pdf via ps2pdf would create a different result
780 # than ps->eps->pdf via ps2eps and epstopdf).
781 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
782 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
784 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
785 rc_entry = [ r'\converter pdf ps "%%" ""' ])
786 # Only define a converter from pdf6 for graphics
787 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
788 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
790 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
791 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
793 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
794 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
796 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
797 rc_entry = [ r'\converter dvi ps "%%" ""' ])
799 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
800 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
802 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
803 rc_entry = [ r'\converter ps fax "%%" ""'])
805 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
806 if fig2dev == "fig2dev":
807 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
808 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
809 \converter fig png "fig2dev -L png $$i $$o" ""
810 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
811 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
813 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
814 rc_entry = [ r'\converter tiff eps "%%" ""'])
816 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
818 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
819 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
820 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
822 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
823 rc_entry = [ r'\converter wmf eps "%%" ""'])
825 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
826 rc_entry = [ r'\converter emf eps "%%" ""'])
827 # Only define a converter to pdf6 for graphics
828 checkProg('an EPS -> PDF converter', ['epstopdf'],
829 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
831 checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
832 rc_entry = [ r'\converter eps png "%%" ""'])
834 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
835 # free software and therefore not compiled in in many installations.
836 # Fortunately, this is not a big problem, because we will use epstopdf to
837 # convert from agr to pdf6 via eps without loss of quality.
838 checkProg('a Grace -> Image converter', ['gracebat'],
840 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
841 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
842 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
843 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
845 checkProg('a Dot -> Image converter', ['dot'],
847 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
848 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
850 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
851 rc_entry = [ r'\converter dia png "%%" ""'])
853 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
854 rc_entry = [ r'\converter dia eps "%%" ""'])
855 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
856 # The eps2->eps converter then fixes the bounding box by cropping.
857 # Although unoconv can convert to png and pdf as well, do not define
858 # odg->png and odg->pdf converters, since the bb would be too large as well.
859 checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
860 rc_entry = [ r'\converter odg eps2 "%%" ""'])
861 # Only define a converter to pdf6 for graphics
862 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
863 rc_entry = [ r'\converter svg pdf6 "%%" ""'])
865 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
866 rc_entry = [ r'\converter svg eps "%%" ""'])
868 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
869 rc_entry = [ r'\converter svg png "%%" ""'])
872 # gnumeric/xls/ods to tex
873 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
874 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
875 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
876 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
878 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
880 version_string = cmdOutput("lilypond --version")
881 match = re.match('GNU LilyPond (\S+)', version_string)
883 version_number = match.groups()[0]
884 version = version_number.split('.')
885 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
886 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
887 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
888 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
889 logger.info('+ found LilyPond version %s.' % version_number)
890 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
891 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
892 \converter lilypond png "lilypond -b eps --png $$i" ""''')
893 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
894 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
895 logger.info('+ found LilyPond version %s.' % version_number)
897 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
899 logger.info('+ found LilyPond, but could not extract version number.')
901 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
902 if (lilypond_book != ''):
903 version_string = cmdOutput("lilypond-book --version")
904 match = re.match('^(\S+)$', version_string)
906 version_number = match.groups()[0]
907 version = version_number.split('.')
908 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
909 # Note: The --lily-output-dir flag is required because lilypond-book
910 # does not process input again unless the input has changed,
911 # even if the output format being requested is different. So
912 # once a .eps file exists, lilypond-book won't create a .pdf
913 # even when requested with --pdf. This is a problem if a user
914 # clicks View PDF after having done a View DVI. To circumvent
915 # this, use different output folders for eps and pdf outputs.
916 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
917 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
918 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
919 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
920 logger.info('+ found LilyPond-book version %s.' % version_number)
922 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
924 logger.info('+ found LilyPond-book, but could not extract version number.')
926 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
927 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
929 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
930 # and a zip archive on Windows.
931 # So, we configure the appropriate version according to the platform.
932 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
934 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
935 addToRC(cmd % "lyxzip")
937 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
938 addToRC(cmd % "lyxgz")
941 # FIXME: no rc_entry? comment it out
942 # checkProg('Image converter', ['convert $$i $$o'])
944 # Entries that do not need checkProg
946 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
947 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
948 \converter docbook docbook-xml "cp $$i $$o" "xml"
949 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
950 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
951 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
952 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
953 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
954 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
955 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
956 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
957 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
958 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
959 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
960 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
961 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
962 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
967 ''' Check docbook '''
968 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
970 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
971 \converter docbook html "sgmltools -b html $$i" ""
972 \converter docbook ps "sgmltools -b ps $$i" ""''',
973 r'''\converter docbook dvi "db2dvi $$i" ""
974 \converter docbook html "db2html $$i" ""''',
975 r'''\converter docbook dvi "" ""
976 \converter docbook html "" ""''',
977 r'''\converter docbook dvi "" ""
978 \converter docbook html "" ""'''])
981 return ('yes', 'true', '\\def\\hasdocbook{yes}')
983 return ('no', 'false', '')
986 def checkOtherEntries():
987 ''' entries other than Format and Converter '''
988 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
989 rc_entry = [ r'\chktex_command "%%"' ])
990 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
991 rc_entry = [ r'\bibtex_command "%%"' ],
992 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
993 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
994 rc_entry = [ r'\jbibtex_command "%%"' ])
995 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
996 rc_entry = [ r'\index_command "%%"' ],
997 alt_rc_entry = [ r'\index_alternatives "%%"' ])
998 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
999 rc_entry = [ r'\jindex_command "%%"' ])
1000 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1001 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1002 checkProg('a nomenclature processor', ['makeindex'],
1003 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1004 ## FIXME: OCTAVE is not used anywhere
1005 # path, OCTAVE = checkProg('Octave', ['octave'])
1006 ## FIXME: MAPLE is not used anywhere
1007 # path, MAPLE = checkProg('Maple', ['maple'])
1008 checkProg('a spool command', ['lp', 'lpr'],
1010 r'''\print_spool_printerprefix "-d "
1011 \print_spool_command "lp"''',
1012 r'''\print_spool_printerprefix "-P",
1013 \print_spool_command "lpr"''',
1015 # Add the rest of the entries (no checkProg is required)
1016 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1017 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1018 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1019 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1023 def processLayoutFile(file, bool_docbook):
1024 ''' process layout file and get a line of result
1026 Declare lines look like this:
1028 \DeclareLaTeXClass[<requirements>]{<description>}
1030 Optionally, a \DeclareCategory line follows:
1032 \DeclareCategory{<category>}
1034 So for example (article.layout, scrbook.layout, svjog.layout)
1036 \DeclareLaTeXClass{article}
1037 \DeclareCategory{Articles}
1039 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1040 \DeclareCategory{Books}
1042 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1044 we'd expect this output:
1046 "article" "article" "article" "false" "article.cls" "Articles"
1047 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1048 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1050 def checkForClassExtension(x):
1051 '''if the extension for a latex class is not
1052 provided, add .cls to the classname'''
1054 return x.strip() + '.cls'
1057 classname = file.split(os.sep)[-1].split('.')[0]
1058 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1059 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1060 q = re.compile(r'\DeclareCategory{(.*)}')
1061 classdeclaration = ""
1062 categorydeclaration = '""'
1063 for line in open(file).readlines():
1064 res = p.search(line)
1065 qres = q.search(line)
1067 (classtype, optAll, opt, opt1, desc) = res.groups()
1068 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1071 prereq_latex = checkForClassExtension(classname)
1073 prereq_list = optAll[1:-1].split(',')
1074 prereq_list = map(checkForClassExtension, prereq_list)
1075 prereq_latex = ','.join(prereq_list)
1076 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1077 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1078 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1079 if categorydeclaration != '""':
1080 return classdeclaration + " " + categorydeclaration
1082 categorydeclaration = '"%s"' % (qres.groups()[0])
1083 if classdeclaration != "":
1084 return classdeclaration + " " + categorydeclaration
1085 if classdeclaration != "":
1086 return classdeclaration + " " + categorydeclaration
1087 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1091 def checkLatexConfig(check_config, bool_docbook):
1092 ''' Explore the LaTeX configuration
1093 Return None (will be passed to sys.exit()) for success.
1095 msg = 'checking LaTeX configuration... '
1096 # if --without-latex-config is forced, or if there is no previous
1097 # version of textclass.lst, re-generate a default file.
1098 if not os.path.isfile('textclass.lst') or not check_config:
1099 # remove the files only if we want to regenerate
1100 removeFiles(['textclass.lst', 'packages.lst'])
1102 # Then, generate a default textclass.lst. In case configure.py
1103 # fails, we still have something to start lyx.
1104 logger.info(msg + ' default values')
1105 logger.info('+checking list of textclasses... ')
1106 tx = open('textclass.lst', 'w')
1108 # This file declares layouts and their associated definition files
1109 # (include dir. relative to the place where this file is).
1110 # It contains only default values, since chkconfig.ltx could not be run
1111 # for some reason. Run ./configure.py if you need to update it after a
1112 # configuration change.
1114 # build the list of available layout files and convert it to commands
1117 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1118 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1120 if not os.path.isfile(file):
1122 # get stuff between /xxxx.layout .
1123 classname = file.split(os.sep)[-1].split('.')[0]
1125 cleanclass = classname.replace(' ', '_')
1126 cleanclass = cleanclass.replace('-', '_')
1127 # make sure the same class is not considered twice
1128 if foundClasses.count(cleanclass) == 0: # not found before
1129 foundClasses.append(cleanclass)
1130 retval = processLayoutFile(file, bool_docbook)
1134 logger.info('\tdone')
1135 if not os.path.isfile('packages.lst') or not check_config:
1136 logger.info('+generating default list of packages... ')
1137 removeFiles(['packages.lst'])
1138 tx = open('packages.lst', 'w')
1140 logger.info('\tdone')
1141 if not check_config:
1143 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1144 logger.info(msg + '\tauto')
1145 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1146 'wrap_chkconfig.ltx'])
1148 if not os.path.isfile( 'chkconfig.ltx' ):
1149 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1151 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1152 # Construct the list of classes to test for.
1153 # build the list of available layout files and convert it to commands
1155 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1156 category = re.compile(r'\DeclareCategory{(.*)}')
1157 empty = re.compile(r'^\s*$')
1158 testclasses = list()
1159 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1160 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1161 nodeclaration = False
1162 if not os.path.isfile(file):
1164 classname = file.split(os.sep)[-1].split('.')[0]
1167 for line in open(file).readlines():
1168 if not empty.match(line) and line[0] != '#':
1170 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1171 nodeclaration = True
1172 # A class, but no category declaration. Just break.
1174 if declare.search(line) != None:
1175 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1176 testclasses.append(decline)
1177 elif category.search(line) != None:
1178 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1179 testclasses.append(catline)
1180 if catline == "" or decline == "":
1186 cl = open('chklayouts.tex', 'w')
1187 for line in testclasses:
1188 cl.write(line + '\n')
1191 # we have chklayouts.tex, then process it
1192 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1194 line = latex_out.readline()
1197 if re.match('^\+', line):
1198 logger.info(line.strip())
1199 # if the command succeeds, None will be returned
1200 ret = latex_out.close()
1202 # remove the copied file
1204 removeFiles( [ 'chkconfig.ltx' ] )
1206 # currently, values in chkconfig are only used to set
1209 for line in open('chkconfig.vars').readlines():
1210 key, val = re.sub('-', '_', line).split('=')
1212 values[key] = val.strip("'")
1213 # chk_fontenc may not exist
1215 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1218 # if configure successed, move textclass.lst.tmp to textclass.lst
1219 # and packages.lst.tmp to packages.lst
1220 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1221 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1222 shutil.move('textclass.lst.tmp', 'textclass.lst')
1223 shutil.move('packages.lst.tmp', 'packages.lst')
1227 def checkModulesConfig():
1228 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1230 logger.info('+checking list of modules... ')
1231 tx = open('lyxmodules.lst', 'w')
1232 tx.write('''## This file declares modules and their associated definition files.
1233 ## It has been automatically generated by configure
1234 ## Use "Options/Reconfigure" if you need to update it after a
1235 ## configuration change.
1236 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1239 # build the list of available modules
1241 # note that this searches the local directory first, then the
1242 # system directory. that way, we pick up the user's version first.
1243 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1244 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1247 if not os.path.isfile(file):
1250 filename = file.split(os.sep)[-1]
1251 filename = filename[:-7]
1252 if seen.count(filename):
1255 seen.append(filename)
1256 retval = processModuleFile(file, filename, bool_docbook)
1260 logger.info('\tdone')
1263 def processModuleFile(file, filename, bool_docbook):
1264 ''' process module file and get a line of result
1266 The top of a module file should look like this:
1267 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1269 #...body of description...
1271 #Requires: [list of required modules]
1272 #Excludes: [list of excluded modules]
1273 #Category: [category name]
1274 The last three lines are optional (though do give a category).
1276 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1278 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1279 rereqs = re.compile(r'#+\s*Requires: (.*)')
1280 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1281 recaty = re.compile(r'#+\s*Category: (.*)')
1282 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1283 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1285 modname = desc = pkgs = req = excl = catgy = ""
1286 readingDescription = False
1289 for line in open(file).readlines():
1290 if readingDescription:
1291 res = redend.search(line)
1293 readingDescription = False
1294 desc = " ".join(descLines)
1296 desc = desc.replace('"', '\\"')
1298 descLines.append(line[1:].strip())
1300 res = redbeg.search(line)
1302 readingDescription = True
1304 res = remods.search(line)
1306 (pkgs, modname) = res.groups()
1310 tmp = [s.strip() for s in pkgs.split(",")]
1311 pkgs = ",".join(tmp)
1313 res = rereqs.search(line)
1316 tmp = [s.strip() for s in req.split("|")]
1319 res = reexcs.search(line)
1322 tmp = [s.strip() for s in excl.split("|")]
1323 excl = "|".join(tmp)
1325 res = recaty.search(line)
1327 catgy = res.group(1)
1331 logger.warning("Module file without \DeclareLyXModule line. ")
1335 # this module has some latex dependencies:
1336 # append the dependencies to chkmodules.tex,
1337 # which is \input'ed by chkconfig.ltx
1338 testpackages = list()
1339 for pkg in pkgs.split(","):
1341 # this is a converter dependency: skip
1343 if pkg.endswith(".sty"):
1345 testpackages.append("\\TestPackage{%s}" % (pkg,))
1346 cm = open('chkmodules.tex', 'a')
1347 for line in testpackages:
1348 cm.write(line + '\n')
1351 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1354 def checkTeXAllowSpaces():
1355 ''' Let's check whether spaces are allowed in TeX file names '''
1356 tex_allows_spaces = 'false'
1357 if lyx_check_config:
1358 msg = "Checking whether TeX allows spaces in file names... "
1359 writeToFile('a b.tex', r'\message{working^^J}' )
1361 if os.name == 'nt' or sys.platform == 'cygwin':
1362 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1364 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1367 if 'working' in latex_out:
1368 logger.info(msg + 'yes')
1369 tex_allows_spaces = 'true'
1371 logger.info(msg + 'no')
1372 tex_allows_spaces = 'false'
1373 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1374 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1377 def rescanTeXFiles():
1378 ''' Run kpsewhich to update information about TeX files '''
1379 logger.info("+Indexing TeX files... ")
1380 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1381 logger.error("configure: error: cannot find TeXFiles.py script")
1383 tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1385 logger.info("\tdone")
1388 def removeTempFiles():
1390 if not lyx_keep_temps:
1391 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1392 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1393 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1396 if __name__ == '__main__':
1397 lyx_check_config = True
1398 lyx_kpsewhich = True
1399 outfile = 'lyxrc.defaults'
1400 lyxrc_fileformat = 11
1402 lyx_keep_temps = False
1405 ## Parse the command line
1406 for op in sys.argv[1:]: # default shell/for list is $*, the options
1407 if op in [ '-help', '--help', '-h' ]:
1408 print '''Usage: configure [options]
1410 --help show this help lines
1411 --keep-temps keep temporary files (for debug. purposes)
1412 --without-kpsewhich do not update TeX files information via kpsewhich
1413 --without-latex-config do not run LaTeX to determine configuration
1414 --with-version-suffix=suffix suffix of binary installed files
1415 --binary-dir=directory directory of binary installed files
1418 elif op == '--without-kpsewhich':
1419 lyx_kpsewhich = False
1420 elif op == '--without-latex-config':
1421 lyx_check_config = False
1422 elif op == '--keep-temps':
1423 lyx_keep_temps = True
1424 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1425 version_suffix = op[22:]
1426 elif op[0:13] == '--binary-dir=':
1427 lyx_binary_dir = op[13:]
1429 print "Unknown option", op
1432 # check if we run from the right directory
1433 srcdir = os.path.dirname(sys.argv[0])
1436 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1437 logger.error("configure: error: cannot find chkconfig.ltx script")
1441 dtl_tools = checkDTLtools()
1442 ## Write the first part of outfile
1443 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1444 # script. It contains default settings that have been determined by
1445 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1446 # want to customize LyX, use LyX' Preferences dialog or modify directly
1447 # the "preferences" file instead. Any setting in that file will
1448 # override the values given here.
1452 ''' % lyxrc_fileformat)
1454 LATEX = checkLatex(dtl_tools)
1455 # check java and perl before any checkProg that may require them
1456 java = checkProg('a java interpreter', ['java'])[1]
1457 perl = checkProg('a perl interpreter', ['perl'])[1]
1458 checkFormatEntries(dtl_tools)
1459 checkConverterEntries()
1460 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1461 checkTeXAllowSpaces()
1462 windows_style_tex_paths = checkTeXPaths()
1463 if windows_style_tex_paths != '':
1464 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1468 checkModulesConfig()
1469 # --without-latex-config can disable lyx_check_config
1470 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1472 # The return error code can be 256. Because most systems expect an error code
1473 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1474 # a None for success, 'ret is not None' is used to exit.
1475 sys.exit(ret is not None)