FlutterTokenizer Class Reference

#include <FlutterTextInputPlugin.h>

Inheritance diagram for FlutterTokenizer:

Instance Methods
(instancetype)	- initWithTextInput: [implementation]
(UITextRange *)	- rangeEnclosingPosition:withGranularity:inDirection: [implementation]
(UITextRange *)	- lineEnclosingPosition:inDirection: [implementation]

Properties
FlutterTextInputView *	textInputView [implementation]

Detailed Description

A tokenizer used by FlutterTextInputView to customize string parsing.

Definition at line 90 of file FlutterTextInputPlugin.h.

Method Documentation

initWithTextInput:

- (instancetype) initWithTextInput: (UIResponder<UITextInput>*)  textInput

implementation

Definition at line 581 of file FlutterTextInputPlugin.mm.

                                 :(UIResponder<UITextInput>*)textInput {
  NSAssert([textInput isKindOfClass:[FlutterTextInputView class]],
           @"The FlutterTokenizer can only be used in a FlutterTextInputView");
  self = [super initWithTextInput:textInput];
  if (self) {
    _textInputView = (FlutterTextInputView*)textInput;
  }
  return self;
}

lineEnclosingPosition:inDirection:

- (UITextRange *) lineEnclosingPosition: (UITextPosition*)  position inDirection: (UITextDirection)  direction

implementation

Definition at line 581 of file FlutterTextInputPlugin.mm.

                                     :(UITextPosition*)position
                          inDirection:(UITextDirection)direction {
  // TODO(hellohuanlin): remove iOS 17 check. The same logic should apply to older iOS version.
  if (@available(iOS 17.0, *)) {
    // According to the API doc if the text position is at a text-unit boundary, it is considered
    // enclosed only if the next position in the given direction is entirely enclosed. Link:
    // https://developer.apple.com/documentation/uikit/uitextinputtokenizer/1614464-rangeenclosingposition?language=objc
    FlutterTextPosition* flutterPosition = (FlutterTextPosition*)position;
    if (flutterPosition.index > _textInputView.text.length ||
        (flutterPosition.index == _textInputView.text.length &&
         direction == UITextStorageDirectionForward)) {
      return nil;
    }
  }
 
  // Gets the first line break position after the input position.
  NSString* textAfter = [_textInputView
      textInRange:[_textInputView textRangeFromPosition:position
                                             toPosition:[_textInputView endOfDocument]]];
  NSArray<NSString*>* linesAfter = [textAfter componentsSeparatedByString:@"\n"];
  NSInteger offSetToLineBreak = [linesAfter firstObject].length;
  UITextPosition* lineBreakAfter = [_textInputView positionFromPosition:position
                                                                 offset:offSetToLineBreak];
  // Gets the first line break position before the input position.
  NSString* textBefore = [_textInputView
      textInRange:[_textInputView textRangeFromPosition:[_textInputView beginningOfDocument]
                                             toPosition:position]];
  NSArray<NSString*>* linesBefore = [textBefore componentsSeparatedByString:@"\n"];
  NSInteger offSetFromLineBreak = [linesBefore lastObject].length;
  UITextPosition* lineBreakBefore = [_textInputView positionFromPosition:position
                                                                  offset:-offSetFromLineBreak];
 
  return [_textInputView textRangeFromPosition:lineBreakBefore toPosition:lineBreakAfter];
}

rangeEnclosingPosition:withGranularity:inDirection:

- (UITextRange *) rangeEnclosingPosition: (UITextPosition*)  position withGranularity: (UITextGranularity)  granularity inDirection: (UITextDirection)  direction

implementation

Definition at line 581 of file FlutterTextInputPlugin.mm.

                                      :(UITextPosition*)position
                       withGranularity:(UITextGranularity)granularity
                           inDirection:(UITextDirection)direction {
  UITextRange* result;
  switch (granularity) {
    case UITextGranularityLine:
      // The default UITextInputStringTokenizer does not handle line granularity
      // correctly. We need to implement our own line tokenizer.
      result = [self lineEnclosingPosition:position inDirection:direction];
      break;
    case UITextGranularityCharacter:
    case UITextGranularityWord:
    case UITextGranularitySentence:
    case UITextGranularityParagraph:
    case UITextGranularityDocument:
      // The UITextInputStringTokenizer can handle all these cases correctly.
      result = [super rangeEnclosingPosition:position
                             withGranularity:granularity
                                 inDirection:direction];
      break;
  }
  return result;
}

Property Documentation

textInputView

- (FlutterTextInputView*) textInputView

readwritenonatomicweakimplementation

Provided by category FlutterTokenizer().

Definition at line 581 of file FlutterTextInputPlugin.mm.

---

The documentation for this class was generated from the following files:

• shell/platform/darwin/ios/framework/Source/FlutterTextInputPlugin.h
• shell/platform/darwin/ios/framework/Source/FlutterTextInputPlugin.mm