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