JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
run.sh: complain if not passed width/height
[watch-my-terminal.git] / terminal.coffee
index 0ba72f4..55f092b 100644 (file)
@@ -7,6 +7,53 @@ else
        window.terminal = {}
        my_exports = window.terminal
 
+if console?.log?
+       log = -> console.log arguments...
+else
+       log = -> null
+
+alternate_charset_table = {
+       A: "↑"
+       B: "↓"
+       C: "→"
+       D: "←"
+       E: "█"
+       F: "▚"
+       G: "☃"
+       '_': " "
+       '`': "◆"
+       a: "▒"
+       b: "␉"
+       c: "␌"
+       d: "␍"
+       e: "␊"
+       f: "°"
+       g: "±"
+       h: "␤"
+       i: "␋"
+       j: "┘"
+       k: "┐"
+       l: "┌"
+       m: "└"
+       n: "┼"
+       o: "⎺"
+       p: "⎻"
+       q: "─"
+       r: "⎼"
+       s: "⎽"
+       t: "├"
+       u: "┤"
+       v: "┴"
+       w: "┬"
+       x: "│"
+       y: "≤"
+       z: "≥"
+       '{': "π"
+       '|': "≠"
+       '}': "£"
+       '~': "·"
+}
+
 class Terminal
        # public:
        constructor: (width, height) ->
@@ -19,10 +66,14 @@ class Terminal
                @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 = []
@@ -32,7 +83,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) ->
@@ -40,33 +91,38 @@ class Terminal
                if @partial.length > 0
                        data = @partial + data
                        @partial = ''
