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                   "" "%%" "%%"    "vector"'])
 224     #
 225     checkViewer('a FIG viewer and editor', ['xfig'],
 226         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"'])
 227     #
 228     checkViewer('a Grace viewer and editor', ['xmgrace'],
 229         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"'])
 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                    "" "%%"       ""      "vector"
 270 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector"'''])
 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,vector"
 275 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector"
 276 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector"'''])
 277     #
 278     checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
 279         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document,vector"'])
 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,vector"')
 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 rtf        rtf    "Rich Text Format"      "" "" ""      "document,vector"
 299 \Format sxw        sxw    "OpenOffice.Org Writer" O  "" ""      "document,vector"
 300 \Format wmf        wmf    "Windows Meta File"     "" "" ""      "vector"
 301 \Format word       doc    "MS Word"               W  "" ""      "document,vector"
 302 \Format wordhtml   html   "MS Word (HTML)"        "" ""        ""       "document"
 303 ''')
 304
 305
 306 def checkConverterEntries():
 307     ''' Check all converters (\converter entries) '''
 308     checkProg('the pdflatex program', ['pdflatex $$i'],
 309         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 310
 311     ''' If we're running LyX in-place then tex2lyx will be found in
 312             ../src/tex2lyx. Add this directory to the PATH temporarily and
 313             search for tex2lyx.
 314             Use PATH to avoid any problems with paths-with-spaces.
 315     '''
 316     path_orig = os.environ["PATH"]
 317     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 318         os.pathsep + path_orig
 319
 320     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 321         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 322 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 323
 324     os.environ["PATH"] = path_orig
 325
 326     #
 327     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 328         rc_entry = [ r'\converter literate   latex      "%%"    ""' ])
 329     #
 330     checkProg('a HTML -> LaTeX converter', ['html2latex $$i'],
 331         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 332     #
 333     checkProg('a MSWord -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 334         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 335     #
 336     checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 337         rc_entry = [ r'\converter latex      wordhtml   "%%"    ""' ])
 338     #
 339     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 340         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 341     #
 342     checkProg('a LaTeX -> OpenOffice.org converter', ['oolatex $$i', 'oolatex.sh $$i'],
 343         rc_entry = [ r'\converter latex      sxw        "%%"    "latex"' ])
 344     # On windows it is called latex2rt.exe
 345     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 346         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 347     #
 348     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 349         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 350     #
 351     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 352         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 353     #
 354     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 355         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 356     #
 357     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 358         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 359     #
 360     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 361         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 362     #
 363     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 364         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 365     #
 366     path, dvipng = checkProg('dvipng', ['dvipng'])
 367     if dvipng == "dvipng":
 368         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 369     else:
 370         addToRC(r'\converter lyxpreview png        ""   ""')
 371     #
 372     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
 373         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 374     #
 375     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 376         rc_entry = [
 377             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 378 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 379 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 380             ''])
 381     #
 382     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 383         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 384     #
 385     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 386         rc_entry = [
 387             r'''\converter tgif       eps        "tgif -stdout -print -color -eps $$i > $$o"    ""
 388 \converter tgif       ppm        "tgif -stdout -print -color -ppm $$i > $$o"    ""
 389 \converter tgif       png        "tgif -stdout -print -color -png $$i > $$o"    ""
 390 \converter tgif       pdf        "tgif -stdout -print -color -pdf $$i > $$o"    ""''',
 391             ''])
 392     #
 393     checkProg('a WMF -> EPS converter', ['wmf2eps -o $$o $$i'],
 394         rc_entry = [ r'\converter wmf        eps        "%%"    ""', ''])
 395     #
 396     checkProg('a EPS -> PDF converter', ['epstopdf'],
 397         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 398     #
 399     checkProg('a Grace -> Image converter', ['gracebat'],
 400         rc_entry = [
 401             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 402 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 403 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 404 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 405             ''])
 406     #
 407     checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 408         'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 409         rc_entry = [ r'\converter latex      html       "%%"    "originaldir,needaux"' ])
 410     #
 411     # FIXME: no rc_entry? comment it out
 412     # checkProg('Image converter', ['convert $$i $$o'])
 413     #
 414     # Entried that do not need checkProg
 415     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 416 \converter date       dateout    "date +%d-%m-%Y > $$o" ""
 417 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 418 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 419 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 420 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 421 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 422 ''')
 423
 424
 425 def checkLinuxDoc():
 426     ''' Check linuxdoc '''
 427     #
 428     path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
 429         rc_entry = [
 430         r'''\converter linuxdoc   lyx        "sgml2lyx $$i"     ""
 431 \converter linuxdoc   latex      "sgml2latex $$i"       ""
 432 \converter linuxdoc   dvi        "sgml2latex -o dvi $$i"        ""
 433 \converter linuxdoc   html       "sgml2html $$i"        ""''',
 434         r'''\converter linuxdoc   lyx        "" ""
 435 \converter linuxdoc   latex      ""     ""
 436 \converter linuxdoc   dvi        ""     ""
 437 \converter linuxdoc   html       ""     ""''' ])
 438     if LINUXDOC != '':
 439         return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
 440     else:
 441         return ('no', 'false', '')
 442
 443
 444 def checkDocBook():
 445     ''' Check docbook '''
 446     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
 447         rc_entry = [
 448             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 449 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 450             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 451 \converter docbook    html       "db2html $$i"  ""''',
 452             r'''\converter docbook    dvi        ""     ""
 453 \converter docbook    html       ""     ""'''])
 454     #
 455     if DOCBOOK != '':
 456         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 457     else:
 458         return ('no', 'false', '')
 459
 460
 461 def checkOtherEntries():
 462     ''' entries other than Format and Converter '''
 463     checkProg('a *roff formatter', ['groff', 'nroff'],
 464         rc_entry = [
 465             r'\ascii_roff_command "groff -t -Tlatin1 $$FName"',
 466             r'\ascii_roff_command "tbl $$FName | nroff"',
 467             r'\ascii_roff_command ""' ])
 468     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 469         rc_entry = [ r'\chktex_command "%%"' ])
 470     checkProg('a spellchecker', ['ispell'],
 471         rc_entry = [ r'\spell_command "%%"' ])
 472     ## FIXME: OCTAVE is not used anywhere
 473     # path, OCTAVE = checkProg('Octave', ['octave'])
 474     ## FIXME: MAPLE is not used anywhere
 475     # path, MAPLE = checkProg('Maple', ['maple'])
 476     checkProg('a spool command', ['lp', 'lpr'],
 477         rc_entry = [
 478             r'''\print_spool_printerprefix "-d "
 479 \print_spool_command "lp"''',
 480             r'''\print_spool_printerprefix "-P",
 481 \print_spool_command "lpr"''',
 482             ''])
 483     # Add the rest of the entries (no checkProg is required)
 484     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 485 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 486 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 487 ''')
 488
 489
 490 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
 491     ''' process layout file and get a line of result
 492
 493         Declear line are like this: (article.layout, scrbook.layout, svjog.layout)
 494
 495         \DeclareLaTeXClass{article}
 496         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 497         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 498
 499         we expect output:
 500
 501         "article" "article" "article" "false"
 502         "scrbook" "scrbook" "book (koma-script)" "false"
 503         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 504     '''
 505     classname = file.split(os.sep)[-1].split('.')[0]
 506     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclearLaTeXClass[a,b,c]{article}
 507     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 508     for line in open(file).readlines():
 509         res = p.search(line)
 510         if res != None:
 511             (classtype, optAll, opt, opt1, desc) = res.groups()
 512             avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
 513             if opt == None:
 514                 opt = classname
 515             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 516     print "Layout file without \DeclearXXClass line. "
 517     sys.exit(2)
 518
 519
 520 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
 521     ''' Explore the LaTeX configuration '''
 522     print 'checking LaTeX configuration... ',
 523     # First, remove the files that we want to re-create
 524     removeFiles(['textclass.lst', 'packages.lst', 'chkconfig.sed'])
 525     #
 526     if not check_config:
 527         print ' default values'
 528         print '+checking list of textclasses... '
 529         tx = open('textclass.lst', 'w')
 530         tx.write('''
 531 # This file declares layouts and their associated definition files
 532 # (include dir. relative to the place where this file is).
 533 # It contains only default values, since chkconfig.ltx could not be run
 534 # for some reason. Run ./configure.py if you need to update it after a
 535 # configuration change.
 536 ''')
 537         # build the list of available layout files and convert it to commands
 538         # for chkconfig.ltx
 539         foundClasses = []
 540         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 541             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 542             # valid file?
 543             if not os.path.isfile(file):
 544                 continue
 545             # get stuff between /xxxx.layout .
 546             classname = file.split(os.sep)[-1].split('.')[0]
 547             #  tr ' -' '__'`
 548             cleanclass = classname.replace(' ', '_')
 549             cleanclass = cleanclass.replace('-', '_')
 550             # make sure the same class is not considered twice
 551             if foundClasses.count(cleanclass) == 0: # not found before
 552                 foundClasses.append(cleanclass)
 553                 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
 554         tx.close()
 555         print '\tdone'
 556     else:
 557         print '\tauto'
 558         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 559             'chkconfig.classes', 'chklayouts.tex'])
 560         rmcopy = False
 561         if not os.path.isfile( 'chkconfig.ltx' ):
 562             shutil.copy( os.path.join(srcdir, 'chkconfig.ltx'),  'chkconfig.ltx' )
 563             rmcopy = True
 564         writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
 565             % (linuxdoc_cmd, docbook_cmd) )
 566         # Construct the list of classes to test for.
 567         # build the list of available layout files and convert it to commands
 568         # for chkconfig.ltx
 569         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 570         testclasses = list()
 571         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 572             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 573             if not os.path.isfile(file):
 574                 continue
 575             classname = file.split(os.sep)[-1].split('.')[0]
 576             for line in open(file).readlines():
 577                 if p1.search(line) == None:
 578                     continue
 579                 if line[0] != '#':
 580                     print "Wrong input layout file with line '" + line
 581                     sys.exit(3)
 582                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 583                 break
 584         testclasses.sort()
 585         cl = open('chklayouts.tex', 'w')
 586         for line in testclasses:
 587             cl.write(line + '\n')
 588         cl.close()
 589         #
 590         # we have chklayouts.tex, then process it
 591         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 592         while True:
 593             line = fout.readline()
 594             if not line:
 595                 break;
 596             if re.match('^\+', line):
 597                 print line,
 598         fout.close()
 599         #
 600         # currently, values in chhkconfig are only used to set
 601         # \font_encoding
 602         values = {}
 603         for line in open('chkconfig.vars').readlines():
 604             key, val = re.sub('-', '_', line).split('=')
 605             val = val.strip()
 606             values[key] = val.strip("'")
 607         # chk_fontenc may not exist
 608         try:
 609             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 610         except:
 611             pass
 612         if rmcopy:   # remove the copied file
 613             removeFiles( [ 'chkconfig.ltx' ] )
 614
 615
 616 def createLaTeXConfig():
 617     ''' create LaTeXConfig.lyx '''
 618     # if chkconfig.sed does not exist (because LaTeX did not run),
 619     # then provide a standard version.
 620     if not os.path.isfile('chkconfig.sed'):
 621         writeToFile('chkconfig.sed', 's!@.*@!???!g\n')
 622     print "creating packages.lst"
 623     # if packages.lst does not exist (because LaTeX did not run),
 624     # then provide a standard version.
 625     if not os.path.isfile('packages.lst'):
 626         writeToFile('packages.lst', '''
 627 ### This file should contain the list of LaTeX packages that have been
 628 ### recognized by LyX. Unfortunately, since configure could not find
 629 ### your LaTeX2e program, the tests have not been run. Run ./configure.py
 630 ### if you need to update it after a configuration change.
 631 ''')
 632     print 'creating doc/LaTeXConfig.lyx'
 633     #
 634     # This is originally done by sed, using a
 635     # tex-generated file chkconfig.sed
 636     ##sed -f chkconfig.sed ${srcdir}/doc/LaTeXConfig.lyx.in
 637     ##  >doc/LaTeXConfig.lyx
 638     # Now, we have to do it by hand (python).
 639     #
 640     # add to chekconfig.sed
 641     writeToFile('chkconfig.sed', '''s!@chk_linuxdoc@!%s!g
 642 s!@chk_docbook@!%s!g
 643     ''' % (chk_linuxdoc, chk_docbook) , append=True)
 644     # process this sed file!!!!
 645     lyxin = open( os.path.join(srcdir, 'doc', 'LaTeXConfig.lyx.in')).readlines()
 646     # get the rules
 647     p = re.compile(r's!(.*)!(.*)!g')
 648     # process each sed replace.
 649     for sed in open('chkconfig.sed').readlines():
 650         if sed.strip() == '':
 651             continue
 652         try:
 653             fr, to = p.match(sed).groups()
 654             # if latex did not run, change all @name@ to '???'
 655             if fr == '@.*@':
 656                 for line in range(len(lyxin)):
 657                     lyxin[line] = re.sub('@.*@', to, lyxin[line])
 658             else:
 659                 for line in range(len(lyxin)):
 660                     lyxin[line] = lyxin[line].replace(fr, to)
 661         except:  # wrong sed entry?
 662             print "Wrong sed entry in chkconfig.sed: '" + sed + "'"
 663             sys.exit(4)
 664     #
 665     writeToFile( os.path.join('doc', 'LaTeXConfig.lyx'),
 666         ''.join(lyxin))
 667
 668
 669 def checkTeXAllowSpaces():
 670     ''' Let's check whether spaces are allowed in TeX file names '''
 671     tex_allows_spaces = 'false'
 672     if lyx_check_config:
 673         print "Checking whether TeX allows spaces in file names... ",
 674         writeToFile('a b.tex', r'\message{working^^J}' )
 675         if os.name == 'nt':
 676             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
 677         else:
 678             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
 679         if 'working' in latex_out:
 680             print 'yes'
 681             tex_allows_spaces = 'true'
 682         else:
 683             print 'no'
 684             tex_allows_spaces = 'false'
 685         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
 686         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
 687
 688
 689 def removeTempFiles():
 690     # Final clean-up
 691     if not lyx_keep_temps:
 692         removeFiles(['chkconfig.sed', 'chkconfig.vars',  \
 693             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
 694             'chklayouts.tex', 'missfont.log',
 695             'chklatex.ltx', 'chklatex.log'])
 696
 697
 698 if __name__ == '__main__':
 699     lyx_check_config = True
 700     outfile = 'lyxrc.defaults'
 701     rc_entries = ''
 702     lyx_keep_temps = False
 703     version_suffix = ''
 704     logfile = 'configure.log'
 705     ## Parse the command line
 706     for op in sys.argv[1:]:   # default shell/for list is $*, the options
 707         if op in [ '-help', '--help', '-h' ]:
 708             print '''Usage: configure [options]
 709 Options:
 710     --help                   show this help lines
 711     --keep-temps             keep temporary files (for debug. purposes)
 712     --without-latex-config   do not run LaTeX to determine configuration
 713     --with-version-suffix=suffix suffix of binary installed files
 714 '''
 715             sys.exit(0)
 716         elif op == '--without-latex-config':
 717             lyx_check_config = False
 718         elif op == '--keep-temps':
 719             lyx_keep_temps = True
 720         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
 721             version_suffix = op[22:]
 722         else:
 723             print "Unknown option", op
 724             sys.exit(1)
 725     #
 726     # set up log file for stdout and stderr
 727     log = open(logfile, 'w')
 728     sys.stdout = Tee(sys.stdout, log)
 729     sys.stderr = Tee(sys.stderr, log)
 730     # check if we run from the right directory
 731     srcdir = os.path.dirname(sys.argv[0])
 732     if srcdir == '':
 733         srcdir = '.'
 734     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
 735         print "configure: error: cannot find chkconfig.ltx script"
 736         sys.exit(1)
 737     setEnviron()
 738     createDirectories()
 739     windows_style_tex_paths = checkTeXPaths()
 740     ## Write the first part of outfile
 741     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
 742 # script. It contains default settings that have been determined by
 743 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
 744 # want to customize LyX, use LyX' Preferences dialog or modify directly
 745 # the "preferences" file instead. Any setting in that file will
 746 # override the values given here.
 747 ''')
 748     # check latex
 749     LATEX = checkLatex()
 750     checkFormatEntries()
 751     checkConverterEntries()
 752     (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
 753     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
 754     checkTeXAllowSpaces()
 755     if windows_style_tex_paths != '':
 756         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
 757     checkOtherEntries()
 758     # --without-latex-config can disable lyx_check_config
 759     checkLatexConfig( lyx_check_config and LATEX != '', bool_docbook, bool_linuxdoc)
 760     createLaTeXConfig()
 761     removeTempFiles()