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'])
242 path, ie = checkViewer('a raster image editor', ['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', ['gv', 'ghostview -swap', 'kghostview'],
277 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
278 \Format ps ps Postscript t "%%" "" "document,vector"'''])
280 checkViewer('a PDF previewer', ['acrobat', 'acroread', 'gv', 'ghostview', \
281 'xpdf', 'kpdf', 'kghostview'],
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', ['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 lyxpreview lyxpreview "LyX Preview" "" "" "" ""
305 \Format pdftex pdftex_t PDFTEX "" "" "" ""
306 \Format program "" Program "" "" "" ""
307 \Format pstex pstex_t PSTEX "" "" "" ""
308 \Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
309 \Format sxw sxw "OpenOffice.Org Writer" O "" "" "document,vector"
310 \Format wmf wmf "Windows Meta File" "" "" "" "vector"
311 \Format word doc "MS Word" W "" "" "document,vector"
312 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
316 def checkConverterEntries():
317 ''' Check all converters (\converter entries) '''
318 checkProg('the pdflatex program', ['pdflatex $$i'],
319 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
321 ''' If we're running LyX in-place then tex2lyx will be found in
322 ../src/tex2lyx. Add this directory to the PATH temporarily and
324 Use PATH to avoid any problems with paths-with-spaces.
326 path_orig = os.environ["PATH"]
327 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
328 os.pathsep + path_orig
330 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
331 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
332 \converter literate lyx "%% -n -f $$i $$o" ""'''])
334 os.environ["PATH"] = path_orig
337 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
338 rc_entry = [ r'\converter literate latex "%%" ""' ])
340 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
341 rc_entry = [ r'\converter html latex "%%" ""' ])
343 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
344 rc_entry = [ r'\converter word latex "%%" ""' ])
346 checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
347 rc_entry = [ r'\converter latex wordhtml "%%" ""' ])
349 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
350 rc_entry = [ r'\converter sxw latex "%%" ""' ])
352 checkProg('a LaTeX -> OpenOffice.org converter', ['oolatex $$i', 'oolatex.sh $$i'],
353 rc_entry = [ r'\converter latex sxw "%%" "latex"' ])
354 # On windows it is called latex2rt.exe
355 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
356 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
358 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
359 rc_entry = [ r'\converter ps pdf "%%" ""' ])
361 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
362 rc_entry = [ r'\converter ps text2 "%%" ""' ])
364 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
365 rc_entry = [ r'\converter ps text3 "%%" ""' ])
367 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
368 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
370 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
371 rc_entry = [ r'\converter dvi ps "%%" ""' ])
373 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
374 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
376 path, dvipng = checkProg('dvipng', ['dvipng'])
377 if dvipng == "dvipng":
378 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
380 addToRC(r'\converter lyxpreview png "" ""')
382 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
383 rc_entry = [ r'\converter ps fax "%%" ""'])
385 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
387 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
388 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
389 \converter fig png "fig2dev -L png $$i $$o" ""''',
392 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
393 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
395 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
397 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
398 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
399 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
400 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
403 checkProg('a WMF -> EPS converter', ['wmf2eps -o $$o $$i'],
404 rc_entry = [ r'\converter wmf eps "%%" ""', ''])
406 checkProg('an EPS -> PDF converter', ['epstopdf'],
407 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
409 path, convert = checkProg('a PDF -> PNG converter', ['convert'])
411 # check whether convert supports the -define option
412 conv_opts = "-define pdf:use-cropbox=true -depth 8"
413 if not 'Unrecognized' in cmdOutput('convert ' + conv_opts + ' 2>&1'):
414 addToRC(r'\converter pdf png "convert %s pdf:$$i png:$$o" ""' % conv_opts)
416 checkProg('a Grace -> Image converter', ['gracebat'],
418 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
419 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
420 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
421 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
424 checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
425 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
426 rc_entry = [ r'\converter latex html "%%" "originaldir,needaux"' ])
428 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
430 version_string = cmdOutput("lilypond --version")
431 match = re.match('GNU LilyPond (\S+)', version_string)
433 version_number = match.groups()[0]
434 version = version_number.split('.')
435 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
436 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
437 \converter lilypond png "lilypond -b eps --png $$i" ""''')
438 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
439 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
440 print '+ found LilyPond version %s.' % version_number
442 print '+ found LilyPond, but version %s is too old.' % version_number
444 print '+ found LilyPond, but could not extract version number.'
446 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
447 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
449 # FIXME: no rc_entry? comment it out
450 # checkProg('Image converter', ['convert $$i $$o'])
452 # Entried that do not need checkProg
453 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
454 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
455 \converter docbook docbook-xml "cp $$i $$o" "xml"
456 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
457 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
458 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
459 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
460 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
465 ''' Check linuxdoc '''
467 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
469 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
470 \converter linuxdoc latex "sgml2latex $$i" ""
471 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
472 \converter linuxdoc html "sgml2html $$i" ""''',
473 r'''\converter linuxdoc lyx "" ""
474 \converter linuxdoc latex "" ""
475 \converter linuxdoc dvi "" ""
476 \converter linuxdoc html "" ""''' ])
478 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
480 return ('no', 'false', '')
484 ''' Check docbook '''
485 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
487 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
488 \converter docbook html "sgmltools -b html $$i" ""''',
489 r'''\converter docbook dvi "db2dvi $$i" ""
490 \converter docbook html "db2html $$i" ""''',
491 r'''\converter docbook dvi "" ""
492 \converter docbook html "" ""'''])
495 return ('yes', 'true', '\\def\\hasdocbook{yes}')
497 return ('no', 'false', '')
500 def checkOtherEntries():
501 ''' entries other than Format and Converter '''
502 checkProg('a *roff formatter', ['groff', 'nroff'],
504 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
505 r'\plaintext_roff_command "tbl $$FName | nroff"',
506 r'\plaintext_roff_command ""' ])
507 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
508 rc_entry = [ r'\chktex_command "%%"' ])
509 checkProg('a spellchecker', ['ispell'],
510 rc_entry = [ r'\spell_command "%%"' ])
511 ## FIXME: OCTAVE is not used anywhere
512 # path, OCTAVE = checkProg('Octave', ['octave'])
513 ## FIXME: MAPLE is not used anywhere
514 # path, MAPLE = checkProg('Maple', ['maple'])
515 checkProg('a spool command', ['lp', 'lpr'],
517 r'''\print_spool_printerprefix "-d "
518 \print_spool_command "lp"''',
519 r'''\print_spool_printerprefix "-P",
520 \print_spool_command "lpr"''',
522 # Add the rest of the entries (no checkProg is required)
523 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
524 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
525 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
529 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
530 ''' process layout file and get a line of result
532 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
534 \DeclareLaTeXClass{article}
535 \DeclareLaTeXClass[scrbook]{book (koma-script)}
536 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
540 "article" "article" "article" "false"
541 "scrbook" "scrbook" "book (koma-script)" "false"
542 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
544 classname = file.split(os.sep)[-1].split('.')[0]
545 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
546 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
547 for line in open(file).readlines():
550 (classtype, optAll, opt, opt1, desc) = res.groups()
551 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
554 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
555 print "Layout file without \DeclareXXClass line. "
559 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
560 ''' Explore the LaTeX configuration '''
561 print 'checking LaTeX configuration... ',
562 # First, remove the files that we want to re-create
563 removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
566 print ' default values'
567 print '+checking list of textclasses... '
568 tx = open('textclass.lst', 'w')
570 # This file declares layouts and their associated definition files
571 # (include dir. relative to the place where this file is).
572 # It contains only default values, since chkconfig.ltx could not be run
573 # for some reason. Run ./configure.py if you need to update it after a
574 # configuration change.
576 # build the list of available layout files and convert it to commands
579 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
580 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
582 if not os.path.isfile(file):
584 # get stuff between /xxxx.layout .
585 classname = file.split(os.sep)[-1].split('.')[0]
587 cleanclass = classname.replace(' ', '_')
588 cleanclass = cleanclass.replace('-', '_')
589 # make sure the same class is not considered twice
590 if foundClasses.count(cleanclass) == 0: # not found before
591 foundClasses.append(cleanclass)
592 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
597 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
598 'chkconfig.classes', 'chklayouts.tex'])
600 if not os.path.isfile( 'chkconfig.ltx' ):
601 shutil.copy( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
603 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
604 % (linuxdoc_cmd, docbook_cmd) )
605 # Construct the list of classes to test for.
606 # build the list of available layout files and convert it to commands
608 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
610 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
611 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
612 if not os.path.isfile(file):
614 classname = file.split(os.sep)[-1].split('.')[0]
615 for line in open(file).readlines():
616 if p1.search(line) == None:
619 print "Wrong input layout file with line '" + line
621 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
624 cl = open('chklayouts.tex', 'w')
625 for line in testclasses:
626 cl.write(line + '\n')
629 # we have chklayouts.tex, then process it
630 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
632 line = fout.readline()
635 if re.match('^\+', line):
639 # currently, values in chhkconfig are only used to set
642 for line in open('chkconfig.vars').readlines():
643 key, val = re.sub('-', '_', line).split('=')
645 values[key] = val.strip("'")
646 # chk_fontenc may not exist
648 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
651 if rmcopy: # remove the copied file
652 removeFiles( [ 'chkconfig.ltx' ] )
655 def createLaTeXConfig():
656 ''' create LaTeXConfig.lyx '''
657 # if chkconfig.sed does not exist (because LaTeX did not run),
658 # then provide a standard version.
659 if not os.path.isfile('chkconfig.sed'):
660 writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
661 print "creating packages.lst"
662 # if packages.lst does not exist (because LaTeX did not run),
663 # then provide a standard version.
664 if not os.path.isfile('packages.lst'):
665 writeToFile('packages.lst', '''
666 ### This file should contain the list of LaTeX packages that have been
667 ### recognized by LyX. Unfortunately, since configure could not find
668 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
669 ### if you need to update it after a configuration change.
671 print 'creating doc/LaTeXConfig.lyx'
673 # This is originally done by sed, using a
674 # tex-generated file chkconfig.sed
675 ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
676 ## >doc/LaTeXConfig.lyx
677 # Now, we have to do it by hand (python).
679 # add to chekconfig.sed
680 writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
682 ''' % (chk_linuxdoc, chk_docbook) , append=True)
683 # process this sed file!!!!
684 lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
686 p = re.compile(r's!(.*)!(.*)!g')
687 # process each sed replace.
688 for sed in open('chkconfig.sed').readlines():
689 if sed.strip() == '':
692 fr, to = p.match(sed).groups()
693 # if latex did not run, change all @name@ to '???'
695 for line in range(len(lyxin)):
696 lyxin[line] = re.sub('@.*@', to, lyxin[line])
698 for line in range(len(lyxin)):
699 lyxin[line] = lyxin[line].replace(fr, to)
700 except: # wrong sed entry?
701 print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
704 writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
708 def checkTeXAllowSpaces():
709 ''' Let's check whether spaces are allowed in TeX file names '''
710 tex_allows_spaces = 'false'
712 print "Checking whether TeX allows spaces in file names... ",
713 writeToFile('a b.tex', r'\message{working^^J}' )
715 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
717 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
718 if 'working' in latex_out:
720 tex_allows_spaces = 'true'
723 tex_allows_spaces = 'false'
724 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
725 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
728 def removeTempFiles():
730 if not lyx_keep_temps:
731 removeFiles(['chkconfig.sed', 'chkconfig.vars', \
732 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
733 'chklayouts.tex', 'missfont.log',
734 'chklatex.ltx', 'chklatex.log'])
737 if __name__ == '__main__':
738 lyx_check_config = True
739 outfile = 'lyxrc.defaults'
741 lyx_keep_temps = False
743 logfile = 'configure.log'
744 ## Parse the command line
745 for op in sys.argv[1:]: # default shell/for list is $*, the options
746 if op in [ '-help', '--help', '-h' ]:
747 print '''Usage: configure [options]
749 --help show this help lines
750 --keep-temps keep temporary files (for debug. purposes)
751 --without-latex-config do not run LaTeX to determine configuration
752 --with-version-suffix=suffix suffix of binary installed files
755 elif op == '--without-latex-config':
756 lyx_check_config = False
757 elif op == '--keep-temps':
758 lyx_keep_temps = True
759 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
760 version_suffix = op[22:]
762 print "Unknown option", op
765 # set up log file for stdout and stderr
766 log = open(logfile, 'w')
767 sys.stdout = Tee(sys.stdout, log)
768 sys.stderr = Tee(sys.stderr, log)
769 # check if we run from the right directory
770 srcdir = os.path.dirname(sys.argv[0])
773 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
774 print "configure: error: cannot find chkconfig.ltx script"
778 windows_style_tex_paths = checkTeXPaths()
779 dtl_tools = checkDTLtools()
780 ## Write the first part of outfile
781 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
782 # script. It contains default settings that have been determined by
783 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
784 # want to customize LyX, use LyX' Preferences dialog or modify directly
785 # the "preferences" file instead. Any setting in that file will
786 # override the values given here.
789 LATEX = checkLatex(dtl_tools)
790 checkFormatEntries(dtl_tools)
791 checkConverterEntries()
792 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
793 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
794 checkTeXAllowSpaces()
795 if windows_style_tex_paths != '':
796 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
798 # --without-latex-config can disable lyx_check_config
799 checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)