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', ['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', ['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 Writer" O "" "" "document,vector"
313 \Format wmf wmf "Windows Meta File" "" "" "" "vector"
314 \Format word doc "MS Word" W "" "" "document,vector"
315 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
319 def checkConverterEntries():
320 ''' Check all converters (\converter entries) '''
321 checkProg('the pdflatex program', ['pdflatex $$i'],
322 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
324 ''' If we're running LyX in-place then tex2lyx will be found in
325 ../src/tex2lyx. Add this directory to the PATH temporarily and
327 Use PATH to avoid any problems with paths-with-spaces.
329 path_orig = os.environ["PATH"]
330 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
331 os.pathsep + path_orig
333 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
334 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
335 \converter literate lyx "%% -n -f $$i $$o" ""'''])
337 os.environ["PATH"] = path_orig
340 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
341 rc_entry = [ r'\converter literate latex "%%" ""' ])
343 checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
344 rc_entry = [ r'\converter html latex "%%" ""' ])
346 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
347 rc_entry = [ r'\converter word latex "%%" ""' ])
349 checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
350 rc_entry = [ r'\converter latex wordhtml "%%" ""' ])
352 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
353 rc_entry = [ r'\converter sxw latex "%%" ""' ])
355 checkProg('a LaTeX -> OpenOffice.org converter', ['oolatex $$i', 'oolatex.sh $$i'],
356 rc_entry = [ r'\converter latex sxw "%%" "latex"' ])
357 # On windows it is called latex2rt.exe
358 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
359 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
361 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
362 rc_entry = [ r'\converter ps pdf "%%" ""' ])
364 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
365 rc_entry = [ r'\converter ps text2 "%%" ""' ])
367 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
368 rc_entry = [ r'\converter ps text3 "%%" ""' ])
370 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
371 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
373 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
374 rc_entry = [ r'\converter dvi ps "%%" ""' ])
376 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
377 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
379 path, dvipng = checkProg('dvipng', ['dvipng'])
380 if dvipng == "dvipng":
381 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
383 addToRC(r'\converter lyxpreview png "" ""')
385 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
386 rc_entry = [ r'\converter ps fax "%%" ""'])
388 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
390 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
391 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
392 \converter fig png "fig2dev -L png $$i $$o" ""''',
395 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
396 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
398 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
400 r'''\converter tgif eps "tgif -stdout -print -color -eps $$i > $$o" ""
401 \converter tgif ppm "tgif -stdout -print -color -ppm $$i > $$o" ""
402 \converter tgif png "tgif -stdout -print -color -png $$i > $$o" ""
403 \converter tgif pdf "tgif -stdout -print -color -pdf $$i > $$o" ""''',
406 checkProg('a WMF -> EPS converter', ['wmf2eps -o $$o $$i'],
407 rc_entry = [ r'\converter wmf eps "%%" ""', ''])
409 checkProg('an EPS -> PDF converter', ['epstopdf'],
410 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
412 # no agr -> pdf converter, since the pdf library used by gracebat is not
413 # free software and therefore not compiled in in many installations.
414 # Fortunately, this is not a big problem, because we will use epstopdf to
415 # convert from agr to pdf via eps without loss of quality.
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 # Entries 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" ""
461 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
462 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
463 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
464 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
465 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
466 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
471 ''' Check linuxdoc '''
473 path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
475 r'''\converter linuxdoc lyx "sgml2lyx $$i" ""
476 \converter linuxdoc latex "sgml2latex $$i" ""
477 \converter linuxdoc dvi "sgml2latex -o dvi $$i" ""
478 \converter linuxdoc html "sgml2html $$i" ""''',
479 r'''\converter linuxdoc lyx "" ""
480 \converter linuxdoc latex "" ""
481 \converter linuxdoc dvi "" ""
482 \converter linuxdoc html "" ""''' ])
484 return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
486 return ('no', 'false', '')
490 ''' Check docbook '''
491 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
493 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
494 \converter docbook html "sgmltools -b html $$i" ""''',
495 r'''\converter docbook dvi "db2dvi $$i" ""
496 \converter docbook html "db2html $$i" ""''',
497 r'''\converter docbook dvi "" ""
498 \converter docbook html "" ""'''])
501 return ('yes', 'true', '\\def\\hasdocbook{yes}')
503 return ('no', 'false', '')
506 def checkOtherEntries():
507 ''' entries other than Format and Converter '''
508 checkProg('a *roff formatter', ['groff', 'nroff'],
510 r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
511 r'\plaintext_roff_command "tbl $$FName | nroff"',
512 r'\plaintext_roff_command ""' ])
513 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
514 rc_entry = [ r'\chktex_command "%%"' ])
515 checkProg('a spellchecker', ['ispell'],
516 rc_entry = [ r'\spell_command "%%"' ])
517 ## FIXME: OCTAVE is not used anywhere
518 # path, OCTAVE = checkProg('Octave', ['octave'])
519 ## FIXME: MAPLE is not used anywhere
520 # path, MAPLE = checkProg('Maple', ['maple'])
521 checkProg('a spool command', ['lp', 'lpr'],
523 r'''\print_spool_printerprefix "-d "
524 \print_spool_command "lp"''',
525 r'''\print_spool_printerprefix "-P",
526 \print_spool_command "lpr"''',
528 # Add the rest of the entries (no checkProg is required)
529 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
530 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
531 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
535 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
536 ''' process layout file and get a line of result
538 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
540 \DeclareLaTeXClass{article}
541 \DeclareLaTeXClass[scrbook]{book (koma-script)}
542 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
546 "article" "article" "article" "false"
547 "scrbook" "scrbook" "book (koma-script)" "false"
548 "svjog" "svjour" "article (Springer - svjour/jog)" "false"
550 classname = file.split(os.sep)[-1].split('.')[0]
551 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
552 p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
553 for line in open(file).readlines():
556 (classtype, optAll, opt, opt1, desc) = res.groups()
557 avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
560 return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
561 print "Layout file without \DeclareXXClass line. "
565 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
566 ''' Explore the LaTeX configuration '''
567 print 'checking LaTeX configuration... ',
568 # First, remove the files that we want to re-create
569 removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
572 print ' default values'
573 print '+checking list of textclasses... '
574 tx = open('textclass.lst', 'w')
576 # This file declares layouts and their associated definition files
577 # (include dir. relative to the place where this file is).
578 # It contains only default values, since chkconfig.ltx could not be run
579 # for some reason. Run ./configure.py if you need to update it after a
580 # configuration change.
582 # build the list of available layout files and convert it to commands
585 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
586 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
588 if not os.path.isfile(file):
590 # get stuff between /xxxx.layout .
591 classname = file.split(os.sep)[-1].split('.')[0]
593 cleanclass = classname.replace(' ', '_')
594 cleanclass = cleanclass.replace('-', '_')
595 # make sure the same class is not considered twice
596 if foundClasses.count(cleanclass) == 0: # not found before
597 foundClasses.append(cleanclass)
598 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
603 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
604 'chkconfig.classes', 'chklayouts.tex'])
606 if not os.path.isfile( 'chkconfig.ltx' ):
607 shutil.copy( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
609 writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
610 % (linuxdoc_cmd, docbook_cmd) )
611 # Construct the list of classes to test for.
612 # build the list of available layout files and convert it to commands
614 p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
616 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
617 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
618 if not os.path.isfile(file):
620 classname = file.split(os.sep)[-1].split('.')[0]
621 for line in open(file).readlines():
622 if p1.search(line) == None:
625 print "Wrong input layout file with line '" + line
627 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
630 cl = open('chklayouts.tex', 'w')
631 for line in testclasses:
632 cl.write(line + '\n')
635 # we have chklayouts.tex, then process it
636 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
638 line = fout.readline()
641 if re.match('^\+', line):
645 # currently, values in chhkconfig are only used to set
648 for line in open('chkconfig.vars').readlines():
649 key, val = re.sub('-', '_', line).split('=')
651 values[key] = val.strip("'")
652 # chk_fontenc may not exist
654 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
657 if rmcopy: # remove the copied file
658 removeFiles( [ 'chkconfig.ltx' ] )
661 def createLaTeXConfig():
662 ''' create LaTeXConfig.lyx '''
663 # if chkconfig.sed does not exist (because LaTeX did not run),
664 # then provide a standard version.
665 if not os.path.isfile('chkconfig.sed'):
666 writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
667 print "creating packages.lst"
668 # if packages.lst does not exist (because LaTeX did not run),
669 # then provide a standard version.
670 if not os.path.isfile('packages.lst'):
671 writeToFile('packages.lst', '''
672 ### This file should contain the list of LaTeX packages that have been
673 ### recognized by LyX. Unfortunately, since configure could not find
674 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
675 ### if you need to update it after a configuration change.
677 print 'creating doc/LaTeXConfig.lyx'
679 # This is originally done by sed, using a
680 # tex-generated file chkconfig.sed
681 ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
682 ## >doc/LaTeXConfig.lyx
683 # Now, we have to do it by hand (python).
685 # add to chekconfig.sed
686 writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
688 ''' % (chk_linuxdoc, chk_docbook) , append=True)
689 # process this sed file!!!!
690 lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
692 p = re.compile(r's!(.*)!(.*)!g')
693 # process each sed replace.
694 for sed in open('chkconfig.sed').readlines():
695 if sed.strip() == '':
698 fr, to = p.match(sed).groups()
699 # if latex did not run, change all @name@ to '???'
701 for line in range(len(lyxin)):
702 lyxin[line] = re.sub('@.*@', to, lyxin[line])
704 for line in range(len(lyxin)):
705 lyxin[line] = lyxin[line].replace(fr, to)
706 except: # wrong sed entry?
707 print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
710 writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
714 def checkTeXAllowSpaces():
715 ''' Let's check whether spaces are allowed in TeX file names '''
716 tex_allows_spaces = 'false'
718 print "Checking whether TeX allows spaces in file names... ",
719 writeToFile('a b.tex', r'\message{working^^J}' )
721 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
723 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
724 if 'working' in latex_out:
726 tex_allows_spaces = 'true'
729 tex_allows_spaces = 'false'
730 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
731 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
734 def removeTempFiles():
736 if not lyx_keep_temps:
737 removeFiles(['chkconfig.sed', 'chkconfig.vars', \
738 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
739 'chklayouts.tex', 'missfont.log',
740 'chklatex.ltx', 'chklatex.log'])
743 if __name__ == '__main__':
744 lyx_check_config = True
745 outfile = 'lyxrc.defaults'
747 lyx_keep_temps = False
749 logfile = 'configure.log'
750 ## Parse the command line
751 for op in sys.argv[1:]: # default shell/for list is $*, the options
752 if op in [ '-help', '--help', '-h' ]:
753 print '''Usage: configure [options]
755 --help show this help lines
756 --keep-temps keep temporary files (for debug. purposes)
757 --without-latex-config do not run LaTeX to determine configuration
758 --with-version-suffix=suffix suffix of binary installed files
761 elif op == '--without-latex-config':
762 lyx_check_config = False
763 elif op == '--keep-temps':
764 lyx_keep_temps = True
765 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
766 version_suffix = op[22:]
768 print "Unknown option", op
771 # set up log file for stdout and stderr
772 log = open(logfile, 'w')
773 sys.stdout = Tee(sys.stdout, log)
774 sys.stderr = Tee(sys.stderr, log)
775 # check if we run from the right directory
776 srcdir = os.path.dirname(sys.argv[0])
779 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
780 print "configure: error: cannot find chkconfig.ltx script"
784 windows_style_tex_paths = checkTeXPaths()
785 dtl_tools = checkDTLtools()
786 ## Write the first part of outfile
787 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
788 # script. It contains default settings that have been determined by
789 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
790 # want to customize LyX, use LyX' Preferences dialog or modify directly
791 # the "preferences" file instead. Any setting in that file will
792 # override the values given here.
795 LATEX = checkLatex(dtl_tools)
796 checkFormatEntries(dtl_tools)
797 checkConverterEntries()
798 (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
799 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
800 checkTeXAllowSpaces()
801 if windows_style_tex_paths != '':
802 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
804 # --without-latex-config can disable lyx_check_config
805 checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)