KeyboardTester Class Reference

Inheritance diagram for KeyboardTester:

Instance Methods
(nonnull instancetype)	- init
(void)	- respondEmbedderCallsWith:
(void)	- recordEmbedderCallsTo:
(void)	- recordEmbedderEventsTo:returning:
(void)	- respondChannelCallsWith:
(void)	- recordChannelCallsTo:
(void)	- respondTextInputWith:
(void)	- recordCallTypesTo:forTypes:
(id)	- lastKeyboardChannelResult
(void)	- sendKeyboardChannelMessage:
(void)	- handleEmbedderEvent:callback:userData:
(void)	- handleChannelMessage:message:binaryReply:
(BOOL)	- handleTextInputKeyEvent:
(void)	- setLayout: [implementation]
(void)	- handleKeyboardChannelMessage:message: [implementation]
(void)	- onSetKeyboardLayoutNotifier: [implementation]
(LayoutClue)	- lookUpLayoutForKeyCode:shift: [implementation]
(void)	- setKeyboardChannelHandler:handler: [implementation]

Properties
FlutterKeyboardManager *	manager
NSResponder *	nextResponder

Detailed Description

Definition at line 180 of file FlutterKeyboardManagerTest.mm.

Method Documentation

handleChannelMessage:message:binaryReply:

- (void) handleChannelMessage:		(NSString*)	channel
message:		(NSData* _Nullable)	message
binaryReply:		(FlutterBinaryReply _Nullable)	callback

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                            :(NSString*)channel
                     message:(NSData* _Nullable)message
                 binaryReply:(FlutterBinaryReply _Nullable)callback {
  if (_typeStorage != nil && (_typeStorageMask & kChannelCall) != 0) {
    [_typeStorage addObject:@(kChannelCall)];
  }
  _channelHandler(^(BOOL handled) {
    NSDictionary* result = @{
      @"handled" : @(handled),
    };
    NSData* encodedKeyEvent = [[FlutterJSONMessageCodec sharedInstance] encode:result];
    callback(encodedKeyEvent);
  });
}

handleEmbedderEvent:callback:userData:

- (void) handleEmbedderEvent:		(const FlutterKeyEvent&)	event
callback:		(nullable FlutterKeyEventCallback)	callback
userData:		(nullable void*)	userData

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                           :(const FlutterKeyEvent&)event
                   callback:(nullable FlutterKeyEventCallback)callback
                   userData:(nullable void*)userData {
  if (_typeStorage != nil && (_typeStorageMask & kEmbedderCall) != 0) {
    [_typeStorage addObject:@(kEmbedderCall)];
  }
  if (callback != nullptr) {
    _embedderHandler(&event, ^(BOOL handled) {
      callback(handled, userData);
    });
  }
}

handleKeyboardChannelMessage:message:

- (void) handleKeyboardChannelMessage: (NSString*)  channel message: (NSData* _Nullable)  message

implementation

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                    :(NSString*)channel message:(NSData* _Nullable)message {
  _keyboardHandler(message, ^(id result) {
    _keyboardChannelResult = result;
  });
}

handleTextInputKeyEvent:

- (BOOL) handleTextInputKeyEvent:

(NSEvent*)

event

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                               :(NSEvent*)event {
  if (_typeStorage != nil && (_typeStorageMask & kTextCall) != 0) {
    [_typeStorage addObject:@(kTextCall)];
  }
  return _textCallback(event);
}

init

- (nonnull instancetype) init

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                             {
  self = [super init];
  if (self == nil) {
    return nil;
  }
 
  _nextResponder = OCMClassMock([NSResponder class]);
  [self respondChannelCallsWith:FALSE];
  [self respondEmbedderCallsWith:FALSE];
  [self respondTextInputWith:FALSE];
 
  _currentLayout = &kUsLayout;
 
  _messengerMock = OCMStrictProtocolMock(@protocol(FlutterBinaryMessenger));
  OCMStub([_messengerMock sendOnChannel:@"flutter/keyevent"
                                message:[OCMArg any]
                            binaryReply:[OCMArg any]])
      .andCall(self, @selector(handleChannelMessage:message:binaryReply:));
  OCMStub([_messengerMock setMessageHandlerOnChannel:@"flutter/keyboard"
                                binaryMessageHandler:[OCMArg any]])
      .andCall(self, @selector(setKeyboardChannelHandler:handler:));
  OCMStub([_messengerMock sendOnChannel:@"flutter/keyboard" message:[OCMArg any]])
      .andCall(self, @selector(handleKeyboardChannelMessage:message:));
  id viewDelegateMock = OCMStrictProtocolMock(@protocol(FlutterKeyboardViewDelegate));
  OCMStub([viewDelegateMock nextResponder]).andReturn(_nextResponder);
  OCMStub([viewDelegateMock onTextInputKeyEvent:[OCMArg any]])
      .andCall(self, @selector(handleTextInputKeyEvent:));
  OCMStub([viewDelegateMock getBinaryMessenger]).andReturn(_messengerMock);
  OCMStub([viewDelegateMock sendKeyEvent:*(const FlutterKeyEvent*)[OCMArg anyPointer]
                                callback:nil
                                userData:nil])
      .ignoringNonObjectArgs()
      .andCall(self, @selector(handleEmbedderEvent:callback:userData:));
  OCMStub([viewDelegateMock subscribeToKeyboardLayoutChange:[OCMArg any]])
      .andCall(self, @selector(onSetKeyboardLayoutNotifier:));
  OCMStub([viewDelegateMock lookUpLayoutForKeyCode:0 shift:false])
      .ignoringNonObjectArgs()
      .andCall(self, @selector(lookUpLayoutForKeyCode:shift:));
 
  _manager = [[FlutterKeyboardManager alloc] initWithViewDelegate:viewDelegateMock];
  return self;
}

