terminal.py

# Ajaxterm was written by Antony Lesuisse (email: al AT udev.org), 
# License Public Domain.

# Terminal class made serializable/picklealbe by using a Metaclass
# (c) 2009 FastSoft
# MIT License

import array, cgi, re

def TerminalMetaclass(name, bases, attys):
    self = type(name, bases, attys)
    self.esc_seq={
        "\x00": None,
        "\x05": self.esc_da,
        "\x07": None,
        "\x08": self.esc_0x08,
        "\x09": self.esc_0x09,
        "\x0a": self.esc_0x0a,
        "\x0b": self.esc_0x0a,
        "\x0c": self.esc_0x0a,
        "\x0d": self.esc_0x0d,
        "\x0e": None,
        "\x0f": None,
        "\x1b#8": None,
        "\x1b=": None,
        "\x1b>": None,
        "\x1b(0": None,
        "\x1b(A": None,
        "\x1b(B": None,
        "\x1b[c": self.esc_da,
        "\x1b[0c": self.esc_da,
        "\x1b]R": None,
        "\x1b7": self.esc_save,
        "\x1b8": self.esc_restore,
        "\x1bD": None,
        "\x1bE": None,
        "\x1bH": None,
        "\x1bM": self.esc_ri,
        "\x1bN": None,
        "\x1bO": None,
        "\x1bZ": self.esc_da,
        "\x1ba": None,
        "\x1bc": self.reset,
        "\x1bn": None,
        "\x1bo": None,
    }

    for k,v in self.esc_seq.items():
        if v==None:
            self.esc_seq[k]=self.esc_ignore
    # regex
    d={
        r'\[\??([0-9;]*)([@ABCDEFGHJKLMPXacdefghlmnqrstu`])' : self.csi_dispatch,
        r'\]([^\x07]+)\x07' : self.esc_ignore,
    }
    self.esc_re=[]
    for k,v in d.items():
        self.esc_re.append((re.compile('\x1b'+k),v))
    # define csi sequences
    self.csi_seq={
        '@': (self.csi_at,[1]),
        '`': (self.csi_G,[1]),
        'J': (self.csi_J,[0]),
        'K': (self.csi_K,[0]),
    }
    for i in [i[4] for i in dir(self) if i.startswith('csi_') and len(i)==5]:
        if not self.csi_seq.has_key(i):
            self.csi_seq[i]=(getattr(self,'csi_'+i),[1])

    return self

