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, svgz" SVG                "" "%%" "%%"    "vector,zipped=native"  "image/svg+xml"'],
 585         path = [inkscape_path])
 586     #
 587     imageformats = r'''\Format bmp        bmp     BMP                    "" "%s"        "%s"    ""      "image/x-bmp"
 588 \Format gif        gif     GIF                    "" "%s"       "%s"    ""      "image/gif"
 589 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""      "image/jpeg"
 590 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""      "image/x-portable-bitmap"
 591 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""      "image/x-portable-graymap"
 592 \Format png        png     PNG                    "" "%s"       "%s"    ""      "image/x-png"
 593 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""      "image/x-portable-pixmap"
 594 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""      "image/tiff"
 595 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""      "image/x-xbitmap"
 596 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""      "image/x-xpixmap"'''
 597     path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
 598     path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
 599     addToRC(imageformats % \
 600         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 601     #
 602     checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 603         'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
 604         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""      ""
 605 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""      ""
 606 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""      ""
 607 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""      ""
 608 \Format docbook    sgml    DocBook                B  "" "%%"    "document,menu=export"  ""
 609 \Format docbook-xml xml   "DocBook (XML)"         "" "" "%%"    "document,menu=export"  "application/docbook+xml"
 610 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"        "text/vnd.graphviz"
 611 \Format dviluatex  tex    "LaTeX (dviluatex)"     "" "" "%%"    "document,menu=export"  ""
 612 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document,menu=export"  ""
 613 \Format literate   nw      NoWeb                  N  "" "%%"    "document,menu=export"  ""
 614 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document,menu=export"  ""
 615 \Format r          R      "R/S code"              "" "" "%%"    "document,menu=export"  ""
 616 \Format knitr      Rnw    "Rnw (knitr)"           "" "" "%%"    "document,menu=export"  ""
 617 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"        "text/x-lilypond"
 618 \Format lilypond-book    lytex "LilyPond book (LaTeX)"   "" ""  "%%"    "document,menu=export"  ""
 619 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document,menu=export"  "text/x-tex"
 620 \Format luatex     tex    "LaTeX (LuaTeX)"        "" "" "%%"    "document,menu=export"  ""
 621 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document,menu=export"  ""
 622 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document,menu=export"  ""
 623 \Format latexclipboard tex "LaTeX (clipboard)"    "" "" "%%"    ""      ""
 624 \Format text       txt    "Plain text"            a  "" "%%"    "document,menu=export"  "text/plain"
 625 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"      ""
 626 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"      ""
 627 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"      ""
 628 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"      ""
 629 \Format beamer.info pdf.info   "Info (Beamer)"         "" ""   "%%"    "document,menu=export"   ""''' ])
 630    #Spreadsheets using ssconvert from gnumeric
 631     checkViewer('gnumeric spreadsheet software', ['gnumeric'],
 632       rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" ""    "%%"   "document"       "application/x-gnumeric"
 633 \Format excel      xls    "Excel spreadsheet"      "" "" "%%"    "document"     "application/vnd.ms-excel"
 634 \Format oocalc     ods    "OpenDocument spreadsheet" "" "" "%%"    "document"   "application/vnd.oasis.opendocument.spreadsheet"'''])
 635  #
 636     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 637         rc_entry = [r'\Format xhtml      xhtml   "LyXHTML"              y "%%" ""    "document,menu=export"     "application/xhtml+xml"'])
 638  #
 639     checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
 640         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 641         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 642         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 643         'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
 644         'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
 645         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""      "text/x-bibtex"''' ])
 646     #
 647     #checkProg('a Postscript interpreter', ['gs'],
 648     #  rc_entry = [ r'\ps_command "%%"' ])
 649     checkViewer('a Postscript previewer', ['kghostview', 'okular', 'qpdfview --unique', 'evince', 'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
 650         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"        "image/x-eps"
 651 \Format eps2       eps    "EPS (uncropped)"       "" "%%"       ""      "vector"        ""
 652 \Format eps3       eps    "EPS (cropped)"         "" "%%"       ""      "document"      ""
 653 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector,menu=export"   "application/postscript"'''])
 654     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 655     # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
 656     checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'qpdfview --unique', 'evince', 'kghostview', 'xpdf', 'SumatraPDF', 'acrobat', 'acroread', 'mupdf', \
 657                     'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
 658         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector,menu=export"   ""
 659 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector,menu=export"   ""
 660 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector,menu=export"   ""
 661 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector,menu=export"   ""
 662 \Format pdf5       pdf    "PDF (LuaTeX)"          u  "%%"       ""      "document,vector,menu=export"   ""
 663 \Format pdf6       pdf    "PDF (graphics)"        "" "%%"       ""      "vector"        "application/pdf"
 664 \Format pdf7       pdf    "PDF (cropped)"         "" "%%"       ""      "document,vector"       ""
 665 \Format pdf8       pdf    "PDF (lower resolution)"         "" "%%"      ""      "document,vector"       ""'''])
 666     #
 667     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
 668         rc_entry = [r'''\Format dvi        dvi     DVI                    D  "%%"       ""      "document,vector,menu=export"   "application/x-dvi"
 669 \Format dvi3       dvi     "DVI (LuaTeX)"          V  "%%"      ""      "document,vector,menu=export"   ""'''])
 670     if dtl_tools:
 671         # Windows only: DraftDVI
 672         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"        ""')
 673     #
 674     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 675         rc_entry = [r'\Format html      "html, htm" HTML                H  "%%" ""      "document,menu=export"  "text/html"'])
 676     #
 677     checkViewerEditor('Noteedit', ['noteedit'],
 678         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"        ""'])
 679     #
 680     checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 681         rc_entry = [r'''\Format odt        odt     "OpenDocument (tex4ht)"  "" "%%"     "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 682 \Format odt2       odt    "OpenDocument (eLyXer)"  "" "%%"      "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 683 \Format odt3       odt    "OpenDocument (Pandoc)"  "" "%%"      "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 684 \Format sxw        sxw    "OpenOffice.Org (sxw)"  "" "" ""      "document,vector"       "application/vnd.sun.xml.writer"'''])
 685     #
 686     checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 687         rc_entry = [r'''\Format rtf        rtf    "Rich Text Format"      "" "%%"       "%%"    "document,vector,menu=export"   "application/rtf"
 688 \Format word       doc    "MS Word"               W  "%%"       "%%"    "document,vector,menu=export"   "application/msword"
 689 \Format word2      docx    "MS Word Office Open XML"               O  "%%"      "%%"    "document,vector,menu=export"   "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
 690     #
 691     # entries that do not need checkProg
 692     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""      ""
 693 \Format csv        csv    "Table (CSV)"           "" "" ""      "document"      "text/csv"
 694 \Format fax        ""      Fax                    "" "" ""      "document"      ""
 695 \Format lyx        lyx     LyX                    "" "" ""      ""      "application/x-lyx"
 696 \Format lyx13x     13.lyx "LyX 1.3.x"             "" "" ""      "document"      ""
 697 \Format lyx14x     14.lyx "LyX 1.4.x"             "" "" ""      "document"      ""
 698 \Format lyx15x     15.lyx "LyX 1.5.x"             "" "" ""      "document"      ""
 699 \Format lyx16x     16.lyx "LyX 1.6.x"             "" "" ""      "document"      ""
 700 \Format lyx20x     20.lyx "LyX 2.0.x"             "" "" ""      "document"      ""
 701 \Format lyx21x     21.lyx "LyX 2.1.x"             "" "" ""      "document,menu=export"  ""
 702 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"      ""
 703 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"      ""
 704 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"      ""
 705 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""      ""
 706 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""      ""
 707 \Format program    ""      Program                "" "" ""      ""      ""
 708 \Format pstex      pstex_t PSTEX                  "" "" ""      ""      ""
 709 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"        "image/x-wmf"
 710 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"        "image/x-emf"
 711 \Format wordhtml  "html, htm" "HTML (MS Word)"    "" "" ""      "document"      ""
 712 ''')
 713
 714
 715 def checkConverterEntries():
 716     ''' Check all converters (\converter entries) '''
 717     checkProg('the pdflatex program', ['pdflatex $$i'],
 718         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex=pdflatex"' ])
 719
 720     checkProg('XeTeX', ['xelatex $$i'],
 721         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex=xelatex"' ])
 722
 723     checkLuatex()
 724
 725     # Look for tex2lyx in this order (see bugs #3308 and #6986):
 726     #   1)  If we're building LyX with autotools then tex2lyx is found
 727     #       in the subdirectory tex2lyx with respect to the binary dir.
 728     #   2)  If we're building LyX with cmake then tex2lyx is found
 729     #       in the binary dir.
 730     #   3)  If LyX was configured with a version suffix then tex2lyx
 731     #       will also have this version suffix.
 732     #   4)  Otherwise always use tex2lyx.
 733     in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
 734     in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
 735
 736     in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
 737     in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
 738
 739     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'],
 740         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 741 \converter latexclipboard lyx        "%% -fixedenc utf8 -f $$i $$o"     ""
 742 \converter literate   lyx        "%% -n -m noweb -f $$i $$o"    ""
 743 \converter sweave   lyx        "%% -n -m sweave -f $$i $$o"     ""
 744 \converter knitr   lyx        "%% -n -m knitr -f $$i $$o"       ""'''], not_found = 'tex2lyx')
 745     if path == '':
 746         logger.warning("Failed to find tex2lyx on your system.")
 747
 748     #
 749     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 750         rc_entry = [r'''\converter literate   latex      "%%"   ""
 751 \converter literate   pdflatex      "%%"        ""
 752 \converter literate   xetex         "%%"        ""
 753 \converter literate   luatex        "%%"        ""'''])
 754     #
 755     checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
 756         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 757 \converter sweave   pdflatex   "%%"     ""
 758 \converter sweave   xetex      "%%"     ""
 759 \converter sweave   luatex     "%%"     ""'''])
 760     #
 761     checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
 762         rc_entry = [r'''\converter knitr   latex      "%%"      ""
 763 \converter knitr   pdflatex   "%%"      ""
 764 \converter knitr   xetex      "%%"      ""
 765 \converter knitr   luatex     "%%"      ""'''])
 766     #
 767     checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
 768         rc_entry = [ r'\converter sweave      r      "%%"    ""' ])
 769     #
 770     checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
 771         rc_entry = [ r'\converter knitr      r      "%%"    ""' ])
 772     #
 773     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
 774         'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
 775         rc_entry = [ r'\converter html       latex      "%%"    ""', \
 776                      r'\converter html       latex      "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o"        ""', \
 777                      r'\converter html       latex      "%%"    ""', \
 778                      r'\converter html       latex      "%%"    ""', '' ])
 779     #
 780     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 781         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 782
 783     # eLyXer: search as an executable (elyxer.py, elyxer)
 784     path, elyxer = checkProg('a LyX -> HTML converter',
 785         ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
 786         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 787     path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
 788         ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
 789         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 790     path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
 791         ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
 792         rc_entry = [ r'\converter lyx      odt2       "%%"      ""' ])
 793     path, elyxer = checkProg('a LyX -> Word converter',
 794         ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
 795         rc_entry = [ r'\converter lyx      word      "%%"       ""' ])
 796     if elyxer.find('elyxer') >= 0:
 797       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 798       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 799     else:
 800       # search for HTML converters other than eLyXer
 801       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 802       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 803           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 804           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 805           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 806       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 807         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 808       else:
 809         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 810       path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 811           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 812           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 813           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 814       if htmlconv.find('htlatex') >= 0:
 815         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 816       else:
 817         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 818
 819
 820     # Check if LyXBlogger is installed
 821     lyxblogger_found = checkModule('lyxblogger')
 822     if lyxblogger_found:
 823       addToRC(r'\Format    blog       blog       "LyXBlogger"           "" "" ""  "document"  ""')
 824       addToRC(r'\converter xhtml      blog       "python -m lyxblogger $$i"       ""')
 825
 826     #
 827     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 828         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 829     #
 830     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 831         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 832     #
 833     checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
 834         rc_entry = [ r'\converter odt3        latex      "%%"   ""' ])
 835     #
 836     checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
 837         rc_entry = [ r'\converter word2      latex      "%%"    ""' ])
 838     # Only define a converter to pdf6, otherwise the odt format could be
 839     # used as an intermediate step for export to pdf, which is not wanted.
 840     checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
 841         rc_entry = [ r'\converter odt        pdf6       "%%"    ""' ])
 842     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 843     # the command mk4ht oolatex $$i has to be used as default,
 844     # but as this would require to have Perl installed, in MiKTeX oolatex is
 845     # directly available as application.
 846     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 847     # Both SuSE and debian have oolatex
 848     checkProg('a LaTeX -> Open Document (tex4ht) converter', [
 849         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 850         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 851         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 852     # On windows it is called latex2rt.exe
 853     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 854         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 855     #
 856     checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
 857         rc_entry = [ r'\converter latex      odt3        "%%"   ""' ])
 858     #
 859     checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
 860         rc_entry = [ r'\converter latex      word2       "%%"   ""' ])
 861     #
 862     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 863         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 864     # Do not define a converter to pdf6, ps is a pure export format
 865     checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
 866         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 867     #
 868     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 869         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 870     #
 871     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 872         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 873     # Need to call ps2eps in a pipe, otherwise it would name the output file
 874     # depending on the extension of the input file. We do not know the input
 875     # file extension in general, so the resultfile= flag would not help.
 876     # Since ps2eps crops the image, we do not use it to convert from ps->eps.
 877     # This would create additional paths in the converter graph with unwanted
 878     # side effects (e.g. ps->pdf via ps2pdf would create a different result
 879     # than ps->eps->pdf via ps2eps and epstopdf).
 880     checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
 881         rc_entry = [ r'\converter eps2       eps      "%%"      ""' ])
 882     #
 883     checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
 884         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 885     # Only define a converter from pdf6 for graphics
 886     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 887         rc_entry = [ r'\converter pdf6        eps        "%%"   ""' ])
 888     # Create one converter for a PDF produced using TeX fonts and one for a
 889     # PDF produced using non-TeX fonts. This does not produce non-unique
 890     # conversion paths, since a given document either uses TeX fonts or not.
 891     checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
 892         rc_entry = [ r'''\converter pdf2   pdf7       "%%"      ""
 893 \converter pdf4   pdf7       "%%"       ""''' ])
 894     # Create one converter for a PDF produced using TeX fonts and one for a
 895     # PDF produced using non-TeX fonts. This does not produce non-unique
 896     # conversion paths, since a given document either uses TeX fonts or not.
 897     checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
 898         rc_entry = [ r'''\converter pdf2   pdf8       "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook"     ""
 899 \converter pdf4   pdf8       "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook"      ""''' ])
 900     #
 901     checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
 902         rc_entry = [ r'\converter pdf2         beamer.info        "%%"  ""' ])
 903     #
 904     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 905         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 906     #
 907     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 908         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 909     #
 910     checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
 911         rc_entry = [ r'\converter dvi        eps3         "%%"  ""' ])
 912     #
 913     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 914         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 915     #
 916     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 917         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 918     #
 919     path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
 920     if fig2dev == "fig2dev":
 921         addToRC(r'''\converter fig        eps        "fig2dev -L eps $$i $$o"   ""
 922 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 923 \converter fig        png        "fig2dev -L png $$i $$o"       ""
 924 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 925 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""''')
 926     #
 927     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 928         rc_entry = [ r'\converter tiff       eps        "%%"    ""'])
 929     #
 930     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 931         rc_entry = [
 932             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 933 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 934 \converter tgif       pdf6       "tgif -print -color -pdf -stdout $$i > $$o"    ""'''])
 935     #
 936     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 937         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 938     #
 939     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 940         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 941     #
 942     checkProg('a WMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 943         rc_entry = [ r'\converter wmf        pdf6        "%%"   ""'])
 944     #
 945     checkProg('an EMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 946         rc_entry = [ r'\converter emf        pdf6        "%%"   ""'])
 947     # Only define a converter to pdf6 for graphics
 948     checkProg('an EPS -> PDF converter', ['epstopdf'],
 949         rc_entry = [ r'\converter eps        pdf6       "epstopdf --outfile=$$o $$i"    ""'])
 950     #
 951     checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
 952         rc_entry = [ r'\converter eps        png        "%%"    ""'])
 953     #
 954     # no agr -> pdf6 converter, since the pdf library used by gracebat is not
 955     # free software and therefore not compiled in in many installations.
 956     # Fortunately, this is not a big problem, because we will use epstopdf to
 957     # convert from agr to pdf6 via eps without loss of quality.
 958     checkProg('a Grace -> Image converter', ['gracebat'],
 959         rc_entry = [
 960             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 961 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 962 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 963 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""'''])
 964     #
 965     checkProg('a Dot -> Image converter', ['dot'],
 966         rc_entry = [
 967             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
 968 \converter dot        png        "dot -Tpng $$i -o $$o" ""'''])
 969     #
 970     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 971         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 972     #
 973     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 974         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 975     # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
 976     # The eps2->eps converter then fixes the bounding box by cropping.
 977     # Although unoconv can convert to png and pdf as well, do not define
 978     # odg->png and odg->pdf converters, since the bb would be too large as well.
 979     checkProg('an OpenDocument -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
 980         rc_entry = [ r'\converter odg        eps2       "%%"    ""'])
 981     # Only define a converter to pdf6 for graphics
 982     # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
 983     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 984         rc_entry = [ r'\converter svg        pdf6       "%%"    ""'],
 985         path = ['', inkscape_path])
 986     #
 987     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 988         rc_entry = [ r'\converter svg        eps        "%%"    ""'],
 989         path = ['', inkscape_path])
 990     #
 991     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_name + ' --without-gui --file=$$i --export-png=$$o'],
 992         rc_entry = [ r'\converter svg        png        "%%"    ""'],
 993         path = ['', inkscape_path])
 994
 995     #
 996     # gnumeric/xls/ods to tex
 997     checkProg('a spreadsheet -> latex converter', ['ssconvert'],
 998        rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 999 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1000 \converter excel  latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
1001
1002     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1003     if (lilypond != ''):
1004         version_string = cmdOutput("lilypond --version")
1005         match = re.match('GNU LilyPond (\S+)', version_string)
1006         if match:
1007             version_number = match.groups()[0]
1008             version = version_number.split('.')
1009             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1010                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps -dsafe --ps $$i"   ""
1011 \converter lilypond   png        "lilypond -dbackend=eps -dsafe --png $$i"      ""''')
1012                 addToRC(r'\converter lilypond   pdf6       "lilypond -dbackend=eps -dsafe --pdf $$i"    ""')
1013                 logger.info('+  found LilyPond version %s.' % version_number)
1014             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1015                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps --safe $$i"  ""
1016 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
1017                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1018                     addToRC(r'\converter lilypond   pdf6       "lilypond -b eps --pdf --safe $$i"       ""')
1019                 logger.info('+  found LilyPond version %s.' % version_number)
1020             else:
1021                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
1022         else:
1023             logger.info('+  found LilyPond, but could not extract version number.')
1024     #
1025     path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1026     if (lilypond_book != ''):
1027         version_string = cmdOutput("lilypond-book --version")
1028         match = re.match('^(\S+)$', version_string)
1029         if match:
1030             version_number = match.groups()[0]
1031             version = version_number.split('.')
1032             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1033                 # Note: The --lily-output-dir flag is required because lilypond-book
1034                 #       does not process input again unless the input has changed,
1035                 #       even if the output format being requested is different. So
1036                 #       once a .eps file exists, lilypond-book won't create a .pdf
1037                 #       even when requested with --pdf. This is a problem if a user
1038                 #       clicks View PDF after having done a View DVI. To circumvent
1039                 #       this, use different output folders for eps and pdf outputs.
1040                 addToRC(r'\converter lilypond-book latex    "lilypond-book --safe --lily-output-dir=ly-eps $$i"                                ""')
1041                 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1042                 addToRC(r'\converter lilypond-book xetex    "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i"  ""')
1043                 addToRC(r'\converter lilypond-book luatex   "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1044                 logger.info('+  found LilyPond-book version %s.' % version_number)
1045             else:
1046                 logger.info('+  found LilyPond-book, but version %s is too old.' % version_number)
1047         else:
1048             logger.info('+  found LilyPond-book, but could not extract version number.')
1049     #
1050     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1051         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""' ])
1052     #
1053     # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1054     # and a zip archive on Windows.
1055     # So, we configure the appropriate version according to the platform.
1056     cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1057     if os.name == 'nt':
1058         addToRC(r'\Format lyxzip     zip    "LyX Archive (zip)"     "" "" ""  "document,menu=export"    ""')
1059         addToRC(cmd % "lyxzip")
1060     else:
1061         addToRC(r'\Format lyxgz      gz     "LyX Archive (tar.gz)"  "" "" ""  "document,menu=export"    ""')
1062         addToRC(cmd % "lyxgz")
1063
1064     #
1065     # FIXME: no rc_entry? comment it out
1066     # checkProg('Image converter', ['convert $$i $$o'])
1067     #
1068     # Entries that do not need checkProg
1069     addToRC(r'''
1070 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
1071 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
1072 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
1073 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
1074 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
1075 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
1076 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
1077 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
1078 \converter lyx        lyx20x     "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o"      ""
1079 \converter lyx        lyx21x     "python -tt $$s/lyx2lyx/lyx2lyx -t 474 $$i > $$o"      ""
1080 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
1081 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
1082 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
1083 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
1084 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
1085 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
1086 \converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py --png"    ""
1087 \converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm"    ""
1088 ''')
1089
1090
1091 def checkDocBook():
1092     ''' Check docbook '''
1093     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
1094         rc_entry = [
1095             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
1096 \converter docbook    html       "sgmltools -b html $$i"        ""
1097 \converter docbook    ps         "sgmltools -b ps $$i"  ""''',
1098             r'''\converter docbook    dvi        "db2dvi $$i"   ""
1099 \converter docbook    html       "db2html $$i"  ""''',
1100             r'''\converter docbook    dvi        ""     ""
1101 \converter docbook    html       "" ""''',
1102             r'''\converter docbook    dvi        ""     ""
1103 \converter docbook    html       ""     ""'''])
1104     #
1105     if DOCBOOK != '':
1106         return ('yes', 'true', '\\def\\hasdocbook{yes}')
1107     else:
1108         return ('no', 'false', '')
1109
1110
1111 def checkOtherEntries():
1112     ''' entries other than Format and Converter '''
1113     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1114         rc_entry = [ r'\chktex_command "%%"' ])
1115     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
1116         rc_entry = [ r'\bibtex_command "%%"' ],
1117         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1118     checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
1119         rc_entry = [ r'\jbibtex_command "%%"' ])
1120     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
1121         rc_entry = [ r'\index_command "%%"' ],
1122         alt_rc_entry = [ r'\index_alternatives "%%"' ])
1123     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1124         rc_entry = [ r'\jindex_command "%%"' ])
1125     checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1126         'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1127     checkProg('a nomenclature processor', ['makeindex'],
1128         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1129     ## FIXME: OCTAVE is not used anywhere
1130     # path, OCTAVE = checkProg('Octave', ['octave'])
1131     ## FIXME: MAPLE is not used anywhere
1132     # path, MAPLE = checkProg('Maple', ['maple'])
1133     # Add the rest of the entries (no checkProg is required)
1134     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
1135 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1136 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1137 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
1138 ''')
1139
1140
1141 def processLayoutFile(file, bool_docbook):
1142     ''' process layout file and get a line of result
1143
1144         Declare lines look like this:
1145
1146         \DeclareLaTeXClass[<requirements>]{<description>}
1147
1148         Optionally, a \DeclareCategory line follows:
1149
1150         \DeclareCategory{<category>}
1151
1152         So for example (article.layout, scrbook.layout, svjog.layout)
1153
1154         \DeclareLaTeXClass{article}
1155         \DeclareCategory{Articles}
1156
1157         \DeclareLaTeXClass[scrbook]{book (koma-script)}
1158         \DeclareCategory{Books}
1159
1160         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1161
1162         we'd expect this output:
1163
1164         "article" "article" "article" "false" "article.cls" "Articles"
1165         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1166         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1167     '''
1168     def checkForClassExtension(x):
1169         '''if the extension for a latex class is not
1170            provided, add .cls to the classname'''
1171         if not '.' in x:
1172             return x.strip() + '.cls'
1173         else:
1174             return x.strip()
1175     classname = file.split(os.sep)[-1].split('.')[0]
1176     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1177     p = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1178     q = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1179     classdeclaration = ""
1180     categorydeclaration = '""'
1181     for line in open(file).readlines():
1182         res = p.search(line)
1183         qres = q.search(line)
1184         if res != None:
1185             (classtype, optAll, opt, opt1, desc) = res.groups()
1186             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1187             if opt == None:
1188                 opt = classname
1189                 prereq_latex = checkForClassExtension(classname)
1190             else:
1191                 prereq_list = optAll[1:-1].split(',')
1192                 prereq_list = map(checkForClassExtension, prereq_list)
1193                 prereq_latex = ','.join(prereq_list)
1194             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1195             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1196             classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1197             if categorydeclaration != '""':
1198                 return classdeclaration + " " + categorydeclaration
1199         if qres != None:
1200              categorydeclaration = '"%s"' % (qres.groups()[0])
1201              if classdeclaration != "":
1202                  return classdeclaration + " " + categorydeclaration
1203     if classdeclaration != "":
1204         return classdeclaration + " " + categorydeclaration
1205     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1206     return ""
1207
1208
1209 def checkLatexConfig(check_config, bool_docbook):
1210     ''' Explore the LaTeX configuration
1211         Return None (will be passed to sys.exit()) for success.
1212     '''
1213     msg = 'checking LaTeX configuration... '
1214     # if --without-latex-config is forced, or if there is no previous
1215     # version of textclass.lst, re-generate a default file.
1216     if not os.path.isfile('textclass.lst') or not check_config:
1217         # remove the files only if we want to regenerate
1218         removeFiles(['textclass.lst', 'packages.lst'])
1219         #
1220         # Then, generate a default textclass.lst. In case configure.py
1221         # fails, we still have something to start lyx.
1222         logger.info(msg + ' default values')
1223         logger.info('+checking list of textclasses... ')
1224         tx = open('textclass.lst', 'w')
1225         tx.write('''
1226 # This file declares layouts and their associated definition files
1227 # (include dir. relative to the place where this file is).
1228 # It contains only default values, since chkconfig.ltx could not be run
1229 # for some reason. Run ./configure.py if you need to update it after a
1230 # configuration change.
1231 ''')
1232         # build the list of available layout files and convert it to commands
1233         # for chkconfig.ltx
1234         foundClasses = []
1235         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1236             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1237             # valid file?
1238             if not os.path.isfile(file):
1239                 continue
1240             # get stuff between /xxxx.layout .
1241             classname = file.split(os.sep)[-1].split('.')[0]
1242             #  tr ' -' '__'`
1243             cleanclass = classname.replace(' ', '_')
1244             cleanclass = cleanclass.replace('-', '_')
1245             # make sure the same class is not considered twice
1246             if foundClasses.count(cleanclass) == 0: # not found before
1247                 foundClasses.append(cleanclass)
1248                 retval = processLayoutFile(file, bool_docbook)
1249                 if retval != "":
1250                     tx.write(retval)
1251         tx.close()
1252         logger.info('\tdone')
1253     if not os.path.isfile('packages.lst') or not check_config:
1254         logger.info('+generating default list of packages... ')
1255         removeFiles(['packages.lst'])
1256         tx = open('packages.lst', 'w')
1257         tx.close()
1258         logger.info('\tdone')
1259     if not check_config:
1260         return None
1261     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1262     logger.info(msg + '\tauto')
1263     removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1264         'wrap_chkconfig.ltx'])
1265     rmcopy = False
1266     if not os.path.isfile( 'chkconfig.ltx' ):
1267         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1268         rmcopy = True
1269     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1270     # Construct the list of classes to test for.
1271     # build the list of available layout files and convert it to commands
1272     # for chkconfig.ltx
1273     declare = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1274     category = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1275     empty = re.compile(r'^\s*$')
1276     testclasses = list()
1277     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1278         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1279         nodeclaration = False
1280         if not os.path.isfile(file):
1281             continue
1282         classname = file.split(os.sep)[-1].split('.')[0]
1283         decline = ""
1284         catline = ""
1285         for line in open(file).readlines():
1286             if not empty.match(line) and line[0] != '#':
1287                 if decline == "":
1288                     logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1289                     nodeclaration = True
1290                 # A class, but no category declaration. Just break.
1291                 break
1292             if declare.search(line) != None:
1293                 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1294                 testclasses.append(decline)
1295             elif category.search(line) != None:
1296                 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1297                 testclasses.append(catline)
1298             if catline == "" or decline == "":
1299                 continue
1300             break
1301         if nodeclaration:
1302             continue
1303     testclasses.sort()
1304     cl = open('chklayouts.tex', 'w')
1305     for line in testclasses:
1306         cl.write(line + '\n')
1307     cl.close()
1308     #
1309     # we have chklayouts.tex, then process it
1310     latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1311     while True:
1312         line = latex_out.readline()
1313         if not line:
1314             break;
1315         if re.match('^\+', line):
1316             logger.info(line.strip())
1317     # if the command succeeds, None will be returned
1318     ret = latex_out.close()
1319     #
1320     # remove the copied file
1321     if rmcopy:
1322         removeFiles( [ 'chkconfig.ltx' ] )
1323     #
1324     # currently, values in chkconfig are only used to set
1325     # \font_encoding
1326     values = {}
1327     for line in open('chkconfig.vars').readlines():
1328         key, val = re.sub('-', '_', line).split('=')
1329         val = val.strip()
1330         values[key] = val.strip("'")
1331     # chk_fontenc may not exist
1332     try:
1333         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1334     except:
1335         pass
1336     # if configure successed, move textclass.lst.tmp to textclass.lst
1337     # and packages.lst.tmp to packages.lst
1338     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1339         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1340         shutil.move('textclass.lst.tmp', 'textclass.lst')
1341         shutil.move('packages.lst.tmp', 'packages.lst')
1342     return ret
1343
1344
1345 def checkModulesConfig():
1346   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1347
1348   logger.info('+checking list of modules... ')
1349   tx = open('lyxmodules.lst', 'w')
1350   tx.write('''## This file declares modules and their associated definition files.
1351 ## It has been automatically generated by configure
1352 ## Use "Options/Reconfigure" if you need to update it after a
1353 ## configuration change.
1354 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1355 ''')
1356
1357   # build the list of available modules
1358   seen = []
1359   # note that this searches the local directory first, then the
1360   # system directory. that way, we pick up the user's version first.
1361   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1362       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1363       # valid file?
1364       logger.info(file)
1365       if not os.path.isfile(file):
1366           continue
1367
1368       filename = file.split(os.sep)[-1]
1369       filename = filename[:-7]
1370       if seen.count(filename):
1371           continue
1372
1373       seen.append(filename)
1374       retval = processModuleFile(file, filename, bool_docbook)
1375       if retval != "":
1376           tx.write(retval)
1377   tx.close()
1378   logger.info('\tdone')
1379
1380
1381 def processModuleFile(file, filename, bool_docbook):
1382     ''' process module file and get a line of result
1383
1384         The top of a module file should look like this:
1385           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1386           #DescriptionBegin
1387           #...body of description...
1388           #DescriptionEnd
1389           #Requires: [list of required modules]
1390           #Excludes: [list of excluded modules]
1391           #Category: [category name]
1392         The last three lines are optional (though do give a category).
1393         We expect output:
1394           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1395     '''
1396     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1397     rereqs = re.compile(r'#+\s*Requires: (.*)')
1398     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1399     recaty = re.compile(r'#+\s*Category: (.*)')
1400     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1401     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1402
1403     modname = desc = pkgs = req = excl = catgy = ""
1404     readingDescription = False
1405     descLines = []
1406
1407     for line in open(file).readlines():
1408       if readingDescription:
1409         res = redend.search(line)
1410         if res != None:
1411           readingDescription = False
1412           desc = " ".join(descLines)
1413           # Escape quotes.
1414           desc = desc.replace('"', '\\"')
1415           continue
1416         descLines.append(line[1:].strip())
1417         continue
1418       res = redbeg.search(line)
1419       if res != None:
1420         readingDescription = True
1421         continue
1422       res = remods.search(line)
1423       if res != None:
1424           (pkgs, modname) = res.groups()
1425           if pkgs == None:
1426             pkgs = ""
1427           else:
1428             tmp = [s.strip() for s in pkgs.split(",")]
1429             pkgs = ",".join(tmp)
1430           continue
1431       res = rereqs.search(line)
1432       if res != None:
1433         req = res.group(1)
1434         tmp = [s.strip() for s in req.split("|")]
1435         req = "|".join(tmp)
1436         continue
1437       res = reexcs.search(line)
1438       if res != None:
1439         excl = res.group(1)
1440         tmp = [s.strip() for s in excl.split("|")]
1441         excl = "|".join(tmp)
1442         continue
1443       res = recaty.search(line)
1444       if res != None:
1445         catgy = res.group(1)
1446         continue
1447
1448     if modname == "":
1449       logger.warning("Module file without \DeclareLyXModule line. ")
1450       return ""
1451
1452     if pkgs != "":
1453         # this module has some latex dependencies:
1454         # append the dependencies to chkmodules.tex,
1455         # which is \input'ed by chkconfig.ltx
1456         testpackages = list()
1457         for pkg in pkgs.split(","):
1458             if "->" in pkg:
1459                 # this is a converter dependency: skip
1460                 continue
1461             if pkg.endswith(".sty"):
1462                 pkg = pkg[:-4]
1463             testpackages.append("\\TestPackage{%s}" % (pkg,))
1464         cm = open('chkmodules.tex', 'a')
1465         for line in testpackages:
1466             cm.write(line + '\n')
1467         cm.close()
1468
1469     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1470
1471
1472 def checkTeXAllowSpaces():
1473     ''' Let's check whether spaces are allowed in TeX file names '''
1474     tex_allows_spaces = 'false'
1475     if lyx_check_config:
1476         msg = "Checking whether TeX allows spaces in file names... "
1477         writeToFile('a b.tex', r'\message{working^^J}' )
1478         if LATEX != '':
1479             if os.name == 'nt' or sys.platform == 'cygwin':
1480                 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1481             else:
1482                 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1483         else:
1484             latex_out = ''
1485         if 'working' in latex_out:
1486             logger.info(msg + 'yes')
1487             tex_allows_spaces = 'true'
1488         else:
1489             logger.info(msg + 'no')
1490             tex_allows_spaces = 'false'
1491         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1492         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1493
1494
1495 def rescanTeXFiles():
1496     ''' Run kpsewhich to update information about TeX files '''
1497     logger.info("+Indexing TeX files... ")
1498     if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1499         logger.error("configure: error: cannot find TeXFiles.py script")
1500         sys.exit(1)
1501     interpreter = sys.executable
1502     if interpreter == '':
1503         interpreter = "python"
1504     tfp = cmdOutput(interpreter + " -tt " + '"' + os.path.join(srcdir, 'scripts', 'TeXFiles.py') + '"')
1505     logger.info(tfp)
1506     logger.info("\tdone")
1507
1508
1509 def removeTempFiles():
1510     # Final clean-up
1511     if not lyx_keep_temps:
1512         removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1513             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1514             'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1515
1516
1517 if __name__ == '__main__':
1518     lyx_check_config = True
1519     lyx_kpsewhich = True
1520     outfile = 'lyxrc.defaults'
1521     lyxrc_fileformat = 19
1522     rc_entries = ''
1523     lyx_keep_temps = False
1524     version_suffix = ''
1525     lyx_binary_dir = ''
1526     ## Parse the command line
1527     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1528         if op in [ '-help', '--help', '-h' ]:
1529             print '''Usage: configure [options]
1530 Options:
1531     --help                   show this help lines
1532     --keep-temps             keep temporary files (for debug. purposes)
1533     --without-kpsewhich      do not update TeX files information via kpsewhich
1534     --without-latex-config   do not run LaTeX to determine configuration
1535     --with-version-suffix=suffix suffix of binary installed files
1536     --binary-dir=directory   directory of binary installed files
1537 '''
1538             sys.exit(0)
1539         elif op == '--without-kpsewhich':
1540             lyx_kpsewhich = False
1541         elif op == '--without-latex-config':
1542             lyx_check_config = False
1543         elif op == '--keep-temps':
1544             lyx_keep_temps = True
1545         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1546             version_suffix = op[22:]
1547         elif op[0:13] == '--binary-dir=':
1548             lyx_binary_dir = op[13:]
1549         else:
1550             print "Unknown option", op
1551             sys.exit(1)
1552     #
1553     # check if we run from the right directory
1554     srcdir = os.path.dirname(sys.argv[0])
1555     if srcdir == '':
1556         srcdir = '.'
1557     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1558         logger.error("configure: error: cannot find chkconfig.ltx script")
1559         sys.exit(1)
1560     setEnviron()
1561     if sys.platform == 'darwin' and len(version_suffix) > 0:
1562         checkUpgrade()
1563     createDirectories()
1564     dtl_tools = checkDTLtools()
1565     ## Write the first part of outfile
1566     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1567 # script. It contains default settings that have been determined by
1568 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1569 # want to customize LyX, use LyX' Preferences dialog or modify directly
1570 # the "preferences" file instead. Any setting in that file will
1571 # override the values given here.
1572
1573 Format %i
1574
1575 ''' % lyxrc_fileformat)
1576     # check latex
1577     LATEX = checkLatex(dtl_tools)
1578     # check java and perl before any checkProg that may require them
1579     java = checkProg('a java interpreter', ['java'])[1]
1580     perl = checkProg('a perl interpreter', ['perl'])[1]
1581     (inkscape_path, inkscape_name) = os.path.split(checkInkscape())
1582     checkFormatEntries(dtl_tools)
1583     checkConverterEntries()
1584     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1585     checkTeXAllowSpaces()
1586     windows_style_tex_paths = checkTeXPaths()
1587     if windows_style_tex_paths != '':
1588         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1589     checkOtherEntries()
1590     if lyx_kpsewhich:
1591         rescanTeXFiles()
1592     checkModulesConfig()
1593     # --without-latex-config can disable lyx_check_config
1594     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1595     removeTempFiles()
1596     # The return error code can be 256. Because most systems expect an error code
1597     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1598     # a None for success, 'ret is not None' is used to exit.
1599     sys.exit(ret is not None)