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