class Terminal(object):
    __metaclass__ = TerminalMetaclass

    def __init__(self,width=80,height=24):
        self.width=width
        self.height=height
        self.init()
        self.reset()
    def init(self):
        # Init 0-256 to latin1 and html translation table
        self.trl1=""
        for i in range(256):
            if i<32:
                self.trl1+=" "
            elif i<127 or i>160:
                self.trl1+=chr(i)
            else:
                self.trl1+="?"
        self.trhtml=""
        for i in range(256):
            if i==0x0a or (i>32 and i<127) or i>160:
                self.trhtml+=chr(i)
            elif i<=32:
                self.trhtml+="\xa0"
            else:
                self.trhtml+="?"
    def reset(self,s=""):
        self.scr=array.array('i',[0x000700]*(self.width*self.height))
        self.st=0
        self.sb=self.height-1
        self.cx_bak=self.cx=0
        self.cy_bak=self.cy=0
        self.cl=0
        self.sgr=0x000700
        self.buf=""
        self.outbuf=""
        self.last_html=""
    def peek(self,y1,x1,y2,x2):
        return self.scr[self.width*y1+x1:self.width*y2+x2]
    def poke(self,y,x,s):
        pos=self.width*y+x
        self.scr[pos:pos+len(s)]=s
    def zero(self,y1,x1,y2,x2):
        w=self.width*(y2-y1)+x2-x1+1
        z=array.array('i',[0x000700]*w)
        self.scr[self.width*y1+x1:self.width*y2+x2+1]=z
    def scroll_up(self,y1,y2):
        self.poke(y1,0,self.peek(y1+1,0,y2,self.width))
        self.zero(y2,0,y2,self.width-1)
    def scroll_down(self,y1,y2):
        self.poke(y1+1,0,self.peek(y1,0,y2-1,self.width))
        self.zero(y1,0,y1,self.width-1)
    def scroll_right(self,y,x):
        self.poke(y,x+1,self.peek(y,x,y,self.width))
        self.zero(y,x,y,x)
    def cursor_down(self):
        if self.cy>=self.st and self.cy<=self.sb:
            self.cl=0
            q,r=divmod(self.cy+1,self.sb+1)
            if q:
                self.scroll_up(self.st,self.sb)
                self.cy=self.sb
            else:
                self.cy=r
    def cursor_right(self):
        q,r=divmod(self.cx+1,self.width)
        if q:
            self.cl=1
        else:
            self.cx=r
    def echo(self,c):
        if self.cl:
            self.cursor_down()
            self.cx=0
        self.scr[(self.cy*self.width)+self.cx]=self.sgr|ord(c)
        self.cursor_right()
    def esc_0x08(self,s):
        self.cx=max(0,self.cx-1)
    def esc_0x09(self,s):
        x=self.cx+8
        q,r=divmod(x,8)
        self.cx=(q*8)%self.width
    def esc_0x0a(self,s):
        self.cursor_down()
    def esc_0x0d(self,s):
        self.cl=0
        self.cx=0
    def esc_save(self,s):
        self.cx_bak=self.cx
        self.cy_bak=self.cy
    def esc_restore(self,s):
        self.cx=self.cx_bak
        self.cy=self.cy_bak
        self.cl=0
    def esc_da(self,s):
        self.outbuf="\x1b[?6c"
    def esc_ri(self,s):
        self.cy=max(self.st,self.cy-1)
        if self.cy==self.st:
            self.scroll_down(self.st,self.sb)
    def esc_ignore(self,*s):
        pass
#       print "term:ignore: %s"%repr(s)
    def csi_dispatch(self,seq,mo):
    # CSI sequences
        s=mo.group(1)
        c=mo.group(2)
        f=self.csi_seq.get(c,None)
        if f:
            try:
                l=[min(int(i),1024) for i in s.split(';') if len(i)<4]
            except ValueError:
                l=[]
            if len(l)==0:
                l=f[1]
            f[0](self, l)
#       else:
#           print 'csi ignore',c,l
    def csi_at(self,l):
        for i in range(l[0]):
            self.scroll_right(self.cy,self.cx)
    def csi_A(self,l):
        self.cy=max(self.st,self.cy-l[0])
    def csi_B(self,l):
        self.cy=min(self.sb,self.cy+l[0])
    def csi_C(self,l):
        self.cx=min(self.width-1,self.cx+l[0])
        self.cl=0
    def csi_D(self,l):
        self.cx=max(0,self.cx-l[0])
        self.cl=0
    def csi_E(self,l):
        self.csi_B(l)
        self.cx=0
        self.cl=0
    def csi_F(self,l):
        self.csi_A(l)
        self.cx=0
        self.cl=0
    def csi_G(self,l):
        self.cx=min(self.width,l[0])-1
    def csi_H(self,l):
        if len(l)<2: l=[1,1]
        self.cx=min(self.width,l[1])-1
        self.cy=min(self.height,l[0])-1
        self.cl=0
    def csi_J(self,l):
        if l[0]==0:
            self.zero(self.cy,self.cx,self.height-1,self.width-1)
        elif l[0]==1:
            self.zero(0,0,self.cy,self.cx)
        elif l[0]==2:
            self.zero(0,0,self.height-1,self.width-1)
    def csi_K(self,l):
        if l[0]==0:
            self.zero(self.cy,self.cx,self.cy,self.width-1)
        elif l[0]==1:
            self.zero(self.cy,0,self.cy,self.cx)
        elif l[0]==2:
            self.zero(self.cy,0,self.cy,self.width-1)
    def csi_L(self,l):
        for i in range(l[0]):
            if self.cy<self.sb:
                self.scroll_down(self.cy,self.sb)
    def csi_M(self,l):
        if self.cy>=self.st and self.cy<=self.sb:
            for i in range(l[0]):
                self.scroll_up(self.cy,self.sb)
    def csi_P(self,l):
        w,cx,cy=self.width,self.cx,self.cy
        end=self.peek(cy,cx,cy,w)
        self.csi_K([0])
        self.poke(cy,cx,end[l[0]:])
    def csi_X(self,l):
        self.zero(self.cy,self.cx,self.cy,self.cx+l[0])
    def csi_a(self,l):
        self.csi_C(l)
    def csi_c(self,l):
        #'\x1b[?0c' 0-8 cursor size
        pass
    def csi_d(self,l):
        self.cy=min(self.height,l[0])-1
    def csi_e(self,l):
        self.csi_B(l)
    def csi_f(self,l):
        self.csi_H(l)
    def csi_h(self,l):
        if l[0]==4:
            pass
