JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
remove unused method
[peach-html5-editor.git] / editor.coffee
index 0b76863..91f5c1c 100644 (file)
@@ -76,13 +76,6 @@ multi_sp_regex = new RegExp '[\u0020\u0009\u000a\u000c\u000d][\u0020\u0009\u000a
 str_has_ws_run = (str) ->
        return multi_sp_regex.test str
 
-debug_dot_at = (doc, x, y) ->
-       return # disabled
-       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_el_bounds = window.bounds = (el) ->
@@ -524,163 +517,6 @@ tree_remove_empty_text_nodes = (tree) ->
                                n.parent.children.splice i, 1
                                break
 
-# 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
-
-       tree_remove_empty_text_nodes(tree)
-
-       iterate = (tree, cb) ->
-               for n in tree
-                       if n.type is '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 '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 = (undo) ->
-               if undo
-                       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 -1
-               else
-                       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 1
-       replace_with_space = (undo) ->
-               if undo
-                       cur.text = (cur.text.substr 0, cur_i) + removed_char + (cur.text.substr cur_i + 1)
-                       cur.el.textContent = cur.text
-               else
-                       removed_char = cur.text.charAt(cur_i)
-                       if removed_char isnt ' '
-                               cur.text = (cur.text.substr 0, cur_i) + ' ' + (cur.text.substr cur_i + 1)
-                               cur.el.textContent = cur.text
-               return 0
-       # 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
-               fixers = [remove, replace_with_space]
-               # check for common case: single whitespace surrounded by non-whitespace chars
-               if prev? and next?
-                       unless (is_space_code prev.text.charCodeAt prev_i) or (is_space_code next.text.charCodeAt next_i)
-                               dbg = cur.text.charCodeAt cur_i
-                               if cur.text.charAt(cur_i) is ' ' # perens required
-                                       # single space can't collapse, doesn't need fixin'
-                                       return false
-                               else
-                                       # tab, newline, etc, can't collapse, but maybe should be replaced
-                                       fixers = [replace_with_space]
-               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
-                       # has bounds, don't try removing
-                       fixers = [replace_with_space]
-               # 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.
-               #
-               # this block (try changing it, put it back if something moves) is also
-               # used on collapsable whitespace characters besides space. In this case
-               # the character is replaced with a normal space character instead of
-               # removed
-               if prev? and not prev_px?
-                       prev_px = new_cursor_position n: prev, i: prev_i
-               if next? and not next_px?
-                       next_px = new_cursor_position n: next, i: next_i
-               #if prev is null and next is null
-               #       parent_px = cur.parent.el.getBoundingClientRect()
-               undo_arg = true # just for readabality
-               removed = 0
-               for fixer in fixers
-                       break if removed > 0
-                       removed += fixer()
-                       need_undo = false
-                       if prev?
-                               if prev_px?
-                                       new_prev_px = new_cursor_position n: prev, i: prev_i
-                                       if new_prev_px?
-                                               if new_prev_px.x isnt prev_px.x or new_prev_px.y isnt prev_px.y
-                                                       need_undo = true
-                                       else
-                                               need_undo = true
-                               else
-                                       console.log "this shouldn't happen, we remove spaces that don't locate"
-                       if next? and not need_undo
-                               if next_px?
-                                       new_next_px = new_cursor_position n: next, i: next_i
-                                       if new_next_px?
-                                               if new_next_px.x isnt next_px.x or new_next_px.y isnt next_px.y
-                                                       need_undo = true
-                                       else
-                                               need_undo = true
-                               #else
-                               #       console.log "removing space becase space after it is collapsed"
-                       if need_undo
-                               removed += fixer undo_arg
-               if removed > 0
-                       return true
-               else
-                       return false
-       # 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
-
-       tree_remove_empty_text_nodes(tree)
-
 class PeachHTML5Editor
        # Options: (all optional)
        #   editor_id: "id" attribute for outer-most element created by/for editor
@@ -952,15 +788,22 @@ class PeachHTML5Editor
                                return false
                        when KEY_DELETE
                                return false unless @cursor?
