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