#           print "insert on"
    def csi_l(self,l):
        if l[0]==4:
            pass
#           print "insert off"
    def csi_m(self,l):
        for i in l:
            if i==0 or i==39 or i==49 or i==27:
                self.sgr=0x000700
            elif i==1:
                self.sgr=(self.sgr|0x000800)
            elif i==7:
                self.sgr=0x070000
            elif i>=30 and i<=37:
                c=i-30
                self.sgr=(self.sgr&0xff08ff)|(c<<8)
            elif i>=40 and i<=47:
                c=i-40
                self.sgr=(self.sgr&0x00ffff)|(c<<16)
#           else:
#               print "CSI sgr ignore",l,i
#       print 'sgr: %r %x'%(l,self.sgr)
    def csi_r(self,l):
        if len(l)<2: l=[0,self.height]
        self.st=min(self.height-1,l[0]-1)
        self.sb=min(self.height-1,l[1]-1)
        self.sb=max(self.st,self.sb)
    def csi_s(self,l):
        self.esc_save(0)
    def csi_u(self,l):
        self.esc_restore(0)
    def escape(self):
        e=self.buf
        if len(e)>32:
#           print "error %r"%e
            self.buf=""
        elif e in self.esc_seq:
            self.esc_seq[e](self, e)
            self.buf=""
        else:
            for r,f in self.esc_re:
                mo=r.match(e)
                if mo:
                    f(self, e,mo)
                    self.buf=""
                    break
#       if self.buf=='': print "ESC %r\n"%e
    def write(self,s):
        for i in s:
            if len(self.buf) or (i in self.esc_seq):
                self.buf+=i
                self.escape()
            elif i == '\x1b':
                self.buf+=i
            else:
                self.echo(i)
    def read(self):
        b=self.outbuf
        self.outbuf=""
        return b
    def dump(self):
        r=''
        for i in self.scr:
            r+=chr(i&255)
        return r
    def dumplatin1(self):
        return self.dump().translate(self.trl1)
    def dumphtml(self,color=1):
        h=self.height
        w=self.width
        r=""
        span=""
        span_bg,span_fg=-1,-1
        for i in range(h*w):
            q,c=divmod(self.scr[i],256)
            if color:
                bg,fg=divmod(q,256)
            else:
                bg,fg=0,7
            if i==self.cy*w+self.cx:
                bg,fg=1,7
            if (bg!=span_bg or fg!=span_fg or i==h*w-1):
                if len(span):
                    r+='<span class="f%d b%d">%s</span>'%(span_fg,span_bg,cgi.escape(span.translate(self.trhtml)))
                span=""
                span_bg,span_fg=bg,fg
            span+=chr(c)
            if i%w==w-1:
                span+='\n'
        r='<?xml version="1.0" encoding="ISO-8859-1"?><pre class="term">%s</pre>'%r
        if self.last_html==r:
            return '<?xml version="1.0"?><idem></idem>'
        else:
            self.last_html=r
#           print self
            return r
    def __repr__(self):
        d=self.dumplatin1()
        r=""
        for i in range(self.height):
            r+="|%s|\n"%d[self.width*i:self.width*(i+1)]
        return r

if __name__ == '__main__':
    Terminal(80, 25)