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 clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
309 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
310 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
311 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
312 \Format pdftex pdftex_t PDFTEX "" "" "" ""
313 \Format program "" Program "" "" "" ""
314 \Format pstex pstex_t PSTEX "" "" "" ""
315 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
316 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
317 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
318 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
319 \Format word doc "MS Word" W "" "" "document,vector"
320 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
324 def checkConverterEntries():
325 ''' Check all converters (\converter entries) '''
326 checkProg('the pdflatex program', ['pdflatex $$i'],
327 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
329 ''' If we're running LyX in-place then tex2lyx will be found in
330 ../src/tex2lyx. Add this directory to the PATH temporarily and
332 Use PATH to avoid any problems with paths-with-spaces.
334 path_orig = os.environ["PATH"]
335 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
336 os.pathsep + path_orig
338 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
339 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
340 \converter literate lyx "%% -n -f $$i $$o" ""'''])
342 os.environ["PATH"] = path_orig
345 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
346 rc_entry = [ r'\converter literate latex "%%" ""' ])
348 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
349 rc_entry = [ r'\converter html latex "%%" ""' ])
351 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
352 rc_entry = [ r'\converter word latex "%%" ""' ])
354 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
355 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
356 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
357 if htmlconv == 'htlatex' or htmlconv == 'latex2html':
358 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
360 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
363 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
364 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
365 if htmlconv == 'htlatex':
366 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
368 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
369 rc_entry = [ r'\converter sxw latex "%%" ""' ])
371 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
372 rc_entry = [ r'\converter odt latex "%%" ""' ])
374 checkProg('a LaTeX -> Open Document converter', ['oolatex $$i', 'oolatex.sh $$i', 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
375 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
376 # On windows it is called latex2rt.exe
377 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
378 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
380 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
381 rc_entry = [ r'\converter ps pdf "%%" ""' ])
383 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
384 rc_entry = [ r'\converter ps text2 "%%" ""' ])
386 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
387 rc_entry = [ r'\converter ps text3 "%%" ""' ])
389 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
390 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
392 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
393 rc_entry = [ r'\converter dvi ps "%%" ""' ])
395 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
396 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
398 path, dvipng = checkProg('dvipng', ['dvipng'])
399 if dvipng == "dvipng":
400 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
402 addToRC(r'\converter lyxpreview png "" ""')
404 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
405 rc_entry = [ r'\converter ps fax "%%" ""'])
407 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
409 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
410 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
411 \converter fig png "fig2dev -L png $$i $$o" ""''',
414 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
415 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
417 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
419 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
420 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
421 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
422 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
425 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
426 rc_entry = [ r'\converter wmf eps "%%" ""'])
428 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
429 rc_entry = [ r'\converter emf eps "%%" ""'])
431 checkProg('an EPS -> PDF converter', ['epstopdf'],
432 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
434 # no agr -> pdf converter, since the pdf library used by gracebat is not
435 # free software and therefore not compiled in in many installations.
436 # Fortunately, this is not a big problem, because we will use epstopdf to
437 # convert from agr to pdf via eps without loss of quality.
438 checkProg('a Grace -> Image converter', ['gracebat'],
440 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
441 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
442 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
443 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
447 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
449 version_string = cmdOutput("lilypond --version")
450 match = re.match('GNU LilyPond (\S+)', version_string)
452 version_number = match.groups()[0]
453 version = version_number.split('.')
454 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
455 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
456 \converter lilypond png "lilypond -b eps --png $$i" ""''')
457 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
458 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
459 print '+ found LilyPond version %s.' % version_number
461 print '+ found LilyPond, but version %s is too old.' % version_number
463 print '+ found LilyPond, but could not extract version number.'
465 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
466 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
468 # FIXME: no rc_entry? comment it out
469 # checkProg('Image converter', ['convert $$i $$o'])
471 # Entries that do not need checkProg
472 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
473 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
474 \converter docbook docbook-xml "cp $$i $$o" "xml"
475 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
476 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
477 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
478 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
479 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
480 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
481 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
482 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
483 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
484 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
485 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
490 ''' Check linuxdoc '''
492 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
494 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
495 \converter linuxdoc latex "sgml2latex $$i" ""
496 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
497 \converter linuxdoc html "sgml2html $$i" ""''',
498 r'''\converter linuxdoc lyx "" ""
499 \converter linuxdoc latex "" ""
500 \converter linuxdoc dvi "" ""
501 \converter linuxdoc html "" ""''' ])
503 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
505 return ('no', 'false', '')
509 ''' Check docbook '''
510 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
512 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
513 \converter docbook html "sgmltools -b html $$i" ""''',
514 r'''\converter docbook dvi "db2dvi $$i" ""
515 \converter docbook html "db2html $$i" ""''',
516 r'''\converter docbook dvi "" ""
517 \converter docbook html "" ""'''])
520 return ('yes', 'true', '\\def\\hasdocbook{yes}')
522 return ('no', 'false', '')
525 def checkOtherEntries():
526 ''' entries other than Format and Converter '''
527 checkProg('a *roff formatter', ['groff', 'nroff'],
529 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
530 r'\plaintext_roff_command "tbl $$FName | nroff"',
531 r'\plaintext_roff_command ""' ])
532 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
533 rc_entry = [ r'\chktex_command "%%"' ])
534 checkProg('a spellchecker', ['ispell'],
535 rc_entry = [ r'\spell_command "%%"' ])
536 ## FIXME: OCTAVE is not used anywhere
537 # path, OCTAVE = checkProg('Octave', ['octave'])
538 ## FIXME: MAPLE is not used anywhere
539 # path, MAPLE = checkProg('Maple', ['maple'])
540 checkProg('a spool command', ['lp', 'lpr'],
542 r'''\print_spool_printerprefix "-d "
543 \print_spool_command "lp"''',
544 r'''\print_spool_printerprefix "-P",
545 \print_spool_command "lpr"''',
547 # Add the rest of the entries (no checkProg is required)
548 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
549 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
550 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
551 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
555 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
556 ''' process layout file and get a line of result
558 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
560 \DeclareLaTeXClass{article}
561 \DeclareLaTeXClass[scrbook]{book (koma-script)}
562 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
566 "article" "article" "article" "false"
567 "scrbook" "scrbook" "book (koma-script)" "false"
568 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
570 classname = file.split(os.sep)[-1].split('.')[0]
571 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
572 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
573 for line in open(file).readlines():
576 (classtype, optAll, opt, opt1, desc) = res.groups()
577 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
580 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
581 print "Layout file without \DeclareXXClass line. "
585 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
586 ''' Explore the LaTeX configuration '''
587 print 'checking LaTeX configuration... ',
588 # First, remove the files that we want to re-create
589 removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
592 print ' default values'
593 print '+checking list of textclasses... '
594 tx = open('textclass.lst', 'w')
596 # This file declares layouts and their associated definition files
597 # (include dir. relative to the place where this file is).
598 # It contains only default values, since chkconfig.ltx could not be run
599 # for some reason. Run ./configure.py if you need to update it after a
600 # configuration change.
602 # build the list of available layout files and convert it to commands
605 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
606 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
608 if not os.path.isfile(file):
610 # get stuff between /xxxx.layout .
611 classname = file.split(os.sep)[-1].split('.')[0]
613 cleanclass = classname.replace(' ', '_')
614 cleanclass = cleanclass.replace('-', '_')
615 # make sure the same class is not considered twice
616 if foundClasses.count(cleanclass) == 0: # not found before
617 foundClasses.append(cleanclass)
618 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
623 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
624 'chkconfig.classes', 'chklayouts.tex'])
626 if not os.path.isfile( 'chkconfig.ltx' ):
627 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
629 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
630 % (linuxdoc_cmd, docbook_cmd) )
631 # Construct the list of classes to test for.
632 # build the list of available layout files and convert it to commands
634 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
636 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
637 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
638 if not os.path.isfile(file):
640 classname = file.split(os.sep)[-1].split('.')[0]
641 for line in open(file).readlines():
642 if p1.search(line) == None:
645 print "Wrong input layout file with line '" + line
647 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
650 cl = open('chklayouts.tex', 'w')
651 for line in testclasses:
652 cl.write(line + '\n')
655 # we have chklayouts.tex, then process it
656 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
658 line = fout.readline()
661 if re.match('^\+', line):
665 # currently, values in chhkconfig are only used to set
668 for line in open('chkconfig.vars').readlines():
669 key, val = re.sub('-', '_', line).split('=')
671 values[key] = val.strip("'")
672 # chk_fontenc may not exist
674 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
677 if rmcopy: # remove the copied file
678 removeFiles( [ 'chkconfig.ltx' ] )
681 def createLaTeXConfig():
682 ''' create LaTeXConfig.lyx '''
683 # if chkconfig.sed does not exist (because LaTeX did not run),
684 # then provide a standard version.
685 if not os.path.isfile('chkconfig.sed'):
686 writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
687 print "creating packages.lst"
688 # if packages.lst does not exist (because LaTeX did not run),
689 # then provide a standard version.
690 if not os.path.isfile('packages.lst'):
691 writeToFile('packages.lst', '''
692 ### This file should contain the list of LaTeX packages that have been
693 ### recognized by LyX. Unfortunately, since configure could not find
694 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
695 ### if you need to update it after a configuration change.
697 print 'creating doc/LaTeXConfig.lyx'
699 # This is originally done by sed, using a
700 # tex-generated file chkconfig.sed
701 ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
702 ## >doc/LaTeXConfig.lyx
703 # Now, we have to do it by hand (python).
705 # add to chekconfig.sed
706 writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
708 ''' % (chk_linuxdoc, chk_docbook) , append=True)
709 # process this sed file!!!!
710 lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
712 p = re.compile(r's!(.*)!(.*)!g')
713 # process each sed replace.
714 for sed in open('chkconfig.sed').readlines():
715 if sed.strip() == '':
718 fr, to = p.match(sed).groups()
719 # if latex did not run, change all @name@ to '???'
721 for line in range(len(lyxin)):
722 lyxin[line] = re.sub('@.*@', to, lyxin[line])
724 for line in range(len(lyxin)):
725 lyxin[line] = lyxin[line].replace(fr, to)
726 except: # wrong sed entry?
727 print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
730 writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
734 def checkTeXAllowSpaces():
735 ''' Let's check whether spaces are allowed in TeX file names '''
736 tex_allows_spaces = 'false'
738 print "Checking whether TeX allows spaces in file names... ",
739 writeToFile('a b.tex', r'\message{working^^J}' )
741 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
743 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
744 if 'working' in latex_out:
746 tex_allows_spaces = 'true'
749 tex_allows_spaces = 'false'
750 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
751 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
754 def removeTempFiles():
756 if not lyx_keep_temps:
757 removeFiles(['chkconfig.sed', 'chkconfig.vars', \
758 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
759 'chklayouts.tex', 'missfont.log',
760 'chklatex.ltx', 'chklatex.log'])
763 if __name__ == '__main__':
764 lyx_check_config = True
765 outfile = 'lyxrc.defaults'
767 lyx_keep_temps = False
769 logfile = 'configure.log'
770 ## Parse the command line
771 for op in sys.argv[1:]: # default shell/for list is $*, the options
772 if op in [ '-help', '--help', '-h' ]:
773 print '''Usage: configure [options]
775 --help show this help lines
776 --keep-temps keep temporary files (for debug. purposes)
777 --without-latex-config do not run LaTeX to determine configuration
778 --with-version-suffix=suffix suffix of binary installed files
781 elif op == '--without-latex-config':
782 lyx_check_config = False
783 elif op == '--keep-temps':
784 lyx_keep_temps = True
785 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
786 version_suffix = op[22:]
788 print "Unknown option", op
791 # set up log file for stdout and stderr
792 log = open(logfile, 'w')
793 sys.stdout = Tee(sys.stdout, log)
794 sys.stderr = Tee(sys.stderr, log)
795 # check if we run from the right directory
796 srcdir = os.path.dirname(sys.argv[0])
799 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
800 print "configure: error: cannot find chkconfig.ltx script"
804 windows_style_tex_paths = checkTeXPaths()
805 dtl_tools = checkDTLtools()
806 ## Write the first part of outfile
807 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
808 # script. It contains default settings that have been determined by
809 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
810 # want to customize LyX, use LyX' Preferences dialog or modify directly
811 # the "preferences" file instead. Any setting in that file will
812 # override the values given here.
815 LATEX = checkLatex(dtl_tools)
816 checkFormatEntries(dtl_tools)
817 checkConverterEntries()
818 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
819 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
820 checkTeXAllowSpaces()
821 if windows_style_tex_paths != '':
822 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
824 # --without-latex-config can disable lyx_check_config
825 checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)