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