2 # -*- coding: utf-8 -*-
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 import sys, os, re, shutil, glob, logging
14 logging.basicConfig(level = logging.DEBUG,
15 format = '%(levelname)s: %(message)s', # ignore application name
16 filename = 'configure.log',
19 # Add a handler to log to console
20 console = logging.StreamHandler()
21 console.setLevel(logging.INFO) # the console only print out general information
22 formatter = logging.Formatter('%(message)s') # only print out the message itself
23 console.setFormatter(formatter)
24 logger = logging.getLogger('LyX')
25 logger.addHandler(console)
27 def writeToFile(filename, lines, append = False):
28 " utility function: write or append lines to filename "
30 file = open(filename, 'a')
32 file = open(filename, 'w')
38 ''' utility function: shortcut for appending lines to outfile
39 add newline at the end of lines.
41 if lines.strip() != '':
42 writeToFile(outfile, lines + '\n', append = True)
43 logger.debug('Add to RC:\n' + lines + '\n\n')
46 def removeFiles(filenames):
47 '''utility function: 'rm -f'
48 ignore errors when file does not exist, or is a directory.
50 for file in filenames:
53 logger.debug('Removing file %s' % file)
55 logger.debug('Failed to remove file %s' % file)
60 '''utility function: run a command and get its output as a string
70 ''' I do not really know why this is useful, but we might as well keep it.
72 Only set these to C if already set. These must not be set unconditionally
73 because not all systems understand e.g. LANG=C (notably SCO).
74 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
75 Non-C LC_CTYPE values break the ctype check.
77 os.environ['LANG'] = os.getenv('LANG', 'C')
78 os.environ['LC'] = os.getenv('LC_ALL', 'C')
79 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
80 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
83 def createDirectories():
84 ''' Create the build directories if necessary '''
85 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
86 'layouts', 'scripts', 'templates', 'ui' ]:
87 if not os.path.isdir( dir ):
90 logger.debug('Create directory %s.' % dir)
92 logger.error('Failed to create directory %s.' % dir)
97 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
98 windows_style_tex_paths = ''
99 if os.name == 'nt' or sys.platform == 'cygwin':
100 from tempfile import mkstemp
101 fd, tmpfname = mkstemp(suffix='.ltx')
103 inpname = tmpfname.replace('\\', '/')
105 inpname = cmdOutput('cygpath -m ' + tmpfname)
106 logname = os.path.basename(inpname.replace('.ltx', '.log'))
107 inpname = inpname.replace('~', '\\string~')
108 os.write(fd, r'\relax')
110 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
111 if 'Error' in latex_out:
112 logger.warning("configure: TeX engine needs posix-style paths in latex files")
113 windows_style_tex_paths = 'false'
115 logger.info("configure: TeX engine needs windows-style paths in latex files")
116 windows_style_tex_paths = 'true'
117 removeFiles([tmpfname, logname, 'texput.log'])
118 return windows_style_tex_paths
121 ## Searching some useful programs
122 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
124 This function will search a program in $PATH plus given path
125 If found, return directory and program name (not the options).
127 description: description of the program
129 progs: check programs, for each prog, the first word is used
130 for searching but the whole string is used to replace
131 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
133 path: additional pathes
135 rc_entry: entry to outfile, can be
136 1. emtpy: no rc entry will be added
137 2. one pattern: %% will be replaced by the first found program,
138 or '' if no program is found.
139 3. several patterns for each prog and not_found. This is used
140 when different programs have different usages. If you do not
141 want not_found entry to be added to the RC file, you can specify
142 an entry for each prog and use '' for the not_found entry.
144 not_found: the value that should be used instead of '' if no program
148 # one rc entry for each progs plus not_found entry
149 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
150 logger.error("rc entry should have one item or item for each prog and not_found.")
152 logger.info('checking for ' + description + '...')
153 ## print '(' + ','.join(progs) + ')',
154 for idx in range(len(progs)):
155 # ac_prog may have options, ac_word is the command name
157 ac_word = ac_prog.split(' ')[0]
158 msg = '+checking for "' + ac_word + '"... '
159 path = os.environ["PATH"].split(os.pathsep) + path
161 if os.environ.has_key("PATHEXT"):
162 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
165 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
166 logger.info(msg + ' yes')
167 # write rc entries for this command
168 if len(rc_entry) == 1:
169 addToRC(rc_entry[0].replace('%%', ac_prog))
170 elif len(rc_entry) > 1:
171 addToRC(rc_entry[idx].replace('%%', ac_prog))
172 return [ac_dir, ac_word]
174 logger.info(msg + ' no')
175 # write rc entries for 'not found'
176 if len(rc_entry) > 0: # the last one.
177 addToRC(rc_entry[-1].replace('%%', not_found))
178 return ['', not_found]
181 def checkViewer(description, progs, rc_entry = [], path = []):
182 ''' The same as checkProg, but for viewers and editors '''
183 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
187 ''' Check whether DTL tools are available (Windows only) '''
188 # Find programs! Returned path is not used now
189 if ((os.name == 'nt' or sys.platform == 'cygwin') and
190 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
191 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
198 def checkLatex(dtl_tools):
199 ''' Check latex, return lyx_check_config '''
200 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
201 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
202 #-----------------------------------------------------------------
203 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 logger.warning("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 Dia viewer and editor', ['dia'],
258 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector"'])
260 checkViewer('a Grace viewer and editor', ['xmgrace'],
261 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
263 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
264 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
266 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
267 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
268 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
269 \Format gif gif GIF "" "%s" "%s" ""
270 \Format jpg jpg JPEG "" "%s" "%s" ""
271 \Format pbm pbm PBM "" "%s" "%s" ""
272 \Format pgm pgm PGM "" "%s" "%s" ""
273 \Format png png PNG "" "%s" "%s" ""
274 \Format ppm ppm PPM "" "%s" "%s" ""
275 \Format tiff tif TIFF "" "%s" "%s" ""
276 \Format xbm xbm XBM "" "%s" "%s" ""
277 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
278 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
280 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
281 'nedit', 'gedit', 'notepad'],
282 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
283 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
284 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
285 \Format dateout tmp "date (output)" "" "" "%%" ""
286 \Format docbook sgml DocBook B "" "%%" "document"
287 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
288 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
289 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
290 \Format literate nw NoWeb N "" "%%" "document"
291 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
292 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
293 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
294 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "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"
319 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector"'''])
321 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
322 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
324 # Windows only: DraftDVI
325 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
327 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
328 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
330 checkViewer('Noteedit', ['noteedit'],
331 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
333 checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
334 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
336 # entried that do not need checkProg
337 addToRC(r'''\Format date "" "date command" "" "" "" ""
338 \Format csv csv "Table (CSV)" "" "" "" "document"
339 \Format fax "" Fax "" "" "" "document"
340 \Format lyx lyx LyX "" "" "" ""
341 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
342 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
343 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
344 \Format lyx16x lyx16 "LyX 1.6.x" "" "" "" "document"
345 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
346 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
347 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
348 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
349 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
350 \Format pdftex pdftex_t PDFTEX "" "" "" ""
351 \Format program "" Program "" "" "" ""
352 \Format pstex pstex_t PSTEX "" "" "" ""
353 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
354 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
355 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
356 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
357 \Format word doc "MS Word" W "" "" "document,vector"
358 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
362 def checkConverterEntries():
363 ''' Check all converters (\converter entries) '''
364 checkProg('the pdflatex program', ['pdflatex $$i'],
365 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
367 checkProg('XeTeX', ['xelatex $$i'],
368 rc_entry = [ r'\converter xetex pdf4 "%%" "latex"' ])
370 ''' If we're running LyX in-place then tex2lyx will be found in
371 ../src/tex2lyx. Add this directory to the PATH temporarily and
373 Use PATH to avoid any problems with paths-with-spaces.
375 path_orig = os.environ["PATH"]
376 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
377 os.pathsep + path_orig
379 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
380 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
381 \converter literate lyx "%% -n -f $$i $$o" ""'''])
383 os.environ["PATH"] = path_orig
386 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
387 rc_entry = [r'''\converter literate latex "%%" ""
388 \converter literate pdflatex "%%" ""'''])
390 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
391 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
392 rc_entry = [ r'\converter html latex "%%" ""' ])
394 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
395 rc_entry = [ r'\converter word latex "%%" ""' ])
396 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
397 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
398 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
399 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
400 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
401 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
402 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
404 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
406 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
407 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
408 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
409 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
410 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
411 if htmlconv.find('htlatex') >= 0:
412 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
414 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
415 rc_entry = [ r'\converter sxw latex "%%" ""' ])
417 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
418 rc_entry = [ r'\converter odt latex "%%" ""' ])
419 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
420 # the command mk4ht oolatex $$i has to be used as default,
421 # but as this would require to have Perl installed, in MiKTeX oolatex is
422 # directly available as application.
423 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
424 # Both SuSE and debian have oolatex
425 checkProg('a LaTeX -> Open Document converter', [
426 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
427 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
428 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
429 # On windows it is called latex2rt.exe
430 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
431 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
433 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
434 rc_entry = [ r'\converter rtf html "%%" ""' ])
436 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
437 rc_entry = [ r'\converter ps pdf "%%" ""' ])
439 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
440 rc_entry = [ r'\converter ps text2 "%%" ""' ])
442 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
443 rc_entry = [ r'\converter ps text3 "%%" ""' ])
445 checkProg('a PS to EPS converter', ['ps2eps $$i'],
446 rc_entry = [ r'\converter ps eps "%%" ""' ])
448 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
449 rc_entry = [ r'\converter pdf ps "%%" ""' ])
451 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
452 rc_entry = [ r'\converter pdf eps "%%" ""' ])
454 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
455 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
457 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
458 rc_entry = [ r'\converter dvi ps "%%" ""' ])
460 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
461 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
463 path, dvipng = checkProg('dvipng', ['dvipng'])
464 if dvipng == "dvipng":
465 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
467 addToRC(r'\converter lyxpreview png "" ""')
469 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
470 rc_entry = [ r'\converter ps fax "%%" ""'])
472 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
474 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
475 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
476 \converter fig png "fig2dev -L png $$i $$o" ""''',
479 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
480 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
482 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
484 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
485 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
486 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
489 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
490 rc_entry = [ r'\converter wmf eps "%%" ""'])
492 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
493 rc_entry = [ r'\converter emf eps "%%" ""'])
495 checkProg('an EPS -> PDF converter', ['epstopdf'],
496 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
498 # no agr -> pdf converter, since the pdf library used by gracebat is not
499 # free software and therefore not compiled in in many installations.
500 # Fortunately, this is not a big problem, because we will use epstopdf to
501 # convert from agr to pdf via eps without loss of quality.
502 checkProg('a Grace -> Image converter', ['gracebat'],
504 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
505 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
506 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
507 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
510 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
511 rc_entry = [ r'\converter dot pdf "%%" ""'])
513 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
514 rc_entry = [ r'\converter dia png "%%" ""'])
516 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
517 rc_entry = [ r'\converter dia eps "%%" ""'])
520 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
522 version_string = cmdOutput("lilypond --version")
523 match = re.match('GNU LilyPond (\S+)', version_string)
525 version_number = match.groups()[0]
526 version = version_number.split('.')
527 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
528 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps --ps $$i" ""
529 \converter lilypond png "lilypond -dbackend=eps --png $$i" ""''')
530 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps --pdf $$i" ""')
531 print '+ found LilyPond version %s.' % version_number
532 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
533 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
534 \converter lilypond png "lilypond -b eps --png $$i" ""''')
535 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
536 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
537 logger.info('+ found LilyPond version %s.' % version_number)
539 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
541 logger.info('+ found LilyPond, but could not extract version number.')
543 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
544 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
546 # FIXME: no rc_entry? comment it out
547 # checkProg('Image converter', ['convert $$i $$o'])
549 # Entries that do not need checkProg
550 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
551 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
552 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
553 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
554 \converter docbook docbook-xml "cp $$i $$o" "xml"
555 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
556 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
557 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
558 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
559 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
560 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
561 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
562 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
563 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
564 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
565 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
566 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
567 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
572 ''' Check docbook '''
573 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
575 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
576 \converter docbook html "sgmltools -b html $$i" ""''',
577 r'''\converter docbook dvi "db2dvi $$i" ""
578 \converter docbook html "db2html $$i" ""''',
579 r'''\converter docbook dvi "" ""
580 \converter docbook html "" ""''',
581 r'''\converter docbook dvi "" ""
582 \converter docbook html "" ""'''])
585 return ('yes', 'true', '\\def\\hasdocbook{yes}')
587 return ('no', 'false', '')
590 def checkOtherEntries():
591 ''' entries other than Format and Converter '''
592 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
593 rc_entry = [ r'\chktex_command "%%"' ])
594 checkProg('BibTeX', ['bibtex'],
595 rc_entry = [ r'\bibtex_command "%%"' ])
596 checkProg('JBibTeX, the Japanese BibTeX', ['jbibtex', 'bibtex'],
597 rc_entry = [ r'\jbibtex_command "%%"' ])
598 checkProg('an index processor', ['texindy', 'makeindex -c -q'],
599 rc_entry = [ r'\index_command "%%"' ])
600 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'makeindex -c -q'],
601 rc_entry = [ r'\jindex_command "%%"' ])
602 checkProg('the splitindex processor', ['splitindex.pl', 'java splitindex', 'splitindex'],
603 rc_entry = [ r'\splitindex_command "%%"' ])
604 checkProg('a nomenclature processor', ['makeindex'],
605 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
606 ## FIXME: OCTAVE is not used anywhere
607 # path, OCTAVE = checkProg('Octave', ['octave'])
608 ## FIXME: MAPLE is not used anywhere
609 # path, MAPLE = checkProg('Maple', ['maple'])
610 checkProg('a spool command', ['lp', 'lpr'],
612 r'''\print_spool_printerprefix "-d "
613 \print_spool_command "lp"''',
614 r'''\print_spool_printerprefix "-P",
615 \print_spool_command "lpr"''',
617 # Add the rest of the entries (no checkProg is required)
618 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
619 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
620 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
621 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
625 def processLayoutFile(file, bool_docbook):
626 ''' process layout file and get a line of result
628 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
630 \DeclareLaTeXClass{article}
631 \DeclareLaTeXClass[scrbook]{book (koma-script)}
632 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
636 "article" "article" "article" "false"
637 "scrbook" "scrbook" "book (koma-script)" "false"
638 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
640 classname = file.split(os.sep)[-1].split('.')[0]
641 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
642 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
643 for line in open(file).readlines():
646 (classtype, optAll, opt, opt1, desc) = res.groups()
647 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
650 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
651 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
655 def checkLatexConfig(check_config, bool_docbook):
656 ''' Explore the LaTeX configuration
657 Return None (will be passed to sys.exit()) for success.
659 msg = 'checking LaTeX configuration... '
660 # if --without-latex-config is forced, or if there is no previous
661 # version of textclass.lst, re-generate a default file.
662 if not os.path.isfile('textclass.lst') or not check_config:
663 # remove the files only if we want to regenerate
664 removeFiles(['textclass.lst', 'packages.lst'])
666 # Then, generate a default textclass.lst. In case configure.py
667 # fails, we still have something to start lyx.
668 logger.info(msg + ' default values')
669 logger.info('+checking list of textclasses... ')
670 tx = open('textclass.lst', 'w')
672 # This file declares layouts and their associated definition files
673 # (include dir. relative to the place where this file is).
674 # It contains only default values, since chkconfig.ltx could not be run
675 # for some reason. Run ./configure.py if you need to update it after a
676 # configuration change.
678 # build the list of available layout files and convert it to commands
681 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
682 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
684 if not os.path.isfile(file):
686 # get stuff between /xxxx.layout .
687 classname = file.split(os.sep)[-1].split('.')[0]
689 cleanclass = classname.replace(' ', '_')
690 cleanclass = cleanclass.replace('-', '_')
691 # make sure the same class is not considered twice
692 if foundClasses.count(cleanclass) == 0: # not found before
693 foundClasses.append(cleanclass)
694 retval = processLayoutFile(file, bool_docbook)
698 logger.info('\tdone')
701 # the following will generate textclass.lst.tmp, and packages.lst.tmp
703 logger.info(msg + '\tauto')
704 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
705 'chkconfig.classes', 'chklayouts.tex'])
707 if not os.path.isfile( 'chkconfig.ltx' ):
708 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
710 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
711 # Construct the list of classes to test for.
712 # build the list of available layout files and convert it to commands
714 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
716 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
717 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
718 if not os.path.isfile(file):
720 classname = file.split(os.sep)[-1].split('.')[0]
721 for line in open(file).readlines():
722 if p1.search(line) == None:
725 logger.error("Wrong input layout file with line '" + line)
727 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
730 cl = open('chklayouts.tex', 'w')
731 for line in testclasses:
732 cl.write(line + '\n')
735 # we have chklayouts.tex, then process it
736 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
738 line = fout.readline()
741 if re.match('^\+', line):
742 logger.info(line.strip())
743 # if the command succeeds, None will be returned
746 # currently, values in chhkconfig are only used to set
749 for line in open('chkconfig.vars').readlines():
750 key, val = re.sub('-', '_', line).split('=')
752 values[key] = val.strip("'")
753 # chk_fontenc may not exist
755 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
758 if rmcopy: # remove the copied file
759 removeFiles( [ 'chkconfig.ltx' ] )
760 # if configure successed, move textclass.lst.tmp to textclass.lst
761 # and packages.lst.tmp to packages.lst
762 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
763 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
764 shutil.move('textclass.lst.tmp', 'textclass.lst')
765 shutil.move('packages.lst.tmp', 'packages.lst')
769 def checkModulesConfig():
770 removeFiles(['lyxmodules.lst'])
772 logger.info('+checking list of modules... ')
773 tx = open('lyxmodules.lst', 'w')
774 tx.write('''## This file declares modules and their associated definition files.
775 ## It has been automatically generated by configure
776 ## Use "Options/Reconfigure" if you need to update it after a
777 ## configuration change.
779 # build the list of available modules
781 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
782 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
785 if not os.path.isfile(file):
787 retval = processModuleFile(file, bool_docbook)
791 logger.info('\tdone')
794 def processModuleFile(file, bool_docbook):
795 ''' process module file and get a line of result
797 The top of a module file should look like this:
798 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
800 #...body of description...
802 #Requires: [list of required modules]
803 #Excludes: [list of excluded modules]
804 The last two lines are optional
806 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
808 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
809 r = re.compile(r'#+\s*Requires: (.*)')
810 x = re.compile(r'#+\s*Excludes: (.*)')
811 b = re.compile(r'#+\s*DescriptionBegin\s*$')
812 e = re.compile(r'#+\s*DescriptionEnd\s*$')
814 modname = desc = pkgs = req = excl = ""
815 readingDescription = False
817 filename = file.split(os.sep)[-1]
818 filename = filename[:-7]
820 for line in open(file).readlines():
821 if readingDescription:
824 readingDescription = False
825 desc = " ".join(descLines)
827 descLines.append(line[1:].strip())
831 readingDescription = True
835 (pkgs, modname) = res.groups()
839 tmp = [s.strip() for s in pkgs.split(",")]
845 tmp = [s.strip() for s in req.split("|")]
851 tmp = [s.strip() for s in excl.split("|")]
855 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
856 logger.warning("Module file without \DeclareLyXModule line. ")
860 def checkTeXAllowSpaces():
861 ''' Let's check whether spaces are allowed in TeX file names '''
862 tex_allows_spaces = 'false'
864 msg = "Checking whether TeX allows spaces in file names... "
865 writeToFile('a b.tex', r'\message{working^^J}' )
867 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
869 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
870 if 'working' in latex_out:
871 logger.info(msg + 'yes')
872 tex_allows_spaces = 'true'
874 logger.info(msg + 'no')
875 tex_allows_spaces = 'false'
876 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
877 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
880 def removeTempFiles():
882 if not lyx_keep_temps:
883 removeFiles(['chkconfig.vars', \
884 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
885 'chklayouts.tex', 'missfont.log',
886 'chklatex.ltx', 'chklatex.log'])
889 if __name__ == '__main__':
890 lyx_check_config = True
891 outfile = 'lyxrc.defaults'
893 lyx_keep_temps = False
895 ## Parse the command line
896 for op in sys.argv[1:]: # default shell/for list is $*, the options
897 if op in [ '-help', '--help', '-h' ]:
898 print '''Usage: configure [options]
900 --help show this help lines
901 --keep-temps keep temporary files (for debug. purposes)
902 --without-latex-config do not run LaTeX to determine configuration
903 --with-version-suffix=suffix suffix of binary installed files
906 elif op == '--without-latex-config':
907 lyx_check_config = False
908 elif op == '--keep-temps':
909 lyx_keep_temps = True
910 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
911 version_suffix = op[22:]
913 print "Unknown option", op
916 # check if we run from the right directory
917 srcdir = os.path.dirname(sys.argv[0])
920 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
921 logger.error("configure: error: cannot find chkconfig.ltx script")
925 windows_style_tex_paths = checkTeXPaths()
926 dtl_tools = checkDTLtools()
927 ## Write the first part of outfile
928 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
929 # script. It contains default settings that have been determined by
930 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
931 # want to customize LyX, use LyX' Preferences dialog or modify directly
932 # the "preferences" file instead. Any setting in that file will
933 # override the values given here.
936 LATEX = checkLatex(dtl_tools)
937 checkFormatEntries(dtl_tools)
938 checkConverterEntries()
939 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
940 checkTeXAllowSpaces()
941 if windows_style_tex_paths != '':
942 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
944 # --without-latex-config can disable lyx_check_config
945 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
946 checkModulesConfig() #lyx_check_config and LATEX != '')
948 # The return error code can be 256. Because most systems expect an error code
949 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
950 # a None for success, 'ret is not None' is used to exit.
951 sys.exit(ret is not None)