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