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