JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
add csi_r (scrolling region)
[watch-my-terminal.git] / terminal.coffee
index 11c79e0..721ed80 100644 (file)
@@ -18,10 +18,15 @@ class Terminal
                @y = 0
                @a = 0x000007 # cursor attributes
                @partial = ''
+               @saved_normal_screen = null
+               @cursor_visible = true
+               @scroll_top = 0
+               @scroll_bottom = height - 1
                @resize width, height
 
        resize: (width, height) ->
                # FIXME: write a version that retains some of the data
+               # FIXME: clamp variables (eg x, y, saved.*, scrolling region) if getting smaller
                @width = width
                @height = height
                @text = []
@@ -31,7 +36,7 @@ class Terminal
                        @attributes[y] = []
                        for x in [0...width]
                                @text[y].push ' '
-                               @attributes[y].push 0
+                               @attributes[y].push 0x07
 
        # pass data from stdout
        update: (data) ->
@@ -52,20 +57,30 @@ class Terminal
                return
 
        add_new_line: ->
-               # clear top line
+               # clear the line at the top of the scrolling region
                for i in [0...@width]
-                       @text[0][i] = ' '
-                       @attributes[0][i] = 0
-               # move (newly cleared) top line to the bottom
-               tmp = @text.shift()
-               @text.push(tmp)
-               tmp = @attributes.shift()
-               @attributes.push(tmp)
+                       @text[@scroll_top][i] = ' '
+                       @attributes[@scroll_top][i] = 0x07
+
+               # move (newly cleared) top line to the bottom of the scrolling region
+               @text = [
+                       @text[0...@scroll_top]..., # up to but not including scroll top
+                       @text[@scroll_top + 1 .. @scroll_bottom]..., # scroll region except top line of it
+                       @text[@scroll_top], # top line of scroll region (already cleared)
+                       @text[@scroll_bottom + 1 ... @height]... # rest of screen
+               ]
+               @attributes = [
+                       @attributes[0...@scroll_top]..., # up to but not including scroll top
+                       @attributes[@scroll_top + 1 .. @scroll_bottom]..., # scroll region except top line of it
+                       @attributes[@scroll_top], # top line of scroll region (already cleared)
+                       @attributes[@scroll_bottom + 1 ... @height]... # rest of screen
+               ]
+
                # slide cursor up with rest of text
                @y -= 1
 
        wrap_to_next_line: ->
-               if @y is @height - 1
+               if @y is @scroll_bottom
                        @add_new_line()
                @y += 1
                @x = 0
@@ -82,22 +97,24 @@ class Terminal
                                when '\x0d' # cr
                                        @x = 0
                                when '\x08' # backspace
-                                       if @x > 0
+                                       if @x is 0
+                                               @x = @width - 1
+                                               if @y > 0
+                                                       @y -= 1
+                                       else
                                                @x -= 1
-                                               @text[@y][@x] = ' '
-                                               # should this set the attribute too?
                                when '\x0a', '\x0b' # lf, vertical tab (same thing)
                                        @wrap_to_next_line()
                                else
+                                       if @x >= @width
+                                               @wrap_to_next_line()
                                        @text[@y][@x] = c
                                        @attributes[@y][@x] = @a
                                        @x += 1
-                                       if @x is @width
-                                               @wrap_to_next_line()
                return
 
        set_attribute_bits: (mask, value) ->
-               @a = (@a & ~mask) | value
+               @a = ((@a & ~mask) | value)
 
        # we're supposed to ignore leeding zeros, and while we're at it, lets swap
        # in the default for blank or missing values
@@ -109,21 +126,88 @@ class Terminal
                else
                        return deef_alt
 
