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