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', '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     path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'],
 504         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 505 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 506 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""
 507 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 508 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 509 \Format png        png     PNG                    "" "%s"       "%s"    ""
 510 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 511 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 512 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 513 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 514     path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'],
 515         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 516 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 517 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""
 518 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 519 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 520 \Format png        png     PNG                    "" "%s"       "%s"    ""
 521 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 522 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 523 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 524 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 525     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 526 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 527 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""
 528 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 529 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 530 \Format png        png     PNG                    "" "%s"       "%s"    ""
 531 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 532 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 533 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 534 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 535         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 536     #
 537     checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 538         'nedit', 'gedit', 'notepad'],
 539         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 540 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 541 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 542 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 543 \Format docbook    sgml    DocBook                B  "" "%%"    "document,menu=export"
 544 \Format docbook-xml xml   "DocBook (XML)"         "" "" "%%"    "document,menu=export"
 545 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"
 546 \Format dviluatex  tex    "LaTeX (dviluatex)"     "" "" "%%"  "document,menu=export"
 547 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document,menu=export"
 548 \Format literate   nw      NoWeb                  N  "" "%%"    "document,menu=export"
 549 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document,menu=export"
 550 \Format r          R      "R/S code"              "" "" "%%"    "document,menu=export"
 551 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"
 552 \Format lilypond-book    lytex "LilyPond book (LaTeX)"   "" ""  "%%"    "document,menu=export"
 553 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document,menu=export"
 554 \Format luatex     tex    "LaTeX (LuaTeX)"        "" "" "%%"    "document,menu=export"
 555 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document,menu=export"
 556 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document,menu=export"
 557 \Format text       txt    "Plain text"            a  "" "%%"    "document,menu=export"
 558 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 559 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 560 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 561 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"''' ])
 562    #Spreadsheets using ssconvert from gnumeric
 563     checkViewer('gnumeric spreadsheet software', ['gnumeric'],
 564       rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" ""    "%%"   "document"
 565 \Format excel      xls    "Excel spreadsheet"      "" "" "%%"    "document"
 566 \Format oocalc     ods    "OpenOffice spreadsheet" "" "" "%%"    "document"'''])
 567  #
 568     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 569         rc_entry = [r'\Format xhtml      xhtml   "LyXHTML"              y "%%" ""    "document,menu=export"'])
 570  #
 571     checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
 572         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 573         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 574         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 575         'nedit', 'gedit', 'notepad'],
 576         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""''' ])
 577     #
 578     #checkProg('a Postscript interpreter', ['gs'],
 579     #  rc_entry = [ r'\ps_command "%%"' ])
 580     checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
 581         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"
 582 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector,menu=export"'''])
 583     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 584     checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 585                     'gv', 'ghostview'],
 586         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector,menu=export"
 587 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector,menu=export"
 588 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector,menu=export"
 589 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector,menu=export"
 590 \Format pdf5       pdf    "PDF (LuaTeX)"          u  "%%"       ""      "document,vector,menu=export"'''])
 591     #
 592     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
 593         rc_entry = [r'''\Format dvi        dvi     DVI                    D  "%%"       ""      "document,vector,menu=export"
 594 \Format dvi3       dvi     "DVI (LuaTeX)"          V  "%%"      ""      "document,vector,menu=export"'''])
 595     if dtl_tools:
 596         # Windows only: DraftDVI
 597         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"')
 598     #
 599     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 600         rc_entry = [r'\Format html      "html, htm" HTML                H  "%%" ""      "document,menu=export"'])
 601     #
 602     checkViewerEditor('Noteedit', ['noteedit'],
 603         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"'])
 604     #
 605     checkViewerEditor('an OpenDocument/OpenOffice viewer', ['swriter', 'oowriter', 'abiword'],
 606         rc_entry = [r'''\Format odt        odt     OpenDocument           "" "%%"       "%%"    "document,vector,menu=export"
 607 \Format sxw        sxw    "OpenOffice.Org (sxw)"  "" "" ""      "document,vector"'''])
 608     #
 609     checkViewerEditor('a Rich Text and Word viewer', ['swriter', 'oowriter', 'abiword'],
 610         rc_entry = [r'''\Format rtf        rtf    "Rich Text Format"      "" "%%"       "%%"    "document,vector,menu=export"
 611 \Format word       doc    "MS Word"               W  "%%"       "%%"    "document,vector,menu=export"'''])
 612     #
 613     # entries that do not need checkProg
 614     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 615 \Format csv        csv    "Table (CSV)"  "" ""  ""      "document"
 616 \Format fax        ""      Fax                    "" "" ""      "document"
 617 \Format lyx        lyx     LyX                    "" "" ""      ""
 618 \Format lyx13x     13.lyx  "LyX 1.3.x"             "" ""        ""      "document"
 619 \Format lyx14x     14.lyx  "LyX 1.4.x"             "" ""        ""      "document"
 620 \Format lyx15x     15.lyx  "LyX 1.5.x"             "" ""        ""      "document"
 621 \Format lyx16x     16.lyx  "LyX 1.6.x"             "" ""        ""      "document,menu=export"
 622 \Format lyx20x     20.lyx  "LyX 2.0.x"             "" ""        ""      "document,menu=export"
 623 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 624 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 625 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 626 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 627 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 628 \Format program    ""      Program                "" "" ""      ""
 629 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 630 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 631 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 632 \Format wordhtml  "html, htm" "HTML (MS Word)"    "" "" ""      "document"
 633 ''')
 634
 635
 636 def checkConverterEntries():
 637     ''' Check all converters (\converter entries) '''
 638     checkProg('the pdflatex program', ['pdflatex $$i'],
 639         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex=pdflatex"' ])
 640
 641     checkProg('XeTeX', ['xelatex $$i'],
 642         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex=xelatex"' ])
 643
 644     checkLuatex()
 645
 646     # Look for tex2lyx in this order (see bugs #3308 and #6986):
 647     #   1)  If we're running LyX in-place then tex2lyx will be found
 648     #       in ../src/tex2lyx with respect to the srcdir.
 649     #   2)  If LyX was configured with a version suffix then tex2lyx
 650     #       will also have this version suffix.
 651     #   3)  Otherwise always use tex2lyx.
 652     in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
 653     in_place = os.path.abspath(in_place)
 654
 655     path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_place, 'tex2lyx' + version_suffix, 'tex2lyx'],
 656         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 657 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''], not_found = 'tex2lyx')
 658     if path == '':
 659         logger.warning("Failed to find tex2lyx on your system.")
 660
 661     #
 662     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 663         rc_entry = [r'''\converter literate   latex      "%%"   ""
 664 \converter literate   pdflatex      "%%"        ""'''])
 665     #
 666     checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
 667         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 668 \converter sweave   pdflatex   "%%"     ""
 669 \converter sweave   xetex      "%%"     ""
 670 \converter sweave   luatex     "%%"     ""'''])
 671     #
 672     checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
 673         rc_entry = [ r'\converter sweave      r      "%%"    ""' ])
 674     #
 675     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i',
 676         'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
 677         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 678     #
 679     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 680         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 681
 682     # eLyXer: search as an executable (elyxer.py, elyxer)
 683     path, elyxer = checkProg('a LyX -> HTML converter',
 684         ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
 685         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 686     path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
 687         ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
 688         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 689     if elyxer.find('elyxer') >= 0:
 690       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 691       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 692     else:
 693       # search for HTML converters other than eLyXer
 694       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 695       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 696           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 697           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 698           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 699       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 700         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 701       else:
 702         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 703       path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 704           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 705           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 706           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 707       if htmlconv.find('htlatex') >= 0:
 708         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 709       else:
 710         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 711
 712
 713     # Check if LyXBlogger is installed
 714     lyxblogger_found = checkModule('lyxblogger')
 715     if lyxblogger_found:
 716       addToRC(r'\Format    blog       blog       "LyXBlogger"           "" "" ""  "document"')
 717       addToRC(r'\converter xhtml      blog       "python -m lyxblogger $$i"       ""')
 718
 719     #
 720     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 721         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 722     #
 723     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 724         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 725     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 726     # the command mk4ht oolatex $$i has to be used as default,
 727     # but as this would require to have Perl installed, in MiKTeX oolatex is
 728     # directly available as application.
 729     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 730     # Both SuSE and debian have oolatex
 731     checkProg('a LaTeX -> Open Document converter', [
 732         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 733         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 734         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 735     # On windows it is called latex2rt.exe
 736     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 737         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 738     #
 739     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 740         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 741     #
 742     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 743         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 744     #
 745     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 746         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 747     #
 748     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 749         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 750     #
 751     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 752         rc_entry = [ r'''\Format eps2       eps    "EPS (ps2eps)"          "" "" ""     "vector"
 753 \converter ps         eps      "%%"     ""
 754 \converter eps2       eps      "%%"     "resultfile=$$b.eps.eps"''' ])
 755     #
 756     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 757         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 758     #
 759     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 760         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 761     #
 762     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 763         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 764     #
 765     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 766         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 767     #
 768     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 769         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 770     #
 771     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 772         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 773     #
 774     path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
 775     if fig2dev == "fig2dev":
 776         addToRC(r'''\converter fig        eps        "fig2dev -L eps $$i $$o"   ""
 777 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 778 \converter fig        png        "fig2dev -L png $$i $$o"       ""
 779 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 780 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""''')
 781     #
 782     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 783         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 784     #
 785     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 786         rc_entry = [
 787             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 788 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 789 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 790             ''])
 791     #
 792     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 793         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 794     #
 795     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 796         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 797     #
 798     checkProg('an EPS -> PDF converter', ['epstopdf'],
 799         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 800     #
 801     checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
 802         rc_entry = [ r'\converter eps        png        "%%"    ""', ''])
 803     #
 804     # no agr -> pdf converter, since the pdf library used by gracebat is not
 805     # free software and therefore not compiled in in many installations.
 806     # Fortunately, this is not a big problem, because we will use epstopdf to
 807     # convert from agr to pdf via eps without loss of quality.
 808     checkProg('a Grace -> Image converter', ['gracebat'],
 809         rc_entry = [
 810             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 811 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 812 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 813 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 814             ''])
 815     #
 816     checkProg('a Dot -> Image converter', ['dot'],
 817         rc_entry = [
 818             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
 819 \converter dot        png        "dot -Tpng $$i -o $$o" ""''',
 820             ''])
 821     #
 822     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 823         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 824     #
 825     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 826         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 827     #
 828     checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i'],
 829         rc_entry = [ r'\converter odg        eps2       "%%"    ""'])
 830     #
 831     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 832         rc_entry = [ r'\converter svg        pdf        "%%"    ""'])
 833     #
 834     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 835         rc_entry = [ r'\converter svg        eps        "%%"    ""'])
 836     #
 837     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
 838         rc_entry = [ r'\converter svg        png        "%%"    ""'])
 839
 840     #
 841     # gnumeric/xls/ods to tex
 842     checkProg('a spreadsheet -> latex converter', ['ssconvert'],
 843        rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 844 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 845 \converter excel  latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
 846 ''])
 847
 848     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 849     if (lilypond != ''):
 850         version_string = cmdOutput("lilypond --version")
 851         match = re.match('GNU LilyPond (\S+)', version_string)
 852         if match:
 853             version_number = match.groups()[0]
 854             version = version_number.split('.')
 855             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 856                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps -dsafe --ps $$i"   ""
 857 \converter lilypond   png        "lilypond -dbackend=eps -dsafe --png $$i"      ""''')
 858                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps -dsafe --pdf $$i"    ""')
 859                 logger.info('+  found LilyPond version %s.' % version_number)
 860             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 861                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps --safe $$i"  ""
 862 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 863                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 864                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf --safe $$i"       ""')
 865                 logger.info('+  found LilyPond version %s.' % version_number)
 866             else:
 867                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 868         else:
 869             logger.info('+  found LilyPond, but could not extract version number.')
 870     #
 871     path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
 872     if (lilypond_book != ''):
 873         version_string = cmdOutput("lilypond-book --version")
 874         match = re.match('^(\S+)$', version_string)
 875         if match:
 876             version_number = match.groups()[0]
 877             version = version_number.split('.')
 878             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
 879                 # Note: The --lily-output-dir flag is required because lilypond-book
 880                 #       does not process input again unless the input has changed,
 881                 #       even if the output format being requested is different. So
 882                 #       once a .eps file exists, lilypond-book won't create a .pdf
 883                 #       even when requested with --pdf. This is a problem if a user
 884                 #       clicks View PDF after having done a View DVI. To circumvent
 885                 #       this, use different output folders for eps and pdf outputs.
 886                 addToRC(r'\converter lilypond-book latex    "lilypond-book --safe --lily-output-dir=ly-eps $$i"                                ""')
 887                 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
 888                 addToRC(r'\converter lilypond-book xetex    "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i"  ""')
 889                 addToRC(r'\converter lilypond-book luatex   "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
 890                 logger.info('+  found LilyPond-book version %s.' % version_number)
 891             else:
 892                 logger.info('+  found LilyPond-book, but version %s is too old.' % version_number)
 893         else:
 894             logger.info('+  found LilyPond-book, but could not extract version number.')
 895     #
 896     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 897         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 898     #
 899     # Currently, lyxpak outputs a gzip compressed tar archive on *nix
 900     # and a zip archive on Windows.
 901     # So, we configure the appropriate version according to the platform.
 902     cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$i" ""'
 903     if os.name == 'nt':
 904         addToRC(r'\Format lyxzip     zip    "LyX Archive (zip)"     "" "" ""  "document,menu=export"')
 905         addToRC(cmd % "lyxzip")
 906     else:
 907         addToRC(r'\Format lyxgz      gz     "LyX Archive (tar.gz)"  "" "" ""  "document,menu=export"')
 908         addToRC(cmd % "lyxgz")
 909
 910     #
 911     # FIXME: no rc_entry? comment it out
 912     # checkProg('Image converter', ['convert $$i $$o'])
 913     #
 914     # Entries that do not need checkProg
 915     addToRC(r'''
 916 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 917 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 918 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 919 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 920 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 921 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 922 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 923 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 924 \converter lyx        lyx20x     "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o"      ""
 925 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 926 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 927 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 928 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 929 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 930 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 931 \converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py --png"    ""
 932 \converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm"    ""
 933 ''')
 934
 935
 936 def checkDocBook():
 937     ''' Check docbook '''
 938     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 939         rc_entry = [
 940             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 941 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 942             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 943 \converter docbook    html       "db2html $$i"  ""''',
 944             r'''\converter docbook    dvi        ""     ""
 945 \converter docbook    html       "" ""''',
 946             r'''\converter docbook    dvi        ""     ""
 947 \converter docbook    html       ""     ""'''])
 948     #
 949     if DOCBOOK != '':
 950         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 951     else:
 952         return ('no', 'false', '')
 953
 954
 955 def checkOtherEntries():
 956     ''' entries other than Format and Converter '''
 957     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 958         rc_entry = [ r'\chktex_command "%%"' ])
 959     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 960         rc_entry = [ r'\bibtex_command "%%"' ],
 961         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 962     checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
 963         rc_entry = [ r'\jbibtex_command "%%"' ])
 964     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
 965         rc_entry = [ r'\index_command "%%"' ],
 966         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 967     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 968         rc_entry = [ r'\jindex_command "%%"' ])
 969     checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
 970         'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
 971     checkProg('a nomenclature processor', ['makeindex'],
 972         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 973     ## FIXME: OCTAVE is not used anywhere
 974     # path, OCTAVE = checkProg('Octave', ['octave'])
 975     ## FIXME: MAPLE is not used anywhere
 976     # path, MAPLE = checkProg('Maple', ['maple'])
 977     checkProg('a spool command', ['lp', 'lpr'],
 978         rc_entry = [
 979             r'''\print_spool_printerprefix "-d "
 980 \print_spool_command "lp"''',
 981             r'''\print_spool_printerprefix "-P",
 982 \print_spool_command "lpr"''',
 983             ''])
 984     # Add the rest of the entries (no checkProg is required)
 985     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 986 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 987 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 988 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 989 ''')
 990
 991
 992 def processLayoutFile(file, bool_docbook):
 993     ''' process layout file and get a line of result
 994
 995         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 996
 997         \DeclareLaTeXClass{article}
 998         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 999         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1000
1001         we expect output:
1002
1003         "article" "article" "article" "false" "article.cls"
1004         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
1005         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
1006     '''
1007     def checkForClassExtension(x):
1008         '''if the extension for a latex class is not
1009            provided, add .cls to the classname'''
1010         if not '.' in x:
1011             return x.strip() + '.cls'
1012         else:
1013             return x.strip()
1014     classname = file.split(os.sep)[-1].split('.')[0]
1015     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1016     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1017     for line in open(file).readlines():
1018         res = p.search(line)
1019         if res != None:
1020             (classtype, optAll, opt, opt1, desc) = res.groups()
1021             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1022             if opt == None:
1023                 opt = classname
1024                 prereq_latex = checkForClassExtension(classname)
1025             else:
1026                 prereq_list = optAll[1:-1].split(',')
1027                 prereq_list = map(checkForClassExtension, prereq_list)
1028                 prereq_latex = ','.join(prereq_list)
1029             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1030             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1031             return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
1032     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1033     return ""
1034
1035
1036 def checkLatexConfig(check_config, bool_docbook):
1037     ''' Explore the LaTeX configuration
1038         Return None (will be passed to sys.exit()) for success.
1039     '''
1040     msg = 'checking LaTeX configuration... '
1041     # if --without-latex-config is forced, or if there is no previous
1042     # version of textclass.lst, re-generate a default file.
1043     if not os.path.isfile('textclass.lst') or not check_config:
1044         # remove the files only if we want to regenerate
1045         removeFiles(['textclass.lst', 'packages.lst'])
1046         #
1047         # Then, generate a default textclass.lst. In case configure.py
1048         # fails, we still have something to start lyx.
1049         logger.info(msg + ' default values')
1050         logger.info('+checking list of textclasses... ')
1051         tx = open('textclass.lst', 'w')
1052         tx.write('''
1053 # This file declares layouts and their associated definition files
1054 # (include dir. relative to the place where this file is).
1055 # It contains only default values, since chkconfig.ltx could not be run
1056 # for some reason. Run ./configure.py if you need to update it after a
1057 # configuration change.
1058 ''')
1059         # build the list of available layout files and convert it to commands
1060         # for chkconfig.ltx
1061         foundClasses = []
1062         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1063             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1064             # valid file?
1065             if not os.path.isfile(file):
1066                 continue
1067             # get stuff between /xxxx.layout .
1068             classname = file.split(os.sep)[-1].split('.')[0]
1069             #  tr ' -' '__'`
1070             cleanclass = classname.replace(' ', '_')
1071             cleanclass = cleanclass.replace('-', '_')
1072             # make sure the same class is not considered twice
1073             if foundClasses.count(cleanclass) == 0: # not found before
1074                 foundClasses.append(cleanclass)
1075                 retval = processLayoutFile(file, bool_docbook)
1076                 if retval != "":
1077                     tx.write(retval)
1078         tx.close()
1079         logger.info('\tdone')
1080     if not check_config:
1081         return None
1082     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1083     logger.info(msg + '\tauto')
1084     removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1085         'wrap_chkconfig.ltx'])
1086     rmcopy = False
1087     if not os.path.isfile( 'chkconfig.ltx' ):
1088         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1089         rmcopy = True
1090     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1091     # Construct the list of classes to test for.
1092     # build the list of available layout files and convert it to commands
1093     # for chkconfig.ltx
1094     declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1095     empty = re.compile(r'^\s*$')
1096     testclasses = list()
1097     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1098         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1099         nodeclaration = False
1100         if not os.path.isfile(file):
1101             continue
1102         classname = file.split(os.sep)[-1].split('.')[0]
1103         for line in open(file).readlines():
1104             if not empty.match(line) and line[0] != '#':
1105                 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1106                 nodeclaration = True
1107                 break
1108             if declare.search(line) == None:
1109                 continue
1110             testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1111             break
1112         if nodeclaration:
1113             continue
1114     testclasses.sort()
1115     cl = open('chklayouts.tex', 'w')
1116     for line in testclasses:
1117         cl.write(line + '\n')
1118     cl.close()
1119     #
1120     # we have chklayouts.tex, then process it
1121     ret = 1
1122     latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx')
1123     for line in latex_out.splitlines():
1124         if re.match('^\+', line):
1125             logger.info(line.strip())
1126             # return None if the command succeeds
1127             if line == "+Inspection done.":
1128                 ret = None
1129     #
1130     # remove the copied file
1131     if rmcopy:
1132         removeFiles( [ 'chkconfig.ltx' ] )
1133     #
1134     # currently, values in chhkconfig are only used to set
1135     # \font_encoding
1136     values = {}
1137     for line in open('chkconfig.vars').readlines():
1138         key, val = re.sub('-', '_', line).split('=')
1139         val = val.strip()
1140         values[key] = val.strip("'")
1141     # chk_fontenc may not exist
1142     try:
1143         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1144     except:
1145         pass
1146     # if configure successed, move textclass.lst.tmp to textclass.lst
1147     # and packages.lst.tmp to packages.lst
1148     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1149         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1150         shutil.move('textclass.lst.tmp', 'textclass.lst')
1151         shutil.move('packages.lst.tmp', 'packages.lst')
1152     return ret
1153
1154
1155 def checkModulesConfig():
1156   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1157
1158   logger.info('+checking list of modules... ')
1159   tx = open('lyxmodules.lst', 'w')
1160   tx.write('''## This file declares modules and their associated definition files.
1161 ## It has been automatically generated by configure
1162 ## Use "Options/Reconfigure" if you need to update it after a
1163 ## configuration change.
1164 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1165 ''')
1166
1167   # build the list of available modules
1168   seen = []
1169   # note that this searches the local directory first, then the
1170   # system directory. that way, we pick up the user's version first.
1171   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1172       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1173       # valid file?
1174       logger.info(file)
1175       if not os.path.isfile(file):
1176           continue
1177
1178       filename = file.split(os.sep)[-1]
1179       filename = filename[:-7]
1180       if seen.count(filename):
1181           continue
1182
1183       seen.append(filename)
1184       retval = processModuleFile(file, filename, bool_docbook)
1185       if retval != "":
1186           tx.write(retval)
1187   tx.close()
1188   logger.info('\tdone')
1189
1190
1191 def processModuleFile(file, filename, bool_docbook):
1192     ''' process module file and get a line of result
1193
1194         The top of a module file should look like this:
1195           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1196           #DescriptionBegin
1197           #...body of description...
1198           #DescriptionEnd
1199           #Requires: [list of required modules]
1200           #Excludes: [list of excluded modules]
1201           #Category: [category name]
1202         The last three lines are optional (though do give a category).
1203         We expect output:
1204           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1205     '''
1206     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1207     rereqs = re.compile(r'#+\s*Requires: (.*)')
1208     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1209     recaty = re.compile(r'#+\s*Category: (.*)')
1210     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1211     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1212
1213     modname = desc = pkgs = req = excl = catgy = ""
1214     readingDescription = False
1215     descLines = []
1216
1217     for line in open(file).readlines():
1218       if readingDescription:
1219         res = redend.search(line)
1220         if res != None:
1221           readingDescription = False
1222           desc = " ".join(descLines)
1223           # Escape quotes.
1224           desc = desc.replace('"', '\\"')
1225           continue
1226         descLines.append(line[1:].strip())
1227         continue
1228       res = redbeg.search(line)
1229       if res != None:
1230         readingDescription = True
1231         continue
1232       res = remods.search(line)
1233       if res != None:
1234           (pkgs, modname) = res.groups()
1235           if pkgs == None:
1236             pkgs = ""
1237           else:
1238             tmp = [s.strip() for s in pkgs.split(",")]
1239             pkgs = ",".join(tmp)
1240           continue
1241       res = rereqs.search(line)
1242       if res != None:
1243         req = res.group(1)
1244         tmp = [s.strip() for s in req.split("|")]
1245         req = "|".join(tmp)
1246         continue
1247       res = reexcs.search(line)
1248       if res != None:
1249         excl = res.group(1)
1250         tmp = [s.strip() for s in excl.split("|")]
1251         excl = "|".join(tmp)
1252         continue
1253       res = recaty.search(line)
1254       if res != None:
1255         catgy = res.group(1)
1256         continue
1257
1258     if modname == "":
1259       logger.warning("Module file without \DeclareLyXModule line. ")
1260       return ""
1261
1262     if pkgs != "":
1263         # this module has some latex dependencies:
1264         # append the dependencies to chkmodules.tex,
1265         # which is \input'ed by chkconfig.ltx
1266         testpackages = list()
1267         for pkg in pkgs.split(","):
1268             if "->" in pkg:
1269                 # this is a converter dependency: skip
1270                 continue
1271             if pkg.endswith(".sty"):
1272                 pkg = pkg[:-4]
1273             testpackages.append("\\TestPackage{%s}" % (pkg,))
1274         cm = open('chkmodules.tex', 'a')
1275         for line in testpackages:
1276             cm.write(line + '\n')
1277         cm.close()
1278
1279     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1280
1281
1282 def checkTeXAllowSpaces():
1283     ''' Let's check whether spaces are allowed in TeX file names '''
1284     tex_allows_spaces = 'false'
1285     if lyx_check_config:
1286         msg = "Checking whether TeX allows spaces in file names... "
1287         writeToFile('a b.tex', r'\message{working^^J}' )
1288         if LATEX != '':
1289             if os.name == 'nt' or sys.platform == 'cygwin':
1290                 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1291             else:
1292                 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1293         else:
1294             latex_out = ''
1295         if 'working' in latex_out:
1296             logger.info(msg + 'yes')
1297             tex_allows_spaces = 'true'
1298         else:
1299             logger.info(msg + 'no')
1300             tex_allows_spaces = 'false'
1301         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1302         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1303
1304
1305 def removeTempFiles():
1306     # Final clean-up
1307     if not lyx_keep_temps:
1308         removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1309             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1310             'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1311
1312
1313 if __name__ == '__main__':
1314     lyx_check_config = True
1315     outfile = 'lyxrc.defaults'
1316     lyxrc_fileformat = 3
1317     rc_entries = ''
1318     lyx_keep_temps = False
1319     version_suffix = ''
1320     ## Parse the command line
1321     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1322         if op in [ '-help', '--help', '-h' ]:
1323             print '''Usage: configure [options]
1324 Options:
1325     --help                   show this help lines
1326     --keep-temps             keep temporary files (for debug. purposes)
1327     --without-latex-config   do not run LaTeX to determine configuration
1328     --with-version-suffix=suffix suffix of binary installed files
1329 '''
1330             sys.exit(0)
1331         elif op == '--without-latex-config':
1332             lyx_check_config = False
1333         elif op == '--keep-temps':
1334             lyx_keep_temps = True
1335         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1336             version_suffix = op[22:]
1337         else:
1338             print "Unknown option", op
1339             sys.exit(1)
1340     #
1341     # check if we run from the right directory
1342     srcdir = os.path.dirname(sys.argv[0])
1343     if srcdir == '':
1344         srcdir = '.'
1345     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1346         logger.error("configure: error: cannot find chkconfig.ltx script")
1347         sys.exit(1)
1348     setEnviron()
1349     createDirectories()
1350     dtl_tools = checkDTLtools()
1351     ## Write the first part of outfile
1352     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1353 # script. It contains default settings that have been determined by
1354 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1355 # want to customize LyX, use LyX' Preferences dialog or modify directly
1356 # the "preferences" file instead. Any setting in that file will
1357 # override the values given here.
1358
1359 Format %i
1360
1361 ''' % lyxrc_fileformat)
1362     # check latex
1363     LATEX = checkLatex(dtl_tools)
1364     # check java and perl before any checkProg that may require them
1365     java = checkProg('a java interpreter', ['java'])[1]
1366     perl = checkProg('a perl interpreter', ['perl'])[1]
1367     checkFormatEntries(dtl_tools)
1368     checkConverterEntries()
1369     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1370     checkTeXAllowSpaces()
1371     windows_style_tex_paths = checkTeXPaths()
1372     if windows_style_tex_paths != '':
1373         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1374     checkOtherEntries()
1375     checkModulesConfig()
1376     # --without-latex-config can disable lyx_check_config
1377     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1378     removeTempFiles()
1379     # The return error code can be 256. Because most systems expect an error code
1380     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1381     # a None for success, 'ret is not None' is used to exit.
1382     sys.exit(ret is not None)