lib/configure.py

   1 #! /usr/bin/env python
   2 #
   3 # file configure.py
   4 # This file is part of LyX, the document processor.
   5 # Licence details can be found in the file COPYING.
   6
   7 # \author Bo Peng
   8 # Full author contact details are available in file CREDITS.
   9
  10 # This is an experimental version of the configure script, written
  11 # in Python.
  12
  13 import sys, os, re, shutil, glob
  14
  15
  16 class Tee:
  17     ''' Writing to a Tee object will write to all file objects it keeps.
  18         That is to say, writing to Tee(sys.stdout, open(logfile, 'w')) will
  19         write to sys.stdout as well as a log file.
  20     '''
  21     def __init__(self, *args):
  22         self.files = args
  23
  24     def write(self, data):
  25         for f in self.files:
  26             result = f.write(data)
  27         return result
  28
  29     def writelines(self, seq):
  30         for i in seq:
  31             self.write(i)
  32
  33
  34 def writeToFile(filename, lines, append = False):
  35     " utility function: write or append lines to filename "
  36     if append:
  37         file = open(filename, 'a')
  38     else:
  39         file = open(filename, 'w')
  40     file.write(lines)
  41     file.close()
  42
  43
  44 def addToRC(lines):
  45     ''' utility function: shortcut for appending lines to outfile
  46         add newline at the end of lines.
  47     '''
  48     if lines.strip() != '':
  49         writeToFile(outfile, lines + '\n', append = True)
  50
  51
  52 def removeFiles(filenames):
  53     '''utility function: 'rm -f'
  54         ignore errors when file does not exist, or is a directory.
  55     '''
  56     for file in filenames:
  57         try:
  58             os.remove(file)
  59         except:
  60             pass
  61
  62
  63 def cmdOutput(cmd):
  64     '''utility function: run a command and get its output as a string
  65         cmd: command to run
  66     '''
  67     fout = os.popen(cmd)
  68     output = fout.read()
  69     fout.close()
  70     return output.strip()
  71
  72
  73 def setEnviron():
  74     ''' I do not really know why this is useful, but we might as well keep it.
  75         NLS nuisances.
  76         Only set these to C if already set.  These must not be set unconditionally
  77         because not all systems understand e.g. LANG=C (notably SCO).
  78         Fixing LC_MESSAGES prevents Solaris sh from translating var values in `set'!
  79         Non-C LC_CTYPE values break the ctype check.
  80     '''
  81     os.environ['LANG'] = os.getenv('LANG', 'C')
  82     os.environ['LC'] = os.getenv('LC_ALL', 'C')
  83     os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
  84     os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
  85
  86
  87 def createDirectories():
  88     ''' Create the build directories if necessary '''
  89     for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
  90         'layouts', 'scripts', 'templates', 'ui' ]:
  91         if not os.path.isdir( dir ):
  92             try:
  93                 os.mkdir( dir)
  94             except:
  95                 print "Failed to create directory ", dir
  96                 sys.exit(1)
  97
  98
  99 def checkTeXPaths():
 100     ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
 101     windows_style_tex_paths = ''
 102     if os.name == 'nt' or sys.platform == 'cygwin':
 103         from tempfile import mkstemp
 104         fd, tmpfname = mkstemp(suffix='.ltx')
 105         if os.name == 'nt':
 106             inpname = tmpfname.replace('\\', '/')
 107         else:
 108             inpname = cmdOutput('cygpath -m ' + tmpfname)
 109         inpname = inpname.replace('~', '\\string~')
 110         os.write(fd, r'\relax')
 111         os.close(fd)
 112         latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
 113         if 'Error' in latex_out:
 114             print "configure: TeX engine needs posix-style paths in latex files"
 115             windows_style_tex_paths = 'false'
 116         else:
 117             print "configure: TeX engine needs windows-style paths in latex files"
 118             windows_style_tex_paths = 'true'
 119         removeFiles([tmpfname, 'texput.log'])
 120     return windows_style_tex_paths
 121
 122
 123 ## Searching some useful programs
 124 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
 125     '''
 126         This function will search a program in $PATH plus given path
 127         If found, return directory and program name (not the options).
 128
 129         description: description of the program
 130
 131         progs: check programs, for each prog, the first word is used
 132             for searching but the whole string is used to replace
 133             %% for a rc_entry. So, feel free to add '$$i' etc for programs.
 134
 135         path: additional pathes
 136
 137         rc_entry: entry to outfile, can be
 138             1. emtpy: no rc entry will be added
 139             2. one pattern: %% will be replaced by the first found program,
 140                 or '' if no program is found.
 141             3. several patterns for each prog and not_found. This is used
 142                 when different programs have different usages. If you do not
 143                 want not_found entry to be added to the RC file, you can specify
 144                 an entry for each prog and use '' for the not_found entry.
 145
 146         not_found: the value that should be used instead of '' if no program
 147             was found
 148
 149     '''
 150     # one rc entry for each progs plus not_found entry
 151     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 152         print "rc entry should have one item or item for each prog and not_found."
 153         sys.exit(2)
 154     print 'checking for ' + description + '...'
 155     ## print '(' + ','.join(progs) + ')',
 156     for idx in range(len(progs)):
 157         # ac_prog may have options, ac_word is the command name
 158         ac_prog = progs[idx]
 159         ac_word = ac_prog.split(' ')[0]
 160         print '+checking for "' + ac_word + '"... ',
 161         path = os.environ["PATH"].split(os.pathsep) + path
 162         for ac_dir in path:
 163             # check both ac_word and ac_word.exe (for windows system)
 164             if os.path.isfile( os.path.join(ac_dir, ac_word) ) or \
 165                 os.path.isfile( os.path.join(ac_dir, ac_word + ".exe") ):
 166                 print ' 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         print ' 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 checkViewer(description, progs, rc_entry = [], path = []):
 182     ''' The same as checkProg, but for viewers and editors '''
 183     return checkProg(description, progs, rc_entry, path, not_found = 'auto')
 184
 185
 186 def checkLatex():
 187     ''' Check latex, return lyx_check_config '''
 188     # Find programs! Returned path is not used now
 189     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 190             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 191             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 192         # Windows only: DraftDVI
 193         converter_entry = r'''\converter latex      dvi2       "%%"     "latex"
 194 \converter dvi2       dvi        "python -tt $$s/scripts/clean_dvi.py $$i $$o"  ""'''
 195     else:
 196         converter_entry = r'\converter latex      dvi        "%%"       "latex"'
 197     path, LATEX = checkProg('a Latex2e program', ['pplatex $$i', 'latex $$i', 'latex2e $$i'],
 198         rc_entry = [converter_entry])
 199     # no latex
 200     if LATEX != '':
 201         # Check if latex is usable
 202         writeToFile('chklatex.ltx', '''
 203 \\nonstopmode\\makeatletter
 204 \\ifx\\undefined\\documentclass\\else
 205   \\message{ThisIsLaTeX2e}
 206 \\fi
 207 \\@@end
 208 ''')
 209         # run latex on chklatex.ltx and check result
 210         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 211             # valid latex2e
 212             return LATEX
 213         else:
 214             print "Latex not usable (not LaTeX2e) "
 215         # remove temporary files
 216         removeFiles(['chklatex.ltx', 'chklatex.log'])
 217     return ''
 218
 219
 220 def checkFormatEntries():
 221     ''' Check all formats (\Format entries) '''
 222     checkViewer('a Tgif viewer and editor', ['tgif'],
 223         rc_entry = [r'\Format tgif       obj     Tgif                   "" "%%" "%%"    ""'])
 224     #
 225     checkViewer('a FIG viewer and editor', ['xfig'],
 226         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    ""'])
 227     #
 228     checkViewer('a Grace viewer and editor', ['xmgrace'],
 229         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    ""'])
 230     #
 231     checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 232         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""'])
 233     #
 234     path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp'])
 235     path, ie = checkViewer('a raster image editor', ['gimp'])
 236     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 237 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 238 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 239 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 240 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 241 \Format png        png     PNG                    "" "%s"       "%s"    ""
 242 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 243 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 244 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 245 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 246         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 247     #
 248     checkViewer('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 249         'nedit', 'gedit', 'notepad'],
 250         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 251 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 252 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 253 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 254 \Format docbook    sgml    DocBook                B  "" "%%"    "document"
 255 \Format docbook-xml xml   "Docbook (XML)"         "" "" "%%"    "document"
 256 \Format literate   nw      NoWeb                  N  "" "%%"    "document"
 257 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document"
 258 \Format linuxdoc   sgml    LinuxDoc               x  "" "%%"    "document"
 259 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document"
 260 \Format text       txt    "Plain text"            a  "" "%%"    "document"
 261 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 262 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 263 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 264 \Format textparagraph txt "Plain text (paragraphs)"    "" ""    "%%"    "document"''' ])
 265     #
 266     #checkProg('a Postscript interpreter', ['gs'],
 267     #  rc_entry = [ r'\ps_command "%%"' ])
 268     checkViewer('a Postscript previewer', ['gv', 'ghostview -swap', 'kghostview'],
 269         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      ""
 270 \Format ps         ps      Postscript             t  "%%"       ""      "document"'''])
 271     #
 272     checkViewer('a PDF previewer', ['acrobat', 'acroread', 'gv', 'ghostview', \
 273                             'xpdf', 'kpdf', 'kghostview'],
 274         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document"
 275 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document"
 276 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document"'''])
 277     #
 278     checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
 279         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document"'])
 280     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 281             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 282             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 283         # Windows only: DraftDVI
 284         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      "document"')
 285     #
 286     checkViewer('a HTML previewer', ['mozilla file://$$p$$i', 'netscape'],
 287         rc_entry = [r'\Format html       html    HTML                   H  "%%" ""      "document"'])
 288     #
 289     # entried that do not need checkProg
 290     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 291 \Format fax        ""      Fax                    "" "" ""      "document"
 292 \Format lyx        lyx     LyX                    "" "" ""      ""
 293 \Format lyx13x     lyx13  "LyX 1.3.x"             "" "" ""      "document"
 294 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 295 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 296 \Format program    ""      Program                "" "" ""      ""
 297 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 298 \Format sxw        sxw    "OpenOffice.Org Writer" O  "" ""      "document"
 299 \Format wmf        wmf    "Windows Meta File"     "" "" ""      ""
 300 \Format word       doc    "MS Word"               W  "" ""      "document"
 301 \Format wordhtml   html   "MS Word (HTML)"        "" ""        ""       "document"
 302 ''')
 303
 304
 305 def checkConverterEntries():
 306     ''' Check all converters (\converter entries) '''
 307     checkProg('the pdflatex program', ['pdflatex $$i'],
 308         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 309
 310     ''' If we're running LyX in-place then tex2lyx will be found in
 311             ../src/tex2lyx. Add this directory to the PATH temporarily and
 312             search for tex2lyx.
 313             Use PATH to avoid any problems with paths-with-spaces.
 314     '''
 315     path_orig = os.environ["PATH"]
 316     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 317         os.pathsep + path_orig
 318
 319     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 320         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 321 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 322
 323     os.environ["PATH"] = path_orig
 324
 325     #
 326     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 327         rc_entry = [ r'\converter literate   latex      "%%"    ""' ])
 328     #
 329     checkProg('a HTML -> LaTeX converter', ['html2latex $$i'],
 330         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 331     #
 332     checkProg('a MSWord -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 333         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 334     #
 335     checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 336         rc_entry = [ r'\converter latex      wordhtml   "%%"    ""' ])
 337     #
 338     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 339         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 340     #
 341     checkProg('a LaTeX -> OpenOffice.org converter', ['oolatex $$i', 'oolatex.sh $$i'],
 342         rc_entry = [ r'\converter latex      sxw        "%%"    "latex"' ])
 343     #
 344     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 345         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 346     #
 347     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 348         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 349     #
 350     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 351         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 352     #
 353     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 354         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 355     #
 356     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 357         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 358     #
 359     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 360         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 361     #
 362     path, dvipng = checkProg('dvipng', ['dvipng'])
 363     if dvipng == "dvipng":
 364         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 365     else:
 366         addToRC(r'\converter lyxpreview png        ""   ""')
 367     #
 368     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
 369         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 370     #
 371     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 372         rc_entry = [
 373             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 374 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 375 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 376             ''])
 377     #
 378     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 379         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 380     #
 381     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 382         rc_entry = [
 383             r'''\converter tgif       eps        "tgif -stdout -print -color -eps $$i > $$o"    ""
 384 \converter tgif       ppm        "tgif -stdout -print -color -ppm $$i > $$o"    ""
 385 \converter tgif       png        "tgif -stdout -print -color -png $$i > $$o"    ""
 386 \converter tgif       pdf        "tgif -stdout -print -color -pdf $$i > $$o"    ""''',
 387             ''])
 388     #
 389     checkProg('a WMF -> EPS converter', ['wmf2eps -o $$o $$i'],
 390         rc_entry = [ r'\converter wmf        eps        "%%"    ""', ''])
 391     #
 392     checkProg('a EPS -> PDF converter', ['epstopdf'],
 393         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 394     #
 395     checkProg('a Grace -> Image converter', ['gracebat'],
 396         rc_entry = [
 397             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 398 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 399 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 400 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 401             ''])
 402     #
 403     checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 404         'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 405         rc_entry = [ r'\converter latex      html       "%%"    "originaldir,needaux"' ])
 406     #
 407     # FIXME: no rc_entry? comment it out
 408     # checkProg('Image converter', ['convert $$i $$o'])
 409     #
 410     # Entried that do not need checkProg
 411     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 412 \converter date       dateout    "date +%d-%m-%Y > $$o" ""
 413 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 414 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 415 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 416 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 417 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 418 ''')
 419
 420
 421 def checkLinuxDoc():
 422     ''' Check linuxdoc '''
 423     #
 424     path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
 425         rc_entry = [
 426         r'''\converter linuxdoc   lyx        "sgml2lyx $$i"     ""
 427 \converter linuxdoc   latex      "sgml2latex $$i"       ""
 428 \converter linuxdoc   dvi        "sgml2latex -o dvi $$i"        ""
 429 \converter linuxdoc   html       "sgml2html $$i"        ""''',
 430         r'''\converter linuxdoc   lyx        "" ""
 431 \converter linuxdoc   latex      ""     ""
 432 \converter linuxdoc   dvi        ""     ""
 433 \converter linuxdoc   html       ""     ""''' ])
 434     if LINUXDOC != '':
 435         return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
 436     else:
 437         return ('no', 'false', '')
 438
 439
 440 def checkDocBook():
 441     ''' Check docbook '''
 442     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
 443         rc_entry = [
 444             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 445 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 446             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 447 \converter docbook    html       "db2html $$i"  ""''',
 448             r'''\converter docbook    dvi        ""     ""
 449 \converter docbook    html       ""     ""'''])
 450     #
 451     if DOCBOOK != '':
 452         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 453     else:
 454         return ('no', 'false', '')
 455
 456
 457 def checkOtherEntries():
 458     ''' entries other than Format and Converter '''
 459     checkProg('a *roff formatter', ['groff', 'nroff'],
 460         rc_entry = [
 461             r'\ascii_roff_command "groff -t -Tlatin1 $$FName"',
 462             r'\ascii_roff_command "tbl $$FName | nroff"',
 463             r'\ascii_roff_command ""' ])
 464     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 465         rc_entry = [ r'\chktex_command "%%"' ])
 466     checkProg('a spellchecker', ['ispell'],
 467         rc_entry = [ r'\spell_command "%%"' ])
 468     ## FIXME: OCTAVE is not used anywhere
 469     # path, OCTAVE = checkProg('Octave', ['octave'])
 470     ## FIXME: MAPLE is not used anywhere
 471     # path, MAPLE = checkProg('Maple', ['maple'])
 472     checkProg('a spool command', ['lp', 'lpr'],
 473         rc_entry = [
 474             r'''\print_spool_printerprefix "-d "
 475 \print_spool_command "lp"''',
 476             r'''\print_spool_printerprefix "-P",
 477 \print_spool_command "lpr"''',
 478             ''])
 479     # Add the rest of the entries (no checkProg is required)
 480     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 481 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 482 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 483 ''')
 484
 485
 486 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
 487     ''' process layout file and get a line of result
 488
 489         Declear line are like this: (article.layout, scrbook.layout, svjog.layout)
 490
 491         \DeclareLaTeXClass{article}
 492         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 493         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 494
 495         we expect output:
 496
 497         "article" "article" "article" "false"
 498         "scrbook" "scrbook" "book (koma-script)" "false"
 499         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 500     '''
 501     classname = file.split(os.sep)[-1].split('.')[0]
 502     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclearLaTeXClass[a,b,c]{article}
 503     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 504     for line in open(file).readlines():
 505         res = p.search(line)
 506         if res != None:
 507             (classtype, optAll, opt, opt1, desc) = res.groups()
 508             avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
 509             if opt == None:
 510                 opt = classname
 511             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 512     print "Layout file without \DeclearXXClass line. "
 513     sys.exit(2)
 514
 515
 516 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
 517     ''' Explore the LaTeX configuration '''
 518     print 'checking LaTeX configuration... ',
 519     # First, remove the files that we want to re-create
 520     removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
 521     #
 522     if not check_config:
 523         print ' default values'
 524         print '+checking list of textclasses... '
 525         tx = open('textclass.lst', 'w')
 526         tx.write('''
 527 # This file declares layouts and their associated definition files
 528 # (include dir. relative to the place where this file is).
 529 # It contains only default values, since chkconfig.ltx could not be run
 530 # for some reason. Run ./configure.py if you need to update it after a
 531 # configuration change.
 532 ''')
 533         # build the list of available layout files and convert it to commands
 534         # for chkconfig.ltx
 535         foundClasses = []
 536         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 537             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 538             # valid file?
 539             if not os.path.isfile(file):
 540                 continue
 541             # get stuff between /xxxx.layout .
 542             classname = file.split(os.sep)[-1].split('.')[0]
 543             #  tr ' -' '__'`
 544             cleanclass = classname.replace(' ', '_')
 545             cleanclass = cleanclass.replace('-', '_')
 546             # make sure the same class is not considered twice
 547             if foundClasses.count(cleanclass) == 0: # not found before
 548                 foundClasses.append(cleanclass)
 549                 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
 550         tx.close()
 551         print '\tdone'
 552     else:
 553         print '\tauto'
 554         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 555             'chkconfig.classes', 'chklayouts.tex'])
 556         rmcopy = False
 557         if not os.path.isfile( 'chkconfig.ltx' ):
 558             shutil.copy( os.path.join(srcdir, 'chkconfig.ltx'),  'chkconfig.ltx' )
 559             rmcopy = True
 560         writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
 561             % (linuxdoc_cmd, docbook_cmd) )
 562         # Construct the list of classes to test for.
 563         # build the list of available layout files and convert it to commands
 564         # for chkconfig.ltx
 565         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 566         testclasses = list()
 567         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 568             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 569             if not os.path.isfile(file):
 570                 continue
 571             classname = file.split(os.sep)[-1].split('.')[0]
 572             for line in open(file).readlines():
 573                 if p1.search(line) == None:
 574                     continue
 575                 if line[0] != '#':
 576                     print "Wrong input layout file with line '" + line
 577                     sys.exit(3)
 578                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 579                 break
 580         testclasses.sort()
 581         cl = open('chklayouts.tex', 'w')
 582         for line in testclasses:
 583             cl.write(line + '\n')
 584         cl.close()
 585         #
 586         # we have chklayouts.tex, then process it
 587         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 588         while True:
 589             line = fout.readline()
 590             if not line:
 591                 break;
 592             if re.match('^\+', line):
 593                 print line,
 594         fout.close()
 595         #
 596         # currently, values in chhkconfig are only used to set
 597         # \font_encoding
 598         values = {}
 599         for line in open('chkconfig.vars').readlines():
 600             key, val = re.sub('-', '_', line).split('=')
 601             val = val.strip()
 602             values[key] = val.strip("'")
 603         # chk_fontenc may not exist
 604         try:
 605             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 606         except:
 607             pass
 608         if rmcopy:   # remove the copied file
 609             removeFiles( [ 'chkconfig.ltx' ] )
 610
 611
 612 def createLaTeXConfig():
 613     ''' create LaTeXConfig.lyx '''
 614     # if chkconfig.sed does not exist (because LaTeX did not run),
 615     # then provide a standard version.
 616     if not os.path.isfile('chkconfig.sed'):
 617         writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
 618     print "creating packages.lst"
 619     # if packages.lst does not exist (because LaTeX did not run),
 620     # then provide a standard version.
 621     if not os.path.isfile('packages.lst'):
 622         writeToFile('packages.lst', '''
 623 ### This file should contain the list of LaTeX packages that have been
 624 ### recognized by LyX. Unfortunately, since configure could not find
 625 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
 626 ### if you need to update it after a configuration change.
 627 ''')
 628     print 'creating doc/LaTeXConfig.lyx'
 629     #
 630     # This is originally done by sed, using a
 631     # tex-generated file chkconfig.sed
 632     ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
 633     ##  >doc/LaTeXConfig.lyx
 634     # Now, we have to do it by hand (python).
 635     #
 636     # add to chekconfig.sed
 637     writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
 638 s!@chk_docbook@!%s!g
 639     ''' % (chk_linuxdoc, chk_docbook) , append=True)
 640     # process this sed file!!!!
 641     lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
 642     # get the rules
 643     p = re.compile(r's!(.*)!(.*)!g')
 644     # process each sed replace.
 645     for sed in open('chkconfig.sed').readlines():
 646         if sed.strip() == '':
 647             continue
 648         try:
 649             fr, to = p.match(sed).groups()
 650             # if latex did not run, change all @name@ to '???'
 651             if fr == '@.*@':
 652                 for line in range(len(lyxin)):
 653                     lyxin[line] = re.sub('@.*@', to, lyxin[line])
 654             else:
 655                 for line in range(len(lyxin)):
 656                     lyxin[line] = lyxin[line].replace(fr, to)
 657         except:  # wrong sed entry?
 658             print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
 659             sys.exit(4)
 660     #
 661     writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
 662         ''.join(lyxin))
 663
 664
 665 def checkTeXAllowSpaces():
 666     ''' Let's check whether spaces are allowed in TeX file names '''
 667     tex_allows_spaces = 'false'
 668     if lyx_check_config:
 669         print "Checking whether TeX allows spaces in file names... ",
 670         writeToFile('a b.tex', r'\message{working^^J}' )
 671         if os.name == 'nt':
 672             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
 673         else:
 674             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
 675         if 'working' in latex_out:
 676             print 'yes'
 677             tex_allows_spaces = 'true'
 678         else:
 679             print 'no'
 680             tex_allows_spaces = 'false'
 681         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
 682         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
 683
 684
 685 def removeTempFiles():
 686     # Final clean-up
 687     if not lyx_keep_temps:
 688         removeFiles(['chkconfig.sed', 'chkconfig.vars',  \
 689             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
 690             'chklayouts.tex', 'missfont.log',
 691             'chklatex.ltx', 'chklatex.log'])
 692
 693
 694 if __name__ == '__main__':
 695     lyx_check_config = True
 696     outfile = 'lyxrc.defaults'
 697     rc_entries = ''
 698     lyx_keep_temps = False
 699     version_suffix = ''
 700     logfile = 'configure.log'
 701     ## Parse the command line
 702     for op in sys.argv[1:]:   # default shell/for list is $*, the options
 703         if op in [ '-help', '--help', '-h' ]:
 704             print '''Usage: configure [options]
 705 Options:
 706     --help                   show this help lines
 707     --keep-temps             keep temporary files (for debug. purposes)
 708     --without-latex-config   do not run LaTeX to determine configuration
 709     --with-version-suffix=suffix suffix of binary installed files
 710 '''
 711             sys.exit(0)
 712         elif op == '--without-latex-config':
 713             lyx_check_config = False
 714         elif op == '--keep-temps':
 715             lyx_keep_temps = True
 716         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
 717             version_suffix = op[22:]
 718         else:
 719             print "Unknown option", op
 720             sys.exit(1)
 721     #
 722     # set up log file for stdout and stderr
 723     log = open(logfile, 'w')
 724     sys.stdout = Tee(sys.stdout, log)
 725     sys.stderr = Tee(sys.stderr, log)
 726     # check if we run from the right directory
 727     srcdir = os.path.dirname(sys.argv[0])
 728     if srcdir == '':
 729         srcdir = '.'
 730     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
 731         print "configure: error: cannot find chkconfig.ltx script"
 732         sys.exit(1)
 733     setEnviron()
 734     createDirectories()
 735     windows_style_tex_paths = checkTeXPaths()
 736     ## Write the first part of outfile
 737     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
 738 # script. It contains default settings that have been determined by
 739 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
 740 # want to customize LyX, use LyX' Preferences dialog or modify directly
 741 # the "preferences" file instead. Any setting in that file will
 742 # override the values given here.
 743 ''')
 744     # check latex
 745     LATEX = checkLatex()
 746     checkFormatEntries()
 747     checkConverterEntries()
 748     (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
 749     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
 750     checkTeXAllowSpaces()
 751     if windows_style_tex_paths != '':
 752         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
 753     checkOtherEntries()
 754     # --without-latex-config can disable lyx_check_config
 755     checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)
 756     createLaTeXConfig()
 757     removeTempFiles()