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', 'platex $$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             LATEX = PLATEX
 396         else:
 397             PLATEX = ''
 398             removeFiles(['chklatex.ltx', 'chklatex.log'])
 399     #-----------------------------------------------------------------
 400     # use LATEX to convert from latex to dvi if PPLATEX is not available
 401     if PPLATEX == '':
 402         PPLATEX = LATEX
 403     if dtl_tools:
 404         # Windows only: DraftDVI
 405         addToRC(r'''\converter latex      dvi2       "%s"       "latex"
 406 \converter dvi2       dvi        "python -tt $$s/scripts/clean_dvi.py $$i $$o"  ""''' % PPLATEX)
 407     else:
 408         addToRC(r'\converter latex      dvi        "%s" "latex"' % PPLATEX)
 409     # no latex
 410     if LATEX != '':
 411         # Check if latex is usable
 412         writeToFile('chklatex.ltx', '''
 413 \\nonstopmode\\makeatletter
 414 \\ifx\\undefined\\documentclass\\else
 415   \\message{ThisIsLaTeX2e}
 416 \\fi
 417 \\@@end
 418 ''')
 419         # run latex on chklatex.ltx and check result
 420         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 421             # valid latex2e
 422             return LATEX
 423         else:
 424             logger.warning("Latex not usable (not LaTeX2e) ")
 425         # remove temporary files
 426         removeFiles(['chklatex.ltx', 'chklatex.log'])
 427     return ''
 428
 429
 430 def checkFormatEntries(dtl_tools):
 431     ''' Check all formats (\Format entries) '''
 432     checkViewerEditor('a Tgif viewer and editor', ['tgif'],
 433         rc_entry = [r'\Format tgif       obj     Tgif                   "" "%%" "%%"    "vector"'])
 434     #
 435     checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
 436         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"'])
 437     #
 438     checkViewerEditor('a Dia viewer and editor', ['dia'],
 439         rc_entry = [r'\Format dia        dia     DIA                    "" "%%" "%%"    "vector"'])
 440     #
 441     checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
 442         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"'])
 443     #
 444     checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 445         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""'])
 446     #
 447     path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'],
 448         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 449 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 450 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 451 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 452 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 453 \Format png        png     PNG                    "" "%s"       "%s"    ""
 454 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 455 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 456 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 457 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 458     path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'],
 459         rc_entry = [r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 460 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 461 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 462 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 463 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 464 \Format png        png     PNG                    "" "%s"       "%s"    ""
 465 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 466 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 467 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 468 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""'''])
 469     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 470 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 471 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 472 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 473 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 474 \Format png        png     PNG                    "" "%s"       "%s"    ""
 475 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 476 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 477 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 478 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 479         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 480     #
 481     checkViewerEditor('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 482         'nedit', 'gedit', 'notepad'],
 483         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 484 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 485 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 486 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 487 \Format docbook    sgml    DocBook                B  "" "%%"    "document"
 488 \Format docbook-xml xml   "Docbook (XML)"         "" "" "%%"    "document"
 489 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"
 490 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document"
 491 \Format literate   nw      NoWeb                  N  "" "%%"    "document"
 492 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document"
 493 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"
 494 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document"
 495 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document"
 496 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document"
 497 \Format text       txt    "Plain text"            a  "" "%%"    "document"
 498 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 499 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 500 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 501 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"''' ])
 502  #
 503     path, xhtmlview = checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 504         rc_entry = [r'\Format xhtml      html   "LyX HTML"              "" "%%" ""    "document"'])
 505     if xhtmlview == "":
 506         addToRC(r'\Format xhtml      html   "LyX HTML"              "" "" "%%"  "document"')
 507  #
 508     checkEditor('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
 509         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 510         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 511         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 512         'nedit', 'gedit', 'notepad'],
 513         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""''' ])
 514     #
 515     #checkProg('a Postscript interpreter', ['gs'],
 516     #  rc_entry = [ r'\ps_command "%%"' ])
 517     checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
 518         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"
 519 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector"'''])
 520     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 521     checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 522                     'gv', 'ghostview'],
 523         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector"
 524 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector"
 525 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector"
 526 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector"'''])
 527     #
 528     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
 529         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document,vector"'])
 530     if dtl_tools:
 531         # Windows only: DraftDVI
 532         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"')
 533     #
 534     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 535         rc_entry = [r'\Format html       html    HTML                   H  "%%" ""      "document"'])
 536     #
 537     checkViewerEditor('Noteedit', ['noteedit'],
 538         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"'])
 539     #
 540     checkViewerEditor('an OpenDocument viewer', ['swriter', 'oowriter'],
 541         rc_entry = [r'\Format odt        odt     OpenDocument           "" "%%" "%%"    "document,vector"'])
 542     #
 543     # entried that do not need checkProg
 544     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 545 \Format csv        csv    "Table (CSV)"  "" ""  ""      "document"
 546 \Format fax        ""      Fax                    "" "" ""      "document"
 547 \Format lyx        lyx     LyX                    "" "" ""      ""
 548 \Format lyx13x     lyx13  "LyX 1.3.x"             "" "" ""      "document"
 549 \Format lyx14x     lyx14  "LyX 1.4.x"             "" "" ""      "document"
 550 \Format lyx15x     lyx15  "LyX 1.5.x"             "" "" ""      "document"
 551 \Format lyx16x     lyx16  "LyX 1.6.x"             "" "" ""      "document"
 552 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 553 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 554 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 555 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 556 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)"       "" ""  ""      ""
 557 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 558 \Format program    ""      Program                "" "" ""      ""
 559 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 560 \Format rtf        rtf    "Rich Text Format"      "" "" ""      "document,vector"
 561 \Format sxw        sxw    "OpenOffice.Org (sxw)"  ""  ""        ""      "document,vector"
 562 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 563 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 564 \Format word       doc    "MS Word"               W  "" ""      "document,vector"
 565 \Format wordhtml   html   "HTML (MS Word)"        "" "" ""      "document"
 566 ''')
 567
 568
 569 def checkConverterEntries():
 570     ''' Check all converters (\converter entries) '''
 571     checkProg('the pdflatex program', ['pdflatex $$i'],
 572         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 573
 574     checkProg('XeTeX', ['xelatex $$i'],
 575         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex"' ])
 576
 577     ''' If we're running LyX in-place then tex2lyx will be found in
 578             ../src/tex2lyx. Add this directory to the PATH temporarily and
 579             search for tex2lyx.
 580             Use PATH to avoid any problems with paths-with-spaces.
 581     '''
 582     path_orig = os.environ["PATH"]
 583     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 584         os.pathsep + path_orig
 585
 586     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 587         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 588 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 589
 590     os.environ["PATH"] = path_orig
 591
 592     #
 593     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 594         rc_entry = [r'''\converter literate   latex      "%%"   ""
 595 \converter literate   pdflatex      "%%"        ""'''])
 596     #
 597     checkProg('a Sweave -> LaTeX converter', ['R CMD Sweave $$i'],
 598         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 599 \converter sweave   pdflatex      "%%"  ""'''])
 600     #
 601     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
 602         'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
 603         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 604     #
 605     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 606         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 607     #
 608     path, elyxer = checkProg('a LyX -> HTML converter', ['elyxer.py', 'elyxer'],
 609       rc_entry = [ r'\converter lyx      html       "python -tt $$s/scripts/elyxer.py --directory $$r $$i $$o"  ""' ])
 610     if elyxer.find('elyxer') >= 0:
 611       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 612     else:
 613       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 614       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 615           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 616           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 617           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 618       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 619         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 620       else:
 621         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 622
 623     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 624     path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 625         "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 626         "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 627         rc_entry = [ r'\converter latex      wordhtml   "%%"    "needaux"' ])
 628     if htmlconv.find('htlatex') >= 0:
 629       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 630     #
 631     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 632         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 633     #
 634     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 635         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 636     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 637     # the command mk4ht oolatex $$i has to be used as default,
 638     # but as this would require to have Perl installed, in MiKTeX oolatex is
 639     # directly available as application.
 640     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 641     # Both SuSE and debian have oolatex
 642     checkProg('a LaTeX -> Open Document converter', [
 643         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 644         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 645         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 646     # On windows it is called latex2rt.exe
 647     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 648         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 649     #
 650     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 651         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 652     #
 653     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 654         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 655     #
 656     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 657         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 658     #
 659     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 660         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 661     #
 662     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 663         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 664     #
 665     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 666         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 667     #
 668     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 669         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 670     #
 671     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 672         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 673     #
 674     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 675         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 676     #
 677     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 678         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 679     #
 680     path, dvipng = checkProg('dvipng', ['dvipng'])
 681     if dvipng == "dvipng":
 682         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 683     else:
 684         addToRC(r'\converter lyxpreview png        ""   ""')
 685     #
 686     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 687         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 688     #
 689     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 690         rc_entry = [
 691             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 692 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 693 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 694             ''])
 695     #
 696     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 697         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 698     #
 699     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 700         rc_entry = [
 701             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 702 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 703 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 704             ''])
 705     #
 706     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 707         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 708     #
 709     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 710         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 711     #
 712     checkProg('an EPS -> PDF converter', ['epstopdf'],
 713         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 714     #
 715     # no agr -> pdf converter, since the pdf library used by gracebat is not
 716     # free software and therefore not compiled in in many installations.
 717     # Fortunately, this is not a big problem, because we will use epstopdf to
 718     # convert from agr to pdf via eps without loss of quality.
 719     checkProg('a Grace -> Image converter', ['gracebat'],
 720         rc_entry = [
 721             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 722 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 723 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 724 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 725             ''])
 726     #
 727     checkProg('a Dot -> PDF converter', ['dot -Tpdf $$i -o $$o'],
 728         rc_entry = [ r'\converter dot        pdf        "%%"    ""'])
 729     #
 730     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 731         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 732     #
 733     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 734         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 735     #
 736     #
 737     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 738     if (lilypond != ''):
 739         version_string = cmdOutput("lilypond --version")
 740         match = re.match('GNU LilyPond (\S+)', version_string)
 741         if match:
 742             version_number = match.groups()[0]
 743             version = version_number.split('.')
 744             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 745                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps --ps $$i"  ""
 746 \converter lilypond   png        "lilypond -dbackend=eps --png $$i"     ""''')
 747                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps --pdf $$i"   ""')
 748                 print '+  found LilyPond version %s.' % version_number
 749             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 750                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 751 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 752                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 753                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 754                 logger.info('+  found LilyPond version %s.' % version_number)
 755             else:
 756                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 757         else:
 758             logger.info('+  found LilyPond, but could not extract version number.')
 759     #
 760     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 761         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 762     #
 763     # FIXME: no rc_entry? comment it out
 764     # checkProg('Image converter', ['convert $$i $$o'])
 765     #
 766     # Entries that do not need checkProg
 767     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 768 \converter lyxpreview-platex ppm        "python -tt $$s/scripts/lyxpreview-platex2bitmap.py"    ""
 769 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 770 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 771 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 772 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 773 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 774 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 775 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 776 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 777 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 778 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 779 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 780 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 781 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 782 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 783 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 784 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 785 ''')
 786
 787
 788 def checkDocBook():
 789     ''' Check docbook '''
 790     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 791         rc_entry = [
 792             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 793 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 794             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 795 \converter docbook    html       "db2html $$i"  ""''',
 796             r'''\converter docbook    dvi        ""     ""
 797 \converter docbook    html       "" ""''',
 798             r'''\converter docbook    dvi        ""     ""
 799 \converter docbook    html       ""     ""'''])
 800     #
 801     if DOCBOOK != '':
 802         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 803     else:
 804         return ('no', 'false', '')
 805
 806
 807 def checkOtherEntries():
 808     ''' entries other than Format and Converter '''
 809     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 810         rc_entry = [ r'\chktex_command "%%"' ])
 811     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 812         rc_entry = [ r'\bibtex_command "%%"' ],
 813         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 814     checkProg('JBibTeX, the Japanese BibTeX', ['jbibtex', 'bibtex'],
 815         rc_entry = [ r'\jbibtex_command "%%"' ])
 816     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q'],
 817         rc_entry = [ r'\index_command "%%"' ],
 818         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 819     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 820         rc_entry = [ r'\jindex_command "%%"' ])
 821     path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
 822         rc_entry = [ r'\splitindex_command "%%"' ])
 823     if splitindex == '':
 824         checkProg('the splitindex processor (java version)', ['splitindex.class'],
 825             rc_entry = [ r'\splitindex_command "java splitindex"' ])
 826     checkProg('a nomenclature processor', ['makeindex'],
 827         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 828     ## FIXME: OCTAVE is not used anywhere
 829     # path, OCTAVE = checkProg('Octave', ['octave'])
 830     ## FIXME: MAPLE is not used anywhere
 831     # path, MAPLE = checkProg('Maple', ['maple'])
 832     checkProg('a spool command', ['lp', 'lpr'],
 833         rc_entry = [
 834             r'''\print_spool_printerprefix "-d "
 835 \print_spool_command "lp"''',
 836             r'''\print_spool_printerprefix "-P",
 837 \print_spool_command "lpr"''',
 838             ''])
 839     # Add the rest of the entries (no checkProg is required)
 840     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 841 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 842 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 843 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 844 ''')
 845
 846
 847 def processLayoutFile(file, bool_docbook):
 848     ''' process layout file and get a line of result
 849
 850         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 851
 852         \DeclareLaTeXClass{article}
 853         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 854         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 855
 856         we expect output:
 857
 858         "article" "article" "article" "false"
 859         "scrbook" "scrbook" "book (koma-script)" "false"
 860         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 861     '''
 862     classname = file.split(os.sep)[-1].split('.')[0]
 863     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 864     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 865     for line in open(file).readlines():
 866         res = p.search(line)
 867         if res != None:
 868             (classtype, optAll, opt, opt1, desc) = res.groups()
 869             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
 870             if opt == None:
 871                 opt = classname
 872             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 873     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
 874     return ""
 875
 876
 877 def checkLatexConfig(check_config, bool_docbook):
 878     ''' Explore the LaTeX configuration
 879         Return None (will be passed to sys.exit()) for success.
 880     '''
 881     msg = 'checking LaTeX configuration... '
 882     # if --without-latex-config is forced, or if there is no previous
 883     # version of textclass.lst, re-generate a default file.
 884     if not os.path.isfile('textclass.lst') or not check_config:
 885         # remove the files only if we want to regenerate
 886         removeFiles(['textclass.lst', 'packages.lst'])
 887         #
 888         # Then, generate a default textclass.lst. In case configure.py
 889         # fails, we still have something to start lyx.
 890         logger.info(msg + ' default values')
 891         logger.info('+checking list of textclasses... ')
 892         tx = open('textclass.lst', 'w')
 893         tx.write('''
 894 # This file declares layouts and their associated definition files
 895 # (include dir. relative to the place where this file is).
 896 # It contains only default values, since chkconfig.ltx could not be run
 897 # for some reason. Run ./configure.py if you need to update it after a
 898 # configuration change.
 899 ''')
 900         # build the list of available layout files and convert it to commands
 901         # for chkconfig.ltx
 902         foundClasses = []
 903         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 904             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 905             # valid file?
 906             if not os.path.isfile(file):
 907                 continue
 908             # get stuff between /xxxx.layout .
 909             classname = file.split(os.sep)[-1].split('.')[0]
 910             #  tr ' -' '__'`
 911             cleanclass = classname.replace(' ', '_')
 912             cleanclass = cleanclass.replace('-', '_')
 913             # make sure the same class is not considered twice
 914             if foundClasses.count(cleanclass) == 0: # not found before
 915                 foundClasses.append(cleanclass)
 916                 retval = processLayoutFile(file, bool_docbook)
 917                 if retval != "":
 918                     tx.write(retval)
 919         tx.close()
 920         logger.info('\tdone')
 921     if not check_config:
 922         return None
 923     # the following will generate textclass.lst.tmp, and packages.lst.tmp
 924     else:
 925         logger.info(msg + '\tauto')
 926         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 927             'chkconfig.classes', 'chklayouts.tex'])
 928         rmcopy = False
 929         if not os.path.isfile( 'chkconfig.ltx' ):
 930             shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
 931             rmcopy = True
 932         writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
 933         # Construct the list of classes to test for.
 934         # build the list of available layout files and convert it to commands
 935         # for chkconfig.ltx
 936         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 937         testclasses = list()
 938         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 939             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 940             if not os.path.isfile(file):
 941                 continue
 942             classname = file.split(os.sep)[-1].split('.')[0]
 943             for line in open(file).readlines():
 944                 if p1.search(line) == None:
 945                     continue
 946                 if line[0] != '#':
 947                     logger.error("Wrong input layout file with line '" + line)
 948                     sys.exit(3)
 949                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 950                 break
 951         testclasses.sort()
 952         cl = open('chklayouts.tex', 'w')
 953         for line in testclasses:
 954             cl.write(line + '\n')
 955         cl.close()
 956         #
 957         # we have chklayouts.tex, then process it
 958         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 959         while True:
 960             line = fout.readline()
 961             if not line:
 962                 break;
 963             if re.match('^\+', line):
 964                 logger.info(line.strip())
 965         # if the command succeeds, None will be returned
 966         ret = fout.close()
 967         #
 968         # currently, values in chhkconfig are only used to set
 969         # \font_encoding
 970         values = {}
 971         for line in open('chkconfig.vars').readlines():
 972             key, val = re.sub('-', '_', line).split('=')
 973             val = val.strip()
 974             values[key] = val.strip("'")
 975         # chk_fontenc may not exist
 976         try:
 977             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 978         except:
 979             pass
 980         if rmcopy:   # remove the copied file
 981             removeFiles( [ 'chkconfig.ltx' ] )
 982         # if configure successed, move textclass.lst.tmp to textclass.lst
 983         # and packages.lst.tmp to packages.lst
 984         if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
 985             and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
 986             shutil.move('textclass.lst.tmp', 'textclass.lst')
 987             shutil.move('packages.lst.tmp', 'packages.lst')
 988         return ret
 989
 990
 991 def checkModulesConfig():
 992   removeFiles(['lyxmodules.lst'])
 993
 994   logger.info('+checking list of modules... ')
 995   tx = open('lyxmodules.lst', 'w')
 996   tx.write('''## This file declares modules and their associated definition files.
 997 ## It has been automatically generated by configure
 998 ## Use "Options/Reconfigure" if you need to update it after a
 999 ## configuration change.
1000 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1001 ''')
1002   # build the list of available modules
1003   foundClasses = []
1004   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1005       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1006       # valid file?
1007       logger.info(file)
1008       if not os.path.isfile(file):
1009           continue
1010       retval = processModuleFile(file, bool_docbook)
1011       if retval != "":
1012           tx.write(retval)
1013   tx.close()
1014   logger.info('\tdone')
1015
1016
1017 def processModuleFile(file, bool_docbook):
1018     ''' process module file and get a line of result
1019
1020         The top of a module file should look like this:
1021           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1022           #DescriptionBegin
1023           #...body of description...
1024           #DescriptionEnd
1025           #Requires: [list of required modules]
1026           #Excludes: [list of excluded modules]
1027           #Category: [category name]
1028         The last three lines are optional (though do give a category).
1029         We expect output:
1030           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1031     '''
1032     p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1033     r = re.compile(r'#+\s*Requires: (.*)')
1034     x = re.compile(r'#+\s*Excludes: (.*)')
1035     c = re.compile(r'#+\s*Category: (.*)')
1036     b = re.compile(r'#+\s*DescriptionBegin\s*$')
1037     e = re.compile(r'#+\s*DescriptionEnd\s*$')
1038
1039     modname = desc = pkgs = req = excl = catgy = ""
1040     readingDescription = False
1041     descLines = []
1042     filename = file.split(os.sep)[-1]
1043     filename = filename[:-7]
1044
1045     for line in open(file).readlines():
1046       if readingDescription:
1047         res = e.search(line)
1048         if res != None:
1049           readingDescription = False
1050           desc = " ".join(descLines)
1051           continue
1052         descLines.append(line[1:].strip())
1053         continue
1054       res = b.search(line)
1055       if res != None:
1056         readingDescription = True
1057         continue
1058       res = p.search(line)
1059       if res != None:
1060           (pkgs, modname) = res.groups()
1061           if pkgs == None:
1062             pkgs = ""
1063           else:
1064             tmp = [s.strip() for s in pkgs.split(",")]
1065             pkgs = ",".join(tmp)
1066           continue
1067       res = r.search(line)
1068       if res != None:
1069         req = res.group(1)
1070         tmp = [s.strip() for s in req.split("|")]
1071         req = "|".join(tmp)
1072         continue
1073       res = x.search(line)
1074       if res != None:
1075         excl = res.group(1)
1076         tmp = [s.strip() for s in excl.split("|")]
1077         excl = "|".join(tmp)
1078         continue
1079       res = c.search(line)
1080       if res != None:
1081         catgy = res.group(1)
1082         continue
1083     if modname != "":
1084         return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1085     logger.warning("Module file without \DeclareLyXModule line. ")
1086     return ""
1087
1088
1089 def checkTeXAllowSpaces():
1090     ''' Let's check whether spaces are allowed in TeX file names '''
1091     tex_allows_spaces = 'false'
1092     if lyx_check_config:
1093         msg = "Checking whether TeX allows spaces in file names... "
1094         writeToFile('a b.tex', r'\message{working^^J}' )
1095         if os.name == 'nt':
1096             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1097         else:
1098             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1099         if 'working' in latex_out:
1100             logger.info(msg + 'yes')
1101             tex_allows_spaces = 'true'
1102         else:
1103             logger.info(msg + 'no')
1104             tex_allows_spaces = 'false'
1105         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1106         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1107
1108
1109 def removeTempFiles():
1110     # Final clean-up
1111     if not lyx_keep_temps:
1112         removeFiles(['chkconfig.vars',  \
1113             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
1114             'chklayouts.tex', 'missfont.log',
1115             'chklatex.ltx', 'chklatex.log'])
1116
1117
1118 if __name__ == '__main__':
1119     lyx_check_config = True
1120     outfile = 'lyxrc.defaults'
1121     rc_entries = ''
1122     lyx_keep_temps = False
1123     version_suffix = ''
1124     ## Parse the command line
1125     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1126         if op in [ '-help', '--help', '-h' ]:
1127             print '''Usage: configure [options]
1128 Options:
1129     --help                   show this help lines
1130     --keep-temps             keep temporary files (for debug. purposes)
1131     --without-latex-config   do not run LaTeX to determine configuration
1132     --with-version-suffix=suffix suffix of binary installed files
1133 '''
1134             sys.exit(0)
1135         elif op == '--without-latex-config':
1136             lyx_check_config = False
1137         elif op == '--keep-temps':
1138             lyx_keep_temps = True
1139         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1140             version_suffix = op[22:]
1141         else:
1142             print "Unknown option", op
1143             sys.exit(1)
1144     #
1145     # check if we run from the right directory
1146     srcdir = os.path.dirname(sys.argv[0])
1147     if srcdir == '':
1148         srcdir = '.'
1149     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1150         logger.error("configure: error: cannot find chkconfig.ltx script")
1151         sys.exit(1)
1152     setEnviron()
1153     createDirectories()
1154     windows_style_tex_paths = checkTeXPaths()
1155     dtl_tools = checkDTLtools()
1156     ## Write the first part of outfile
1157     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1158 # script. It contains default settings that have been determined by
1159 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1160 # want to customize LyX, use LyX' Preferences dialog or modify directly
1161 # the "preferences" file instead. Any setting in that file will
1162 # override the values given here.
1163 ''')
1164     # check latex
1165     LATEX = checkLatex(dtl_tools)
1166     checkFormatEntries(dtl_tools)
1167     checkConverterEntries()
1168     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1169     checkTeXAllowSpaces()
1170     if windows_style_tex_paths != '':
1171         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1172     checkOtherEntries()
1173     # --without-latex-config can disable lyx_check_config
1174     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1175     checkModulesConfig() #lyx_check_config and LATEX != '')
1176     removeTempFiles()
1177     # The return error code can be 256. Because most systems expect an error code
1178     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1179     # a None for success, 'ret is not None' is used to exit.
1180     sys.exit(ret is not None)