lib/configure.py

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