lib/configure.py

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