2 # -*- coding: utf-8 -*-
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 import sys, os, re, shutil, glob
15 ''' Writing to a Tee object will write to all file objects it keeps.
16 That is to say, writing to Tee(sys.stdout, open(logfile, 'w')) will
17 write to sys.stdout as well as a log file.
19 def __init__(self, *args):
22 def write(self, data):
24 result = f.write(data)
27 def writelines(self, seq):
32 def writeToFile(filename, lines, append = False):
33 " utility function: write or append lines to filename "
35 file = open(filename, 'a')
37 file = open(filename, 'w')
43 ''' utility function: shortcut for appending lines to outfile
44 add newline at the end of lines.
46 if lines.strip() != '':
47 writeToFile(outfile, lines + '\n', append = True)
50 def removeFiles(filenames):
51 '''utility function: 'rm -f'
52 ignore errors when file does not exist, or is a directory.
54 for file in filenames:
62 '''utility function: run a command and get its output as a string
72 ''' I do not really know why this is useful, but we might as well keep it.
74 Only set these to C if already set. These must not be set unconditionally
75 because not all systems understand e.g. LANG=C (notably SCO).
76 Fixing LC_MESSAGES prevents Solaris sh from translating var values in `set'!
77 Non-C LC_CTYPE values break the ctype check.
79 os.environ['LANG'] = os.getenv('LANG', 'C')
80 os.environ['LC'] = os.getenv('LC_ALL', 'C')
81 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
82 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
85 def createDirectories():
86 ''' Create the build directories if necessary '''
87 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
88 'layouts', 'scripts', 'templates', 'ui' ]:
89 if not os.path.isdir( dir ):
93 print "Failed to create directory ", dir
98 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
99 windows_style_tex_paths = ''
100 if os.name == 'nt' or sys.platform == 'cygwin':
101 from tempfile import mkstemp
102 fd, tmpfname = mkstemp(suffix='.ltx')
104 inpname = tmpfname.replace('\\', '/')
106 inpname = cmdOutput('cygpath -m ' + tmpfname)
107 logname = os.path.basename(inpname.replace('.ltx', '.log'))
108 inpname = inpname.replace('~', '\\string~')
109 os.write(fd, r'\relax')
111 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
112 if 'Error' in latex_out:
113 print "configure: TeX engine needs posix-style paths in latex files"
114 windows_style_tex_paths = 'false'
116 print "configure: TeX engine needs windows-style paths in latex files"
117 windows_style_tex_paths = 'true'
118 removeFiles([tmpfname, logname, 'texput.log'])
119 return windows_style_tex_paths
122 ## Searching some useful programs
123 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
125 This function will search a program in $PATH plus given path
126 If found, return directory and program name (not the options).
128 description: description of the program
130 progs: check programs, for each prog, the first word is used
131 for searching but the whole string is used to replace
132 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
134 path: additional pathes
136 rc_entry: entry to outfile, can be
137 1. emtpy: no rc entry will be added
138 2. one pattern: %% will be replaced by the first found program,
139 or '' if no program is found.
140 3. several patterns for each prog and not_found. This is used
141 when different programs have different usages. If you do not
142 want not_found entry to be added to the RC file, you can specify
143 an entry for each prog and use '' for the not_found entry.
145 not_found: the value that should be used instead of '' if no program
149 # one rc entry for each progs plus not_found entry
150 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
151 print "rc entry should have one item or item for each prog and not_found."
153 print 'checking for ' + description + '...'
154 ## print '(' + ','.join(progs) + ')',
155 for idx in range(len(progs)):
156 # ac_prog may have options, ac_word is the command name
158 ac_word = ac_prog.split(' ')[0]
159 print '+checking for "' + ac_word + '"... ',
160 path = os.environ["PATH"].split(os.pathsep) + path
162 if os.environ.has_key("PATHEXT"):
163 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
166 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
168 # write rc entries for this command
169 if len(rc_entry) == 1:
170 addToRC(rc_entry[0].replace('%%', ac_prog))
171 elif len(rc_entry) > 1:
172 addToRC(rc_entry[idx].replace('%%', ac_prog))
173 return [ac_dir, ac_word]
176 # write rc entries for 'not found'
177 if len(rc_entry) > 0: # the last one.
178 addToRC(rc_entry[-1].replace('%%', not_found))
179 return ['', not_found]
182 def checkViewer(description, progs, rc_entry = [], path = []):
183 ''' The same as checkProg, but for viewers and editors '''
184 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
188 ''' Check whether DTL tools are available (Windows only) '''
189 # Find programs! Returned path is not used now
190 if ((os.name == 'nt' or sys.platform == 'cygwin') and
191 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
192 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
199 def checkLatex(dtl_tools):
200 ''' Check latex, return lyx_check_config '''
201 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
202 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
203 #-----------------------------------------------------------------
204 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
205 # check if PLATEX is pLaTeX2e
206 writeToFile('chklatex.ltx', '''
210 # run platex on chklatex.ltx and check result
211 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
212 # We have the Japanese pLaTeX2e
213 addToRC(r'\converter platex dvi "%s" "latex"' % PLATEX)
217 removeFiles(['chklatex.ltx', 'chklatex.log'])
218 #-----------------------------------------------------------------
219 # use LATEX to convert from latex to dvi if PPLATEX is not available
223 # Windows only: DraftDVI
224 addToRC(r'''\converter latex dvi2 "%s" "latex"
225 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
227 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
230 # Check if latex is usable
231 writeToFile('chklatex.ltx', '''
232 \\nonstopmode\\makeatletter
233 \\ifx\\undefined\\documentclass\\else
234 \\message{ThisIsLaTeX2e}
238 # run latex on chklatex.ltx and check result
239 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
243 print "Latex not usable (not LaTeX2e) "
244 # remove temporary files
245 removeFiles(['chklatex.ltx', 'chklatex.log'])
249 def checkFormatEntries(dtl_tools):
250 ''' Check all formats (\Format entries) '''
251 checkViewer('a Tgif viewer and editor', ['tgif'],
252 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
254 checkViewer('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
255 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
257 checkViewer('a Grace viewer and editor', ['xmgrace'],
258 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
260 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
261 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
263 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
264 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
265 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
266 \Format gif gif GIF "" "%s" "%s" ""
267 \Format jpg jpg JPEG "" "%s" "%s" ""
268 \Format pbm pbm PBM "" "%s" "%s" ""
269 \Format pgm pgm PGM "" "%s" "%s" ""
270 \Format png png PNG "" "%s" "%s" ""
271 \Format ppm ppm PPM "" "%s" "%s" ""
272 \Format tiff tif TIFF "" "%s" "%s" ""
273 \Format xbm xbm XBM "" "%s" "%s" ""
274 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
275 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
277 checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
278 'nedit', 'gedit', 'notepad'],
279 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
280 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
281 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
282 \Format dateout tmp "date (output)" "" "" "%%" ""
283 \Format docbook sgml DocBook B "" "%%" "document"
284 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
285 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
286 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
287 \Format literate nw NoWeb N "" "%%" "document"
288 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
289 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
290 \Format linuxdoc sgml LinuxDoc x "" "%%" "document"
291 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
292 \Format text txt "Plain text" a "" "%%" "document"
293 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
294 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
295 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
296 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
298 checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
299 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
300 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
301 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
302 'nedit', 'gedit', 'notepad'],
303 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
305 #checkProg('a Postscript interpreter', ['gs'],
306 # rc_entry = [ r'\ps_command "%%"' ])
307 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
308 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
309 \Format ps ps Postscript t "%%" "" "document,vector"'''])
311 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
313 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
314 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
315 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
317 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
318 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
320 # Windows only: DraftDVI
321 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
323 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
324 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
326 checkViewer('Noteedit', ['noteedit'],
327 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
329 checkViewer('an OpenDocument viewer', ['oowriter'],
330 rc_entry = [r'\Format odt odt OpenDocument "" "%%" "%%" "document,vector"'])
332 # entried that do not need checkProg
333 addToRC(r'''\Format date "" "date command" "" "" "" ""
334 \Format csv csv "Table (CSV)" "" "" "" "document"
335 \Format fax "" Fax "" "" "" "document"
336 \Format lyx lyx LyX "" "" "" ""
337 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
338 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
339 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
340 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
341 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
342 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
343 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
344 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
345 \Format pdftex pdftex_t PDFTEX "" "" "" ""
346 \Format program "" Program "" "" "" ""
347 \Format pstex pstex_t PSTEX "" "" "" ""
348 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
349 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
350 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
351 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
352 \Format word doc "MS Word" W "" "" "document,vector"
353 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
357 def checkConverterEntries():
358 ''' Check all converters (\converter entries) '''
359 checkProg('the pdflatex program', ['pdflatex $$i'],
360 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
362 ''' If we're running LyX in-place then tex2lyx will be found in
363 ../src/tex2lyx. Add this directory to the PATH temporarily and
365 Use PATH to avoid any problems with paths-with-spaces.
367 path_orig = os.environ["PATH"]
368 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
369 os.pathsep + path_orig
371 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
372 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
373 \converter literate lyx "%% -n -f $$i $$o" ""'''])
375 os.environ["PATH"] = path_orig
378 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
379 rc_entry = [ r'\converter literate latex "%%" ""' ])
381 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
382 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
383 rc_entry = [ r'\converter html latex "%%" ""' ])
385 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
386 rc_entry = [ r'\converter word latex "%%" ""' ])
387 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
388 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
389 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
390 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
391 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
392 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
393 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
395 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
397 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
398 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
399 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
400 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
401 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
402 if htmlconv.find('htlatex') >= 0:
403 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
405 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
406 rc_entry = [ r'\converter sxw latex "%%" ""' ])
408 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
409 rc_entry = [ r'\converter odt latex "%%" ""' ])
410 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
411 # Both SuSE and debian have oolatex
412 checkProg('a LaTeX -> Open Document converter', [
413 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\'', \
414 'oolatex $$i', 'oolatex.sh $$i', \
415 '/usr/share/tex4ht/oolatex $$i'],
416 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
417 # On windows it is called latex2rt.exe
418 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
419 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
421 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
422 rc_entry = [ r'\converter rtf html "%%" ""' ])
424 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
425 rc_entry = [ r'\converter ps pdf "%%" ""' ])
427 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
428 rc_entry = [ r'\converter ps text2 "%%" ""' ])
430 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
431 rc_entry = [ r'\converter ps text3 "%%" ""' ])
433 checkProg('a PS to EPS converter', ['ps2eps $$i'],
434 rc_entry = [ r'\converter ps eps "%%" ""' ])
436 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
437 rc_entry = [ r'\converter pdf ps "%%" ""' ])
439 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
440 rc_entry = [ r'\converter pdf eps "%%" ""' ])
442 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
443 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
445 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
446 rc_entry = [ r'\converter dvi ps "%%" ""' ])
448 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
449 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
451 path, dvipng = checkProg('dvipng', ['dvipng'])
452 if dvipng == "dvipng":
453 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
455 addToRC(r'\converter lyxpreview png "" ""')
457 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
458 rc_entry = [ r'\converter ps fax "%%" ""'])
460 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
462 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
463 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
464 \converter fig png "fig2dev -L png $$i $$o" ""''',
467 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
468 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
470 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
472 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
473 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
474 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
475 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
478 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
479 rc_entry = [ r'\converter wmf eps "%%" ""'])
481 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
482 rc_entry = [ r'\converter emf eps "%%" ""'])
484 checkProg('an EPS -> PDF converter', ['epstopdf'],
485 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
487 # no agr -> pdf converter, since the pdf library used by gracebat is not
488 # free software and therefore not compiled in in many installations.
489 # Fortunately, this is not a big problem, because we will use epstopdf to
490 # convert from agr to pdf via eps without loss of quality.
491 checkProg('a Grace -> Image converter', ['gracebat'],
493 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
494 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
495 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
496 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
499 checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
500 rc_entry = [ r'\converter dot pdf "%%" ""'])
503 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
505 version_string = cmdOutput("lilypond --version")
506 match = re.match('GNU LilyPond (\S+)', version_string)
508 version_number = match.groups()[0]
509 version = version_number.split('.')
510 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
511 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
512 \converter lilypond png "lilypond -b eps --png $$i" ""''')
513 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
514 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
515 print '+ found LilyPond version %s.' % version_number
517 print '+ found LilyPond, but version %s is too old.' % version_number
519 print '+ found LilyPond, but could not extract version number.'
521 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
522 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
524 # FIXME: no rc_entry? comment it out
525 # checkProg('Image converter', ['convert $$i $$o'])
527 # Entries that do not need checkProg
528 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
529 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
530 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
531 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
532 \converter docbook docbook-xml "cp $$i $$o" "xml"
533 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
534 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
535 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
536 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
537 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
538 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
539 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
540 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
541 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
542 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
543 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
544 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
549 ''' Check linuxdoc '''
551 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
553 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
554 \converter linuxdoc latex "sgml2latex $$i" ""
555 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
556 \converter linuxdoc html "sgml2html $$i" ""''',
557 r'''\converter linuxdoc lyx "" ""
558 \converter linuxdoc latex "" ""
559 \converter linuxdoc dvi "" ""
560 \converter linuxdoc html "" ""''' ])
562 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
564 return ('no', 'false', '')
568 ''' Check docbook '''
569 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
571 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
572 \converter docbook html "sgmltools -b html $$i" ""''',
573 r'''\converter docbook dvi "db2dvi $$i" ""
574 \converter docbook html "db2html $$i" ""''',
575 r'''\converter docbook dvi "" ""
576 \converter docbook html "" ""'''])
579 return ('yes', 'true', '\\def\\hasdocbook{yes}')
581 return ('no', 'false', '')
584 def checkOtherEntries():
585 ''' entries other than Format and Converter '''
586 checkProg('a *roff formatter', ['groff', 'nroff'],
588 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
589 r'\plaintext_roff_command "tbl $$FName | nroff"',
590 r'\plaintext_roff_command ""' ])
591 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
592 rc_entry = [ r'\chktex_command "%%"' ])
593 checkProg('BibTeX', ['jbibtex', 'bibtex'],
594 rc_entry = [ r'\bibtex_command "%%"' ])
595 checkProg('an index processor', ['texindy', 'makeindex -c -q'],
596 rc_entry = [ r'\index_command "%%"' ])
597 checkProg('a nomenclature processor', ['makeindex'],
598 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
599 checkProg('a spellchecker', ['ispell'],
600 rc_entry = [ r'\spell_command "%%"' ])
601 ## FIXME: OCTAVE is not used anywhere
602 # path, OCTAVE = checkProg('Octave', ['octave'])
603 ## FIXME: MAPLE is not used anywhere
604 # path, MAPLE = checkProg('Maple', ['maple'])
605 checkProg('a spool command', ['lp', 'lpr'],
607 r'''\print_spool_printerprefix "-d "
608 \print_spool_command "lp"''',
609 r'''\print_spool_printerprefix "-P",
610 \print_spool_command "lpr"''',
612 # Add the rest of the entries (no checkProg is required)
613 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
614 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
615 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
616 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
620 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
621 ''' process layout file and get a line of result
623 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
625 \DeclareLaTeXClass{article}
626 \DeclareLaTeXClass[scrbook]{book (koma-script)}
627 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
631 "article" "article" "article" "false"
632 "scrbook" "scrbook" "book (koma-script)" "false"
633 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
635 classname = file.split(os.sep)[-1].split('.')[0]
636 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
637 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
638 for line in open(file).readlines():
641 (classtype, optAll, opt, opt1, desc) = res.groups()
642 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
645 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
646 print "Layout file without \DeclareXXClass line. "
650 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
651 ''' Explore the LaTeX configuration
652 Return None (will be passed to sys.exit()) for success.
654 print 'checking LaTeX configuration... ',
655 # if --without-latex-config is forced, or if there is no previous
656 # version of textclass.lst, re-generate a default file.
657 if not os.path.isfile('textclass.lst') or not check_config:
658 # remove the files only if we want to regenerate
659 removeFiles(['textclass.lst', 'packages.lst'])
661 # Then, generate a default textclass.lst. In case configure.py
662 # fails, we still have something to start lyx.
663 print ' default values'
664 print '+checking list of textclasses... '
665 tx = open('textclass.lst', 'w')
667 # This file declares layouts and their associated definition files
668 # (include dir. relative to the place where this file is).
669 # It contains only default values, since chkconfig.ltx could not be run
670 # for some reason. Run ./configure.py if you need to update it after a
671 # configuration change.
673 # build the list of available layout files and convert it to commands
676 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
677 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
679 if not os.path.isfile(file):
681 # get stuff between /xxxx.layout .
682 classname = file.split(os.sep)[-1].split('.')[0]
684 cleanclass = classname.replace(' ', '_')
685 cleanclass = cleanclass.replace('-', '_')
686 # make sure the same class is not considered twice
687 if foundClasses.count(cleanclass) == 0: # not found before
688 foundClasses.append(cleanclass)
689 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
694 # the following will generate textclass.lst.tmp, and packages.lst.tmp
697 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
698 'chkconfig.classes', 'chklayouts.tex'])
700 if not os.path.isfile( 'chkconfig.ltx' ):
701 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
703 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
704 % (linuxdoc_cmd, docbook_cmd) )
705 # Construct the list of classes to test for.
706 # build the list of available layout files and convert it to commands
708 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
710 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
711 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
712 if not os.path.isfile(file):
714 classname = file.split(os.sep)[-1].split('.')[0]
715 for line in open(file).readlines():
716 if p1.search(line) == None:
719 print "Wrong input layout file with line '" + line
721 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
724 cl = open('chklayouts.tex', 'w')
725 for line in testclasses:
726 cl.write(line + '\n')
729 # we have chklayouts.tex, then process it
730 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
732 line = fout.readline()
735 if re.match('^\+', line):
737 # if the command succeeds, None will be returned
740 # currently, values in chhkconfig are only used to set
743 for line in open('chkconfig.vars').readlines():
744 key, val = re.sub('-', '_', line).split('=')
746 values[key] = val.strip("'")
747 # chk_fontenc may not exist
749 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
752 if rmcopy: # remove the copied file
753 removeFiles( [ 'chkconfig.ltx' ] )
754 # if configure successed, move textclass.lst.tmp to textclass.lst
755 # and packages.lst.tmp to packages.lst
756 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
757 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
758 shutil.move('textclass.lst.tmp', 'textclass.lst')
759 shutil.move('packages.lst.tmp', 'packages.lst')
763 def checkModulesConfig():
764 removeFiles(['lyxmodules.lst'])
766 print '+checking list of modules... '
767 tx = open('lyxmodules.lst', 'w')
768 tx.write('''## This file declares modules and their associated definition files.
769 ## It has been automatically generated by configure
770 ## Use "Options/Reconfigure" if you need to update it after a
771 ## configuration change.
773 # build the list of available modules
775 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
776 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
779 if not os.path.isfile(file):
781 tx.write(processModuleFile(file, bool_docbook, bool_linuxdoc))
786 def processModuleFile(file, bool_docbook, bool_linuxdoc):
787 ''' process module file and get a line of result
789 The top of a module file should look like this:
790 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
792 #...body of description...
794 #Requires: [list of required modules]
795 #Excludes: [list of excluded modules]
796 The last two lines are optional
798 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
800 p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
801 r = re.compile(r'#+\s*Requires: (.*)')
802 x = re.compile(r'#+\s*Excludes: (.*)')
803 b = re.compile(r'#+\s*DescriptionBegin\s*$')
804 e = re.compile(r'#+\s*DescriptionEnd\s*$')
806 modname = desc = pkgs = req = excl = ""
807 readingDescription = False
809 filename = file.split(os.sep)[-1]
810 filename = filename[:-7]
812 for line in open(file).readlines():
813 if readingDescription:
816 readingDescription = False
817 desc = " ".join(descLines)
819 descLines.append(line[1:].strip())
823 readingDescription = True
827 (pkgs, modname) = res.groups()
831 tmp = [s.strip() for s in pkgs.split(",")]
837 tmp = [s.strip() for s in req.split("|")]
843 tmp = [s.strip() for s in excl.split("|")]
847 return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
848 print "Module file without \DeclareLyXModule line. "
852 def checkTeXAllowSpaces():
853 ''' Let's check whether spaces are allowed in TeX file names '''
854 tex_allows_spaces = 'false'
856 print "Checking whether TeX allows spaces in file names... ",
857 writeToFile('a b.tex', r'\message{working^^J}' )
859 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
861 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
862 if 'working' in latex_out:
864 tex_allows_spaces = 'true'
867 tex_allows_spaces = 'false'
868 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
869 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
872 def removeTempFiles():
874 if not lyx_keep_temps:
875 removeFiles(['chkconfig.vars', \
876 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
877 'chklayouts.tex', 'missfont.log',
878 'chklatex.ltx', 'chklatex.log'])
881 if __name__ == '__main__':
882 lyx_check_config = True
883 outfile = 'lyxrc.defaults'
885 lyx_keep_temps = False
887 logfile = 'configure.log'
888 ## Parse the command line
889 for op in sys.argv[1:]: # default shell/for list is $*, the options
890 if op in [ '-help', '--help', '-h' ]:
891 print '''Usage: configure [options]
893 --help show this help lines
894 --keep-temps keep temporary files (for debug. purposes)
895 --without-latex-config do not run LaTeX to determine configuration
896 --with-version-suffix=suffix suffix of binary installed files
899 elif op == '--without-latex-config':
900 lyx_check_config = False
901 elif op == '--keep-temps':
902 lyx_keep_temps = True
903 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
904 version_suffix = op[22:]
906 print "Unknown option", op
909 # set up log file for stdout and stderr
910 log = open(logfile, 'w')
911 sys.stdout = Tee(sys.stdout, log)
912 sys.stderr = Tee(sys.stderr, log)
913 # check if we run from the right directory
914 srcdir = os.path.dirname(sys.argv[0])
917 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
918 print "configure: error: cannot find chkconfig.ltx script"
922 windows_style_tex_paths = checkTeXPaths()
923 dtl_tools = checkDTLtools()
924 ## Write the first part of outfile
925 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
926 # script. It contains default settings that have been determined by
927 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
928 # want to customize LyX, use LyX' Preferences dialog or modify directly
929 # the "preferences" file instead. Any setting in that file will
930 # override the values given here.
933 LATEX = checkLatex(dtl_tools)
934 checkFormatEntries(dtl_tools)
935 checkConverterEntries()
936 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
937 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
938 checkTeXAllowSpaces()
939 if windows_style_tex_paths != '':
940 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
942 # --without-latex-config can disable lyx_check_config
943 ret = checkLatexConfig(lyx_check_config and LATEX != '',
944 bool_docbook, bool_linuxdoc)
945 checkModulesConfig() #lyx_check_config and LATEX != '')
947 # The return error code can be 256. Because most systems expect an error code
948 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
949 # a None for success, 'ret is not None' is used to exit.
950 sys.exit(ret is not None)