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