-               parts = data.split(/\x1b\[/)
+               parts = data.split(/\x1b/)
                if parts.length > 1
                        if -1 is @escape_sequence_length parts[parts.length - 1]
                                @partial = parts.pop()
-               if parts.length > 0
-                       for i in [0...parts.length]
-                               if i is 0
-                                       @update_text parts[i]
-                               else
-                                       @update_sequence_then_text parts[i]
+               for i in [0...parts.length]
+                       if i is 0
+                               @update_text parts[i]
+                       else
+                               @update_sequence_then_text parts[i]
                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
+
+               rearrange = (a) =>
+                       return [
+                               a[0...@scroll_top]..., # up to but not including scroll top
+                               a[@scroll_top + 1 .. @scroll_bottom]..., # scroll region except top line of it
+                               a[@scroll_top], # top line of scroll region (already cleared)
+                               a[@scroll_bottom + 1 ... @height]... # rest of screen
+                       ]
+               @text = rearrange @text
+               @attributes = rearrange @attributes
+
                # 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
@@ -91,9 +147,16 @@ class Terminal
                                                @x -= 1
                                when '\x0a', '\x0b' # lf, vertical tab (same thing)
                                        @wrap_to_next_line()
+                               when '\x0f'
+                                       @alternate_charset = true
+                               when '\x0e'
+                                       @alternate_charset = false
                                else
                                        if @x >= @width
                                                @wrap_to_next_line()
+                                       if @alternate_charset
+                                               if alternate_charset_table[c]?
+                                                       c = alternate_charset_table[c]
                                        @text[@y][@x] = c
                                        @attributes[@y][@x] = @a
                                        @x += 1
@@ -112,25 +175,80 @@ class Terminal
                else
                        return deef_alt
 
-       # set cursor position (one based)
-       csi_H: (row, column) ->
-               # handle blank/missing args and convert to 0 base
-               row = @fix_esc_arg(row, 1) - 1
-               column = @fix_esc_arg(column, 1) - 1
+       # csi_@: rxvt does nothing I can detect
 
-               #clamp values
-               if column < 0
-                       column = 0
-               else if column >= @width
-                       column = @width - 1
+       # "The auxiliary keypad keys will send ASCII codes corresponding to the
+       # characters engraved on their keys." (numlock?)
+       "esc_>": ->
+
+       # 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
+
+       # cursor set_row (y)
+       csi_d: (row) ->
+               row = -1 + parseInt @fix_esc_arg row, '1'
+               @set_row_clamped row
+               return
+
+       # cursor column (x)
+       csi_G: (col) ->
+               col = -1 + parseInt @fix_esc_arg col, '1'
+               @set_column_clamped col
+               return
+
+       # set cursor row (zero based)
+       set_row_clamped: (row) ->
                if row < 0
                        row = 0
                if row >= @height
                        row = @height - 1
-
-               #move the cursor
-               @x = column
                @y = row
+               return
+       # set cursor column (zero based)
+       set_column_clamped: (column) ->
+               if column < 0
+                       column = 0
+               if column >= @width
+                       column = @width - 1
+               @x = column
+               return
+       # set cursor position (one based)
+       csi_H: (row, column) ->
+               # 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'
+               @set_row_clamped row
+               @set_column_clamped column
+               return
 
        # clear to screen edge(es)
        csi_J: (direction) ->
@@ -157,7 +275,7 @@ class Terminal
                                                @text[row][i] = ' '
                                                @attributes[row][i] = @a
                        else
-                               console.log "confusing arg for csi_J: #{direction}"
+                               log "confusing arg for csi_J: #{direction}"
                return
 
        # clear (some or all of) current line
@@ -181,19 +299,129 @@ class Terminal
                                        @text[@y][i] = ' '
                                        @attributes[@y][i] = @a
                        else
-                               console.log "confusing arg for csi_K: #{direction}"
+                               log "confusing arg for csi_K: #{direction}"
                return
-       
-       # misc
-       csiq_h: ->
-               args = []
-               for i in arguments
-                       switch @fix_esc_arg i, ''
+
+       # move lines downwards (arg is how far)
+       csi_L: (lines) ->
+               lines = parseInt @fix_esc_arg lines, '1'
+
+               rearrange = (a) =>
+                       return [
+                               a[0...@y]..., # keep everything above cursor
+                               a[@scroll_bottom - lines + 1 .. @scroll_bottom]..., # we'll clear these shortly
+                               a[@y..@scroll_bottom - lines]..., # lines that are moving down
+                               a[@scroll_bottom + 1 ... @height]... # rest of screen
+                       ]
+               @text = rearrange @text
+               @attributes = rearrange @attributes
+
+               # clear the lines we scrolled off (and put back in as "new")
+               for y in [@y...@y+lines]
+                       for x in [0...@width]
+                               @text[y][x] = ' '
+                               @attributes[y][x] = 0x07
+
+       # move lines upwards (arg is how far)
+       # this obliterates the line under the cursor and arg-1 following it
+       csi_M: (lines) ->
+               lines = parseInt @fix_esc_arg lines, '1'
+
+               rearrange = (a) =>
+                       return [
+                               a[0 ... @y]..., # keep everything above cursor
+                               a[@y + lines .. @scroll_bottom]..., # lines we're moving up
+                               a[@y ... @y + lines]..., # recycle these
+                               a[@scroll_bottom + 1 ... @height]... # keep the rest
+                       ]
+               @text = rearrange @text
+               @attributes = rearrange @attributes
+
+               # clear the lines we're recycling
+               for y in [@scroll_bottom - lines + 1 .. @scroll_bottom]
+                       for x in [0...@width]
+                               @text[y][x] = ' '
+                               @attributes[y][x] = 0x07
+
+       # delete chars (without moving the cursor)
+       csi_X: (chars) ->
+               chars = parseInt @fix_esc_arg chars, '1'
+               x = @x
+               for c in [0...chars]
+                       if x >= @width
+                               return
+                       @text[@y][x] = ' '
+                       @attributes[@y][x] = @a
+                       x += 1
+               return
+       "csi_@": (chars) ->
+               chars = parseInt @fix_esc_arg chars, '1'
+               if chars < 1
+                       return
+               if chars > @width - @x
+                       chars = @width - @x
+               else
+                       dest = @width - 1
+                       if dest >= @width
+                               dest = @width - 1
+                       while dest - chars >= @x
+                               @text[@y][dest] = @text[@y][dest - chars]
+                               @attributes[@y][dest] = @attributes[@y][dest - chars]
+                               dest -= 1
+               @csi_X chars # clear
+       csi_P: (chars) ->
+               chars = parseInt @fix_esc_arg chars, '1'
+               if chars < 1
+                       return
+               if chars > @width - @x
+                       chars = @width - @x
+               else
+                       dest = @x
+                       while dest < @width - chars
+                               @text[@y][dest] = @text[@y][dest + chars]
+                               @attributes[@y][dest] = @attributes[@y][dest + chars]
+                               dest += 1
+               # clear the space moved out of
+               x = @width - chars
+               while x < @width
+                       @text[@y][x] = ' '
+                       @attributes[@y][x] = @a
+                       x += 1
+
+       # set modes not starting with "?"
+       csi_h: (args...) ->
+               for i in args
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '0' # error (ignored
+                                       return
+                               when '2' # KAM -- keyboard action
+                                       return
+                               when '4' # put cursor in "INSERT" mode
+                                       return
+                               when '12' # turn local echo off (or on?)
+                                       return
+                               # TODO when '20' LNM linefeed/newline
+                               else
+                                       log "Unimplemented arg for csi_h: #{arg}"
+       # set modes starting with "?"
+       csiq_h: (args...) ->
+               for i in args
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '1' # mode ?1
+                                       # numlock on
+                                       return
+                               when '25'
+                                       @cursor_visible = true
+                               when '1000'
+                                       # x11 normal mouse tracking
+                                       return
                                when '1049'
                                        if @saved_normal_screen?
-                                               console.log "ignoring request to switch to the alt screen because we're already on the alt screen"
+                                               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]
+                                       @saved_normal_screen = x: @x, y: @y, text: @text, attributes: @attributes
                                        @text = []
                                        @attributes = []
                                        for y in [0...@height]
