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