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