/* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see .
*/
/******************************************************************************
* Cocoa video driver *
* Known things left to do: *
* Nothing at the moment. *
******************************************************************************/
#ifdef WITH_COCOA
#include "../../stdafx.h"
#define Rect OTTDRect
#define Point OTTDPoint
#import
#undef Rect
#undef Point
#include "../../openttd.h"
#include "../../debug.h"
#include "../../os/macosx/splash.h"
#include "../../settings_type.h"
#include "../../core/geometry_type.hpp"
#include "cocoa_v.h"
#include "cocoa_keys.h"
#include "../../blitter/factory.hpp"
#include "../../gfx_func.h"
#include "../../network/network.h"
#include "../../core/random_func.hpp"
#include "../../core/math_func.hpp"
#include "../../texteff.hpp"
#include "../../window_func.h"
#import /* gettimeofday */
/**
* Important notice regarding all modifications!!!!!!!
* There are certain limitations because the file is objective C++.
* gdb has limitations.
* C++ and objective C code can't be joined in all cases (classes stuff).
* Read http://developer.apple.com/releasenotes/Cocoa/Objective-C++.html for more information.
*/
/* Right Mouse Button Emulation enum */
enum RightMouseButtonEmulationState {
RMBE_COMMAND,
RMBE_CONTROL,
RMBE_OFF,
};
static unsigned int _current_mods;
static bool _tab_is_down;
static bool _emulating_right_button;
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
static float _current_magnification;
#endif
#ifdef _DEBUG
static uint32 _tEvent;
#endif
/* Support for touch gestures is only available starting with the
* 10.6 SDK, even if it says that support starts in fact with 10.5.2.
* Replicate the needed stuff for older SDKs. */
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 && MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6)
static const NSUInteger NSEventTypeMagnify = 30;
static const NSUInteger NSEventTypeEndGesture = 20;
@interface NSEvent ()
/* This message is valid for events of type NSEventTypeMagnify, on 10.5.2 or later */
- (CGFloat)magnification WEAK_IMPORT_ATTRIBUTE;
@end
#endif
static uint32 GetTick()
{
struct timeval tim;
gettimeofday(&tim, NULL);
return tim.tv_usec / 1000 + tim.tv_sec * 1000;
}
static void QZ_WarpCursor(int x, int y)
{
assert(_cocoa_subdriver != NULL);
/* Only allow warping when in foreground */
if (![ NSApp isActive ]) return;
NSPoint p = NSMakePoint(x, y);
CGPoint cgp = _cocoa_subdriver->PrivateLocalToCG(&p);
/* Do the actual warp */
CGWarpMouseCursorPosition(cgp);
/* this is the magic call that fixes cursor "freezing" after warp */
CGAssociateMouseAndMouseCursorPosition(true);
}
static void QZ_CheckPaletteAnim()
{
if (_cur_palette.count_dirty != 0) {
Blitter *blitter = BlitterFactory::GetCurrentBlitter();
switch (blitter->UsePaletteAnimation()) {
case Blitter::PALETTE_ANIMATION_VIDEO_BACKEND:
_cocoa_subdriver->UpdatePalette(_cur_palette.first_dirty, _cur_palette.count_dirty);
break;
case Blitter::PALETTE_ANIMATION_BLITTER:
blitter->PaletteAnimate(_cur_palette);
break;
case Blitter::PALETTE_ANIMATION_NONE:
break;
default:
NOT_REACHED();
}
_cur_palette.count_dirty = 0;
}
}
struct VkMapping {
unsigned short vk_from;
byte map_to;
};
#define AS(x, z) {x, z}
static const VkMapping _vk_mapping[] = {
AS(QZ_BACKQUOTE, WKC_BACKQUOTE), // key left of '1'
AS(QZ_BACKQUOTE2, WKC_BACKQUOTE), // some keyboards have it on another scancode
/* Pageup stuff + up/down */
AS(QZ_PAGEUP, WKC_PAGEUP),
AS(QZ_PAGEDOWN, WKC_PAGEDOWN),
AS(QZ_UP, WKC_UP),
AS(QZ_DOWN, WKC_DOWN),
AS(QZ_LEFT, WKC_LEFT),
AS(QZ_RIGHT, WKC_RIGHT),
AS(QZ_HOME, WKC_HOME),
AS(QZ_END, WKC_END),
AS(QZ_INSERT, WKC_INSERT),
AS(QZ_DELETE, WKC_DELETE),
/* Letters. QZ_[a-z] is not in numerical order so we can't use AM(...) */
AS(QZ_a, 'A'),
AS(QZ_b, 'B'),
AS(QZ_c, 'C'),
AS(QZ_d, 'D'),
AS(QZ_e, 'E'),
AS(QZ_f, 'F'),
AS(QZ_g, 'G'),
AS(QZ_h, 'H'),
AS(QZ_i, 'I'),
AS(QZ_j, 'J'),
AS(QZ_k, 'K'),
AS(QZ_l, 'L'),
AS(QZ_m, 'M'),
AS(QZ_n, 'N'),
AS(QZ_o, 'O'),
AS(QZ_p, 'P'),
AS(QZ_q, 'Q'),
AS(QZ_r, 'R'),
AS(QZ_s, 'S'),
AS(QZ_t, 'T'),
AS(QZ_u, 'U'),
AS(QZ_v, 'V'),
AS(QZ_w, 'W'),
AS(QZ_x, 'X'),
AS(QZ_y, 'Y'),
AS(QZ_z, 'Z'),
/* Same thing for digits */
AS(QZ_0, '0'),
AS(QZ_1, '1'),
AS(QZ_2, '2'),
AS(QZ_3, '3'),
AS(QZ_4, '4'),
AS(QZ_5, '5'),
AS(QZ_6, '6'),
AS(QZ_7, '7'),
AS(QZ_8, '8'),
AS(QZ_9, '9'),
AS(QZ_ESCAPE, WKC_ESC),
AS(QZ_PAUSE, WKC_PAUSE),
AS(QZ_BACKSPACE, WKC_BACKSPACE),
AS(QZ_SPACE, WKC_SPACE),
AS(QZ_RETURN, WKC_RETURN),
AS(QZ_TAB, WKC_TAB),
/* Function keys */
AS(QZ_F1, WKC_F1),
AS(QZ_F2, WKC_F2),
AS(QZ_F3, WKC_F3),
AS(QZ_F4, WKC_F4),
AS(QZ_F5, WKC_F5),
AS(QZ_F6, WKC_F6),
AS(QZ_F7, WKC_F7),
AS(QZ_F8, WKC_F8),
AS(QZ_F9, WKC_F9),
AS(QZ_F10, WKC_F10),
AS(QZ_F11, WKC_F11),
AS(QZ_F12, WKC_F12),
/* Numeric part */
AS(QZ_KP0, '0'),
AS(QZ_KP1, '1'),
AS(QZ_KP2, '2'),
AS(QZ_KP3, '3'),
AS(QZ_KP4, '4'),
AS(QZ_KP5, '5'),
AS(QZ_KP6, '6'),
AS(QZ_KP7, '7'),
AS(QZ_KP8, '8'),
AS(QZ_KP9, '9'),
AS(QZ_KP_DIVIDE, WKC_NUM_DIV),
AS(QZ_KP_MULTIPLY, WKC_NUM_MUL),
AS(QZ_KP_MINUS, WKC_NUM_MINUS),
AS(QZ_KP_PLUS, WKC_NUM_PLUS),
AS(QZ_KP_ENTER, WKC_NUM_ENTER),
AS(QZ_KP_PERIOD, WKC_NUM_DECIMAL),
/* Other non-letter keys */
AS(QZ_SLASH, WKC_SLASH),
AS(QZ_SEMICOLON, WKC_SEMICOLON),
AS(QZ_EQUALS, WKC_EQUALS),
AS(QZ_LEFTBRACKET, WKC_L_BRACKET),
AS(QZ_BACKSLASH, WKC_BACKSLASH),
AS(QZ_RIGHTBRACKET, WKC_R_BRACKET),
AS(QZ_QUOTE, WKC_SINGLEQUOTE),
AS(QZ_COMMA, WKC_COMMA),
AS(QZ_MINUS, WKC_MINUS),
AS(QZ_PERIOD, WKC_PERIOD)
};
static uint32 QZ_MapKey(unsigned short sym)
{
uint32 key = 0;
for (const VkMapping *map = _vk_mapping; map != endof(_vk_mapping); ++map) {
if (sym == map->vk_from) {
key = map->map_to;
break;
}
}
if (_current_mods & NSShiftKeyMask) key |= WKC_SHIFT;
if (_current_mods & NSControlKeyMask) key |= (_settings_client.gui.right_mouse_btn_emulation != RMBE_CONTROL ? WKC_CTRL : WKC_META);
if (_current_mods & NSAlternateKeyMask) key |= WKC_ALT;
if (_current_mods & NSCommandKeyMask) key |= (_settings_client.gui.right_mouse_btn_emulation != RMBE_CONTROL ? WKC_META : WKC_CTRL);
return key;
}
static bool QZ_KeyEvent(unsigned short keycode, unsigned short unicode, BOOL down)
{
bool interpret_keys = true;
switch (keycode) {
case QZ_UP: SB(_dirkeys, 1, 1, down); break;
case QZ_DOWN: SB(_dirkeys, 3, 1, down); break;
case QZ_LEFT: SB(_dirkeys, 0, 1, down); break;
case QZ_RIGHT: SB(_dirkeys, 2, 1, down); break;
case QZ_TAB: _tab_is_down = down; break;
case QZ_RETURN:
case QZ_f:
if (down && (_current_mods & NSCommandKeyMask)) {
VideoDriver::GetInstance()->ToggleFullscreen(!_fullscreen);
}
break;
case QZ_v:
if (down && EditBoxInGlobalFocus() && (_current_mods & (NSCommandKeyMask | NSControlKeyMask))) {
HandleKeypress(WKC_CTRL | 'V', unicode);
}
break;
case QZ_u:
if (down && EditBoxInGlobalFocus() && (_current_mods & (NSCommandKeyMask | NSControlKeyMask))) {
HandleKeypress(WKC_CTRL | 'U', unicode);
}
break;
}
if (down) {
uint32 pressed_key = QZ_MapKey(keycode);
static bool console = false;
/* The second backquote may have a character, which we don't want to interpret. */
if (pressed_key == WKC_BACKQUOTE && (console || unicode == 0)) {
if (!console) {
/* Backquote is a dead key, require a double press for hotkey behaviour (i.e. console). */
console = true;
return true;
} else {
/* Second backquote, don't interpret as text input. */
interpret_keys = false;
}
}
console = false;
/* Don't handle normal characters if an edit box has the focus. */
if (!EditBoxInGlobalFocus() || IsInsideMM(pressed_key & ~WKC_SPECIAL_KEYS, WKC_F1, WKC_PAUSE + 1)) {
HandleKeypress(pressed_key, unicode);
}
DEBUG(driver, 2, "cocoa_v: QZ_KeyEvent: %x (%x), down, mapping: %x", keycode, unicode, pressed_key);
} else {
DEBUG(driver, 2, "cocoa_v: QZ_KeyEvent: %x (%x), up", keycode, unicode);
}
return interpret_keys;
}
static void QZ_DoUnsidedModifiers(unsigned int newMods)
{
const int mapping[] = { QZ_CAPSLOCK, QZ_LSHIFT, QZ_LCTRL, QZ_LALT, QZ_LMETA };
if (_current_mods == newMods) return;
/* Iterate through the bits, testing each against the current modifiers */
for (unsigned int i = 0, bit = NSAlphaShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {
unsigned int currentMask, newMask;
currentMask = _current_mods & bit;
newMask = newMods & bit;
if (currentMask && currentMask != newMask) { // modifier up event
/* If this was Caps Lock, we need some additional voodoo to make SDL happy (is this needed in ottd?) */
if (bit == NSAlphaShiftKeyMask) QZ_KeyEvent(mapping[i], 0, YES);
QZ_KeyEvent(mapping[i], 0, NO);
} else if (newMask && currentMask != newMask) { // modifier down event
QZ_KeyEvent(mapping[i], 0, YES);
/* If this was Caps Lock, we need some additional voodoo to make SDL happy (is this needed in ottd?) */
if (bit == NSAlphaShiftKeyMask) QZ_KeyEvent(mapping[i], 0, NO);
}
}
_current_mods = newMods;
}
static void QZ_MouseMovedEvent(int x, int y)
{
if (_cursor.UpdateCursorPosition(x, y, false)) {
QZ_WarpCursor(_cursor.pos.x, _cursor.pos.y);
}
HandleMouseEvents();
}
static void QZ_MouseButtonEvent(int button, BOOL down)
{
switch (button) {
case 0:
if (down) {
_left_button_down = true;
} else {
_left_button_down = false;
_left_button_clicked = false;
}
HandleMouseEvents();
break;
case 1:
if (down) {
_right_button_down = true;
_right_button_clicked = true;
} else {
_right_button_down = false;
}
HandleMouseEvents();
break;
}
}
static bool QZ_PollEvent()
{
assert(_cocoa_subdriver != NULL);
#ifdef _DEBUG
uint32 et0 = GetTick();
#endif
NSEvent *event = [ NSApp nextEventMatchingMask:NSAnyEventMask
untilDate:[ NSDate distantPast ]
inMode:NSDefaultRunLoopMode dequeue:YES ];
#ifdef _DEBUG
_tEvent += GetTick() - et0;
#endif
if (event == nil) return false;
if (!_cocoa_subdriver->IsActive()) {
[ NSApp sendEvent:event ];
return true;
}
QZ_DoUnsidedModifiers( [ event modifierFlags ] );
NSString *chars;
NSPoint pt;
switch ([ event type ]) {
case NSMouseMoved:
case NSOtherMouseDragged:
case NSLeftMouseDragged:
pt = _cocoa_subdriver->GetMouseLocation(event);
if (!_cocoa_subdriver->MouseIsInsideView(&pt) && !_emulating_right_button) {
[ NSApp sendEvent:event ];
break;
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
break;
case NSRightMouseDragged:
pt = _cocoa_subdriver->GetMouseLocation(event);
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
break;
case NSLeftMouseDown:
{
uint32 keymask = 0;
if (_settings_client.gui.right_mouse_btn_emulation == RMBE_COMMAND) keymask |= NSCommandKeyMask;
if (_settings_client.gui.right_mouse_btn_emulation == RMBE_CONTROL) keymask |= NSControlKeyMask;
pt = _cocoa_subdriver->GetMouseLocation(event);
if (!([ event modifierFlags ] & keymask) || !_cocoa_subdriver->MouseIsInsideView(&pt)) {
[ NSApp sendEvent:event ];
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
/* Right mouse button emulation */
if ([ event modifierFlags ] & keymask) {
_emulating_right_button = true;
QZ_MouseButtonEvent(1, YES);
} else {
QZ_MouseButtonEvent(0, YES);
}
break;
}
case NSLeftMouseUp:
[ NSApp sendEvent:event ];
pt = _cocoa_subdriver->GetMouseLocation(event);
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
/* Right mouse button emulation */
if (_emulating_right_button) {
_emulating_right_button = false;
QZ_MouseButtonEvent(1, NO);
} else {
QZ_MouseButtonEvent(0, NO);
}
break;
case NSRightMouseDown:
pt = _cocoa_subdriver->GetMouseLocation(event);
if (!_cocoa_subdriver->MouseIsInsideView(&pt)) {
[ NSApp sendEvent:event ];
break;
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
QZ_MouseButtonEvent(1, YES);
break;
case NSRightMouseUp:
pt = _cocoa_subdriver->GetMouseLocation(event);
if (!_cocoa_subdriver->MouseIsInsideView(&pt)) {
[ NSApp sendEvent:event ];
break;
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
QZ_MouseButtonEvent(1, NO);
break;
#if 0
/* This is not needed since openttd currently only use two buttons */
case NSOtherMouseDown:
pt = QZ_GetMouseLocation(event);
if (!QZ_MouseIsInsideView(&pt)) {
[ NSApp sendEvent:event ];
break;
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
QZ_MouseButtonEvent([ event buttonNumber ], YES);
break;
case NSOtherMouseUp:
pt = QZ_GetMouseLocation(event);
if (!QZ_MouseIsInsideView(&pt)) {
[ NSApp sendEvent:event ];
break;
}
QZ_MouseMovedEvent((int)pt.x, (int)pt.y);
QZ_MouseButtonEvent([ event buttonNumber ], NO);
break;
#endif
case NSKeyDown: {
/* Quit, hide and minimize */
switch ([ event keyCode ]) {
case QZ_q:
case QZ_h:
case QZ_m:
if ([ event modifierFlags ] & NSCommandKeyMask) {
[ NSApp sendEvent:event ];
}
break;
}
chars = [ event characters ];
unsigned short unicode = [ chars length ] > 0 ? [ chars characterAtIndex:0 ] : 0;
if (EditBoxInGlobalFocus()) {
if (QZ_KeyEvent([ event keyCode ], unicode, YES)) {
[ _cocoa_subdriver->cocoaview interpretKeyEvents:[ NSArray arrayWithObject:event ] ];
}
} else {
QZ_KeyEvent([ event keyCode ], unicode, YES);
for (uint i = 1; i < [ chars length ]; i++) {
QZ_KeyEvent(0, [ chars characterAtIndex:i ], YES);
}
}
break;
}
case NSKeyUp:
/* Quit, hide and minimize */
switch ([ event keyCode ]) {
case QZ_q:
case QZ_h:
case QZ_m:
if ([ event modifierFlags ] & NSCommandKeyMask) {
[ NSApp sendEvent:event ];
}
break;
}
chars = [ event characters ];
QZ_KeyEvent([ event keyCode ], [ chars length ] ? [ chars characterAtIndex:0 ] : 0, NO);
break;
case NSScrollWheel:
if ([ event deltaY ] > 0.0) { /* Scroll up */
_cursor.wheel--;
} else if ([ event deltaY ] < 0.0) { /* Scroll down */
_cursor.wheel++;
} /* else: deltaY was 0.0 and we don't want to do anything */
/* Set the scroll count for scrollwheel scrolling */
_cursor.h_wheel -= (int)([ event deltaX ] * 5 * _settings_client.gui.scrollwheel_multiplier);
_cursor.v_wheel -= (int)([ event deltaY ] * 5 * _settings_client.gui.scrollwheel_multiplier);
break;
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
case NSEventTypeMagnify:
/* Pinch open or close gesture. */
_current_magnification += [ event magnification ] * 5.0f;
while (_current_magnification >= 1.0f) {
_current_magnification -= 1.0f;
_cursor.wheel--;
HandleMouseEvents();
}
while (_current_magnification <= -1.0f) {
_current_magnification += 1.0f;
_cursor.wheel++;
HandleMouseEvents();
}
break;
case NSEventTypeEndGesture:
/* Gesture ended. */
_current_magnification = 0.0f;
break;
#endif
case NSCursorUpdate:
case NSMouseEntered:
case NSMouseExited:
/* Catch these events if the cursor is dragging. During dragging, we reset
* the mouse position programmatically, which would trigger OS X to show
* the default arrow cursor if the events are propagated. */
if (_cursor.fix_at) break;
FALLTHROUGH;
default:
[ NSApp sendEvent:event ];
}
return true;
}
void QZ_GameLoop()
{
uint32 cur_ticks = GetTick();
uint32 last_cur_ticks = cur_ticks;
uint32 next_tick = cur_ticks + MILLISECONDS_PER_TICK;
#ifdef _DEBUG
uint32 et0 = GetTick();
uint32 st = 0;
#endif
DisplaySplashImage();
QZ_CheckPaletteAnim();
_cocoa_subdriver->Draw(true);
CSleep(1);
for (int i = 0; i < 2; i++) GameLoop();
UpdateWindows();
QZ_CheckPaletteAnim();
_cocoa_subdriver->Draw();
CSleep(1);
/* Set the proper OpenTTD palette which got spoilt by the splash
* image when using 8bpp blitter */
GfxInitPalettes();
QZ_CheckPaletteAnim();
_cocoa_subdriver->Draw(true);
for (;;) {
uint32 prev_cur_ticks = cur_ticks; // to check for wrapping
InteractiveRandom(); // randomness
while (QZ_PollEvent()) {}
if (_exit_game) break;
#if defined(_DEBUG)
if (_current_mods & NSShiftKeyMask)
#else
if (_tab_is_down)
#endif
{
if (!_networking && _game_mode != GM_MENU) _fast_forward |= 2;
} else if (_fast_forward & 2) {
_fast_forward = 0;
}
cur_ticks = GetTick();
if (cur_ticks >= next_tick || (_fast_forward && !_pause_mode) || cur_ticks < prev_cur_ticks) {
_realtime_tick += cur_ticks - last_cur_ticks;
last_cur_ticks = cur_ticks;
next_tick = cur_ticks + MILLISECONDS_PER_TICK;
bool old_ctrl_pressed = _ctrl_pressed;
_ctrl_pressed = !!(_current_mods & ( _settings_client.gui.right_mouse_btn_emulation != RMBE_CONTROL ? NSControlKeyMask : NSCommandKeyMask));
_shift_pressed = !!(_current_mods & NSShiftKeyMask);
if (old_ctrl_pressed != _ctrl_pressed) HandleCtrlChanged();
GameLoop();
UpdateWindows();
QZ_CheckPaletteAnim();
_cocoa_subdriver->Draw();
} else {
#ifdef _DEBUG
uint32 st0 = GetTick();
#endif
CSleep(1);
#ifdef _DEBUG
st += GetTick() - st0;
#endif
NetworkDrawChatMessage();
DrawMouseCursor();
_cocoa_subdriver->Draw();
}
}
#ifdef _DEBUG
uint32 et = GetTick();
DEBUG(driver, 1, "cocoa_v: nextEventMatchingMask took %i ms total", _tEvent);
DEBUG(driver, 1, "cocoa_v: game loop took %i ms total (%i ms without sleep)", et - et0, et - et0 - st);
DEBUG(driver, 1, "cocoa_v: (nextEventMatchingMask total)/(game loop total) is %f%%", (double)_tEvent / (double)(et - et0) * 100);
DEBUG(driver, 1, "cocoa_v: (nextEventMatchingMask total)/(game loop without sleep total) is %f%%", (double)_tEvent / (double)(et - et0 - st) * 100);
#endif
}
#endif /* WITH_COCOA */