lib/configure.py

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