From bbe9c00bdbbf6f076c5feb35e64b6e0b5c6bb6dd Mon Sep 17 00:00:00 2001
From: Simon Lydell <simon.lydell@gmail.com>
Date: Wed, 24 Feb 2016 15:32:45 +0100
Subject: [PATCH] Allow to temporarily enter Ignore mode based on focusType

Currently supports the wasavi extension and CodeMirror's Vim mode.

Fixes #532.
---
 documentation/api.md        |  3 +++
 documentation/options.md    | 23 +++++++++++++++++++++++
 extension/lib/events.coffee |  2 +-
 extension/lib/modes.coffee  | 10 +++++++---
 extension/lib/utils.coffee  | 22 ++++++++++++++++++++++
 extension/lib/vim.coffee    | 10 +++++++++-
 6 files changed, 65 insertions(+), 5 deletions(-)

diff --git a/documentation/api.md b/documentation/api.md
index e657f8d..0d125c4 100644
--- a/documentation/api.md
+++ b/documentation/api.md
@@ -550,6 +550,9 @@ A `match` object has the following properties:
   following values, depending on what kind of _element_ is focused and which
   _key_ was pressed:
 
+  - `'ignore'`: element: some kind of Vim-style editor. VimFx automatically
+    enters Ignore mode when this focus type is encountered. key: any pressed
+    key.
   - `'editable'`: element: some kind of text input, a `<select>` element or a
     “contenteditable” element. key: any pressed key.
   - `'activatable'`: element: an “activatable” element (link or button).
diff --git a/documentation/options.md b/documentation/options.md
index ecad5be..8090ac7 100644
--- a/documentation/options.md
+++ b/documentation/options.md
@@ -87,6 +87,29 @@ You might also want to read about the [Ignore mode `<s-f1>` command][s-f1].
 [button]: button.md
 [s-f1]: commands.md#ignore-mode-s-f1
 
+#### Blacklisting specific elements
+
+VimFx automatically enters Ignore mode while Vim-style editors are focused, such
+as the [wasavi] extension and [CodeMirror editors in Vim mode][codemirror-vim].
+
+By default, VimFx lets you press `<escape>` to blur text inputs. Also by
+default, Vim-style editors use `<escape>` to exit from their Insert mode to
+their Normal mode. In other words, there is a keyboard shortcut conflict here.
+
+It makes the most sense to let the Vim-style editor “win.” That’s why VimFx
+(temporarily) enters Ignore mode when focusing such an editor. In Insert mode,
+there is no `<escape>` shortcut (by default), and thus no conflict. Instead,
+there’s `<s-escape>` to blur the current element and exit Ignore mode.
+`<s-escape>` was chosen because it is very unlikely to cause conflicts. If it
+ever does, there’s the [`<s-f1>`] command to the rescue.
+
+There is currently no way of specifying your own elements to be blacklisted, but
+such a feature could be added if there’s demand for it.
+
+[wasavi]: http://appsweets.net/wasavi/
+[codemirror-vim]: https://codemirror.net/demo/vim.html
+[`<s-f1>`]: commands.md#ignore-mode-s-f1
+
 ### Prevent autofocus
 
 Many sites autofocus their search box, for example. This might be annoying when
diff --git a/extension/lib/events.coffee b/extension/lib/events.coffee
index 4f8a68d..182b172 100644
--- a/extension/lib/events.coffee
+++ b/extension/lib/events.coffee
@@ -122,7 +122,7 @@ class UIEventManager
 
       if vim.isUIEvent(event)
         focusType = utils.getFocusType(utils.getActiveElement(@window))
-        @vimfx.emit('focusTypeChange', {vim, focusType})
+        vim._setFocusType(focusType)
 
     @listen('focus', handleFocusRelatedEvent.bind(null, {mode: 'find'}))
     @listen('blur',  handleFocusRelatedEvent.bind(null, {mode: 'normal'}))
