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 # use LATEX to convert from latex to dvi if PPLATEX is not available
207 # Windows only: DraftDVI
208 addToRC(r'''\converter latex dvi2 "%s" "latex"
209 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
211 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
214 # Check if latex is usable
215 writeToFile('chklatex.ltx', '''
216 \\nonstopmode\\makeatletter
217 \\ifx\\undefined\\documentclass\\else
218 \\message{ThisIsLaTeX2e}
222 # run latex on chklatex.ltx and check result
223 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
227 print "Latex not usable (not LaTeX2e) "
228 # remove temporary files
229 removeFiles(['chklatex.ltx', 'chklatex.log'])
233 def checkFormatEntries(dtl_tools):
234 ''' Check all formats (\Format entries) '''
235 checkViewer('a Tgif viewer and editor', ['tgif'],
236 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
238 checkViewer('a FIG viewer and editor', ['xfig'],
239 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
241 checkViewer('a Grace viewer and editor', ['xmgrace'],
242 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
244 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
245 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
247 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
248 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
249 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
250 \Format gif gif GIF "" "%s" "%s" ""
251 \Format jpg jpg JPEG "" "%s" "%s" ""
252 \Format pbm pbm PBM "" "%s" "%s" ""
253 \Format pgm pgm PGM "" "%s" "%s" ""
254 \Format png png PNG "" "%s" "%s" ""
255 \Format ppm ppm PPM "" "%s" "%s" ""
256 \Format tiff tif TIFF "" "%s" "%s" ""
257 \Format xbm xbm XBM "" "%s" "%s" ""
258 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
259 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
261 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
262 'nedit', 'gedit', 'notepad'],
263 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
264 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
265 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
266 \Format dateout tmp "date (output)" "" "" "%%" ""
267 \Format docbook sgml DocBook B "" "%%" "document"
268 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
269 \Format literate nw NoWeb N "" "%%" "document"
270 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
271 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
272 \Format linuxdoc sgml LinuxDoc x "" "%%" "document"
273 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
274 \Format text txt "Plain text" a "" "%%" "document"
275 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
276 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
277 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
278 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
280 #checkProg('a Postscript interpreter', ['gs'],
281 # rc_entry = [ r'\ps_command "%%"' ])
282 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
283 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
284 \Format ps ps Postscript t "%%" "" "document,vector"'''])
286 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
288 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
289 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
290 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
292 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
293 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
295 # Windows only: DraftDVI
296 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
298 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
299 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
301 checkViewer('Noteedit', ['noteedit'],
302 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
304 checkViewer('an OpenDocument viewer', ['oowriter'],
305 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
307 # entried that do not need checkProg
308 addToRC(r'''\Format date "" "date command" "" "" "" ""
309 \Format fax "" Fax "" "" "" "document"
310 \Format lyx lyx LyX "" "" "" ""
311 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
312 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
313 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
314 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
315 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
316 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
317 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
318 \Format pdftex pdftex_t PDFTEX "" "" "" ""
319 \Format program "" Program "" "" "" ""
320 \Format pstex pstex_t PSTEX "" "" "" ""
321 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
322 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
323 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
324 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
325 \Format word doc "MS Word" W "" "" "document,vector"
326 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
330 def checkConverterEntries():
331 ''' Check all converters (\converter entries) '''
332 checkProg('the pdflatex program', ['pdflatex $$i'],
333 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
335 ''' If we're running LyX in-place then tex2lyx will be found in
336 ../src/tex2lyx. Add this directory to the PATH temporarily and
338 Use PATH to avoid any problems with paths-with-spaces.
340 path_orig = os.environ["PATH"]
341 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
342 os.pathsep + path_orig
344 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
345 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
346 \converter literate lyx "%% -n -f $$i $$o" ""'''])
348 os.environ["PATH"] = path_orig
351 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
352 rc_entry = [ r'\converter literate latex "%%" ""' ])
354 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
355 rc_entry = [ r'\converter html latex "%%" ""' ])
357 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
358 rc_entry = [ r'\converter word latex "%%" ""' ])
359 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
360 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
361 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
362 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
363 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
364 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
365 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
367 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
369 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
370 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
371 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
372 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
373 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
374 if htmlconv.find('htlatex') >= 0:
375 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
377 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
378 rc_entry = [ r'\converter sxw latex "%%" ""' ])
380 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
381 rc_entry = [ r'\converter odt latex "%%" ""' ])
382 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
383 # Both SuSE and debian have oolatex
384 checkProg('a LaTeX -> Open Document converter', [
385 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\'', \
386 'oolatex $$i', 'oolatex.sh $$i', \
387 '/usr/share/tex4ht/oolatex $$i'],
388 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
389 # On windows it is called latex2rt.exe
390 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
391 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
393 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
394 rc_entry = [ r'\converter ps pdf "%%" ""' ])
396 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
397 rc_entry = [ r'\converter ps text2 "%%" ""' ])
399 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
400 rc_entry = [ r'\converter ps text3 "%%" ""' ])
402 checkProg('a PS to EPS converter', ['ps2eps $$i'],
403 rc_entry = [ r'\converter ps eps "%%" ""' ])
405 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
406 rc_entry = [ r'\converter pdf ps "%%" ""' ])
408 checkProg('a PDF to EPS converter', ['pdftops -eps $$i $$o'],
409 rc_entry = [ r'\converter pdf eps "%%" ""' ])
411 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
412 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
414 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
415 rc_entry = [ r'\converter dvi ps "%%" ""' ])
417 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
418 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
420 path, dvipng = checkProg('dvipng', ['dvipng'])
421 if dvipng == "dvipng":
422 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
424 addToRC(r'\converter lyxpreview png "" ""')
426 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
427 rc_entry = [ r'\converter ps fax "%%" ""'])
429 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
431 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
432 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
433 \converter fig png "fig2dev -L png $$i $$o" ""''',
436 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
437 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
439 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
441 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
442 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
443 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
444 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
447 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
448 rc_entry = [ r'\converter wmf eps "%%" ""'])
450 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
451 rc_entry = [ r'\converter emf eps "%%" ""'])
453 checkProg('an EPS -> PDF converter', ['epstopdf'],
454 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
456 # no agr -> pdf converter, since the pdf library used by gracebat is not
457 # free software and therefore not compiled in in many installations.
458 # Fortunately, this is not a big problem, because we will use epstopdf to
459 # convert from agr to pdf via eps without loss of quality.
460 checkProg('a Grace -> Image converter', ['gracebat'],
462 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
463 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
464 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
465 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
469 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
471 version_string = cmdOutput("lilypond --version")
472 match = re.match('GNU LilyPond (\S+)', version_string)
474 version_number = match.groups()[0]
475 version = version_number.split('.')
476 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
477 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
478 \converter lilypond png "lilypond -b eps --png $$i" ""''')
479 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
480 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
481 print '+ found LilyPond version %s.' % version_number
483 print '+ found LilyPond, but version %s is too old.' % version_number
485 print '+ found LilyPond, but could not extract version number.'
487 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
488 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
490 # FIXME: no rc_entry? comment it out
491 # checkProg('Image converter', ['convert $$i $$o'])
493 # Entries that do not need checkProg
494 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
495 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
496 \converter docbook docbook-xml "cp $$i $$o" "xml"
497 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
498 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
499 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
500 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
501 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
502 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
503 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
504 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
505 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
506 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
507 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
508 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
513 ''' Check linuxdoc '''
515 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
517 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
518 \converter linuxdoc latex "sgml2latex $$i" ""
519 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
520 \converter linuxdoc html "sgml2html $$i" ""''',
521 r'''\converter linuxdoc lyx "" ""
522 \converter linuxdoc latex "" ""
523 \converter linuxdoc dvi "" ""
524 \converter linuxdoc html "" ""''' ])
526 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
528 return ('no', 'false', '')
532 ''' Check docbook '''
533 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
535 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
536 \converter docbook html "sgmltools -b html $$i" ""''',
537 r'''\converter docbook dvi "db2dvi $$i" ""
538 \converter docbook html "db2html $$i" ""''',
539 r'''\converter docbook dvi "" ""
540 \converter docbook html "" ""'''])
543 return ('yes', 'true', '\\def\\hasdocbook{yes}')
545 return ('no', 'false', '')
548 def checkOtherEntries():
549 ''' entries other than Format and Converter '''
550 checkProg('a *roff formatter', ['groff', 'nroff'],
552 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
553 r'\plaintext_roff_command "tbl $$FName | nroff"',
554 r'\plaintext_roff_command ""' ])
555 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
556 rc_entry = [ r'\chktex_command "%%"' ])
557 checkProg('a spellchecker', ['ispell'],
558 rc_entry = [ r'\spell_command "%%"' ])
559 ## FIXME: OCTAVE is not used anywhere
560 # path, OCTAVE = checkProg('Octave', ['octave'])
561 ## FIXME: MAPLE is not used anywhere
562 # path, MAPLE = checkProg('Maple', ['maple'])
563 checkProg('a spool command', ['lp', 'lpr'],
565 r'''\print_spool_printerprefix "-d "
566 \print_spool_command "lp"''',
567 r'''\print_spool_printerprefix "-P",
568 \print_spool_command "lpr"''',
570 # Add the rest of the entries (no checkProg is required)
571 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
572 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
573 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
574 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
578 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
579 ''' process layout file and get a line of result
581 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
583 \DeclareLaTeXClass{article}
584 \DeclareLaTeXClass[scrbook]{book (koma-script)}
585 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
589 "article" "article" "article" "false"
590 "scrbook" "scrbook" "book (koma-script)" "false"
591 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
593 classname = file.split(os.sep)[-1].split('.')[0]
594 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
595 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
596 for line in open(file).readlines():
599 (classtype, optAll, opt, opt1, desc) = res.groups()
600 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
603 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
604 print "Layout file without \DeclareXXClass line. "
608 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
609 ''' Explore the LaTeX configuration
610 Return None (will be passed to sys.exit()) for success.
612 print 'checking LaTeX configuration... ',
613 # if --without-latex-config is forced, or if there is no previous
614 # version of textclass.lst, re-generate a default file.
615 if not os.path.isfile('textclass.lst') or not check_config:
616 # remove the files only if we want to regenerate
617 removeFiles(['textclass.lst', 'packages.lst'])
619 # Then, generate a default textclass.lst. In case configure.py
620 # fails, we still have something to start lyx.
621 print ' default values'
622 print '+checking list of textclasses... '
623 tx = open('textclass.lst', 'w')
625 # This file declares layouts and their associated definition files
626 # (include dir. relative to the place where this file is).
627 # It contains only default values, since chkconfig.ltx could not be run
628 # for some reason. Run ./configure.py if you need to update it after a
629 # configuration change.
631 # build the list of available layout files and convert it to commands
634 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
635 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
637 if not os.path.isfile(file):
639 # get stuff between /xxxx.layout .
640 classname = file.split(os.sep)[-1].split('.')[0]
642 cleanclass = classname.replace(' ', '_')
643 cleanclass = cleanclass.replace('-', '_')
644 # make sure the same class is not considered twice
645 if foundClasses.count(cleanclass) == 0: # not found before
646 foundClasses.append(cleanclass)
647 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
652 # the following will generate textclass.lst.tmp, and packages.lst.tmp
655 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
656 'chkconfig.classes', 'chklayouts.tex'])
658 if not os.path.isfile( 'chkconfig.ltx' ):
659 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
661 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
662 % (linuxdoc_cmd, docbook_cmd) )
663 # Construct the list of classes to test for.
664 # build the list of available layout files and convert it to commands
666 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
668 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
669 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
670 if not os.path.isfile(file):
672 classname = file.split(os.sep)[-1].split('.')[0]
673 for line in open(file).readlines():
674 if p1.search(line) == None:
677 print "Wrong input layout file with line '" + line
679 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
682 cl = open('chklayouts.tex', 'w')
683 for line in testclasses:
684 cl.write(line + '\n')
687 # we have chklayouts.tex, then process it
688 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
690 line = fout.readline()
693 if re.match('^\+', line):
695 # if the command succeeds, None will be returned
698 # currently, values in chhkconfig are only used to set
701 for line in open('chkconfig.vars').readlines():
702 key, val = re.sub('-', '_', line).split('=')
704 values[key] = val.strip("'")
705 # chk_fontenc may not exist
707 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
710 if rmcopy: # remove the copied file
711 removeFiles( [ 'chkconfig.ltx' ] )
712 # if configure successed, move textclass.lst.tmp to textclass.lst
713 # and packages.lst.tmp to packages.lst
714 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
715 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
716 shutil.move('textclass.lst.tmp', 'textclass.lst')
717 shutil.move('packages.lst.tmp', 'packages.lst')
721 def checkModulesConfig():
722 removeFiles(['lyxmodules.lst'])
724 print '+checking list of modules... '
725 tx = open('lyxmodules.lst', 'w')
726 tx.write('''## This file declares modules and their associated definition files.
727 ## It has been automatically generated by configure
728 ## Use "Options/Reconfigure" if you need to update it after a
729 ## configuration change.
731 # build the list of available modules
733 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
734 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
737 if not os.path.isfile(file):
739 tx.write(processModuleFile(file, bool_docbook, bool_linuxdoc))
744 def processModuleFile(file, bool_docbook, bool_linuxdoc):
745 ''' process module file and get a line of result
747 The top of a module file should look like this:
748 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
750 #...body of description...
752 #Requires: [list of required modules]
753 #Excludes: [list of excluded modules]
754 The last two lines are optional
756 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
758 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
759 r = re.compile(r'#+\s*Requires: (.*)')
760 x = re.compile(r'#+\s*Excludes: (.*)')
761 b = re.compile(r'#+\s*DescriptionBegin\s*$')
762 e = re.compile(r'#+\s*DescriptionEnd\s*$')
764 modname = desc = pkgs = req = excl = ""
765 readingDescription = False
767 filename = file.split(os.sep)[-1]
768 filename = filename[:-7]
770 for line in open(file).readlines():
771 if readingDescription:
774 readingDescription = False
775 desc = " ".join(descLines)
777 descLines.append(line[1:].strip())
781 readingDescription = True
785 (pkgs, modname) = res.groups()
789 tmp = [s.strip() for s in pkgs.split(",")]
795 tmp = [s.strip() for s in req.split("|")]
801 tmp = [s.strip() for s in excl.split("|")]
805 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
806 print "Module file without \DeclareLyXModule line. "
810 def checkTeXAllowSpaces():
811 ''' Let's check whether spaces are allowed in TeX file names '''
812 tex_allows_spaces = 'false'
814 print "Checking whether TeX allows spaces in file names... ",
815 writeToFile('a b.tex', r'\message{working^^J}' )
817 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
819 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
820 if 'working' in latex_out:
822 tex_allows_spaces = 'true'
825 tex_allows_spaces = 'false'
826 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
827 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
830 def removeTempFiles():
832 if not lyx_keep_temps:
833 removeFiles(['chkconfig.vars', \
834 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
835 'chklayouts.tex', 'missfont.log',
836 'chklatex.ltx', 'chklatex.log'])
839 if __name__ == '__main__':
840 lyx_check_config = True
841 outfile = 'lyxrc.defaults'
843 lyx_keep_temps = False
845 logfile = 'configure.log'
846 ## Parse the command line
847 for op in sys.argv[1:]: # default shell/for list is $*, the options
848 if op in [ '-help', '--help', '-h' ]:
849 print '''Usage: configure [options]
851 --help show this help lines
852 --keep-temps keep temporary files (for debug. purposes)
853 --without-latex-config do not run LaTeX to determine configuration
854 --with-version-suffix=suffix suffix of binary installed files
857 elif op == '--without-latex-config':
858 lyx_check_config = False
859 elif op == '--keep-temps':
860 lyx_keep_temps = True
861 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
862 version_suffix = op[22:]
864 print "Unknown option", op
867 # set up log file for stdout and stderr
868 log = open(logfile, 'w')
869 sys.stdout = Tee(sys.stdout, log)
870 sys.stderr = Tee(sys.stderr, log)
871 # check if we run from the right directory
872 srcdir = os.path.dirname(sys.argv[0])
875 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
876 print "configure: error: cannot find chkconfig.ltx script"
880 windows_style_tex_paths = checkTeXPaths()
881 dtl_tools = checkDTLtools()
882 ## Write the first part of outfile
883 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
884 # script. It contains default settings that have been determined by
885 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
886 # want to customize LyX, use LyX' Preferences dialog or modify directly
887 # the "preferences" file instead. Any setting in that file will
888 # override the values given here.
891 LATEX = checkLatex(dtl_tools)
892 checkFormatEntries(dtl_tools)
893 checkConverterEntries()
894 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
895 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
896 checkTeXAllowSpaces()
897 if windows_style_tex_paths != '':
898 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
900 # --without-latex-config can disable lyx_check_config
901 ret = checkLatexConfig(lyx_check_config and LATEX != '',
902 bool_docbook, bool_linuxdoc)
903 checkModulesConfig() #lyx_check_config and LATEX != '')
905 # The return error code can be 256. Because most systems expect an error code
906 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
907 # a None for success, 'ret is not None' is used to exit.
908 sys.exit(ret is not None)