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