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
 625     # eLyXer: search as a Python module and then as an executable (elyxer.py, elyxer)
 626     elyxerfound = checkModule('elyxer')
 627     if elyxerfound:
 628       addToRC(r'''\converter lyx      html       "python -m elyxer --directory $$r $$i $$o"     ""''')
 629     else:
 630       path, elyxer = checkProg('a LyX -> HTML converter',
 631         ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
 632         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 633       if elyxer.find('elyxer') >= 0:
 634         elyxerfound = True
 635
 636     if elyxerfound:
 637       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 638     else:
 639       # search for other converters than eLyXer
 640       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 641       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 642           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 643           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 644           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 645       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 646         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 647       else:
 648         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 649
 650     # Check if LyxBlogger is installed.
 651     path, lyxblogger = checkProg('A LyX to WordPress Blog Publishing Tool',
 652       ['lyxblogger $$i'], rc_entry = [])
 653     if lyxblogger.find('lyxblogger') >= 0:
 654       addToRC(r'\Format    blog       blog       "LyxBlogger"           "" "" ""  "document"')
 655       addToRC(r'\converter xhtml      blog       "lyxblogger $$i"       ""')
 656
 657     if elyxerfound:
 658       addToRC(r'''\converter lyx      wordhtml       "python -m elyxer --html --directory $$r $$i $$o"  ""''')
 659     else:
 660       path, elyxer = checkProg('a LyX -> MS Word converter',
 661         ['elyxer.py --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
 662         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 663       if elyxer.find('elyxer') >= 0:
 664         elyxerfound = True
 665
 666     if elyxerfound:
 667       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 668     else:
 669       # search for other converters than eLyXer
 670       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 671       path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 672           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 673           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 674           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 675       if htmlconv.find('htlatex') >= 0:
 676         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 677       else:
 678         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 679
 680     #
 681     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 682         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 683     #
 684     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 685         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 686     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 687     # the command mk4ht oolatex $$i has to be used as default,
 688     # but as this would require to have Perl installed, in MiKTeX oolatex is
 689     # directly available as application.
 690     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 691     # Both SuSE and debian have oolatex
 692     checkProg('a LaTeX -> Open Document converter', [
 693         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 694         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 695         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 696     # On windows it is called latex2rt.exe
 697     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 698         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 699     #
 700     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 701         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 702     #
 703     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 704         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 705     #
 706     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 707         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 708     #
 709     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 710         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 711     #
 712     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 713         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 714     #
 715     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 716         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 717     #
 718     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 719         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 720     #
 721     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 722         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 723     #
 724     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 725         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 726     #
 727     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 728         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 729     #
 730     path, dvipng = checkProg('dvipng', ['dvipng'])
 731     if dvipng == "dvipng":
 732         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 733     else:
 734         addToRC(r'\converter lyxpreview png        ""   ""')
 735     #
 736     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 737         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 738     #
 739     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 740         rc_entry = [
 741             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 742 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 743 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 744             ''])
 745     #
 746     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 747         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 748     #
 749     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 750         rc_entry = [
 751             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 752 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 753 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 754             ''])
 755     #
 756     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 757         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 758     #
 759     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 760         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 761     #
 762     checkProg('an EPS -> PDF converter', ['epstopdf'],
 763         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 764     #
 765     # no agr -> pdf converter, since the pdf library used by gracebat is not
 766     # free software and therefore not compiled in in many installations.
 767     # Fortunately, this is not a big problem, because we will use epstopdf to
 768     # convert from agr to pdf via eps without loss of quality.
 769     checkProg('a Grace -> Image converter', ['gracebat'],
 770         rc_entry = [
 771             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 772 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 773 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 774 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 775             ''])
 776     #
 777     checkProg('a Dot -> Image converter', ['dot'],
 778         rc_entry = [
 779             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
 780 \converter dot        pdf        "dot -Tpdf $$i -o $$o" ""
 781 \converter dot        png        "dot -Tpng $$i -o $$o" ""''',
 782             ''])
 783     #
 784     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 785         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 786     #
 787     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 788         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 789     #
 790     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'],
 791         rc_entry = [ r'\converter svg        pdf        "%%"    ""'])
 792     #
 793     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'],
 794         rc_entry = [ r'\converter svg        eps        "%%"    ""'])
 795     # the PNG export via Inkscape must not have the full path ($$p) for the file
 796     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
 797         rc_entry = [ r'\converter svg        png        "%%"    ""'])
 798
 799     #
 800     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 801     if (lilypond != ''):
 802         version_string = cmdOutput("lilypond --version")
 803         match = re.match('GNU LilyPond (\S+)', version_string)
 804         if match:
 805             version_number = match.groups()[0]
 806             version = version_number.split('.')
 807             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 808                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps --ps $$i"  ""
 809 \converter lilypond   png        "lilypond -dbackend=eps --png $$i"     ""''')
 810                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps --pdf $$i"   ""')
 811                 print '+  found LilyPond version %s.' % version_number
 812             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 813                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 814 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 815                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 816                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 817                 logger.info('+  found LilyPond version %s.' % version_number)
 818             else:
 819                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 820         else:
 821             logger.info('+  found LilyPond, but could not extract version number.')
 822     #
 823     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 824         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 825     #
 826     # FIXME: no rc_entry? comment it out
 827     # checkProg('Image converter', ['convert $$i $$o'])
 828     #
 829     # Entries that do not need checkProg
 830     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 831 \converter lyxpreview-platex ppm        "python -tt $$s/scripts/lyxpreview-platex2bitmap.py"    ""
 832 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 833 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 834 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 835 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 836 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 837 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 838 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 839 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 840 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 841 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 842 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 843 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 844 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 845 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 846 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 847 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 848 ''')
 849
 850
 851 def checkDocBook():
 852     ''' Check docbook '''
 853     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 854         rc_entry = [
 855             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 856 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 857             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 858 \converter docbook    html       "db2html $$i"  ""''',
 859             r'''\converter docbook    dvi        ""     ""
 860 \converter docbook    html       "" ""''',
 861             r'''\converter docbook    dvi        ""     ""
 862 \converter docbook    html       ""     ""'''])
 863     #
 864     if DOCBOOK != '':
 865         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 866     else:
 867         return ('no', 'false', '')
 868
 869
 870 def checkOtherEntries():
 871     ''' entries other than Format and Converter '''
 872     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 873         rc_entry = [ r'\chktex_command "%%"' ])
 874     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 875         rc_entry = [ r'\bibtex_command "%%"' ],
 876         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 877     checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
 878         rc_entry = [ r'\jbibtex_command "%%"' ])
 879     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q'],
 880         rc_entry = [ r'\index_command "%%"' ],
 881         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 882     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 883         rc_entry = [ r'\jindex_command "%%"' ])
 884     path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
 885         rc_entry = [ r'\splitindex_command "%%"' ])
 886     if splitindex == '':
 887         checkProg('the splitindex processor (java version)', ['splitindex.class'],
 888             rc_entry = [ r'\splitindex_command "java splitindex"' ])
 889     checkProg('a nomenclature processor', ['makeindex'],
 890         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 891     ## FIXME: OCTAVE is not used anywhere
 892     # path, OCTAVE = checkProg('Octave', ['octave'])
 893     ## FIXME: MAPLE is not used anywhere
 894     # path, MAPLE = checkProg('Maple', ['maple'])
 895     checkProg('a spool command', ['lp', 'lpr'],
 896         rc_entry = [
 897             r'''\print_spool_printerprefix "-d "
 898 \print_spool_command "lp"''',
 899             r'''\print_spool_printerprefix "-P",
 900 \print_spool_command "lpr"''',
 901             ''])
 902     # Add the rest of the entries (no checkProg is required)
 903     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 904 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 905 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 906 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 907 ''')
 908
 909
 910 def processLayoutFile(file, bool_docbook):
 911     ''' process layout file and get a line of result
 912
 913         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 914
 915         \DeclareLaTeXClass{article}
 916         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 917         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 918
 919         we expect output:
 920
 921         "article" "article" "article" "false" "article.cls"
 922         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
 923         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
 924     '''
 925     def checkForClassExtension(x):
 926         '''if the extension for a latex class is not
 927            provided, add .cls to the classname'''
 928         if not '.' in x:
 929             return x.strip() + '.cls'
 930         else:
 931             return x.strip()
 932     classname = file.split(os.sep)[-1].split('.')[0]
 933     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 934     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 935     for line in open(file).readlines():
 936         res = p.search(line)
 937         if res != None:
 938             (classtype, optAll, opt, opt1, desc) = res.groups()
 939             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
 940             if opt == None:
 941                 opt = classname
 942                 prereq_latex = checkForClassExtension(classname)
 943             else:
 944                 prereq_list = optAll[1:-1].split(',')
 945                 prereq_list = map(checkForClassExtension, prereq_list)
 946                 prereq_latex = ','.join(prereq_list)
 947             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
 948             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
 949             return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
 950     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
 951     return ""
 952
 953
 954 def checkLatexConfig(check_config, bool_docbook):
 955     ''' Explore the LaTeX configuration
 956         Return None (will be passed to sys.exit()) for success.
 957     '''
 958     msg = 'checking LaTeX configuration... '
 959     # if --without-latex-config is forced, or if there is no previous
 960     # version of textclass.lst, re-generate a default file.
 961     if not os.path.isfile('textclass.lst') or not check_config:
 962         # remove the files only if we want to regenerate
 963         removeFiles(['textclass.lst', 'packages.lst'])
 964         #
 965         # Then, generate a default textclass.lst. In case configure.py
 966         # fails, we still have something to start lyx.
 967         logger.info(msg + ' default values')
 968         logger.info('+checking list of textclasses... ')
 969         tx = open('textclass.lst', 'w')
 970         tx.write('''
 971 # This file declares layouts and their associated definition files
 972 # (include dir. relative to the place where this file is).
 973 # It contains only default values, since chkconfig.ltx could not be run
 974 # for some reason. Run ./configure.py if you need to update it after a
 975 # configuration change.
 976 ''')
 977         # build the list of available layout files and convert it to commands
 978         # for chkconfig.ltx
 979         foundClasses = []
 980         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 981             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 982             # valid file?
 983             if not os.path.isfile(file):
 984                 continue
 985             # get stuff between /xxxx.layout .
 986             classname = file.split(os.sep)[-1].split('.')[0]
 987             #  tr ' -' '__'`
 988             cleanclass = classname.replace(' ', '_')
 989             cleanclass = cleanclass.replace('-', '_')
 990             # make sure the same class is not considered twice
 991             if foundClasses.count(cleanclass) == 0: # not found before
 992                 foundClasses.append(cleanclass)
 993                 retval = processLayoutFile(file, bool_docbook)
 994                 if retval != "":
 995                     tx.write(retval)
 996         tx.close()
 997         logger.info('\tdone')
 998     if not check_config:
 999         return None
1000     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1001     logger.info(msg + '\tauto')
1002     removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
1003         'chkconfig.classes', 'chklayouts.tex'])
1004     rmcopy = False
1005     if not os.path.isfile( 'chkconfig.ltx' ):
1006         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1007         rmcopy = True
1008     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1009     # Construct the list of classes to test for.
1010     # build the list of available layout files and convert it to commands
1011     # for chkconfig.ltx
1012     declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1013     empty = re.compile(r'^\s*$')
1014     testclasses = list()
1015     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1016         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1017         if not os.path.isfile(file):
1018             continue
1019         classname = file.split(os.sep)[-1].split('.')[0]
1020         for line in open(file).readlines():
1021             if not empty.match(line) and line[0] != '#':
1022                 logger.error("Failed to find \Declare line for layout file `" + file + "'")
1023                 sys.exit(3)
1024             if declare.search(line) == None:
1025                 continue
1026             testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1027             break
1028     testclasses.sort()
1029     cl = open('chklayouts.tex', 'w')
1030     for line in testclasses:
1031         cl.write(line + '\n')
1032     cl.close()
1033     #
1034     # we have chklayouts.tex, then process it
1035     fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
1036     while True:
1037         line = fout.readline()
1038         if not line:
1039             break;
1040         if re.match('^\+', line):
1041             logger.info(line.strip())
1042     # if the command succeeds, None will be returned
1043     ret = fout.close()
1044     #
1045     # currently, values in chhkconfig are only used to set
1046     # \font_encoding
1047     values = {}
1048     for line in open('chkconfig.vars').readlines():
1049         key, val = re.sub('-', '_', line).split('=')
1050         val = val.strip()
1051         values[key] = val.strip("'")
1052     # chk_fontenc may not exist
1053     try:
1054         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1055     except:
1056         pass
1057     if rmcopy:   # remove the copied file
1058         removeFiles( [ 'chkconfig.ltx' ] )
1059     # if configure successed, move textclass.lst.tmp to textclass.lst
1060     # and packages.lst.tmp to packages.lst
1061     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1062         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1063         shutil.move('textclass.lst.tmp', 'textclass.lst')
1064         shutil.move('packages.lst.tmp', 'packages.lst')
1065     return ret
1066
1067
1068 def checkModulesConfig():
1069   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1070
1071   logger.info('+checking list of modules... ')
1072   tx = open('lyxmodules.lst', 'w')
1073   tx.write('''## This file declares modules and their associated definition files.
1074 ## It has been automatically generated by configure
1075 ## Use "Options/Reconfigure" if you need to update it after a
1076 ## configuration change.
1077 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1078 ''')
1079   # build the list of available modules
1080   foundClasses = []
1081   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1082       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1083       # valid file?
1084       logger.info(file)
1085       if not os.path.isfile(file):
1086           continue
1087       retval = processModuleFile(file, bool_docbook)
1088       if retval != "":
1089           tx.write(retval)
1090   tx.close()
1091   logger.info('\tdone')
1092
1093
1094 def processModuleFile(file, bool_docbook):
1095     ''' process module file and get a line of result
1096
1097         The top of a module file should look like this:
1098           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1099           #DescriptionBegin
1100           #...body of description...
1101           #DescriptionEnd
1102           #Requires: [list of required modules]
1103           #Excludes: [list of excluded modules]
1104           #Category: [category name]
1105         The last three lines are optional (though do give a category).
1106         We expect output:
1107           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1108     '''
1109     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1110     rereqs = re.compile(r'#+\s*Requires: (.*)')
1111     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1112     recaty = re.compile(r'#+\s*Category: (.*)')
1113     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1114     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1115
1116     modname = desc = pkgs = req = excl = catgy = ""
1117     readingDescription = False
1118     descLines = []
1119     filename = file.split(os.sep)[-1]
1120     filename = filename[:-7]
1121
1122     for line in open(file).readlines():
1123       if readingDescription:
1124         res = redend.search(line)
1125         if res != None:
1126           readingDescription = False
1127           desc = " ".join(descLines)
1128           # Escape quotes.
1129           desc = desc.replace('"', '\\"')
1130           continue
1131         descLines.append(line[1:].strip())
1132         continue
1133       res = redbeg.search(line)
1134       if res != None:
1135         readingDescription = True
1136         continue
1137       res = remods.search(line)
1138       if res != None:
1139           (pkgs, modname) = res.groups()
1140           if pkgs == None:
1141             pkgs = ""
1142           else:
1143             tmp = [s.strip() for s in pkgs.split(",")]
1144             pkgs = ",".join(tmp)
1145           continue
1146       res = rereqs.search(line)
1147       if res != None:
1148         req = res.group(1)
1149         tmp = [s.strip() for s in req.split("|")]
1150         req = "|".join(tmp)
1151         continue
1152       res = reexcs.search(line)
1153       if res != None:
1154         excl = res.group(1)
1155         tmp = [s.strip() for s in excl.split("|")]
1156         excl = "|".join(tmp)
1157         continue
1158       res = recaty.search(line)
1159       if res != None:
1160         catgy = res.group(1)
1161         continue
1162
1163     if modname == "":
1164       logger.warning("Module file without \DeclareLyXModule line. ")
1165       return ""
1166
1167     if pkgs != "":
1168         # this module has some latex dependencies:
1169         # append the dependencies to chkmodules.tex,
1170         # which is \input'ed by chkconfig.ltx
1171         testpackages = list()
1172         for pkg in pkgs.split(","):
1173             if "->" in pkg:
1174                 # this is a converter dependency: skip
1175                 continue
1176             if pkg.endswith(".sty"):
1177                 pkg = pkg[:-4]
1178             testpackages.append("\\TestPackage{%s}" % (pkg,))
1179         cm = open('chkmodules.tex', 'a')
1180         for line in testpackages:
1181             cm.write(line + '\n')
1182         cm.close()
1183
1184     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1185
1186
1187
1188 def checkTeXAllowSpaces():
1189     ''' Let's check whether spaces are allowed in TeX file names '''
1190     tex_allows_spaces = 'false'
1191     if lyx_check_config:
1192         msg = "Checking whether TeX allows spaces in file names... "
1193         writeToFile('a b.tex', r'\message{working^^J}' )
1194         if os.name == 'nt':
1195             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1196         else:
1197             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1198         if 'working' in latex_out:
1199             logger.info(msg + 'yes')
1200             tex_allows_spaces = 'true'
1201         else:
1202             logger.info(msg + 'no')
1203             tex_allows_spaces = 'false'
1204         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1205         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1206
1207
1208 def removeTempFiles():
1209     # Final clean-up
1210     if not lyx_keep_temps:
1211         removeFiles(['chkconfig.vars',  \
1212             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
1213             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1214             'chklatex.ltx', 'chklatex.log'])
1215
1216
1217 if __name__ == '__main__':
1218     lyx_check_config = True
1219     outfile = 'lyxrc.defaults'
1220     rc_entries = ''
1221     lyx_keep_temps = False
1222     version_suffix = ''
1223     ## Parse the command line
1224     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1225         if op in [ '-help', '--help', '-h' ]:
1226             print '''Usage: configure [options]
1227 Options:
1228     --help                   show this help lines
1229     --keep-temps             keep temporary files (for debug. purposes)
1230     --without-latex-config   do not run LaTeX to determine configuration
1231     --with-version-suffix=suffix suffix of binary installed files
1232 '''
1233             sys.exit(0)
1234         elif op == '--without-latex-config':
1235             lyx_check_config = False
1236         elif op == '--keep-temps':
1237             lyx_keep_temps = True
1238         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1239             version_suffix = op[22:]
1240         else:
1241             print "Unknown option", op
1242             sys.exit(1)
1243     #
1244     # check if we run from the right directory
1245     srcdir = os.path.dirname(sys.argv[0])
1246     if srcdir == '':
1247         srcdir = '.'
1248     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1249         logger.error("configure: error: cannot find chkconfig.ltx script")
1250         sys.exit(1)
1251     setEnviron()
1252     createDirectories()
1253     windows_style_tex_paths = checkTeXPaths()
1254     dtl_tools = checkDTLtools()
1255     ## Write the first part of outfile
1256     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1257 # script. It contains default settings that have been determined by
1258 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1259 # want to customize LyX, use LyX' Preferences dialog or modify directly
1260 # the "preferences" file instead. Any setting in that file will
1261 # override the values given here.
1262 ''')
1263     # check latex
1264     LATEX = checkLatex(dtl_tools)
1265     checkFormatEntries(dtl_tools)
1266     checkConverterEntries()
1267     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1268     checkTeXAllowSpaces()
1269     if windows_style_tex_paths != '':
1270         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1271     checkOtherEntries()
1272     checkModulesConfig()
1273     # --without-latex-config can disable lyx_check_config
1274     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1275     removeTempFiles()
1276     # The return error code can be 256. Because most systems expect an error code
1277     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1278     # a None for success, 'ret is not None' is used to exit.
1279     sys.exit(ret is not None)