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'])
206 # check if PLATEX is pLaTeX2e
207 writeToFile('chklatex.ltx', '''
211 # run platex on chklatex.ltx and check result
212 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
213 # We have the Japanese pLaTeX2e
214 addToRC(r'\converter platex dvi "%s" "latex"' % PLATEX)
218 removeFiles(['chklatex.ltx', 'chklatex.log'])
219 #-----------------------------------------------------------------
220 # use LATEX to convert from latex to dvi if PPLATEX is not available
224 # Windows only: DraftDVI
225 addToRC(r'''\converter latex dvi2 "%s" "latex"
226 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
228 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
231 # Check if latex is usable
232 writeToFile('chklatex.ltx', '''
233 \\nonstopmode\\makeatletter
234 \\ifx\\undefined\\documentclass\\else
235 \\message{ThisIsLaTeX2e}
239 # run latex on chklatex.ltx and check result
240 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
244 print "Latex not usable (not LaTeX2e) "
245 # remove temporary files
246 removeFiles(['chklatex.ltx', 'chklatex.log'])
250 def checkFormatEntries(dtl_tools):
251 ''' Check all formats (\Format entries) '''
252 checkViewer('a Tgif viewer and editor', ['tgif'],
253 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
255 checkViewer('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
256 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
258 checkViewer('a Grace viewer and editor', ['xmgrace'],
259 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
261 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
262 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
264 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
265 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
266 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
267 \Format gif gif GIF "" "%s" "%s" ""
268 \Format jpg jpg JPEG "" "%s" "%s" ""
269 \Format pbm pbm PBM "" "%s" "%s" ""
270 \Format pgm pgm PGM "" "%s" "%s" ""
271 \Format png png PNG "" "%s" "%s" ""
272 \Format ppm ppm PPM "" "%s" "%s" ""
273 \Format tiff tif TIFF "" "%s" "%s" ""
274 \Format xbm xbm XBM "" "%s" "%s" ""
275 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
276 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
278 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
279 'nedit', 'gedit', 'notepad'],
280 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
281 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
282 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
283 \Format dateout tmp "date (output)" "" "" "%%" ""
284 \Format docbook sgml DocBook B "" "%%" "document"
285 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
286 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
287 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
288 \Format literate nw NoWeb N "" "%%" "document"
289 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
290 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
291 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
292 \Format text txt "Plain text" a "" "%%" "document"
293 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
294 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
295 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
296 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
298 checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
299 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
300 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
301 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
302 'nedit', 'gedit', 'notepad'],
303 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
305 #checkProg('a Postscript interpreter', ['gs'],
306 # rc_entry = [ r'\ps_command "%%"' ])
307 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
308 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
309 \Format ps ps Postscript t "%%" "" "document,vector"'''])
311 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
313 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
314 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
315 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
317 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
318 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
320 # Windows only: DraftDVI
321 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
323 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
324 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
326 checkViewer('Noteedit', ['noteedit'],
327 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
329 checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
330 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
332 # entried that do not need checkProg
333 addToRC(r'''\Format date "" "date command" "" "" "" ""
334 \Format csv csv "Table (CSV)" "" "" "" "document"
335 \Format fax "" Fax "" "" "" "document"
336 \Format lyx lyx LyX "" "" "" ""
337 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
338 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
339 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
340 \Format lyx16x lyx16 "LyX 1.6.x" "" "" "" "document"
341 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
342 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
343 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
344 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
345 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
346 \Format pdftex pdftex_t PDFTEX "" "" "" ""
347 \Format program "" Program "" "" "" ""
348 \Format pstex pstex_t PSTEX "" "" "" ""
349 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
350 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
351 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
352 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
353 \Format word doc "MS Word" W "" "" "document,vector"
354 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
358 def checkConverterEntries():
359 ''' Check all converters (\converter entries) '''
360 checkProg('the pdflatex program', ['pdflatex $$i'],
361 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
363 ''' If we're running LyX in-place then tex2lyx will be found in
364 ../src/tex2lyx. Add this directory to the PATH temporarily and
366 Use PATH to avoid any problems with paths-with-spaces.
368 path_orig = os.environ["PATH"]
369 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
370 os.pathsep + path_orig
372 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
373 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
374 \converter literate lyx "%% -n -f $$i $$o" ""'''])
376 os.environ["PATH"] = path_orig
379 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
380 rc_entry = [r'''\converter literate latex "%%" ""
381 \converter literate pdflatex "%%" ""'''])
383 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
384 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
385 rc_entry = [ r'\converter html latex "%%" ""' ])
387 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
388 rc_entry = [ r'\converter word latex "%%" ""' ])
389 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
390 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
391 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
392 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
393 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
394 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
395 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
397 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
399 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
400 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
401 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
402 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
403 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
404 if htmlconv.find('htlatex') >= 0:
405 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
407 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
408 rc_entry = [ r'\converter sxw latex "%%" ""' ])
410 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
411 rc_entry = [ r'\converter odt latex "%%" ""' ])
412 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
413 # the command mk4ht oolatex $$i has to be used as default,
414 # but as this would require to have Perl installed, in MiKTeX oolatex is
415 # directly available as application.
416 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
417 # Both SuSE and debian have oolatex
418 checkProg('a LaTeX -> Open Document converter', [
419 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
420 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
421 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
422 # On windows it is called latex2rt.exe
423 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
424 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
426 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
427 rc_entry = [ r'\converter rtf html "%%" ""' ])
429 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
430 rc_entry = [ r'\converter ps pdf "%%" ""' ])
432 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
433 rc_entry = [ r'\converter ps text2 "%%" ""' ])
435 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
436 rc_entry = [ r'\converter ps text3 "%%" ""' ])
438 checkProg('a PS to EPS converter', ['ps2eps $$i'],
439 rc_entry = [ r'\converter ps eps "%%" ""' ])
441 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
442 rc_entry = [ r'\converter pdf ps "%%" ""' ])
444 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
445 rc_entry = [ r'\converter pdf eps "%%" ""' ])
447 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
448 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
450 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
451 rc_entry = [ r'\converter dvi ps "%%" ""' ])
453 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
454 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
456 path, dvipng = checkProg('dvipng', ['dvipng'])
457 if dvipng == "dvipng":
458 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
460 addToRC(r'\converter lyxpreview png "" ""')
462 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
463 rc_entry = [ r'\converter ps fax "%%" ""'])
465 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
467 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
468 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
469 \converter fig png "fig2dev -L png $$i $$o" ""''',
472 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
473 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
475 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
477 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
478 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
479 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
482 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
483 rc_entry = [ r'\converter wmf eps "%%" ""'])
485 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
486 rc_entry = [ r'\converter emf eps "%%" ""'])
488 checkProg('an EPS -> PDF converter', ['epstopdf'],
489 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
491 # no agr -> pdf converter, since the pdf library used by gracebat is not
492 # free software and therefore not compiled in in many installations.
493 # Fortunately, this is not a big problem, because we will use epstopdf to
494 # convert from agr to pdf via eps without loss of quality.
495 checkProg('a Grace -> Image converter', ['gracebat'],
497 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
498 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
499 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
500 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
503 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
504 rc_entry = [ r'\converter dot pdf "%%" ""'])
507 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
509 version_string = cmdOutput("lilypond --version")
510 match = re.match('GNU LilyPond (\S+)', version_string)
512 version_number = match.groups()[0]
513 version = version_number.split('.')
514 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
515 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
516 \converter lilypond png "lilypond -b eps --png $$i" ""''')
517 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
518 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
519 print '+ found LilyPond version %s.' % version_number
521 print '+ found LilyPond, but version %s is too old.' % version_number
523 print '+ found LilyPond, but could not extract version number.'
525 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
526 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
528 # FIXME: no rc_entry? comment it out
529 # checkProg('Image converter', ['convert $$i $$o'])
531 # Entries that do not need checkProg
532 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
533 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
534 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
535 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
536 \converter docbook docbook-xml "cp $$i $$o" "xml"
537 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
538 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
539 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
540 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
541 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
542 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
543 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
544 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
545 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
546 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
547 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
548 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
549 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
554 ''' Check docbook '''
555 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
557 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
558 \converter docbook html "sgmltools -b html $$i" ""''',
559 r'''\converter docbook dvi "db2dvi $$i" ""
560 \converter docbook html "db2html $$i" ""''',
561 r'''\converter docbook dvi "" ""
562 \converter docbook html "" ""''',
563 r'''\converter docbook dvi "" ""
564 \converter docbook html "" ""'''])
567 return ('yes', 'true', '\\def\\hasdocbook{yes}')
569 return ('no', 'false', '')
572 def checkOtherEntries():
573 ''' entries other than Format and Converter '''
574 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
575 rc_entry = [ r'\chktex_command "%%"' ])
576 checkProg('BibTeX', ['jbibtex', 'bibtex'],
577 rc_entry = [ r'\bibtex_command "%%"' ])
578 checkProg('an index processor', ['texindy', 'makeindex -c -q'],
579 rc_entry = [ r'\index_command "%%"' ])
580 checkProg('a nomenclature processor', ['makeindex'],
581 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
582 ## FIXME: OCTAVE is not used anywhere
583 # path, OCTAVE = checkProg('Octave', ['octave'])
584 ## FIXME: MAPLE is not used anywhere
585 # path, MAPLE = checkProg('Maple', ['maple'])
586 checkProg('a spool command', ['lp', 'lpr'],
588 r'''\print_spool_printerprefix "-d "
589 \print_spool_command "lp"''',
590 r'''\print_spool_printerprefix "-P",
591 \print_spool_command "lpr"''',
593 # Add the rest of the entries (no checkProg is required)
594 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
595 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
596 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
597 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
601 def processLayoutFile(file, bool_docbook):
602 ''' process layout file and get a line of result
604 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
606 \DeclareLaTeXClass{article}
607 \DeclareLaTeXClass[scrbook]{book (koma-script)}
608 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
612 "article" "article" "article" "false"
613 "scrbook" "scrbook" "book (koma-script)" "false"
614 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
616 classname = file.split(os.sep)[-1].split('.')[0]
617 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
618 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
619 for line in open(file).readlines():
622 (classtype, optAll, opt, opt1, desc) = res.groups()
623 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
626 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
627 print "Layout file " + file + " has no \DeclareXXClass line. "
631 def checkLatexConfig(check_config, bool_docbook):
632 ''' Explore the LaTeX configuration
633 Return None (will be passed to sys.exit()) for success.
635 print 'checking LaTeX configuration... ',
636 # if --without-latex-config is forced, or if there is no previous
637 # version of textclass.lst, re-generate a default file.
638 if not os.path.isfile('textclass.lst') or not check_config:
639 # remove the files only if we want to regenerate
640 removeFiles(['textclass.lst', 'packages.lst'])
642 # Then, generate a default textclass.lst. In case configure.py
643 # fails, we still have something to start lyx.
644 print ' default values'
645 print '+checking list of textclasses... '
646 tx = open('textclass.lst', 'w')
648 # This file declares layouts and their associated definition files
649 # (include dir. relative to the place where this file is).
650 # It contains only default values, since chkconfig.ltx could not be run
651 # for some reason. Run ./configure.py if you need to update it after a
652 # configuration change.
654 # build the list of available layout files and convert it to commands
657 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
658 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
660 if not os.path.isfile(file):
662 # get stuff between /xxxx.layout .
663 classname = file.split(os.sep)[-1].split('.')[0]
665 cleanclass = classname.replace(' ', '_')
666 cleanclass = cleanclass.replace('-', '_')
667 # make sure the same class is not considered twice
668 if foundClasses.count(cleanclass) == 0: # not found before
669 foundClasses.append(cleanclass)
670 retval = processLayoutFile(file, bool_docbook)
677 # the following will generate textclass.lst.tmp, and packages.lst.tmp
680 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
681 'chkconfig.classes', 'chklayouts.tex'])
683 if not os.path.isfile( 'chkconfig.ltx' ):
684 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
686 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
687 # Construct the list of classes to test for.
688 # build the list of available layout files and convert it to commands
690 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
692 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
693 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
694 if not os.path.isfile(file):
696 classname = file.split(os.sep)[-1].split('.')[0]
697 for line in open(file).readlines():
698 if p1.search(line) == None:
701 print "Wrong input layout file with line '" + line
703 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
706 cl = open('chklayouts.tex', 'w')
707 for line in testclasses:
708 cl.write(line + '\n')
711 # we have chklayouts.tex, then process it
712 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
714 line = fout.readline()
717 if re.match('^\+', line):
719 # if the command succeeds, None will be returned
722 # currently, values in chhkconfig are only used to set
725 for line in open('chkconfig.vars').readlines():
726 key, val = re.sub('-', '_', line).split('=')
728 values[key] = val.strip("'")
729 # chk_fontenc may not exist
731 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
734 if rmcopy: # remove the copied file
735 removeFiles( [ 'chkconfig.ltx' ] )
736 # if configure successed, move textclass.lst.tmp to textclass.lst
737 # and packages.lst.tmp to packages.lst
738 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
739 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
740 shutil.move('textclass.lst.tmp', 'textclass.lst')
741 shutil.move('packages.lst.tmp', 'packages.lst')
745 def checkModulesConfig():
746 removeFiles(['lyxmodules.lst'])
748 print '+checking list of modules... '
749 tx = open('lyxmodules.lst', 'w')
750 tx.write('''## This file declares modules and their associated definition files.
751 ## It has been automatically generated by configure
752 ## Use "Options/Reconfigure" if you need to update it after a
753 ## configuration change.
755 # build the list of available modules
757 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
758 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
761 if not os.path.isfile(file):
763 retval = processModuleFile(file, bool_docbook)
770 def processModuleFile(file, bool_docbook):
771 ''' process module file and get a line of result
773 The top of a module file should look like this:
774 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
776 #...body of description...
778 #Requires: [list of required modules]
779 #Excludes: [list of excluded modules]
780 The last two lines are optional
782 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
784 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
785 r = re.compile(r'#+\s*Requires: (.*)')
786 x = re.compile(r'#+\s*Excludes: (.*)')
787 b = re.compile(r'#+\s*DescriptionBegin\s*$')
788 e = re.compile(r'#+\s*DescriptionEnd\s*$')
790 modname = desc = pkgs = req = excl = ""
791 readingDescription = False
793 filename = file.split(os.sep)[-1]
794 filename = filename[:-7]
796 for line in open(file).readlines():
797 if readingDescription:
800 readingDescription = False
801 desc = " ".join(descLines)
803 descLines.append(line[1:].strip())
807 readingDescription = True
811 (pkgs, modname) = res.groups()
815 tmp = [s.strip() for s in pkgs.split(",")]
821 tmp = [s.strip() for s in req.split("|")]
827 tmp = [s.strip() for s in excl.split("|")]
831 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
832 print "Module file without \DeclareLyXModule line. "
836 def checkTeXAllowSpaces():
837 ''' Let's check whether spaces are allowed in TeX file names '''
838 tex_allows_spaces = 'false'
840 print "Checking whether TeX allows spaces in file names... ",
841 writeToFile('a b.tex', r'\message{working^^J}' )
843 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
845 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
846 if 'working' in latex_out:
848 tex_allows_spaces = 'true'
851 tex_allows_spaces = 'false'
852 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
853 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
856 def removeTempFiles():
858 if not lyx_keep_temps:
859 removeFiles(['chkconfig.vars', \
860 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
861 'chklayouts.tex', 'missfont.log',
862 'chklatex.ltx', 'chklatex.log'])
865 if __name__ == '__main__':
866 lyx_check_config = True
867 outfile = 'lyxrc.defaults'
869 lyx_keep_temps = False
871 logfile = 'configure.log'
872 ## Parse the command line
873 for op in sys.argv[1:]: # default shell/for list is $*, the options
874 if op in [ '-help', '--help', '-h' ]:
875 print '''Usage: configure [options]
877 --help show this help lines
878 --keep-temps keep temporary files (for debug. purposes)
879 --without-latex-config do not run LaTeX to determine configuration
880 --with-version-suffix=suffix suffix of binary installed files
883 elif op == '--without-latex-config':
884 lyx_check_config = False
885 elif op == '--keep-temps':
886 lyx_keep_temps = True
887 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
888 version_suffix = op[22:]
890 print "Unknown option", op
893 # set up log file for stdout and stderr
894 log = open(logfile, 'w')
895 sys.stdout = Tee(sys.stdout, log)
896 sys.stderr = Tee(sys.stderr, log)
897 # check if we run from the right directory
898 srcdir = os.path.dirname(sys.argv[0])
901 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
902 print "configure: error: cannot find chkconfig.ltx script"
906 windows_style_tex_paths = checkTeXPaths()
907 dtl_tools = checkDTLtools()
908 ## Write the first part of outfile
909 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
910 # script. It contains default settings that have been determined by
911 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
912 # want to customize LyX, use LyX' Preferences dialog or modify directly
913 # the "preferences" file instead. Any setting in that file will
914 # override the values given here.
917 LATEX = checkLatex(dtl_tools)
918 checkFormatEntries(dtl_tools)
919 checkConverterEntries()
920 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
921 checkTeXAllowSpaces()
922 if windows_style_tex_paths != '':
923 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
925 # --without-latex-config can disable lyx_check_config
926 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
927 checkModulesConfig() #lyx_check_config and LATEX != '')
929 # The return error code can be 256. Because most systems expect an error code
930 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
931 # a None for success, 'ret is not None' is used to exit.
932 sys.exit(ret is not None)