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