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