lastKeyboardChannelResult

- (id) lastKeyboardChannelResult

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                {
  return _keyboardChannelResult;
}

lookUpLayoutForKeyCode:shift:

- (LayoutClue) lookUpLayoutForKeyCode: (uint16_t)  keyCode shift: (BOOL)  shift

implementation

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                    :(uint16_t)keyCode shift:(BOOL)shift {
  uint32_t cluePair = (*_currentLayout)[(keyCode * 2) + (shift ? 1 : 0)];
  const uint32_t kCharMask = 0xffff;
  const uint32_t kDeadKeyMask = 0x10000;
  return LayoutClue{cluePair & kCharMask, (cluePair & kDeadKeyMask) != 0};
}

onSetKeyboardLayoutNotifier:

- (void) onSetKeyboardLayoutNotifier: (nullable flutter::KeyboardLayoutNotifier)  callback

implementation

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                   :(nullable flutter::KeyboardLayoutNotifier)callback {
  _keyboardLayoutNotifier = callback;
}

recordCallTypesTo:forTypes:

- (void) recordCallTypesTo:		(nonnull NSMutableArray<NSNumber*>*)	typeStorage
forTypes:		(uint32_t)	typeMask

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                         :(nonnull NSMutableArray<NSNumber*>*)typeStorage
                 forTypes:(uint32_t)typeMask {
  _typeStorage = typeStorage;
  _typeStorageMask = typeMask;
}

recordChannelCallsTo:

- (void) recordChannelCallsTo:

(nonnull NSMutableArray<FlutterAsyncKeyCallback>*)

storage

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                            :(nonnull NSMutableArray<FlutterAsyncKeyCallback>*)storage {
  _channelHandler = ^(FlutterAsyncKeyCallback callback) {
    [storage addObject:callback];
  };
}

recordEmbedderCallsTo:

- (void) recordEmbedderCallsTo:

(nonnull NSMutableArray<FlutterAsyncKeyCallback>*)

storage

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                             :(nonnull NSMutableArray<FlutterAsyncKeyCallback>*)storage {
  _embedderHandler = ^(const FlutterKeyEvent* event, FlutterAsyncKeyCallback callback) {
    [storage addObject:callback];
  };
}

recordEmbedderEventsTo:returning:

- (void) recordEmbedderEventsTo:		(nonnull std::vector<FlutterKeyEvent>*)	storage
returning:		(bool)	handled

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                              :(nonnull std::vector<FlutterKeyEvent>*)storage
                     returning:(bool)handled {
  _embedderHandler = ^(const FlutterKeyEvent* event, FlutterAsyncKeyCallback callback) {
    FlutterKeyEvent newEvent = *event;
    if (event->character != nullptr) {
      size_t charLen = strlen(event->character);
      char* newCharacter = new char[charLen + 1];
      strlcpy(newCharacter, event->character, charLen + 1);
      newEvent.character = newCharacter;
    }
    storage->push_back(newEvent);
    callback(handled);
  };
}

respondChannelCallsWith:

- (void) respondChannelCallsWith:

(BOOL)

response

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                               :(BOOL)response {
  _channelHandler = ^(FlutterAsyncKeyCallback callback) {
    callback(response);
  };
}

respondEmbedderCallsWith:

- (void) respondEmbedderCallsWith:

(BOOL)

response

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                :(BOOL)response {
  _embedderHandler = ^(const FlutterKeyEvent* event, FlutterAsyncKeyCallback callback) {
    callback(response);
  };
}

respondTextInputWith:

- (void) respondTextInputWith:

(BOOL)

response

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                            :(BOOL)response {
  _textCallback = ^(NSEvent* event) {
    return response;
  };
}

sendKeyboardChannelMessage:

- (void) sendKeyboardChannelMessage:

(NSData* _Nullable)

message

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                  :(NSData* _Nullable)message {
  [_messengerMock sendOnChannel:@"flutter/keyboard" message:message];
}

setKeyboardChannelHandler:handler:

- (void) setKeyboardChannelHandler: (NSString*)  channel handler: (FlutterBinaryMessageHandler)  handler

implementation

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                                 :(NSString*)channel handler:(FlutterBinaryMessageHandler)handler {
  _keyboardHandler = handler;
}

setLayout:

- (void) setLayout: (const MockLayoutData&)  layout

implementation

Definition at line 248 of file FlutterKeyboardManagerTest.mm.

                 :(const MockLayoutData&)layout {
  _currentLayout = &layout;
  if (_keyboardLayoutNotifier != nil) {
    _keyboardLayoutNotifier();
  }
}

Property Documentation

manager

- (FlutterKeyboardManager*) manager

readnonatomicstrong

Definition at line 219 of file FlutterKeyboardManagerTest.mm.

nextResponder

- (NSResponder*) nextResponder

readwritenonatomicstrong

Definition at line 220 of file FlutterKeyboardManagerTest.mm.

---

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

• shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerTest.mm