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