+       # csi_@: rxvt does nothing I can detect
+
+       # move cursor up
+       csi_A: (lines) ->
+               lines = parseInt @fix_esc_arg lines, '1'
+               @y -= lines
+               if @y < 0
+                       @y = 0
+               return
+
+       # move cursor down
+       csi_B: (lines) ->
+               lines = parseInt @fix_esc_arg lines, '1'
+               @y += lines
+               if @y >= @height
+                       @y = @height - 1
+               return
+
+       # move cursor right
+       csi_C: (cols) ->
+               cols = parseInt @fix_esc_arg cols, '1'
+               @x += cols
+               if @x >= @width
+                       @x = @width - 1
+               return
+
+       # move cursor left
+       csi_D: (cols) ->
+               cols = parseInt @fix_esc_arg cols, '1'
+               @x -= cols
+               if @x < 0
+                       @x = 0
+               return
+
        # set cursor position (one based)
        csi_H: (row, column) ->
-               row = 0 + @fix_esc_arg row, 1
-               column = 0 + @fix_esc_arg column, 1
-               # convert to 0 base
-               column -= 1
-               if 0 <= column < @width
-                       @x = column
-               else
-                       console.log "tried to move cursor to invalid column: #{column}"
-               row -= 1
-               if 0 <= row < @height
-                       @y = row
-               else
-                       console.log "tried to move cursor to invalid row: #{row}"
+               # handle blank/missing args and convert to 0 base
+               row = -1 + parseInt @fix_esc_arg row, '1'
+               column = -1 + parseInt @fix_esc_arg column, '1'
+
+               #clamp values
+               if column < 0
+                       column = 0
+               else if column >= @width
+                       column = @width - 1
+               if row < 0
+                       row = 0
+               if row >= @height
+                       row = @height - 1
+
+               #move the cursor
+               @x = column
+               @y = row
+               return
+
+       # clear to screen edge(es)
+       csi_J: (direction) ->
+               switch @fix_esc_arg direction, '0'
+                       when '0' # erase down
+                               # rest of current line
+                               @csi_K direction
+                               # rest of lines
+                               for row in [@y...@height]
+                                       for i in [0...@width]
+                                               @text[row][i] = ' '
+                                               @attributes[row][i] = @a
+                       when '1' # erase up
+                               # beginning of current line
+                               @csi_K direction
+                               # all previous lines
+                               for row in [0..@y]
+                                       for i in [0...@width]
+                                               @text[row][i] = ' '
+                                               @attributes[row][i] = @a
+                       when '2' # erase everything
+                               for row in [0...@height]
+                                       for i in [0...@width]
+                                               @text[row][i] = ' '
+                                               @attributes[row][i] = @a
+                       else
+                               console.log "confusing arg for csi_J: #{direction}"
+               return
 
        # clear (some or all of) current line
        csi_K: (direction) ->
@@ -133,48 +217,110 @@ class Terminal
                                        @text[@y][i] = ' '
                                        @attributes[@y][i] = @a
                        when '1' # erase to left
-                               for i in [0...@x]
+                               # @x can equal @width (after printing to right-most column)
+                               if @x < @width
+                                       max = @x
+                               else
+                                       max = @width - 1
+                               for i in [0..max]
                                        @text[@y][i] = ' '
                                        @attributes[@y][i] = @a
-                       when '0' # erase whole line
+                       when '2' # erase whole line
                                for i in [0...@width]
                                        @text[@y][i] = ' '
                                        @attributes[@y][i] = @a
+                       else
+                               console.log "confusing arg for csi_K: #{direction}"
+               return
+       
+       # misc
+       csiq_h: ->
+               args = []
+               for i in arguments
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '25'
+                                       @cursor_visible = true
+                               when '1049'
+                                       if @saved_normal_screen?
+                                               console.log "ignoring request to switch to the alt screen because we're already on the alt screen"
+                                               return
+                                       @saved_normal_screen = [@x, @y, @text, @attributes]
+                                       @text = []
+                                       @attributes = []
+                                       for y in [0...@height]
+                                               @text[y] = []
+                                               @attributes[y] = []
+                                               for x in [0...@width]
+                                                       @text[y].push ' '
+                                                       @attributes[y].push 0x07
+                               else
+                                       console.log "confusing arg for csiq_h: #{arg}"
+               return
+
+       # unmisc
+       csiq_l: ->
+               args = []
+               for i in arguments
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '25'
+                                       @cursor_visible = false
+                               when '1049'
+                                       if not @saved_normal_screen?
+                                               console.log "ignoring request to switch to the normal screen because we're already on the normal screen"
+                                               return
+                                       @x = @saved_normal_screen[0]
+                                       @y = @saved_normal_screen[1]
+                                       @text = @saved_normal_screen[2]
+                                       @attributes = @saved_normal_screen[3]
+                                       @saved_normal_screen = null
+                               else
+                                       console.log "confusing arg for csiq_l: #{arg}"
+               return
 
        # set color, bold, underline, etc
        csi_m: ->
                args = []
                for i in arguments
