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     checkViewerEditor('a SVG viewer and editor', ['inkscape'],
 460         rc_entry = [r'\Format svg        svg     SVG                    "" "%%" "%%"    "vector"'])
 461     #
 462     path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'],
 463         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 464 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 465 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 466 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 467 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 468 \Format png        png     PNG                    "" "%s"       "%s"    ""
 469 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 470 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 471 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 472 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 473     path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'],
 474         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 475 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 476 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 477 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 478 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 479 \Format png        png     PNG                    "" "%s"       "%s"    ""
 480 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 481 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 482 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 483 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 484     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 485 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 486 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 487 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 488 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 489 \Format png        png     PNG                    "" "%s"       "%s"    ""
 490 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 491 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 492 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 493 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 494         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 495     #
 496     checkViewerEditor('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 497         'nedit', 'gedit', 'notepad'],
 498         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 499 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 500 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 501 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 502 \Format docbook    sgml    DocBook                B  "" "%%"    "document"
 503 \Format docbook-xml xml   "Docbook (XML)"         "" "" "%%"    "document"
 504 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"
 505 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document"
 506 \Format literate   nw      NoWeb                  N  "" "%%"    "document"
 507 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document"
 508 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"
 509 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document"
 510 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document"
 511 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document"
 512 \Format text       txt    "Plain text"            a  "" "%%"    "document"
 513 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 514 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 515 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 516 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"''' ])
 517  #
 518     path, xhtmlview = checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 519         rc_entry = [r'\Format xhtml      xhtml   "LyXHTML"              X "%%" ""    "document"'])
 520     if xhtmlview == "":
 521         addToRC(r'\Format xhtml      xhtml   "LyXHTML"              X "" ""  "document"')
 522  #
 523     checkEditor('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
 524         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 525         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 526         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 527         'nedit', 'gedit', 'notepad'],
 528         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""''' ])
 529     #
 530     #checkProg('a Postscript interpreter', ['gs'],
 531     #  rc_entry = [ r'\ps_command "%%"' ])
 532     checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
 533         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"
 534 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector"'''])
 535     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 536     checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 537                     'gv', 'ghostview'],
 538         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector"
 539 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector"
 540 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector"
 541 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector"'''])
 542     #
 543     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
 544         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document,vector"'])
 545     if dtl_tools:
 546         # Windows only: DraftDVI
 547         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"')
 548     #
 549     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 550         rc_entry = [r'\Format html       html    HTML                   H  "%%" ""      "document"'])
 551     #
 552     checkViewerEditor('Noteedit', ['noteedit'],
 553         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"'])
 554     #
 555     checkViewerEditor('an OpenDocument/OpenOffice viewer', ['swriter', 'oowriter', 'abiword'],
 556         rc_entry = [r'''\Format odt        odt     OpenDocument           "" "%%"       "%%"    "document,vector"
 557 \Format sxw        sxw    "OpenOffice.Org (sxw)"  "" "" ""      "document,vector"'''])
 558     #
 559     checkViewerEditor('a Rich Text and Word viewer', ['swriter', 'oowriter', 'abiword'],
 560         rc_entry = [r'''\Format rtf        rtf    "Rich Text Format"      "" "" ""      "document,vector"
 561 \Format word       doc    "MS Word"               W  "" ""      "document,vector"'''])
 562     #
 563     # entried that do not need checkProg
 564     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 565 \Format csv        csv    "Table (CSV)"  "" ""  ""      "document"
 566 \Format fax        ""      Fax                    "" "" ""      "document"
 567 \Format lyx        lyx     LyX                    "" "" ""      ""
 568 \Format lyx13x     lyx13  "LyX 1.3.x"             "" "" ""      "document"
 569 \Format lyx14x     lyx14  "LyX 1.4.x"             "" "" ""      "document"
 570 \Format lyx15x     lyx15  "LyX 1.5.x"             "" "" ""      "document"
 571 \Format lyx16x     lyx16  "LyX 1.6.x"             "" "" ""      "document"
 572 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 573 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 574 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 575 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 576 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)"       "" ""  ""      ""
 577 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 578 \Format program    ""      Program                "" "" ""      ""
 579 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 580 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 581 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 582 \Format wordhtml   html   "HTML (MS Word)"        "" "" ""      "document"
 583 ''')
 584
 585
 586 def checkConverterEntries():
 587     ''' Check all converters (\converter entries) '''
 588     checkProg('the pdflatex program', ['pdflatex $$i'],
 589         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 590
 591     checkProg('XeTeX', ['xelatex $$i'],
 592         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex"' ])
 593
 594     ''' If we're running LyX in-place then tex2lyx will be found in
 595             ../src/tex2lyx. Add this directory to the PATH temporarily and
 596             search for tex2lyx.
 597             Use PATH to avoid any problems with paths-with-spaces.
 598     '''
 599     path_orig = os.environ["PATH"]
 600     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 601         os.pathsep + path_orig
 602
 603     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 604         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 605 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 606
 607     os.environ["PATH"] = path_orig
 608
 609     #
 610     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 611         rc_entry = [r'''\converter literate   latex      "%%"   ""
 612 \converter literate   pdflatex      "%%"        ""'''])
 613     #
 614     checkProg('a Sweave -> LaTeX converter', ['R CMD Sweave $$i'],
 615         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 616 \converter sweave   pdflatex      "%%"  ""'''])
 617     #
 618     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
 619         'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
 620         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 621     #
 622     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 623         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 624     # eLyXer: search as a Python module and then as an executable (elyxer.py, elyxer)
 625     elyxerfound = checkModule('elyxer')
 626     if elyxerfound:
 627       addToRC(r'''\converter lyx      html       "python -m elyxer --directory $$r $$i $$o"     ""''')
 628     else:
 629       path, elyxer = checkProg('a LyX -> HTML converter',
 630         ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
 631         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 632       if elyxer.find('elyxer') >= 0:
 633         elyxerfound = True
 634
 635     if elyxerfound:
 636       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 637     else:
 638       # search for other converters than eLyXer
 639       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 640       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 641           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 642           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 643           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 644       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 645         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 646       else:
 647         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 648
 649     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 650     path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 651         "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 652         "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 653         rc_entry = [ r'\converter latex      wordhtml   "%%"    "needaux"' ])
 654     if htmlconv.find('htlatex') >= 0:
 655       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 656     #
 657     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 658         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 659     #
 660     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 661         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 662     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 663     # the command mk4ht oolatex $$i has to be used as default,
 664     # but as this would require to have Perl installed, in MiKTeX oolatex is
 665     # directly available as application.
 666     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 667     # Both SuSE and debian have oolatex
 668     checkProg('a LaTeX -> Open Document converter', [
 669         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 670         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 671         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 672     # On windows it is called latex2rt.exe
 673     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 674         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 675     #
 676     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 677         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 678     #
 679     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 680         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 681     #
 682     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 683         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 684     #
 685     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 686         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 687     #
 688     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 689         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 690     #
 691     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 692         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 693     #
 694     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 695         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 696     #
 697     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 698         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 699     #
 700     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 701         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 702     #
 703     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 704         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 705     #
 706     path, dvipng = checkProg('dvipng', ['dvipng'])
 707     if dvipng == "dvipng":
 708         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 709     else:
 710         addToRC(r'\converter lyxpreview png        ""   ""')
 711     #
 712     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 713         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 714     #
 715     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 716         rc_entry = [
 717             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 718 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 719 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 720             ''])
 721     #
 722     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 723         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 724     #
 725     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 726         rc_entry = [
 727             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 728 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 729 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 730             ''])
 731     #
 732     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 733         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 734     #
 735     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 736         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 737     #
 738     checkProg('an EPS -> PDF converter', ['epstopdf'],
 739         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 740     #
 741     # no agr -> pdf converter, since the pdf library used by gracebat is not
 742     # free software and therefore not compiled in in many installations.
 743     # Fortunately, this is not a big problem, because we will use epstopdf to
 744     # convert from agr to pdf via eps without loss of quality.
 745     checkProg('a Grace -> Image converter', ['gracebat'],
 746         rc_entry = [
 747             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 748 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 749 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 750 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 751             ''])
 752     #
 753     checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
 754         rc_entry = [ r'\converter dot        pdf        "%%"    ""'])
 755     #
 756     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 757         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 758     #
 759     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 760         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 761     #
 762     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$p/$$i --export-area-drawing --without-gui --export-pdf=$$p/$$o'],
 763         rc_entry = [ r'\converter svg        pdf        "%%"    ""'])
 764     #
 765     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$p/$$i --export-area-drawing --without-gui --export-eps=$$p/$$o'],
 766         rc_entry = [ r'\converter svg        eps        "%%"    ""'])
 767     # the PNG export via Inkscape must not have the full path ($$p) for the file
 768     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
 769         rc_entry = [ r'\converter svg        png        "%%"    ""'])
 770
 771     #
 772     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 773     if (lilypond != ''):
 774         version_string = cmdOutput("lilypond --version")
 775         match = re.match('GNU LilyPond (\S+)', version_string)
 776         if match:
 777             version_number = match.groups()[0]
 778             version = version_number.split('.')
 779             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 780                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps --ps $$i"  ""
 781 \converter lilypond   png        "lilypond -dbackend=eps --png $$i"     ""''')
 782                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps --pdf $$i"   ""')
 783                 print '+  found LilyPond version %s.' % version_number
 784             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 785                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 786 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 787                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 788                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 789                 logger.info('+  found LilyPond version %s.' % version_number)
 790             else:
 791                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 792         else:
 793             logger.info('+  found LilyPond, but could not extract version number.')
 794     #
 795     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 796         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 797     #
 798     # FIXME: no rc_entry? comment it out
 799     # checkProg('Image converter', ['convert $$i $$o'])
 800     #
 801     # Entries that do not need checkProg
 802     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 803 \converter lyxpreview-platex ppm        "python -tt $$s/scripts/lyxpreview-platex2bitmap.py"    ""
 804 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 805 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 806 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 807 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 808 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 809 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 810 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 811 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 812 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 813 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 814 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 815 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 816 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 817 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 818 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 819 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 820 ''')
 821
 822
 823 def checkDocBook():
 824     ''' Check docbook '''
 825     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 826         rc_entry = [
 827             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 828 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 829             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 830 \converter docbook    html       "db2html $$i"  ""''',
 831             r'''\converter docbook    dvi        ""     ""
 832 \converter docbook    html       "" ""''',
 833             r'''\converter docbook    dvi        ""     ""
 834 \converter docbook    html       ""     ""'''])
 835     #
 836     if DOCBOOK != '':
 837         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 838     else:
 839         return ('no', 'false', '')
 840
 841
 842 def checkOtherEntries():
 843     ''' entries other than Format and Converter '''
 844     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 845         rc_entry = [ r'\chktex_command "%%"' ])
 846     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 847         rc_entry = [ r'\bibtex_command "%%"' ],
 848         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 849     checkProg('JBibTeX, the Japanese BibTeX', ['jbibtex', 'bibtex'],
 850         rc_entry = [ r'\jbibtex_command "%%"' ])
 851     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q'],
 852         rc_entry = [ r'\index_command "%%"' ],
 853         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 854     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 855         rc_entry = [ r'\jindex_command "%%"' ])
 856     path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
 857         rc_entry = [ r'\splitindex_command "%%"' ])
 858     if splitindex == '':
 859         checkProg('the splitindex processor (java version)', ['splitindex.class'],
 860             rc_entry = [ r'\splitindex_command "java splitindex"' ])
 861     checkProg('a nomenclature processor', ['makeindex'],
 862         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 863     ## FIXME: OCTAVE is not used anywhere
 864     # path, OCTAVE = checkProg('Octave', ['octave'])
 865     ## FIXME: MAPLE is not used anywhere
 866     # path, MAPLE = checkProg('Maple', ['maple'])
 867     checkProg('a spool command', ['lp', 'lpr'],
 868         rc_entry = [
 869             r'''\print_spool_printerprefix "-d "
 870 \print_spool_command "lp"''',
 871             r'''\print_spool_printerprefix "-P",
 872 \print_spool_command "lpr"''',
 873             ''])
 874     # Add the rest of the entries (no checkProg is required)
 875     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 876 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 877 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 878 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 879 ''')
 880
 881
 882 def processLayoutFile(file, bool_docbook):
 883     ''' process layout file and get a line of result
 884
 885         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 886
 887         \DeclareLaTeXClass{article}
 888         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 889         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 890
 891         we expect output:
 892
 893         "article" "article" "article" "false" "article.cls"
 894         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
 895         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
 896     '''
 897     def checkForClassExtension(x):
 898         '''if the extension for a latex class is not
 899            provided, add .cls to the classname'''
 900         if not '.' in x:
 901             return x.strip() + '.cls'
 902         else:
 903             return x.strip()
 904     classname = file.split(os.sep)[-1].split('.')[0]
 905     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 906     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 907     for line in open(file).readlines():
 908         res = p.search(line)
 909         if res != None:
 910             (classtype, optAll, opt, opt1, desc) = res.groups()
 911             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
 912             if opt == None:
 913                 opt = classname
 914                 prereq_latex = checkForClassExtension(classname)
 915             else:
 916                 prereq_list = optAll[1:-1].split(',')
 917                 prereq_list = map(checkForClassExtension, prereq_list)
 918                 prereq_latex = ','.join(prereq_list)
 919             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
 920             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
 921             return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
 922     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
 923     return ""
 924
 925
 926 def checkLatexConfig(check_config, bool_docbook):
 927     ''' Explore the LaTeX configuration
 928         Return None (will be passed to sys.exit()) for success.
 929     '''
 930     msg = 'checking LaTeX configuration... '
 931     # if --without-latex-config is forced, or if there is no previous
 932     # version of textclass.lst, re-generate a default file.
 933     if not os.path.isfile('textclass.lst') or not check_config:
 934         # remove the files only if we want to regenerate
 935         removeFiles(['textclass.lst', 'packages.lst'])
 936         #
 937         # Then, generate a default textclass.lst. In case configure.py
 938         # fails, we still have something to start lyx.
 939         logger.info(msg + ' default values')
 940         logger.info('+checking list of textclasses... ')
 941         tx = open('textclass.lst', 'w')
 942         tx.write('''
 943 # This file declares layouts and their associated definition files
 944 # (include dir. relative to the place where this file is).
 945 # It contains only default values, since chkconfig.ltx could not be run
 946 # for some reason. Run ./configure.py if you need to update it after a
 947 # configuration change.
 948 ''')
 949         # build the list of available layout files and convert it to commands
 950         # for chkconfig.ltx
 951         foundClasses = []
 952         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 953             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 954             # valid file?
 955             if not os.path.isfile(file):
 956                 continue
 957             # get stuff between /xxxx.layout .
 958             classname = file.split(os.sep)[-1].split('.')[0]
 959             #  tr ' -' '__'`
 960             cleanclass = classname.replace(' ', '_')
 961             cleanclass = cleanclass.replace('-', '_')
 962             # make sure the same class is not considered twice
 963             if foundClasses.count(cleanclass) == 0: # not found before
 964                 foundClasses.append(cleanclass)
 965                 retval = processLayoutFile(file, bool_docbook)
 966                 if retval != "":
 967                     tx.write(retval)
 968         tx.close()
 969         logger.info('\tdone')
 970     if not check_config:
 971         return None
 972     # the following will generate textclass.lst.tmp, and packages.lst.tmp
 973     logger.info(msg + '\tauto')
 974     removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 975         'chkconfig.classes', 'chklayouts.tex'])
 976     rmcopy = False
 977     if not os.path.isfile( 'chkconfig.ltx' ):
 978         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
 979         rmcopy = True
 980     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
 981     # Construct the list of classes to test for.
 982     # build the list of available layout files and convert it to commands
 983     # for chkconfig.ltx
 984     p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 985     testclasses = list()
 986     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 987         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 988         if not os.path.isfile(file):
 989             continue
 990         classname = file.split(os.sep)[-1].split('.')[0]
 991         for line in open(file).readlines():
 992             if p1.search(line) == None:
 993                 continue
 994             if line[0] != '#':
 995                 logger.error("Wrong input layout file with line '" + line)
 996                 sys.exit(3)
 997             testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 998             break
 999     testclasses.sort()
