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