JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
test/show-off how smart whitespace checking is
[peach-html5-editor.git] / editor.coffee
index 956ade0..45d505b 100644 (file)
@@ -27,7 +27,6 @@ debug_dot_at = (doc, x, y) ->
 
 # 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()
@@ -47,41 +46,53 @@ get_el_bounds = (el) ->
                h: rect.height ? (rect.top - rect.bottom)
        }
 
+is_display_block = (el) ->
+       if el.currentStyle?
+               return el.currentStyle.display is 'block'
+       else
+               return window.getComputedStyle(el, null).getPropertyValue('display') is 'block'
+
+# Warning: currently assumes you're asking about a single character
+# Note: chromium returns multiple bounding rects for a space at a line-break
+# Note: chromium's getBoundingClientRect() is broken (when zero-area client rects)
+# Note: sometimes returns null (eg for whitespace that is not visible)
+text_range_bounds = (el, start, end) ->
+       range = document.createRange()
+       range.setStart el, start
+       range.setEnd el, end
+       rects = range.getClientRects()
+       if rects.length > 0
+               rect = rects[0]
+       else
+               return null
+       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)
+               rects: rects
+               bounding: range.getBoundingClientRect()
+       }
+
 # figure out the x/y coordinates of where the cursor should be if it's at
 # position ``i`` within text node ``n``
+# sometimes returns null (eg for whitespace that is not visible)
 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
+               ret = text_range_bounds n.el, 0, 0
        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]
+               ret = text_range_bounds n.el, i - 1, i
+               if ret?
+                       ret.x += ret.w
        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
+               ret = text_range_bounds n.el, i, i + 1
+       if ret?
+               debug_dot_at n.el.ownerDocument, ret.x, ret.y
        return ret
 
 # encode text so it can be safely placed inside an html attribute
@@ -217,10 +228,14 @@ traverse_tree = (tree, state, cb) ->
 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
+               unless orig_xyh?
+                       console.log "ERROR: couldn't find xy for current cursor location"
+                       return
                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]
+                       if next_xyh?
+                               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
@@ -235,10 +250,14 @@ find_next_cursor_position = (tree, n, i) ->
 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
+               unless orig_xyh?
+                       console.log "ERROR: couldn't find xy for current cursor location"
+                       return
                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]
+                       if prev_xyh?
+                               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
@@ -271,8 +290,14 @@ find_loc_cursor_position = (tree, loc) ->
                                return [c, 0] if c.text.length is 0
                                before_i = 0
                                before = cursor_to_xyh c, before_i
+                               unless before?
+                                       console.log "error: failed to find cursor pixel location for start of", c
+                                       return
                                after_i = c.text.length
                                after = cursor_to_xyh c, after_i
+                               unless after?
+                                       console.log "error: failed to find cursor pixel location for end of", c
+                                       return
                                if loc.y < before.y + before.h and loc.x < before.x
                                        # console.log 'before first char on first line'
                                        continue
@@ -288,6 +313,9 @@ find_loc_cursor_position = (tree, loc) ->
                                while after_i - before_i > 1
                                        cur_i = Math.round((before_i + after_i) / 2)
                                        cur = cursor_to_xyh c, cur_i
+                                       unless loc?
+                                               console.log "error: failed to find cursor pixel location for", c, cur_i
+                                               return
                                        if loc.y < cur.y or (loc.y <= cur.y + cur.h and loc.x < cur.x)
                                                after_i = cur_i
                                                after = cur
@@ -301,6 +329,133 @@ find_loc_cursor_position = (tree, loc) ->
                                        return [c, after_i]
        return null
 
