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