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 # check both ac_word and ac_word.exe (for windows system)
163 if os.path.isfile( os.path.join(ac_dir, ac_word) ) or \
164 os.path.isfile( os.path.join(ac_dir, ac_word + ".exe") ):
166 # write rc entries for this command
167 if len(rc_entry) == 1:
168 addToRC(rc_entry[0].replace('%%', ac_prog))
169 elif len(rc_entry) > 1:
170 addToRC(rc_entry[idx].replace('%%', ac_prog))
171 return [ac_dir, ac_word]
174 # write rc entries for 'not found'
175 if len(rc_entry) > 0: # the last one.
176 addToRC(rc_entry[-1].replace('%%', not_found))
177 return ['', not_found]
180 def checkViewer(description, progs, rc_entry = [], path = []):
181 ''' The same as checkProg, but for viewers and editors '''
182 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
186 ''' Check whether DTL tools are available (Windows only) '''
187 # Find programs! Returned path is not used now
188 if ((os.name == 'nt' or sys.platform == 'cygwin') and
189 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
190 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
197 def checkLatex(dtl_tools):
198 ''' Check latex, return lyx_check_config '''
200 # Windows only: DraftDVI
201 converter_entry = r'''\converter latex dvi2 "%%" "latex"
202 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""'''
204 converter_entry = r'\converter latex dvi "%%" "latex"'
205 path, LATEX = checkProg('a Latex2e program', ['pplatex $$i', 'latex $$i', 'latex2e $$i'],
206 rc_entry = [converter_entry])
209 # Check if latex is usable
210 writeToFile('chklatex.ltx', '''
211 \\nonstopmode\\makeatletter
212 \\ifx\\undefined\\documentclass\\else
213 \\message{ThisIsLaTeX2e}
217 # run latex on chklatex.ltx and check result
218 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
222 print "Latex not usable (not LaTeX2e) "
223 # remove temporary files
224 removeFiles(['chklatex.ltx', 'chklatex.log'])
228 def checkFormatEntries(dtl_tools):
229 ''' Check all formats (\Format entries) '''
230 checkViewer('a Tgif viewer and editor', ['tgif'],
231 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
233 checkViewer('a FIG viewer and editor', ['xfig'],
234 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
236 checkViewer('a Grace viewer and editor', ['xmgrace'],
237 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
239 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
240 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
242 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
243 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
244 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
245 \Format gif gif GIF "" "%s" "%s" ""
246 \Format jpg jpg JPEG "" "%s" "%s" ""
247 \Format pbm pbm PBM "" "%s" "%s" ""
248 \Format pgm pgm PGM "" "%s" "%s" ""
249 \Format png png PNG "" "%s" "%s" ""
250 \Format ppm ppm PPM "" "%s" "%s" ""
251 \Format tiff tif TIFF "" "%s" "%s" ""
252 \Format xbm xbm XBM "" "%s" "%s" ""
253 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
254 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
256 checkViewer('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
257 'nedit', 'gedit', 'notepad'],
258 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
259 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
260 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
261 \Format dateout tmp "date (output)" "" "" "%%" ""
262 \Format docbook sgml DocBook B "" "%%" "document"
263 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
264 \Format literate nw NoWeb N "" "%%" "document"
265 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
266 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
267 \Format linuxdoc sgml LinuxDoc x "" "%%" "document"
268 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
269 \Format text txt "Plain text" a "" "%%" "document"
270 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
271 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
272 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
273 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
275 #checkProg('a Postscript interpreter', ['gs'],
276 # rc_entry = [ r'\ps_command "%%"' ])
277 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
278 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
279 \Format ps ps Postscript t "%%" "" "document,vector"'''])
281 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
283 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
284 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
285 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
287 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
288 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
290 # Windows only: DraftDVI
291 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "document,vector"')
293 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
294 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
296 checkViewer('Noteedit', ['noteedit'],
297 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
299 checkViewer('an OpenDocument viewer', ['oowriter'],
300 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
302 # entried that do not need checkProg
303 addToRC(r'''\Format date "" "date command" "" "" "" ""
304 \Format fax "" Fax "" "" "" "document"
305 \Format lyx lyx LyX "" "" "" ""
306 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
307 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
308 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
309 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
310 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
311 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
312 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
313 \Format pdftex pdftex_t PDFTEX "" "" "" ""
314 \Format program "" Program "" "" "" ""
315 \Format pstex pstex_t PSTEX "" "" "" ""
316 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
317 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
318 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
319 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
320 \Format word doc "MS Word" W "" "" "document,vector"
321 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
325 def checkConverterEntries():
326 ''' Check all converters (\converter entries) '''
327 checkProg('the pdflatex program', ['pdflatex $$i'],
328 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
330 ''' If we're running LyX in-place then tex2lyx will be found in
331 ../src/tex2lyx. Add this directory to the PATH temporarily and
333 Use PATH to avoid any problems with paths-with-spaces.
335 path_orig = os.environ["PATH"]
336 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
337 os.pathsep + path_orig
339 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
340 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
341 \converter literate lyx "%% -n -f $$i $$o" ""'''])
343 os.environ["PATH"] = path_orig
346 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
347 rc_entry = [ r'\converter literate latex "%%" ""' ])
349 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
350 rc_entry = [ r'\converter html latex "%%" ""' ])
352 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
353 rc_entry = [ r'\converter word latex "%%" ""' ])
354 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
355 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
356 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
357 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
358 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
359 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
360 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
362 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
364 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
365 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
366 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
367 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
368 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
369 if htmlconv.find('htlatex') >= 0:
370 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
372 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
373 rc_entry = [ r'\converter sxw latex "%%" ""' ])
375 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
376 rc_entry = [ r'\converter odt latex "%%" ""' ])
377 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
378 # Both SuSE and debian have oolatex
379 checkProg('a LaTeX -> Open Document converter', ['oolatex $$i', 'oolatex.sh $$i', \
380 '/usr/share/tex4ht/oolatex $$i', \
381 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
382 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
383 # On windows it is called latex2rt.exe
384 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
385 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
387 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
388 rc_entry = [ r'\converter ps pdf "%%" ""' ])
390 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
391 rc_entry = [ r'\converter ps text2 "%%" ""' ])
393 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
394 rc_entry = [ r'\converter ps text3 "%%" ""' ])
396 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
397 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
399 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
400 rc_entry = [ r'\converter dvi ps "%%" ""' ])
402 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
403 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
405 path, dvipng = checkProg('dvipng', ['dvipng'])
406 if dvipng == "dvipng":
407 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
409 addToRC(r'\converter lyxpreview png "" ""')
411 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
412 rc_entry = [ r'\converter ps fax "%%" ""'])
414 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
416 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
417 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
418 \converter fig png "fig2dev -L png $$i $$o" ""''',
421 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
422 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
424 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
426 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
427 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
428 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
429 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
432 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
433 rc_entry = [ r'\converter wmf eps "%%" ""'])
435 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
436 rc_entry = [ r'\converter emf eps "%%" ""'])
438 checkProg('an EPS -> PDF converter', ['epstopdf'],
439 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
441 # no agr -> pdf converter, since the pdf library used by gracebat is not
442 # free software and therefore not compiled in in many installations.
443 # Fortunately, this is not a big problem, because we will use epstopdf to
444 # convert from agr to pdf via eps without loss of quality.
445 checkProg('a Grace -> Image converter', ['gracebat'],
447 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
448 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
449 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
450 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
454 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
456 version_string = cmdOutput("lilypond --version")
457 match = re.match('GNU LilyPond (\S+)', version_string)
459 version_number = match.groups()[0]
460 version = version_number.split('.')
461 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
462 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
463 \converter lilypond png "lilypond -b eps --png $$i" ""''')
464 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
465 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
466 print '+ found LilyPond version %s.' % version_number
468 print '+ found LilyPond, but version %s is too old.' % version_number
470 print '+ found LilyPond, but could not extract version number.'
472 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
473 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
475 # FIXME: no rc_entry? comment it out
476 # checkProg('Image converter', ['convert $$i $$o'])
478 # Entries that do not need checkProg
479 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
480 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
481 \converter docbook docbook-xml "cp $$i $$o" "xml"
482 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
483 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
484 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
485 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
486 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
487 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
488 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
489 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
490 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
491 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
492 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
493 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
498 ''' Check linuxdoc '''
500 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
502 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
503 \converter linuxdoc latex "sgml2latex $$i" ""
504 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
505 \converter linuxdoc html "sgml2html $$i" ""''',
506 r'''\converter linuxdoc lyx "" ""
507 \converter linuxdoc latex "" ""
508 \converter linuxdoc dvi "" ""
509 \converter linuxdoc html "" ""''' ])
511 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
513 return ('no', 'false', '')
517 ''' Check docbook '''
518 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
520 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
521 \converter docbook html "sgmltools -b html $$i" ""''',
522 r'''\converter docbook dvi "db2dvi $$i" ""
523 \converter docbook html "db2html $$i" ""''',
524 r'''\converter docbook dvi "" ""
525 \converter docbook html "" ""'''])
528 return ('yes', 'true', '\\def\\hasdocbook{yes}')
530 return ('no', 'false', '')
533 def checkOtherEntries():
534 ''' entries other than Format and Converter '''
535 checkProg('a *roff formatter', ['groff', 'nroff'],
537 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
538 r'\plaintext_roff_command "tbl $$FName | nroff"',
539 r'\plaintext_roff_command ""' ])
540 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
541 rc_entry = [ r'\chktex_command "%%"' ])
542 checkProg('a spellchecker', ['ispell'],
543 rc_entry = [ r'\spell_command "%%"' ])
544 ## FIXME: OCTAVE is not used anywhere
545 # path, OCTAVE = checkProg('Octave', ['octave'])
546 ## FIXME: MAPLE is not used anywhere
547 # path, MAPLE = checkProg('Maple', ['maple'])
548 checkProg('a spool command', ['lp', 'lpr'],
550 r'''\print_spool_printerprefix "-d "
551 \print_spool_command "lp"''',
552 r'''\print_spool_printerprefix "-P",
553 \print_spool_command "lpr"''',
555 # Add the rest of the entries (no checkProg is required)
556 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
557 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
558 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
559 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
563 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
564 ''' process layout file and get a line of result
566 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
568 \DeclareLaTeXClass{article}
569 \DeclareLaTeXClass[scrbook]{book (koma-script)}
570 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
574 "article" "article" "article" "false"
575 "scrbook" "scrbook" "book (koma-script)" "false"
576 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
578 classname = file.split(os.sep)[-1].split('.')[0]
579 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
580 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
581 for line in open(file).readlines():
584 (classtype, optAll, opt, opt1, desc) = res.groups()
585 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
588 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
589 print "Layout file without \DeclareXXClass line. "
593 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
594 ''' Explore the LaTeX configuration '''
595 print 'checking LaTeX configuration... ',
596 # if --without-latex-config is forced, or if there is no previous
597 # version of textclass.lst, re-generate a default file.
598 if not os.path.isfile('textclass.lst') or not check_config:
599 # remove the files only if we want to regenerate
600 removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
602 # Then, generate a default textclass.lst. In case configure.py
603 # fails, we still have something to start lyx.
604 print ' default values'
605 print '+checking list of textclasses... '
606 tx = open('textclass.lst', 'w')
608 # This file declares layouts and their associated definition files
609 # (include dir. relative to the place where this file is).
610 # It contains only default values, since chkconfig.ltx could not be run
611 # for some reason. Run ./configure.py if you need to update it after a
612 # configuration change.
614 # build the list of available layout files and convert it to commands
617 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
618 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
620 if not os.path.isfile(file):
622 # get stuff between /xxxx.layout .
623 classname = file.split(os.sep)[-1].split('.')[0]
625 cleanclass = classname.replace(' ', '_')
626 cleanclass = cleanclass.replace('-', '_')
627 # make sure the same class is not considered twice
628 if foundClasses.count(cleanclass) == 0: # not found before
629 foundClasses.append(cleanclass)
630 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
633 # the following will generate textclass.lst.tmp, and packages.lst.tmp
636 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
637 'chkconfig.classes', 'chklayouts.tex'])
639 if not os.path.isfile( 'chkconfig.ltx' ):
640 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
642 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
643 % (linuxdoc_cmd, docbook_cmd) )
644 # Construct the list of classes to test for.
645 # build the list of available layout files and convert it to commands
647 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
649 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
650 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
651 if not os.path.isfile(file):
653 classname = file.split(os.sep)[-1].split('.')[0]
654 for line in open(file).readlines():
655 if p1.search(line) == None:
658 print "Wrong input layout file with line '" + line
660 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
663 cl = open('chklayouts.tex', 'w')
664 for line in testclasses:
665 cl.write(line + '\n')
668 # we have chklayouts.tex, then process it
669 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
671 line = fout.readline()
674 if re.match('^\+', line):
678 # currently, values in chhkconfig are only used to set
681 for line in open('chkconfig.vars').readlines():
682 key, val = re.sub('-', '_', line).split('=')
684 values[key] = val.strip("'")
685 # chk_fontenc may not exist
687 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
690 if rmcopy: # remove the copied file
691 removeFiles( [ 'chkconfig.ltx' ] )
692 # if configure successed, move textclass.lst.tmp to textclass.lst
693 # and packages.lst.tmp to packages.lst
694 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
695 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
696 shutil.move('textclass.lst.tmp', 'textclass.lst')
697 shutil.move('packages.lst.tmp', 'packages.lst')
700 def createLaTeXConfig():
701 ''' create LaTeXConfig.lyx '''
702 # if chkconfig.sed does not exist (because LaTeX did not run),
703 # then provide a standard version.
704 if not os.path.isfile('chkconfig.sed'):
705 writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
706 print "creating packages.lst"
707 # if packages.lst does not exist (because LaTeX did not run),
708 # then provide a standard version.
709 if not os.path.isfile('packages.lst'):
710 writeToFile('packages.lst', '''
711 ### This file should contain the list of LaTeX packages that have been
712 ### recognized by LyX. Unfortunately, since configure could not find
713 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
714 ### if you need to update it after a configuration change.
716 print 'creating doc/LaTeXConfig.lyx'
718 # This is originally done by sed, using a
719 # tex-generated file chkconfig.sed
720 ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
721 ## >doc/LaTeXConfig.lyx
722 # Now, we have to do it by hand (python).
724 # add to chekconfig.sed
725 writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
727 ''' % (chk_linuxdoc, chk_docbook) , append=True)
728 # process this sed file!!!!
729 lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
731 p = re.compile(r's!(.*)!(.*)!g')
732 # process each sed replace.
733 for sed in open('chkconfig.sed').readlines():
734 if sed.strip() == '':
737 fr, to = p.match(sed).groups()
738 # if latex did not run, change all @name@ to '???'
740 for line in range(len(lyxin)):
741 lyxin[line] = re.sub('@.*@', to, lyxin[line])
743 for line in range(len(lyxin)):
744 lyxin[line] = lyxin[line].replace(fr, to)
745 except: # wrong sed entry?
746 print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
749 writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
753 def checkModulesConfig():
754 removeFiles(['lyxmodules.lst'])
756 print '+checking list of modules... '
757 tx = open('lyxmodules.lst', 'w')
758 tx.write('''## This file declares modules and their associated definition files.
759 ## It has been automatically generated by configure
760 ## Use "Options/Reconfigure" if you need to update it after a
761 ## configuration change.
763 # build the list of available modules
765 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
766 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
769 if not os.path.isfile(file):
771 tx.write(processModuleFile(file, bool_docbook, bool_linuxdoc))
775 def processModuleFile(file, bool_docbook, bool_linuxdoc):
776 ''' process module file and get a line of result
778 Declare lines look like this:
779 \DeclareLyXModule[LaTeX Packages]{Description}{ModuleName}...
781 "ModuleName" "filename" "Description" "Packages"
784 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*)\])?{(.*)}{(.*)}')
785 for line in open(file).readlines():
788 (packages, desc, modname) = res.groups()
789 #check availability...need to add that
793 pkgs = [s.strip() for s in packages.split(",")]
794 packages = ",".join(pkgs)
796 filename = file.split(os.sep)[-1]
797 return '"%s" "%s" "%s" "%s"\n' % (modname, filename, desc, packages)
798 print "Module file without \DeclareLyXModule line. "
804 def checkTeXAllowSpaces():
805 ''' Let's check whether spaces are allowed in TeX file names '''
806 tex_allows_spaces = 'false'
808 print "Checking whether TeX allows spaces in file names... ",
809 writeToFile('a b.tex', r'\message{working^^J}' )
811 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
813 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
814 if 'working' in latex_out:
816 tex_allows_spaces = 'true'
819 tex_allows_spaces = 'false'
820 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
821 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
824 def removeTempFiles():
826 if not lyx_keep_temps:
827 removeFiles(['chkconfig.sed', 'chkconfig.vars', \
828 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
829 'chklayouts.tex', 'missfont.log',
830 'chklatex.ltx', 'chklatex.log'])
833 if __name__ == '__main__':
834 lyx_check_config = True
835 outfile = 'lyxrc.defaults'
837 lyx_keep_temps = False
839 logfile = 'configure.log'
840 ## Parse the command line
841 for op in sys.argv[1:]: # default shell/for list is $*, the options
842 if op in [ '-help', '--help', '-h' ]:
843 print '''Usage: configure [options]
845 --help show this help lines
846 --keep-temps keep temporary files (for debug. purposes)
847 --without-latex-config do not run LaTeX to determine configuration
848 --with-version-suffix=suffix suffix of binary installed files
851 elif op == '--without-latex-config':
852 lyx_check_config = False
853 elif op == '--keep-temps':
854 lyx_keep_temps = True
855 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
856 version_suffix = op[22:]
858 print "Unknown option", op
861 # set up log file for stdout and stderr
862 log = open(logfile, 'w')
863 sys.stdout = Tee(sys.stdout, log)
864 sys.stderr = Tee(sys.stderr, log)
865 # check if we run from the right directory
866 srcdir = os.path.dirname(sys.argv[0])
869 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
870 print "configure: error: cannot find chkconfig.ltx script"
874 windows_style_tex_paths = checkTeXPaths()
875 dtl_tools = checkDTLtools()
876 ## Write the first part of outfile
877 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
878 # script. It contains default settings that have been determined by
879 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
880 # want to customize LyX, use LyX' Preferences dialog or modify directly
881 # the "preferences" file instead. Any setting in that file will
882 # override the values given here.
885 LATEX = checkLatex(dtl_tools)
886 checkFormatEntries(dtl_tools)
887 checkConverterEntries()
888 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
889 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
890 checkTeXAllowSpaces()
891 if windows_style_tex_paths != '':
892 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
894 # --without-latex-config can disable lyx_check_config
895 checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)
897 checkModulesConfig() #lyx_check_config and LATEX != '')