+# browsers collapse these (html5 spec calls these "space characters")
+is_space_code = (char_code) ->
+       switch char_code
+               when 9, 10, 12, 13, 32
+                       return true
+       return false
+is_space = (chr) ->
+       return is_space_code chr.charCodeAt 0
+
+# pass a array of nodes (from parser library, ie it should have .el and .text)
+tree_dedup_space = (tree) ->
+       prev = cur = next = null
+       prev_i = cur_i = next_i = 0
+       prev_pos = pos = next_pos = null
+       prev_px = cur_px = next_px = null
+       first = true
+       removed_char = null
+
+       iterate = (tree, cb) ->
+               for n in tree
+                       if n.type is TYPE_TEXT
+                               i = 0
+                               while i < n.text.length # don't foreach, cb might remove chars
+                                       advance = cb n, i
+                                       if advance
+                                               i += 1
+                       if n.type is TYPE_TAG
+                               block = is_display_block n.el
+                               if block
+                                       cb null
+                               if n.children.length > 0
+                                       iterate n.children, cb
+                               if block
+                                       cb null
+       # remove cur char
+       remove = ->
+               removed_char = cur.text.charAt(cur_i)
+               cur.el.textContent = cur.text = (cur.text.substr 0, cur_i) + (cur.text.substr cur_i + 1)
+               if next is cur # in same text node
+                       if next_i is 0
+                               throw "how is this possible?"
+                       next_i -= 1
+               return true
+       # undo remove()
+       put_it_back = ->
+               cur.el.textContent = cur.text = (cur.text.substr 0, cur_i) + removed_char + (cur.text.substr cur_i)
+               if next is cur # in same text node
+                       next_i += 1
+               return false
+       # return true if cur was removed from the dom (ie re-use same prev)
+       operate = ->
+               # cur definitately set
+               # prev and/or next might be null, indicating the start/end of a display:block
+               return false unless is_space_code cur.text.charCodeAt cur_i
+               bounds = text_range_bounds cur.el, cur_i, cur_i + 1
+               # consistent cases:
+               # 1. zero rects returned by getClientRects() means collapsed space
+               if bounds is null
+                       return remove()
+               # 2. width greater than zero means visible space
+               if bounds.w > 0
+                       return false
+               # now the weird edge cases...
+               #
+               # firefox and chromium both report zero width for characters at the end
+               # of a line where the text wraps (automatically, due to word-wrap) to
+               # the next line. These do not appear to be distinguishable from
+               # collapsed spaces via the range/bounds api, so...
+               #
+               # remove it from the dom, and if prev or next moves, put it back.
+               if prev? and not prev_px?
+                       prev_px = cursor_to_xyh prev, prev_i
+               if next? and not next_px?
+                       next_px = cursor_to_xyh next, next_i
+               #if prev is null and next is null
+               #       parent_px = cur.parent.el.getBoundingClientRect()
+               remove()
+               if prev?
+                       if prev_px?
+                               new_prev_px = cursor_to_xyh prev, prev_i
+                               if new_prev_px.x isnt prev_px.x or new_prev_px.y isnt prev_px.y
+                                       return put_it_back()
+                       else
+                               console.log "this shouldn't happen, we remove spaces that don't locate"
+               if next?
+                       if next_px?
+                               new_next_px = cursor_to_xyh next, next_i
+                               if new_next_px.x isnt next_px.x or new_next_px.y isnt next_px.y
+                                       return put_it_back()
+                       #else
+                       #       console.log "removing space becase space after it is collapsed"
+               # if there's no prev or next (single space inside a block-level element?) check
+               # TODO scrapt this, or fix it so it works when there's no parent
+               # if prev is null and next is null
+               #       new_parent_px = cur.parent.el.getBoundingClientRect()
+               #       if new_parent_px.left isnt parent_px.left or new_parent_px.top isnt parent_px.top or new_parent_px.right isnt parent_px.right or new_parent_px.bottom isnt parent_px.bottom
+               #               console.log "WEIRD: parent moved"
+               #               return put_it_back()
+               # we didn't put it back
+               return true
+       # pass null at start/end of display:block
+       queue = (n, i) ->
+               next = n
+               next_i = i
+               next_px = null
+               advance = true
+               if cur?
+                       removed = operate()
+                       # don't advance (to the next character next time) if we removed a
+                       # character from the same text node as ``next``, because doing so
+                       # renumbers the indexes in that string
+                       if removed and cur is next
+                               advance = false
+               else
+                       removed = false
+               unless removed
+                       prev = cur
+                       prev_i = cur_i
+                       prev_px = cur_px
+               cur = next
+               cur_i = next_i
+               cur_px = next_px
+               return advance
+       queue null
+       iterate tree, queue
+       queue null
+
 class PeachHTML5Editor
        constructor: (in_el, options = {}) ->
                @in_el = in_el
@@ -430,6 +585,7 @@ class PeachHTML5Editor
                                                        @cursor[0].text.substr(@cursor[1])
                                        @cursor[0].el.nodeValue = @cursor[0].text
                                        @move_cursor [@cursor[0], @cursor[1] + 1]
+                                       @changed()
                                return false
                        if options.stylesheet # TODO test this
                                istyle = @idoc.createElement 'style'
@@ -449,13 +605,21 @@ class PeachHTML5Editor
                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
+               tree_dedup_space @tree
+               @changed()
+       changed: ->
+               # FIXME don't export cursor placeholder (when cursor is between space characters)
+               @in_el.onchange = null
+               @in_el.value = dom_to_html @tree
+               @in_el.onchange = =>
+                       @load_html @in_el.value
        move_cursor: (cursor) ->
                loc = cursor_to_xyh cursor[0], cursor[1]
-               return if loc is null
+               unless loc?
+                       console.log "error: tried to move cursor to position that has no pixel location", cursor[0], cursor[1]
+                       return
                @cursor = cursor
                # replace cursor, to reset blink animation
                if @cursor_visible