-                               return false unless @cursor.i < @cursor.n.text.length
-                               @remove_character @cursor.n, @cursor.i
-                               @text_cleanup @cursor.n
-                               @changed()
-                               new_cursor = new_cursor_position n: @cursor.n, i: @cursor.i
+                               new_cursor = find_next_cursor_position @tree, n: @cursor.n, i: @cursor.i
+                               # try moving cursor right and then running backspace code
+                               # TODO replace this hack with a real implementation
                                if new_cursor?
-                                       @move_cursor new_cursor
-                               else
-                                       @kill_cursor()
+                                       # try to detect common case where cursor goes inside an block,
+                                       # but doesn't pass a character (and advance one more in that case)
+                                       if new_cursor.n isnt @cursor.n and new_cursor.i is 0
+                                               if new_cursor.n.type is 'text' and new_cursor.n.text.length > 0
+                                                       if new_cursor.n.parent?
+                                                               unless @is_display_block new_cursor.n.parent
+                                                                       # FIXME should test run sibling
+                                                                       new_cursor = new_cursor_position n: new_cursor.n, i: new_cursor.i + 1
+                               if new_cursor?
+                                       if new_cursor.n isnt @cursor.n or new_cursor.i isnt @cursor.i
+                                               @move_cursor new_cursor
+                                               @on_key_backspace e
                                return false
                        when KEY_ENTER
                                @on_key_enter e
@@ -1071,7 +914,13 @@ class PeachHTML5Editor
                                                ret.push n
                        return false # not done traversing
                return ret
-       _merge_left: (state) -> # helper for on_key_backspace
+       node_is_decendant: (young, old) ->
+               while young? and young != @tree_parent
+                       return true if young is old
+                       young = young.parent
+               return false
+       # helper for on_key_backspace
+       _merge_left: (state) ->
                # the node prev to n was not prev to it a moment ago, merge with it if reasonable
                pi = state.n.parent.children.indexOf(state.n)
                if pi > 0
@@ -1082,18 +931,30 @@ class PeachHTML5Editor
                                @remove_node state.n
                                state.n = prev
                                state.changed = true
+                               state.moved_cursor = true
                # else # TODO merge possible consecutive matching inline tags at @cursor
                return state
-       _remove_node_and_inline_parents: (n) -> # helper for on_key_backspace
+       # helper for on_key_backspace
+       # remove n from the dom, also remove its inline parents that are emptied by removing n
+       _backspace_node_helper: (n, run = @get_text_run(n), run_i = run.indexOf(n)) ->
                block = @find_block_parent n
                # delete text node
                @remove_node n
                # delete any inline parents
                n = n.parent
                while n? and n isnt block
+                       # bail if the previous node in this run is also inside the same parent
+                       if run_i > 0
+                               break if @node_is_decendant run[run_i - 1], n
+                       # bail if the next node in this run is also inside the same parent
+                       if run_i + 1 < run.length
+                               break if @node_is_decendant run[run_i + 1], n
+                       # move any sibling nodes to parent. These nodes are not in the text run
                        while n.children.length > 0
                                @move_node n.children[0], n.parent, n
+                       # remove (now completely empty) inline parent
                        @remove_node n
+                       # proceed to outer parent
                        n = n.parent
                return
        on_key_backspace: (e) ->
@@ -1124,7 +985,7 @@ class PeachHTML5Editor
                                prev = run[run_i - 1]
                                if prev.type is 'text' # if previous in text run is text
                                        if prev.text.length is 1 # if emptying prev (in text run)
-                                               @_remove_node_and_inline_parents prev
+                                               @_backspace_node_helper prev, run, run_i
                                                merge_state = n: @cursor.n, i: @cursor.i
                                                @_merge_left merge_state
                                                @text_cleanup merge_state.n
@@ -1136,12 +997,12 @@ class PeachHTML5Editor
                                                @text_cleanup @cursor.n
                                                new_cursor = new_cursor_position n: @cursor.n, i: @cursor.i
                                else if prev.name is 'br' or prev.name is 'hr'
