lib/configure.py

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