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