-                                       @_remove_node_and_inline_parents prev
+                                       @_backspace_node_helper prev, run, run_i
                                        merge_state = n: @cursor.n, i: @cursor.i
                                        @_merge_left merge_state
                                        @text_cleanup merge_state.n
                                        new_cursor = new_cursor_position n: merge_state.n, i: merge_state.i
-                               # FIXME CONTINUE
+                               # FIXME implement this:
                                # else # if prev (in run) is inline-block
                                        # if that inline-block has text in it
                                                # delete last char in prev inlineblock
@@ -1162,6 +1023,10 @@ class PeachHTML5Editor
                                        block = @find_block_parent @cursor.n
                                        changed = false
                                        n = @cursor.n.parent
+                                       # note: this doesn't use _backspace_node_helper because:
+                                       # 1. we don't want to delete the target node (we're replacing it's contents)
+                                       # 2. we want to track whether anything was removed
+                                       # 3. we know already know there's no other text from this run anywhere
                                        while n and n isnt block
                                                changed = true
                                                while n.children.length > 0
@@ -1183,19 +1048,25 @@ class PeachHTML5Editor
                                        ncb = @find_block_parent new_cursor.n
                                        if ncb isnt block
                                                new_cursor = find_next_cursor_position @tree, n: @cursor.n, i: 1
-                                       # delete text node
-                                       @remove_node @cursor.n
-                                       # delete any inline parents
-                                       n = @cursor.n.parent
-                                       while n? and n isnt block
-                                               # FIXME break if anything else in the text run is in here too
-                                               while n.children.length > 0
-                                                       @move_node n.children[0], n.parent, n
-                                               @remove_node n
-                                               n = n.parent
-                                       # update cursor dest in case things moved around
+                                       # delete text node and cleanup emptied parents
+                                       run_i = run.indexOf @cursor.n
+                                       @_backspace_node_helper @cursor.n, run, run_i
+                                       # see if new adjacent siblings should merge
+                                       # TODO make smarter
+                                       if run_i > 0 and run_i + 1 < run.length
+                                               if run[run_i - 1].type is 'text' and run[run_i + 1].type is 'text'
+                                                       merge_state = n: run[run_i + 1]
+                                                       @_merge_left merge_state
+                                                       if merge_state.moved_cursor
+                                                               new_cursor = merge_state
+                                       # update whitespace preservation
+                                       @text_cleanup(block)
+                                       # update cursor x/y in case things moved around
                                        if new_cursor?
-                                               new_cursor = new_cursor_position n: new_cursor.n, i: new_cursor.i
+                                               if new_cursor.n.el.parentNode # still in dom after cleanup
+                                                       new_cursor = new_cursor_position n: new_cursor.n, i: new_cursor.i
+                                               else
+                                                       new_cursor = null
                        else # there's a char left of cursor that we can delete without emptying anything
                                # delete character
                                need_text_cleanup = true
@@ -1313,7 +1184,7 @@ class PeachHTML5Editor
                @tree_parent.el = @idoc.body
                @clear_dom()
                instantiate_tree @tree, @tree_parent.el
-               tree_dedup_space @tree
+               @collapse_whitespace @tree
                @changed()
        changed: ->
                @in_el.onchange = null
@@ -1330,28 +1201,6 @@ class PeachHTML5Editor
                h = parseInt(@idoc.body.scrollHeight, 10)
                @iframe.style.height = "#{h}px"
                @wrap2.scrollTop = s
-       # does this node have whitespace that would be collapsed by white-space: normal?
-       # note: this checks direct text children, and does _not_ recurse into child tags
-       # tag is a node with type:"tag"
-       # FIXME use new textrun api
-       has_collapsable_space: (tag) ->
-               for n in tag.children
-                       if n.type is 'text'
-                               for i in [0...n.text.length]
-                                       code = n.text.charCodeAt i
-                                       if code isnt 32 and is_space_code code
-                                               # tab, return
-                                               return true
-                                       # check for double spaces that don't surround insert location
-                                       continue if i is 0
-                                       if n.text.substr(i - 1, 2) is '  '
-                                               return true
-                               if n.text.length > 0
-                                       if is_space_code n.text.charCodeAt 0
-                                               return true
-                                       if is_space_code n.text.charCodeAt n.text.length - 1
-                                               return true
-               return false
        # true if n is text node with only one caracter, and the only child of a tag
        is_only_char_in_tag: (n, i) ->
                return false unless n.type is 'text'
