lib/configure.py

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