JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
link to git repo
[peach-html5-editor.git] / editor.coffee
index faa2e3f..956ade0 100644 (file)
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+TYPE_TAG = peach_parser.TYPE_TAG
+TYPE_TEXT = peach_parser.TYPE_TEXT
+TYPE_COMMENT = peach_parser.TYPE_COMMENT
+TYPE_DOCTYPE = peach_parser.TYPE_DOCTYPE
+
+debug_dot_at = (doc, x, y) ->
+       el = doc.createElement 'div'
+       el.setAttribute 'style', "position: absolute; left: #{x}px; top: #{y}px; width: 1px; height: 3px; background-color: red"
+       doc.body.appendChild el
+       #console.log(new Error().stack)
+
+# text nodes don't have getBoundingClientRect(), so use selection api to find
+# it.
+get_text_bounding_rect = (el) ->
+get_el_bounds = (el) ->
+       if el.getBoundingClientRect?
+               rect = el.getBoundingClientRect()
+       else
+               # text nodes don't have getBoundingClientRect(), so use range api
+               range = el.ownerDocument.createRange()
+               range.selectNodeContents el
+               rect = range.getBoundingClientRect()
+       doc = el.ownerDocument.documentElement
+       win = el.ownerDocument.defaultView
+       y_fix = win.pageYOffset - doc.clientTop
+       x_fix = win.pageXOffset - doc.clientLeft
+       return {
+               x: rect.left + x_fix
+               y: rect.top + y_fix
+               w: rect.width ? (rect.right - rect.left)
+               h: rect.height ? (rect.top - rect.bottom)
+       }
+
+# figure out the x/y coordinates of where the cursor should be if it's at
+# position ``i`` within text node ``n``
+window.cursor_to_xyh = cursor_to_xyh = (n, i) ->
+       range = document.createRange()
+       plus_width = false
+       if n.text.length is 0
+               range.setStart n.el, i
+               range.setEnd n.el, i
+       if i is n.text.length
+               range.setStart n.el, i - 1
+               range.setEnd n.el, i
+               plus_width = true
+       else
+               range.setStart n.el, i
+               range.setEnd n.el, i + 1
+       # chromium returns bogus results with getBoundingClientRect() when zero width and/or height
+       rect = range.getClientRects()
+       if rect.length > 0
+               if plus_width
+                       # chromium returns multiple rects for the space that is broken
+                       # across lines by word-wrap (firefox doesn't)
+                       rect = rect[rect.length - 1]
+               else
+                       rect = rect[0]
+       else
+               return x: 0, y: 0, w: 0, h: 0 # TODO return null, fix callers
+       ret = {
+               x: rect.left
+               y: rect.top
+               w: rect.width ? (rect.right - rect.left)
+               h: rect.height ? (rect.top - rect.bottom)
+       }
+       if plus_width
+               ret.x += ret.w
+       debug_dot_at n.el.ownerDocument, ret.x, ret.y
+       return ret
+
 # encode text so it can be safely placed inside an html attribute
 enc_attr_regex = new RegExp '(&)|(")|(\u00A0)', 'g'
 enc_attr = (txt) ->
@@ -43,7 +113,7 @@ dom_to_html = (dom) ->
        ret = ''
        for el in dom
                switch el.type
-                       when peach_parser.TYPE_TAG
+                       when TYPE_TAG
                                ret += '<' + el.name
                                attr_keys = []
                                for k of el.attrs
@@ -58,11 +128,11 @@ dom_to_html = (dom) ->
                                        if el.children.length
                                                ret += dom_to_html el.children
                                        ret += "</#{el.name}>"
-                       when peach_parser.TYPE_TEXT
+                       when TYPE_TEXT
                                ret += el.text
-                       when peach_parser.TYPE_COMMENT
+                       when TYPE_COMMENT
                                ret += "<!--#{el.text}-->"
-                       when peach_parser.TYPE_DOCTYPE
+                       when TYPE_DOCTYPE
                                ret += "<!DOCTYPE #{el.name}"
                                if el.public_identifier? and el.public_identifier.length > 0
                                        ret += " \"#{el.public_identifier}\""
