lib/configure.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # file configure.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7
   8 # \author Bo Peng
   9 # Full author contact details are available in file CREDITS.
  10
  11 import sys, os, re, shutil, glob, logging
  12
  13 # set up logging
  14 logging.basicConfig(level = logging.DEBUG,
  15     format = '%(levelname)s: %(message)s', # ignore application name
  16     filename = 'configure.log',
  17     filemode = 'w')
  18 #
  19 # Add a handler to log to console
  20 console = logging.StreamHandler()
  21 console.setLevel(logging.INFO) # the console only print out general information
  22 formatter = logging.Formatter('%(message)s') # only print out the message itself
  23 console.setFormatter(formatter)
  24 logger = logging.getLogger('LyX')
  25 logger.addHandler(console)
  26
  27 def writeToFile(filename, lines, append = False):
  28     " utility function: write or append lines to filename "
  29     if append:
  30         file = open(filename, 'a')
  31     else:
  32         file = open(filename, 'w')
  33     file.write(lines)
  34     file.close()
  35
  36
  37 def addToRC(lines):
  38     ''' utility function: shortcut for appending lines to outfile
  39         add newline at the end of lines.
  40     '''
  41     if lines.strip() != '':
  42         writeToFile(outfile, lines + '\n', append = True)
  43         logger.debug('Add to RC:\n' + lines + '\n\n')
  44
  45
  46 def removeFiles(filenames):
  47     '''utility function: 'rm -f'
  48         ignore errors when file does not exist, or is a directory.
  49     '''
  50     for file in filenames:
  51         try:
  52             os.remove(file)
  53             logger.debug('Removing file %s' % file)
  54         except:
  55             logger.debug('Failed to remove file %s' % file)
  56             pass
  57
  58
  59 def cmdOutput(cmd):
  60     '''utility function: run a command and get its output as a string
  61         cmd: command to run
  62     '''
  63     fout = os.popen(cmd)
  64     output = fout.read()
  65     fout.close()
  66     return output.strip()
  67
  68
  69 def setEnviron():
  70     ''' I do not really know why this is useful, but we might as well keep it.
  71         NLS nuisances.
  72         Only set these to C if already set.  These must not be set unconditionally
  73         because not all systems understand e.g. LANG=C (notably SCO).
  74         Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
  75         Non-C LC_CTYPE values break the ctype check.
  76     '''
  77     os.environ['LANG'] = os.getenv('LANG', 'C')
  78     os.environ['LC'] = os.getenv('LC_ALL', 'C')
  79     os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
  80     os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
  81
  82
  83 def createDirectories():
  84     ''' Create the build directories if necessary '''
  85     for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
  86         'layouts', 'scripts', 'templates', 'ui' ]:
  87         if not os.path.isdir( dir ):
  88             try:
  89                 os.mkdir( dir)
  90                 logger.debug('Create directory %s.' % dir)
  91             except:
  92                 logger.error('Failed to create directory %s.' % dir)
  93                 sys.exit(1)
  94
  95
  96 def checkTeXPaths():
  97     ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
  98     windows_style_tex_paths = ''
  99     if os.name == 'nt' or sys.platform == 'cygwin':
 100         from tempfile import mkstemp
 101         fd, tmpfname = mkstemp(suffix='.ltx')
 102         if os.name == 'nt':
 103             inpname = tmpfname.replace('\\', '/')
 104         else:
 105             inpname = cmdOutput('cygpath -m ' + tmpfname)
 106         logname = os.path.basename(inpname.replace('.ltx', '.log'))
 107         inpname = inpname.replace('~', '\\string~')
 108         os.write(fd, r'\relax')
 109         os.close(fd)
 110         latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
 111         if 'Error' in latex_out:
 112             logger.warning("configure: TeX engine needs posix-style paths in latex files")
 113             windows_style_tex_paths = 'false'
 114         else:
 115             logger.info("configure: TeX engine needs windows-style paths in latex files")
 116             windows_style_tex_paths = 'true'
 117         removeFiles([tmpfname, logname, 'texput.log'])
 118     return windows_style_tex_paths
 119
 120
 121 ## Searching some useful programs
 122 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
 123     '''
 124         This function will search a program in $PATH plus given path
 125         If found, return directory and program name (not the options).
 126
 127         description: description of the program
 128
 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.
 132
 133         path: additional pathes
 134
 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.
 143
 144         not_found: the value that should be used instead of '' if no program
 145             was found
 146
 147     '''
 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         logger.error("rc entry should have one item or item for each prog and not_found.")
 151         sys.exit(2)
 152     logger.info('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
 156         ac_prog = progs[idx]
 157         ac_word = ac_prog.split(' ')[0]
 158         msg = '+checking for "' + ac_word + '"... '
 159         path = os.environ["PATH"].split(os.pathsep) + path
 160         extlist = ['']
 161         if os.environ.has_key("PATHEXT"):
 162             extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 163         for ac_dir in path:
 164             for ext in extlist:
 165                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 166                     logger.info(msg + ' yes')
 167                     # write rc entries for this command
 168                     if len(rc_entry) == 1:
 169                         addToRC(rc_entry[0].replace('%%', ac_prog))
 170                     elif len(rc_entry) > 1:
 171                         addToRC(rc_entry[idx].replace('%%', ac_prog))
 172                     return [ac_dir, ac_word]
 173         # if not successful
 174         logger.info(msg + ' no')
 175     # write rc entries for 'not found'
 176     if len(rc_entry) > 0:  # the last one.
 177         addToRC(rc_entry[-1].replace('%%', not_found))
 178     return ['', not_found]
 179
 180
 181 def checkViewer(description, progs, rc_entry = [], path = []):
 182     ''' The same as checkProg, but for viewers and editors '''
 183     return checkProg(description, progs, rc_entry, path, not_found = 'auto')
 184
 185
 186 def checkDTLtools():
 187     ''' Check whether DTL tools are available (Windows only) '''
 188     # Find programs! Returned path is not used now
 189     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 190             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 191             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 192         dtl_tools = True
 193     else:
 194         dtl_tools = False
 195     return dtl_tools
 196
 197
 198 def checkLatex(dtl_tools):
 199     ''' Check latex, return lyx_check_config '''
 200     path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
 201     path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
 202     #-----------------------------------------------------------------
 203     path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
 204     if PLATEX != '':
 205         # check if PLATEX is pLaTeX2e
 206         writeToFile('chklatex.ltx', '''
 207 \\nonstopmode
 208 \\@@end
 209 ''')
 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)
 214             LATEX = PLATEX
 215         else:
 216             PLATEX = ''
 217             removeFiles(['chklatex.ltx', 'chklatex.log'])
 218     #-----------------------------------------------------------------
 219     # use LATEX to convert from latex to dvi if PPLATEX is not available
 220     if PPLATEX == '':
 221         PPLATEX = LATEX
 222     if dtl_tools:
 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)
 226     else:
 227         addToRC(r'\converter latex      dvi        "%s" "latex"' % PPLATEX)
 228     # no latex
 229     if LATEX != '':
 230         # Check if latex is usable
 231         writeToFile('chklatex.ltx', '''
 232 \\nonstopmode\\makeatletter
 233 \\ifx\\undefined\\documentclass\\else
 234   \\message{ThisIsLaTeX2e}
 235 \\fi
 236 \\@@end
 237 ''')
 238         # run latex on chklatex.ltx and check result
 239         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 240             # valid latex2e
 241             return LATEX
 242         else:
 243             logger.warning("Latex not usable (not LaTeX2e) ")
 244         # remove temporary files
 245         removeFiles(['chklatex.ltx', 'chklatex.log'])
 246     return ''
 247
 248
 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"'])
 253     #
 254     checkViewer('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
 255         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"'])
 256     #
 257     checkViewer('a Dia viewer and editor', ['dia'],
 258         rc_entry = [r'\Format dia        dia     DIA                    "" "%%" "%%"    "vector"'])
 259     #
 260     checkViewer('a Grace viewer and editor', ['xmgrace'],
 261         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"'])
 262     #
 263     checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 264         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""'])
 265     #
 266     path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
 267     path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
 268     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 269 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 270 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 271 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 272 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 273 \Format png        png     PNG                    "" "%s"       "%s"    ""
 274 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 275 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 276 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 277 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 278         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 279     #
 280     checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 281         'nedit', 'gedit', 'notepad'],
 282         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 283 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 284 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 285 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 286 \Format docbook    sgml    DocBook                B  "" "%%"    "document"
 287 \Format docbook-xml xml   "Docbook (XML)"         "" "" "%%"    "document"
 288 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"
 289 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document"
 290 \Format literate   nw      NoWeb                  N  "" "%%"    "document"
 291 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"
 292 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document"
 293 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document"
 294 \Format text       txt    "Plain text"            a  "" "%%"    "document"
 295 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 296 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 297 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 298 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"''' ])
 299  #
 300     checkViewer('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
 301         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 302         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 303         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 304         'nedit', 'gedit', 'notepad'],
 305         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""''' ])
 306     #
 307     #checkProg('a Postscript interpreter', ['gs'],
 308     #  rc_entry = [ r'\ps_command "%%"' ])
 309     checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
 310         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"
 311 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector"'''])
 312     #
 313     checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 314                     'gv', 'ghostview'],
 315         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector"
 316 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector"
 317 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector"'''])
 318     #
 319     checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
 320         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document,vector"'])
 321     if dtl_tools:
 322         # Windows only: DraftDVI
 323         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"')
 324     #
 325     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 326         rc_entry = [r'\Format html       html    HTML                   H  "%%" ""      "document"'])
 327     #
 328     checkViewer('Noteedit', ['noteedit'],
 329         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"'])
 330     #
 331     checkViewer('an OpenDocument viewer', ['swriter', 'oowriter'],
 332         rc_entry = [r'\Format odt        odt     OpenDocument           "" "%%" "%%"    "document,vector"'])
 333     #
 334     # entried that do not need checkProg
 335     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 336 \Format csv        csv    "Table (CSV)"  "" ""  ""      "document"
 337 \Format fax        ""      Fax                    "" "" ""      "document"
 338 \Format lyx        lyx     LyX                    "" "" ""      ""
 339 \Format lyx13x     lyx13  "LyX 1.3.x"             "" "" ""      "document"
 340 \Format lyx14x     lyx14  "LyX 1.4.x"             "" "" ""      "document"
 341 \Format lyx15x     lyx15  "LyX 1.5.x"             "" "" ""      "document"
 342 \Format lyx16x     lyx16  "LyX 1.6.x"             "" "" ""      "document"
 343 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 344 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 345 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 346 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 347 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)"       "" ""  ""      ""
 348 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 349 \Format program    ""      Program                "" "" ""      ""
 350 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 351 \Format rtf        rtf    "Rich Text Format"      "" "" ""      "document,vector"
 352 \Format sxw        sxw    "OpenOffice.Org (sxw)"  ""  ""        ""      "document,vector"
 353 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 354 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 355 \Format word       doc    "MS Word"               W  "" ""      "document,vector"
 356 \Format wordhtml   html   "HTML (MS Word)"        "" ""        ""       "document"
 357 ''')
 358
 359
 360 def checkConverterEntries():
 361     ''' Check all converters (\converter entries) '''
 362     checkProg('the pdflatex program', ['pdflatex $$i'],
 363         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 364
 365     ''' If we're running LyX in-place then tex2lyx will be found in
 366             ../src/tex2lyx. Add this directory to the PATH temporarily and
 367             search for tex2lyx.
 368             Use PATH to avoid any problems with paths-with-spaces.
 369     '''
 370     path_orig = os.environ["PATH"]
 371     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 372         os.pathsep + path_orig
 373
 374     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 375         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 376 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 377
 378     os.environ["PATH"] = path_orig
 379
 380     #
 381     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 382         rc_entry = [r'''\converter literate   latex      "%%"   ""
 383 \converter literate   pdflatex      "%%"        ""'''])
 384     #
 385     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
 386         'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
 387         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 388     #
 389     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 390         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 391     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 392     path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 393         '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 394         'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 395         rc_entry = [ r'\converter latex      html       "%%"    "needaux"' ])
 396     if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 397       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 398     else:
 399       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 400
 401     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 402     path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 403         "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 404         "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 405         rc_entry = [ r'\converter latex      wordhtml   "%%"    "needaux"' ])
 406     if htmlconv.find('htlatex') >= 0:
 407       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 408     #
 409     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 410         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 411     #
 412     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 413         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 414     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 415     # the command mk4ht oolatex $$i has to be used as default,
 416     # but as this would require to have Perl installed, in MiKTeX oolatex is
 417     # directly available as application.
 418     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 419     # Both SuSE and debian have oolatex
 420     checkProg('a LaTeX -> Open Document converter', [
 421         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 422         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 423         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 424     # On windows it is called latex2rt.exe
 425     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 426         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 427     #
 428     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 429         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 430     #
 431     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 432         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 433     #
 434     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 435         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 436     #
 437     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 438         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 439     #
 440     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 441         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 442     #
 443     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 444         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 445     #
 446     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 447         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 448     #
 449     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 450         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 451     #
 452     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 453         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 454     #
 455     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 456         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 457     #
 458     path, dvipng = checkProg('dvipng', ['dvipng'])
 459     if dvipng == "dvipng":
 460         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 461     else:
 462         addToRC(r'\converter lyxpreview png        ""   ""')
 463     #
 464     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
 465         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 466     #
 467     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 468         rc_entry = [
 469             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 470 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 471 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 472             ''])
 473     #
 474     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 475         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 476     #
 477     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 478         rc_entry = [
 479             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 480 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 481 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 482             ''])
 483     #
 484     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 485         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 486     #
 487     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 488         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 489     #
 490     checkProg('an EPS -> PDF converter', ['epstopdf'],
 491         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 492     #
 493     # no agr -> pdf converter, since the pdf library used by gracebat is not
 494     # free software and therefore not compiled in in many installations.
 495     # Fortunately, this is not a big problem, because we will use epstopdf to
 496     # convert from agr to pdf via eps without loss of quality.
 497     checkProg('a Grace -> Image converter', ['gracebat'],
 498         rc_entry = [
 499             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 500 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 501 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 502 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 503             ''])
 504     #
 505     checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
 506         rc_entry = [ r'\converter dot        pdf        "%%"    ""'])
 507     #
 508     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 509         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 510     #
 511     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 512         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 513     #
 514     #
 515     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 516     if (lilypond != ''):
 517         version_string = cmdOutput("lilypond --version")
 518         match = re.match('GNU LilyPond (\S+)', version_string)
 519         if match:
 520             version_number = match.groups()[0]
 521             version = version_number.split('.')
 522             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 523                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps --ps $$i"  ""
 524 \converter lilypond   png        "lilypond -dbackend=eps --png $$i"     ""''')
 525                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps --pdf $$i"   ""')
 526                 print '+  found LilyPond version %s.' % version_number
 527             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 528                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 529 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 530                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 531                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 532                 logger.info('+  found LilyPond version %s.' % version_number)
 533             else:
 534                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 535         else:
 536             logger.info('+  found LilyPond, but could not extract version number.')
 537     #
 538     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 539         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 540     #
 541     # FIXME: no rc_entry? comment it out
 542     # checkProg('Image converter', ['convert $$i $$o'])
 543     #
 544     # Entries that do not need checkProg
 545     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 546 \converter lyxpreview-platex ppm        "python -tt $$s/scripts/lyxpreview-platex2bitmap.py"    ""
 547 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 548 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 549 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 550 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 551 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 552 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 553 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 554 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 555 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 556 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 557 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 558 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 559 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 560 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 561 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 562 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 563 ''')
 564
 565
 566 def checkDocBook():
 567     ''' Check docbook '''
 568     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 569         rc_entry = [
 570             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 571 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 572             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 573 \converter docbook    html       "db2html $$i"  ""''',
 574             r'''\converter docbook    dvi        ""     ""
 575 \converter docbook    html       "" ""''',
 576             r'''\converter docbook    dvi        ""     ""
 577 \converter docbook    html       ""     ""'''])
 578     #
 579     if DOCBOOK != '':
 580         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 581     else:
 582         return ('no', 'false', '')
 583
 584
 585 def checkOtherEntries():
 586     ''' entries other than Format and Converter '''
 587     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 588         rc_entry = [ r'\chktex_command "%%"' ])
 589     checkProg('BibTeX', ['jbibtex', 'bibtex'],
 590         rc_entry = [ r'\bibtex_command "%%"' ])
 591     checkProg('an index processor', ['texindy', 'makeindex -c -q'],
 592         rc_entry = [ r'\index_command "%%"' ])
 593     checkProg('a nomenclature processor', ['makeindex'],
 594         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 595     ## FIXME: OCTAVE is not used anywhere
 596     # path, OCTAVE = checkProg('Octave', ['octave'])
 597     ## FIXME: MAPLE is not used anywhere
 598     # path, MAPLE = checkProg('Maple', ['maple'])
 599     checkProg('a spool command', ['lp', 'lpr'],
 600         rc_entry = [
 601             r'''\print_spool_printerprefix "-d "
 602 \print_spool_command "lp"''',
 603             r'''\print_spool_printerprefix "-P",
 604 \print_spool_command "lpr"''',
 605             ''])
 606     # Add the rest of the entries (no checkProg is required)
 607     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 608 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 609 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 610 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 611 ''')
 612
 613
 614 def processLayoutFile(file, bool_docbook):
 615     ''' process layout file and get a line of result
 616
 617         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 618
 619         \DeclareLaTeXClass{article}
 620         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 621         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 622
 623         we expect output:
 624
 625         "article" "article" "article" "false"
 626         "scrbook" "scrbook" "book (koma-script)" "false"
 627         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 628     '''
 629     classname = file.split(os.sep)[-1].split('.')[0]
 630     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 631     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 632     for line in open(file).readlines():
 633         res = p.search(line)
 634         if res != None:
 635             (classtype, optAll, opt, opt1, desc) = res.groups()
 636             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
 637             if opt == None:
 638                 opt = classname
 639             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 640     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
 641     return ""
 642
 643
 644 def checkLatexConfig(check_config, bool_docbook):
 645     ''' Explore the LaTeX configuration
 646         Return None (will be passed to sys.exit()) for success.
 647     '''
 648     msg = 'checking LaTeX configuration... '
 649     # if --without-latex-config is forced, or if there is no previous
 650     # version of textclass.lst, re-generate a default file.
 651     if not os.path.isfile('textclass.lst') or not check_config:
 652         # remove the files only if we want to regenerate
 653         removeFiles(['textclass.lst', 'packages.lst'])
 654         #
 655         # Then, generate a default textclass.lst. In case configure.py
 656         # fails, we still have something to start lyx.
 657         logger.info(msg + ' default values')
 658         logger.info('+checking list of textclasses... ')
 659         tx = open('textclass.lst', 'w')
 660         tx.write('''
 661 # This file declares layouts and their associated definition files
 662 # (include dir. relative to the place where this file is).
 663 # It contains only default values, since chkconfig.ltx could not be run
 664 # for some reason. Run ./configure.py if you need to update it after a
 665 # configuration change.
 666 ''')
 667         # build the list of available layout files and convert it to commands
 668         # for chkconfig.ltx
 669         foundClasses = []
 670         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 671             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 672             # valid file?
 673             if not os.path.isfile(file):
 674                 continue
 675             # get stuff between /xxxx.layout .
 676             classname = file.split(os.sep)[-1].split('.')[0]
 677             #  tr ' -' '__'`
 678             cleanclass = classname.replace(' ', '_')
 679             cleanclass = cleanclass.replace('-', '_')
 680             # make sure the same class is not considered twice
 681             if foundClasses.count(cleanclass) == 0: # not found before
 682                 foundClasses.append(cleanclass)
 683                 retval = processLayoutFile(file, bool_docbook)
 684                 if retval != "":
 685                     tx.write(retval)
 686         tx.close()
 687         logger.info('\tdone')
 688     if not check_config:
 689         return None
 690     # the following will generate textclass.lst.tmp, and packages.lst.tmp
 691     else:
 692         logger.info(msg + '\tauto')
 693         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 694             'chkconfig.classes', 'chklayouts.tex'])
 695         rmcopy = False
 696         if not os.path.isfile( 'chkconfig.ltx' ):
 697             shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
 698             rmcopy = True
 699         writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
 700         # Construct the list of classes to test for.
 701         # build the list of available layout files and convert it to commands
 702         # for chkconfig.ltx
 703         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 704         testclasses = list()
 705         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 706             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 707             if not os.path.isfile(file):
 708                 continue
 709             classname = file.split(os.sep)[-1].split('.')[0]
 710             for line in open(file).readlines():
 711                 if p1.search(line) == None:
 712                     continue
 713                 if line[0] != '#':
 714                     logger.error("Wrong input layout file with line '" + line)
 715                     sys.exit(3)
 716                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 717                 break
 718         testclasses.sort()
 719         cl = open('chklayouts.tex', 'w')
 720         for line in testclasses:
 721             cl.write(line + '\n')
 722         cl.close()
 723         #
 724         # we have chklayouts.tex, then process it
 725         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 726         while True:
 727             line = fout.readline()
 728             if not line:
 729                 break;
 730             if re.match('^\+', line):
 731                 logger.info(line.strip())
 732         # if the command succeeds, None will be returned
 733         ret = fout.close()
 734         #
 735         # currently, values in chhkconfig are only used to set
 736         # \font_encoding
 737         values = {}
 738         for line in open('chkconfig.vars').readlines():
 739             key, val = re.sub('-', '_', line).split('=')
 740             val = val.strip()
 741             values[key] = val.strip("'")
 742         # chk_fontenc may not exist
 743         try:
 744             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 745         except:
 746             pass
 747         if rmcopy:   # remove the copied file
 748             removeFiles( [ 'chkconfig.ltx' ] )
 749         # if configure successed, move textclass.lst.tmp to textclass.lst
 750         # and packages.lst.tmp to packages.lst
 751         if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
 752             and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
 753             shutil.move('textclass.lst.tmp', 'textclass.lst')
 754             shutil.move('packages.lst.tmp', 'packages.lst')
 755         return ret
 756
 757
 758 def checkModulesConfig():
 759   removeFiles(['lyxmodules.lst'])
 760
 761   logger.info('+checking list of modules... ')
 762   tx = open('lyxmodules.lst', 'w')
 763   tx.write('''## This file declares modules and their associated definition files.
 764 ## It has been automatically generated by configure
 765 ## Use "Options/Reconfigure" if you need to update it after a
 766 ## configuration change.
 767 ''')
 768   # build the list of available modules
 769   foundClasses = []
 770   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
 771       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
 772       # valid file?
 773       logger.info(file)
 774       if not os.path.isfile(file):
 775           continue
 776       retval = processModuleFile(file, bool_docbook)
 777       if retval != "":
 778           tx.write(retval)
 779   tx.close()
 780   logger.info('\tdone')
 781
 782
 783 def processModuleFile(file, bool_docbook):
 784     ''' process module file and get a line of result
 785
 786         The top of a module file should look like this:
 787           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
 788           #BeginDescription
 789           #...body of description...
 790           #EndDescription
 791           #Requires: [list of required modules]
 792           #Excludes: [list of excluded modules]
 793         The last two lines are optional
 794         We expect output:
 795           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
 796     '''
 797     p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
 798     r = re.compile(r'#+\s*Requires: (.*)')
 799     x = re.compile(r'#+\s*Excludes: (.*)')
 800     b = re.compile(r'#+\s*DescriptionBegin\s*$')
 801     e = re.compile(r'#+\s*DescriptionEnd\s*$')
 802
 803     modname = desc = pkgs = req = excl = ""
 804     readingDescription = False
 805     descLines = []
 806     filename = file.split(os.sep)[-1]
 807     filename = filename[:-7]
 808
 809     for line in open(file).readlines():
 810       if readingDescription:
 811         res = e.search(line)
 812         if res != None:
 813           readingDescription = False
 814           desc = " ".join(descLines)
 815           continue
 816         descLines.append(line[1:].strip())
 817         continue
 818       res = b.search(line)
 819       if res != None:
 820         readingDescription = True
 821         continue
 822       res = p.search(line)
 823       if res != None:
 824           (pkgs, modname) = res.groups()
 825           if pkgs == None:
 826             pkgs = ""
 827           else:
 828             tmp = [s.strip() for s in pkgs.split(",")]
 829             pkgs = ",".join(tmp)
 830           continue
 831       res = r.search(line)
 832       if res != None:
 833         req = res.group(1)
 834         tmp = [s.strip() for s in req.split("|")]
 835         req = "|".join(tmp)
 836         continue
 837       res = x.search(line)
 838       if res != None:
 839         excl = res.group(1)
 840         tmp = [s.strip() for s in excl.split("|")]
 841         excl = "|".join(tmp)
 842         continue
 843     if modname != "":
 844         return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
 845     logger.warning("Module file without \DeclareLyXModule line. ")
 846     return ""
 847
 848
 849 def checkTeXAllowSpaces():
 850     ''' Let's check whether spaces are allowed in TeX file names '''
 851     tex_allows_spaces = 'false'
 852     if lyx_check_config:
 853         msg = "Checking whether TeX allows spaces in file names... "
 854         writeToFile('a b.tex', r'\message{working^^J}' )
 855         if os.name == 'nt':
 856             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
 857         else:
 858             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
 859         if 'working' in latex_out:
 860             logger.info(msg + 'yes')
 861             tex_allows_spaces = 'true'
 862         else:
 863             logger.info(msg + 'no')
 864             tex_allows_spaces = 'false'
 865         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
 866         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
 867
 868
 869 def removeTempFiles():
 870     # Final clean-up
 871     if not lyx_keep_temps:
 872         removeFiles(['chkconfig.vars',  \
 873             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
 874             'chklayouts.tex', 'missfont.log',
 875             'chklatex.ltx', 'chklatex.log'])
 876
 877
 878 if __name__ == '__main__':
 879     lyx_check_config = True
 880     outfile = 'lyxrc.defaults'
 881     rc_entries = ''
 882     lyx_keep_temps = False
 883     version_suffix = ''
 884     ## Parse the command line
 885     for op in sys.argv[1:]:   # default shell/for list is $*, the options
 886         if op in [ '-help', '--help', '-h' ]:
 887             print '''Usage: configure [options]
 888 Options:
 889     --help                   show this help lines
 890     --keep-temps             keep temporary files (for debug. purposes)
 891     --without-latex-config   do not run LaTeX to determine configuration
 892     --with-version-suffix=suffix suffix of binary installed files
 893 '''
 894             sys.exit(0)
 895         elif op == '--without-latex-config':
 896             lyx_check_config = False
 897         elif op == '--keep-temps':
 898             lyx_keep_temps = True
 899         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
 900             version_suffix = op[22:]
 901         else:
 902             print "Unknown option", op
 903             sys.exit(1)
 904     #
 905     # check if we run from the right directory
 906     srcdir = os.path.dirname(sys.argv[0])
 907     if srcdir == '':
 908         srcdir = '.'
 909     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
 910         logger.error("configure: error: cannot find chkconfig.ltx script")
 911         sys.exit(1)
 912     setEnviron()
 913     createDirectories()
 914     windows_style_tex_paths = checkTeXPaths()
 915     dtl_tools = checkDTLtools()
 916     ## Write the first part of outfile
 917     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
 918 # script. It contains default settings that have been determined by
 919 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
 920 # want to customize LyX, use LyX' Preferences dialog or modify directly
 921 # the "preferences" file instead. Any setting in that file will
 922 # override the values given here.
 923 ''')
 924     # check latex
 925     LATEX = checkLatex(dtl_tools)
 926     checkFormatEntries(dtl_tools)
 927     checkConverterEntries()
 928     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
 929     checkTeXAllowSpaces()
 930     if windows_style_tex_paths != '':
 931         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
 932     checkOtherEntries()
 933     # --without-latex-config can disable lyx_check_config
 934     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
 935     checkModulesConfig() #lyx_check_config and LATEX != '')
 936     removeTempFiles()
 937     # The return error code can be 256. Because most systems expect an error code
 938     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
 939     # a None for success, 'ret is not None' is used to exit.
 940     sys.exit(ret is not None)