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