@@ -201,21 +429,60 @@ class Terminal
                                                @attributes[y] = []
                                                for x in [0...@width]
                                                        @text[y].push ' '
-                                                       @attributes[y].push 0
-       # unmisc
+                                                       @attributes[y].push 0x07
+                               else
+                                       log "Unimplemented arg for csiq_h: #{arg}"
+               return
+
+       # reset (turn off) modes
+       # note that modes starting with ? call csiq_l, not this
+       csi_l: ->
+               for i in arguments
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '0' # error (ignored
+                                       return
+                               when '2' # KAM -- keyboard action
+                                       return
+                               when '4' # put cursor in "REPLACE" mode
+                                       return
+                               when '12' # turn local echo on (or off?)
+                                       return
+                               # TODO when '20' LNM linefeed/newline
+
+       # reset (turn off) modes starting with ?
+       # in st source, these are priv=true
        csiq_l: ->
                args = []
                for i in arguments
-                       switch @fix_esc_arg i, ''
+                       arg = @fix_esc_arg i, ''
+                       switch arg
+                               when '1' # mode ?1 reset
+                                       # numlock off
+                                       return
+                               when '12' # mode ?12
+                                       # stop blinking the cursor (ignored)
+                                       return
+                               when '25' # mode ?25 reset
+                                       @cursor_visible = false
+                               when '0', '2', '3', '4', '8', '18', '19', '42', '12'
+                                       # st ignores all of these
+                                       return
+                               when '9', '1000', '1002', '1003', '1004', '1006'
+                                       # mouse reporting and such (ignored)
+                                       return
                                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"
+                                               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]
+                                       @x = @saved_normal_screen.x
+                                       @y = @saved_normal_screen.y
+                                       @text = @saved_normal_screen.text
+                                       @attributes = @saved_normal_screen.attributes
                                        @saved_normal_screen = null
+                               else
+                                       log "Unimplemented arg for csiq_l: #{arg}"
+               return
 
        # set color, bold, underline, etc
        csi_m: ->
@@ -228,26 +495,29 @@ class Terminal
                        switch arg
                                # remove all style/color
                                when '0'
-                                       @a = 0
+                                       @a = 0x07
 
                                # style attributes
                                when '1' # bold
                                        @set_attribute_bits 0x010000, 0x010000
-                               # FIXME add '3' for italic ('23' to turn it off)
+                               when '3' # italic (rare)
+                                       @set_attribute_bits 0x200000, 0x200000
                                when '4' # underline
                                        @set_attribute_bits 0x020000, 0x020000
                                when '5' # blink
                                        @set_attribute_bits 0x040000, 0x040000
                                when '7' # inverse
                                        @set_attribute_bits 0x080000, 0x080000
-                               when '8' # invisible
+                               when '8' # invisible. urivt ignores this
                                        @set_attribute_bits 0x100000, 0x100000
 
                                # disable style attributes
-                               when '22' # not bold... according to a page
+                               when '21' # not bold (rare)
                                        @set_attribute_bits 0x010000, 0
-                               when '21' # ... though this would make more sense for "not bold"
+                               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 0x020000, 0
                                when '25' # not blink
@@ -332,54 +602,131 @@ class Terminal
 
                                # bright bg colors
                                when '100' # bg bright black
-                                       @set_attribute_bits 0xff, 0x08
+                                       @set_attribute_bits 0xff00, 0x0800
                                when '101' # bg bright red
-                                       @set_attribute_bits 0xff, 0x09
+                                       @set_attribute_bits 0xff00, 0x0900
                                when '102' # bg bright green
