lib/configure.py

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