-                       args.push @fix_esc_arg i, 0
+                       args.push @fix_esc_arg i, '0'
 
                while args.length > 0
-                       switch args.shift()
-
+                       arg = args.shift()
+                       switch arg
                                # remove all style/color
                                when '0'
-                                       @set_attribute_bits 0xffffff, 0x000007
+                                       @a = 0x07
 
                                # style attributes
                                when '1' # bold
-                                       @set_attribute_bits 0x10000, 0x10000
+                                       @set_attribute_bits 0x010000, 0x010000
+                               when '3' # italic (rare)
+                                       @set_attribute_bits 0x200000, 0x200000
                                when '4' # underline
-                                       @set_attribute_bits 0x20000, 0x20000
+                                       @set_attribute_bits 0x020000, 0x020000
                                when '5' # blink
-                                       @set_attribute_bits 0x40000, 0x40000
-                               when '8' # invisible
-                                       @set_attribute_bits 0x80000, 0x80000
+                                       @set_attribute_bits 0x040000, 0x040000
+                               when '7' # inverse
+                                       @set_attribute_bits 0x080000, 0x080000
+                               when '8' # invisible. urivt ignores this
+                                       @set_attribute_bits 0x100000, 0x100000
 
                                # disable style attributes
-                               when '22' # not bold... according to a page
-                                       @set_attribute_bits 0x10000, 0
-                               when '21' # ... though this would make more sense for "not bold"
-                                       @set_attribute_bits 0x10000, 0
+                               when '21' # not bold (rare)
+                                       @set_attribute_bits 0x010000, 0
+                               when '22' # not bold
+                                       @set_attribute_bits 0x010000, 0
+                               when '23' # not italic (rare)
+                                       @set_attribute_bits 0x200000, 0
                                when '24' # not underline
-                                       @set_attribute_bits 0x20000, 0
+                                       @set_attribute_bits 0x020000, 0
                                when '25' # not blink
-                                       @set_attribute_bits 0x40000, 0
+                                       @set_attribute_bits 0x040000, 0
+                               when '27' # not inverse
+                                       @set_attribute_bits 0x080000, 0
                                when '28' # not invisible
-                                       @set_attribute_bits 0x80000, 0
+                                       @set_attribute_bits 0x100000, 0
 
                                when '100' # reset colors but not other attributes
                                        @set_attribute_bits 0xffff, 0x0007
@@ -267,15 +413,31 @@ class Terminal
                                when '107' # bg bright white
                                        @set_attribute_bits 0xff, 0x0f
 
-
                                else
                                        # if we don't recognize the style, go back to default
-                                       @set_attribute_bits 0xffffff, 0
+                                       console.log "unrecognized csi_m arg: \"#{arg}\""
+                                       @a = 0
+               return
+
+       # set scrolling region
+       csi_r: (top, bottom) ->
+               top = -1 + parseInt @fix_esc_arg top, '1'
+               bottom = -1 + parseInt @fix_esc_arg bottom, '10000'
+               if top < 0
+                       top = 0
+               if bottom >= @height
+                       bottom = @height - 1
+               @scroll_top = top
+               @scroll_bottom = bottom
                return
 
        # str is the whole escape sequence (minus the esc[ prefix)
        update_sequence: (str) ->
-               command = @["csi_#{str.substr str.length - 1}"]
+               prefix = 'csi_'
+               if str[0] is '?'
+                       prefix = 'csiq_'
+                       str = str.substr 1
+               command = @[prefix + str.substr(str.length - 1)]
                if not command?
                        console.log "Unrecognized sequence: ESC[#{str}"
                        return