2018-09-13 17:44:08 +03:00
// dear imgui: Platform Binding for OSX / Cocoa
2018-07-04 14:24:16 +03:00
// This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan, Metal..)
2019-05-28 12:22:17 +03:00
// [ALPHA] Early bindings, not well tested. If you want a portable application, prefer using the GLFW or SDL platform bindings on Mac.
2018-06-11 11:19:17 +03:00
2019-05-28 12:22:17 +03:00
// Implemented features:
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
// [X] Platform: OSX clipboard is supported within core Dear ImGui (no specific code in this back-end).
2018-06-11 22:07:14 +03:00
// Issues:
2019-05-28 12:22:17 +03:00
// [ ] Platform: Keys are all generally very broken. Best using [event keycode] and not [event characters]..
2018-06-11 11:19:17 +03:00
#include "imgui.h"
#include "imgui_impl_osx.h"
#import <Cocoa/Cocoa.h>
// CHANGELOG
// (minor and older changes stripped away, please see git history for details)
2019-10-11 15:20:04 +03:00
// 2019-10-11: Inputs: Fix using Backspace key.
// 2019-07-21: Re-added clipboard handlers as they are not enabled by default in core imgui.cpp (reverted 2019-05-18 change).
2019-05-28 12:22:17 +03:00
// 2019-05-28: Inputs: Added mouse cursor shape and visibility support.
2019-05-18 18:44:09 +03:00
// 2019-05-18: Misc: Removed clipboard handlers as they are now supported by core imgui.cpp.
2019-05-11 11:33:56 +03:00
// 2019-05-11: Inputs: Don't filter character values before calling AddInputCharacter() apart from 0xF700..0xFFFF range.
2018-11-30 20:18:15 +03:00
// 2018-11-30: Misc: Setting up io.BackendPlatformName so it can be displayed in the About Window.
2018-07-08 11:47:31 +03:00
// 2018-07-07: Initial version.
2018-06-11 11:19:17 +03:00
// Data
2018-07-30 15:15:24 +03:00
static CFAbsoluteTime g_Time = 0.0;
2019-05-28 12:15:59 +03:00
static NSCursor* g_MouseCursors[ImGuiMouseCursor_COUNT] = { 0 };
static bool g_MouseCursorHidden = false;
// Undocumented methods for creating cursors.
@interface NSCursor()
+ (id)_windowResizeNorthWestSouthEastCursor;
+ (id)_windowResizeNorthEastSouthWestCursor;
+ (id)_windowResizeNorthSouthCursor;
+ (id)_windowResizeEastWestCursor;
@end
2018-06-11 11:19:17 +03:00
// Functions
bool ImGui_ImplOSX_Init()
{
ImGuiIO& io = ImGui::GetIO();
// Setup back-end capabilities flags
2019-10-11 15:20:04 +03:00
io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
2018-06-11 11:19:17 +03:00
//io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
//io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
//io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can set io.MouseHoveredViewport correctly (optional, not easy)
2018-11-30 20:18:15 +03:00
io.BackendPlatformName = "imgui_impl_osx";
2018-06-11 11:19:17 +03:00
2019-10-11 15:20:04 +03:00
// Keyboard mapping. Dear ImGui will use those indices to peek into the io.KeyDown[] array.
2018-06-11 22:07:14 +03:00
const int offset_for_function_keys = 256 - 0xF700;
2019-07-19 03:24:56 +03:00
io.KeyMap[ImGuiKey_Tab] = '\t';
io.KeyMap[ImGuiKey_LeftArrow] = NSLeftArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_RightArrow] = NSRightArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_UpArrow] = NSUpArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_DownArrow] = NSDownArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_PageUp] = NSPageUpFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_PageDown] = NSPageDownFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Home] = NSHomeFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_End] = NSEndFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Insert] = NSInsertFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Delete] = NSDeleteFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Backspace] = 127;
io.KeyMap[ImGuiKey_Space] = 32;
io.KeyMap[ImGuiKey_Enter] = 13;
io.KeyMap[ImGuiKey_Escape] = 27;
2019-07-22 04:39:50 +03:00
io.KeyMap[ImGuiKey_KeyPadEnter] = 13;
2019-07-19 03:24:56 +03:00
io.KeyMap[ImGuiKey_A] = 'A';
io.KeyMap[ImGuiKey_C] = 'C';
io.KeyMap[ImGuiKey_V] = 'V';
io.KeyMap[ImGuiKey_X] = 'X';
io.KeyMap[ImGuiKey_Y] = 'Y';
io.KeyMap[ImGuiKey_Z] = 'Z';
2019-01-20 19:56:17 +03:00
2019-05-28 12:22:17 +03:00
// Load cursors. Some of them are undocumented.
2019-05-28 12:15:59 +03:00
g_MouseCursorHidden = false;
g_MouseCursors[ImGuiMouseCursor_Arrow] = [NSCursor arrowCursor];
g_MouseCursors[ImGuiMouseCursor_TextInput] = [NSCursor IBeamCursor];
g_MouseCursors[ImGuiMouseCursor_ResizeAll] = [NSCursor closedHandCursor];
g_MouseCursors[ImGuiMouseCursor_Hand] = [NSCursor pointingHandCursor];
2019-05-28 12:22:17 +03:00
g_MouseCursors[ImGuiMouseCursor_ResizeNS] = [NSCursor respondsToSelector:@selector(_windowResizeNorthSouthCursor)] ? [NSCursor _windowResizeNorthSouthCursor] : [NSCursor resizeUpDownCursor];
g_MouseCursors[ImGuiMouseCursor_ResizeEW] = [NSCursor respondsToSelector:@selector(_windowResizeEastWestCursor)] ? [NSCursor _windowResizeEastWestCursor] : [NSCursor resizeLeftRightCursor];
g_MouseCursors[ImGuiMouseCursor_ResizeNESW] = [NSCursor respondsToSelector:@selector(_windowResizeNorthEastSouthWestCursor)] ? [NSCursor _windowResizeNorthEastSouthWestCursor] : [NSCursor closedHandCursor];
g_MouseCursors[ImGuiMouseCursor_ResizeNWSE] = [NSCursor respondsToSelector:@selector(_windowResizeNorthWestSouthEastCursor)] ? [NSCursor _windowResizeNorthWestSouthEastCursor] : [NSCursor closedHandCursor];
2019-05-28 12:15:59 +03:00
2019-07-22 05:06:07 +03:00
// Note that imgui.cpp also include default OSX clipboard handlers which can be enabled
// by adding '#define IMGUI_ENABLE_OSX_DEFAULT_CLIPBOARD_FUNCTIONS' in imconfig.h and adding '-framework ApplicationServices' to your linker command-line.
// Since we are already in ObjC land here, it is easy for us to add a clipboard handler using the NSPasteboard api.
io.SetClipboardTextFn = [](void*, const char* str) -> void
{
NSPasteboard* pasteboard = [NSPasteboard generalPasteboard];
[pasteboard declareTypes:[NSArray arrayWithObject:NSPasteboardTypeString] owner:nil];
[pasteboard setString:[NSString stringWithUTF8String:str] forType:NSPasteboardTypeString];
};
io.GetClipboardTextFn = [](void*) -> const char*
{
NSPasteboard* pasteboard = [NSPasteboard generalPasteboard];
NSString* available = [pasteboard availableTypeFromArray: [NSArray arrayWithObject:NSPasteboardTypeString]];
if (![available isEqualToString:NSPasteboardTypeString])
return NULL;
NSString* string = [pasteboard stringForType:NSPasteboardTypeString];
if (string == nil)
return NULL;
const char* string_c = (const char*)[string UTF8String];
size_t string_len = strlen(string_c);
static ImVector<char> s_clipboard;
s_clipboard.resize((int)string_len + 1);
strcpy(s_clipboard.Data, string_c);
return s_clipboard.Data;
};
2019-05-18 18:44:09 +03:00
2018-06-11 11:19:17 +03:00
return true;
}
void ImGui_ImplOSX_Shutdown()
{
}
2019-05-28 12:15:59 +03:00
static void ImGui_ImplOSX_UpdateMouseCursor()
{
ImGuiIO& io = ImGui::GetIO();
if (io.ConfigFlags & ImGuiConfigFlags_NoMouseCursorChange)
return;
ImGuiMouseCursor imgui_cursor = ImGui::GetMouseCursor();
if (io.MouseDrawCursor || imgui_cursor == ImGuiMouseCursor_None)
{
// Hide OS mouse cursor if imgui is drawing it or if it wants no cursor
if (!g_MouseCursorHidden)
{
g_MouseCursorHidden = true;
[NSCursor hide];
}
}
else
{
// Show OS mouse cursor
2019-05-28 12:22:17 +03:00
[g_MouseCursors[g_MouseCursors[imgui_cursor] ? imgui_cursor : ImGuiMouseCursor_Arrow] set];
2019-05-28 12:15:59 +03:00
if (g_MouseCursorHidden)
{
g_MouseCursorHidden = false;
[NSCursor unhide];
}
}
}
2018-07-04 14:24:16 +03:00
void ImGui_ImplOSX_NewFrame(NSView* view)
2018-06-11 11:19:17 +03:00
{
// Setup display size
2018-06-11 22:07:14 +03:00
ImGuiIO& io = ImGui::GetIO();
2019-10-01 07:16:30 +03:00
if (view)
{
const float dpi = [view.window backingScaleFactor];
io.DisplaySize = ImVec2((float)view.bounds.size.width, (float)view.bounds.size.height);
io.DisplayFramebufferScale = ImVec2(dpi, dpi);
}
2018-06-11 11:19:17 +03:00
// Setup time step
2018-07-30 15:15:24 +03:00
if (g_Time == 0.0)
g_Time = CFAbsoluteTimeGetCurrent();
CFAbsoluteTime current_time = CFAbsoluteTimeGetCurrent();
io.DeltaTime = current_time - g_Time;
2018-06-11 11:19:17 +03:00
g_Time = current_time;
2019-05-28 12:15:59 +03:00
ImGui_ImplOSX_UpdateMouseCursor();
2018-06-11 11:19:17 +03:00
}
2018-06-11 22:07:14 +03:00
static int mapCharacterToKey(int c)
2018-06-11 11:19:17 +03:00
{
2018-06-11 22:07:14 +03:00
if (c >= 'a' && c <= 'z')
return c - 'a' + 'A';
if (c == 25) // SHIFT+TAB -> TAB
return 9;
if (c >= 0 && c < 256)
return c;
if (c >= 0xF700 && c < 0xF700 + 256)
return c - 0xF700 + 256;
return -1;
2018-06-11 11:19:17 +03:00
}
2018-06-11 22:07:14 +03:00
static void resetKeys()
2018-06-11 11:19:17 +03:00
{
ImGuiIO& io = ImGui::GetIO();
2018-06-15 23:49:03 +03:00
for (int n = 0; n < IM_ARRAYSIZE(io.KeysDown); n++)
io.KeysDown[n] = false;
2018-06-11 11:19:17 +03:00
}
2018-07-04 14:24:16 +03:00
bool ImGui_ImplOSX_HandleEvent(NSEvent* event, NSView* view)
2018-06-11 11:19:17 +03:00
{
ImGuiIO& io = ImGui::GetIO();
2018-07-04 14:24:16 +03:00
if (event.type == NSEventTypeLeftMouseDown || event.type == NSEventTypeRightMouseDown || event.type == NSEventTypeOtherMouseDown)
2018-06-11 11:19:17 +03:00
{
int button = (int)[event buttonNumber];
if (button >= 0 && button < IM_ARRAYSIZE(io.MouseDown))
io.MouseDown[button] = true;
return io.WantCaptureMouse;
}
2018-07-04 14:24:16 +03:00
if (event.type == NSEventTypeLeftMouseUp || event.type == NSEventTypeRightMouseUp || event.type == NSEventTypeOtherMouseUp)
2018-06-11 11:19:17 +03:00
{
int button = (int)[event buttonNumber];
if (button >= 0 && button < IM_ARRAYSIZE(io.MouseDown))
io.MouseDown[button] = false;
return io.WantCaptureMouse;
}
2018-07-04 14:24:16 +03:00
if (event.type == NSEventTypeMouseMoved || event.type == NSEventTypeLeftMouseDragged)
{
NSPoint mousePoint = event.locationInWindow;
mousePoint = [view convertPoint:mousePoint fromView:nil];
mousePoint = NSMakePoint(mousePoint.x, view.bounds.size.height - mousePoint.y);
io.MousePos = ImVec2(mousePoint.x, mousePoint.y);
}
2018-06-11 11:19:17 +03:00
if (event.type == NSEventTypeScrollWheel)
{
double wheel_dx = 0.0;
double wheel_dy = 0.0;
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1070
if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6)
{
wheel_dx = [event scrollingDeltaX];
wheel_dy = [event scrollingDeltaY];
if ([event hasPreciseScrollingDeltas])
{
wheel_dx *= 0.1;
wheel_dy *= 0.1;
}
}
else
2019-10-11 15:20:04 +03:00
#endif // MAC_OS_X_VERSION_MAX_ALLOWED
2018-06-11 11:19:17 +03:00
{
wheel_dx = [event deltaX];
wheel_dy = [event deltaY];
}
if (fabs(wheel_dx) > 0.0)
io.MouseWheelH += wheel_dx * 0.1f;
if (fabs(wheel_dy) > 0.0)
io.MouseWheel += wheel_dy * 0.1f;
return io.WantCaptureMouse;
}
2018-06-15 23:49:03 +03:00
// FIXME: All the key handling is wrong and broken. Refer to GLFW's cocoa_init.mm and cocoa_window.mm.
2018-06-11 11:19:17 +03:00
if (event.type == NSEventTypeKeyDown)
{
NSString* str = [event characters];
int len = (int)[str length];
for (int i = 0; i < len; i++)
{
2018-06-11 22:07:14 +03:00
int c = [str characterAtIndex:i];
2019-10-11 15:20:04 +03:00
if (!io.KeyCtrl && !(c >= 0xF700 && c <= 0xFFFF) && c != 127)
2019-05-11 11:33:56 +03:00
io.AddInputCharacter((unsigned int)c);
2018-06-11 22:07:14 +03:00
// We must reset in case we're pressing a sequence of special keys while keeping the command pressed
int key = mapCharacterToKey(c);
if (key != -1 && key < 256 && !io.KeyCtrl)
resetKeys();
if (key != -1)
io.KeysDown[key] = true;
2018-06-11 11:19:17 +03:00
}
return io.WantCaptureKeyboard;
}
if (event.type == NSEventTypeKeyUp)
{
NSString* str = [event characters];
int len = (int)[str length];
for (int i = 0; i < len; i++)
{
2018-06-11 22:07:14 +03:00
int c = [str characterAtIndex:i];
int key = mapCharacterToKey(c);
if (key != -1)
io.KeysDown[key] = false;
2018-06-11 11:19:17 +03:00
}
return io.WantCaptureKeyboard;
}
if (event.type == NSEventTypeFlagsChanged)
{
ImGuiIO& io = ImGui::GetIO();
2018-06-11 22:07:14 +03:00
unsigned int flags = [event modifierFlags] & NSEventModifierFlagDeviceIndependentFlagsMask;
bool oldKeyCtrl = io.KeyCtrl;
bool oldKeyShift = io.KeyShift;
bool oldKeyAlt = io.KeyAlt;
bool oldKeySuper = io.KeySuper;
io.KeyCtrl = flags & NSEventModifierFlagControl;
io.KeyShift = flags & NSEventModifierFlagShift;
io.KeyAlt = flags & NSEventModifierFlagOption;
io.KeySuper = flags & NSEventModifierFlagCommand;
2018-06-11 11:19:17 +03:00
2018-06-15 23:49:03 +03:00
// We must reset them as we will not receive any keyUp event if they where pressed with a modifier
if ((oldKeyShift && !io.KeyShift) || (oldKeyCtrl && !io.KeyCtrl) || (oldKeyAlt && !io.KeyAlt) || (oldKeySuper && !io.KeySuper))
2018-06-11 22:07:14 +03:00
resetKeys();
2018-06-11 11:19:17 +03:00
return io.WantCaptureKeyboard;
}
2019-01-20 19:56:17 +03:00
2018-06-11 11:19:17 +03:00
return false;
}