lib/configure.py

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