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
15 ''' Writing to a Tee object will write to all file objects it keeps.
16 That is to say, writing to Tee(sys.stdout, open(logfile, 'w')) will
17 write to sys.stdout as well as a log file.
19 def __init__(self, *args):
22 def write(self, data):
24 result = f.write(data)
27 def writelines(self, seq):
32 def writeToFile(filename, lines, append = False):
33 " utility function: write or append lines to filename "
35 file = open(filename, 'a')
37 file = open(filename, 'w')
43 ''' utility function: shortcut for appending lines to outfile
44 add newline at the end of lines.
46 if lines.strip() != '':
47 writeToFile(outfile, lines + '\n', append = True)
50 def removeFiles(filenames):
51 '''utility function: 'rm -f'
52 ignore errors when file does not exist, or is a directory.
54 for file in filenames:
62 '''utility function: run a command and get its output as a string
72 ''' I do not really know why this is useful, but we might as well keep it.
74 Only set these to C if already set. These must not be set unconditionally
75 because not all systems understand e.g. LANG=C (notably SCO).
76 Fixing LC_MESSAGES prevents Solaris sh from translating var values in `set'!
77 Non-C LC_CTYPE values break the ctype check.
79 os.environ['LANG'] = os.getenv('LANG', 'C')
80 os.environ['LC'] = os.getenv('LC_ALL', 'C')
81 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
82 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
85 def createDirectories():
86 ''' Create the build directories if necessary '''
87 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
88 'layouts', 'scripts', 'templates', 'ui' ]:
89 if not os.path.isdir( dir ):
93 print "Failed to create directory ", dir
98 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
99 windows_style_tex_paths = ''
100 if os.name == 'nt' or sys.platform == 'cygwin':
101 from tempfile import mkstemp
102 fd, tmpfname = mkstemp(suffix='.ltx')
104 inpname = tmpfname.replace('\\', '/')
106 inpname = cmdOutput('cygpath -m ' + tmpfname)
107 logname = os.path.basename(inpname.replace('.ltx', '.log'))
108 inpname = inpname.replace('~', '\\string~')
109 os.write(fd, r'\relax')
111 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
112 if 'Error' in latex_out:
113 print "configure: TeX engine needs posix-style paths in latex files"
114 windows_style_tex_paths = 'false'
116 print "configure: TeX engine needs windows-style paths in latex files"
117 windows_style_tex_paths = 'true'
118 removeFiles([tmpfname, logname, 'texput.log'])
119 return windows_style_tex_paths
122 ## Searching some useful programs
123 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
125 This function will search a program in $PATH plus given path
126 If found, return directory and program name (not the options).
128 description: description of the program
130 progs: check programs, for each prog, the first word is used
131 for searching but the whole string is used to replace
132 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
134 path: additional pathes
136 rc_entry: entry to outfile, can be
137 1. emtpy: no rc entry will be added
138 2. one pattern: %% will be replaced by the first found program,
139 or '' if no program is found.
140 3. several patterns for each prog and not_found. This is used
141 when different programs have different usages. If you do not
142 want not_found entry to be added to the RC file, you can specify
143 an entry for each prog and use '' for the not_found entry.
145 not_found: the value that should be used instead of '' if no program
149 # one rc entry for each progs plus not_found entry
150 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
151 print "rc entry should have one item or item for each prog and not_found."
153 print 'checking for ' + description + '...'
154 ## print '(' + ','.join(progs) + ')',
155 for idx in range(len(progs)):
156 # ac_prog may have options, ac_word is the command name
158 ac_word = ac_prog.split(' ')[0]
159 print '+checking for "' + ac_word + '"... ',
160 path = os.environ["PATH"].split(os.pathsep) + path
162 if os.environ.has_key("PATHEXT"):
163 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
166 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
168 # write rc entries for this command
169 if len(rc_entry) == 1:
170 addToRC(rc_entry[0].replace('%%', ac_prog))
171 elif len(rc_entry) > 1:
172 addToRC(rc_entry[idx].replace('%%', ac_prog))
173 return [ac_dir, ac_word]
176 # write rc entries for 'not found'
177 if len(rc_entry) > 0: # the last one.
178 addToRC(rc_entry[-1].replace('%%', not_found))
179 return ['', not_found]
182 def checkViewer(description, progs, rc_entry = [], path = []):
183 ''' The same as checkProg, but for viewers and editors '''
184 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
188 ''' Check whether DTL tools are available (Windows only) '''
189 # Find programs! Returned path is not used now
190 if ((os.name == 'nt' or sys.platform == 'cygwin') and
191 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
192 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
199 def checkLatex(dtl_tools):
200 ''' Check latex, return lyx_check_config '''
201 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
202 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
203 #-----------------------------------------------------------------
204 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
205 # check if PLATEX is pLaTeX2e
206 writeToFile('chklatex.ltx', '''
210 # run platex on chklatex.ltx and check result
211 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
212 # We have the Japanese pLaTeX2e
213 addToRC(r'\converter platex dvi "%s" "latex"' % PLATEX)
217 removeFiles(['chklatex.ltx', 'chklatex.log'])
218 #-----------------------------------------------------------------
219 # use LATEX to convert from latex to dvi if PPLATEX is not available
223 # Windows only: DraftDVI
224 addToRC(r'''\converter latex dvi2 "%s" "latex"
225 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
227 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
230 # Check if latex is usable
231 writeToFile('chklatex.ltx', '''
232 \\nonstopmode\\makeatletter
233 \\ifx\\undefined\\documentclass\\else
234 \\message{ThisIsLaTeX2e}
238 # run latex on chklatex.ltx and check result
239 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
243 print "Latex not usable (not LaTeX2e) "
244 # remove temporary files
245 removeFiles(['chklatex.ltx', 'chklatex.log'])
249 def checkFormatEntries(dtl_tools):
250 ''' Check all formats (\Format entries) '''
251 checkViewer('a Tgif viewer and editor', ['tgif'],
252 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
254 checkViewer('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
255 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
257 checkViewer('a Grace viewer and editor', ['xmgrace'],
258 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
260 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
261 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
263 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
264 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
265 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
266 \Format gif gif GIF "" "%s" "%s" ""
267 \Format jpg jpg JPEG "" "%s" "%s" ""
268 \Format pbm pbm PBM "" "%s" "%s" ""
269 \Format pgm pgm PGM "" "%s" "%s" ""
270 \Format png png PNG "" "%s" "%s" ""
271 \Format ppm ppm PPM "" "%s" "%s" ""
272 \Format tiff tif TIFF "" "%s" "%s" ""
273 \Format xbm xbm XBM "" "%s" "%s" ""
274 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
275 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
277 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
278 'nedit', 'gedit', 'notepad'],
279 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
280 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
281 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
282 \Format dateout tmp "date (output)" "" "" "%%" ""
283 \Format docbook sgml DocBook B "" "%%" "document"
284 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
285 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
286 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
287 \Format literate nw NoWeb N "" "%%" "document"
288 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
289 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
290 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
291 \Format text txt "Plain text" a "" "%%" "document"
292 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
293 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
294 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
295 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
297 checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
298 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
299 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
300 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
301 'nedit', 'gedit', 'notepad'],
302 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
304 #checkProg('a Postscript interpreter', ['gs'],
305 # rc_entry = [ r'\ps_command "%%"' ])
306 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
307 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
308 \Format ps ps Postscript t "%%" "" "document,vector"'''])
310 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
312 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
313 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
314 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
316 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
317 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
319 # Windows only: DraftDVI
320 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
322 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
323 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
325 checkViewer('Noteedit', ['noteedit'],
326 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
328 checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
329 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
331 # entried that do not need checkProg
332 addToRC(r'''\Format date "" "date command" "" "" "" ""
333 \Format csv csv "Table (CSV)" "" "" "" "document"
334 \Format fax "" Fax "" "" "" "document"
335 \Format lyx lyx LyX "" "" "" ""
336 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
337 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
338 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
339 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
340 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
341 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
342 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
343 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
344 \Format pdftex pdftex_t PDFTEX "" "" "" ""
345 \Format program "" Program "" "" "" ""
346 \Format pstex pstex_t PSTEX "" "" "" ""
347 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
348 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
349 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
350 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
351 \Format word doc "MS Word" W "" "" "document,vector"
352 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
356 def checkConverterEntries():
357 ''' Check all converters (\converter entries) '''
358 checkProg('the pdflatex program', ['pdflatex $$i'],
359 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
361 ''' If we're running LyX in-place then tex2lyx will be found in
362 ../src/tex2lyx. Add this directory to the PATH temporarily and
364 Use PATH to avoid any problems with paths-with-spaces.
366 path_orig = os.environ["PATH"]
367 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
368 os.pathsep + path_orig
370 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
371 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
372 \converter literate lyx "%% -n -f $$i $$o" ""'''])
374 os.environ["PATH"] = path_orig
377 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
378 rc_entry = [r'''\converter literate latex "%%" ""
379 \converter literate pdflatex "%%" ""'''])
381 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
382 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
383 rc_entry = [ r'\converter html latex "%%" ""' ])
385 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
386 rc_entry = [ r'\converter word latex "%%" ""' ])
387 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
388 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
389 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
390 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
391 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
392 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
393 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
395 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
397 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
398 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
399 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
400 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
401 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
402 if htmlconv.find('htlatex') >= 0:
403 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
405 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
406 rc_entry = [ r'\converter sxw latex "%%" ""' ])
408 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
409 rc_entry = [ r'\converter odt latex "%%" ""' ])
410 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
411 # the command mk4ht oolatex $$i has to be used as default,
412 # but as this would require to have Perl installed, in MiKTeX oolatex is
413 # directly available as application.
414 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
415 # Both SuSE and debian have oolatex
416 checkProg('a LaTeX -> Open Document converter', [
417 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
418 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
419 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
420 # On windows it is called latex2rt.exe
421 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
422 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
424 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
425 rc_entry = [ r'\converter rtf html "%%" ""' ])
427 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
428 rc_entry = [ r'\converter ps pdf "%%" ""' ])
430 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
431 rc_entry = [ r'\converter ps text2 "%%" ""' ])
433 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
434 rc_entry = [ r'\converter ps text3 "%%" ""' ])
436 checkProg('a PS to EPS converter', ['ps2eps $$i'],
437 rc_entry = [ r'\converter ps eps "%%" ""' ])
439 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
440 rc_entry = [ r'\converter pdf ps "%%" ""' ])
442 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
443 rc_entry = [ r'\converter pdf eps "%%" ""' ])
445 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
446 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
448 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
449 rc_entry = [ r'\converter dvi ps "%%" ""' ])
451 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
452 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
454 path, dvipng = checkProg('dvipng', ['dvipng'])
455 if dvipng == "dvipng":
456 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
458 addToRC(r'\converter lyxpreview png "" ""')
460 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
461 rc_entry = [ r'\converter ps fax "%%" ""'])
463 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
465 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
466 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
467 \converter fig png "fig2dev -L png $$i $$o" ""''',
470 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
471 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
473 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
475 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
476 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
477 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
478 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
481 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
482 rc_entry = [ r'\converter wmf eps "%%" ""'])
484 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
485 rc_entry = [ r'\converter emf eps "%%" ""'])
487 checkProg('an EPS -> PDF converter', ['epstopdf'],
488 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
490 # no agr -> pdf converter, since the pdf library used by gracebat is not
491 # free software and therefore not compiled in in many installations.
492 # Fortunately, this is not a big problem, because we will use epstopdf to
493 # convert from agr to pdf via eps without loss of quality.
494 checkProg('a Grace -> Image converter', ['gracebat'],
496 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
497 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
498 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
499 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
502 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
503 rc_entry = [ r'\converter dot pdf "%%" ""'])
506 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
508 version_string = cmdOutput("lilypond --version")
509 match = re.match('GNU LilyPond (\S+)', version_string)
511 version_number = match.groups()[0]
512 version = version_number.split('.')
513 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
514 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
515 \converter lilypond png "lilypond -b eps --png $$i" ""''')
516 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
517 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
518 print '+ found LilyPond version %s.' % version_number
520 print '+ found LilyPond, but version %s is too old.' % version_number
522 print '+ found LilyPond, but could not extract version number.'
524 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
525 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
527 # FIXME: no rc_entry? comment it out
528 # checkProg('Image converter', ['convert $$i $$o'])
530 # Entries that do not need checkProg
531 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
532 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
533 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
534 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
535 \converter docbook docbook-xml "cp $$i $$o" "xml"
536 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
537 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
538 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
539 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
540 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
541 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
542 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
543 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
544 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
545 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
546 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
547 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
552 ''' Check docbook '''
553 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
555 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
556 \converter docbook html "sgmltools -b html $$i" ""''',
557 r'''\converter docbook dvi "db2dvi $$i" ""
558 \converter docbook html "db2html $$i" ""''',
559 r'''\converter docbook dvi "" ""
560 \converter docbook html "" ""'''])
563 return ('yes', 'true', '\\def\\hasdocbook{yes}')
565 return ('no', 'false', '')
568 def checkOtherEntries():
569 ''' entries other than Format and Converter '''
570 checkProg('a *roff formatter', ['groff', 'nroff'],
572 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
573 r'\plaintext_roff_command "tbl $$FName | nroff"',
574 r'\plaintext_roff_command ""' ])
575 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
576 rc_entry = [ r'\chktex_command "%%"' ])
577 checkProg('BibTeX', ['jbibtex', 'bibtex'],
578 rc_entry = [ r'\bibtex_command "%%"' ])
579 checkProg('an index processor', ['texindy', 'makeindex -c -q'],
580 rc_entry = [ r'\index_command "%%"' ])
581 checkProg('a nomenclature processor', ['makeindex'],
582 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
583 checkProg('a spellchecker', ['ispell'],
584 rc_entry = [ r'\spell_command "%%"' ])
585 ## FIXME: OCTAVE is not used anywhere
586 # path, OCTAVE = checkProg('Octave', ['octave'])
587 ## FIXME: MAPLE is not used anywhere
588 # path, MAPLE = checkProg('Maple', ['maple'])
589 checkProg('a spool command', ['lp', 'lpr'],
591 r'''\print_spool_printerprefix "-d "
592 \print_spool_command "lp"''',
593 r'''\print_spool_printerprefix "-P",
594 \print_spool_command "lpr"''',
596 # Add the rest of the entries (no checkProg is required)
597 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
598 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
599 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
600 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
604 def processLayoutFile(file, bool_docbook):
605 ''' process layout file and get a line of result
607 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
609 \DeclareLaTeXClass{article}
610 \DeclareLaTeXClass[scrbook]{book (koma-script)}
611 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
615 "article" "article" "article" "false"
616 "scrbook" "scrbook" "book (koma-script)" "false"
617 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
619 classname = file.split(os.sep)[-1].split('.')[0]
620 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
621 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
622 for line in open(file).readlines():
625 (classtype, optAll, opt, opt1, desc) = res.groups()
626 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
629 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
630 print "Layout file " + file + " has no \DeclareXXClass line. "
634 def checkLatexConfig(check_config, bool_docbook):
635 ''' Explore the LaTeX configuration
636 Return None (will be passed to sys.exit()) for success.
638 print 'checking LaTeX configuration... ',
639 # if --without-latex-config is forced, or if there is no previous
640 # version of textclass.lst, re-generate a default file.
641 if not os.path.isfile('textclass.lst') or not check_config:
642 # remove the files only if we want to regenerate
643 removeFiles(['textclass.lst', 'packages.lst'])
645 # Then, generate a default textclass.lst. In case configure.py
646 # fails, we still have something to start lyx.
647 print ' default values'
648 print '+checking list of textclasses... '
649 tx = open('textclass.lst', 'w')
651 # This file declares layouts and their associated definition files
652 # (include dir. relative to the place where this file is).
653 # It contains only default values, since chkconfig.ltx could not be run
654 # for some reason. Run ./configure.py if you need to update it after a
655 # configuration change.
657 # build the list of available layout files and convert it to commands
660 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
661 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
663 if not os.path.isfile(file):
665 # get stuff between /xxxx.layout .
666 classname = file.split(os.sep)[-1].split('.')[0]
668 cleanclass = classname.replace(' ', '_')
669 cleanclass = cleanclass.replace('-', '_')
670 # make sure the same class is not considered twice
671 if foundClasses.count(cleanclass) == 0: # not found before
672 foundClasses.append(cleanclass)
673 retval = processLayoutFile(file, bool_docbook)
680 # the following will generate textclass.lst.tmp, and packages.lst.tmp
683 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
684 'chkconfig.classes', 'chklayouts.tex'])
686 if not os.path.isfile( 'chkconfig.ltx' ):
687 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
689 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n',
691 # Construct the list of classes to test for.
692 # build the list of available layout files and convert it to commands
694 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
696 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
697 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
698 if not os.path.isfile(file):
700 classname = file.split(os.sep)[-1].split('.')[0]
701 for line in open(file).readlines():
702 if p1.search(line) == None:
705 print "Wrong input layout file with line '" + line
707 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
710 cl = open('chklayouts.tex', 'w')
711 for line in testclasses:
712 cl.write(line + '\n')
715 # we have chklayouts.tex, then process it
716 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
718 line = fout.readline()
721 if re.match('^\+', line):
723 # if the command succeeds, None will be returned
726 # currently, values in chhkconfig are only used to set
729 for line in open('chkconfig.vars').readlines():
730 key, val = re.sub('-', '_', line).split('=')
732 values[key] = val.strip("'")
733 # chk_fontenc may not exist
735 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
738 if rmcopy: # remove the copied file
739 removeFiles( [ 'chkconfig.ltx' ] )
740 # if configure successed, move textclass.lst.tmp to textclass.lst
741 # and packages.lst.tmp to packages.lst
742 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
743 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
744 shutil.move('textclass.lst.tmp', 'textclass.lst')
745 shutil.move('packages.lst.tmp', 'packages.lst')
749 def checkModulesConfig():
750 removeFiles(['lyxmodules.lst'])
752 print '+checking list of modules... '
753 tx = open('lyxmodules.lst', 'w')
754 tx.write('''## This file declares modules and their associated definition files.
755 ## It has been automatically generated by configure
756 ## Use "Options/Reconfigure" if you need to update it after a
757 ## configuration change.
759 # build the list of available modules
761 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
762 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
765 if not os.path.isfile(file):
767 retval = processModuleFile(file, bool_docbook)
774 def processModuleFile(file, bool_docbook):
775 ''' process module file and get a line of result
777 The top of a module file should look like this:
778 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
780 #...body of description...
782 #Requires: [list of required modules]
783 #Excludes: [list of excluded modules]
784 The last two lines are optional
786 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
788 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
789 r = re.compile(r'#+\s*Requires: (.*)')
790 x = re.compile(r'#+\s*Excludes: (.*)')
791 b = re.compile(r'#+\s*DescriptionBegin\s*$')
792 e = re.compile(r'#+\s*DescriptionEnd\s*$')
794 modname = desc = pkgs = req = excl = ""
795 readingDescription = False
797 filename = file.split(os.sep)[-1]
798 filename = filename[:-7]
800 for line in open(file).readlines():
801 if readingDescription:
804 readingDescription = False
805 desc = " ".join(descLines)
807 descLines.append(line[1:].strip())
811 readingDescription = True
815 (pkgs, modname) = res.groups()
819 tmp = [s.strip() for s in pkgs.split(",")]
825 tmp = [s.strip() for s in req.split("|")]
831 tmp = [s.strip() for s in excl.split("|")]
835 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
836 print "Module file without \DeclareLyXModule line. "
840 def checkTeXAllowSpaces():
841 ''' Let's check whether spaces are allowed in TeX file names '''
842 tex_allows_spaces = 'false'
844 print "Checking whether TeX allows spaces in file names... ",
845 writeToFile('a b.tex', r'\message{working^^J}' )
847 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
849 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
850 if 'working' in latex_out:
852 tex_allows_spaces = 'true'
855 tex_allows_spaces = 'false'
856 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
857 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
860 def removeTempFiles():
862 if not lyx_keep_temps:
863 removeFiles(['chkconfig.vars', \
864 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
865 'chklayouts.tex', 'missfont.log',
866 'chklatex.ltx', 'chklatex.log'])
869 if __name__ == '__main__':
870 lyx_check_config = True
871 outfile = 'lyxrc.defaults'
873 lyx_keep_temps = False
875 logfile = 'configure.log'
876 ## Parse the command line
877 for op in sys.argv[1:]: # default shell/for list is $*, the options
878 if op in [ '-help', '--help', '-h' ]:
879 print '''Usage: configure [options]
881 --help show this help lines
882 --keep-temps keep temporary files (for debug. purposes)
883 --without-latex-config do not run LaTeX to determine configuration
884 --with-version-suffix=suffix suffix of binary installed files
887 elif op == '--without-latex-config':
888 lyx_check_config = False
889 elif op == '--keep-temps':
890 lyx_keep_temps = True
891 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
892 version_suffix = op[22:]
894 print "Unknown option", op
897 # set up log file for stdout and stderr
898 log = open(logfile, 'w')
899 sys.stdout = Tee(sys.stdout, log)
900 sys.stderr = Tee(sys.stderr, log)
901 # check if we run from the right directory
902 srcdir = os.path.dirname(sys.argv[0])
905 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
906 print "configure: error: cannot find chkconfig.ltx script"
910 windows_style_tex_paths = checkTeXPaths()
911 dtl_tools = checkDTLtools()
912 ## Write the first part of outfile
913 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
914 # script. It contains default settings that have been determined by
915 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
916 # want to customize LyX, use LyX' Preferences dialog or modify directly
917 # the "preferences" file instead. Any setting in that file will
918 # override the values given here.
921 LATEX = checkLatex(dtl_tools)
922 checkFormatEntries(dtl_tools)
923 checkConverterEntries()
924 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
925 checkTeXAllowSpaces()
926 if windows_style_tex_paths != '':
927 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
929 # --without-latex-config can disable lyx_check_config
930 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
931 checkModulesConfig() #lyx_check_config and LATEX != '')
933 # The return error code can be 256. Because most systems expect an error code
934 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
935 # a None for success, 'ret is not None' is used to exit.
936 sys.exit(ret is not None)