Merge pull request #204 from Microsoft/tooltips

Updated tooltip positioning for the refactor

Author: billti

Default.sublime-keymap

@@ -73,15 +73,6 @@
             { "key": "selector", "operator": "equal", "operand": "text.find-refs" }
         ]
     },
-    {
-        "keys": [ "alt+,"],
-        "command": "typescript_signature_popup",
-        "context": [
-            { "key": "selector", "operator": "equal", "operand": "source.ts" },
-            { "key": "tooltip_supported", "operator": "equal", "operand": true}
-
-        ]
-    },
     {
         "keys": [ "ctrl+t", "ctrl+q" ],
         "command": "typescript_quick_info_doc",
@@ -135,6 +126,15 @@
             { "key": "selector", "operator": "equal", "operand": "source.ts" },
             { "key": "is_popup_visible"}
         ]
+    },    // In case when auto match is enabled, only format if not within {}
+    {
+        "keys": [ "alt+,"],
+        "command": "typescript_signature_popup",
+        "context": [
+            { "key": "selector", "operator": "equal", "operand": "source.ts" },
+            { "key": "tooltip_supported", "operator": "equal", "operand": true}
+
+        ]
     },
     {
         "keys": [ "enter" ],

TypeScript.sublime-commands

@@ -10,5 +10,6 @@
  { "caption" : "TypeScript: Rename", "command": "typescript_rename" },
  { "caption" : "TypeScript: PasteAndFormat", "command": "typescript_paste_and_format" },
  { "caption" : "TypeScript: FormatLine", "command": "typescript_format_line" },
+ { "caption" : "TypeScript: SignatureInfo", "command": "typescript_signature_popup" },
  { "caption" : "TypeScript: FormatBlock", "command": "typescript_format_brackets" }
 ]

typescript/libs/popup_manager.py

@@ -14,6 +14,12 @@ class PopupManager():
 
     It uses the WorkScheduler class to handle sending requests to the server to
     ensure good performance.
+
+    The main challenge is that certain activities, such as cursor movement, can
+    automatically dismiss the popup - even though the cursor may still be in the
+    argument list. Therefore the class listens to the on_hidden event, and will
+    redisplay if necessary (i.e. if the cursor is still in the argument list).
+    If the popup is explicitly dismissed, on_close_popup is called.
     """
 
     html_template = ''
@@ -30,6 +36,9 @@ def __init__(self, proxy):
         self.signature_index = 0
         self.current_parameter = 0
 
+        # Track current popup location to see if we only need to update the text
+        self.current_location = None
+
     def queue_signature_popup(self, view):
         cursor = view.rowcol(view.sel()[0].begin())
         point = Location(cursor[0] + 1, cursor[1] + 1)
@@ -58,14 +67,15 @@ def on_response(self, responseJson, view):
         self.current_parameter = responseJson["body"]["argumentIndex"]
 
         # Add a region to track the arg list as the user types
-        # Needs to be ajusted to 0-based indexing
+        # Needs to be adjusted to 0-based indexing
         arg_span = self.signature_help["applicableSpan"]
         span_start = view.text_point(
             arg_span["start"]["line"] - 1,
             arg_span["start"]["offset"] - 2)
         span_end = view.text_point(
             arg_span["end"]["line"] - 1,
-            arg_span["end"]["offset"] - 1)
+            arg_span["end"]["offset"])
+
         arg_region = sublime.Region(span_start, span_end)
         view.add_regions('argSpan', [arg_region],
                          flags=sublime.HIDDEN)
@@ -78,15 +88,36 @@ def display(self):
         popup_text = PopupManager.html_template.substitute(popup_parts)
 
         log.debug('Displaying signature popup')
-        if not self.current_view.is_popup_visible():
+
+        arg_region = self.current_view.get_regions('argSpan')[0]
+        location = arg_region.begin()  # Default to start of arg list
+
+        # If the cursor is not in the first line of the arg list, set the popup
+        # location to first non-whitespace, or EOL, of the current line
+        cursor_point = self.current_view.sel()[0].begin()
+        opening_line = self.current_view.line(arg_region.begin())
+        if(not opening_line.contains(cursor_point)):
+            cursor_line_start = self.current_view.line(cursor_point).begin()
+            location = self.current_view.find(
+                r'\s*?(?=[\S\n\r]|$)',
+                cursor_line_start
+            ).end()
+
+        # If the popup is currently visible and at the right location, then
+        # call 'update' instead of 'show', else this can get in a loop when show
+        # causes the old popup to be hidden (and on_hidden is called), as well
+        # as causing some unnecessary UI flickering.
+        if self.current_view.is_popup_visible() and self.current_location == location:
+            self.current_view.update_popup(popup_text)
+        else:
+            self.current_location = location
             self.current_view.show_popup(
                 popup_text,
                 sublime.COOPERATE_WITH_AUTO_COMPLETE,
                 on_navigate=self.on_navigate,
                 on_hide=self.on_hidden,
+                location=location,
                 max_width=800)
-        else:
-            self.current_view.update_popup(popup_text)
 
     def move_next(self):
         if not self.signature_help:
@@ -113,15 +144,17 @@ def on_navigate(self, loc):
     def on_hidden(self):
         log.debug('In popup on_hidden handler')
         if not self.current_view:
+            log.debug('No current view for popup session. Hiding popup')
             return
 
+        # If we're still in the arg list, then redisplay
         cursor_region = self.current_view.sel()[0]
         arg_regions = self.current_view.get_regions('argSpan')
         if len(arg_regions):
             argSpan = self.current_view.get_regions('argSpan')[0]
             if argSpan.contains(cursor_region):
                 log.debug('Was hidden while in region.  Redisplaying')
-                # Occurs on left/right movement.  Rerun to redisplay popup.
+                # Occurs on cursor movement.  Rerun to redisplay popup.
                 self.display()
         else:
             # Cleanup
@@ -202,7 +235,8 @@ def get_current_signature_parts(self):
             param = item["parameters"][self.current_parameter]
             activeParam = '<span class="param">{0}:</span> <i>{1}</i>'.format(
                 param["name"],
-                param["documentation"][0]["text"] if param["documentation"] else "")
+                param["documentation"][0]["text"]
+                    if param["documentation"] else "")
         else:
             activeParam = ''