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