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