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', 'gnuhtml2latex $$i', \
 355         'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
 356         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 357     #
 358     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 359         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 360     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 361     path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 362         '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 363         'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 364         rc_entry = [ r'\converter latex      html       "%%"    "needaux"' ])
 365     if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 366       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 367     else:
 368       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 369
 370     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 371     path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 372         "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 373         "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 374         rc_entry = [ r'\converter latex      wordhtml   "%%"    "needaux"' ])
 375     if htmlconv.find('htlatex') >= 0:
 376       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 377     #
 378     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 379         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 380     #
 381     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 382         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 383     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 384     # Both SuSE and debian have oolatex
 385     checkProg('a LaTeX -> Open Document converter', [
 386         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\'', \
 387         'oolatex $$i', 'oolatex.sh $$i', \
 388         '/usr/share/tex4ht/oolatex $$i'],
 389         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 390     # On windows it is called latex2rt.exe
 391     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 392         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 393     #
 394     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 395         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 396     #
 397     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 398         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 399     #
 400     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 401         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 402     #
 403     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 404         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 405     #
 406     checkProg('a PS to EPS converter', ['ps2eps $$i'],
 407         rc_entry = [ r'\converter ps         eps      "%%"      ""' ])
 408     #
 409     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 410         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 411     #
 412     checkProg('a PDF to EPS converter', ['pdftops -eps $$i $$o'],
 413         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 414     #
 415     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 416         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 417     #
 418     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 419         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 420     #
 421     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 422         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 423     #
 424     path, dvipng = checkProg('dvipng', ['dvipng'])
 425     if dvipng == "dvipng":
 426         addToRC(r'\converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py"        ""')
 427     else:
 428         addToRC(r'\converter lyxpreview png        ""   ""')
 429     #
 430     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i'],
 431         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 432     #
 433     checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
 434         rc_entry = [
 435             r'''\converter fig        eps        "fig2dev -L eps $$i $$o"       ""
 436 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 437 \converter fig        png        "fig2dev -L png $$i $$o"       ""''',
 438             ''])
 439     #
 440     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 441         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 442     #
 443     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 444         rc_entry = [
 445             r'''\converter tgif       eps        "tgif -stdout -print -color -eps $$i > $$o"    ""
 446 \converter tgif       ppm        "tgif -stdout -print -color -ppm $$i > $$o"    ""
 447 \converter tgif       png        "tgif -stdout -print -color -png $$i > $$o"    ""
 448 \converter tgif       pdf        "tgif -stdout -print -color -pdf $$i > $$o"    ""''',
 449             ''])
 450     #
 451     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 452         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 453     #
 454     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 455         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 456     #
 457     checkProg('an EPS -> PDF converter', ['epstopdf'],
 458         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 459     #
 460     # no agr -> pdf converter, since the pdf library used by gracebat is not
 461     # free software and therefore not compiled in in many installations.
 462     # Fortunately, this is not a big problem, because we will use epstopdf to
 463     # convert from agr to pdf via eps without loss of quality.
 464     checkProg('a Grace -> Image converter', ['gracebat'],
 465         rc_entry = [
 466             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 467 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 468 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 469 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 470             ''])
 471     #
 472     #
 473     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 474     if (lilypond != ''):
 475         version_string = cmdOutput("lilypond --version")
 476         match = re.match('GNU LilyPond (\S+)', version_string)
 477         if match:
 478             version_number = match.groups()[0]
 479             version = version_number.split('.')
 480             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 481                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps $$i" ""
 482 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 483                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 484                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf $$i"      ""')
 485                 print '+  found LilyPond version %s.' % version_number
 486             else:
 487                 print '+  found LilyPond, but version %s is too old.' % version_number
 488         else:
 489             print '+  found LilyPond, but could not extract version number.'
 490     #
 491     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 492         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 493     #
 494     # FIXME: no rc_entry? comment it out
 495     # checkProg('Image converter', ['convert $$i $$o'])
 496     #
 497     # Entries that do not need checkProg
 498     addToRC(r'''\converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py"  ""
 499 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 500 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 501 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 502 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 503 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""
 504 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 505 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 506 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 507 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 508 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 509 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 510 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 511 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 512 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 513 ''')
 514
 515
 516 def checkLinuxDoc():
 517     ''' Check linuxdoc '''
 518     #
 519     path, LINUXDOC = checkProg('SGML-tools 1.x (LinuxDoc)', ['sgml2lyx'],
 520         rc_entry = [
 521         r'''\converter linuxdoc   lyx        "sgml2lyx $$i"     ""
 522 \converter linuxdoc   latex      "sgml2latex $$i"       ""
 523 \converter linuxdoc   dvi        "sgml2latex -o dvi $$i"        ""
 524 \converter linuxdoc   html       "sgml2html $$i"        ""''',
 525         r'''\converter linuxdoc   lyx        "" ""
 526 \converter linuxdoc   latex      ""     ""
 527 \converter linuxdoc   dvi        ""     ""
 528 \converter linuxdoc   html       ""     ""''' ])
 529     if LINUXDOC != '':
 530         return ('yes', 'true', '\\def\\haslinuxdoc{yes}')
 531     else:
 532         return ('no', 'false', '')
 533
 534
 535 def checkDocBook():
 536     ''' Check docbook '''
 537     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook) or db2x scripts', ['sgmltools', 'db2dvi'],
 538         rc_entry = [
 539             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 540 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 541             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 542 \converter docbook    html       "db2html $$i"  ""''',
 543             r'''\converter docbook    dvi        ""     ""
 544 \converter docbook    html       ""     ""'''])
 545     #
 546     if DOCBOOK != '':
 547         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 548     else:
 549         return ('no', 'false', '')
 550
 551
 552 def checkOtherEntries():
 553     ''' entries other than Format and Converter '''
 554     checkProg('a *roff formatter', ['groff', 'nroff'],
 555         rc_entry = [
 556             r'\plaintext_roff_command "groff -t -Tlatin1 $$FName"',
 557             r'\plaintext_roff_command "tbl $$FName | nroff"',
 558             r'\plaintext_roff_command ""' ])
 559     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 560         rc_entry = [ r'\chktex_command "%%"' ])
 561     checkProg('a spellchecker', ['ispell'],
 562         rc_entry = [ r'\spell_command "%%"' ])
 563     ## FIXME: OCTAVE is not used anywhere
 564     # path, OCTAVE = checkProg('Octave', ['octave'])
 565     ## FIXME: MAPLE is not used anywhere
 566     # path, MAPLE = checkProg('Maple', ['maple'])
 567     checkProg('a spool command', ['lp', 'lpr'],
 568         rc_entry = [
 569             r'''\print_spool_printerprefix "-d "
 570 \print_spool_command "lp"''',
 571             r'''\print_spool_printerprefix "-P",
 572 \print_spool_command "lpr"''',
 573             ''])
 574     # Add the rest of the entries (no checkProg is required)
 575     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
 576 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 577 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
 578 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
 579 ''')
 580
 581
 582 def processLayoutFile(file, bool_docbook, bool_linuxdoc):
 583     ''' process layout file and get a line of result
 584
 585         Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
 586
 587         \DeclareLaTeXClass{article}
 588         \DeclareLaTeXClass[scrbook]{book (koma-script)}
 589         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
 590
 591         we expect output:
 592
 593         "article" "article" "article" "false"
 594         "scrbook" "scrbook" "book (koma-script)" "false"
 595         "svjog" "svjour" "article (Springer - svjour/jog)" "false"
 596     '''
 597     classname = file.split(os.sep)[-1].split('.')[0]
 598     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
 599     p = re.compile(r'\Declare(LaTeX|DocBook|LinuxDoc)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
 600     for line in open(file).readlines():
 601         res = p.search(line)
 602         if res != None:
 603             (classtype, optAll, opt, opt1, desc) = res.groups()
 604             avai = {'LaTeX':'false', 'DocBook':bool_docbook, 'LinuxDoc':bool_linuxdoc}[classtype]
 605             if opt == None:
 606                 opt = classname
 607             return '"%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai)
 608     print "Layout file without \DeclareXXClass line. "
 609     sys.exit(2)
 610
 611
 612 def checkLatexConfig(check_config, bool_docbook, bool_linuxdoc):
 613     ''' Explore the LaTeX configuration
 614         Return None (will be passed to sys.exit()) for success.
 615     '''
 616     print 'checking LaTeX configuration... ',
 617     # if --without-latex-config is forced, or if there is no previous
 618     # version of textclass.lst, re-generate a default file.
 619     if not os.path.isfile('textclass.lst') or not check_config:
 620         # remove the files only if we want to regenerate
 621         removeFiles(['textclass.lst', 'packages.lst'])
 622         #
 623         # Then, generate a default textclass.lst. In case configure.py
 624         # fails, we still have something to start lyx.
 625         print ' default values'
 626         print '+checking list of textclasses... '
 627         tx = open('textclass.lst', 'w')
 628         tx.write('''
 629 # This file declares layouts and their associated definition files
 630 # (include dir. relative to the place where this file is).
 631 # It contains only default values, since chkconfig.ltx could not be run
 632 # for some reason. Run ./configure.py if you need to update it after a
 633 # configuration change.
 634 ''')
 635         # build the list of available layout files and convert it to commands
 636         # for chkconfig.ltx
 637         foundClasses = []
 638         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 639             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 640             # valid file?
 641             if not os.path.isfile(file):
 642                 continue
 643             # get stuff between /xxxx.layout .
 644             classname = file.split(os.sep)[-1].split('.')[0]
 645             #  tr ' -' '__'`
 646             cleanclass = classname.replace(' ', '_')
 647             cleanclass = cleanclass.replace('-', '_')
 648             # make sure the same class is not considered twice
 649             if foundClasses.count(cleanclass) == 0: # not found before
 650                 foundClasses.append(cleanclass)
 651                 tx.write(processLayoutFile(file, bool_docbook, bool_linuxdoc))
 652         tx.close()
 653         print '\tdone'
 654     if not check_config:
 655         return None
 656     # the following will generate textclass.lst.tmp, and packages.lst.tmp
 657     else:
 658         print '\tauto'
 659         removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
 660             'chkconfig.classes', 'chklayouts.tex'])
 661         rmcopy = False
 662         if not os.path.isfile( 'chkconfig.ltx' ):
 663             shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
 664             rmcopy = True
 665         writeToFile('wrap_chkconfig.ltx', '%s\n%s\n\\input{chkconfig.ltx}\n' \
 666             % (linuxdoc_cmd, docbook_cmd) )
 667         # Construct the list of classes to test for.
 668         # build the list of available layout files and convert it to commands
 669         # for chkconfig.ltx
 670         p1 = re.compile(r'\Declare(LaTeX|DocBook)Class')
 671         testclasses = list()
 672         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
 673             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
 674             if not os.path.isfile(file):
 675                 continue
 676             classname = file.split(os.sep)[-1].split('.')[0]
 677             for line in open(file).readlines():
 678                 if p1.search(line) == None:
 679                     continue
 680                 if line[0] != '#':
 681                     print "Wrong input layout file with line '" + line
 682                     sys.exit(3)
 683                 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
 684                 break
 685         testclasses.sort()
 686         cl = open('chklayouts.tex', 'w')
 687         for line in testclasses:
 688             cl.write(line + '\n')
 689         cl.close()
 690         #
 691         # we have chklayouts.tex, then process it
 692         fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
 693         while True:
 694             line = fout.readline()
 695             if not line:
 696                 break;
 697             if re.match('^\+', line):
 698                 print line,
 699         # if the command succeeds, None will be returned
 700         ret = fout.close()
 701         #
 702         # currently, values in chhkconfig are only used to set
 703         # \font_encoding
 704         values = {}
 705         for line in open('chkconfig.vars').readlines():
 706             key, val = re.sub('-', '_', line).split('=')
 707             val = val.strip()
 708             values[key] = val.strip("'")
 709         # chk_fontenc may not exist
 710         try:
 711             addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
 712         except:
 713             pass
 714         if rmcopy:   # remove the copied file
 715             removeFiles( [ 'chkconfig.ltx' ] )
 716         # if configure successed, move textclass.lst.tmp to textclass.lst
 717         # and packages.lst.tmp to packages.lst
 718         if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
 719             and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
 720             shutil.move('textclass.lst.tmp', 'textclass.lst')
 721             shutil.move('packages.lst.tmp', 'packages.lst')
 722         return ret
 723
 724
 725 def checkModulesConfig():
 726   removeFiles(['lyxmodules.lst'])
 727
 728   print '+checking list of modules... '
 729   tx = open('lyxmodules.lst', 'w')
 730   tx.write('''## This file declares modules and their associated definition files.
 731 ## It has been automatically generated by configure
 732 ## Use "Options/Reconfigure" if you need to update it after a
 733 ## configuration change.
 734 ''')
 735   # build the list of available modules
 736   foundClasses = []
 737   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
 738       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
 739       # valid file?
 740       print file
 741       if not os.path.isfile(file):
 742           continue
 743       tx.write(processModuleFile(file, bool_docbook, bool_linuxdoc))
 744   tx.close()
 745   print '\tdone'
 746
 747
 748 def processModuleFile(file, bool_docbook, bool_linuxdoc):
 749     ''' process module file and get a line of result
 750
 751         The top of a module file should look like this:
 752           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
 753           #BeginDescription
 754           #...body of description...
 755           #EndDescription
 756           #Requires: [list of required modules]
 757           #Excludes: [list of excluded modules]
 758         The last two lines are optional
 759         We expect output:
 760           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes"
 761     '''
 762     p = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
 763     r = re.compile(r'#+\s*Requires: (.*)')
 764     x = re.compile(r'#+\s*Excludes: (.*)')
 765     b = re.compile(r'#+\s*DescriptionBegin\s*$')
 766     e = re.compile(r'#+\s*DescriptionEnd\s*$')
 767
 768     modname = desc = pkgs = req = excl = ""
 769     readingDescription = False
 770     descLines = []
 771     filename = file.split(os.sep)[-1]
 772     filename = filename[:-7]
 773
 774     for line in open(file).readlines():
 775       if readingDescription:
 776         res = e.search(line)
 777         if res != None:
 778           readingDescription = False
 779           desc = " ".join(descLines)
 780           continue
 781         descLines.append(line[1:].strip())
 782         continue
 783       res = b.search(line)
 784       if res != None:
 785         readingDescription = True
 786         continue
 787       res = p.search(line)
 788       if res != None:
 789           (pkgs, modname) = res.groups()
 790           if pkgs == None:
 791             pkgs = ""
 792           else:
 793             tmp = [s.strip() for s in pkgs.split(",")]
 794             pkgs = ",".join(tmp)
 795           continue
 796       res = r.search(line)
 797       if res != None:
 798         req = res.group(1)
 799         tmp = [s.strip() for s in req.split("|")]
 800         req = "|".join(tmp)
 801         continue
 802       res = x.search(line)
 803       if res != None:
 804         excl = res.group(1)
 805         tmp = [s.strip() for s in excl.split("|")]
 806         excl = "|".join(tmp)
 807         continue
 808     if modname != "":
 809         return '"%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl)
 810     print "Module file without \DeclareLyXModule line. "
 811     sys.exit(2)
 812
 813
 814 def checkTeXAllowSpaces():
 815     ''' Let's check whether spaces are allowed in TeX file names '''
 816     tex_allows_spaces = 'false'
 817     if lyx_check_config:
 818         print "Checking whether TeX allows spaces in file names... ",
 819         writeToFile('a b.tex', r'\message{working^^J}' )
 820         if os.name == 'nt':
 821             latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
 822         else:
 823             latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
 824         if 'working' in latex_out:
 825             print 'yes'
 826             tex_allows_spaces = 'true'
 827         else:
 828             print 'no'
 829             tex_allows_spaces = 'false'
 830         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
 831         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
 832
 833
 834 def removeTempFiles():
 835     # Final clean-up
 836     if not lyx_keep_temps:
 837         removeFiles(['chkconfig.vars',  \
 838             'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
 839             'chklayouts.tex', 'missfont.log',
 840             'chklatex.ltx', 'chklatex.log'])
 841
 842
 843 if __name__ == '__main__':
 844     lyx_check_config = True
 845     outfile = 'lyxrc.defaults'
 846     rc_entries = ''
 847     lyx_keep_temps = False
 848     version_suffix = ''
 849     logfile = 'configure.log'
 850     ## Parse the command line
 851     for op in sys.argv[1:]:   # default shell/for list is $*, the options
 852         if op in [ '-help', '--help', '-h' ]:
 853             print '''Usage: configure [options]
 854 Options:
 855     --help                   show this help lines
 856     --keep-temps             keep temporary files (for debug. purposes)
 857     --without-latex-config   do not run LaTeX to determine configuration
 858     --with-version-suffix=suffix suffix of binary installed files
 859 '''
 860             sys.exit(0)
 861         elif op == '--without-latex-config':
 862             lyx_check_config = False
 863         elif op == '--keep-temps':
 864             lyx_keep_temps = True
 865         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
 866             version_suffix = op[22:]
 867         else:
 868             print "Unknown option", op
 869             sys.exit(1)
 870     #
 871     # set up log file for stdout and stderr
 872     log = open(logfile, 'w')
 873     sys.stdout = Tee(sys.stdout, log)
 874     sys.stderr = Tee(sys.stderr, log)
 875     # check if we run from the right directory
 876     srcdir = os.path.dirname(sys.argv[0])
 877     if srcdir == '':
 878         srcdir = '.'
 879     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
 880         print "configure: error: cannot find chkconfig.ltx script"
 881         sys.exit(1)
 882     setEnviron()
 883     createDirectories()
 884     windows_style_tex_paths = checkTeXPaths()
 885     dtl_tools = checkDTLtools()
 886     ## Write the first part of outfile
 887     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
 888 # script. It contains default settings that have been determined by
 889 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
 890 # want to customize LyX, use LyX' Preferences dialog or modify directly
 891 # the "preferences" file instead. Any setting in that file will
 892 # override the values given here.
 893 ''')
 894     # check latex
 895     LATEX = checkLatex(dtl_tools)
 896     checkFormatEntries(dtl_tools)
 897     checkConverterEntries()
 898     (chk_linuxdoc, bool_linuxdoc, linuxdoc_cmd) = checkLinuxDoc()
 899     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
 900     checkTeXAllowSpaces()
 901     if windows_style_tex_paths != '':
 902         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
 903     checkOtherEntries()
 904     # --without-latex-config can disable lyx_check_config
 905     ret = checkLatexConfig(lyx_check_config and LATEX != '',
 906         bool_docbook, bool_linuxdoc)
 907     checkModulesConfig() #lyx_check_config and LATEX != '')
 908     removeTempFiles()
 909     # The return error code can be 256. Because most systems expect an error code
 910     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
 911     # a None for success, 'ret is not None' is used to exit.
 912     sys.exit(ret is not None)