lib/configure.py

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