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