bos@3: #!/usr/bin/python
bos@4: #
bos@4: # This program takes something that resembles a shell script and runs
bos@4: # it, spitting input (commands from the script) and output into text
bos@4: # files, for use in examples.
bos@3: 
bos@3: import cStringIO
bos@3: import os
bos@3: import pty
bos@3: import re
bos@4: import shutil
bos@6: import signal
bos@36: import stat
bos@3: import sys
bos@4: import tempfile
bos@4: import time
bos@3: 
bos@4: def tex_escape(s):
bos@4:     if '\\' in s:
bos@4:         s = s.replace('\\', '\\\\')
bos@4:     if '{' in s:
bos@4:         s = s.replace('{', '\\{')
bos@4:     if '}' in s:
bos@4:         s = s.replace('}', '\\}')
bos@4:     return s
bos@4:         
bos@3: class example:
bos@4:     shell = '/bin/bash'
bos@6:     prompt = '__run_example_prompt__\n'
bos@4:     pi_re = re.compile('#\$\s*(name):\s*(.*)$')
bos@4:     
bos@3:     def __init__(self, name):
bos@3:         self.name = name
bos@3: 
bos@3:     def parse(self):
bos@4:         '''yield each hunk of input from the file.'''
bos@3:         fp = open(self.name)
bos@3:         cfp = cStringIO.StringIO()
bos@3:         for line in fp:
bos@3:             cfp.write(line)
bos@3:             if not line.rstrip().endswith('\\'):
bos@3:                 yield cfp.getvalue()
bos@3:                 cfp.seek(0)
bos@3:                 cfp.truncate()
bos@3:         
bos@3:     def status(self, s):
bos@3:         sys.stdout.write(s)
bos@3:         if not s.endswith('\n'):
bos@3:             sys.stdout.flush()
bos@3: 
bos@6:     def send(self, s):
bos@6:         self.cfp.write(s)
bos@6:         self.cfp.flush()
bos@6: 
bos@6:     def receive(self):
bos@6:         out = cStringIO.StringIO()
bos@4:         while True:
bos@6:             s = self.cfp.readline().replace('\r\n', '\n')
bos@6:             if not s or s == self.prompt:
bos@6:                 break
bos@6:             out.write(s)
bos@6:         return out.getvalue()
bos@4:         
bos@6:     def sendreceive(self, s):
bos@6:         self.send(s)
bos@6:         r = self.receive()
bos@6:         if r.startswith(s):
bos@6:             r = r[len(s):]
bos@6:         return r
bos@6:     
bos@3:     def run(self):
bos@3:         ofp = None
bos@4:         basename = os.path.basename(self.name)
bos@4:         self.status('running %s ' % basename)
bos@4:         tmpdir = tempfile.mkdtemp(prefix=basename)
bos@6:         rcfile = os.path.join(tmpdir, '.bashrc')
bos@6:         rcfp = open(rcfile, 'w')
bos@6:         print >> rcfp, 'PS1="%s"' % self.prompt
bos@6:         print >> rcfp, 'unset HISTFILE'
bos@19:         print >> rcfp, 'export EXAMPLE_DIR="%s"' % os.getcwd()
bos@6:         print >> rcfp, 'export LANG=C'
bos@6:         print >> rcfp, 'export LC_ALL=C'
bos@6:         print >> rcfp, 'export TZ=GMT'
bos@6:         print >> rcfp, 'export HGRC="%s/.hgrc"' % tmpdir
bos@6:         print >> rcfp, 'export HGRCPATH=$HGRC'
bos@6:         print >> rcfp, 'cd %s' % tmpdir
bos@6:         rcfp.close()
bos@6:         pid, fd = pty.fork()
bos@6:         if pid == 0:
bos@6:             #os.execl(self.shell, self.shell)
benoit@22:             os.system('/bin/bash --noediting --noprofile --norc')
bos@6:             sys.exit(0)
bos@6:         self.cfp = os.fdopen(fd, 'w+')
bos@4:         try:
benoit@22:             # setup env and prompt
benoit@22:             self.sendreceive('source %s\n\n' % rcfile)
bos@4:             for hunk in self.parse():
bos@4:                 # is this line a processing instruction?
bos@4:                 m = self.pi_re.match(hunk)
bos@4:                 if m:
bos@4:                     pi, rest = m.groups()
bos@4:                     if pi == 'name':
bos@4:                         self.status('.')
bos@4:                         out = rest
bos@4:                         assert os.sep not in out
bos@4:                         if out:
bos@4:                             ofp = open('%s.%s.out' % (self.name, out), 'w')
bos@4:                         else:
bos@4:                             ofp = None
bos@6:                 elif hunk.strip():
bos@4:                     # it's something we should execute
bos@6:                     output = self.sendreceive(hunk)
bos@6:                     if not ofp:
bos@6:                         continue
bos@6:                     # first, print the command we ran
bos@6:                     if not hunk.startswith('#'):
bos@6:                         nl = hunk.endswith('\n')
bos@6:                         hunk = ('$ \\textbf{%s}' %
bos@6:                                 tex_escape(hunk.rstrip('\n')))
bos@6:                         if nl: hunk += '\n'
bos@6:                     ofp.write(hunk)
bos@4:                     # then its output
bos@19:                     ofp.write(tex_escape(output))
bos@4:             self.status('\n')
bos@45:             open(self.name + '.run', 'w')
bos@4:         finally:
bos@6:             try:
bos@6:                 output = self.sendreceive('exit\n')
bos@6:                 if ofp:
bos@6:                     ofp.write(output)
bos@6:                 self.cfp.close()
bos@6:             except IOError:
bos@6:                 pass
bos@6:             os.kill(pid, signal.SIGTERM)
bos@4:             os.wait()
bos@4:             shutil.rmtree(tmpdir)
bos@3: 
bos@3: def main(path='.'):
bos@3:     args = sys.argv[1:]
bos@3:     if args:
bos@3:         for a in args:
bos@3:             example(a).run()
bos@3:         return
bos@3:     for name in os.listdir(path):
bos@3:         if name == 'run-example' or name.startswith('.'): continue
bos@3:         if name.endswith('.out') or name.endswith('~'): continue
bos@45:         if name.endswith('.run'): continue
bos@19:         pathname = os.path.join(path, name)
bos@36:         st = os.lstat(pathname)
bos@36:         if stat.S_ISREG(st.st_mode) and st.st_mode & 0111:
bos@19:             example(pathname).run()
bos@4:     print >> open(os.path.join(path, '.run'), 'w'), time.asctime()
bos@3: 
bos@3: if __name__ == '__main__':
bos@3:     main()