Merge pull request slackhq#284 from slackhq/asynch-auto-completion

Allows asynch auto-completion. Closes slackhq#278

Author: bradya

Examples/Messenger-Shared/MessageViewController.m

@@ -452,11 +452,9 @@ - (BOOL)canShowTypingIndicator
 #endif
 }
 
-- (BOOL)canShowAutoCompletion
+- (void)didChangeAutoCompletionPrefix:(NSString *)prefix andWord:(NSString *)word
 {
     NSArray *array = nil;
-    NSString *prefix = self.foundPrefix;
-    NSString *word = self.foundWord;
 
     self.searchResult = nil;
 
@@ -481,7 +479,9 @@ - (BOOL)canShowAutoCompletion
 
     self.searchResult = [[NSMutableArray alloc] initWithArray:array];
 
-    return self.searchResult.count > 0;
+    BOOL show = (self.searchResult.count > 0);
+    
+    [self showAutoCompletionView:show];
 }
 
 - (CGFloat)heightForAutoCompletionView

Source/Classes/SLKTextViewController.h

@@ -372,6 +372,9 @@ NS_CLASS_AVAILABLE_IOS(7_0) @interface SLKTextViewController : UIViewController
 /** The table view used to display autocompletion results. */
 @property (nonatomic, readonly) UITableView *autoCompletionView;
 
+/** YES if the autocompletion mode is active. */
+@property (nonatomic, readonly, getter = isAutoCompleting) BOOL autoCompleting;
+
 /** The recently found prefix symbol used as prefix for autocompletion mode. */
 @property (nonatomic, readonly, copy) NSString *foundPrefix;
 
@@ -381,27 +384,44 @@ NS_CLASS_AVAILABLE_IOS(7_0) @interface SLKTextViewController : UIViewController
 /** The recently found word at the text view's caret position. */
 @property (nonatomic, readonly, copy) NSString *foundWord;
 
-/** YES if the autocompletion mode is active. */
-@property (nonatomic, readonly, getter = isAutoCompleting) BOOL autoCompleting;
-
 /** An array containing all the registered prefix strings for autocompletion. */
 @property (nonatomic, readonly, copy) NSArray *registeredPrefixes;
 
 /**
  Registers any string prefix for autocompletion detection, useful for user mentions and/or hashtags autocompletion.
  The prefix must be valid NSString (i.e: '@', '#', '\', and so on). This also checks if no repeated prefix is inserted.
+ You can also use longer prefixes.
  
  @param prefixes An array of prefix strings.
  */
 - (void)registerPrefixesForAutoCompletion:(NSArray *)prefixes;
 
+/**
+ Notifies the view controller either the autocompletion prefix or word have changed.
+ Use this method to modify your data source or fetch data asynchronously from an HTTP resource.
+ Once your data source is ready, make sure to call -showAutoCompletionView: to display the view accordingly.
+ You don't need call super since this method doesn't do anything.
+
+ @param prefix The detected prefix.
+ @param word The derected word.
+ */
+- (void)didChangeAutoCompletionPrefix:(NSString *)prefix andWord:(NSString *)word;
+
+/**
+ Use this method to programatically show/hide the autocompletion view.
+ Right before the view is shown, -reloadData is called. So avoid calling it manually.
+ 
+ @param show YES if the autocompletion view should be shown.
+ */
+- (void)showAutoCompletionView:(BOOL)show;
+
 /**
  Verifies that the autocompletion view should be shown. Default is NO.
  To enabled autocompletion, you MUST override this method to perform additional tasks, before the autocompletion view is shown (i.e. populating the data source).
  
  @return YES if the autocompletion view should be shown.
  */
