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