lib/configure.py

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