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 from __future__ import print_function
  12 import glob, logging, os, re, shutil, subprocess, sys, stat
  13
  14 # set up logging
  15 logging.basicConfig(level = logging.DEBUG,
  16     format = '%(levelname)s: %(message)s', # ignore application name
  17     filename = 'configure.log',
  18     filemode = 'w')
  19 #
  20 # Add a handler to log to console
  21 console = logging.StreamHandler()
  22 console.setLevel(logging.INFO) # the console only print out general information
  23 formatter = logging.Formatter('%(message)s') # only print out the message itself
  24 console.setFormatter(formatter)
  25 logger = logging.getLogger('LyX')
  26 logger.addHandler(console)
  27
  28 def writeToFile(filename, lines, append = False):
  29     " utility function: write or append lines to filename "
  30     if append:
  31         file = open(filename, 'a')
  32     else:
  33         file = open(filename, 'w')
  34     file.write(lines)
  35     file.close()
  36
  37
  38 def addToRC(lines):
  39     ''' utility function: shortcut for appending lines to outfile
  40         add newline at the end of lines.
  41     '''
  42     if lines.strip() != '':
  43         writeToFile(outfile, lines + '\n', append = True)
  44         logger.debug('Add to RC:\n' + lines + '\n\n')
  45
  46
  47 def removeFiles(filenames):
  48     '''utility function: 'rm -f'
  49         ignore errors when file does not exist, or is a directory.
  50     '''
  51     for file in filenames:
  52         try:
  53             os.remove(file)
  54             logger.debug('Removing file %s' % file)
  55         except:
  56             logger.debug('Failed to remove file %s' % file)
  57             pass
  58
  59
  60 def cmdOutput(cmd, async = False):
  61     '''utility function: run a command and get its output as a string
  62         cmd: command to run
  63         async: if False, return whole output as a string, otherwise
  64                return the stdout handle from which the output can be
  65                read (the caller is then responsible for closing it)
  66     '''
  67     if os.name == 'nt':
  68         b = False
  69         if sys.version_info[0] < 3:
  70             cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
  71         else:
  72             cmd = 'cmd /d /c pushd ' + shortPath(os.getcwd()) + '&' + cmd
  73     else:
  74         b = True
  75     pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE,
  76                             stdout=subprocess.PIPE, universal_newlines=True)
  77     pipe.stdin.close()
  78     if async:
  79         return pipe.stdout
  80     output = pipe.stdout.read()
  81     pipe.stdout.close()
  82     return output.strip()
  83
  84
  85 def shortPath(path):
  86     ''' On Windows, return the short version of "path" if possible '''
  87     if os.name == 'nt':
  88         from ctypes import windll, create_unicode_buffer
  89         GetShortPathName = windll.kernel32.GetShortPathNameW
  90         shortlen = GetShortPathName(path, 0, 0)
  91         shortpath = create_unicode_buffer(shortlen)
  92         if GetShortPathName(path, shortpath, shortlen):
  93             return shortpath.value
  94     return path
  95
  96
  97 def setEnviron():
  98     ''' I do not really know why this is useful, but we might as well keep it.
  99         NLS nuisances.
 100         Only set these to C if already set.  These must not be set unconditionally
 101         because not all systems understand e.g. LANG=C (notably SCO).
 102         Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
 103         Non-C LC_CTYPE values break the ctype check.
 104     '''
 105     os.environ['LANG'] = os.getenv('LANG', 'C')
 106     os.environ['LC'] = os.getenv('LC_ALL', 'C')
 107     os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
 108     os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
 109
 110
 111 def copy_tree(src, dst, preserve_symlinks=False, level=0):
 112     ''' Copy an entire directory tree 'src' to a new location 'dst'.
 113
 114     Code inspired from distutils.copy_tree.
 115          Copying ignores non-regular files and the cache directory.
 116     Pipes may be present as leftovers from LyX for lyx-server.
 117
 118     If 'preserve_symlinks' is true, symlinks will be
 119     copied as symlinks (on platforms that support them!); otherwise
 120     (the default), the destination of the symlink will be copied.
 121     '''
 122
 123     if not os.path.isdir(src):
 124         raise FileError("cannot copy tree '%s': not a directory" % src)
 125     try:
 126         names = os.listdir(src)
 127     except os.error as oserror:
 128         (errno, errstr) = oserror.args
 129         raise FileError("error listing files in '%s': %s" % (src, errstr))
 130
 131     if not os.path.isdir(dst):
 132         os.makedirs(dst)
 133
 134     outputs = []
 135
 136     for name in names:
 137         src_name = os.path.join(src, name)
 138         dst_name = os.path.join(dst, name)
 139         if preserve_symlinks and os.path.islink(src_name):
 140             link_dest = os.readlink(src_name)
 141             os.symlink(link_dest, dst_name)
 142             outputs.append(dst_name)
 143         elif level == 0 and name == 'cache':
 144             logger.info("Skip cache %s", src_name)
 145         elif os.path.isdir(src_name):
 146             outputs.extend(
 147                 copy_tree(src_name, dst_name, preserve_symlinks, level=(level + 1)))
 148         elif stat.S_ISREG(os.stat(src_name).st_mode) or os.path.islink(src_name):
 149             shutil.copy2(src_name, dst_name)
 150             outputs.append(dst_name)
 151         else:
 152             logger.info("Ignore non-regular file %s", src_name)
 153
 154     return outputs
 155
 156
 157 def checkUpgrade():
 158     ''' Check for upgrade from previous version '''
 159     cwd = os.getcwd()
 160     basename = os.path.basename( cwd )
 161     lyxrc = os.path.join(cwd, outfile)
 162     if not os.path.isfile( lyxrc ) and basename.endswith( version_suffix ) :
 163         logger.info('Checking for upgrade from previous version.')
 164         parent = os.path.dirname(cwd)
 165         appname = basename[:(-len(version_suffix))]
 166         for version in ['-2.1', '-2.0', '-1.6' ]:
 167             logger.debug('Checking for upgrade from previous version ' + version)
 168             previous = os.path.join(parent, appname + version)
 169             logger.debug('previous = ' + previous)
 170             if os.path.isdir( previous ):
 171                 logger.info('Found directory "%s".', previous)
 172                 copy_tree( previous, cwd, True )
 173                 logger.info('Content copied to directory "%s".', cwd)
 174                 return
 175
 176
 177 def createDirectories():
 178     ''' Create the build directories if necessary '''
 179     for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd',
 180         'layouts', 'scripts', 'templates', 'ui' ]:
 181         if not os.path.isdir( dir ):
 182             try:
 183                 os.mkdir( dir)
 184                 logger.debug('Create directory %s.' % dir)
 185             except:
 186                 logger.error('Failed to create directory %s.' % dir)
 187                 sys.exit(1)
 188
 189
 190 def checkTeXPaths():
 191     ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
 192     windows_style_tex_paths = ''
 193     if LATEX == '':
 194         return windows_style_tex_paths
 195     if os.name == 'nt' or sys.platform == 'cygwin':
 196         from tempfile import mkstemp
 197         fd, tmpfname = mkstemp(suffix='.ltx')
 198         if os.name == 'nt':
 199             from locale import getdefaultlocale
 200             language, encoding = getdefaultlocale()
 201             if encoding == None:
 202                 encoding = 'latin1'
 203             if sys.version_info[0] < 3:
 204                 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
 205             else:
 206                 inpname = shortPath(str(tmpfname, encoding)).replace('\\', '/')
 207         else:
 208             inpname = cmdOutput('cygpath -m ' + tmpfname)
 209         logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
 210         inpname = inpname.replace('~', '\\string~')
 211         os.write(fd, r'\relax')
 212         os.close(fd)
 213         latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"'
 214                               % inpname)
 215         if 'Error' in latex_out:
 216             latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"'
 217                                   % inpname)
 218         if 'Error' in latex_out:
 219             logger.warning("configure: TeX engine needs posix-style paths in latex files")
 220             windows_style_tex_paths = 'false'
 221         else:
 222             logger.info("configure: TeX engine needs windows-style paths in latex files")
 223             windows_style_tex_paths = 'true'
 224         removeFiles([tmpfname, logname, 'texput.log'])
 225     return windows_style_tex_paths
 226
 227
 228 ## Searching some useful programs
 229 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
 230     '''
 231         This function will search a program in $PATH plus given path
 232         If found, return directory and program name (not the options).
 233
 234         description: description of the program
 235
 236         progs: check programs, for each prog, the first word is used
 237             for searching but the whole string is used to replace
 238             %% for a rc_entry. So, feel free to add '$$i' etc for programs.
 239
 240         path: additional paths (will be prepended to the program name)
 241
 242         rc_entry: entry to outfile, can be
 243             1. emtpy: no rc entry will be added
 244             2. one pattern: %% will be replaced by the first found program,
 245                 or '' if no program is found.
 246             3. several patterns for each prog and not_found. This is used
 247                 when different programs have different usages. If you do not
 248                 want not_found entry to be added to the RC file, you can specify
 249                 an entry for each prog and use '' for the not_found entry.
 250
 251         not_found: the value that should be used instead of '' if no program
 252             was found
 253
 254     '''
 255     # one rc entry for each progs plus not_found entry
 256     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 257         logger.error("rc entry should have one item or item "
 258                      "for each prog and not_found.")
 259         sys.exit(2)
 260     logger.info('checking for ' + description + '...')
 261     ## print '(' + ','.join(progs) + ')',
 262     additional_path = path
 263     path = os.environ["PATH"].split(os.pathsep) + additional_path
 264     extlist = ['']
 265     if "PATHEXT" in os.environ:
 266         extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 267     global java, perl
 268     for idx in range(len(progs)):
 269         # ac_prog may have options, ac_word is the command name
 270         ac_prog = progs[idx]
 271         ac_word = ac_prog.split(' ')[0]
 272         if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
 273             continue
 274         if ac_word.endswith('.pl') and perl == '':
 275             continue
 276         msg = '+checking for "' + ac_word + '"... '
 277         for ac_dir in path:
 278             if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
 279                 continue
 280             for ext in extlist:
 281                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 282                     logger.info(msg + ' yes')
 283                     # deal with java and perl
 284                     if ac_word.endswith('.class'):
 285                         ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
 286                                     % (java, os.path.join(ac_dir, ac_word[:-6])))
 287                     elif ac_word.endswith('.jar'):
 288                         ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
 289                                     % (java, os.path.join(ac_dir, ac_word)))
 290                     elif ac_word.endswith('.pl'):
 291                         ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
 292                                     % (perl, os.path.join(ac_dir, ac_word)))
 293                     elif ac_dir in additional_path:
 294                         ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
 295                                     % (os.path.join(ac_dir, ac_word)))
 296                     # write rc entries for this command
 297                     if len(rc_entry) == 1:
 298                         addToRC(rc_entry[0].replace('%%', ac_prog))
 299                     elif len(rc_entry) > 1:
 300                         addToRC(rc_entry[idx].replace('%%', ac_prog))
 301                     return [ac_dir, ac_word]
 302         # if not successful
 303         logger.info(msg + ' no')
 304     # write rc entries for 'not found'
 305     if len(rc_entry) > 0:  # the last one.
 306         addToRC(rc_entry[-1].replace('%%', not_found))
 307     return ['', not_found]
 308
 309
 310 def checkProgAlternatives(description, progs, rc_entry = [],
 311                           alt_rc_entry = [], path = [], not_found = ''):
 312     '''
 313         The same as checkProg, but additionally, all found programs will be added
 314         as alt_rc_entries
 315     '''
 316     # one rc entry for each progs plus not_found entry
 317     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 318         logger.error("rc entry should have one item or item for each prog and not_found.")
 319         sys.exit(2)
 320     logger.info('checking for ' + description + '...')
 321     ## print '(' + ','.join(progs) + ')',
 322     additional_path = path
 323     path = os.environ["PATH"].split(os.pathsep) + additional_path
 324     extlist = ['']
 325     if "PATHEXT" in os.environ:
 326         extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 327     found_prime = False
 328     real_ac_dir = ''
 329     real_ac_word = not_found
 330     global java, perl
 331     for idx in range(len(progs)):
 332         # ac_prog may have options, ac_word is the command name
 333         ac_prog = progs[idx]
 334         ac_word = ac_prog.split(' ')[0]
 335         if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
 336             continue
 337         if ac_word.endswith('.pl') and perl == '':
 338             continue
 339         msg = '+checking for "' + ac_word + '"... '
 340         found_alt = False
 341         for ac_dir in path:
 342             if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
 343                 continue
 344             for ext in extlist:
 345                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 346                     logger.info(msg + ' yes')
 347                     pr = re.compile(r'(\\\S+)(.*)$')
 348                     m = None
 349                     # deal with java and perl
 350                     if ac_word.endswith('.class'):
 351                         ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
 352                                     % (java, os.path.join(ac_dir, ac_word[:-6])))
 353                     elif ac_word.endswith('.jar'):
 354                         ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
 355                                     % (java, os.path.join(ac_dir, ac_word)))
 356                     elif ac_word.endswith('.pl'):
 357                         ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
 358                                     % (perl, os.path.join(ac_dir, ac_word)))
 359                     elif ac_dir in additional_path:
 360                         ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
 361                                     % (os.path.join(ac_dir, ac_word)))
 362                     # write rc entries for this command
 363                     if found_prime == False:
 364                         if len(rc_entry) == 1:
 365                             addToRC(rc_entry[0].replace('%%', ac_prog))
 366                         elif len(rc_entry) > 1:
 367                             addToRC(rc_entry[idx].replace('%%', ac_prog))
 368                         real_ac_dir = ac_dir
 369                         real_ac_word = ac_word
 370                         found_prime = True
 371                     if len(alt_rc_entry) == 1:
 372                         alt_rc = alt_rc_entry[0]
 373                         if alt_rc == "":
 374                             # if no explicit alt_rc is given, construct one
 375                             m = pr.match(rc_entry[0])
 376                             if m:
 377                                 alt_rc = m.group(1) + "_alternatives" + m.group(2)
 378                         addToRC(alt_rc.replace('%%', ac_prog))
 379                     elif len(alt_rc_entry) > 1:
 380                         alt_rc = alt_rc_entry[idx]
 381                         if alt_rc == "":
 382                             # if no explicit alt_rc is given, construct one
 383                             m = pr.match(rc_entry[idx])
 384                             if m:
 385                                 alt_rc = m.group(1) + "_alternatives" + m.group(2)
 386                         addToRC(alt_rc.replace('%%', ac_prog))
 387                     found_alt = True
 388                     break
 389             if found_alt:
 390                 break
 391         if found_alt == False:
 392             # if not successful
 393             logger.info(msg + ' no')
 394     if found_prime:
 395         return [real_ac_dir, real_ac_word]
 396     # write rc entries for 'not found'
 397     if len(rc_entry) > 0:  # the last one.
 398         addToRC(rc_entry[-1].replace('%%', not_found))
 399     return ['', not_found]
 400
 401
 402 def addAlternatives(rcs, alt_type):
 403     '''
 404         Returns a \\prog_alternatives string to be used as an alternative
 405         rc entry.  alt_type can be a string or a list of strings.
 406     '''
 407     r = re.compile(r'\\Format (\S+).*$')
 408     m = None
 409     alt = ''
 410     alt_token = '\\%s_alternatives '
 411     if isinstance(alt_type, str):
 412         alt_tokens = [alt_token % alt_type]
 413     else:
 414         alt_tokens = [alt_token % s for s in alt_type]
 415     for idxx in range(len(rcs)):
 416         if len(rcs) == 1:
 417             m = r.match(rcs[0])
 418             if m:
 419                 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
 420         elif len(rcs) > 1:
 421             m = r.match(rcs[idxx])
 422             if m:
 423                 if idxx > 0:
 424                     alt += '\n'
 425                 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
 426     return alt
 427
 428
 429 def listAlternatives(progs, alt_type, rc_entry = []):
 430     '''
 431         Returns a list of \\prog_alternatives strings to be used as alternative
 432         rc entries.  alt_type can be a string or a list of strings.
 433     '''
 434     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 435         logger.error("rc entry should have one item or item for each prog and not_found.")
 436         sys.exit(2)
 437     alt_rc_entry = []
 438     for idx in range(len(progs)):
 439         if len(rc_entry) == 1:
 440             rcs = rc_entry[0].split('\n')
 441             alt = addAlternatives(rcs, alt_type)
 442             alt_rc_entry.insert(0, alt)
 443         elif len(rc_entry) > 1:
 444             rcs = rc_entry[idx].split('\n')
 445             alt = addAlternatives(rcs, alt_type)
 446             alt_rc_entry.insert(idx, alt)
 447     return alt_rc_entry
 448
 449
 450 def checkViewer(description, progs, rc_entry = [], path = []):
 451     ''' The same as checkProgAlternatives, but for viewers '''
 452     alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
 453     return checkProgAlternatives(description, progs, rc_entry,
 454                                  alt_rc_entry, path, not_found = 'auto')
 455
 456
 457 def checkEditor(description, progs, rc_entry = [], path = []):
 458     ''' The same as checkProgAlternatives, but for editors '''
 459     alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
 460     return checkProgAlternatives(description, progs, rc_entry,
 461                                  alt_rc_entry, path, not_found = 'auto')
 462
 463
 464 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
 465     ''' The same as checkViewer, but do not add rc entry '''
 466     alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
 467     rc_entry = []
 468     return checkProgAlternatives(description, progs, rc_entry,
 469                                  alt_rc_entry, path, not_found = 'auto')
 470
 471
 472 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
 473     ''' The same as checkViewer, but do not add rc entry '''
 474     alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
 475     rc_entry = []
 476     return checkProgAlternatives(description, progs, rc_entry,
 477                                  alt_rc_entry, path, not_found = 'auto')
 478
 479
 480 def checkViewerEditor(description, progs, rc_entry = [], path = []):
 481     ''' The same as checkProgAlternatives, but for viewers and editors '''
 482     alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
 483     return checkProgAlternatives(description, progs, rc_entry,
 484                                  alt_rc_entry, path, not_found = 'auto')
 485
 486
 487 def checkDTLtools():
 488     ''' Check whether DTL tools are available (Windows only) '''
 489     # Find programs! Returned path is not used now
 490     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 491             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 492             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 493         dtl_tools = True
 494     else:
 495         dtl_tools = False
 496     return dtl_tools
 497
 498 def checkInkscape():
 499     ''' Check whether Inkscape is available and return the full path (Windows only) '''
 500     if os.name != 'nt':
 501         return 'inkscape'
 502     if sys.version_info[0] < 3:
 503         import _winreg as winreg
 504     else:
 505         import winreg
 506     aReg = winreg.ConnectRegistry(None, winreg.HKEY_CLASSES_ROOT)
 507     try:
 508         aKey = winreg.OpenKey(aReg, r"inkscape.svg\DefaultIcon")
 509         val = winreg.QueryValueEx(aKey, "")
 510         return str(val[0]).split('"')[1].replace('.exe', '')
 511     except EnvironmentError:
 512         try:
 513             aKey = winreg.OpenKey(aReg, r"Applications\inkscape.exe\shell\open\command")
 514             val = winreg.QueryValueEx(aKey, "")
 515             return str(val[0]).split('"')[1].replace('.exe', '')
 516         except EnvironmentError:
 517             return 'inkscape'
 518
 519 def checkLatex(dtl_tools):
 520     ''' Check latex, return lyx_check_config '''
 521     path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
 522     path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
 523     #-----------------------------------------------------------------
 524     path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
 525     if PLATEX != '':
 526         # check if PLATEX is pLaTeX2e
 527         writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
 528         # run platex on chklatex.ltx and check result
 529         if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
 530             # We have the Japanese pLaTeX2e
 531             addToRC(r'\converter platex   dvi       "%s"   "latex=platex"' % PLATEX)
 532         else:
 533             PLATEX = ''
 534             removeFiles(['chklatex.ltx', 'chklatex.log'])
 535     #-----------------------------------------------------------------
 536     # use LATEX to convert from latex to dvi if PPLATEX is not available
 537     if PPLATEX == '':
 538         PPLATEX = LATEX
 539     if dtl_tools:
 540         # Windows only: DraftDVI
 541         addToRC(r'''\converter latex      dvi2       "%s"       "latex"
 542 \converter dvi2       dvi        "python -tt $$s/scripts/clean_dvi.py $$i $$o"  ""''' % PPLATEX)
 543     else:
 544         addToRC(r'\converter latex      dvi        "%s" "latex"' % PPLATEX)
 545     # no latex
 546     if LATEX != '':
 547         # Check if latex is usable
 548         writeToFile('chklatex.ltx', r'''
 549 \nonstopmode
 550 \ifx\undefined\documentclass\else
 551   \message{ThisIsLaTeX2e}
 552 \fi
 553 \makeatletter
 554 \@@end
 555 ''')
 556         # run latex on chklatex.ltx and check result
 557         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 558             # valid latex2e
 559             return LATEX
 560         else:
 561             logger.warning("Latex not usable (not LaTeX2e) ")
 562         # remove temporary files
 563         removeFiles(['chklatex.ltx', 'chklatex.log'])
 564     return ''
 565
 566
 567 def checkLuatex():
 568     ''' Check if luatex is there '''
 569     path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
 570     path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
 571     if LUATEX != '':
 572         addToRC(r'\converter luatex      pdf5       "%s"        "latex=lualatex"' % LUATEX)
 573     if DVILUATEX != '':
 574         addToRC(r'\converter dviluatex   dvi3        "%s"       "latex=dvilualatex"' % DVILUATEX)
 575
 576
 577 def checkModule(module):
 578     ''' Check for a Python module, return the status '''
 579     msg = 'checking for "' + module + ' module"... '
 580     try:
 581       __import__(module)
 582       logger.info(msg + ' yes')
 583       return True
 584     except ImportError:
 585       logger.info(msg + ' no')
 586       return False
 587
 588
 589 def checkFormatEntries(dtl_tools):
 590     ''' Check all formats (\Format entries) '''
 591     checkViewerEditor('a Tgif viewer and editor', ['tgif'],
 592         rc_entry = [r'\Format tgif      "obj, tgo" Tgif                 "" "%%" "%%"    "vector"        "application/x-tgif"'])
 593     #
 594     checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
 595         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"        "application/x-xfig"'])
 596     #
 597     checkViewerEditor('a Dia viewer and editor', ['dia'],
 598         rc_entry = [r'\Format dia        dia     DIA                    "" "%%" "%%"    "vector,zipped=native", "application/x-dia-diagram"'])
 599     #
 600     checkViewerEditor('an OpenDocument drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
 601         rc_entry = [r'\Format odg        "odg, sxd" "OpenDocument drawing"   "" "%%"    "%%"    "vector,zipped=native"  "application/vnd.oasis.opendocument.graphics"'])
 602     #
 603     checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
 604         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"        ""'])
 605     #
 606     checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 607         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""      ""'])
 608     #
 609     checkViewerEditor('a SVG viewer and editor', [inkscape_name],
 610         rc_entry = [r'''\Format svg        "svg" SVG                "" "%%" "%%"        "vector"        "image/svg+xml"
 611 \Format svgz       "svgz" "SVG (compressed)" "" "%%" "%%"       "vector,zipped=native"  ""'''],
 612         path = [inkscape_path])
 613     #
 614     imageformats = r'''\Format bmp        bmp     BMP                    "" "%s"        "%s"    ""      "image/x-bmp"
 615 \Format gif        gif     GIF                    "" "%s"       "%s"    ""      "image/gif"
 616 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""      "image/jpeg"
 617 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""      "image/x-portable-bitmap"
 618 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""      "image/x-portable-graymap"
 619 \Format png        png     PNG                    "" "%s"       "%s"    ""      "image/x-png"
 620 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""      "image/x-portable-pixmap"
 621 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""      "image/tiff"
 622 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""      "image/x-xbitmap"
 623 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""      "image/x-xpixmap"'''
 624     path, iv = checkViewerNoRC('a raster image viewer',
 625         ['xv', 'gwenview', 'kview',
 626          'eog', 'xviewer', 'ristretto', 'gpicview', 'lximage-qt',
 627          'xdg-open', 'gimp-remote', 'gimp'],
 628         rc_entry = [imageformats])
 629     path, ie = checkEditorNoRC('a raster image editor',
 630         ['gimp-remote', 'gimp'], rc_entry = [imageformats])
 631     addToRC(imageformats % ((iv, ie)*10))
 632     #
 633     checkViewerEditor('a text editor',
 634         ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate',
 635          'nedit', 'gedit', 'geany', 'leafpad', 'mousepad', 'xed', 'notepad'],
 636         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""      ""
 637 \Format docbook    sgml    DocBook                B  "" "%%"    "document,menu=export"  ""
 638 \Format docbook-xml xml   "DocBook (XML)"         "" "" "%%"    "document,menu=export"  "application/docbook+xml"
 639 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"        "text/vnd.graphviz"
 640 \Format dviluatex  tex    "LaTeX (dviluatex)"     "" "" "%%"    "document,menu=export"  ""
 641 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document,menu=export"  ""
 642 \Format literate   nw      NoWeb                  N  "" "%%"    "document,menu=export"  ""
 643 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document,menu=export"  ""
 644 \Format r          R      "R/S code"              "" "" "%%"    "document,menu=export"  ""
 645 \Format knitr      Rnw    "Rnw (knitr)"           "" "" "%%"    "document,menu=export"  ""
 646 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"        "text/x-lilypond"
 647 \Format lilypond-book    lytex "LilyPond book (LaTeX)"   "" ""  "%%"    "document,menu=export"  ""
 648 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document,menu=export"  "text/x-tex"
 649 \Format luatex     tex    "LaTeX (LuaTeX)"        "" "" "%%"    "document,menu=export"  ""
 650 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document,menu=export"  ""
 651 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document,menu=export"  ""
 652 \Format latexclipboard tex "LaTeX (clipboard)"    "" "" "%%"    ""      ""
 653 \Format text       txt    "Plain text"            a  "" "%%"    "document,menu=export"  "text/plain"
 654 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"      ""
 655 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"      ""
 656 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"      ""
 657 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"      ""
 658 \Format beamer.info pdf.info   "Info (Beamer)"         "" ""   "%%"    "document,menu=export"   ""''' ])
 659    #Spreadsheets using ssconvert from gnumeric
 660     checkViewer('gnumeric spreadsheet software', ['gnumeric'],
 661       rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" ""    "%%"   "document"       "application/x-gnumeric"
 662 \Format excel      xls    "Excel spreadsheet"      "" "" "%%"    "document"     "application/vnd.ms-excel"
 663 \Format excel2     xlsx   "MS Excel Office Open XML" "" "" "%%" "document"      "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
 664 \Format html_table html   "HTML Table (for spreadsheets)"      "" "" "%%"    "document" "text/html"
 665 \Format oocalc     ods    "OpenDocument spreadsheet" "" "" "%%"    "document"   "application/vnd.oasis.opendocument.spreadsheet"'''])
 666  #
 667     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 668         rc_entry = [r'\Format xhtml      xhtml   "LyXHTML"              y "%%" ""    "document,menu=export"     "application/xhtml+xml"'])
 669  #
 670     checkEditor('a BibTeX editor', ['jabref', 'JabRef',
 671         'pybliographic', 'bibdesk', 'gbib', 'kbib',
 672         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex'
 673         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate',
 674         'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad',
 675         'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
 676         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""      "text/x-bibtex"''' ])
 677     #
 678     #checkProg('a Postscript interpreter', ['gs'],
 679     #  rc_entry = [ r'\ps_command "%%"' ])
 680     checkViewer('a Postscript previewer',
 681                 ['kghostview', 'okular', 'qpdfview --unique',
 682                  'evince', 'xreader',
 683                  'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
 684         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"        "image/x-eps"
 685 \Format eps2       eps    "EPS (uncropped)"       "" "%%"       ""      "vector"        ""
 686 \Format eps3       eps    "EPS (cropped)"         "" "%%"       ""      "document"      ""
 687 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector,menu=export"   "application/postscript"'''])
 688     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 689     # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
 690     checkViewer('a PDF previewer',
 691                 ['pdfview', 'kpdf', 'okular', 'qpdfview --unique',
 692                  'evince', 'xreader', 'kghostview', 'xpdf', 'SumatraPDF',
 693                  'acrobat', 'acroread', 'mupdf',
 694                  'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
 695         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector,menu=export"   ""
 696 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector,menu=export"   ""
 697 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector,menu=export"   ""
 698 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector,menu=export"   ""
 699 \Format pdf5       pdf    "PDF (LuaTeX)"          u  "%%"       ""      "document,vector,menu=export"   ""
 700 \Format pdf6       pdf    "PDF (graphics)"        "" "%%"       ""      "vector"        "application/pdf"
 701 \Format pdf7       pdf    "PDF (cropped)"         "" "%%"       ""      "document,vector"       ""
 702 \Format pdf8       pdf    "PDF (lower resolution)"         "" "%%"      ""      "document,vector"       ""'''])
 703     #
 704     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular',
 705                                     'evince', 'xreader',
 706                                     'yap', 'dviout -Set=!m'],
 707         rc_entry = [r'''\Format dvi        dvi     DVI                    D  "%%"       ""      "document,vector,menu=export"   "application/x-dvi"
 708 \Format dvi3       dvi     "DVI (LuaTeX)"          V  "%%"      ""      "document,vector,menu=export"   ""'''])
 709     if dtl_tools:
 710         # Windows only: DraftDVI
 711         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"        ""')
 712     #
 713     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 714         rc_entry = [r'\Format html      "html, htm" HTML                H  "%%" ""      "document,menu=export"  "text/html"'])
 715     #
 716     checkViewerEditor('Noteedit', ['noteedit'],
 717         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"        ""'])
 718     #
 719     checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 720         rc_entry = [r'''\Format odt        odt     "OpenDocument (tex4ht)"  "" "%%"     "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 721 \Format odt2       odt    "OpenDocument (eLyXer)"  "" "%%"      "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 722 \Format odt3       odt    "OpenDocument (Pandoc)"  "" "%%"      "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 723 \Format sxw        sxw    "OpenOffice.Org (sxw)"  "" "" ""      "document,vector"       "application/vnd.sun.xml.writer"'''])
 724     #
 725     checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 726         rc_entry = [r'''\Format rtf        rtf    "Rich Text Format"      "" "%%"       "%%"    "document,vector,menu=export"   "application/rtf"
 727 \Format word       doc    "MS Word"               W  "%%"       "%%"    "document,vector,menu=export"   "application/msword"
 728 \Format word2      docx    "MS Word Office Open XML"               O  "%%"      "%%"    "document,vector,menu=export"   "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
 729     #
 730     # entries that do not need checkProg
 731     addToRC(r'''\Format csv        csv    "Table (CSV)"           "" "" ""      "document"      "text/csv"
 732 \Format fax        ""      Fax                    "" "" ""      "document"      ""
 733 \Format lyx        lyx     LyX                    "" "" ""      ""      "application/x-lyx"
 734 \Format lyx13x     13.lyx "LyX 1.3.x"             "" "" ""      "document"      ""
 735 \Format lyx14x     14.lyx "LyX 1.4.x"             "" "" ""      "document"      ""
 736 \Format lyx15x     15.lyx "LyX 1.5.x"             "" "" ""      "document"      ""
 737 \Format lyx16x     16.lyx "LyX 1.6.x"             "" "" ""      "document"      ""
 738 \Format lyx20x     20.lyx "LyX 2.0.x"             "" "" ""      "document"      ""
 739 \Format lyx21x     21.lyx "LyX 2.1.x"             "" "" ""      "document"      ""
 740 \Format lyx22x     22.lyx "LyX 2.2.x"             "" "" ""      "document,menu=export"  ""
 741 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"      ""
 742 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"      ""
 743 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"      ""
 744 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""      ""
 745 \Format pdftex     "pdftex_t, pdf_tex" PDFTEX                "" ""      ""      ""      ""
 746 \Format program    ""      Program                "" "" ""      ""      ""
 747 \Format pstex      "pstex_t, ps_tex" PSTEX                  "" ""       ""      ""      ""
 748 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"        "image/x-wmf"
 749 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"        "image/x-emf"
 750 \Format wordhtml  "html, htm" "HTML (MS Word)"    "" "" ""      "document"      ""
 751 ''')
 752
 753
 754 def checkConverterEntries():
 755     ''' Check all converters (\converter entries) '''
 756     checkProg('the pdflatex program', ['pdflatex $$i'],
 757         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex=pdflatex"' ])
 758
 759     checkProg('XeTeX', ['xelatex $$i'],
 760         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex=xelatex"' ])
 761
 762     checkLuatex()
 763
 764     # Look for tex2lyx in this order (see bugs #3308 and #6986):
 765     #   1)  If we're building LyX with autotools then tex2lyx is found
 766     #       in the subdirectory tex2lyx with respect to the binary dir.
 767     #   2)  If we're building LyX with cmake then tex2lyx is found
 768     #       in the binary dir.
 769     #   3)  If LyX was configured with a version suffix then tex2lyx
 770     #       will also have this version suffix.
 771     #   4)  Otherwise always use tex2lyx.
 772     in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
 773     in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
 774
 775     in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
 776     in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
 777
 778     path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_binary_subdir, in_binary_subdir + version_suffix, in_binary_dir, in_binary_dir + version_suffix, 'tex2lyx' + version_suffix, 'tex2lyx'],
 779         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 780 \converter latexclipboard lyx        "%% -fixedenc utf8 -f $$i $$o"     ""
 781 \converter literate   lyx        "%% -n -m noweb -f $$i $$o"    ""
 782 \converter sweave   lyx        "%% -n -m sweave -f $$i $$o"     "needauth"
 783 \converter knitr   lyx        "%% -n -m knitr -f $$i $$o"       "needauth"'''], not_found = 'tex2lyx')
 784     if path == '':
 785         logger.warning("Failed to find tex2lyx on your system.")
 786
 787     #
 788     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 789         rc_entry = [r'''\converter literate   latex      "%%"   ""
 790 \converter literate   pdflatex      "%%"        ""
 791 \converter literate   xetex         "%%"        ""
 792 \converter literate   luatex        "%%"        ""
 793 \converter literate   dviluatex     "%%"        ""'''])
 794     #
 795     checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
 796         rc_entry = [r'''\converter sweave   latex      "%%"     "needauth"
 797 \converter sweave   pdflatex   "%%"     "needauth"
 798 \converter sweave   xetex      "%%"     "needauth"
 799 \converter sweave   luatex     "%%"     "needauth"
 800 \converter sweave   dviluatex  "%%"     "needauth"'''])
 801     #
 802     checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
 803         rc_entry = [r'''\converter knitr   latex      "%%"      "needauth"
 804 \converter knitr   pdflatex   "%%"      "needauth"
 805 \converter knitr   xetex      "%%"      "needauth"
 806 \converter knitr   luatex     "%%"      "needauth"
 807 \converter knitr   dviluatex  "%%"      "needauth"'''])
 808     #
 809     checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
 810         rc_entry = [ r'\converter sweave      r      "%%"    "needauth"' ])
 811     #
 812     checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
 813         rc_entry = [ r'\converter knitr      r      "%%"    "needauth"' ])
 814     #
 815     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
 816         'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
 817         rc_entry = [ r'\converter html       latex      "%%"    ""',
 818                      r'\converter html       latex      "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o"        ""',
 819                      r'\converter html       latex      "%%"    ""',
 820                      r'\converter html       latex      "%%"    ""', '' ])
 821     #
 822     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 823         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 824
 825     # eLyXer: search as an executable (elyxer.py, elyxer)
 826     path, elyxer = checkProg('a LyX -> HTML converter',
 827         ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
 828         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 829     path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
 830         ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
 831         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 832     path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
 833         ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
 834         rc_entry = [ r'\converter lyx      odt2       "%%"      ""' ])
 835     path, elyxer = checkProg('a LyX -> Word converter',
 836         ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
 837         rc_entry = [ r'\converter lyx      word      "%%"       ""' ])
 838     if elyxer.find('elyxer') >= 0:
 839       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 840       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 841     else:
 842       # search for HTML converters other than eLyXer
 843       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 844       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i',
 845           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o',
 846           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 847           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 848       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 849         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 850       else:
 851         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 852       path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'",
 853           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'",
 854           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 855           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 856       if htmlconv.find('htlatex') >= 0:
 857         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 858       else:
 859         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 860
 861
 862     # Check if LyXBlogger is installed
 863     lyxblogger_found = checkModule('lyxblogger')
 864     if lyxblogger_found:
 865       addToRC(r'\Format    blog       blog       "LyXBlogger"           "" "" ""  "document"  ""')
 866       addToRC(r'\converter xhtml      blog       "python -m lyxblogger $$i"       ""')
 867
 868     #
 869     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 870         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 871     #
 872     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 873         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 874     #
 875     checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
 876         rc_entry = [ r'\converter odt3        latex      "%%"   ""' ])
 877     #
 878     checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
 879         rc_entry = [ r'\converter word2      latex      "%%"    ""' ])
 880     # Only define a converter to pdf6, otherwise the odt format could be
 881     # used as an intermediate step for export to pdf, which is not wanted.
 882     checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
 883         rc_entry = [ r'\converter odt        pdf6       "%%"    ""' ])
 884     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 885     # the command mk4ht oolatex $$i has to be used as default,
 886     # but as this would require to have Perl installed, in MiKTeX oolatex is
 887     # directly available as application.
 888     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 889     # Both SuSE and debian have oolatex
 890     checkProg('a LaTeX -> Open Document (tex4ht) converter', [
 891         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 892         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 893         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 894     # On windows it is called latex2rt.exe
 895     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 896         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 897     #
 898     checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
 899         rc_entry = [ r'\converter latex      odt3        "%%"   ""' ])
 900     #
 901     checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
 902         rc_entry = [ r'\converter latex      word2       "%%"   ""' ])
 903     #
 904     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 905         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 906     # Do not define a converter to pdf6, ps is a pure export format
 907     checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
 908         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 909     #
 910     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 911         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 912     #
 913     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 914         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 915     # Need to call ps2eps in a pipe, otherwise it would name the output file
 916     # depending on the extension of the input file. We do not know the input
 917     # file extension in general, so the resultfile= flag would not help.
 918     # Since ps2eps crops the image, we do not use it to convert from ps->eps.
 919     # This would create additional paths in the converter graph with unwanted
 920     # side effects (e.g. ps->pdf via ps2pdf would create a different result
 921     # than ps->eps->pdf via ps2eps and epstopdf).
 922     checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
 923         rc_entry = [ r'\converter eps2       eps      "%%"      ""' ])
 924     #
 925     checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
 926         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 927     # Only define a converter from pdf6 for graphics
 928     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 929         rc_entry = [ r'\converter pdf6        eps        "%%"   ""' ])
 930     # Create one converter for a PDF produced using TeX fonts and one for a
 931     # PDF produced using non-TeX fonts. This does not produce non-unique
 932     # conversion paths, since a given document either uses TeX fonts or not.
 933     checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
 934         rc_entry = [ r'''\converter pdf2   pdf7       "%%"      ""
 935 \converter pdf4   pdf7       "%%"       ""''' ])
 936     # Create one converter for a PDF produced using TeX fonts and one for a
 937     # PDF produced using non-TeX fonts. This does not produce non-unique
 938     # conversion paths, since a given document either uses TeX fonts or not.
 939     checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
 940         rc_entry = [ r'''\converter pdf2   pdf8       "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook"     ""
 941 \converter pdf4   pdf8       "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook"      ""''' ])
 942     #
 943     checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
 944         rc_entry = [ r'\converter pdf2         beamer.info        "%%"  ""' ])
 945     #
 946     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 947         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 948     #
 949     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 950         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 951     #
 952     checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
 953         rc_entry = [ r'\converter dvi        eps3         "%%"  ""' ])
 954     #
 955     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 956         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 957     #
 958     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 959         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 960     #
 961     path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
 962     if fig2dev == "fig2dev":
 963         addToRC(r'''\converter fig        eps        "fig2dev -L eps $$i $$o"   ""
 964 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 965 \converter fig        svg        "fig2dev -L svg $$i $$o"       ""
 966 \converter fig        png        "fig2dev -L png $$i $$o"       ""
 967 \converter svg        pdftex     "python -tt $$s/scripts/svg2pdftex.py $$i $$o" ""
 968 \converter svg        pstex      "python -tt $$s/scripts/svg2pstex.py $$i $$o" ""
 969 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 970 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""''')
 971     #
 972     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 973         rc_entry = [ r'\converter tiff       eps        "%%"    ""'])
 974     #
 975     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 976         rc_entry = [
 977             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 978 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 979 \converter tgif       pdf6       "tgif -print -color -pdf -stdout $$i > $$o"    ""'''])
 980     #
 981     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 982         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 983     #
 984     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 985         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 986     #
 987     checkProg('a WMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 988         rc_entry = [ r'\converter wmf        pdf6        "%%"   ""'])
 989     #
 990     checkProg('an EMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 991         rc_entry = [ r'\converter emf        pdf6        "%%"   ""'])
 992     # Only define a converter to pdf6 for graphics
 993     checkProg('an EPS -> PDF converter', ['epstopdf'],
 994         rc_entry = [ r'\converter eps        pdf6       "epstopdf --outfile=$$o $$i"    ""'])
 995     #
 996     checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
 997         rc_entry = [ r'\converter eps        png        "%%"    ""'])
 998     #
 999     # no agr -> pdf6 converter, since the pdf library used by gracebat is not
1000     # free software and therefore not compiled in in many installations.
1001     # Fortunately, this is not a big problem, because we will use epstopdf to
1002     # convert from agr to pdf6 via eps without loss of quality.
1003     checkProg('a Grace -> Image converter', ['gracebat'],
1004         rc_entry = [
1005             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
1006 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
1007 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
1008 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""'''])
1009     #
1010     checkProg('a Dot -> Image converter', ['dot'],
1011         rc_entry = [
1012             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
1013 \converter dot        png        "dot -Tpng $$i -o $$o" ""'''])
1014     #
1015     path, dia = checkProg('a Dia -> Image converter', ['dia'])
1016     if dia == 'dia':
1017         addToRC(r'''\converter dia        png        "dia -e $$o -t png $$i"    ""
1018 \converter dia        eps        "dia -e $$o -t eps $$i"        ""
1019 \converter dia        svg        "dia -e $$o -t svg $$i"        ""''')
1020
1021     #
1022     # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
1023     # The eps2->eps converter then fixes the bounding box by cropping.
1024     # Although unoconv can convert to png and pdf as well, do not define
1025     # odg->png and odg->pdf converters, since the bb would be too large as well.
1026     checkProg('an OpenDocument -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
1027         rc_entry = [ r'\converter odg        eps2       "%%"    ""'])
1028     #
1029     checkProg('a SVG (compressed) -> SVG converter', ['gunzip -c $$i > $$o'],
1030         rc_entry = [ r'\converter svgz       svg        "%%"    ""'])
1031     #
1032     checkProg('a SVG -> SVG (compressed) converter', ['gzip -c $$i > $$o'],
1033         rc_entry = [ r'\converter svg        svgz       "%%"    ""'])
1034     # Only define a converter to pdf6 for graphics
1035     # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
1036     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1037         rc_entry = [ r'''\converter svg        pdf6       "%%"    ""
1038 \converter svgz       pdf6       "%%"    ""'''],
1039         path = ['', inkscape_path])
1040     #
1041     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1042         rc_entry = [ r'''\converter svg        eps        "%%"    ""
1043 \converter svgz       eps        "%%"    ""'''],
1044         path = ['', inkscape_path])
1045     #
1046     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_name + ' --without-gui --file=$$i --export-png=$$o'],
1047         rc_entry = [ r'''\converter svg        png        "%%"    "",
1048 \converter svgz       png        "%%"    ""'''],
1049         path = ['', inkscape_path])
1050
1051     #
1052     # gnumeric/xls/ods to tex
1053     checkProg('a spreadsheet -> latex converter', ['ssconvert'],
1054        rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1055 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1056 \converter excel  latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1057 \converter excel2 latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1058 \converter gnumeric html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1059 \converter oocalc html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1060 \converter excel  html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1061 \converter excel2 html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1062 '''])
1063
1064     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1065     if (lilypond != ''):
1066         version_string = cmdOutput("lilypond --version")
1067         match = re.match('GNU LilyPond (\S+)', version_string)
1068         if match:
1069             version_number = match.groups()[0]
1070             version = version_number.split('.')
1071             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1072                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps -dsafe --ps $$i"   ""
1073 \converter lilypond   png        "lilypond -dbackend=eps -dsafe --png $$i"      ""''')
1074                 addToRC(r'\converter lilypond   pdf6       "lilypond -dbackend=eps -dsafe --pdf $$i"    ""')
1075                 logger.info('+  found LilyPond version %s.' % version_number)
1076             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1077                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps --safe $$i"  ""
1078 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
1079                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1080                     addToRC(r'\converter lilypond   pdf6       "lilypond -b eps --pdf --safe $$i"       ""')
1081                 logger.info('+  found LilyPond version %s.' % version_number)
1082             else:
1083                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
1084         else:
1085             logger.info('+  found LilyPond, but could not extract version number.')
1086     #
1087     path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1088     if (lilypond_book != ''):
1089         version_string = cmdOutput("lilypond-book --version")
1090         match = re.match('^(\S+)$', version_string)
1091         if match:
1092             version_number = match.groups()[0]
1093             version = version_number.split('.')
1094             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1095                 # Note: The --lily-output-dir flag is required because lilypond-book
1096                 #       does not process input again unless the input has changed,
1097                 #       even if the output format being requested is different. So
1098                 #       once a .eps file exists, lilypond-book won't create a .pdf
1099                 #       even when requested with --pdf. This is a problem if a user
1100                 #       clicks View PDF after having done a View DVI. To circumvent
1101                 #       this, use different output folders for eps and pdf outputs.
1102                 addToRC(r'\converter lilypond-book latex    "lilypond-book --safe --lily-output-dir=ly-eps $$i"                                ""')
1103                 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1104                 addToRC(r'\converter lilypond-book xetex    "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i"  ""')
1105                 addToRC(r'\converter lilypond-book luatex   "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1106                 addToRC(r'\converter lilypond-book dviluatex "lilypond-book --safe --latex-program=dvilualatex --lily-output-dir=ly-eps $$i" ""')
1107                 logger.info('+  found LilyPond-book version %s.' % version_number)
1108             else:
1109                 logger.info('+  found LilyPond-book, but version %s is too old.' % version_number)
1110         else:
1111             logger.info('+  found LilyPond-book, but could not extract version number.')
1112     #
1113     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1114         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""' ])
1115     #
1116     # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1117     # and a zip archive on Windows.
1118     # So, we configure the appropriate version according to the platform.
1119     cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1120     if os.name == 'nt':
1121         addToRC(r'\Format lyxzip     zip    "LyX Archive (zip)"     "" "" ""  "document,menu=export"    ""')
1122         addToRC(cmd % "lyxzip")
1123     else:
1124         addToRC(r'\Format lyxgz      gz     "LyX Archive (tar.gz)"  "" "" ""  "document,menu=export"    ""')
1125         addToRC(cmd % "lyxgz")
1126
1127     #
1128     # FIXME: no rc_entry? comment it out
1129     # checkProg('Image converter', ['convert $$i $$o'])
1130     #
1131     # Entries that do not need checkProg
1132     addToRC(r'''
1133 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
1134 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
1135 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
1136 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -V 1.3 -o $$o $$i"     ""
1137 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o $$i"     ""
1138 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -V 1.5 -o $$o $$i"     ""
1139 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -V 1.6 -o $$o $$i"     ""
1140 \converter lyx        lyx20x     "python -tt $$s/lyx2lyx/lyx2lyx -V 2.0 -o $$o $$i"     ""
1141 \converter lyx        lyx21x     "python -tt $$s/lyx2lyx/lyx2lyx -V 2.1 -o $$o $$i"     ""
1142 \converter lyx        lyx22x     "python -tt $$s/lyx2lyx/lyx2lyx -V 2.2 -o $$o $$i"     ""
1143 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c big5   $$i"   ""
1144 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_jp $$i"   ""
1145 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_kr $$i"   ""
1146 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5   -o $$o $$i"  ""
1147 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -o $$o $$i"  ""
1148 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -o $$o $$i"  ""
1149 \converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py --png"    ""
1150 \converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm"    ""
1151 ''')
1152
1153
1154 def checkDocBook():
1155     ''' Check docbook '''
1156     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
1157         rc_entry = [
1158             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
1159 \converter docbook    html       "sgmltools -b html $$i"        ""
1160 \converter docbook    ps         "sgmltools -b ps $$i"  ""''',
1161             r'''\converter docbook    dvi        "db2dvi $$i"   ""
1162 \converter docbook    html       "db2html $$i"  ""''',
1163             r'''\converter docbook    dvi        ""     ""
1164 \converter docbook    html       "" ""''',
1165             r'''\converter docbook    dvi        ""     ""
1166 \converter docbook    html       ""     ""'''])
1167     #
1168     if DOCBOOK != '':
1169         return ('yes', 'true', '\\def\\hasdocbook{yes}')
1170     else:
1171         return ('no', 'false', '')
1172
1173
1174 def checkOtherEntries():
1175     ''' entries other than Format and Converter '''
1176     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1177         rc_entry = [ r'\chktex_command "%%"' ])
1178     checkProgAlternatives('BibTeX or alternative programs',
1179         ['bibtex', 'bibtex8', 'biber'],
1180         rc_entry = [ r'\bibtex_command "%%"' ],
1181         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1182     checkProg('a specific Japanese BibTeX variant',
1183         ['pbibtex', 'jbibtex', 'bibtex'],
1184         rc_entry = [ r'\jbibtex_command "%%"' ])
1185     checkProgAlternatives('available index processors',
1186         ['texindy', 'makeindex -c -q', 'xindy'],
1187         rc_entry = [ r'\index_command "%%"' ],
1188         alt_rc_entry = [ r'\index_alternatives "%%"' ])
1189     checkProg('an index processor appropriate to Japanese',
1190         ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1191         rc_entry = [ r'\jindex_command "%%"' ])
1192     checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1193         'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1194     checkProg('a nomenclature processor', ['makeindex'],
1195         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1196     ## FIXME: OCTAVE is not used anywhere
1197     # path, OCTAVE = checkProg('Octave', ['octave'])
1198     ## FIXME: MAPLE is not used anywhere
1199     # path, MAPLE = checkProg('Maple', ['maple'])
1200     # Add the rest of the entries (no checkProg is required)
1201     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
1202 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1203 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1204 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
1205 ''')
1206
1207
1208 def processLayoutFile(file, bool_docbook):
1209     ''' process layout file and get a line of result
1210
1211         Declare lines look like this:
1212
1213         \DeclareLaTeXClass[<requirements>]{<description>}
1214
1215         Optionally, a \DeclareCategory line follows:
1216
1217         \DeclareCategory{<category>}
1218
1219         So for example (article.layout, scrbook.layout, svjog.layout)
1220
1221         \DeclareLaTeXClass{article}
1222         \DeclareCategory{Articles}
1223
1224         \DeclareLaTeXClass[scrbook]{book (koma-script)}
1225         \DeclareCategory{Books}
1226
1227         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1228
1229         we'd expect this output:
1230
1231         "article" "article" "article" "false" "article.cls" "Articles"
1232         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1233         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1234     '''
1235     def checkForClassExtension(x):
1236         '''if the extension for a latex class is not
1237            provided, add .cls to the classname'''
1238         if not '.' in x:
1239             return x.strip() + '.cls'
1240         else:
1241             return x.strip()
1242     classname = file.split(os.sep)[-1].split('.')[0]
1243     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1244     p = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1245     q = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1246     classdeclaration = ""
1247     categorydeclaration = '""'
1248     for line in open(file).readlines():
1249         res = p.search(line)
1250         qres = q.search(line)
1251         if res != None:
1252             (classtype, optAll, opt, opt1, desc) = res.groups()
1253             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1254             if opt == None:
1255                 opt = classname
1256                 prereq_latex = checkForClassExtension(classname)
1257             else:
1258                 prereq_list = optAll[1:-1].split(',')
1259                 prereq_list = list(map(checkForClassExtension, prereq_list))
1260                 prereq_latex = ','.join(prereq_list)
1261             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1262             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1263             classdeclaration = ('"%s" "%s" "%s" "%s" "%s"'
1264                                % (classname, opt, desc, avai, prereq))
1265             if categorydeclaration != '""':
1266                 return classdeclaration + " " + categorydeclaration
1267         if qres != None:
1268              categorydeclaration = '"%s"' % (qres.groups()[0])
1269              if classdeclaration != "":
1270                  return classdeclaration + " " + categorydeclaration
1271     if classdeclaration != "":
1272         return classdeclaration + " " + categorydeclaration
1273     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1274     return ""
1275
1276
1277 def checkLatexConfig(check_config, bool_docbook):
1278     ''' Explore the LaTeX configuration
1279         Return None (will be passed to sys.exit()) for success.
1280     '''
1281     msg = 'checking LaTeX configuration... '
1282     # if --without-latex-config is forced, or if there is no previous
1283     # version of textclass.lst, re-generate a default file.
1284     if not os.path.isfile('textclass.lst') or not check_config:
1285         # remove the files only if we want to regenerate
1286         removeFiles(['textclass.lst', 'packages.lst'])
1287         #
1288         # Then, generate a default textclass.lst. In case configure.py
1289         # fails, we still have something to start lyx.
1290         logger.info(msg + ' default values')
1291         logger.info('+checking list of textclasses... ')
1292         tx = open('textclass.lst', 'w')
1293         tx.write('''
1294 # This file declares layouts and their associated definition files
1295 # (include dir. relative to the place where this file is).
1296 # It contains only default values, since chkconfig.ltx could not be run
1297 # for some reason. Run ./configure.py if you need to update it after a
1298 # configuration change.
1299 ''')
1300         # build the list of available layout files and convert it to commands
1301         # for chkconfig.ltx
1302         foundClasses = []
1303         for file in (glob.glob(os.path.join('layouts', '*.layout'))
1304                      + glob.glob(os.path.join(srcdir, 'layouts', '*.layout'))):
1305             # valid file?
1306             if not os.path.isfile(file):
1307                 continue
1308             # get stuff between /xxxx.layout .
1309             classname = file.split(os.sep)[-1].split('.')[0]
1310             #  tr ' -' '__'`
1311             cleanclass = classname.replace(' ', '_')
1312             cleanclass = cleanclass.replace('-', '_')
1313             # make sure the same class is not considered twice
1314             if foundClasses.count(cleanclass) == 0: # not found before
1315                 foundClasses.append(cleanclass)
1316                 retval = processLayoutFile(file, bool_docbook)
1317                 if retval != "":
1318                     tx.write(retval)
1319         tx.close()
1320         logger.info('\tdone')
1321     if not os.path.isfile('packages.lst') or not check_config:
1322         logger.info('+generating default list of packages... ')
1323         removeFiles(['packages.lst'])
1324         tx = open('packages.lst', 'w')
1325         tx.close()
1326         logger.info('\tdone')
1327     if not check_config:
1328         return None
1329     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1330     logger.info(msg + '\tauto')
1331     removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1332         'wrap_chkconfig.ltx'])
1333     rmcopy = False
1334     if not os.path.isfile( 'chkconfig.ltx' ):
1335         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1336         rmcopy = True
1337     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1338     # Construct the list of classes to test for.
1339     # build the list of available layout files and convert it to commands
1340     # for chkconfig.ltx
1341     declare = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1342     category = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1343     empty = re.compile(r'^\s*$')
1344     testclasses = list()
1345     for file in (glob.glob( os.path.join('layouts', '*.layout') )
1346                  + glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) ):
1347         nodeclaration = False
1348         if not os.path.isfile(file):
1349             continue
1350         classname = file.split(os.sep)[-1].split('.')[0]
1351         decline = ""
1352         catline = ""
1353         for line in open(file).readlines():
1354             if not empty.match(line) and line[0] != '#':
1355                 if decline == "":
1356                     logger.warning("Failed to find valid \Declare line "
1357                         "for layout file `%s'.\n\t=> Skipping this file!" % file)
1358                     nodeclaration = True
1359                 # A class, but no category declaration. Just break.
1360                 break
1361             if declare.search(line) != None:
1362                 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1363                 testclasses.append(decline)
1364             elif category.search(line) != None:
1365                 catline = ("\\DeclareCategory{%s}{%s}"
1366                            % (classname, category.search(line).groups()[0]))
1367                 testclasses.append(catline)
1368             if catline == "" or decline == "":
1369                 continue
1370             break
1371         if nodeclaration:
1372             continue
1373     testclasses.sort()
1374     cl = open('chklayouts.tex', 'w')
1375     for line in testclasses:
1376         cl.write(line + '\n')
1377     cl.close()
1378     #
1379     # we have chklayouts.tex, then process it
1380     latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1381     while True:
1382         line = latex_out.readline()
1383         if not line:
1384             break;
1385         if re.match('^\+', line):
1386             logger.info(line.strip())
1387     # if the command succeeds, None will be returned
1388     ret = latex_out.close()
1389     #
1390     # remove the copied file
1391     if rmcopy:
1392         removeFiles( [ 'chkconfig.ltx' ] )
1393     #
1394     # currently, values in chkconfig are only used to set
1395     # \font_encoding
1396     values = {}
1397     for line in open('chkconfig.vars').readlines():
1398         key, val = re.sub('-', '_', line).split('=')
1399         val = val.strip()
1400         values[key] = val.strip("'")
1401     # chk_fontenc may not exist
1402     try:
1403         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1404     except:
1405         pass
1406     # if configure successed, move textclass.lst.tmp to textclass.lst
1407     # and packages.lst.tmp to packages.lst
1408     if (os.path.isfile('textclass.lst.tmp')
1409           and len(open('textclass.lst.tmp').read()) > 0
1410         and os.path.isfile('packages.lst.tmp')
1411           and len(open('packages.lst.tmp').read()) > 0):
1412         shutil.move('textclass.lst.tmp', 'textclass.lst')
1413         shutil.move('packages.lst.tmp', 'packages.lst')
1414     return ret
1415
1416
1417 def checkModulesConfig():
1418   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1419
1420   logger.info('+checking list of modules... ')
1421   tx = open('lyxmodules.lst', 'w')
1422   tx.write('''## This file declares modules and their associated definition files.
1423 ## It has been automatically generated by configure
1424 ## Use "Options/Reconfigure" if you need to update it after a
1425 ## configuration change.
1426 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1427 ''')
1428
1429   # build the list of available modules
1430   seen = []
1431   # note that this searches the local directory first, then the
1432   # system directory. that way, we pick up the user's version first.
1433   for file in (glob.glob( os.path.join('layouts', '*.module') )
1434                + glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) ):
1435       # valid file?
1436       logger.info(file)
1437       if not os.path.isfile(file):
1438           continue
1439
1440       filename = file.split(os.sep)[-1]
1441       filename = filename[:-7]
1442       if seen.count(filename):
1443           continue
1444
1445       seen.append(filename)
1446       retval = processModuleFile(file, filename, bool_docbook)
1447       if retval != "":
1448           tx.write(retval)
1449   tx.close()
1450   logger.info('\tdone')
1451
1452
1453 def processModuleFile(file, filename, bool_docbook):
1454     ''' process module file and get a line of result
1455
1456         The top of a module file should look like this:
1457           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1458           #DescriptionBegin
1459           #...body of description...
1460           #DescriptionEnd
1461           #Requires: [list of required modules]
1462           #Excludes: [list of excluded modules]
1463           #Category: [category name]
1464         The last three lines are optional (though do give a category).
1465         We expect output:
1466           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1467     '''
1468     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1469     rereqs = re.compile(r'#+\s*Requires: (.*)')
1470     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1471     recaty = re.compile(r'#+\s*Category: (.*)')
1472     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1473     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1474
1475     modname = desc = pkgs = req = excl = catgy = ""
1476     readingDescription = False
1477     descLines = []
1478
1479     for line in open(file).readlines():
1480       if readingDescription:
1481         res = redend.search(line)
1482         if res != None:
1483           readingDescription = False
1484           desc = " ".join(descLines)
1485           # Escape quotes.
1486           desc = desc.replace('"', '\\"')
1487           continue
1488         descLines.append(line[1:].strip())
1489         continue
1490       res = redbeg.search(line)
1491       if res != None:
1492         readingDescription = True
1493         continue
1494       res = remods.search(line)
1495       if res != None:
1496           (pkgs, modname) = res.groups()
1497           if pkgs == None:
1498             pkgs = ""
1499           else:
1500             tmp = [s.strip() for s in pkgs.split(",")]
1501             pkgs = ",".join(tmp)
1502           continue
1503       res = rereqs.search(line)
1504       if res != None:
1505         req = res.group(1)
1506         tmp = [s.strip() for s in req.split("|")]
1507         req = "|".join(tmp)
1508         continue
1509       res = reexcs.search(line)
1510       if res != None:
1511         excl = res.group(1)
1512         tmp = [s.strip() for s in excl.split("|")]
1513         excl = "|".join(tmp)
1514         continue
1515       res = recaty.search(line)
1516       if res != None:
1517         catgy = res.group(1)
1518         continue
1519
1520     if modname == "":
1521       logger.warning("Module file without \DeclareLyXModule line. ")
1522       return ""
1523
1524     if pkgs != "":
1525         # this module has some latex dependencies:
1526         # append the dependencies to chkmodules.tex,
1527         # which is \input'ed by chkconfig.ltx
1528         testpackages = list()
1529         for pkg in pkgs.split(","):
1530             if "->" in pkg:
1531                 # this is a converter dependency: skip
1532                 continue
1533             if pkg.endswith(".sty"):
1534                 pkg = pkg[:-4]
1535             testpackages.append("\\TestPackage{%s}" % (pkg,))
1536         cm = open('chkmodules.tex', 'a')
1537         for line in testpackages:
1538             cm.write(line + '\n')
1539         cm.close()
1540
1541     return ('"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n'
1542             % (modname, filename, desc, pkgs, req, excl, catgy))
1543
1544
1545 def checkCiteEnginesConfig():
1546   removeFiles(['lyxciteengines.lst', 'chkciteengines.tex'])
1547
1548   logger.info('+checking list of cite engines... ')
1549   tx = open('lyxciteengines.lst', 'w')
1550   tx.write('''## This file declares cite engines and their associated definition files.
1551 ## It has been automatically generated by configure
1552 ## Use "Options/Reconfigure" if you need to update it after a
1553 ## configuration change.
1554 ## "CiteEngineName" "filename" "CiteEngineType" "CiteFramework" "DefaultBiblio" "Description" "Packages"
1555 ''')
1556
1557   # build the list of available modules
1558   seen = []
1559   # note that this searches the local directory first, then the
1560   # system directory. that way, we pick up the user's version first.
1561   for file in glob.glob( os.path.join('citeengines', '*.citeengine') ) + \
1562       glob.glob( os.path.join(srcdir, 'citeengines', '*.citeengine' ) ) :
1563       # valid file?
1564       logger.info(file)
1565       if not os.path.isfile(file):
1566           continue
1567
1568       filename = file.split(os.sep)[-1]
1569       filename = filename[:-11]
1570       if seen.count(filename):
1571           continue
1572
1573       seen.append(filename)
1574       retval = processCiteEngineFile(file, filename, bool_docbook)
1575       if retval != "":
1576           tx.write(retval)
1577   tx.close()
1578   logger.info('\tdone')
1579
1580
1581 def processCiteEngineFile(file, filename, bool_docbook):
1582     ''' process cite engines file and get a line of result
1583
1584         The top of a cite engine file should look like this:
1585           #\DeclareLyXCiteEngine[LaTeX Packages]{CiteEngineName}
1586           #DescriptionBegin
1587           #...body of description...
1588           #DescriptionEnd
1589         We expect output:
1590           "CiteEngineName" "filename" "CiteEngineType" "CiteFramework" "DefaultBiblio" "Description" "Packages"
1591     '''
1592     remods = re.compile(r'\DeclareLyXCiteEngine\s*(?:\[([^]]*?)\])?{(.*)}')
1593     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1594     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1595     recet = re.compile(r'\s*CiteEngineType\s*(.*)')
1596     redb = re.compile(r'\s*DefaultBiblio\s*(.*)')
1597     resfm = re.compile(r'\s*CiteFramework\s*(.*)')
1598
1599     modname = desc = pkgs = cet = db = cfm = ""
1600     readingDescription = False
1601     descLines = []
1602
1603     for line in open(file).readlines():
1604       if readingDescription:
1605         res = redend.search(line)
1606         if res != None:
1607           readingDescription = False
1608           desc = " ".join(descLines)
1609           # Escape quotes.
1610           desc = desc.replace('"', '\\"')
1611           continue
1612         descLines.append(line[1:].strip())
1613         continue
1614       res = redbeg.search(line)
1615       if res != None:
1616         readingDescription = True
1617         continue
1618       res = remods.search(line)
1619       if res != None:
1620           (pkgs, modname) = res.groups()
1621           if pkgs == None:
1622             pkgs = ""
1623           else:
1624             tmp = [s.strip() for s in pkgs.split(",")]
1625             pkgs = ",".join(tmp)
1626           continue
1627       res = recet.search(line)
1628       if res != None:
1629         cet = res.group(1)
1630         continue
1631       res = redb.search(line)
1632       if res != None:
1633         db = res.group(1)
1634         continue
1635       res = resfm.search(line)
1636       if res != None:
1637         cfm = res.group(1)
1638         continue
1639
1640     if modname == "":
1641       logger.warning("Cite Engine File file without \DeclareLyXCiteEngine line. ")
1642       return ""
1643
1644     if pkgs != "":
1645         # this cite engine has some latex dependencies:
1646         # append the dependencies to chkciteengines.tex,
1647         # which is \input'ed by chkconfig.ltx
1648         testpackages = list()
1649         for pkg in pkgs.split(","):
1650             if "->" in pkg:
1651                 # this is a converter dependency: skip
1652                 continue
1653             if pkg.endswith(".sty"):
1654                 pkg = pkg[:-4]
1655             testpackages.append("\\TestPackage{%s}" % (pkg,))
1656         cm = open('chkciteengines.tex', 'a')
1657         for line in testpackages:
1658             cm.write(line + '\n')
1659         cm.close()
1660
1661     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, cet, cfm, db, desc, pkgs)
1662
1663
1664 def checkTeXAllowSpaces():
1665     ''' Let's check whether spaces are allowed in TeX file names '''
1666     tex_allows_spaces = 'false'
1667     if lyx_check_config:
1668         msg = "Checking whether TeX allows spaces in file names... "
1669         writeToFile('a b.tex', r'\message{working^^J}' )
1670         if LATEX != '':
1671             if os.name == 'nt' or sys.platform == 'cygwin':
1672                 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1673             else:
1674                 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1675         else:
1676             latex_out = ''
1677         if 'working' in latex_out:
1678             logger.info(msg + 'yes')
1679             tex_allows_spaces = 'true'
1680         else:
1681             logger.info(msg + 'no')
1682             tex_allows_spaces = 'false'
1683         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1684         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1685
1686
1687 def rescanTeXFiles():
1688     ''' Run kpsewhich to update information about TeX files '''
1689     logger.info("+Indexing TeX files... ")
1690     if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1691         logger.error("configure: error: cannot find TeXFiles.py script")
1692         sys.exit(1)
1693     interpreter = sys.executable
1694     if interpreter == '':
1695         interpreter = "python"
1696     tfp = cmdOutput(interpreter + " -tt " + '"'
1697                     + os.path.join(srcdir, 'scripts', 'TeXFiles.py') + '"')
1698     logger.info(tfp)
1699     logger.info("\tdone")
1700
1701
1702 def removeTempFiles():
1703     # Final clean-up
1704     if not lyx_keep_temps:
1705         removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1706             'chklayouts.tex', 'chkmodules.tex', 'chkciteengines.tex',
1707             'missfont.log', 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1708
1709
1710 if __name__ == '__main__':
1711     lyx_check_config = True
1712     lyx_kpsewhich = True
1713     outfile = 'lyxrc.defaults'
1714     lyxrc_fileformat = 20
1715     rc_entries = ''
1716     lyx_keep_temps = False
1717     version_suffix = ''
1718     lyx_binary_dir = ''
1719     ## Parse the command line
1720     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1721         if op in [ '-help', '--help', '-h' ]:
1722             print('''Usage: configure [options]
1723 Options:
1724     --help                   show this help lines
1725     --keep-temps             keep temporary files (for debug. purposes)
1726     --without-kpsewhich      do not update TeX files information via kpsewhich
1727     --without-latex-config   do not run LaTeX to determine configuration
1728     --with-version-suffix=suffix suffix of binary installed files
1729     --binary-dir=directory   directory of binary installed files
1730 ''')
1731             sys.exit(0)
1732         elif op == '--without-kpsewhich':
1733             lyx_kpsewhich = False
1734         elif op == '--without-latex-config':
1735             lyx_check_config = False
1736         elif op == '--keep-temps':
1737             lyx_keep_temps = True
1738         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1739             version_suffix = op[22:]
1740         elif op[0:13] == '--binary-dir=':
1741             lyx_binary_dir = op[13:]
1742         else:
1743             print("Unknown option %s" % op)
1744             sys.exit(1)
1745     #
1746     # check if we run from the right directory
1747     srcdir = os.path.dirname(sys.argv[0])
1748     if srcdir == '':
1749         srcdir = '.'
1750     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1751         logger.error("configure: error: cannot find chkconfig.ltx script")
1752         sys.exit(1)
1753     setEnviron()
1754     if sys.platform == 'darwin' and len(version_suffix) > 0:
1755         checkUpgrade()
1756     createDirectories()
1757     dtl_tools = checkDTLtools()
1758     ## Write the first part of outfile
1759     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1760 # script. It contains default settings that have been determined by
1761 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1762 # want to customize LyX, use LyX' Preferences dialog or modify directly
1763 # the "preferences" file instead. Any setting in that file will
1764 # override the values given here.
1765
1766 Format %i
1767
1768 ''' % lyxrc_fileformat)
1769     # check latex
1770     LATEX = checkLatex(dtl_tools)
1771     # check java and perl before any checkProg that may require them
1772     java = checkProg('a java interpreter', ['java'])[1]
1773     perl = checkProg('a perl interpreter', ['perl'])[1]
1774     (inkscape_path, inkscape_name) = os.path.split(checkInkscape())
1775     checkFormatEntries(dtl_tools)
1776     checkConverterEntries()
1777     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1778     checkTeXAllowSpaces()
1779     windows_style_tex_paths = checkTeXPaths()
1780     if windows_style_tex_paths != '':
1781         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1782     checkOtherEntries()
1783     if lyx_kpsewhich:
1784         rescanTeXFiles()
1785     checkModulesConfig()
1786     checkCiteEnginesConfig()
1787     # --without-latex-config can disable lyx_check_config
1788     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1789     removeTempFiles()
1790     # The return error code can be 256. Because most systems expect an error code
1791     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1792     # a None for success, 'ret is not None' is used to exit.
1793     sys.exit(ret is not None)