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,menu=export"'''])
 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 lyx20x     20.lyx  "LyX 2.0.x"             "" ""        ""      "document,menu=export"
 590 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 591 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 592 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 593 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 594 \Format lyxpreview-lytex  lyxpreview-lytex  "LyX Preview (LilyPond book)" "" "" ""      ""
 595 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)"       "" ""  ""      ""
 596 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 597 \Format program    ""      Program                "" "" ""      ""
 598 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 599 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 600 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 601 \Format wordhtml   html   "HTML (MS Word)"        "" "" ""      "document"
 602 ''')
 603
 604
 605 def checkConverterEntries():
 606     ''' Check all converters (\converter entries) '''
 607     checkProg('the pdflatex program', ['pdflatex $$i'],
 608         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex=pdflatex"' ])
 609
 610     checkProg('XeTeX', ['xelatex $$i'],
 611         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex=xelatex"' ])
 612
 613     checkLuatex()
 614
 615     ''' If we're running LyX in-place then tex2lyx will be found in
 616             ../src/tex2lyx. Add this directory to the PATH temporarily and
 617             search for tex2lyx.
 618             Use PATH to avoid any problems with paths-with-spaces.
 619     '''
 620     path_orig = os.environ["PATH"]
 621     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 622         os.pathsep + path_orig
 623
 624 # First search for tex2lyx with version suffix (bug 6986)
 625     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx' + version_suffix, 'tex2lyx'],
 626         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 627 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 628
 629     os.environ["PATH"] = path_orig
 630
 631     #
 632     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 633         rc_entry = [r'''\converter literate   latex      "%%"   ""
 634 \converter literate   pdflatex      "%%"        ""'''])
 635     #
 636     checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
 637         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 638 \converter sweave   pdflatex   "%%"     ""
 639 \converter sweave   xetex      "%%"     ""
 640 \converter sweave   luatex     "%%"     ""'''])
 641     #
 642     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
 643         'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
 644         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 645     #
 646     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 647         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 648
 649     # eLyXer: search as an executable (elyxer.py, elyxer)
 650     path, elyxer = checkProg('a LyX -> HTML converter',
 651         ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
 652         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 653     path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
 654         ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
 655         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 656     if elyxer.find('elyxer') >= 0:
 657       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 658       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 659     else:
 660       # search for HTML converters other than eLyXer
 661       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 662       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 663           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 664           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 665           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 666       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 667         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 668       else:
 669         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 670       path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 671           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 672           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 673           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 674       if htmlconv.find('htlatex') >= 0:
 675         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 676       else:
 677         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 678
 679
 680     # Check if LyXBlogger is installed
 681     lyxblogger_found = checkModule('lyxblogger')
 682     if lyxblogger_found:
 683       addToRC(r'\Format    blog       blog       "LyXBlogger"           "" "" ""  "document"')
 684       addToRC(r'\converter xhtml      blog       "python -m lyxblogger $$i"       ""')
 685
 686     #
 687     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 688         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 689     #
 690     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 691         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 692     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 693     # the command mk4ht oolatex $$i has to be used as default,
 694     # but as this would require to have Perl installed, in MiKTeX oolatex is
 695     # directly available as application.
 696     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 697     # Both SuSE and debian have oolatex
 698     checkProg('a LaTeX -> Open Document converter', [
 699         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 700         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 701         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 702     # On windows it is called latex2rt.exe
 703     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 704         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 705     #
 706     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 707         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 708     #
 709     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 710         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 711     #
 712     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 713         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 714     #
 715     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 716         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 717     #
 718     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 719         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 720     #
 721     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 722         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 723     #
 724     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 725         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 726     #
 727     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 728         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 729     #
 730     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 731         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 732     #
 733     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 734         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 735     #
 736     path, dvipng = checkProg('dvipng', ['dvipng'])
 737     path, dv2dt  = checkProg('DVI to DTL converter', ['dv2dt'])
 738     if dvipng == "dvipng" and dv2dt == 'dv2dt':
 739         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 740     else:
 741         # set empty converter to override the default imagemagick
 742         addToRC(r'\converter lyxpreview png        ""   ""')
 743     if dv2dt == 'dv2dt':
 744         addToRC(r'\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 745     else:
 746         # set empty converter to override the default imagemagick
 747         addToRC(r'\converter lyxpreview ppm        ""   ""')
 748     #
 749     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 750         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 751     #
 752     path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
 753     if fig2dev == "fig2dev":
 754         addToRC(r'''\converter fig        eps        "fig2dev -L eps $$i $$o"   ""
 755 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 756 \converter fig        png        "fig2dev -L png $$i $$o"       ""
 757 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 758 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""''')
 759     #
 760     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 761         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 762     #
 763     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 764         rc_entry = [
 765             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 766 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 767 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 768             ''])
 769     #
 770     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 771         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 772     #
 773     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 774         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 775     #
 776     checkProg('an EPS -> PDF converter', ['epstopdf'],
 777         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 778     #
 779     # no agr -> pdf converter, since the pdf library used by gracebat is not
 780     # free software and therefore not compiled in in many installations.
 781     # Fortunately, this is not a big problem, because we will use epstopdf to
 782     # convert from agr to pdf via eps without loss of quality.
 783     checkProg('a Grace -> Image converter', ['gracebat'],
 784         rc_entry = [
 785             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 786 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 787 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 788 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 789             ''])
 790     #
 791     checkProg('a Dot -> Image converter', ['dot'],
 792         rc_entry = [
 793             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
 794 \converter dot        png        "dot -Tpng $$i -o $$o" ""''',
 795             ''])
 796     #
 797     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 798         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 799     #
 800     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 801         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 802     #
 803     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 804         rc_entry = [ r'\converter svg        pdf        "%%"    ""'])
 805     #
 806     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 807         rc_entry = [ r'\converter svg        eps        "%%"    ""'])
 808     #
 809     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
 810         rc_entry = [ r'\converter svg        png        "%%"    ""'])
 811
 812     #
 813     # gnumeric/xls/ods to tex
 814     checkProg('a spreadsheet -> latex converter', ['ssconvert'],
 815        rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 816 \converter ods latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 817 \converter xls latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
 818 ''])
 819
 820     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 821     if (lilypond != ''):
 822         version_string = cmdOutput("lilypond --version")
 823         match = re.match('GNU LilyPond (\S+)', version_string)
 824         if match:
 825             version_number = match.groups()[0]
 826             version = version_number.split('.')
 827             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 828                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps -dsafe --ps $$i"   ""
 829 \converter lilypond   png        "lilypond -dbackend=eps -dsafe --png $$i"      ""''')
 830                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps -dsafe --pdf $$i"    ""')
 831                 logger.info('+  found LilyPond version %s.' % version_number)
 832             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 833                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps --safe $$i"  ""
 834 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 835                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 836                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf --safe $$i"       ""')
 837                 logger.info('+  found LilyPond version %s.' % version_number)
 838             else:
 839                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 840         else:
 841             logger.info('+  found LilyPond, but could not extract version number.')
 842     #
 843     path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
 844     if (lilypond_book != ''):
 845         version_string = cmdOutput("lilypond-book --version")
 846         match = re.match('^(\S+)$', version_string)
 847         if match:
 848             version_number = match.groups()[0]
 849             version = version_number.split('.')
 850             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
 851                 if dv2dt == 'dv2dt':
 852                     addToRC(r'\converter lyxpreview-lytex ppm "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
 853                 else:
 854                     # set empty converter to override the default imagemagick
 855                     addToRC(r'\converter lyxpreview-lytex ppm "" ""')
 856                 if dvipng == "dvipng" and dv2dt == 'dv2dt':
 857                     addToRC(r'\converter lyxpreview-lytex png "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
 858                 else:
 859                     # set empty converter to override the default imagemagick
 860                     addToRC(r'\converter lyxpreview-lytex png "" ""')
 861                 # Note: The --lily-output-dir flag is required because lilypond-book
 862                 #       does not process input again unless the input has changed,
 863                 #       even if the output format being requested is different. So
 864                 #       once a .eps file exists, lilypond-book won't create a .pdf
 865                 #       even when requested with --pdf. This is a problem if a user
 866                 #       clicks View PDF after having done a View DVI. To circumvent
 867                 #       this, use different output folders for eps and pdf outputs.
 868                 addToRC(r'\converter lilypond-book latex    "lilypond-book --safe --lily-output-dir=ly-eps $$i"                                ""')
 869                 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
 870                 addToRC(r'\converter lilypond-book xetex    "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i"  ""')
 871                 addToRC(r'\converter lilypond-book luatex   "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
 872                 logger.info('+  found LilyPond-book version %s.' % version_number)
 873             else:
 874                 logger.info('+  found LilyPond-book, but version %s is too old.' % version_number)
 875         else:
 876             logger.info('+  found LilyPond-book, but could not extract version number.')
 877     #
 878     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 879         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 880     #
 881     # Currently, lyxpak outputs a gzip compressed tar archive on *nix
 882     # and a zip archive on Windows.
 883     # So, we configure the appropriate version according to the platform.
 884     cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$i" ""'
 885     if os.name == 'nt':
 886         addToRC(r'\Format lyxzip     zip    "LyX Archive (zip)"     "" "" ""  "document,menu=export"')
 887         addToRC(cmd % "lyxzip")
 888     else:
 889         addToRC(r'\Format lyxgz      gz     "LyX Archive (tar.gz)"  "" "" ""  "document,menu=export"')
 890         addToRC(cmd % "lyxgz")
 891
 892     #
 893     # FIXME: no rc_entry? comment it out
 894     # checkProg('Image converter', ['convert $$i $$o'])
 895     #
 896     # Entries that do not need checkProg
 897     addToRC(r'''\converter lyxpreview-platex ppm        "python -tt $$s/scripts/lyxpreview-platex2bitmap.py"    ""
 898 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 899 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 900 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 901 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 902 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 903 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 904 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 905 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 906 \converter lyx        lyx20x     "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o"      ""
 907 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 908 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 909 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 910 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 911 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 912 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 913 ''')
 914
 915
 916 def checkDocBook():
 917     ''' Check docbook '''
 918     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 919         rc_entry = [
 920             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 921 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 922             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 923 \converter docbook    html       "db2html $$i"  ""''',
 924             r'''\converter docbook    dvi        ""     ""
 925 \converter docbook    html       "" ""''',
 926             r'''\converter docbook    dvi        ""     ""
 927 \converter docbook    html       ""     ""'''])
 928     #
 929     if DOCBOOK != '':
 930         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 931     else:
 932         return ('no', 'false', '')
 933
 934
 935 def checkOtherEntries():
 936     ''' entries other than Format and Converter '''
 937     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 938         rc_entry = [ r'\chktex_command "%%"' ])
 939     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 940         rc_entry = [ r'\bibtex_command "%%"' ],
 941         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 942     checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
 943         rc_entry = [ r'\jbibtex_command "%%"' ])
 944     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
 945         rc_entry = [ r'\index_command "%%"' ],
 946         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 947     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 948         rc_entry = [ r'\jindex_command "%%"' ])
 949     path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
 950         rc_entry = [ r'\splitindex_command "%%"' ])
 951     if splitindex == '':
 952         checkProg('the splitindex processor (java version)', ['splitindex.class'],
 953             rc_entry = [ r'\splitindex_command "java splitindex"' ])
 954     checkProg('a nomenclature processor', ['makeindex'],
 955         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 956     ## FIXME: OCTAVE is not used anywhere
 957     # path, OCTAVE = checkProg('Octave', ['octave'])
 958     ## FIXME: MAPLE is not used anywhere
 959     # path, MAPLE = checkProg('Maple', ['maple'])
 960     checkProg('a spool command', ['lp', 'lpr'],
 961         rc_entry = [
 962             r'''\print_spool_printerprefix "-d "
 963 \print_spool_command "lp"''',
 964             r'''\print_spool_printerprefix "-P",
 965 \print_spool_command "lpr"''',
 966             ''])
 967     # Add the rest of the entries (no checkProg is required)
 968     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 969 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 970 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 971 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 972 ''')
 973
 974
 975 def processLayoutFile(file, bool_docbook):
 976     ''' process layout file and get a line of result
 977
 978         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 979
 980         \DeclareLaTeXClass{article}
 981         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 982         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 983
 984         we expect output:
 985
 986         "article" "article" "article" "false" "article.cls"
 987         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
 988         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
 989     '''
 990     def checkForClassExtension(x):
 991         '''if the extension for a latex class is not
 992            provided, add .cls to the classname'''
 993         if not '.' in x:
 994             return x.strip() + '.cls'
 995         else:
 996             return x.strip()
 997     classname = file.split(os.sep)[-1].split('.')[0]
 998     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 999     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1000     for line in open(file).readlines():
1001         res = p.search(line)
1002         if res != None:
1003             (classtype, optAll, opt, opt1, desc) = res.groups()
1004             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1005             if opt == None:
1006                 opt = classname
1007                 prereq_latex = checkForClassExtension(classname)
1008             else:
1009                 prereq_list = optAll[1:-1].split(',')
1010                 prereq_list = map(checkForClassExtension, prereq_list)
1011                 prereq_latex = ','.join(prereq_list)
1012             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1013             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1014             return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
1015     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1016     return ""
1017
1018
1019 def checkLatexConfig(check_config, bool_docbook):
1020     ''' Explore the LaTeX configuration
1021         Return None (will be passed to sys.exit()) for success.
1022     '''
1023     msg = 'checking LaTeX configuration... '
1024     # if --without-latex-config is forced, or if there is no previous
1025     # version of textclass.lst, re-generate a default file.
1026     if not os.path.isfile('textclass.lst') or not check_config:
1027         # remove the files only if we want to regenerate
1028         removeFiles(['textclass.lst', 'packages.lst'])
1029         #
1030         # Then, generate a default textclass.lst. In case configure.py
1031         # fails, we still have something to start lyx.
1032         logger.info(msg + ' default values')
1033         logger.info('+checking list of textclasses... ')
1034         tx = open('textclass.lst', 'w')
1035         tx.write('''
1036 # This file declares layouts and their associated definition files
1037 # (include dir. relative to the place where this file is).
1038 # It contains only default values, since chkconfig.ltx could not be run
1039 # for some reason. Run ./configure.py if you need to update it after a
1040 # configuration change.
1041 ''')
1042         # build the list of available layout files and convert it to commands
1043         # for chkconfig.ltx
1044         foundClasses = []
1045         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1046             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1047             # valid file?
1048             if not os.path.isfile(file):
1049                 continue
1050             # get stuff between /xxxx.layout .
1051             classname = file.split(os.sep)[-1].split('.')[0]
1052             #  tr ' -' '__'`
1053             cleanclass = classname.replace(' ', '_')
1054             cleanclass = cleanclass.replace('-', '_')
1055             # make sure the same class is not considered twice
1056             if foundClasses.count(cleanclass) == 0: # not found before
1057                 foundClasses.append(cleanclass)
1058                 retval = processLayoutFile(file, bool_docbook)
1059                 if retval != "":
1060                     tx.write(retval)
1061         tx.close()
1062         logger.info('\tdone')
1063     if not check_config:
1064         return None
1065     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1066     logger.info(msg + '\tauto')
1067     removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1068         'wrap_chkconfig.ltx'])
1069     rmcopy = False
1070     if not os.path.isfile( 'chkconfig.ltx' ):
1071         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1072         rmcopy = True
1073     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1074     # Construct the list of classes to test for.
1075     # build the list of available layout files and convert it to commands
1076     # for chkconfig.ltx
1077     declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1078     empty = re.compile(r'^\s*$')
1079     testclasses = list()
1080     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1081         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1082         nodeclaration = False
1083         if not os.path.isfile(file):
1084             continue
1085         classname = file.split(os.sep)[-1].split('.')[0]
1086         for line in open(file).readlines():
1087             if not empty.match(line) and line[0] != '#':
1088                 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1089                 nodeclaration = True
1090                 break
1091             if declare.search(line) == None:
1092                 continue
1093             testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1094             break
1095         if nodeclaration:
1096             continue
1097     testclasses.sort()
1098     cl = open('chklayouts.tex', 'w')
1099     for line in testclasses:
1100         cl.write(line + '\n')
1101     cl.close()
1102     #
1103     # we have chklayouts.tex, then process it
1104     fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
1105     while True:
1106         line = fout.readline()
1107         if not line:
1108             break;
1109         if re.match('^\+', line):
1110             logger.info(line.strip())
1111     # if the command succeeds, None will be returned
1112     ret = fout.close()
1113     #
1114     # currently, values in chhkconfig are only used to set
1115     # \font_encoding
1116     values = {}
1117     for line in open('chkconfig.vars').readlines():
1118         key, val = re.sub('-', '_', line).split('=')
1119         val = val.strip()
1120         values[key] = val.strip("'")
1121     # chk_fontenc may not exist
1122     try:
1123         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1124     except:
1125         pass
1126     if rmcopy:   # remove the copied file
1127         removeFiles( [ 'chkconfig.ltx' ] )
1128     # if configure successed, move textclass.lst.tmp to textclass.lst
1129     # and packages.lst.tmp to packages.lst
1130     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1131         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1132         shutil.move('textclass.lst.tmp', 'textclass.lst')
1133         shutil.move('packages.lst.tmp', 'packages.lst')
1134     return ret
1135
1136
1137 def checkModulesConfig():
1138   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1139
1140   logger.info('+checking list of modules... ')
1141   tx = open('lyxmodules.lst', 'w')
1142   tx.write('''## This file declares modules and their associated definition files.
1143 ## It has been automatically generated by configure
1144 ## Use "Options/Reconfigure" if you need to update it after a
1145 ## configuration change.
1146 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1147 ''')
1148
1149   # build the list of available modules
1150   seen = []
1151   # note that this searches the local directory first, then the
1152   # system directory. that way, we pick up the user's version first.
1153   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1154       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1155       # valid file?
1156       logger.info(file)
1157       if not os.path.isfile(file):
1158           continue
1159
1160       filename = file.split(os.sep)[-1]
1161       filename = filename[:-7]
1162       if seen.count(filename):
1163           continue
1164
1165       seen.append(filename)
1166       retval = processModuleFile(file, filename, bool_docbook)
1167       if retval != "":
1168           tx.write(retval)
1169   tx.close()
1170   logger.info('\tdone')
1171
1172
1173 def processModuleFile(file, filename, bool_docbook):
1174     ''' process module file and get a line of result
1175
1176         The top of a module file should look like this:
1177           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1178           #DescriptionBegin
1179           #...body of description...
1180           #DescriptionEnd
1181           #Requires: [list of required modules]
1182           #Excludes: [list of excluded modules]
1183           #Category: [category name]
1184         The last three lines are optional (though do give a category).
1185         We expect output:
1186           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1187     '''
1188     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1189     rereqs = re.compile(r'#+\s*Requires: (.*)')
1190     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1191     recaty = re.compile(r'#+\s*Category: (.*)')
1192     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1193     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1194
1195     modname = desc = pkgs = req = excl = catgy = ""
1196     readingDescription = False
1197     descLines = []
1198
1199     for line in open(file).readlines():
1200       if readingDescription:
1201         res = redend.search(line)
1202         if res != None:
1203           readingDescription = False
1204           desc = " ".join(descLines)
1205           # Escape quotes.
1206           desc = desc.replace('"', '\\"')
1207           continue
1208         descLines.append(line[1:].strip())
1209         continue
1210       res = redbeg.search(line)
1211       if res != None:
1212         readingDescription = True
1213         continue
1214       res = remods.search(line)
1215       if res != None:
1216           (pkgs, modname) = res.groups()
1217           if pkgs == None:
1218             pkgs = ""
1219           else:
1220             tmp = [s.strip() for s in pkgs.split(",")]
1221             pkgs = ",".join(tmp)
1222           continue
1223       res = rereqs.search(line)
1224       if res != None:
1225         req = res.group(1)
1226         tmp = [s.strip() for s in req.split("|")]
1227         req = "|".join(tmp)
1228         continue
1229       res = reexcs.search(line)
1230       if res != None:
1231         excl = res.group(1)
1232         tmp = [s.strip() for s in excl.split("|")]
1233         excl = "|".join(tmp)
1234         continue
1235       res = recaty.search(line)
1236       if res != None:
1237         catgy = res.group(1)
1238         continue
1239
1240     if modname == "":
1241       logger.warning("Module file without \DeclareLyXModule line. ")
1242       return ""
1243
1244     if pkgs != "":
1245         # this module has some latex dependencies:
1246         # append the dependencies to chkmodules.tex,
1247         # which is \input'ed by chkconfig.ltx
1248         testpackages = list()
1249         for pkg in pkgs.split(","):
1250             if "->" in pkg:
1251                 # this is a converter dependency: skip
1252                 continue
1253             if pkg.endswith(".sty"):
1254                 pkg = pkg[:-4]
1255             testpackages.append("\\TestPackage{%s}" % (pkg,))
1256         cm = open('chkmodules.tex', 'a')
1257         for line in testpackages:
1258             cm.write(line + '\n')
1259         cm.close()
1260
1261     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1262
1263
1264 def checkTeXAllowSpaces():
1265     ''' Let's check whether spaces are allowed in TeX file names '''
1266     tex_allows_spaces = 'false'
1267     if lyx_check_config:
1268         msg = "Checking whether TeX allows spaces in file names... "
1269         writeToFile('a b.tex', r'\message{working^^J}' )
1270         if LATEX != '':
1271             if os.name == 'nt' or sys.platform == 'cygwin':
1272                 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1273             else:
1274                 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1275         else:
1276             latex_out = ''
1277         if 'working' in latex_out:
1278             logger.info(msg + 'yes')
1279             tex_allows_spaces = 'true'
1280         else:
1281             logger.info(msg + 'no')
1282             tex_allows_spaces = 'false'
1283         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1284         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1285
1286
1287 def removeTempFiles():
1288     # Final clean-up
1289     if not lyx_keep_temps:
1290         removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1291             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1292             'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1293
1294
1295 if __name__ == '__main__':
1296     lyx_check_config = True
1297     outfile = 'lyxrc.defaults'
1298     lyxrc_fileformat = 1
1299     rc_entries = ''
1300     lyx_keep_temps = False
1301     version_suffix = ''
1302     ## Parse the command line
1303     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1304         if op in [ '-help', '--help', '-h' ]:
1305             print '''Usage: configure [options]
1306 Options:
1307     --help                   show this help lines
1308     --keep-temps             keep temporary files (for debug. purposes)
1309     --without-latex-config   do not run LaTeX to determine configuration
1310     --with-version-suffix=suffix suffix of binary installed files
1311 '''
1312             sys.exit(0)
1313         elif op == '--without-latex-config':
1314             lyx_check_config = False
1315         elif op == '--keep-temps':
1316             lyx_keep_temps = True
1317         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1318             version_suffix = op[22:]
1319         else:
1320             print "Unknown option", op
1321             sys.exit(1)
1322     #
1323     # check if we run from the right directory
1324     srcdir = os.path.dirname(sys.argv[0])
1325     if srcdir == '':
1326         srcdir = '.'
1327     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1328         logger.error("configure: error: cannot find chkconfig.ltx script")
1329         sys.exit(1)
1330     setEnviron()
1331     createDirectories()
1332     dtl_tools = checkDTLtools()
1333     ## Write the first part of outfile
1334     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1335 # script. It contains default settings that have been determined by
1336 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1337 # want to customize LyX, use LyX' Preferences dialog or modify directly
1338 # the "preferences" file instead. Any setting in that file will
1339 # override the values given here.
1340
1341 Format %i
1342
1343 ''' % lyxrc_fileformat)
1344     # check latex
1345     LATEX = checkLatex(dtl_tools)
1346     checkFormatEntries(dtl_tools)
1347     checkConverterEntries()
1348     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1349     checkTeXAllowSpaces()
1350     windows_style_tex_paths = checkTeXPaths()
1351     if windows_style_tex_paths != '':
1352         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1353     checkOtherEntries()
1354     checkModulesConfig()
1355     # --without-latex-config can disable lyx_check_config
1356     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1357     removeTempFiles()
1358     # The return error code can be 256. Because most systems expect an error code
1359     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1360     # a None for success, 'ret is not None' is used to exit.
1361     sys.exit(ret is not None)