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