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 Dia viewer and editor', ['dia'],
259 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector"'])
261 checkViewer('a Grace viewer and editor', ['xmgrace'],
262 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
264 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
265 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
267 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
268 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
269 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
270 \Format gif gif GIF "" "%s" "%s" ""
271 \Format jpg jpg JPEG "" "%s" "%s" ""
272 \Format pbm pbm PBM "" "%s" "%s" ""
273 \Format pgm pgm PGM "" "%s" "%s" ""
274 \Format png png PNG "" "%s" "%s" ""
275 \Format ppm ppm PPM "" "%s" "%s" ""
276 \Format tiff tif TIFF "" "%s" "%s" ""
277 \Format xbm xbm XBM "" "%s" "%s" ""
278 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
279 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
281 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
282 'nedit', 'gedit', 'notepad'],
283 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
284 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
285 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
286 \Format dateout tmp "date (output)" "" "" "%%" ""
287 \Format docbook sgml DocBook B "" "%%" "document"
288 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
289 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
290 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
291 \Format literate nw NoWeb N "" "%%" "document"
292 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
293 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
294 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
295 \Format text txt "Plain text" a "" "%%" "document"
296 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
297 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
298 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
299 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
301 checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
302 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
303 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
304 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
305 'nedit', 'gedit', 'notepad'],
306 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
308 #checkProg('a Postscript interpreter', ['gs'],
309 # rc_entry = [ r'\ps_command "%%"' ])
310 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
311 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
312 \Format ps ps Postscript t "%%" "" "document,vector"'''])
314 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
316 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
317 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
318 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
320 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
321 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
323 # Windows only: DraftDVI
324 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
326 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
327 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
329 checkViewer('Noteedit', ['noteedit'],
330 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
332 checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
333 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
335 # entried that do not need checkProg
336 addToRC(r'''\Format date "" "date command" "" "" "" ""
337 \Format csv csv "Table (CSV)" "" "" "" "document"
338 \Format fax "" Fax "" "" "" "document"
339 \Format lyx lyx LyX "" "" "" ""
340 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
341 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
342 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
343 \Format lyx16x lyx16 "LyX 1.6.x" "" "" "" "document"
344 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
345 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
346 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
347 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
348 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
349 \Format pdftex pdftex_t PDFTEX "" "" "" ""
350 \Format program "" Program "" "" "" ""
351 \Format pstex pstex_t PSTEX "" "" "" ""
352 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
353 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
354 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
355 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
356 \Format word doc "MS Word" W "" "" "document,vector"
357 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
361 def checkConverterEntries():
362 ''' Check all converters (\converter entries) '''
363 checkProg('the pdflatex program', ['pdflatex $$i'],
364 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
366 ''' If we're running LyX in-place then tex2lyx will be found in
367 ../src/tex2lyx. Add this directory to the PATH temporarily and
369 Use PATH to avoid any problems with paths-with-spaces.
371 path_orig = os.environ["PATH"]
372 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
373 os.pathsep + path_orig
375 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
376 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
377 \converter literate lyx "%% -n -f $$i $$o" ""'''])
379 os.environ["PATH"] = path_orig
382 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
383 rc_entry = [r'''\converter literate latex "%%" ""
384 \converter literate pdflatex "%%" ""'''])
386 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
387 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
388 rc_entry = [ r'\converter html latex "%%" ""' ])
390 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
391 rc_entry = [ r'\converter word latex "%%" ""' ])
392 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
393 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
394 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
395 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
396 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
397 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
398 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
400 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
402 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
403 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
404 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
405 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
406 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
407 if htmlconv.find('htlatex') >= 0:
408 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
410 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
411 rc_entry = [ r'\converter sxw latex "%%" ""' ])
413 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
414 rc_entry = [ r'\converter odt latex "%%" ""' ])
415 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
416 # the command mk4ht oolatex $$i has to be used as default,
417 # but as this would require to have Perl installed, in MiKTeX oolatex is
418 # directly available as application.
419 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
420 # Both SuSE and debian have oolatex
421 checkProg('a LaTeX -> Open Document converter', [
422 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
423 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
424 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
425 # On windows it is called latex2rt.exe
426 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
427 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
429 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
430 rc_entry = [ r'\converter rtf html "%%" ""' ])
432 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
433 rc_entry = [ r'\converter ps pdf "%%" ""' ])
435 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
436 rc_entry = [ r'\converter ps text2 "%%" ""' ])
438 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
439 rc_entry = [ r'\converter ps text3 "%%" ""' ])
441 checkProg('a PS to EPS converter', ['ps2eps $$i'],
442 rc_entry = [ r'\converter ps eps "%%" ""' ])
444 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
445 rc_entry = [ r'\converter pdf ps "%%" ""' ])
447 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
448 rc_entry = [ r'\converter pdf eps "%%" ""' ])
450 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
451 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
453 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
454 rc_entry = [ r'\converter dvi ps "%%" ""' ])
456 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
457 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
459 path, dvipng = checkProg('dvipng', ['dvipng'])
460 if dvipng == "dvipng":
461 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
463 addToRC(r'\converter lyxpreview png "" ""')
465 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
466 rc_entry = [ r'\converter ps fax "%%" ""'])
468 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
470 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
471 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
472 \converter fig png "fig2dev -L png $$i $$o" ""''',
475 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
476 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
478 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
480 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
481 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
482 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
485 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
486 rc_entry = [ r'\converter wmf eps "%%" ""'])
488 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
489 rc_entry = [ r'\converter emf eps "%%" ""'])
491 checkProg('an EPS -> PDF converter', ['epstopdf'],
492 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
494 # no agr -> pdf converter, since the pdf library used by gracebat is not
495 # free software and therefore not compiled in in many installations.
496 # Fortunately, this is not a big problem, because we will use epstopdf to
497 # convert from agr to pdf via eps without loss of quality.
498 checkProg('a Grace -> Image converter', ['gracebat'],
500 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
501 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
502 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
503 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
506 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
507 rc_entry = [ r'\converter dot pdf "%%" ""'])
509 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
510 rc_entry = [ r'\converter dia png "%%" ""'])
512 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
513 rc_entry = [ r'\converter dia eps "%%" ""'])
516 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
518 version_string = cmdOutput("lilypond --version")
519 match = re.match('GNU LilyPond (\S+)', version_string)
521 version_number = match.groups()[0]
522 version = version_number.split('.')
523 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
524 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
525 \converter lilypond png "lilypond -b eps --png $$i" ""''')
526 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
527 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
528 print '+ found LilyPond version %s.' % version_number
530 print '+ found LilyPond, but version %s is too old.' % version_number
532 print '+ found LilyPond, but could not extract version number.'
534 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
535 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
537 # FIXME: no rc_entry? comment it out
538 # checkProg('Image converter', ['convert $$i $$o'])
540 # Entries that do not need checkProg
541 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
542 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
543 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
544 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
545 \converter docbook docbook-xml "cp $$i $$o" "xml"
546 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
547 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
548 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
549 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
550 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
551 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
552 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
553 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
554 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
555 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
556 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
557 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
558 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
563 ''' Check docbook '''
564 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
566 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
567 \converter docbook html "sgmltools -b html $$i" ""''',
568 r'''\converter docbook dvi "db2dvi $$i" ""
569 \converter docbook html "db2html $$i" ""''',
570 r'''\converter docbook dvi "" ""
571 \converter docbook html "" ""''',
572 r'''\converter docbook dvi "" ""
573 \converter docbook html "" ""'''])
576 return ('yes', 'true', '\\def\\hasdocbook{yes}')
578 return ('no', 'false', '')
581 def checkOtherEntries():
582 ''' entries other than Format and Converter '''
583 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
584 rc_entry = [ r'\chktex_command "%%"' ])
585 checkProg('BibTeX', ['jbibtex', 'bibtex'],
586 rc_entry = [ r'\bibtex_command "%%"' ])
587 checkProg('an index processor', ['texindy', 'makeindex -c -q'],
588 rc_entry = [ r'\index_command "%%"' ])
589 checkProg('a nomenclature processor', ['makeindex'],
590 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
591 ## FIXME: OCTAVE is not used anywhere
592 # path, OCTAVE = checkProg('Octave', ['octave'])
593 ## FIXME: MAPLE is not used anywhere
594 # path, MAPLE = checkProg('Maple', ['maple'])
595 checkProg('a spool command', ['lp', 'lpr'],
597 r'''\print_spool_printerprefix "-d "
598 \print_spool_command "lp"''',
599 r'''\print_spool_printerprefix "-P",
600 \print_spool_command "lpr"''',
602 # Add the rest of the entries (no checkProg is required)
603 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
604 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
605 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
606 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
610 def processLayoutFile(file, bool_docbook):
611 ''' process layout file and get a line of result
613 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
615 \DeclareLaTeXClass{article}
616 \DeclareLaTeXClass[scrbook]{book (koma-script)}
617 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
621 "article" "article" "article" "false"
622 "scrbook" "scrbook" "book (koma-script)" "false"
623 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
625 classname = file.split(os.sep)[-1].split('.')[0]
626 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
627 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
628 for line in open(file).readlines():
631 (classtype, optAll, opt, opt1, desc) = res.groups()
632 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
635 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
636 print "Layout file " + file + " has no \DeclareXXClass line. "
640 def checkLatexConfig(check_config, bool_docbook):
641 ''' Explore the LaTeX configuration
642 Return None (will be passed to sys.exit()) for success.
644 print 'checking LaTeX configuration... ',
645 # if --without-latex-config is forced, or if there is no previous
646 # version of textclass.lst, re-generate a default file.
647 if not os.path.isfile('textclass.lst') or not check_config:
648 # remove the files only if we want to regenerate
649 removeFiles(['textclass.lst', 'packages.lst'])
651 # Then, generate a default textclass.lst. In case configure.py
652 # fails, we still have something to start lyx.
653 print ' default values'
654 print '+checking list of textclasses... '
655 tx = open('textclass.lst', 'w')
657 # This file declares layouts and their associated definition files
658 # (include dir. relative to the place where this file is).
659 # It contains only default values, since chkconfig.ltx could not be run
660 # for some reason. Run ./configure.py if you need to update it after a
661 # configuration change.
663 # build the list of available layout files and convert it to commands
666 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
667 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
669 if not os.path.isfile(file):
671 # get stuff between /xxxx.layout .
672 classname = file.split(os.sep)[-1].split('.')[0]
674 cleanclass = classname.replace(' ', '_')
675 cleanclass = cleanclass.replace('-', '_')
676 # make sure the same class is not considered twice
677 if foundClasses.count(cleanclass) == 0: # not found before
678 foundClasses.append(cleanclass)
679 retval = processLayoutFile(file, bool_docbook)
686 # the following will generate textclass.lst.tmp, and packages.lst.tmp
689 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
690 'chkconfig.classes', 'chklayouts.tex'])
692 if not os.path.isfile( 'chkconfig.ltx' ):
693 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
695 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
696 # Construct the list of classes to test for.
697 # build the list of available layout files and convert it to commands
699 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
701 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
702 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
703 if not os.path.isfile(file):
705 classname = file.split(os.sep)[-1].split('.')[0]
706 for line in open(file).readlines():
707 if p1.search(line) == None:
710 print "Wrong input layout file with line '" + line
712 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
715 cl = open('chklayouts.tex', 'w')
716 for line in testclasses:
717 cl.write(line + '\n')
720 # we have chklayouts.tex, then process it
721 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
723 line = fout.readline()
726 if re.match('^\+', line):
728 # if the command succeeds, None will be returned
731 # currently, values in chhkconfig are only used to set
734 for line in open('chkconfig.vars').readlines():
735 key, val = re.sub('-', '_', line).split('=')
737 values[key] = val.strip("'")
738 # chk_fontenc may not exist
740 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
743 if rmcopy: # remove the copied file
744 removeFiles( [ 'chkconfig.ltx' ] )
745 # if configure successed, move textclass.lst.tmp to textclass.lst
746 # and packages.lst.tmp to packages.lst
747 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
748 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
749 shutil.move('textclass.lst.tmp', 'textclass.lst')
750 shutil.move('packages.lst.tmp', 'packages.lst')
754 def checkModulesConfig():
755 removeFiles(['lyxmodules.lst'])
757 print '+checking list of modules... '
758 tx = open('lyxmodules.lst', 'w')
759 tx.write('''## This file declares modules and their associated definition files.
760 ## It has been automatically generated by configure
761 ## Use "Options/Reconfigure" if you need to update it after a
762 ## configuration change.
764 # build the list of available modules
766 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
767 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
770 if not os.path.isfile(file):
772 retval = processModuleFile(file, bool_docbook)
779 def processModuleFile(file, bool_docbook):
780 ''' process module file and get a line of result
782 The top of a module file should look like this:
783 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
785 #...body of description...
787 #Requires: [list of required modules]
788 #Excludes: [list of excluded modules]
789 The last two lines are optional
791 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
793 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
794 r = re.compile(r'#+\s*Requires: (.*)')
795 x = re.compile(r'#+\s*Excludes: (.*)')
796 b = re.compile(r'#+\s*DescriptionBegin\s*$')
797 e = re.compile(r'#+\s*DescriptionEnd\s*$')
799 modname = desc = pkgs = req = excl = ""
800 readingDescription = False
802 filename = file.split(os.sep)[-1]
803 filename = filename[:-7]
805 for line in open(file).readlines():
806 if readingDescription:
809 readingDescription = False
810 desc = " ".join(descLines)
812 descLines.append(line[1:].strip())
816 readingDescription = True
820 (pkgs, modname) = res.groups()
824 tmp = [s.strip() for s in pkgs.split(",")]
830 tmp = [s.strip() for s in req.split("|")]
836 tmp = [s.strip() for s in excl.split("|")]
840 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
841 print "Module file without \DeclareLyXModule line. "
845 def checkTeXAllowSpaces():
846 ''' Let's check whether spaces are allowed in TeX file names '''
847 tex_allows_spaces = 'false'
849 print "Checking whether TeX allows spaces in file names... ",
850 writeToFile('a b.tex', r'\message{working^^J}' )
852 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
854 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
855 if 'working' in latex_out:
857 tex_allows_spaces = 'true'
860 tex_allows_spaces = 'false'
861 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
862 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
865 def removeTempFiles():
867 if not lyx_keep_temps:
868 removeFiles(['chkconfig.vars', \
869 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
870 'chklayouts.tex', 'missfont.log',
871 'chklatex.ltx', 'chklatex.log'])
874 if __name__ == '__main__':
875 lyx_check_config = True
876 outfile = 'lyxrc.defaults'
878 lyx_keep_temps = False
880 logfile = 'configure.log'
881 ## Parse the command line
882 for op in sys.argv[1:]: # default shell/for list is $*, the options
883 if op in [ '-help', '--help', '-h' ]:
884 print '''Usage: configure [options]
886 --help show this help lines
887 --keep-temps keep temporary files (for debug. purposes)
888 --without-latex-config do not run LaTeX to determine configuration
889 --with-version-suffix=suffix suffix of binary installed files
892 elif op == '--without-latex-config':
893 lyx_check_config = False
894 elif op == '--keep-temps':
895 lyx_keep_temps = True
896 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
897 version_suffix = op[22:]
899 print "Unknown option", op
902 # set up log file for stdout and stderr
903 log = open(logfile, 'w')
904 sys.stdout = Tee(sys.stdout, log)
905 sys.stderr = Tee(sys.stderr, log)
906 # check if we run from the right directory
907 srcdir = os.path.dirname(sys.argv[0])
910 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
911 print "configure: error: cannot find chkconfig.ltx script"
915 windows_style_tex_paths = checkTeXPaths()
916 dtl_tools = checkDTLtools()
917 ## Write the first part of outfile
918 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
919 # script. It contains default settings that have been determined by
920 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
921 # want to customize LyX, use LyX' Preferences dialog or modify directly
922 # the "preferences" file instead. Any setting in that file will
923 # override the values given here.
926 LATEX = checkLatex(dtl_tools)
927 checkFormatEntries(dtl_tools)
928 checkConverterEntries()
929 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
930 checkTeXAllowSpaces()
931 if windows_style_tex_paths != '':
932 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
934 # --without-latex-config can disable lyx_check_config
935 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
936 checkModulesConfig() #lyx_check_config and LATEX != '')
938 # The return error code can be 256. Because most systems expect an error code
939 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
940 # a None for success, 'ret is not None' is used to exit.
941 sys.exit(ret is not None)