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