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 inpname = inpname.replace('~', '\\string~')
108 os.write(fd, r'\relax')
110 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
111 if 'Error' in latex_out:
112 print "configure: TeX engine needs posix-style paths in latex files"
113 windows_style_tex_paths = 'false'
115 print "configure: TeX engine needs windows-style paths in latex files"
116 windows_style_tex_paths = 'true'
117 removeFiles([tmpfname, 'texput.log'])
118 return windows_style_tex_paths
121 ## Searching some useful programs
122 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
124 This function will search a program in $PATH plus given path
125 If found, return directory and program name (not the options).
127 description: description of the program
129 progs: check programs, for each prog, the first word is used
130 for searching but the whole string is used to replace
131 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
133 path: additional pathes
135 rc_entry: entry to outfile, can be
136 1. emtpy: no rc entry will be added
137 2. one pattern: %% will be replaced by the first found program,
138 or '' if no program is found.
139 3. several patterns for each prog and not_found. This is used
140 when different programs have different usages. If you do not
141 want not_found entry to be added to the RC file, you can specify
142 an entry for each prog and use '' for the not_found entry.
144 not_found: the value that should be used instead of '' if no program
148 # one rc entry for each progs plus not_found entry
149 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
150 print "rc entry should have one item or item for each prog and not_found."
152 print 'checking for ' + description + '...'
153 ## print '(' + ','.join(progs) + ')',
154 for idx in range(len(progs)):
155 # ac_prog may have options, ac_word is the command name
157 ac_word = ac_prog.split(' ')[0]
158 print '+checking for "' + ac_word + '"... ',
159 path = os.environ["PATH"].split(os.pathsep) + path
161 # check both ac_word and ac_word.exe (for windows system)
162 if os.path.isfile( os.path.join(ac_dir, ac_word) ) or \
163 os.path.isfile( os.path.join(ac_dir, ac_word + ".exe") ):
165 # write rc entries for this command
166 if len(rc_entry) == 1:
167 addToRC(rc_entry[0].replace('%%', ac_prog))
168 elif len(rc_entry) > 1:
169 addToRC(rc_entry[idx].replace('%%', ac_prog))
170 return [ac_dir, ac_word]
173 # write rc entries for 'not found'
174 if len(rc_entry) > 0: # the last one.
175 addToRC(rc_entry[-1].replace('%%', not_found))
176 return ['', not_found]
179 def checkViewer(description, progs, rc_entry = [], path = []):
180 ''' The same as checkProg, but for viewers and editors '''
181 return checkProg(description, progs, rc_entry, path, not_found = 'auto')
185 ''' Check whether DTL tools are available (Windows only) '''
186 # Find programs! Returned path is not used now
187 if ((os.name == 'nt' or sys.platform == 'cygwin') and
188 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
189 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
196 def checkLatex(dtl_tools):
197 ''' Check latex, return lyx_check_config '''
199 # Windows only: DraftDVI
200 converter_entry = r'''\converter latex dvi2 "%%" "latex"
201 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""'''
203 converter_entry = r'\converter latex dvi "%%" "latex"'
204 path, LATEX = checkProg('a Latex2e program', ['pplatex $$i', 'latex $$i', 'latex2e $$i'],
205 rc_entry = [converter_entry])
208 # Check if latex is usable
209 writeToFile('chklatex.ltx', '''
210 \\nonstopmode\\makeatletter
211 \\ifx\\undefined\\documentclass\\else
212 \\message{ThisIsLaTeX2e}
216 # run latex on chklatex.ltx and check result
217 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
221 print "Latex not usable (not LaTeX2e) "
222 # remove temporary files
223 removeFiles(['chklatex.ltx', 'chklatex.log'])
227 def checkFormatEntries(dtl_tools):
228 ''' Check all formats (\Format entries) '''
229 checkViewer('a Tgif viewer and editor', ['tgif'],
230 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
232 checkViewer('a FIG viewer and editor', ['xfig'],
233 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
235 checkViewer('a Grace viewer and editor', ['xmgrace'],
236 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
238 checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
239 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
241 path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
242 path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
243 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
244 \Format gif gif GIF "" "%s" "%s" ""
245 \Format jpg jpg JPEG "" "%s" "%s" ""
246 \Format pbm pbm PBM "" "%s" "%s" ""
247 \Format pgm pgm PGM "" "%s" "%s" ""
248 \Format png png PNG "" "%s" "%s" ""
249 \Format ppm ppm PPM "" "%s" "%s" ""
250 \Format tiff tif TIFF "" "%s" "%s" ""
251 \Format xbm xbm XBM "" "%s" "%s" ""
252 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
253 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
255 checkViewer('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
256 'nedit', 'gedit', 'notepad'],
257 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
258 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
259 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
260 \Format dateout tmp "date (output)" "" "" "%%" ""
261 \Format docbook sgml DocBook B "" "%%" "document"
262 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
263 \Format literate nw NoWeb N "" "%%" "document"
264 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
265 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
266 \Format linuxdoc sgml LinuxDoc x "" "%%" "document"
267 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
268 \Format text txt "Plain text" a "" "%%" "document"
269 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
270 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
271 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
272 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
274 #checkProg('a Postscript interpreter', ['gs'],
275 # rc_entry = [ r'\ps_command "%%"' ])
276 checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
277 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
278 \Format ps ps Postscript t "%%" "" "document,vector"'''])
280 checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
282 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
283 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
284 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"'''])
286 checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
287 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
289 # Windows only: DraftDVI
290 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "document,vector"')
292 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
293 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
295 checkViewer('Noteedit', ['noteedit'],
296 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
298 # entried that do not need checkProg
299 addToRC(r'''\Format date "" "date command" "" "" "" ""
300 \Format fax "" Fax "" "" "" "document"
301 \Format lyx lyx LyX "" "" "" ""
302 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
303 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
304 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
305 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
306 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
307 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
308 \Format pdftex pdftex_t PDFTEX "" "" "" ""
309 \Format program "" Program "" "" "" ""
310 \Format pstex pstex_t PSTEX "" "" "" ""
311 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
312 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"
313 \Format odt odt "Open Document" O "" "" "document,vector"
314 \Format wmf wmf "Windows Meta File" "" "" "" "vector"
315 \Format word doc "MS Word" W "" "" "document,vector"
316 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
320 def checkConverterEntries():
321 ''' Check all converters (\converter entries) '''
322 checkProg('the pdflatex program', ['pdflatex $$i'],
323 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
325 ''' If we're running LyX in-place then tex2lyx will be found in
326 ../src/tex2lyx. Add this directory to the PATH temporarily and
328 Use PATH to avoid any problems with paths-with-spaces.
330 path_orig = os.environ["PATH"]
331 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
332 os.pathsep + path_orig
334 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
335 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
336 \converter literate lyx "%% -n -f $$i $$o" ""'''])
338 os.environ["PATH"] = path_orig
341 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
342 rc_entry = [ r'\converter literate latex "%%" ""' ])
344 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
345 rc_entry = [ r'\converter html latex "%%" ""' ])
347 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
348 rc_entry = [ r'\converter word latex "%%" ""' ])
350 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
351 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
352 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
353 if htmlconv == 'htlatex' or htmlconv == 'latex2html':
354 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
356 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
359 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
360 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
361 if htmlconv == 'htlatex':
362 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
364 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
365 rc_entry = [ r'\converter sxw latex "%%" ""' ])
367 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
368 rc_entry = [ r'\converter odt latex "%%" ""' ])
370 checkProg('a LaTeX -> Open Document converter', ['oolatex $$i', 'oolatex.sh $$i'],
371 rc_entry = [ r'\converter latex odt "%%" "latex"' ])
372 # On windows it is called latex2rt.exe
373 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
374 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
376 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
377 rc_entry = [ r'\converter ps pdf "%%" ""' ])
379 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
380 rc_entry = [ r'\converter ps text2 "%%" ""' ])
382 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
383 rc_entry = [ r'\converter ps text3 "%%" ""' ])
385 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
386 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
388 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
389 rc_entry = [ r'\converter dvi ps "%%" ""' ])
391 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
392 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
394 path, dvipng = checkProg('dvipng', ['dvipng'])
395 if dvipng == "dvipng":
396 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
398 addToRC(r'\converter lyxpreview png "" ""')
400 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
401 rc_entry = [ r'\converter ps fax "%%" ""'])
403 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
405 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
406 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
407 \converter fig png "fig2dev -L png $$i $$o" ""''',
410 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
411 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
413 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
415 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
416 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
417 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
418 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
421 checkProg('a WMF -> EPS converter', ['wmf2eps -o $$o $$i'],
422 rc_entry = [ r'\converter wmf eps "%%" ""', ''])
424 checkProg('an EPS -> PDF converter', ['epstopdf'],
425 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
427 # no agr -> pdf converter, since the pdf library used by gracebat is not
428 # free software and therefore not compiled in in many installations.
429 # Fortunately, this is not a big problem, because we will use epstopdf to
430 # convert from agr to pdf via eps without loss of quality.
431 checkProg('a Grace -> Image converter', ['gracebat'],
433 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
434 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
435 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
436 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
440 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
442 version_string = cmdOutput("lilypond --version")
443 match = re.match('GNU LilyPond (\S+)', version_string)
445 version_number = match.groups()[0]
446 version = version_number.split('.')
447 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
448 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
449 \converter lilypond png "lilypond -b eps --png $$i" ""''')
450 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
451 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
452 print '+ found LilyPond version %s.' % version_number
454 print '+ found LilyPond, but version %s is too old.' % version_number
456 print '+ found LilyPond, but could not extract version number.'
458 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
459 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
461 # FIXME: no rc_entry? comment it out
462 # checkProg('Image converter', ['convert $$i $$o'])
464 # Entries that do not need checkProg
465 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
466 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
467 \converter docbook docbook-xml "cp $$i $$o" "xml"
468 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
469 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
470 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
471 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
472 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
473 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
474 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
475 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
476 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
477 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
478 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
483 ''' Check linuxdoc '''
485 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
487 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
488 \converter linuxdoc latex "sgml2latex $$i" ""
489 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
490 \converter linuxdoc html "sgml2html $$i" ""''',
491 r'''\converter linuxdoc lyx "" ""
492 \converter linuxdoc latex "" ""
493 \converter linuxdoc dvi "" ""
494 \converter linuxdoc html "" ""''' ])
496 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
498 return ('no', 'false', '')
502 ''' Check docbook '''
503 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
505 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
506 \converter docbook html "sgmltools -b html $$i" ""''',
507 r'''\converter docbook dvi "db2dvi $$i" ""
508 \converter docbook html "db2html $$i" ""''',
509 r'''\converter docbook dvi "" ""
510 \converter docbook html "" ""'''])
513 return ('yes', 'true', '\\def\\hasdocbook{yes}')
515 return ('no', 'false', '')
518 def checkOtherEntries():
519 ''' entries other than Format and Converter '''
520 checkProg('a *roff formatter', ['groff', 'nroff'],
522 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
523 r'\plaintext_roff_command "tbl $$FName | nroff"',
524 r'\plaintext_roff_command ""' ])
525 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
526 rc_entry = [ r'\chktex_command "%%"' ])
527 checkProg('a spellchecker', ['ispell'],
528 rc_entry = [ r'\spell_command "%%"' ])
529 ## FIXME: OCTAVE is not used anywhere
530 # path, OCTAVE = checkProg('Octave', ['octave'])
531 ## FIXME: MAPLE is not used anywhere
532 # path, MAPLE = checkProg('Maple', ['maple'])
533 checkProg('a spool command', ['lp', 'lpr'],
535 r'''\print_spool_printerprefix "-d "
536 \print_spool_command "lp"''',
537 r'''\print_spool_printerprefix "-P",
538 \print_spool_command "lpr"''',
540 # Add the rest of the entries (no checkProg is required)
541 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
542 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
543 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
544 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
548 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
549 ''' process layout file and get a line of result
551 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
553 \DeclareLaTeXClass{article}
554 \DeclareLaTeXClass[scrbook]{book (koma-script)}
555 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
559 "article" "article" "article" "false"
560 "scrbook" "scrbook" "book (koma-script)" "false"
561 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
563 classname = file.split(os.sep)[-1].split('.')[0]
564 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
565 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
566 for line in open(file).readlines():
569 (classtype, optAll, opt, opt1, desc) = res.groups()
570 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
573 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
574 print "Layout file without \DeclareXXClass line. "
578 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
579 ''' Explore the LaTeX configuration '''
580 print 'checking LaTeX configuration... ',
581 # First, remove the files that we want to re-create
582 removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
585 print ' default values'
586 print '+checking list of textclasses... '
587 tx = open('textclass.lst', 'w')
589 # This file declares layouts and their associated definition files
590 # (include dir. relative to the place where this file is).
591 # It contains only default values, since chkconfig.ltx could not be run
592 # for some reason. Run ./configure.py if you need to update it after a
593 # configuration change.
595 # build the list of available layout files and convert it to commands
598 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
599 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
601 if not os.path.isfile(file):
603 # get stuff between /xxxx.layout .
604 classname = file.split(os.sep)[-1].split('.')[0]
606 cleanclass = classname.replace(' ', '_')
607 cleanclass = cleanclass.replace('-', '_')
608 # make sure the same class is not considered twice
609 if foundClasses.count(cleanclass) == 0: # not found before
610 foundClasses.append(cleanclass)
611 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
616 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
617 'chkconfig.classes', 'chklayouts.tex'])
619 if not os.path.isfile( 'chkconfig.ltx' ):
620 shutil.copy( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
622 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
623 % (linuxdoc_cmd, docbook_cmd) )
624 # Construct the list of classes to test for.
625 # build the list of available layout files and convert it to commands
627 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
629 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
630 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
631 if not os.path.isfile(file):
633 classname = file.split(os.sep)[-1].split('.')[0]
634 for line in open(file).readlines():
635 if p1.search(line) == None:
638 print "Wrong input layout file with line '" + line
640 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
643 cl = open('chklayouts.tex', 'w')
644 for line in testclasses:
645 cl.write(line + '\n')
648 # we have chklayouts.tex, then process it
649 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
651 line = fout.readline()
654 if re.match('^\+', line):
658 # currently, values in chhkconfig are only used to set
661 for line in open('chkconfig.vars').readlines():
662 key, val = re.sub('-', '_', line).split('=')
664 values[key] = val.strip("'")
665 # chk_fontenc may not exist
667 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
670 if rmcopy: # remove the copied file
671 removeFiles( [ 'chkconfig.ltx' ] )
674 def createLaTeXConfig():
675 ''' create LaTeXConfig.lyx '''
676 # if chkconfig.sed does not exist (because LaTeX did not run),
677 # then provide a standard version.
678 if not os.path.isfile('chkconfig.sed'):
679 writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
680 print "creating packages.lst"
681 # if packages.lst does not exist (because LaTeX did not run),
682 # then provide a standard version.
683 if not os.path.isfile('packages.lst'):
684 writeToFile('packages.lst', '''
685 ### This file should contain the list of LaTeX packages that have been
686 ### recognized by LyX. Unfortunately, since configure could not find
687 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
688 ### if you need to update it after a configuration change.
690 print 'creating doc/LaTeXConfig.lyx'
692 # This is originally done by sed, using a
693 # tex-generated file chkconfig.sed
694 ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
695 ## >doc/LaTeXConfig.lyx
696 # Now, we have to do it by hand (python).
698 # add to chekconfig.sed
699 writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
701 ''' % (chk_linuxdoc, chk_docbook) , append=True)
702 # process this sed file!!!!
703 lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
705 p = re.compile(r's!(.*)!(.*)!g')
706 # process each sed replace.
707 for sed in open('chkconfig.sed').readlines():
708 if sed.strip() == '':
711 fr, to = p.match(sed).groups()
712 # if latex did not run, change all @name@ to '???'
714 for line in range(len(lyxin)):
715 lyxin[line] = re.sub('@.*@', to, lyxin[line])
717 for line in range(len(lyxin)):
718 lyxin[line] = lyxin[line].replace(fr, to)
719 except: # wrong sed entry?
720 print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
723 writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
727 def checkTeXAllowSpaces():
728 ''' Let's check whether spaces are allowed in TeX file names '''
729 tex_allows_spaces = 'false'
731 print "Checking whether TeX allows spaces in file names... ",
732 writeToFile('a b.tex', r'\message{working^^J}' )
734 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
736 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
737 if 'working' in latex_out:
739 tex_allows_spaces = 'true'
742 tex_allows_spaces = 'false'
743 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
744 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
747 def removeTempFiles():
749 if not lyx_keep_temps:
750 removeFiles(['chkconfig.sed', 'chkconfig.vars', \
751 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
752 'chklayouts.tex', 'missfont.log',
753 'chklatex.ltx', 'chklatex.log'])
756 if __name__ == '__main__':
757 lyx_check_config = True
758 outfile = 'lyxrc.defaults'
760 lyx_keep_temps = False
762 logfile = 'configure.log'
763 ## Parse the command line
764 for op in sys.argv[1:]: # default shell/for list is $*, the options
765 if op in [ '-help', '--help', '-h' ]:
766 print '''Usage: configure [options]
768 --help show this help lines
769 --keep-temps keep temporary files (for debug. purposes)
770 --without-latex-config do not run LaTeX to determine configuration
771 --with-version-suffix=suffix suffix of binary installed files
774 elif op == '--without-latex-config':
775 lyx_check_config = False
776 elif op == '--keep-temps':
777 lyx_keep_temps = True
778 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
779 version_suffix = op[22:]
781 print "Unknown option", op
784 # set up log file for stdout and stderr
785 log = open(logfile, 'w')
786 sys.stdout = Tee(sys.stdout, log)
787 sys.stderr = Tee(sys.stderr, log)
788 # check if we run from the right directory
789 srcdir = os.path.dirname(sys.argv[0])
792 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
793 print "configure: error: cannot find chkconfig.ltx script"
797 windows_style_tex_paths = checkTeXPaths()
798 dtl_tools = checkDTLtools()
799 ## Write the first part of outfile
800 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
801 # script. It contains default settings that have been determined by
802 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
803 # want to customize LyX, use LyX' Preferences dialog or modify directly
804 # the "preferences" file instead. Any setting in that file will
805 # override the values given here.
808 LATEX = checkLatex(dtl_tools)
809 checkFormatEntries(dtl_tools)
810 checkConverterEntries()
811 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
812 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
813 checkTeXAllowSpaces()
814 if windows_style_tex_paths != '':
815 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
817 # --without-latex-config can disable lyx_check_config
818 checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)