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 sys, os, re, shutil, glob, logging
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)
60 '''utility function: run a command and get its output as a string
70 ''' I do not really know why this is useful, but we might as well keep it.
72 Only set these to C if already set. These must not be set unconditionally
73 because not all systems understand e.g. LANG=C (notably SCO).
74 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
75 Non-C LC_CTYPE values break the ctype check.
77 os.environ['LANG'] = os.getenv('LANG', 'C')
78 os.environ['LC'] = os.getenv('LC_ALL', 'C')
79 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
80 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
83 def createDirectories():
84 ''' Create the build directories if necessary '''
85 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
86 'layouts', 'scripts', 'templates', 'ui' ]:
87 if not os.path.isdir( dir ):
90 logger.debug('Create directory %s.' % dir)
92 logger.error('Failed to create directory %s.' % dir)
97 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
98 windows_style_tex_paths = ''
99 if os.name == 'nt' or sys.platform == 'cygwin':
100 from tempfile import mkstemp
101 fd, tmpfname = mkstemp(suffix='.ltx')
103 inpname = tmpfname.replace('\\', '/')
105 inpname = cmdOutput('cygpath -m ' + tmpfname)
106 logname = os.path.basename(inpname.replace('.ltx', '.log'))
107 inpname = inpname.replace('~', '\\string~')
108 os.write(fd, r'\relax')
110 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
111 if 'Error' in latex_out:
112 logger.warning("configure: TeX engine needs posix-style paths in latex files")
113 windows_style_tex_paths = 'false'
115 logger.info("configure: TeX engine needs windows-style paths in latex files")
116 windows_style_tex_paths = 'true'
117 removeFiles([tmpfname, logname, 'texput.log'])
118 return windows_style_tex_paths
121 ## Searching some useful programs
122 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
124 This function will search a program in $PATH plus given path
125 If found, return directory and program name (not the options).
127 description: description of the program
129 progs: check programs, for each prog, the first word is used
130 for searching but the whole string is used to replace
131 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
133 path: additional pathes
135 rc_entry: entry to outfile, can be
136 1. emtpy: no rc entry will be added
137 2. one pattern: %% will be replaced by the first found program,
138 or '' if no program is found.
139 3. several patterns for each prog and not_found. This is used
140 when different programs have different usages. If you do not
141 want not_found entry to be added to the RC file, you can specify
142 an entry for each prog and use '' for the not_found entry.
144 not_found: the value that should be used instead of '' if no program
148 # one rc entry for each progs plus not_found entry
149 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
150 logger.error("rc entry should have one item or item for each prog and not_found.")
152 logger.info('checking for ' + description + '...')
153 ## print '(' + ','.join(progs) + ')',
154 for idx in range(len(progs)):
155 # ac_prog may have options, ac_word is the command name
157 ac_word = ac_prog.split(' ')[0]
158 msg = '+checking for "' + ac_word + '"... '
159 path = os.environ["PATH"].split(os.pathsep) + path
161 if os.environ.has_key("PATHEXT"):
162 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
165 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
166 logger.info(msg + ' yes')
167 # write rc entries for this command
168 if len(rc_entry) == 1:
169 addToRC(rc_entry[0].replace('%%', ac_prog))
170 elif len(rc_entry) > 1:
171 addToRC(rc_entry[idx].replace('%%', ac_prog))
172 return [ac_dir, ac_word]
174 logger.info(msg + ' no')
175 # write rc entries for 'not found'
176 if len(rc_entry) > 0: # the last one.
177 addToRC(rc_entry[-1].replace('%%', not_found))
178 return ['', not_found]
181 ## Searching some useful programs
182 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
184 The same as checkProg, but additionally, all found programs will be added
187 # one rc entry for each progs plus not_found entry
188 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
189 logger.error("rc entry should have one item or item for each prog and not_found.")
191 # check if alt rcs are given
192 if len(alt_rc_entry) > 1 and len(alt_rc_entry) != len(rc_entry):
193 logger.error("invalid alt_rc_entry specification.")
195 logger.info('checking for ' + description + '...')
196 ## print '(' + ','.join(progs) + ')',
199 real_ac_word = not_found
200 for idx in range(len(progs)):
201 # ac_prog may have options, ac_word is the command name
203 ac_word = ac_prog.split(' ')[0]
204 msg = '+checking for "' + ac_word + '"... '
205 path = os.environ["PATH"].split(os.pathsep) + path
207 if os.environ.has_key("PATHEXT"):
208 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
212 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
213 logger.info(msg + ' yes')
214 # write rc entries for this command
215 if found_prime == False:
216 if len(rc_entry) == 1:
217 addToRC(rc_entry[0].replace('%%', ac_prog))
218 elif len(rc_entry) > 1:
219 addToRC(rc_entry[idx].replace('%%', ac_prog))
221 real_ac_word = ac_word
223 if len(alt_rc_entry) == 1:
224 addToRC(alt_rc_entry[0].replace('%%', ac_prog))
225 elif len(alt_rc_entry) > 1:
226 addToRC(alt_rc_entry[idx].replace('%%', ac_prog))
231 if found_alt == False:
233 logger.info(msg + ' no')
235 return [real_ac_dir, real_ac_word]
236 # write rc entries for 'not found'
237 if len(rc_entry) > 0: # the last one.
238 addToRC(rc_entry[-1].replace('%%', not_found))
239 return ['', not_found]
242 def checkViewer(description, progs, rc_entry = [], path = []):
243 ''' The same as checkProg, but for viewers and editors '''
244 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
248 ''' Check whether DTL tools are available (Windows only) '''
249 # Find programs! Returned path is not used now
250 if ((os.name == 'nt' or sys.platform == 'cygwin') and
251 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
252 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
259 def checkLatex(dtl_tools):
260 ''' Check latex, return lyx_check_config '''
261 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
262 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
263 #-----------------------------------------------------------------
264 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
266 # check if PLATEX is pLaTeX2e
267 writeToFile('chklatex.ltx', '''
271 # run platex on chklatex.ltx and check result
272 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
273 # We have the Japanese pLaTeX2e
274 addToRC(r'\converter platex dvi "%s" "latex"' % PLATEX)
278 removeFiles(['chklatex.ltx', 'chklatex.log'])
279 #-----------------------------------------------------------------
280 # use LATEX to convert from latex to dvi if PPLATEX is not available
284 # Windows only: DraftDVI
285 addToRC(r'''\converter latex dvi2 "%s" "latex"
286 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
288 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
291 # Check if latex is usable
292 writeToFile('chklatex.ltx', '''
293 \\nonstopmode\\makeatletter
294 \\ifx\\undefined\\documentclass\\else
295 \\message{ThisIsLaTeX2e}
299 # run latex on chklatex.ltx and check result
300 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
304 logger.warning("Latex not usable (not LaTeX2e) ")
305 # remove temporary files
306 removeFiles(['chklatex.ltx', 'chklatex.log'])
310 def checkFormatEntries(dtl_tools):
311 ''' Check all formats (\Format entries) '''
312 checkViewer('a Tgif viewer and editor', ['tgif'],
313 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
315 checkViewer('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
316 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
318 checkViewer('a Dia viewer and editor', ['dia'],
319 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector"'])
321 checkViewer('a Grace viewer and editor', ['xmgrace'],
322 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
324 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
325 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
327 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
328 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
329 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
330 \Format gif gif GIF "" "%s" "%s" ""
331 \Format jpg jpg JPEG "" "%s" "%s" ""
332 \Format pbm pbm PBM "" "%s" "%s" ""
333 \Format pgm pgm PGM "" "%s" "%s" ""
334 \Format png png PNG "" "%s" "%s" ""
335 \Format ppm ppm PPM "" "%s" "%s" ""
336 \Format tiff tif TIFF "" "%s" "%s" ""
337 \Format xbm xbm XBM "" "%s" "%s" ""
338 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
339 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
341 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
342 'nedit', 'gedit', 'notepad'],
343 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
344 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
345 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
346 \Format dateout tmp "date (output)" "" "" "%%" ""
347 \Format docbook sgml DocBook B "" "%%" "document"
348 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
349 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
350 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
351 \Format literate nw NoWeb N "" "%%" "document"
352 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
353 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
354 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
355 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document"
356 \Format text txt "Plain text" a "" "%%" "document"
357 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
358 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
359 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
360 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
362 checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
363 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
364 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
365 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
366 'nedit', 'gedit', 'notepad'],
367 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
369 #checkProg('a Postscript interpreter', ['gs'],
370 # rc_entry = [ r'\ps_command "%%"' ])
371 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
372 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
373 \Format ps ps Postscript t "%%" "" "document,vector"'''])
375 checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
377 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
378 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
379 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"
380 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector"'''])
382 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular'],
383 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
385 # Windows only: DraftDVI
386 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
388 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
389 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
391 checkViewer('Noteedit', ['noteedit'],
392 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
394 checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
395 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
397 # entried that do not need checkProg
398 addToRC(r'''\Format date "" "date command" "" "" "" ""
399 \Format csv csv "Table (CSV)" "" "" "" "document"
400 \Format fax "" Fax "" "" "" "document"
401 \Format lyx lyx LyX "" "" "" ""
402 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
403 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
404 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
405 \Format lyx16x lyx16 "LyX 1.6.x" "" "" "" "document"
406 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
407 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
408 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
409 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
410 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
411 \Format pdftex pdftex_t PDFTEX "" "" "" ""
412 \Format program "" Program "" "" "" ""
413 \Format pstex pstex_t PSTEX "" "" "" ""
414 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
415 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
416 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
417 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
418 \Format word doc "MS Word" W "" "" "document,vector"
419 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
423 def checkConverterEntries():
424 ''' Check all converters (\converter entries) '''
425 checkProg('the pdflatex program', ['pdflatex $$i'],
426 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
428 checkProg('XeTeX', ['xelatex $$i'],
429 rc_entry = [ r'\converter xetex pdf4 "%%" "latex"' ])
431 ''' If we're running LyX in-place then tex2lyx will be found in
432 ../src/tex2lyx. Add this directory to the PATH temporarily and
434 Use PATH to avoid any problems with paths-with-spaces.
436 path_orig = os.environ["PATH"]
437 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
438 os.pathsep + path_orig
440 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
441 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
442 \converter literate lyx "%% -n -f $$i $$o" ""'''])
444 os.environ["PATH"] = path_orig
447 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
448 rc_entry = [r'''\converter literate latex "%%" ""
449 \converter literate pdflatex "%%" ""'''])
451 path, elyx = checkProg('eLyXer converter', ['elyxer.py $$i $$o'],
452 rc_entry = [ r'\converter lyx html2 "%%" ""' ] )
453 if elyx.find('elyxer.py') >= 0 :
454 addToRC(r'''\copier html2 "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
455 checkViewer('an eLyXer previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
456 rc_entry = [r'\Format html2 html "HTML (eLyXer)" e "%%" "" "document"'])
459 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
460 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
461 rc_entry = [ r'\converter html latex "%%" ""' ])
463 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
464 rc_entry = [ r'\converter word latex "%%" ""' ])
465 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
466 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
467 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
468 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
469 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
470 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
471 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
473 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
475 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
476 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
477 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
478 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
479 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
480 if htmlconv.find('htlatex') >= 0:
481 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
483 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
484 rc_entry = [ r'\converter sxw latex "%%" ""' ])
486 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
487 rc_entry = [ r'\converter odt latex "%%" ""' ])
488 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
489 # the command mk4ht oolatex $$i has to be used as default,
490 # but as this would require to have Perl installed, in MiKTeX oolatex is
491 # directly available as application.
492 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
493 # Both SuSE and debian have oolatex
494 checkProg('a LaTeX -> Open Document converter', [
495 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
496 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
497 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
498 # On windows it is called latex2rt.exe
499 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
500 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
502 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
503 rc_entry = [ r'\converter rtf html "%%" ""' ])
505 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
506 rc_entry = [ r'\converter ps pdf "%%" ""' ])
508 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
509 rc_entry = [ r'\converter ps text2 "%%" ""' ])
511 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
512 rc_entry = [ r'\converter ps text3 "%%" ""' ])
514 checkProg('a PS to EPS converter', ['ps2eps $$i'],
515 rc_entry = [ r'\converter ps eps "%%" ""' ])
517 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
518 rc_entry = [ r'\converter pdf ps "%%" ""' ])
520 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
521 rc_entry = [ r'\converter pdf eps "%%" ""' ])
523 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
524 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
526 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
527 rc_entry = [ r'\converter dvi ps "%%" ""' ])
529 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
530 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
532 path, dvipng = checkProg('dvipng', ['dvipng'])
533 if dvipng == "dvipng":
534 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
536 addToRC(r'\converter lyxpreview png "" ""')
538 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
539 rc_entry = [ r'\converter ps fax "%%" ""'])
541 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
543 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
544 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
545 \converter fig png "fig2dev -L png $$i $$o" ""''',
548 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
549 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
551 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
553 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
554 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
555 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
558 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
559 rc_entry = [ r'\converter wmf eps "%%" ""'])
561 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
562 rc_entry = [ r'\converter emf eps "%%" ""'])
564 checkProg('an EPS -> PDF converter', ['epstopdf'],
565 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
567 # no agr -> pdf converter, since the pdf library used by gracebat is not
568 # free software and therefore not compiled in in many installations.
569 # Fortunately, this is not a big problem, because we will use epstopdf to
570 # convert from agr to pdf via eps without loss of quality.
571 checkProg('a Grace -> Image converter', ['gracebat'],
573 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
574 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
575 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
576 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
579 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
580 rc_entry = [ r'\converter dot pdf "%%" ""'])
582 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
583 rc_entry = [ r'\converter dia png "%%" ""'])
585 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
586 rc_entry = [ r'\converter dia eps "%%" ""'])
589 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
591 version_string = cmdOutput("lilypond --version")
592 match = re.match('GNU LilyPond (\S+)', version_string)
594 version_number = match.groups()[0]
595 version = version_number.split('.')
596 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
597 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps --ps $$i" ""
598 \converter lilypond png "lilypond -dbackend=eps --png $$i" ""''')
599 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps --pdf $$i" ""')
600 print '+ found LilyPond version %s.' % version_number
601 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
602 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
603 \converter lilypond png "lilypond -b eps --png $$i" ""''')
604 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
605 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
606 logger.info('+ found LilyPond version %s.' % version_number)
608 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
610 logger.info('+ found LilyPond, but could not extract version number.')
612 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
613 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
615 # FIXME: no rc_entry? comment it out
616 # checkProg('Image converter', ['convert $$i $$o'])
618 # Entries that do not need checkProg
619 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
620 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
621 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
622 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
623 \converter docbook docbook-xml "cp $$i $$o" "xml"
624 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
625 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
626 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
627 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
628 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
629 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
630 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
631 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
632 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
633 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
634 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
635 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
636 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
641 ''' Check docbook '''
642 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
644 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
645 \converter docbook html "sgmltools -b html $$i" ""''',
646 r'''\converter docbook dvi "db2dvi $$i" ""
647 \converter docbook html "db2html $$i" ""''',
648 r'''\converter docbook dvi "" ""
649 \converter docbook html "" ""''',
650 r'''\converter docbook dvi "" ""
651 \converter docbook html "" ""'''])
654 return ('yes', 'true', '\\def\\hasdocbook{yes}')
656 return ('no', 'false', '')
659 def checkOtherEntries():
660 ''' entries other than Format and Converter '''
661 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
662 rc_entry = [ r'\chktex_command "%%"' ])
663 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
664 rc_entry = [ r'\bibtex_command "%%"' ],
665 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
666 checkProg('JBibTeX, the Japanese BibTeX', ['jbibtex', 'bibtex'],
667 rc_entry = [ r'\jbibtex_command "%%"' ])
668 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q'],
669 rc_entry = [ r'\index_command "%%"' ],
670 alt_rc_entry = [ r'\index_alternatives "%%"' ])
671 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'makeindex -c -q'],
672 rc_entry = [ r'\jindex_command "%%"' ])
673 checkProg('the splitindex processor', ['splitindex.pl', 'java splitindex', 'splitindex'],
674 rc_entry = [ r'\splitindex_command "%%"' ])
675 checkProg('a nomenclature processor', ['makeindex'],
676 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
677 ## FIXME: OCTAVE is not used anywhere
678 # path, OCTAVE = checkProg('Octave', ['octave'])
679 ## FIXME: MAPLE is not used anywhere
680 # path, MAPLE = checkProg('Maple', ['maple'])
681 checkProg('a spool command', ['lp', 'lpr'],
683 r'''\print_spool_printerprefix "-d "
684 \print_spool_command "lp"''',
685 r'''\print_spool_printerprefix "-P",
686 \print_spool_command "lpr"''',
688 # Add the rest of the entries (no checkProg is required)
689 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
690 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
691 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
692 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
696 def processLayoutFile(file, bool_docbook):
697 ''' process layout file and get a line of result
699 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
701 \DeclareLaTeXClass{article}
702 \DeclareLaTeXClass[scrbook]{book (koma-script)}
703 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
707 "article" "article" "article" "false"
708 "scrbook" "scrbook" "book (koma-script)" "false"
709 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
711 classname = file.split(os.sep)[-1].split('.')[0]
712 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
713 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
714 for line in open(file).readlines():
717 (classtype, optAll, opt, opt1, desc) = res.groups()
718 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
721 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
722 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
726 def checkLatexConfig(check_config, bool_docbook):
727 ''' Explore the LaTeX configuration
728 Return None (will be passed to sys.exit()) for success.
730 msg = 'checking LaTeX configuration... '
731 # if --without-latex-config is forced, or if there is no previous
732 # version of textclass.lst, re-generate a default file.
733 if not os.path.isfile('textclass.lst') or not check_config:
734 # remove the files only if we want to regenerate
735 removeFiles(['textclass.lst', 'packages.lst'])
737 # Then, generate a default textclass.lst. In case configure.py
738 # fails, we still have something to start lyx.
739 logger.info(msg + ' default values')
740 logger.info('+checking list of textclasses... ')
741 tx = open('textclass.lst', 'w')
743 # This file declares layouts and their associated definition files
744 # (include dir. relative to the place where this file is).
745 # It contains only default values, since chkconfig.ltx could not be run
746 # for some reason. Run ./configure.py if you need to update it after a
747 # configuration change.
749 # build the list of available layout files and convert it to commands
752 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
753 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
755 if not os.path.isfile(file):
757 # get stuff between /xxxx.layout .
758 classname = file.split(os.sep)[-1].split('.')[0]
760 cleanclass = classname.replace(' ', '_')
761 cleanclass = cleanclass.replace('-', '_')
762 # make sure the same class is not considered twice
763 if foundClasses.count(cleanclass) == 0: # not found before
764 foundClasses.append(cleanclass)
765 retval = processLayoutFile(file, bool_docbook)
769 logger.info('\tdone')
772 # the following will generate textclass.lst.tmp, and packages.lst.tmp
774 logger.info(msg + '\tauto')
775 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
776 'chkconfig.classes', 'chklayouts.tex'])
778 if not os.path.isfile( 'chkconfig.ltx' ):
779 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
781 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
782 # Construct the list of classes to test for.
783 # build the list of available layout files and convert it to commands
785 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
787 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
788 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
789 if not os.path.isfile(file):
791 classname = file.split(os.sep)[-1].split('.')[0]
792 for line in open(file).readlines():
793 if p1.search(line) == None:
796 logger.error("Wrong input layout file with line '" + line)
798 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
801 cl = open('chklayouts.tex', 'w')
802 for line in testclasses:
803 cl.write(line + '\n')
806 # we have chklayouts.tex, then process it
807 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
809 line = fout.readline()
812 if re.match('^\+', line):
813 logger.info(line.strip())
814 # if the command succeeds, None will be returned
817 # currently, values in chhkconfig are only used to set
820 for line in open('chkconfig.vars').readlines():
821 key, val = re.sub('-', '_', line).split('=')
823 values[key] = val.strip("'")
824 # chk_fontenc may not exist
826 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
829 if rmcopy: # remove the copied file
830 removeFiles( [ 'chkconfig.ltx' ] )
831 # if configure successed, move textclass.lst.tmp to textclass.lst
832 # and packages.lst.tmp to packages.lst
833 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
834 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
835 shutil.move('textclass.lst.tmp', 'textclass.lst')
836 shutil.move('packages.lst.tmp', 'packages.lst')
840 def checkModulesConfig():
841 removeFiles(['lyxmodules.lst'])
843 logger.info('+checking list of modules... ')
844 tx = open('lyxmodules.lst', 'w')
845 tx.write('''## This file declares modules and their associated definition files.
846 ## It has been automatically generated by configure
847 ## Use "Options/Reconfigure" if you need to update it after a
848 ## configuration change.
850 # build the list of available modules
852 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
853 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
856 if not os.path.isfile(file):
858 retval = processModuleFile(file, bool_docbook)
862 logger.info('\tdone')
865 def processModuleFile(file, bool_docbook):
866 ''' process module file and get a line of result
868 The top of a module file should look like this:
869 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
871 #...body of description...
873 #Requires: [list of required modules]
874 #Excludes: [list of excluded modules]
875 The last two lines are optional
877 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
879 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
880 r = re.compile(r'#+\s*Requires: (.*)')
881 x = re.compile(r'#+\s*Excludes: (.*)')
882 b = re.compile(r'#+\s*DescriptionBegin\s*$')
883 e = re.compile(r'#+\s*DescriptionEnd\s*$')
885 modname = desc = pkgs = req = excl = ""
886 readingDescription = False
888 filename = file.split(os.sep)[-1]
889 filename = filename[:-7]
891 for line in open(file).readlines():
892 if readingDescription:
895 readingDescription = False
896 desc = " ".join(descLines)
898 descLines.append(line[1:].strip())
902 readingDescription = True
906 (pkgs, modname) = res.groups()
910 tmp = [s.strip() for s in pkgs.split(",")]
916 tmp = [s.strip() for s in req.split("|")]
922 tmp = [s.strip() for s in excl.split("|")]
926 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
927 logger.warning("Module file without \DeclareLyXModule line. ")
931 def checkTeXAllowSpaces():
932 ''' Let's check whether spaces are allowed in TeX file names '''
933 tex_allows_spaces = 'false'
935 msg = "Checking whether TeX allows spaces in file names... "
936 writeToFile('a b.tex', r'\message{working^^J}' )
938 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
940 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
941 if 'working' in latex_out:
942 logger.info(msg + 'yes')
943 tex_allows_spaces = 'true'
945 logger.info(msg + 'no')
946 tex_allows_spaces = 'false'
947 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
948 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
951 def removeTempFiles():
953 if not lyx_keep_temps:
954 removeFiles(['chkconfig.vars', \
955 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
956 'chklayouts.tex', 'missfont.log',
957 'chklatex.ltx', 'chklatex.log'])
960 if __name__ == '__main__':
961 lyx_check_config = True
962 outfile = 'lyxrc.defaults'
964 lyx_keep_temps = False
966 ## Parse the command line
967 for op in sys.argv[1:]: # default shell/for list is $*, the options
968 if op in [ '-help', '--help', '-h' ]:
969 print '''Usage: configure [options]
971 --help show this help lines
972 --keep-temps keep temporary files (for debug. purposes)
973 --without-latex-config do not run LaTeX to determine configuration
974 --with-version-suffix=suffix suffix of binary installed files
977 elif op == '--without-latex-config':
978 lyx_check_config = False
979 elif op == '--keep-temps':
980 lyx_keep_temps = True
981 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
982 version_suffix = op[22:]
984 print "Unknown option", op
987 # check if we run from the right directory
988 srcdir = os.path.dirname(sys.argv[0])
991 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
992 logger.error("configure: error: cannot find chkconfig.ltx script")
996 windows_style_tex_paths = checkTeXPaths()
997 dtl_tools = checkDTLtools()
998 ## Write the first part of outfile
999 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1000 # script. It contains default settings that have been determined by
1001 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1002 # want to customize LyX, use LyX' Preferences dialog or modify directly
1003 # the "preferences" file instead. Any setting in that file will
1004 # override the values given here.
1007 LATEX = checkLatex(dtl_tools)
1008 checkFormatEntries(dtl_tools)
1009 checkConverterEntries()
1010 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1011 checkTeXAllowSpaces()
1012 if windows_style_tex_paths != '':
1013 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1015 # --without-latex-config can disable lyx_check_config
1016 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1017 checkModulesConfig() #lyx_check_config and LATEX != '')
1019 # The return error code can be 256. Because most systems expect an error code
1020 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1021 # a None for success, 'ret is not None' is used to exit.
1022 sys.exit(ret is not None)