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