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