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