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 "%%" ""
663 \converter literate luatex "%%" ""'''])
665 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
666 rc_entry = [r'''\converter sweave latex "%%" ""
667 \converter sweave pdflatex "%%" ""
668 \converter sweave xetex "%%" ""
669 \converter sweave luatex "%%" ""'''])
671 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
672 rc_entry = [r'''\converter knitr latex "%%" ""
673 \converter knitr pdflatex "%%" ""
674 \converter knitr xetex "%%" ""
675 \converter knitr luatex "%%" ""'''])
677 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
678 rc_entry = [ r'\converter sweave r "%%" ""' ])
680 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
681 rc_entry = [ r'\converter knitr r "%%" ""' ])
683 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i',
684 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
685 rc_entry = [ r'\converter html latex "%%" ""' ])
687 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
688 rc_entry = [ r'\converter word latex "%%" ""' ])
690 # eLyXer: search as an executable (elyxer.py, elyxer)
691 path, elyxer = checkProg('a LyX -> HTML converter',
692 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
693 rc_entry = [ r'\converter lyx html "%%" ""' ])
694 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
695 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
696 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
697 if elyxer.find('elyxer') >= 0:
698 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
699 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
701 # search for HTML converters other than eLyXer
702 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
703 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
704 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
705 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
706 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
707 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
708 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
710 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
711 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
712 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
713 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
714 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
715 if htmlconv.find('htlatex') >= 0:
716 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
718 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
721 # Check if LyXBlogger is installed
722 lyxblogger_found = checkModule('lyxblogger')
724 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
725 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
728 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
729 rc_entry = [ r'\converter sxw latex "%%" ""' ])
731 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
732 rc_entry = [ r'\converter odt latex "%%" ""' ])
734 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
735 rc_entry = [ r'\converter odt pdf "%%" ""' ])
736 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
737 # the command mk4ht oolatex $$i has to be used as default,
738 # but as this would require to have Perl installed, in MiKTeX oolatex is
739 # directly available as application.
740 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
741 # Both SuSE and debian have oolatex
742 checkProg('a LaTeX -> Open Document converter', [
743 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
744 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
745 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
746 # On windows it is called latex2rt.exe
747 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
748 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
750 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
751 rc_entry = [ r'\converter rtf html "%%" ""' ])
753 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
754 rc_entry = [ r'\converter ps pdf "%%" ""' ])
756 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
757 rc_entry = [ r'\converter ps text2 "%%" ""' ])
759 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
760 rc_entry = [ r'\converter ps text3 "%%" ""' ])
761 # Need to call ps2eps in a pipe, otherwise it would name the output file
762 # depending on the extension of the input file. We do not know the input
763 # file extension in general, so the resultfile= flag would not help.
764 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
765 # This would create additional paths in the converter graph with unwanted
766 # side effects (e.g. ps->pdf via ps2pdf would create a different result
767 # than ps->eps->pdf via ps2eps and epstopdf).
768 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
769 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
771 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
772 rc_entry = [ r'\converter pdf ps "%%" ""' ])
774 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
775 rc_entry = [ r'\converter pdf eps "%%" ""' ])
777 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
778 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
780 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
781 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
783 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
784 rc_entry = [ r'\converter dvi ps "%%" ""' ])
786 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
787 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
789 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
790 rc_entry = [ r'\converter ps fax "%%" ""'])
792 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
793 if fig2dev == "fig2dev":
794 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
795 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
796 \converter fig png "fig2dev -L png $$i $$o" ""
797 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
798 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
800 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
801 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
803 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
805 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
806 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
807 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
810 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
811 rc_entry = [ r'\converter wmf eps "%%" ""'])
813 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
814 rc_entry = [ r'\converter emf eps "%%" ""'])
816 checkProg('an EPS -> PDF converter', ['epstopdf'],
817 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
819 checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
820 rc_entry = [ r'\converter eps png "%%" ""', ''])
822 # no agr -> pdf converter, since the pdf library used by gracebat is not
823 # free software and therefore not compiled in in many installations.
824 # Fortunately, this is not a big problem, because we will use epstopdf to
825 # convert from agr to pdf via eps without loss of quality.
826 checkProg('a Grace -> Image converter', ['gracebat'],
828 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
829 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
830 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
831 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
834 checkProg('a Dot -> Image converter', ['dot'],
836 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
837 \converter dot png "dot -Tpng $$i -o $$o" ""''',
840 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
841 rc_entry = [ r'\converter dia png "%%" ""'])
843 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
844 rc_entry = [ r'\converter dia eps "%%" ""'])
845 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
846 # The eps2->eps converter then fixes the bounding box by cropping.
847 # Although unoconv can convert to png and pdf as well, do not define
848 # odg->png and odg->pdf converters, since the bb would be too large as well.
849 checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
850 rc_entry = [ r'\converter odg eps2 "%%" ""'])
852 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
853 rc_entry = [ r'\converter svg pdf "%%" ""'])
855 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
856 rc_entry = [ r'\converter svg eps "%%" ""'])
858 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
859 rc_entry = [ r'\converter svg png "%%" ""'])
862 # gnumeric/xls/ods to tex
863 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
864 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
865 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
866 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
869 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
871 version_string = cmdOutput("lilypond --version")
872 match = re.match('GNU LilyPond (\S+)', version_string)
874 version_number = match.groups()[0]
875 version = version_number.split('.')
876 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
877 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
878 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
879 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
880 logger.info('+ found LilyPond version %s.' % version_number)
881 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
882 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
883 \converter lilypond png "lilypond -b eps --png $$i" ""''')
884 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
885 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf --safe $$i" ""')
886 logger.info('+ found LilyPond version %s.' % version_number)
888 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
890 logger.info('+ found LilyPond, but could not extract version number.')
892 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
893 if (lilypond_book != ''):
894 version_string = cmdOutput("lilypond-book --version")
895 match = re.match('^(\S+)$', version_string)
897 version_number = match.groups()[0]
898 version = version_number.split('.')
899 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
900 # Note: The --lily-output-dir flag is required because lilypond-book
901 # does not process input again unless the input has changed,
902 # even if the output format being requested is different. So
903 # once a .eps file exists, lilypond-book won't create a .pdf
904 # even when requested with --pdf. This is a problem if a user
905 # clicks View PDF after having done a View DVI. To circumvent
906 # this, use different output folders for eps and pdf outputs.
907 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
908 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
909 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
910 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
911 logger.info('+ found LilyPond-book version %s.' % version_number)
913 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
915 logger.info('+ found LilyPond-book, but could not extract version number.')
917 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
918 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
920 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
921 # and a zip archive on Windows.
922 # So, we configure the appropriate version according to the platform.
923 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
925 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
926 addToRC(cmd % "lyxzip")
928 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
929 addToRC(cmd % "lyxgz")
932 # FIXME: no rc_entry? comment it out
933 # checkProg('Image converter', ['convert $$i $$o'])
935 # Entries that do not need checkProg
937 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
938 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
939 \converter docbook docbook-xml "cp $$i $$o" "xml"
940 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
941 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
942 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
943 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
944 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
945 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
946 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
947 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
948 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
949 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
950 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
951 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
952 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
953 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
958 ''' Check docbook '''
959 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
961 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
962 \converter docbook html "sgmltools -b html $$i" ""''',
963 r'''\converter docbook dvi "db2dvi $$i" ""
964 \converter docbook html "db2html $$i" ""''',
965 r'''\converter docbook dvi "" ""
966 \converter docbook html "" ""''',
967 r'''\converter docbook dvi "" ""
968 \converter docbook html "" ""'''])
971 return ('yes', 'true', '\\def\\hasdocbook{yes}')
973 return ('no', 'false', '')
976 def checkOtherEntries():
977 ''' entries other than Format and Converter '''
978 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
979 rc_entry = [ r'\chktex_command "%%"' ])
980 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
981 rc_entry = [ r'\bibtex_command "%%"' ],
982 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
983 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
984 rc_entry = [ r'\jbibtex_command "%%"' ])
985 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
986 rc_entry = [ r'\index_command "%%"' ],
987 alt_rc_entry = [ r'\index_alternatives "%%"' ])
988 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
989 rc_entry = [ r'\jindex_command "%%"' ])
990 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
991 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
992 checkProg('a nomenclature processor', ['makeindex'],
993 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
994 ## FIXME: OCTAVE is not used anywhere
995 # path, OCTAVE = checkProg('Octave', ['octave'])
996 ## FIXME: MAPLE is not used anywhere
997 # path, MAPLE = checkProg('Maple', ['maple'])
998 checkProg('a spool command', ['lp', 'lpr'],
1000 r'''\print_spool_printerprefix "-d "
1001 \print_spool_command "lp"''',
1002 r'''\print_spool_printerprefix "-P",
1003 \print_spool_command "lpr"''',
1005 # Add the rest of the entries (no checkProg is required)
1006 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1007 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1008 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1009 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1013 def processLayoutFile(file, bool_docbook):
1014 ''' process layout file and get a line of result
1016 Declare lines look like this:
1018 \DeclareLaTeXClass[<requirements>]{<description>}
1020 Optionally, a \DeclareCategory line follows:
1022 \DeclareCategory{<category>}
1024 So for example (article.layout, scrbook.layout, svjog.layout)
1026 \DeclareLaTeXClass{article}
1027 \DeclareCategory{Articles}
1029 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1030 \DeclareCategory{Books}
1032 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1034 we'd expect this output:
1036 "article" "article" "article" "false" "article.cls" "Articles"
1037 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1038 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1040 def checkForClassExtension(x):
1041 '''if the extension for a latex class is not
1042 provided, add .cls to the classname'''
1044 return x.strip() + '.cls'
1047 classname = file.split(os.sep)[-1].split('.')[0]
1048 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1049 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1050 q = re.compile(r'\DeclareCategory{(.*)}')
1051 classdeclaration = ""
1052 categorydeclaration = '""'
1053 for line in open(file).readlines():
1054 res = p.search(line)
1055 qres = q.search(line)
1057 (classtype, optAll, opt, opt1, desc) = res.groups()
1058 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1061 prereq_latex = checkForClassExtension(classname)
1063 prereq_list = optAll[1:-1].split(',')
1064 prereq_list = map(checkForClassExtension, prereq_list)
1065 prereq_latex = ','.join(prereq_list)
1066 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1067 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1068 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1069 if categorydeclaration != '""':
1070 return classdeclaration + " " + categorydeclaration
1072 categorydeclaration = '"%s"' % (qres.groups()[0])
1073 if classdeclaration != "":
1074 return classdeclaration + " " + categorydeclaration
1075 if classdeclaration != "":
1076 return classdeclaration + " " + categorydeclaration
1077 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1081 def checkLatexConfig(check_config, bool_docbook):
1082 ''' Explore the LaTeX configuration
1083 Return None (will be passed to sys.exit()) for success.
1085 msg = 'checking LaTeX configuration... '
1086 # if --without-latex-config is forced, or if there is no previous
1087 # version of textclass.lst, re-generate a default file.
1088 if not os.path.isfile('textclass.lst') or not check_config:
1089 # remove the files only if we want to regenerate
1090 removeFiles(['textclass.lst', 'packages.lst'])
1092 # Then, generate a default textclass.lst. In case configure.py
1093 # fails, we still have something to start lyx.
1094 logger.info(msg + ' default values')
1095 logger.info('+checking list of textclasses... ')
1096 tx = open('textclass.lst', 'w')
1098 # This file declares layouts and their associated definition files
1099 # (include dir. relative to the place where this file is).
1100 # It contains only default values, since chkconfig.ltx could not be run
1101 # for some reason. Run ./configure.py if you need to update it after a
1102 # configuration change.
1104 # build the list of available layout files and convert it to commands
1107 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1108 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1110 if not os.path.isfile(file):
1112 # get stuff between /xxxx.layout .
1113 classname = file.split(os.sep)[-1].split('.')[0]
1115 cleanclass = classname.replace(' ', '_')
1116 cleanclass = cleanclass.replace('-', '_')
1117 # make sure the same class is not considered twice
1118 if foundClasses.count(cleanclass) == 0: # not found before
1119 foundClasses.append(cleanclass)
1120 retval = processLayoutFile(file, bool_docbook)
1124 logger.info('\tdone')
1125 if not os.path.isfile('packages.lst') or not check_config:
1126 logger.info('+generating default list of packages... ')
1127 removeFiles(['packages.lst'])
1128 tx = open('packages.lst', 'w')
1130 logger.info('\tdone')
1131 if not check_config:
1133 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1134 logger.info(msg + '\tauto')
1135 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1136 'wrap_chkconfig.ltx'])
1138 if not os.path.isfile( 'chkconfig.ltx' ):
1139 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1141 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1142 # Construct the list of classes to test for.
1143 # build the list of available layout files and convert it to commands
1145 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1146 category = re.compile(r'\DeclareCategory{(.*)}')
1147 empty = re.compile(r'^\s*$')
1148 testclasses = list()
1149 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1150 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1151 nodeclaration = False
1152 if not os.path.isfile(file):
1154 classname = file.split(os.sep)[-1].split('.')[0]
1157 for line in open(file).readlines():
1158 if not empty.match(line) and line[0] != '#':
1160 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1161 nodeclaration = True
1162 # A class, but no category declaration. Just break.
1164 if declare.search(line) != None:
1165 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1166 testclasses.append(decline)
1167 elif category.search(line) != None:
1168 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1169 testclasses.append(catline)
1170 if catline == "" or decline == "":
1176 cl = open('chklayouts.tex', 'w')
1177 for line in testclasses:
1178 cl.write(line + '\n')
1181 # we have chklayouts.tex, then process it
1182 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1184 line = latex_out.readline()
1187 if re.match('^\+', line):
1188 logger.info(line.strip())
1189 # if the command succeeds, None will be returned
1190 ret = latex_out.close()
1192 # remove the copied file
1194 removeFiles( [ 'chkconfig.ltx' ] )
1196 # currently, values in chkconfig are only used to set
1199 for line in open('chkconfig.vars').readlines():
1200 key, val = re.sub('-', '_', line).split('=')
1202 values[key] = val.strip("'")
1203 # chk_fontenc may not exist
1205 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1208 # if configure successed, move textclass.lst.tmp to textclass.lst
1209 # and packages.lst.tmp to packages.lst
1210 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1211 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1212 shutil.move('textclass.lst.tmp', 'textclass.lst')
1213 shutil.move('packages.lst.tmp', 'packages.lst')
1217 def checkModulesConfig():
1218 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1220 logger.info('+checking list of modules... ')
1221 tx = open('lyxmodules.lst', 'w')
1222 tx.write('''## This file declares modules and their associated definition files.
1223 ## It has been automatically generated by configure
1224 ## Use "Options/Reconfigure" if you need to update it after a
1225 ## configuration change.
1226 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1229 # build the list of available modules
1231 # note that this searches the local directory first, then the
1232 # system directory. that way, we pick up the user's version first.
1233 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1234 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1237 if not os.path.isfile(file):
1240 filename = file.split(os.sep)[-1]
1241 filename = filename[:-7]
1242 if seen.count(filename):
1245 seen.append(filename)
1246 retval = processModuleFile(file, filename, bool_docbook)
1250 logger.info('\tdone')
1253 def processModuleFile(file, filename, bool_docbook):
1254 ''' process module file and get a line of result
1256 The top of a module file should look like this:
1257 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1259 #...body of description...
1261 #Requires: [list of required modules]
1262 #Excludes: [list of excluded modules]
1263 #Category: [category name]
1264 The last three lines are optional (though do give a category).
1266 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1268 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1269 rereqs = re.compile(r'#+\s*Requires: (.*)')
1270 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1271 recaty = re.compile(r'#+\s*Category: (.*)')
1272 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1273 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1275 modname = desc = pkgs = req = excl = catgy = ""
1276 readingDescription = False
1279 for line in open(file).readlines():
1280 if readingDescription:
1281 res = redend.search(line)
1283 readingDescription = False
1284 desc = " ".join(descLines)
1286 desc = desc.replace('"', '\\"')
1288 descLines.append(line[1:].strip())
1290 res = redbeg.search(line)
1292 readingDescription = True
1294 res = remods.search(line)
1296 (pkgs, modname) = res.groups()
1300 tmp = [s.strip() for s in pkgs.split(",")]
1301 pkgs = ",".join(tmp)
1303 res = rereqs.search(line)
1306 tmp = [s.strip() for s in req.split("|")]
1309 res = reexcs.search(line)
1312 tmp = [s.strip() for s in excl.split("|")]
1313 excl = "|".join(tmp)
1315 res = recaty.search(line)
1317 catgy = res.group(1)
1321 logger.warning("Module file without \DeclareLyXModule line. ")
1325 # this module has some latex dependencies:
1326 # append the dependencies to chkmodules.tex,
1327 # which is \input'ed by chkconfig.ltx
1328 testpackages = list()
1329 for pkg in pkgs.split(","):
1331 # this is a converter dependency: skip
1333 if pkg.endswith(".sty"):
1335 testpackages.append("\\TestPackage{%s}" % (pkg,))
1336 cm = open('chkmodules.tex', 'a')
1337 for line in testpackages:
1338 cm.write(line + '\n')
1341 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1344 def checkTeXAllowSpaces():
1345 ''' Let's check whether spaces are allowed in TeX file names '''
1346 tex_allows_spaces = 'false'
1347 if lyx_check_config:
1348 msg = "Checking whether TeX allows spaces in file names... "
1349 writeToFile('a b.tex', r'\message{working^^J}' )
1351 if os.name == 'nt' or sys.platform == 'cygwin':
1352 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1354 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1357 if 'working' in latex_out:
1358 logger.info(msg + 'yes')
1359 tex_allows_spaces = 'true'
1361 logger.info(msg + 'no')
1362 tex_allows_spaces = 'false'
1363 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1364 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1367 def rescanTeXFiles():
1368 ''' Run kpsewhich to update information about TeX files '''
1369 logger.info("+Indexing TeX files... ")
1370 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1371 logger.error("configure: error: cannot find TeXFiles.py script")
1373 tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1375 logger.info("\tdone")
1378 def removeTempFiles():
1380 if not lyx_keep_temps:
1381 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1382 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1383 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1386 if __name__ == '__main__':
1387 lyx_check_config = True
1388 lyx_kpsewhich = True
1389 outfile = 'lyxrc.defaults'
1390 lyxrc_fileformat = 7
1392 lyx_keep_temps = False
1394 ## Parse the command line
1395 for op in sys.argv[1:]: # default shell/for list is $*, the options
1396 if op in [ '-help', '--help', '-h' ]:
1397 print '''Usage: configure [options]
1399 --help show this help lines
1400 --keep-temps keep temporary files (for debug. purposes)
1401 --without-kpsewhich do not update TeX files information via kpsewhich
1402 --without-latex-config do not run LaTeX to determine configuration
1403 --with-version-suffix=suffix suffix of binary installed files
1406 elif op == '--without-kpsewhich':
1407 lyx_kpsewhich = False
1408 elif op == '--without-latex-config':
1409 lyx_check_config = False
1410 elif op == '--keep-temps':
1411 lyx_keep_temps = True
1412 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1413 version_suffix = op[22:]
1415 print "Unknown option", op
1418 # check if we run from the right directory
1419 srcdir = os.path.dirname(sys.argv[0])
1422 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1423 logger.error("configure: error: cannot find chkconfig.ltx script")
1427 dtl_tools = checkDTLtools()
1428 ## Write the first part of outfile
1429 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1430 # script. It contains default settings that have been determined by
1431 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1432 # want to customize LyX, use LyX' Preferences dialog or modify directly
1433 # the "preferences" file instead. Any setting in that file will
1434 # override the values given here.
1438 ''' % lyxrc_fileformat)
1440 LATEX = checkLatex(dtl_tools)
1441 # check java and perl before any checkProg that may require them
1442 java = checkProg('a java interpreter', ['java'])[1]
1443 perl = checkProg('a perl interpreter', ['perl'])[1]
1444 checkFormatEntries(dtl_tools)
1445 checkConverterEntries()
1446 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1447 checkTeXAllowSpaces()
1448 windows_style_tex_paths = checkTeXPaths()
1449 if windows_style_tex_paths != '':
1450 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1454 checkModulesConfig()
1455 # --without-latex-config can disable lyx_check_config
1456 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1458 # The return error code can be 256. Because most systems expect an error code
1459 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1460 # a None for success, 'ret is not None' is used to exit.
1461 sys.exit(ret is not None)