lib/configure.py

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