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