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