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