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