@@ -85,23 +155,21 @@ domify = (h) ->
        return el
 
 css = ''
-css += 'div#peach_editor_cursor {'
-css +=     'display: inline-block;'
+css += 'div#peach_html5_editor_cursor {'
+css +=     'position: absolute;'
 css +=     'height: 1em;'
 css +=     'width: 2px;'
 css +=     'margin-left: -1px;'
 css +=     'margin-right: -1px;'
-css +=     'background: #000;'
-css +=     '-webkit-animation: 1s blink step-end infinite;'
-css +=     'animation: 1s blink step-end infinite;'
+css +=     'background: #444;'
+css +=     '-webkit-animation: blink 1s steps(2, start) infinite;'
+css +=     'animation: blink 1s steps(2, start) infinite;'
 css += '}'
-css += '@-webkit-keyframes "blink" {'
-css +=     'from, to { background: #000; }'
-css +=     '50% { background: transparent; }'
+css += '@-webkit-keyframes blink {'
+css +=     'to { visibility: hidden; }'
 css += '}'
-css += '@keyframes "blink" {'
-css +=     'from, to { background: #000; }'
-css +=     '50% { background: transparent; }'
+css += '@keyframes blink {'
+css +=     'to { visibility: hidden; }'
 css += '}'
 
 # key codes:
@@ -120,74 +188,286 @@ KEY_PAGE_UP = 33
 KEY_PAGE_DOWN = 34
 KEY_TAB = 9
 