diff --git a/extension/lib/modes.coffee b/extension/lib/modes.coffee
index 7c6a78a..3eba1c8 100644
--- a/extension/lib/modes.coffee
+++ b/extension/lib/modes.coffee
@@ -217,7 +217,8 @@ mode('ignore', {
       storage.type ?= 'explicit'
 
   onLeave: ({vim, storage}) ->
-    vim._run('blur_active_element') unless storage.count?
+    unless storage.count? or storage.type == 'focusType'
+      vim._run('blur_active_element')
 
   onInput: (args, match) ->
     {vim, storage} = args
@@ -233,8 +234,11 @@ mode('ignore', {
     return false
 
 }, {
-  exit: ({vim}) -> vim.enterMode('normal')
-  unquote: ({vim}) -> vim.enterMode('normal', {returnTo: 'ignore'})
+  exit: ({vim, storage}) ->
+    storage.type = null
+    vim.enterMode('normal')
+  unquote: ({vim}) ->
+    vim.enterMode('normal', {returnTo: 'ignore'})
 })
 
 
diff --git a/extension/lib/utils.coffee b/extension/lib/utils.coffee
index 80dcb01..d07899e 100644
--- a/extension/lib/utils.coffee
+++ b/extension/lib/utils.coffee
@@ -95,6 +95,24 @@ isIframeEditor = (element) ->
          # The wasavi extension.
          element.hasAttribute('data-wasavi-state')
 
+isIgnoreModeFocusType = (element) ->
+  return \
+    # The wasavi extension.
+    element.hasAttribute('data-wasavi-state') or
+    element.closest('#wasavi_container') or
+    # CodeMirror in Vim mode.
+    (element.localName == 'textarea' and
+     element.closest('.CodeMirror') and _hasVimEventListener(element))
+
+# CodeMirror’s Vim mode is really sucky to detect. The only way seems to be to
+# check if the there are any event listener functions with Vim-y words in them.
+_hasVimEventListener = (element) ->
+  for listener in nsIEventListenerService.getListenerInfoFor(element)
+    if listener.listenerObject and
+       /\bvim\b|insertmode/i.test(String(listener.listenerObject))
+      return true
+  return false
+
 isProperLink = (element) ->
   # `.getAttribute` is used below instead of `.hasAttribute` to exclude `<a
   # href="">`s used as buttons on some sites.
@@ -175,6 +193,8 @@ focusElement = (element, options = {}) ->
   element.select?() if options.select
 
 getFocusType = (element) -> switch
+  when isIgnoreModeFocusType(element)
+    'ignore'
   when isTypingElement(element)
     'editable'
   when isActivatable(element)
@@ -510,6 +530,8 @@ module.exports = {
   isActivatable
   isAdjustable
   isContentEditable
+  isIframeEditor
+  isIgnoreModeFocusType
   isProperLink
   isTextInputElement
   isTypingElement
diff --git a/extension/lib/vim.coffee b/extension/lib/vim.coffee
index d05d83d..4d75715 100644
--- a/extension/lib/vim.coffee
+++ b/extension/lib/vim.coffee
@@ -79,7 +79,7 @@ class Vim
       # the frame script arrives too late. Therefore, check that the currently
       # active element isn’t a browser UI element first.
       unless @_isUIElement(utils.getActiveElement(@window))
-        @_parent.emit('focusTypeChange', {vim: this, focusType})
+        @_setFocusType(focusType)
     )
 
   _setBrowser: (@browser, {addListeners = true} = {}) ->
@@ -182,4 +182,12 @@ class Vim
     @browser.focus()
     @_run('focus_marker_element', {elementIndex, options})
 
+  _setFocusType: (focusType) ->
+    switch
+      when focusType == 'ignore'
+        @enterMode('ignore', {type: 'focusType'})
+      when @mode == 'ignore' and @_storage.ignore.type == 'focusType'
+        @enterMode('normal')
+    @_parent.emit('focusTypeChange', {vim: this, focusType})
+
 module.exports = Vim
-- 
2.39.3