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         logname = os.path.basename(inpname.replace('.ltx', '.log'))
 108         inpname = inpname.replace('~', '\\string~')
 109         os.write(fd, r'\relax')
 110         os.close(fd)
 111         latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
 112         if 'Error' in latex_out:
 113             print "configure: TeX engine needs posix-style paths in latex files"
 114             windows_style_tex_paths = 'false'
 115         else:
 116             print "configure: TeX engine needs windows-style paths in latex files"
 117             windows_style_tex_paths = 'true'
 118         removeFiles([tmpfname, logname, 'texput.log'])
 119     return windows_style_tex_paths
 120
 121
 122 ## Searching some useful programs
 123 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
 124     '''
 125         This function will search a program in $PATH plus given path
 126         If found, return directory and program name (not the options).
 127
 128         description: description of the program
 129
 130         progs: check programs, for each prog, the first word is used
 131             for searching but the whole string is used to replace
 132             %% for a rc_entry. So, feel free to add '$$i' etc for programs.
 133
 134         path: additional pathes
 135
 136         rc_entry: entry to outfile, can be
 137             1. emtpy: no rc entry will be added
 138             2. one pattern: %% will be replaced by the first found program,
 139                 or '' if no program is found.
 140             3. several patterns for each prog and not_found. This is used
 141                 when different programs have different usages. If you do not
 142                 want not_found entry to be added to the RC file, you can specify
 143                 an entry for each prog and use '' for the not_found entry.
 144
 145         not_found: the value that should be used instead of '' if no program
 146             was found
 147
 148     '''
 149     # one rc entry for each progs plus not_found entry
 150     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 151         print "rc entry should have one item or item for each prog and not_found."
 152         sys.exit(2)
 153     print 'checking for ' + description + '...'
 154     ## print '(' + ','.join(progs) + ')',
 155     for idx in range(len(progs)):
 156         # ac_prog may have options, ac_word is the command name
 157         ac_prog = progs[idx]
 158         ac_word = ac_prog.split(' ')[0]
 159         print '+checking for "' + ac_word + '"... ',
 160         path = os.environ["PATH"].split(os.pathsep) + path
 161         extlist = ['']
 162         if os.environ.has_key("PATHEXT"):
 163             extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 164         for ac_dir in path:
 165             for ext in extlist:
 166                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 167                     print ' yes'
 168                     # write rc entries for this command
 169                     if len(rc_entry) == 1:
 170                         addToRC(rc_entry[0].replace('%%', ac_prog))
 171                     elif len(rc_entry) > 1:
 172                         addToRC(rc_entry[idx].replace('%%', ac_prog))
 173                     return [ac_dir, ac_word]
 174         # if not successful
 175         print ' no'
 176     # write rc entries for 'not found'
 177     if len(rc_entry) > 0:  # the last one.
 178         addToRC(rc_entry[-1].replace('%%', not_found))
 179     return ['', not_found]
 180
 181
 182 def checkViewer(description, progs, rc_entry = [], path = []):
 183     ''' The same as checkProg, but for viewers and editors '''
 184     return checkProg(description, progs, rc_entry, path, not_found = 'auto')
 185
 186
 187 def checkDTLtools():
 188     ''' Check whether DTL tools are available (Windows only) '''
 189     # Find programs! Returned path is not used now
 190     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 191             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 192             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 193         dtl_tools = True
 194     else:
 195         dtl_tools = False
 196     return dtl_tools
 197
 198
 199 def checkLatex(dtl_tools):
 200     ''' Check latex, return lyx_check_config '''
 201     path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'platex $$i', 'latex2e $$i'])
 202     path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
 203     # use LATEX to convert from latex to dvi if PPLATEX is not available
 204     if PPLATEX == '':
 205         PPLATEX = LATEX
 206     if dtl_tools:
 207         # Windows only: DraftDVI
 208         addToRC(r'''\converter latex      dvi2       "%s"       "latex"
 209 \converter dvi2       dvi        "python -tt $$s/scripts/clean_dvi.py $$i $$o"  ""''' % PPLATEX)
 210     else:
 211         addToRC(r'\converter latex      dvi        "%s" "latex"' % PPLATEX)
 212     # no latex
 213     if LATEX != '':
 214         # Check if latex is usable
 215         writeToFile('chklatex.ltx', '''
 216 \\nonstopmode\\makeatletter
 217 \\ifx\\undefined\\documentclass\\else
 218   \\message{ThisIsLaTeX2e}
 219 \\fi
 220 \\@@end
 221 ''')
 222         # run latex on chklatex.ltx and check result
 223         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 224             # valid latex2e
 225             return LATEX
 226         else:
 227             print "Latex not usable (not LaTeX2e) "
 228         # remove temporary files
 229         removeFiles(['chklatex.ltx', 'chklatex.log'])
 230     return ''
 231
 232
 233 def checkFormatEntries(dtl_tools):
 234     ''' Check all formats (\Format entries) '''
 235     checkViewer('a Tgif viewer and editor', ['tgif'],
 236         rc_entry = [r'\Format tgif       obj     Tgif                   "" "%%" "%%"    "vector"'])
 237     #
 238     checkViewer('a FIG viewer and editor', ['xfig'],
 239         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"'])
 240     #
 241     checkViewer('a Grace viewer and editor', ['xmgrace'],
 242         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"'])
 243     #
 244     checkViewer('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 245         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""'])
 246     #
 247     path, iv = checkViewer('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'])
 248     path, ie = checkViewer('a raster image editor', ['gimp-remote', 'gimp'])
 249     addToRC(r'''\Format bmp        bmp     BMP                    "" "%s"       "%s"    ""
 250 \Format gif        gif     GIF                    "" "%s"       "%s"    ""
 251 \Format jpg        jpg     JPEG                   "" "%s"       "%s"    ""
 252 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""
 253 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""
 254 \Format png        png     PNG                    "" "%s"       "%s"    ""
 255 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""
 256 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""
 257 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""
 258 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""''' % \
 259         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 260     #
 261     checkViewer('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 262         'nedit', 'gedit', 'notepad'],
 263         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""
 264 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""
 265 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""
 266 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""
 267 \Format docbook    sgml    DocBook                B  "" "%%"    "document"
 268 \Format docbook-xml xml   "Docbook (XML)"         "" "" "%%"    "document"
 269 \Format literate   nw      NoWeb                  N  "" "%%"    "document"
 270 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"
 271 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document"
 272 \Format linuxdoc   sgml    LinuxDoc               x  "" "%%"    "document"
 273 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document"
 274 \Format text       txt    "Plain text"            a  "" "%%"    "document"
 275 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"
 276 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"
 277 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"
 278 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"''' ])
 279     #
 280     #checkProg('a Postscript interpreter', ['gs'],
 281     #  rc_entry = [ r'\ps_command "%%"' ])
 282     checkViewer('a Postscript previewer', ['kghostview', 'evince', 'gv', 'ghostview -swap'],
 283         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"
 284 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector"'''])
 285     #
 286     checkViewer('a PDF previewer', ['kpdf', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 287                     'gv', 'ghostview'],
 288         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector"
 289 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector"
 290 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector"'''])
 291     #
 292     checkViewer('a DVI previewer', ['xdvi', 'kdvi'],
 293         rc_entry = [r'\Format dvi        dvi     DVI                    D  "%%" ""      "document,vector"'])
 294     if dtl_tools:
 295         # Windows only: DraftDVI
 296         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"')
 297     #
 298     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 299         rc_entry = [r'\Format html       html    HTML                   H  "%%" ""      "document"'])
 300     #
 301     checkViewer('Noteedit', ['noteedit'],
 302         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"'])
 303     #
 304     checkViewer('an OpenDocument viewer', ['oowriter'],
 305         rc_entry = [r'\Format odt        odt     OpenDocument           "" "%%" "%%"    "document,vector"'])
 306     #
 307     # entried that do not need checkProg
 308     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""
 309 \Format fax        ""      Fax                    "" "" ""      "document"
 310 \Format lyx        lyx     LyX                    "" "" ""      ""
 311 \Format lyx13x     lyx13  "LyX 1.3.x"             "" "" ""      "document"
 312 \Format lyx14x     lyx14  "LyX 1.4.x"             "" "" ""      "document"
 313 \Format lyx15x     lyx15  "LyX 1.5.x"             "" "" ""      "document"
 314 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"
 315 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"
 316 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"
 317 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""
 318 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""
 319 \Format program    ""      Program                "" "" ""      ""
 320 \Format pstex      pstex_t PSTEX                  "" "" ""      ""
 321 \Format rtf        rtf    "Rich Text Format"      "" "" ""      "document,vector"
 322 \Format sxw        sxw    "OpenOffice.Org (sxw)"  ""  ""        ""      "document,vector"
 323 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"
 324 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"
 325 \Format word       doc    "MS Word"               W  "" ""      "document,vector"
 326 \Format wordhtml   html   "HTML (MS Word)"        "" ""        ""       "document"
 327 ''')
 328
 329
 330 def checkConverterEntries():
 331     ''' Check all converters (\converter entries) '''
 332     checkProg('the pdflatex program', ['pdflatex $$i'],
 333         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex"' ])
 334
 335     ''' If we're running LyX in-place then tex2lyx will be found in
 336             ../src/tex2lyx. Add this directory to the PATH temporarily and
 337             search for tex2lyx.
 338             Use PATH to avoid any problems with paths-with-spaces.
 339     '''
 340     path_orig = os.environ["PATH"]
 341     os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
 342         os.pathsep + path_orig
 343
 344     checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
 345         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 346 \converter literate   lyx        "%% -n -f $$i $$o"     ""'''])
 347
 348     os.environ["PATH"] = path_orig
 349
 350     #
 351     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 352         rc_entry = [ r'\converter literate   latex      "%%"    ""' ])
 353     #
 354     checkProg('an HTML -> LaTeX converter', ['html2latex $$i'],
 355         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 356     #
 357     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 358         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 359     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 360     path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 361         '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 362         'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 363         rc_entry = [ r'\converter latex      html       "%%"    "needaux"' ])
 364     if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 365       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 366     else:
 367       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 368
 369     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 370     path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 371         "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 372         "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 373         rc_entry = [ r'\converter latex      wordhtml   "%%"    "needaux"' ])
 374     if htmlconv.find('htlatex') >= 0:
 375       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 376     #
 377     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 378         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 379     #
 380     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 381         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 382     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 383     # Both SuSE and debian have oolatex
 384     checkProg('a LaTeX -> Open Document converter', ['oolatex $$i', 'oolatex.sh $$i', \
 385         '/usr/share/tex4ht/oolatex $$i', \
 386         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 387         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 388     # On windows it is called latex2rt.exe
 389     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 390         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 391     #
 392     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 393         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 394     #
 395     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 396         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 397     #
 398     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 399         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 400     #
 401     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 402         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 403     #
 404     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 405         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 406     #
 407     checkProg('a PDF to EPS converter', ['pdftops -eps $$i $$o'],
 408         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 409     #
 410     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 411         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 412     #
 413     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 414         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 415     #
 416     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 417         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 418     #
 419     path, dvipng = checkProg('dvipng', ['dvipng'])
 420     if dvipng == "dvipng":
 421         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 422     else:
 423         addToRC(r'\converter lyxpreview png        ""   ""')
 424     #
 425     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
 426         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 427     #
 428     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 429         rc_entry = [
 430             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 431 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 432 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 433             ''])
 434     #
 435     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 436         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 437     #
 438     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 439         rc_entry = [
 440             r'''\converter tgif       eps        "tgif -stdout -print -color -eps $$i > $$o"    ""
 441 \converter tgif       ppm        "tgif -stdout -print -color -ppm $$i > $$o"    ""
 442 \converter tgif       png        "tgif -stdout -print -color -png $$i > $$o"    ""
 443 \converter tgif       pdf        "tgif -stdout -print -color -pdf $$i > $$o"    ""''',
 444             ''])
 445     #
 446     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 447         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 448     #
 449     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 450         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 451     #
 452     checkProg('an EPS -> PDF converter', ['epstopdf'],
 453         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 454     #
 455     # no agr -> pdf converter, since the pdf library used by gracebat is not
 456     # free software and therefore not compiled in in many installations.
 457     # Fortunately, this is not a big problem, because we will use epstopdf to
 458     # convert from agr to pdf via eps without loss of quality.
 459     checkProg('a Grace -> Image converter', ['gracebat'],
 460         rc_entry = [
 461             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 462 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 463 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 464 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 465             ''])
 466     #
 467     #
 468     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 469     if (lilypond != ''):
 470         version_string = cmdOutput("lilypond --version")
 471         match = re.match('GNU LilyPond (\S+)', version_string)
 472         if match:
 473             version_number = match.groups()[0]
 474             version = version_number.split('.')
 475             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 476                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 477 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 478                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 479                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 480                 print '+  found LilyPond version %s.' % version_number
 481             else:
 482                 print '+  found LilyPond, but version %s is too old.' % version_number
 483         else:
 484             print '+  found LilyPond, but could not extract version number.'
 485     #
 486     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 487         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 488     #
 489     # FIXME: no rc_entry? comment it out
 490     # checkProg('Image converter', ['convert $$i $$o'])
 491     #
 492     # Entries that do not need checkProg
 493     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 494 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 495 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 496 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 497 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 498 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 499 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 500 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 501 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 502 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 503 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 504 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 505 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 506 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 507 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 508 ''')
 509
 510
 511 def checkLinuxDoc():
 512     ''' Check linuxdoc '''
 513     #
 514     path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
 515         rc_entry = [
 516         r'''\converter linuxdoc   lyx        "sgml2lyx $$i"     ""
 517 \converter linuxdoc   latex      "sgml2latex $$i"       ""
 518 \converter linuxdoc   dvi        "sgml2latex -o dvi $$i"        ""
 519 \converter linuxdoc   html       "sgml2html $$i"        ""''',
 520         r'''\converter linuxdoc   lyx        "" ""
 521 \converter linuxdoc   latex      ""     ""
 522 \converter linuxdoc   dvi        ""     ""
 523 \converter linuxdoc   html       ""     ""''' ])
 524     if LINUXDOC != '':
 525         return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
 526     else:
 527         return ('no', 'false', '')
 528
 529
 530 def checkDocBook():
 531     ''' Check docbook '''
 532     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
 533         rc_entry = [
 534             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 535 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 536             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 537 \converter docbook    html       "db2html $$i"  ""''',
 538             r'''\converter docbook    dvi        ""     ""
 539 \converter docbook    html       ""     ""'''])
 540     #
 541     if DOCBOOK != '':
 542         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 543     else:
 544         return ('no', 'false', '')
 545
 546
 547 def checkOtherEntries():
 548     ''' entries other than Format and Converter '''
 549     checkProg('a *roff formatter', ['groff', 'nroff'],
 550         rc_entry = [
 551             r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
 552             r'\plaintext_roff_command "tbl $$FName | nroff"',
 553             r'\plaintext_roff_command ""' ])
 554     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 555         rc_entry = [ r'\chktex_command "%%"' ])
 556     checkProg('a spellchecker', ['ispell'],
 557         rc_entry = [ r'\spell_command "%%"' ])
 558     ## FIXME: OCTAVE is not used anywhere
 559     # path, OCTAVE = checkProg('Octave', ['octave'])
 560     ## FIXME: MAPLE is not used anywhere
 561     # path, MAPLE = checkProg('Maple', ['maple'])
 562     checkProg('a spool command', ['lp', 'lpr'],
 563         rc_entry = [
 564             r'''\print_spool_printerprefix "-d "
 565 \print_spool_command "lp"''',
 566             r'''\print_spool_printerprefix "-P",
 567 \print_spool_command "lpr"''',
 568             ''])
 569     # Add the rest of the entries (no checkProg is required)
 570     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 571 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 572 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 573 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 574 ''')
 575
 576
 577 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
 578     ''' process layout file and get a line of result
 579
 580         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 581
 582         \DeclareLaTeXClass{article}
 583         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 584         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 585
 586         we expect output:
 587
 588         "article" "article" "article" "false"
 589         "scrbook" "scrbook" "book (koma-script)" "false"
 590         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 591     '''
 592     classname = file.split(os.sep)[-1].split('.')[0]
 593     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 594     p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 595     for line in open(file).readlines():
 596         res = p.search(line)
 597         if res != None:
 598             (classtype, optAll, opt, opt1, desc) = res.groups()
 599             avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
 600             if opt == None:
 601                 opt = classname
 602             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 603     print "Layout file without \DeclareXXClass line. "
 604     sys.exit(2)
 605
 606
 607 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
 608     ''' Explore the LaTeX configuration
 609         Return None (will be passed to sys.exit()) for success.
 610     '''
 611     print 'checking LaTeX configuration... ',
 612     # if --without-latex-config is forced, or if there is no previous
 613     # version of textclass.lst, re-generate a default file.
 614     if not os.path.isfile('textclass.lst') or not check_config:
 615         # remove the files only if we want to regenerate
 616         removeFiles(['textclass.lst', 'packages.lst'])
 617         #
 618         # Then, generate a default textclass.lst. In case configure.py
 619         # fails, we still have something to start lyx.
 620         print ' default values'
 621         print '+checking list of textclasses... '
 622         tx = open('textclass.lst', 'w')
 623         tx.write('''
 624 # This file declares layouts and their associated definition files
 625 # (include dir. relative to the place where this file is).
 626 # It contains only default values, since chkconfig.ltx could not be run
 627 # for some reason. Run ./configure.py if you need to update it after a
 628 # configuration change.
 629 ''')
 630         # build the list of available layout files and convert it to commands
 631         # for chkconfig.ltx
 632         foundClasses = []
 633         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 634             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 635             # valid file?
 636             if not os.path.isfile(file):
 637                 continue
 638             # get stuff between /xxxx.layout .
 639             classname = file.split(os.sep)[-1].split('.')[0]
 640             #  tr ' -' '__'`
 641             cleanclass = classname.replace(' ', '_')
 642             cleanclass = cleanclass.replace('-', '_')
 643             # make sure the same class is not considered twice
 644             if foundClasses.count(cleanclass) == 0: # not found before
 645                 foundClasses.append(cleanclass)
 646                 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
 647         tx.close()
 648         print '\tdone'
 649     if not check_config:
 650         return None
 651     # the following will generate textclass.lst.tmp, and packages.lst.tmp
 652     else:
 653         print '\tauto'
 654         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 655             'chkconfig.classes', 'chklayouts.tex'])
 656         rmcopy = False
 657         if not os.path.isfile( 'chkconfig.ltx' ):
 658             shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
 659             rmcopy = True
 660         writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
 661             % (linuxdoc_cmd, docbook_cmd) )
 662         # Construct the list of classes to test for.
 663         # build the list of available layout files and convert it to commands
 664         # for chkconfig.ltx
 665         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 666         testclasses = list()
 667         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 668             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 669             if not os.path.isfile(file):
 670                 continue
 671             classname = file.split(os.sep)[-1].split('.')[0]
 672             for line in open(file).readlines():
 673                 if p1.search(line) == None:
 674                     continue
 675                 if line[0] != '#':
 676                     print "Wrong input layout file with line '" + line
 677                     sys.exit(3)
 678                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 679                 break
 680         testclasses.sort()
 681         cl = open('chklayouts.tex', 'w')
 682         for line in testclasses:
 683             cl.write(line + '\n')
 684         cl.close()
 685         #
 686         # we have chklayouts.tex, then process it
 687         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 688         while True:
 689             line = fout.readline()
 690             if not line:
 691                 break;
 692             if re.match('^\+', line):
 693                 print line,
 694         # if the command succeeds, None will be returned
 695         ret = fout.close()
 696         #
 697         # currently, values in chhkconfig are only used to set
 698         # \font_encoding
 699         values = {}
 700         for line in open('chkconfig.vars').readlines():
 701             key, val = re.sub('-', '_', line).split('=')
 702             val = val.strip()
 703             values[key] = val.strip("'")
 704         # chk_fontenc may not exist
 705         try:
 706             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 707         except:
 708             pass
 709         if rmcopy:   # remove the copied file
 710             removeFiles( [ 'chkconfig.ltx' ] )
 711         # if configure successed, move textclass.lst.tmp to textclass.lst
 712         # and packages.lst.tmp to packages.lst
 713         if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
 714             and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
 715             shutil.move('textclass.lst.tmp', 'textclass.lst')
 716             shutil.move('packages.lst.tmp', 'packages.lst')
 717         return ret
 718
 719
 720 def checkModulesConfig():
 721   removeFiles(['lyxmodules.lst'])
 722
 723   print '+checking list of modules... '
 724   tx = open('lyxmodules.lst', 'w')
 725   tx.write('''## This file declares modules and their associated definition files.
 726 ## It has been automatically generated by configure
 727 ## Use "Options/Reconfigure" if you need to update it after a
 728 ## configuration change.
 729 ''')
 730   # build the list of available modules
 731   foundClasses = []
 732   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
 733       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
 734       # valid file?
 735       print file
 736       if not os.path.isfile(file):
 737           continue
 738       tx.write(processModuleFile(file, bool_docbook, bool_linuxdoc))
 739   tx.close()
 740   print '\tdone'
 741
 742
 743 def processModuleFile(file, bool_docbook, bool_linuxdoc):
 744     ''' process module file and get a line of result
 745
 746         The top of a module file should look like this:
 747           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
 748           #BeginDescription
 749           #...body of description...
 750           #EndDescription
 751           #Requires: [list of required modules]
 752           #Excludes: [list of excluded modules]
 753         The last two lines are optional
 754         We expect output:
 755           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
 756     '''
 757     p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
 758     r = re.compile(r'#+\s*Requires: (.*)')
 759     x = re.compile(r'#+\s*Excludes: (.*)')
 760     b = re.compile(r'#+\s*DescriptionBegin\s*$')
 761     e = re.compile(r'#+\s*DescriptionEnd\s*$')
 762
 763     modname = desc = pkgs = req = excl = ""
 764     readingDescription = False
 765     descLines = []
 766     filename = file.split(os.sep)[-1]
 767     filename = filename[:-7]
 768
 769     for line in open(file).readlines():
 770       if readingDescription:
 771         res = e.search(line)
 772         if res != None:
 773           readingDescription = False
 774           desc = " ".join(descLines)
 775           continue
 776         descLines.append(line[1:].strip())
 777         continue
 778       res = b.search(line)
 779       if res != None:
 780         readingDescription = True
 781         continue
 782       res = p.search(line)
 783       if res != None:
 784           (pkgs, modname) = res.groups()
 785           if pkgs == None:
 786             pkgs = ""
 787           else:
 788             tmp = [s.strip() for s in pkgs.split(",")]
 789             pkgs = ",".join(tmp)
 790           continue
 791       res = r.search(line)
 792       if res != None:
 793         req = res.group(1)
 794         tmp = [s.strip() for s in req.split("|")]
 795         req = "|".join(tmp)
 796         continue
 797       res = x.search(line)
 798       if res != None:
 799         excl = res.group(1)
 800         tmp = [s.strip() for s in excl.split("|")]
 801         excl = "|".join(tmp)
 802         continue
 803     if modname != "":
 804         return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
 805     print "Module file without \DeclareLyXModule line. "
 806     sys.exit(2)
 807
 808
 809 def checkTeXAllowSpaces():
 810     ''' Let's check whether spaces are allowed in TeX file names '''
 811     tex_allows_spaces = 'false'
 812     if lyx_check_config:
 813         print "Checking whether TeX allows spaces in file names... ",
 814         writeToFile('a b.tex', r'\message{working^^J}' )
 815         if os.name == 'nt':
 816             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
 817         else:
 818             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
 819         if 'working' in latex_out:
 820             print 'yes'
 821             tex_allows_spaces = 'true'
 822         else:
 823             print 'no'
 824             tex_allows_spaces = 'false'
 825         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
 826         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
 827
 828
 829 def removeTempFiles():
 830     # Final clean-up
 831     if not lyx_keep_temps:
 832         removeFiles(['chkconfig.vars',  \
 833             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
 834             'chklayouts.tex', 'missfont.log',
 835             'chklatex.ltx', 'chklatex.log'])
 836
 837
 838 if __name__ == '__main__':
 839     lyx_check_config = True
 840     outfile = 'lyxrc.defaults'
 841     rc_entries = ''
 842     lyx_keep_temps = False
 843     version_suffix = ''
 844     logfile = 'configure.log'
 845     ## Parse the command line
 846     for op in sys.argv[1:]:   # default shell/for list is $*, the options
 847         if op in [ '-help', '--help', '-h' ]:
 848             print '''Usage: configure [options]
 849 Options:
 850     --help                   show this help lines
 851     --keep-temps             keep temporary files (for debug. purposes)
 852     --without-latex-config   do not run LaTeX to determine configuration
 853     --with-version-suffix=suffix suffix of binary installed files
 854 '''
 855             sys.exit(0)
 856         elif op == '--without-latex-config':
 857             lyx_check_config = False
 858         elif op == '--keep-temps':
 859             lyx_keep_temps = True
 860         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
 861             version_suffix = op[22:]
 862         else:
 863             print "Unknown option", op
 864             sys.exit(1)
 865     #
 866     # set up log file for stdout and stderr
 867     log = open(logfile, 'w')
 868     sys.stdout = Tee(sys.stdout, log)
 869     sys.stderr = Tee(sys.stderr, log)
 870     # check if we run from the right directory
 871     srcdir = os.path.dirname(sys.argv[0])
 872     if srcdir == '':
 873         srcdir = '.'
 874     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
 875         print "configure: error: cannot find chkconfig.ltx script"
 876         sys.exit(1)
 877     setEnviron()
 878     createDirectories()
 879     windows_style_tex_paths = checkTeXPaths()
 880     dtl_tools = checkDTLtools()
 881     ## Write the first part of outfile
 882     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
 883 # script. It contains default settings that have been determined by
 884 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
 885 # want to customize LyX, use LyX' Preferences dialog or modify directly
 886 # the "preferences" file instead. Any setting in that file will
 887 # override the values given here.
 888 ''')
 889     # check latex
 890     LATEX = checkLatex(dtl_tools)
 891     checkFormatEntries(dtl_tools)
 892     checkConverterEntries()
 893     (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
 894     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
 895     checkTeXAllowSpaces()
 896     if windows_style_tex_paths != '':
 897         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
 898     checkOtherEntries()
 899     # --without-latex-config can disable lyx_check_config
 900     ret = checkLatexConfig(lyx_check_config and LATEX != '',
 901         bool_docbook, bool_linuxdoc)
 902     checkModulesConfig() #lyx_check_config and LATEX != '')
 903     removeTempFiles()
 904     # The return error code can be 256. Because most systems expect an error code
 905     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
 906     # a None for success, 'ret is not None' is used to exit.
 907     sys.exit(ret is not None)