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