lib/configure.py

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