@@ -1426,10 +1275,172 @@ class PeachHTML5Editor
                else
                        if n.attrs.style?
                                delete n.attrs.style
+       # remove whitespace that would be trimmed
+       # replace whitespace that would collapse with a single space
+       # FIXME remove whitespace from after <br> (but not before)
+       collapse_whitespace: (tree = @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
+
+               tree_remove_empty_text_nodes(tree)
+
+               iterate = (tree, cb) ->
+                       for n in tree
+                               if n.type is '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 '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 = (undo) ->
+                       if undo
+                               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 -1
+                       else
+                               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 1
+               replace_with_space = (undo) ->
+                       if undo
+                               cur.text = (cur.text.substr 0, cur_i) + removed_char + (cur.text.substr cur_i + 1)
+                               cur.el.textContent = cur.text
+                       else
+                               removed_char = cur.text.charAt(cur_i)
+                               if removed_char isnt ' '
+                                       cur.text = (cur.text.substr 0, cur_i) + ' ' + (cur.text.substr cur_i + 1)
+                                       cur.el.textContent = cur.text
+                       return 0
+               # 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
+                       fixers = [remove, replace_with_space]
+                       # check for common case: single whitespace surrounded by non-whitespace chars
+                       if prev? and next?
+                               unless (is_space_code prev.text.charCodeAt prev_i) or (is_space_code next.text.charCodeAt next_i)
+                                       dbg = cur.text.charCodeAt cur_i
+                                       if cur.text.charAt(cur_i) is ' ' # perens required
+                                               # single space can't collapse, doesn't need fixin'
+                                               return false
+                                       else
+                                               # tab, newline, etc, can't collapse, but maybe should be replaced
+                                               fixers = [replace_with_space]
+                       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
+                               # has bounds, don't try removing
+                               fixers = [replace_with_space]
+                       # 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.
+                       #
+                       # this block (try changing it, put it back if something moves) is also
+                       # used on collapsable whitespace characters besides space. In this case
+                       # the character is replaced with a normal space character instead of
+                       # removed
+                       if prev? and not prev_px?
+                               prev_px = new_cursor_position n: prev, i: prev_i
+                       if next? and not next_px?
+                               next_px = new_cursor_position n: next, i: next_i
+                       #if prev is null and next is null
+                       #       parent_px = cur.parent.el.getBoundingClientRect()
+                       undo_arg = true # just for readabality
+                       removed = 0
+                       for fixer in fixers
+                               break if removed > 0
+                               removed += fixer()
+                               need_undo = false
+                               if prev?
+                                       if prev_px?
+                                               new_prev_px = new_cursor_position n: prev, i: prev_i
+                                               if new_prev_px?
+                                                       if new_prev_px.x isnt prev_px.x or new_prev_px.y isnt prev_px.y
+                                                               need_undo = true
+                                               else
+                                                       need_undo = true
+                                       else
+                                               console.log "this shouldn't happen, we remove spaces that don't locate"
+                               if next? and not need_undo
+                                       if next_px?
+                                               new_next_px = new_cursor_position n: next, i: next_i
+                                               if new_next_px?
+                                                       if new_next_px.x isnt next_px.x or new_next_px.y isnt next_px.y
+                                                               need_undo = true
+                                               else
+                                                       need_undo = true
+                                       #else
+                                       #       console.log "removing space becase space after it is collapsed"
+                               if need_undo
+                                       removed += fixer undo_arg
+                       if removed > 0
+                               return true
+                       else
+                               return false
+               # 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
+
+               tree_remove_empty_text_nodes(tree)
+               return
        # call this after you insert or remove inline nodes. It will:
        #    merge consecutive text nodes
        #    remove empty text nodes
        #    adjust white-space property
+       # note: this assumes that all whitespace in text nodes should be displayed
+       # (ie not collapse or be trimmed) and will change the white-space property
+       # as needed to achieve this.
        text_cleanup: (n) ->
                if @is_display_block n
                        block = n