-- (BOOL)canShowAutoCompletion;
+- (BOOL)canShowAutoCompletion DEPRECATED_MSG_ATTRIBUTE("Override -didChangeAutoCompletionPrefix:andWord: instead");
 
 /**
  Returns a custom height for the autocompletion view. Default is 0.0.

Source/Classes/SLKTextViewController.m

@@ -718,6 +718,7 @@ - (void)editText:(NSString *)text
     // Brings up the keyboard if needed
     [self presentKeyboard:YES];
 }
+
 - (void)didCommitTextEditing:(id)sender
 {
     if (!self.textInputbar.isEditing) {
@@ -760,11 +761,6 @@ - (BOOL)canShowTypingIndicator
     return YES;
 }
 
-- (BOOL)canShowAutoCompletion
-{
-    return NO;
-}
-
 - (CGFloat)heightForAutoCompletionView
 {
     return 0.0;
@@ -1549,6 +1545,95 @@ - (void)registerPrefixesForAutoCompletion:(NSArray *)prefixes
     _registeredPrefixes = [[NSArray alloc] initWithArray:array];
 }
 
+- (void)didChangeAutoCompletionPrefix:(NSString *)prefix andWord:(NSString *)word
+{
+    // No implementation here. Meant to be overriden in subclass.
+}
+
+- (BOOL)canShowAutoCompletion
+{
+    // Let's keep this around for a bit, for backwards compatibility.
+    return NO;
+}
+
+- (void)showAutoCompletionView:(BOOL)show
+{
+    // Reloads the tableview before showing/hiding
+    if (show) {
+        [self.autoCompletionView reloadData];
+    }
+    
+    self.autoCompleting = show;
+    
+    // Toggles auto-correction if requiered
+    [self slk_enableTypingSuggestionIfNeeded];
+    
+    CGFloat viewHeight = show ? [self heightForAutoCompletionView] : 0.0;
+    
+    if (self.autoCompletionViewHC.constant == viewHeight) {
+        return;
+    }
+    
+    // If the auto-completion view height is bigger than the maximum height allows, it is reduce to that size. Default 140 pts.
+    CGFloat maximumHeight = [self maximumHeightForAutoCompletionView];
+    
+    if (viewHeight > maximumHeight) {
+        viewHeight = maximumHeight;
+    }
+    
+    CGFloat contentViewHeight = self.scrollViewHC.constant + self.autoCompletionViewHC.constant;
+    
+    // On iPhone, the auto-completion view can't extend beyond the content view height
+    if (SLK_IS_IPHONE && viewHeight > contentViewHeight) {
+        viewHeight = contentViewHeight;
+    }
+    
+    self.autoCompletionViewHC.constant = viewHeight;
+    
+    [self.view slk_animateLayoutIfNeededWithBounce:self.bounces
+                                           options:UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionLayoutSubviews|UIViewAnimationOptionBeginFromCurrentState
+                                        animations:NULL];
+}
+
+- (void)acceptAutoCompletionWithString:(NSString *)string
+{
+    [self acceptAutoCompletionWithString:string keepPrefix:YES];
+}
+
+- (void)acceptAutoCompletionWithString:(NSString *)string keepPrefix:(BOOL)keepPrefix
+{
+    if (string.length == 0) {
+        return;
+    }
+    
+    SLKTextView *textView = self.textView;
+    
+    NSUInteger location = self.foundPrefixRange.location;
+    if (keepPrefix) {
+        location += self.foundPrefixRange.length;
+    }
+    
+    NSUInteger length = self.foundWord.length;
+    if (!keepPrefix) {
+        length += self.foundPrefixRange.length;
+    }
+    
+    NSRange range = NSMakeRange(location, length);
+    NSRange insertionRange = [textView slk_insertText:string inRange:range];
+    
+    textView.selectedRange = NSMakeRange(insertionRange.location, 0);
+    
+    [self cancelAutoCompletion];
+    
+    [textView slk_scrollToCaretPositonAnimated:NO];
+}
+
+- (void)cancelAutoCompletion
+{
+    [self slk_invalidateAutoCompletion];
+    [self slk_hideAutoCompletionViewIfNeeded];
+}
+
 - (void)slk_processTextForAutoCompletion
 {
     if (self.isTransitioning) {
@@ -1617,13 +1702,7 @@ - (void)slk_handleProcessedWord:(NSString *)word range:(NSRange)range
         return [self cancelAutoCompletion];
     }
 
-    [self slk_showAutoCompletionView:[self canShowAutoCompletion]];
-}
-
-- (void)cancelAutoCompletion
-{
-    [self slk_invalidateAutoCompletion];
-    [self slk_hideAutoCompletionViewIfNeeded];
+    [self didChangeAutoCompletionPrefix:self.foundPrefix andWord:self.foundWord];
 }
 
 - (void)slk_invalidateAutoCompletion
@@ -1635,81 +1714,11 @@ - (void)slk_invalidateAutoCompletion
     [self.autoCompletionView setContentOffset:CGPointZero];
 }
 
-- (void)acceptAutoCompletionWithString:(NSString *)string
-{
-    [self acceptAutoCompletionWithString:string keepPrefix:YES];
-}
-
-- (void)acceptAutoCompletionWithString:(NSString *)string keepPrefix:(BOOL)keepPrefix
-{
-    if (string.length == 0) {
-        return;
-    }
-    
-    SLKTextView *textView = self.textView;
-    
-    NSUInteger location = self.foundPrefixRange.location;
-    if (keepPrefix) {
-        location += self.foundPrefixRange.length;
-    }
-    
-    NSUInteger length = self.foundWord.length;
-    if (!keepPrefix) {
-        length += self.foundPrefixRange.length;
-    }
-    
-    NSRange range = NSMakeRange(location, length);
-    NSRange insertionRange = [textView slk_insertText:string inRange:range];
-    
-    textView.selectedRange = NSMakeRange(insertionRange.location, 0);
-    
-    [self cancelAutoCompletion];
-    
-    [textView slk_scrollToCaretPositonAnimated:NO];
-}
-
 - (void)slk_hideAutoCompletionViewIfNeeded
 {
     if (self.isAutoCompleting) {
-        [self slk_showAutoCompletionView:NO];
-    }
-}
-
-- (void)slk_showAutoCompletionView:(BOOL)show
-{
-    // Reloads the tableview before showing/hiding
-    [self.autoCompletionView reloadData];
-    
-    self.autoCompleting = show;
-    
-    // Toggles auto-correction if requiered
-    [self slk_enableTypingSuggestionIfNeeded];
-    
-    CGFloat viewHeight = show ? [self heightForAutoCompletionView] : 0.0;
-    
-    if (self.autoCompletionViewHC.constant == viewHeight) {
-        return;
+        [self showAutoCompletionView:NO];
     }
-    
-    // If the auto-completion view height is bigger than the maximum height allows, it is reduce to that size. Default 140 pts.
-    CGFloat maximumHeight = [self maximumHeightForAutoCompletionView];
-    
-    if (viewHeight > maximumHeight) {
-        viewHeight = maximumHeight;
-    }
-    
-    CGFloat contentViewHeight = self.scrollViewHC.constant + self.autoCompletionViewHC.constant;
-    
-    // On iPhone, the auto-completion view can't extend beyond the content view height
-    if (SLK_IS_IPHONE && viewHeight > contentViewHeight) {
-        viewHeight = contentViewHeight;
-    }
-    
-    self.autoCompletionViewHC.constant = viewHeight;
-    
-    [self.view slk_animateLayoutIfNeededWithBounce:self.bounces
-                                           options:UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionLayoutSubviews|UIViewAnimationOptionBeginFromCurrentState
-                                        animations:NULL];
 }