-async = require 'async'
-fs = require 'fs'
+# this file is used by the client and server.
+
+# work around lack of module system in the browser:
+if exports?
+ my_exports = exports
+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:
@attributes = []
@x = 0
@y = 0
- @a = 0 # cursor attributes
+ @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 = []
@attributes[y] = []
for x in [0...width]
@text[y].push ' '
- @attributes[y].push 0
+ @attributes[y].push 0x07
# pass data from stdout
update: (data) ->
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
-
- clear_rest_of_line: ->
- for i in [@x...@width]
- @text[@y][i] = ' '
- @attributes[@y][i] = @a
-
+
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
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()
+ 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
- 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
+ fix_esc_arg: (value, deef_alt) ->
+ if value? and value != ''
+ while value[0] is '0' and value.length > 1
+ value = value.substr 1
+ return value
+ else
+ return deef_alt
+
+ # csi_@: rxvt does nothing I can detect
+
+ # "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
+ @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) ->
+ 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
+ log "confusing arg for csi_J: #{direction}"
+ return
+
+ # clear (some or all of) current line
+ csi_K: (direction) ->
+ switch @fix_esc_arg direction, '0'
+ when '0' # erase to right
+ for i in [@x...@width]
+ @text[@y][i] = ' '
+ @attributes[@y][i] = @a
+ when '1' # erase to left
+ # @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 '2' # erase whole line
+ for i in [0...@width]
+ @text[@y][i] = ' '
+ @attributes[@y][i] = @a
+ else
+ log "confusing arg for csi_K: #{direction}"
+ return
+
+ # move lines downwards (arg is how far)
+ csi_L: (lines) ->
+ lines = parseInt @fix_esc_arg lines, '1'
- csi_m: default: "0", go: ->
+ 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?
+ log "ignoring request to switch to the alt screen because we're already on the alt screen"
+ return
+ @saved_normal_screen = x: @x, y: @y, text: @text, attributes: @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
+ 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
+ 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?
+ log "ignoring request to switch to the normal screen because we're already on the normal screen"
+ return
+ @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: ->
+ args = []
for i in arguments
- switch i
+ args.push @fix_esc_arg i, '0'
+
+ while args.length > 0
+ arg = args.shift()
+ switch arg
+ # remove all style/color
when '0'
- @set_attribute_bits 0xffffff, 0
+ @a = 0x07
+
+ # style attributes
when '1' # bold
- @set_attribute_bits 0x100, 1
+ @set_attribute_bits 0x010000, 0x010000
+ when '3' # italic (rare)
+ @set_attribute_bits 0x200000, 0x200000
when '4' # underline
- @set_attribute_bits 0x200, 1
+ @set_attribute_bits 0x020000, 0x020000
when '5' # blink
- @set_attribute_bits 0x400, 1
- when '8' # invisible
- @set_attribute_bits 0x800, 1
-
- when '22' # not bold... according to a page
- @set_attribute_bits 0x100, 0
- when '21' # ... though this would make more sense for "not bold"
- @set_attribute_bits 0x100, 0
+ @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 '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 0x200, 0
+ @set_attribute_bits 0x020000, 0
when '25' # not blink
- @set_attribute_bits 0x400, 0
+ @set_attribute_bits 0x040000, 0
+ when '27' # not inverse
+ @set_attribute_bits 0x080000, 0
when '28' # not invisible
- @set_attribute_bits 0x800, 0
+ @set_attribute_bits 0x100000, 0
+
+ when '100' # reset colors but not other attributes
+ @set_attribute_bits 0xffff, 0x0007
+ # 8 fg colors
when '30' # fg black
- @set_attribute_bits 0xff, 0
+ @set_attribute_bits 0xff, 0x00
when '31' # fg red
- @set_attribute_bits 0xff, 0xe0
+ @set_attribute_bits 0xff, 0x01
when '32' # fg green
- @set_attribute_bits 0xff, 0x1c
+ @set_attribute_bits 0xff, 0x02
when '33' # fg yellow
- @set_attribute_bits 0xff, 0xfc
+ @set_attribute_bits 0xff, 0x03
when '34' # fg blue
- @set_attribute_bits 0xff, 0x02
+ @set_attribute_bits 0xff, 0x04
when '35' # fg magenta
- @set_attribute_bits 0xff, 0xe2
+ @set_attribute_bits 0xff, 0x05
when '36' # fg cyan
- @set_attribute_bits 0xff, 0x1f
+ @set_attribute_bits 0xff, 0x06
when '37', '39' # fg white (39 is default)
- @set_attribute_bits 0xff, 0xff
+ @set_attribute_bits 0xff, 0x07
+
+ when '38'
+ if args.length >= 2 and args[0] is '5'
+ args.shift()
+ @set_attribute_bits 0xff, (0xff & args.shift())
+ else
+ @set_attribute_bits 0x20000, 0x20000
+ # 8 bg colors
when '40' # bg black
- @set_attribute_bits 0xff00, 0
+ @set_attribute_bits 0xff00, 0x0000
when '41' # bg red
- @set_attribute_bits 0xff00, 0xe000
+ @set_attribute_bits 0xff00, 0x0100
when '42' # bg green
- @set_attribute_bits 0xff00, 0x1c00
+ @set_attribute_bits 0xff00, 0x0200
when '43' # bg yellow
- @set_attribute_bits 0xff00, 0xfc00
+ @set_attribute_bits 0xff00, 0x0300
when '44' # bg blue
- @set_attribute_bits 0xff00, 0x0200
+ @set_attribute_bits 0xff00, 0x0400
when '45' # bg magenta
- @set_attribute_bits 0xff00, 0xe200
+ @set_attribute_bits 0xff00, 0x0500
when '46' # bg cyan
- @set_attribute_bits 0xff00, 0x1f00
- when '47', '49' # bg white (49 is default)
- @set_attribute_bits 0xff00, 0xff
+ @set_attribute_bits 0xff00, 0x0600
+ when '47' # bg white
+ @set_attribute_bits 0xff00, 0x0700
+ when '49' # bg default
+ @set_attribute_bits 0xff00, 0x0000
+
+ when '48'
+ if args.length >= 2 and args[0] is '5'
+ args.shift()
+ @set_attribute_bits 0xff00, ((0xff & args.shift()) << 8)
+ else
+ @set_attribute_bits 0x20000, 0x20000
+
+ # bright fg colors
+ when '90' # fg bright black
+ @set_attribute_bits 0xff, 0x08
+ when '91' # fg bright red
+ @set_attribute_bits 0xff, 0x09
+ when '92' # fg bright green
+ @set_attribute_bits 0xff, 0x0a
+ when '93' # fg bright yellow
+ @set_attribute_bits 0xff, 0x0b
+ when '94' # fg bright blue
+ @set_attribute_bits 0xff, 0x0c
+ when '95' # fg bright magenta
+ @set_attribute_bits 0xff, 0x0d
+ when '96' # fg bright cyan
+ @set_attribute_bits 0xff, 0x0e
+ when '97' # fg bright white
+ @set_attribute_bits 0xff, 0x0f
+
+ # bright bg colors
+ when '100' # bg bright black
+ @set_attribute_bits 0xff00, 0x0800
+ when '101' # bg bright red
+ @set_attribute_bits 0xff00, 0x0900
+ when '102' # bg bright green
+ @set_attribute_bits 0xff00, 0x0a00
+ when '103' # bg bright yellow
+ @set_attribute_bits 0xff00, 0x0b00
+ when '104' # bg bright blue
+ @set_attribute_bits 0xff00, 0x0c00
+ when '105' # bg bright magenta
+ @set_attribute_bits 0xff00, 0x0d00
+ when '106' # bg bright cyan
+ @set_attribute_bits 0xff00, 0x0e00
+ when '107' # bg bright white
+ @set_attribute_bits 0xff00, 0x0f00
else
# if we don't recognize the style, go back to default
- @set_attribute_bits 0xffffff, 0
+ 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) ->
- command = @["csi_#{str.substr str.length - 1}"]
- return unless command?
- args = str.substr(0, str.length - 1).split ';'
- for i in [0...args.length]
- if args[i] is ''
- args[i] = command.default
- command.go.call this, args...
+ 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
+ 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
-exports.new = (width, height) ->
+my_exports.new = (width, height) ->
return new Terminal width, height
Got questions, comments, patches, etc.? Contact Jason Woofenden