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