1000     cl = open('chklayouts.tex', 'w')
1001     for line in testclasses:
1002         cl.write(line + '\n')
1003     cl.close()
1004     #
1005     # we have chklayouts.tex, then process it
1006     fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
1007     while True:
1008         line = fout.readline()
1009         if not line:
1010             break;
1011         if re.match('^\+', line):
1012             logger.info(line.strip())
1013     # if the command succeeds, None will be returned
1014     ret = fout.close()
1015     #
1016     # currently, values in chhkconfig are only used to set
1017     # \font_encoding
1018     values = {}
1019     for line in open('chkconfig.vars').readlines():
1020         key, val = re.sub('-', '_', line).split('=')
1021         val = val.strip()
1022         values[key] = val.strip("'")
1023     # chk_fontenc may not exist
1024     try:
1025         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1026     except:
1027         pass
1028     if rmcopy:   # remove the copied file
1029         removeFiles( [ 'chkconfig.ltx' ] )
1030     # if configure successed, move textclass.lst.tmp to textclass.lst
1031     # and packages.lst.tmp to packages.lst
1032     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1033         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1034         shutil.move('textclass.lst.tmp', 'textclass.lst')
1035         shutil.move('packages.lst.tmp', 'packages.lst')
1036     return ret
1037
1038
1039 def checkModulesConfig():
1040   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1041
1042   logger.info('+checking list of modules... ')
1043   tx = open('lyxmodules.lst', 'w')
1044   tx.write('''## This file declares modules and their associated definition files.
1045 ## It has been automatically generated by configure
1046 ## Use "Options/Reconfigure" if you need to update it after a
1047 ## configuration change.
1048 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1049 ''')
1050   # build the list of available modules
1051   foundClasses = []
1052   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1053       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1054       # valid file?
1055       logger.info(file)
1056       if not os.path.isfile(file):
1057           continue
1058       retval = processModuleFile(file, bool_docbook)
1059       if retval != "":
1060           tx.write(retval)
1061   tx.close()
1062   logger.info('\tdone')
1063
1064
1065 def processModuleFile(file, bool_docbook):
1066     ''' process module file and get a line of result
1067
1068         The top of a module file should look like this:
1069           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1070           #DescriptionBegin
1071           #...body of description...
1072           #DescriptionEnd
1073           #Requires: [list of required modules]
1074           #Excludes: [list of excluded modules]
1075           #Category: [category name]
1076         The last three lines are optional (though do give a category).
1077         We expect output:
1078           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1079     '''
1080     p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1081     r = re.compile(r'#+\s*Requires: (.*)')
1082     x = re.compile(r'#+\s*Excludes: (.*)')
1083     c = re.compile(r'#+\s*Category: (.*)')
1084     b = re.compile(r'#+\s*DescriptionBegin\s*$')
1085     e = re.compile(r'#+\s*DescriptionEnd\s*$')
1086
1087     modname = desc = pkgs = req = excl = catgy = ""
1088     readingDescription = False
1089     descLines = []
1090     filename = file.split(os.sep)[-1]
1091     filename = filename[:-7]
1092
1093     for line in open(file).readlines():
1094       if readingDescription:
1095         res = e.search(line)
1096         if res != None:
1097           readingDescription = False
1098           desc = " ".join(descLines)
1099           continue
1100         descLines.append(line[1:].strip())
1101         continue
1102       res = b.search(line)
1103       if res != None:
1104         readingDescription = True
1105         continue
1106       res = p.search(line)
1107       if res != None:
1108           (pkgs, modname) = res.groups()
1109           if pkgs == None:
1110             pkgs = ""
1111           else:
1112             tmp = [s.strip() for s in pkgs.split(",")]
1113             pkgs = ",".join(tmp)
1114           continue
1115       res = r.search(line)
1116       if res != None:
1117         req = res.group(1)
1118         tmp = [s.strip() for s in req.split("|")]
1119         req = "|".join(tmp)
1120         continue
1121       res = x.search(line)
1122       if res != None:
1123         excl = res.group(1)
1124         tmp = [s.strip() for s in excl.split("|")]
1125         excl = "|".join(tmp)
1126         continue
1127       res = c.search(line)
1128       if res != None:
1129         catgy = res.group(1)
1130         continue
1131     if modname != "":
1132         if pkgs != "":
1133             # this module has some latex dependencies:
1134             # append the dependencies to chkmodules.tex,
1135             # which is \input'ed by chkconfig.ltx
1136             testpackages = list()
1137             for pkg in pkgs.split(","):
1138                 if "->" in pkg:
1139                     # this is a converter dependency: skip
1140                     continue
1141                 if pkg.endswith(".sty"):
1142                     pkg = pkg[:-4]
1143                 testpackages.append("\\TestPackage{%s}" % (pkg,))
1144             cm = open('chkmodules.tex', 'a')
1145             for line in testpackages:
1146                 cm.write(line + '\n')
1147             cm.close()
1148         return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1149     logger.warning("Module file without \DeclareLyXModule line. ")
1150     return ""
1151
1152
1153 def checkTeXAllowSpaces():
1154     ''' Let's check whether spaces are allowed in TeX file names '''
1155     tex_allows_spaces = 'false'
1156     if lyx_check_config:
1157         msg = "Checking whether TeX allows spaces in file names... "
1158         writeToFile('a b.tex', r'\message{working^^J}' )
1159         if os.name == 'nt':
1160             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1161         else:
1162             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1163         if 'working' in latex_out:
1164             logger.info(msg + 'yes')
1165             tex_allows_spaces = 'true'
1166         else:
1167             logger.info(msg + 'no')
1168             tex_allows_spaces = 'false'
1169         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1170         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1171
1172
1173 def removeTempFiles():
1174     # Final clean-up
1175     if not lyx_keep_temps:
1176         removeFiles(['chkconfig.vars',  \
1177             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
1178             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1179             'chklatex.ltx', 'chklatex.log'])
1180
1181
1182 if __name__ == '__main__':
1183     lyx_check_config = True
1184     outfile = 'lyxrc.defaults'
1185     rc_entries = ''
1186     lyx_keep_temps = False
1187     version_suffix = ''
1188     ## Parse the command line
1189     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1190         if op in [ '-help', '--help', '-h' ]:
1191             print '''Usage: configure [options]
1192 Options:
1193     --help                   show this help lines
1194     --keep-temps             keep temporary files (for debug. purposes)
1195     --without-latex-config   do not run LaTeX to determine configuration
1196     --with-version-suffix=suffix suffix of binary installed files
1197 '''
1198             sys.exit(0)
1199         elif op == '--without-latex-config':
1200             lyx_check_config = False
1201         elif op == '--keep-temps':
1202             lyx_keep_temps = True
1203         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1204             version_suffix = op[22:]
1205         else:
1206             print "Unknown option", op
1207             sys.exit(1)
1208     #
1209     # check if we run from the right directory
1210     srcdir = os.path.dirname(sys.argv[0])
1211     if srcdir == '':
1212         srcdir = '.'
1213     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1214         logger.error("configure: error: cannot find chkconfig.ltx script")
1215         sys.exit(1)
1216     setEnviron()
1217     createDirectories()
1218     windows_style_tex_paths = checkTeXPaths()
1219     dtl_tools = checkDTLtools()
1220     ## Write the first part of outfile
1221     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1222 # script. It contains default settings that have been determined by
1223 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1224 # want to customize LyX, use LyX' Preferences dialog or modify directly
1225 # the "preferences" file instead. Any setting in that file will
1226 # override the values given here.
1227 ''')
1228     # check latex
1229     LATEX = checkLatex(dtl_tools)
1230     checkFormatEntries(dtl_tools)
1231     checkConverterEntries()
1232     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1233     checkTeXAllowSpaces()
1234     if windows_style_tex_paths != '':
1235         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1236     checkOtherEntries()
1237     checkModulesConfig()
1238     # --without-latex-config can disable lyx_check_config
1239     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1240     removeTempFiles()
1241     # The return error code can be 256. Because most systems expect an error code
1242     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1243     # a None for success, 'ret is not None' is used to exit.
1244     sys.exit(ret is not None)