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