-wysiwyg = (el, options = {}) ->
-       opt_fragment = options.fragment ? true
-       parser_opts = {}
-       if opt_fragment
-               parser_opts.fragment = 'body'
-       editor_instance = {
-               dom: []
-               iframe: document.createElement('iframe')
-               load_html: (html) ->
-                       @dom = peach_parser.parse html, parser_opts
-                       as_html = peach.dom_to_html @dom
-                       as_html = as_html.substr(0, 5) + '<span class="peach_editor_cursor"></span>' + as_html.substr(5)
-                       @iframe.contentDocument.body.innerHTML = as_html
-       }
-       el.parentNode.appendChild editor_instance.iframe
-       idoc = editor_instance.iframe.contentDocument
-       ignore_key_codes =
-               '18': true # alt
-               '20': true # capslock
-               '17': true # ctrl
-               '144': true # numlock
-               '16': true # shift
-               '91': true # windows "start" key
-       control_key_codes = # we react to these, but they aren't typing
-               '37': KEY_LEFT
-               '38': KEY_UP
-               '39': KEY_RIGHT
-               '40': KEY_DOWN
-               '35': KEY_END
-               '8':  KEY_BACKSPACE
-               '46': KEY_DELETE
-               '13': KEY_ENTER
-               '27': KEY_ESCAPE
-               '36': KEY_HOME
-               '45': KEY_INSERT
-               '33': KEY_PAGE_UP
-               '34': KEY_PAGE_DOWN
-               '9':  KEY_TAB
-
-       idoc.body.onkeyup = (e) ->
-               return false if ignore_key_codes[e.keyCode]?
-               return false if control_key_codes[e.keyCode]?
-       idoc.body.onkeydown = (e) ->
-               return false if ignore_key_codes[e.keyCode]?
-               return false if control_key_codes[e.keyCode]?
-       idoc.body.onkeypress = (e) ->
-               return if e.ctrlKey
-               return false if ignore_key_codes[e.keyCode]?
-               # in firefox, keyCode is only set for non-typing keys
-               if e.keyCode isnt KEY_BACKSPACE # so this is fine
-                       return false if control_key_codes[e.keyCode]?
-               char = e.charCode ? e.keyCode
-               el.value += String.fromCharCode char
-               editor_instance.load_html el.value
-               return false
-       if options.stylesheet # TODO test this
-               istyle = idoc.createElement 'style'
-               istyle.setAttribute 'src', options.stylesheet
-               idoc.head.appendChild istyle
-       icss = idoc.createElement 'style'
-       icss.appendChild idoc.createTextNode css
-       idoc.head.appendChild icss
-       editor_instance.load_html el.value
-       return editor_instance
-
-window.peach = {
-       wysiwyg: wysiwyg
-       dom_to_html: dom_to_html
-}
+instantiate_tree = (tree, parent) ->
+       for c in tree
+               switch c.type
+                       when TYPE_TEXT
+                               c.el = parent.ownerDocument.createTextNode c.text
+                               parent.appendChild c.el
+                       when TYPE_TAG
+                               # TODO create in correct namespace
+                               c.el = parent.ownerDocument.createElement c.name
+                               for k, v of c.attrs
+                                       # FIXME if attr_whitelist[k]?
+                                       c.el.setAttribute k, v
+                               parent.appendChild c.el
+                               if c.children.length
+                                       instantiate_tree c.children, c.el
+
+traverse_tree = (tree, state, cb) ->
+       for c in tree
+               cb c, state
+               break if state.done?
+               if c.children.length
+                       traverse_tree c.children, state, cb
+                       break if state.done?
+       return state
+# find the next element in tree (and decendants) that is after n and can contain text
+# TODO make it so cursor can go places that don't have text but could
+find_next_cursor_position = (tree, n, i) ->
+       if n? and n.type is TYPE_TEXT and n.text.length > i
+               orig_xyh = cursor_to_xyh n, i
+               for next_i in [i+1 .. n.text.length] # inclusive is valid (after last char)
+                       next_xyh = cursor_to_xyh n, next_i
+                       if next_xyh.x > orig_xyh.x or next_xyh.y > orig_xyh.y
+                               return [n, next_i]
+       found = traverse_tree tree, before: n?, (node, state) ->
+               if node.type is TYPE_TEXT and state.before is false
+                       state.node = node
+                       state.done = true
+               if node is n
+                       state.before = false
+       if found.node?
+               return [found.node, 0]
+       return null
+
+# TODO make it so cursor can go places that don't have text but could
+find_prev_cursor_position = (tree, n, i) ->
+       if n? and n.type is TYPE_TEXT and i > 0
+               orig_xyh = cursor_to_xyh n, i
+               for prev_i in [i-1 .. 0]
+                       prev_xyh = cursor_to_xyh n, prev_i
+                       if prev_xyh.x < orig_xyh.x or prev_xyh.y < orig_xyh.y
+                               return [n, prev_i]
+               return [n, i - 1]
+       found = traverse_tree tree, before: n?, (node, state) ->
+               if node.type is TYPE_TEXT
+                       unless n?
+                               state.node = node
+                               state.done = true
+                       if node is n
+                               if state.prev?
+                                       state.node = state.prev
+                               state.done = true
+                       if node
+                               state.prev = node
+       if found.node?
+               return [found.node, found.node.text.length]
+       return null
+
+find_loc_cursor_position = (tree, loc) ->
+       for c in tree
+               if c.type is TYPE_TAG or c.type is TYPE_TEXT
+                       bounds = get_el_bounds c.el
+                       continue if loc.x < bounds.x
+                       continue if loc.x > bounds.x + bounds.w
+                       continue if loc.y < bounds.y
+                       continue if loc.y > bounds.y + bounds.h
+                       if c.children.length
+                               ret = find_loc_cursor_position c.children, loc
+                               return ret if ret?
+                       if c.type is TYPE_TEXT
+                               # click is within bounding box that contains all text.
+                               return [c, 0] if c.text.length is 0
+                               before_i = 0
+                               before = cursor_to_xyh c, before_i
+                               after_i = c.text.length
+                               after = cursor_to_xyh c, after_i
+                               if loc.y < before.y + before.h and loc.x < before.x
+                                       # console.log 'before first char on first line'
+                                       continue
+                               if loc.y > after.y and loc.x > after.x
+                                       # console.log 'after last char on last line'
+                                       continue
+                               if loc.y < before.y
+                                       console.log "Warning: click in bounding box but above first line"
+                                       continue # above first line (runaround?)
+                               if loc.y > after.y + after.h
+                                       console.log "Warning: click in bounding box but below last line", loc.y, after.y, after.h
+                                       continue # below last line (shouldn't happen?)
+                               while after_i - before_i > 1
+                                       cur_i = Math.round((before_i + after_i) / 2)
+                                       cur = cursor_to_xyh c, cur_i
+                                       if loc.y < cur.y or (loc.y <= cur.y + cur.h and loc.x < cur.x)
+                                               after_i = cur_i
+                                               after = cur
+                                       else
+                                               before_i = cur_i
+                                               before = cur
+                               # which one is closest?
+                               if Math.abs(before.x - loc.x) < Math.abs(after.x - loc.x)
+                                       return [c, before_i]
+                               else
+                                       return [c, after_i]
+       return null
+
+class PeachHTML5Editor
+       constructor: (in_el, options = {}) ->
+               @in_el = in_el
+               @tree = []
+               @iframe = domify iframe: class: 'peach_html5_editor'
+               @cursor = null
+               @cursor_el = null
+               @cursor_visible = false
+               opt_fragment = options.fragment ? true
+               @parser_opts = {}
+               if opt_fragment
+                       @parser_opts.fragment = 'body'
+
+               @iframe.onload = =>
+                       @idoc = @iframe.contentDocument
+
+                       ignore_key_codes =
+                               '18': true # alt
+                               '20': true # capslock
+                               '17': true # ctrl
+                               '144': true # numlock
+                               '16': true # shift
+                               '91': true # windows "start" key
+                       control_key_codes = # we react to these, but they aren't typing
+                               '37': KEY_LEFT
+                               '38': KEY_UP
+                               '39': KEY_RIGHT
+                               '40': KEY_DOWN
+                               '35': KEY_END
+                               '8':  KEY_BACKSPACE
+                               '46': KEY_DELETE
+                               '13': KEY_ENTER
+                               '27': KEY_ESCAPE
+                               '36': KEY_HOME
+                               '45': KEY_INSERT
+                               '33': KEY_PAGE_UP
+                               '34': KEY_PAGE_DOWN
+                               '9':  KEY_TAB
+
+                       @idoc.body.onclick = (e) =>
+                               # idoc.body.offset().left/top
+                               new_cursor = find_loc_cursor_position @tree, x: e.pageX, y: e.pageY
+                               if new_cursor?
+                                       @move_cursor new_cursor
+                       @idoc.body.onkeyup = (e) =>
+                               return if e.ctrlKey
+                               return false if ignore_key_codes[e.keyCode]?
+                               #return false if control_key_codes[e.keyCode]?
+                       @idoc.body.onkeydown = (e) =>
+                               return if e.ctrlKey
+                               return false if ignore_key_codes[e.keyCode]?
+                               #return false if control_key_codes[e.keyCode]?
+                               switch e.keyCode
+                                       when KEY_LEFT
+                                               if @cursor?
+                                                       new_cursor = find_prev_cursor_position @tree, @cursor...
+                                                       if new_cursor?
+                                                               @move_cursor new_cursor
+                                               else
+                                                       for c in @tree
+                                                               new_cursor = find_next_cursor_position @tree, c, -1
+                                                               if new_cursor?
+                                                                       @move_cursor new_cursor
+                                                                       break
+                                               return false
+                                       when KEY_UP
+                                               return false
+                                       when KEY_RIGHT
+                                               if @cursor?
+                                                       new_cursor = find_next_cursor_position @tree, @cursor...
+                                                       if new_cursor?
+                                                               @move_cursor new_cursor
+                                               else
+                                                       for c in @tree
+                                                               new_cursor = find_prev_cursor_position @tree, c, -1
+                                                               if new_cursor?
+                                                                       @move_cursor new_cursor
+                                                                       break
+                                               return false
+                                       when KEY_DOWN
+                                               return false
+                                       when KEY_END
+                                               return false
+                                       when KEY_BACKSPACE
+                                               return false unless @cursor?
+                                               return false unless @cursor[1] > 0
+                                               @cursor[0].text = @cursor[0].text.substr(0, @cursor[1] - 1) + @cursor[0].text.substr(@cursor[1])
+                                               @cursor[0].el.nodeValue = @cursor[0].text
+                                               @move_cursor [@cursor[0], @cursor[1] - 1]
+                                               return false
+                                       when KEY_DELETE
+                                               return false unless @cursor?
+                                               return false unless @cursor[1] < @cursor[0].text.length
+                                               @cursor[0].text = @cursor[0].text.substr(0, @cursor[1]) + @cursor[0].text.substr(@cursor[1] + 1)
+                                               @cursor[0].el.nodeValue = @cursor[0].text
+                                               @move_cursor [@cursor[0], @cursor[1]]
+                                               return false
+                                       when KEY_ENTER
+                                               return false
+                                       when KEY_ESCAPE
+                                               return false
+                                       when KEY_HOME
+                                               return false
+                                       when KEY_INSERT
+                                               return false
+                                       when KEY_PAGE_UP
+                                               return false
+                                       when KEY_PAGE_DOWN
+                                               return false
+                                       when KEY_TAB
+                                               return false
+                       @idoc.body.onkeypress = (e) =>
+                               return if e.ctrlKey
+                               return false if ignore_key_codes[e.keyCode]?
+                               return false if control_key_codes[e.keyCode]? # handled in keydown
+                               char = e.charCode ? e.keyCode
+                               if char and @cursor?
+                                       char = String.fromCharCode char
+                                       if @cursor[1] is 0
+                                               @cursor[0].text = char + @cursor[0].text
+                                       else if @cursor[1] is @cursor[0].text.length - 1
+                                               @cursor[0].text += char
+                                       else
+                                               @cursor[0].text =
+                                                       @cursor[0].text.substr(0, @cursor[1]) +
+                                                       char +
+                                                       @cursor[0].text.substr(@cursor[1])
+                                       @cursor[0].el.nodeValue = @cursor[0].text
+                                       @move_cursor [@cursor[0], @cursor[1] + 1]
+                               return false
+                       if options.stylesheet # TODO test this
+                               istyle = @idoc.createElement 'style'
+                               istyle.setAttribute 'src', options.stylesheet
+                               @idoc.head.appendChild istyle
+                       icss = @idoc.createElement 'style'
+                       icss.appendChild @idoc.createTextNode css
+                       @idoc.head.appendChild icss
+                       @load_html @in_el.value
+
+               @in_el.parentNode.appendChild @iframe
+       clear_dom: ->
+               # FIXME add parent node, so we don't empty body and delete cursor_el
+               while @idoc.body.childNodes.length
+                       @idoc.body.removeChild @idoc.body.childNodes[0]
+               @cursor_visible = false
+               return
+       load_html: (html) ->
+               @tree = peach_parser.parse html, @parser_opts
+               #as_html = dom_to_html @tree
+               #@iframe.contentDocument.body.innerHTML = as_html
+               @clear_dom()
+               instantiate_tree @tree, @idoc.body
+       move_cursor: (cursor) ->
+               loc = cursor_to_xyh cursor[0], cursor[1]
+               return if loc is null
+               @cursor = cursor
+               # replace cursor, to reset blink animation
+               if @cursor_visible
+                       @cursor_el.parentNode.removeChild @cursor_el
+               @cursor_el = domify div: id: 'peach_html5_editor_cursor'
+               @idoc.body.appendChild @cursor_el
+               @cursor_visible = true
+               # TODO figure out x,y coords for cursor
+               @cursor_el.style.left = "#{loc.x}px"
+               @cursor_el.style.top = "#{loc.y}px"
+
+window.peach_html5_editor = (args...) ->
+       return new PeachHTML5Editor args...
 
-# test in browser: peach.wysiwyg(document.getElementsByTagName('textarea')[0])
+# test in browser: peach_html5_editor(document.getElementsByTagName('textarea')[0])