-                                       @set_attribute_bits 0xff, 0x0a
+                                       @set_attribute_bits 0xff00, 0x0a00
                                when '103' # bg bright yellow
-                                       @set_attribute_bits 0xff, 0x0b
+                                       @set_attribute_bits 0xff00, 0x0b00
                                when '104' # bg bright blue
-                                       @set_attribute_bits 0xff, 0x0c
+                                       @set_attribute_bits 0xff00, 0x0c00
                                when '105' # bg bright magenta
-                                       @set_attribute_bits 0xff, 0x0d
+                                       @set_attribute_bits 0xff00, 0x0d00
                                when '106' # bg bright cyan
-                                       @set_attribute_bits 0xff, 0x0e
+                                       @set_attribute_bits 0xff00, 0x0e00
                                when '107' # bg bright white
-                                       @set_attribute_bits 0xff, 0x0f
+                                       @set_attribute_bits 0xff00, 0x0f00
 
                                else
                                        # if we don't recognize the style, go back to default
-                                       console.log "unrecognized csi_m arg: \"#{arg}\""
+                                       log "unrecognized csi_m arg: \"#{arg}\""
                                        @a = 0
                return
 
-       # str is the whole escape sequence (minus the esc[ prefix)
+       # set scroll 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
+
+       # move cursor up one line, if it's at the top, scroll everything down
+       esc_M: ->
+               if @y > 0
+                       @csi_A '1'
+               else
+                       @csi_L '1'
+       
+       # esc ]
+       "esc_]": (seq) ->
+               sem = seq.indexOf ';'
+               if sem < 1 || seq[0] isnt '0'
+                       log "Unimplemented esc_] (OS command) sequence: #{seq}"
+                       return
+               if window?
+                       title = seq.substr sem + 1
+                       title = title.substr 0, title.length - 1
+                       window.document.title = title
+
+       # "The auxiliary keypad keys will transmit control sequences."
+       "esc_=": ->
+
+       # esc )
+       "esc_)": ->
+               @alternate_charset = true
+       # esc ( 0
+       gzd4_0: ->
+               @alternate_charset = true
+       # esc ( B
+       gzd4_B: ->
+               @alternate_charset = false
+
+       esc_n: ->
+               @alternate_charset = false
+
+       esc_o: ->
+               @alternate_charset = true
+
+       # str is the whole escape sequence (minus the esc character)
        update_sequence: (str) ->
-               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}"
+               if str[0] is '['
+                       if str[1] is '?'
+                               method_prefix = 'csiq_'
+                               args = str.substr(2, str.length - 3).split ';'
+                       else
+                               method_prefix = 'csi_'
+                               args = str.substr(1, str.length - 2).split ';'
+                       method_name = method_prefix + str.substr str.length - 1
+               else if str[0] is '(' # character set
+                       method_name = 'gzd4_' + str.substr 1, 1
+                       args = [str.substr 1]
+               else
+                       method_name = 'esc_' + str.substr 0, 1
+                       args = [str.substr 1]
+               method = @[method_name]
+               if not method?
+                       log "Unimplemented #{method_name}, code: ESC#{str}"
                        return
-               args = str.substr(0, str.length - 1).split ';'
-               command.call this, args...
+               method.apply this, args
 
        update_sequence_then_text: (str) ->
                len = @escape_sequence_length str
                if len is -1
-                       console.log "couldn't find escape sequence here: #{str.substr 0, 25}"
-                       @update_text "ESC[" + str
+                       log "couldn't find escape sequence here: #{str.substr 0, 25}"
+                       @update_text "ESC" + str
                else
                        @update_sequence str.substr 0, len
                        @update_text str.substr len
 
        escape_sequence_length: (str) ->
-               parts = str.match(/^[0-9;?]{0,25}./)
-               return -1 unless parts?
-               return parts[0].length
+               if str[0] is '['
+                       parts = str.match(/^\[[0-9;?]{0,25}./)
+                       return -1 unless parts?
+                       return parts[0].length
+               else if str[0] is '('
+                       if str.length == 1
+                               return -1
+                       if str[1] is '!' or str[1] is '%'
+                               return 3
+                       else
+                               return 2
+               else if str[0] is ']'
+                       st = str.indexOf "\u0007"
+                       if st is -1
+                               return -1
+                       return st + 1
+               else
+                       #log "non[: ESC#{str.substr 0, 10}"
+                       if str.length >= 1
+                               return 1
+                       else
+                               return -1
 
 my_exports.new = (width, height) ->
        return new Terminal width, height