Implement gD

keymaps/vim-mode.cson

@@ -183,6 +183,7 @@
   'm': 'vim-mode:mark'
   '`': 'vim-mode:move-to-mark-literal'
   '\'': 'vim-mode:move-to-mark'
+  'g D': 'vim-mode:move-to-definition'
 
   'f': 'vim-mode:find'
   'F': 'vim-mode:find-backwards'

lib/motions/index.coffee

@@ -1,13 +1,15 @@
 Motions = require './general-motions'
 {Search, SearchCurrentWord, BracketMatchingMotion, RepeatSearch} = require './search-motion'
 MoveToMark = require './move-to-mark-motion'
+MoveToDefinition = require './move-to-definition-motion'
 {Find, Till} = require './find-motion'
 
 Motions.Search = Search
 Motions.SearchCurrentWord = SearchCurrentWord
 Motions.BracketMatchingMotion = BracketMatchingMotion
 Motions.RepeatSearch = RepeatSearch
 Motions.MoveToMark = MoveToMark
+Motions.MoveToDefinition = MoveToDefinition
 Motions.Find = Find
 Motions.Till = Till
 

lib/motions/move-to-definition-motion.coffee

@@ -0,0 +1,7 @@
+{SearchCurrentWord} = require './search-motion'
+
+module.exports =
+class MoveToDefinition extends SearchCurrentWord
+
+  # Scan using a fake cursor that reports its position at the top of the doc
+  scan: (cursor) -> super {getBufferPosition: -> [0, 0]}, true

lib/motions/search-motion.coffee

@@ -26,13 +26,13 @@ class SearchBase extends MotionWithInput
     else
       atom.beep()
 
-  scan: (cursor) ->
+  scan: (cursor, returnFirstResult = false) ->
     return [] if @input.characters is ""
-
     currentPosition = cursor.getBufferPosition()
 
     [rangesBefore, rangesAfter] = [[], []]
-    @editor.scan @getSearchTerm(@input.characters), ({range}) =>
+    @editor.scan @getSearchTerm(@input.characters), (iteration) =>
+      range = iteration.range
       isBefore = if @reverse
         range.start.compare(currentPosition) < 0
       else
@@ -43,6 +43,8 @@ class SearchBase extends MotionWithInput
       else
         rangesAfter.push(range)
 
+      iteration.stop() if returnFirstResult
+
     if @reverse
       rangesAfter.concat(rangesBefore).reverse()
     else
@@ -60,6 +62,9 @@ class SearchBase extends MotionWithInput
 
     modFlags = Object.keys(modifiers).join('')
 
+    # Escape the term for use in regex
+    term = term.replace /([$])/g, '\\$1'
+
     try
       new RegExp(term, modFlags)
     catch

lib/vim-state.coffee

@@ -175,6 +175,7 @@ class VimState
       'repeat-search-backwards': (e) => new Motions.RepeatSearch(@editor, this).reversed()
       'move-to-mark': (e) => new Motions.MoveToMark(@editor, this)
       'move-to-mark-literal': (e) => new Motions.MoveToMark(@editor, this, false)
+      'move-to-definition': (e) => new Motions.MoveToDefinition(@editor, this)
       'mark': (e) => new Operators.Mark(@editor, this)
       'find': (e) => new Motions.Find(@editor, this)
       'find-backwards': (e) => new Motions.Find(@editor, this).reverse()

spec/motions-spec.coffee

@@ -1454,6 +1454,46 @@ describe "Motions", ->
       normalModeInputKeydown('`')
       expect(editor.getCursorBufferPosition()).toEqual [1, 5]
 
+  describe 'the gD keybindings', ->
+
+    it 'moves to the definition of a js variable', ->
+      editor.setText('var myVar;\nmyVar')
+      editor.setCursorBufferPosition([1, 1])
+      keydown('g')
+      keydown('D', shift: true)
+      expect(editor.getCursorBufferPosition()).toEqual [0, 4]
+
+    it 'moves to the definition of a php variable', ->
+      # a user may choose to include `$` as part of names:
+      atom.config.set('vim-mode.iskeyword', '[$@a-zA-Z0-9_\-]+')
+
+      editor.setText('$myVar = 20;\n$myVar')
+      editor.setCursorBufferPosition([1, 1])
+      keydown('g')
+      keydown('D', shift: true)
+      expect(editor.getCursorBufferPosition()).toEqual [0, 0]
+
+    it 'moves to the definition of a class', ->
+      editor.setText('class myClass {}\nmyClass')
+      editor.setCursorBufferPosition([1, 1])
+      keydown('g')
+      keydown('D', shift: true)
+      expect(editor.getCursorBufferPosition()).toEqual [0, 6]
+
+    it 'moves to the definition of a global variable', ->
+      editor.setText('bar = 10\nbar')
+      editor.setCursorBufferPosition([1, 1])
+      keydown('g')
+      keydown('D', shift: true)
+      expect(editor.getCursorBufferPosition()).toEqual [0, 0]
+
+    it 'moves to the definition of a variable with many keywords', ->
+      editor.setText('public static int bar = 10\nbar')
+      editor.setCursorBufferPosition([1, 1])
+      keydown('g')
+      keydown('D', shift: true)
+      expect(editor.getCursorBufferPosition()).toEqual [0, 18]
+
   describe 'the f/F keybindings', ->
     beforeEach ->
       editor.setText("abcabcabcabc\n")