1

/* $Id$ */

     2

     3

/******************************************************************************

     4

 *                             Cocoa video driver                             *

     5

 * Known things left to do:                                                   *

     6

 *  Nothing at the moment.                                                    *

     7

 ******************************************************************************/

     8

     9

#ifdef WITH_COCOA

    10

    11

#define MAC_OS_X_VERSION_MIN_REQUIRED    MAC_OS_X_VERSION_10_3

    12

#include <AvailabilityMacros.h>

    13

    14

#import <Cocoa/Cocoa.h>

    15

#import <sys/time.h> /* gettimeofday */

    16

#import <sys/param.h> /* for MAXPATHLEN */

    17

#import <unistd.h>

    18

    19

/**

    20

 * Important notice regarding all modifications!!!!!!!

    21

 * There are certain limitations because the file is objective C++.

    22

 * gdb has limitations.

    23

 * C++ and objective C code can't be joined in all cases (classes stuff).

    24

 * Read http://developer.apple.com/releasenotes/Cocoa/Objective-C++.html for more information.

    25

 */

    26

    27

    28

/* Defined in stdbool.h */

    29

#ifndef __cplusplus

    30

# ifndef __BEOS__

    31

#  undef bool

    32

#  undef false

    33

#  undef true

    34

# endif

    35

#endif

    36

    37

    38

#include "../../stdafx.h"

    39

#include "../../openttd.h"

    40

#include "../../debug.h"

    41

#include "../../os/macosx/splash.h"

    42

#include "../../variables.h"

    43

#include "../../settings_type.h"

    44

#include "../../core/geometry_type.hpp"

    45

#include "cocoa_v.h"

    46

#include "cocoa_keys.h"

    47

#include "../../blitter/factory.hpp"

    48

#include "../../gfx_func.h"

    49

#include "../../network/network.h"

    50

#include "../../core/random_func.hpp"

    51

#include "../../texteff.hpp"

    52

    53

    54

/* Right Mouse Button Emulation enum */

    55

enum {

    56

	RMBE_COMMAND,

    57

	RMBE_CONTROL,

    58

	RMBE_OFF,

    59

};

    60

    61

    62

static bool _show_mouse = true;

    63

static unsigned int _current_mods;

    64

static bool _tab_is_down;

    65

static bool _emulating_right_button;

    66

#ifdef _DEBUG

    67

static uint32 _tEvent;

    68

#endif

    69

    70

    71

static uint32 GetTick()

    72

{

    73

	struct timeval tim;

    74

    75

	gettimeofday(&tim, NULL);

    76

	return tim.tv_usec / 1000 + tim.tv_sec * 1000;

    77

}

    78

    79

    80

void QZ_ShowMouse()

    81

{

    82

	if (!_show_mouse) {

    83

		[ NSCursor unhide ];

    84

		_show_mouse = true;

    85

    86

		// Hide the openttd cursor when leaving the window

    87

		if (_cocoa_subdriver != NULL)

    88

			UndrawMouseCursor();

    89

		_cursor.in_window = false;

    90

	}

    91

}

    92

    93

void QZ_HideMouse()

    94

{

    95

	if (_show_mouse) {

    96

		/*

    97

		 * Don't hide the cursor when compiling in debug mode.

    98

		 * Note: Not hiding the cursor will cause artefacts around it in 8bpp fullscreen mode.

    99

		 */

   100

#ifndef _DEBUG

   101

		[ NSCursor hide ];

   102

#endif

   103

		_show_mouse = false;

   104

   105

		// Show the openttd cursor again

   106

		_cursor.in_window = true;

   107

	}

   108

}

   109

   110

static void QZ_WarpCursor(int x, int y)

   111

{

   112

	NSPoint p;

   113

	CGPoint cgp;

   114

   115

	assert(_cocoa_subdriver);

   116

   117

	/* Only allow warping when in foreground */

   118

	if (![ NSApp isActive ]) return;

   119

   120

	p = NSMakePoint(x, y);

   121

	cgp = _cocoa_subdriver->PrivateLocalToCG(&p);

   122

   123

	/* this is the magic call that fixes cursor "freezing" after warp */

   124

	CGSetLocalEventsSuppressionInterval(0.0);

   125

	/* Do the actual warp */

   126

	CGWarpMouseCursorPosition(cgp);

   127

   128

	/* Generate the mouse moved event */

   129

}

   130

   131

   132

static void QZ_CheckPaletteAnim()

   133

{

   134

	if (_pal_count_dirty != 0) {

   135

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   136

   137

		switch (blitter->UsePaletteAnimation()) {

   138

			case Blitter::PALETTE_ANIMATION_VIDEO_BACKEND:

   139

				_cocoa_subdriver->UpdatePalette(_pal_first_dirty, _pal_count_dirty);

   140

				break;

   141

   142

			case Blitter::PALETTE_ANIMATION_BLITTER:

   143

				blitter->PaletteAnimate(_pal_first_dirty, _pal_count_dirty);

   144

				break;

   145

   146

			case Blitter::PALETTE_ANIMATION_NONE:

   147

				break;

   148

   149

			default:

   150

				NOT_REACHED();

   151

		}

   152

		_pal_count_dirty = 0;

   153

	}

   154

}

   155

   156

   157

   158

struct VkMapping {

   159

	unsigned short vk_from;

   160

	byte map_to;

   161

};

   162

   163

#define AS(x, z) {x, z}

   164

   165

static const VkMapping _vk_mapping[] = {

   166

	AS(QZ_BACKQUOTE,  WKC_BACKQUOTE), // key left of '1'

   167

	AS(QZ_BACKQUOTE2, WKC_BACKQUOTE), // some keyboards have it on another scancode

   168

   169

	/* Pageup stuff + up/down */

   170

	AS(QZ_PAGEUP,   WKC_PAGEUP),

   171

	AS(QZ_PAGEDOWN, WKC_PAGEDOWN),

   172

   173

	AS(QZ_UP,    WKC_UP),

   174

	AS(QZ_DOWN,  WKC_DOWN),

   175

	AS(QZ_LEFT,  WKC_LEFT),

   176

	AS(QZ_RIGHT, WKC_RIGHT),

   177

   178

	AS(QZ_HOME, WKC_HOME),

   179

	AS(QZ_END,  WKC_END),

   180

   181

	AS(QZ_INSERT, WKC_INSERT),

   182

	AS(QZ_DELETE, WKC_DELETE),

   183

   184

	/* Letters. QZ_[a-z] is not in numerical order so we can't use AM(...) */

   185

	AS(QZ_a, 'A'),

   186

	AS(QZ_b, 'B'),

   187

	AS(QZ_c, 'C'),

   188

	AS(QZ_d, 'D'),

   189

	AS(QZ_e, 'E'),

   190

	AS(QZ_f, 'F'),

   191

	AS(QZ_g, 'G'),

   192

	AS(QZ_h, 'H'),

   193

	AS(QZ_i, 'I'),

   194

	AS(QZ_j, 'J'),

   195

	AS(QZ_k, 'K'),

   196

	AS(QZ_l, 'L'),

   197

	AS(QZ_m, 'M'),

   198

	AS(QZ_n, 'N'),

   199

	AS(QZ_o, 'O'),

   200

	AS(QZ_p, 'P'),

   201

	AS(QZ_q, 'Q'),

   202

	AS(QZ_r, 'R'),

   203

	AS(QZ_s, 'S'),

   204

	AS(QZ_t, 'T'),

   205

	AS(QZ_u, 'U'),

   206

	AS(QZ_v, 'V'),

   207

	AS(QZ_w, 'W'),

   208

	AS(QZ_x, 'X'),

   209

	AS(QZ_y, 'Y'),

   210

	AS(QZ_z, 'Z'),

   211

	/* Same thing for digits */

   212

	AS(QZ_0, '0'),

   213

	AS(QZ_1, '1'),

   214

	AS(QZ_2, '2'),

   215

	AS(QZ_3, '3'),

   216

	AS(QZ_4, '4'),

   217

	AS(QZ_5, '5'),

   218

	AS(QZ_6, '6'),

   219

	AS(QZ_7, '7'),

   220

	AS(QZ_8, '8'),

   221

	AS(QZ_9, '9'),

   222

   223

	AS(QZ_ESCAPE,    WKC_ESC),

   224

	AS(QZ_PAUSE,     WKC_PAUSE),

   225

	AS(QZ_BACKSPACE, WKC_BACKSPACE),

   226

   227

	AS(QZ_SPACE,  WKC_SPACE),

   228

	AS(QZ_RETURN, WKC_RETURN),

   229

	AS(QZ_TAB,    WKC_TAB),

   230

   231

	/* Function keys */

   232

	AS(QZ_F1,  WKC_F1),

   233

	AS(QZ_F2,  WKC_F2),

   234

	AS(QZ_F3,  WKC_F3),

   235

	AS(QZ_F4,  WKC_F4),

   236

	AS(QZ_F5,  WKC_F5),

   237

	AS(QZ_F6,  WKC_F6),

   238

	AS(QZ_F7,  WKC_F7),

   239

	AS(QZ_F8,  WKC_F8),

   240

	AS(QZ_F9,  WKC_F9),

   241

	AS(QZ_F10, WKC_F10),

   242

	AS(QZ_F11, WKC_F11),

   243

	AS(QZ_F12, WKC_F12),

   244

   245

	/* Numeric part */

   246

	AS(QZ_KP0,         WKC_NUM_0),

   247

	AS(QZ_KP1,         WKC_NUM_1),

   248

	AS(QZ_KP2,         WKC_NUM_2),

   249

	AS(QZ_KP3,         WKC_NUM_3),

   250

	AS(QZ_KP4,         WKC_NUM_4),

   251

	AS(QZ_KP5,         WKC_NUM_5),

   252

	AS(QZ_KP6,         WKC_NUM_6),

   253

	AS(QZ_KP7,         WKC_NUM_7),

   254

	AS(QZ_KP8,         WKC_NUM_8),

   255

	AS(QZ_KP9,         WKC_NUM_9),

   256

	AS(QZ_KP_DIVIDE,   WKC_NUM_DIV),

   257

	AS(QZ_KP_MULTIPLY, WKC_NUM_MUL),

   258

	AS(QZ_KP_MINUS,    WKC_NUM_MINUS),

   259

	AS(QZ_KP_PLUS,     WKC_NUM_PLUS),

   260

	AS(QZ_KP_ENTER,    WKC_NUM_ENTER),

   261

	AS(QZ_KP_PERIOD,   WKC_NUM_DECIMAL),

   262

   263

	/* Other non-letter keys */

   264

	AS(QZ_SLASH,        WKC_SLASH),

   265

	AS(QZ_SEMICOLON,    WKC_SEMICOLON),

   266

	AS(QZ_EQUALS,       WKC_EQUALS),

   267

	AS(QZ_LEFTBRACKET,  WKC_L_BRACKET),

   268

	AS(QZ_BACKSLASH,    WKC_BACKSLASH),

   269

	AS(QZ_RIGHTBRACKET, WKC_R_BRACKET),

   270

   271

	AS(QZ_QUOTE,   WKC_SINGLEQUOTE),

   272

	AS(QZ_COMMA,   WKC_COMMA),

   273

	AS(QZ_MINUS,   WKC_MINUS),

   274

	AS(QZ_PERIOD,  WKC_PERIOD)

   275

};

   276

   277

   278

static uint32 QZ_MapKey(unsigned short sym)

   279

{

   280

	const VkMapping *map;

   281

	uint32 key = 0;

   282

   283

	for (map = _vk_mapping; map != endof(_vk_mapping); ++map) {

   284

		if (sym == map->vk_from) {

   285

			key = map->map_to;

   286

			break;

   287

		}

   288

	}

   289

   290

	if (_current_mods & NSShiftKeyMask)     key |= WKC_SHIFT;

   291

	if (_current_mods & NSControlKeyMask)   key |= (_settings_client.gui.right_mouse_btn_emulation != RMBE_CONTROL ? WKC_CTRL : WKC_META);

   292

	if (_current_mods & NSAlternateKeyMask) key |= WKC_ALT;

   293

	if (_current_mods & NSCommandKeyMask)   key |= (_settings_client.gui.right_mouse_btn_emulation != RMBE_CONTROL ? WKC_META : WKC_CTRL);

   294

   295

	return key << 16;

   296

}

   297

   298

static void QZ_KeyEvent(unsigned short keycode, unsigned short unicode, BOOL down)

   299

{

   300

	switch (keycode) {

   301

		case QZ_UP:    SB(_dirkeys, 1, 1, down); break;

   302

		case QZ_DOWN:  SB(_dirkeys, 3, 1, down); break;

   303

		case QZ_LEFT:  SB(_dirkeys, 0, 1, down); break;

   304

		case QZ_RIGHT: SB(_dirkeys, 2, 1, down); break;

   305

   306

		case QZ_TAB: _tab_is_down = down; break;

   307

   308

		case QZ_RETURN:

   309

		case QZ_f:

   310

			if (down && (_current_mods & NSCommandKeyMask)) {

   311

				_video_driver->ToggleFullscreen(!_fullscreen);

   312

			}

   313

			break;

   314

	}

   315

   316

	if (down) {

   317

		uint32 pressed_key = QZ_MapKey(keycode) | unicode;

   318

		HandleKeypress(pressed_key);

   319

		DEBUG(driver, 2, "cocoa_v: QZ_KeyEvent: %x (%x), down, mapping: %x", keycode, unicode, pressed_key);

   320

	} else {

   321

		DEBUG(driver, 2, "cocoa_v: QZ_KeyEvent: %x (%x), up", keycode, unicode);

   322

	}

   323

}

   324

   325

static void QZ_DoUnsidedModifiers(unsigned int newMods)

   326

{

   327

	const int mapping[] = { QZ_CAPSLOCK, QZ_LSHIFT, QZ_LCTRL, QZ_LALT, QZ_LMETA };

   328

   329

	int i;

   330

	unsigned int bit;

   331

   332

	if (_current_mods == newMods) return;

   333

   334

	/* Iterate through the bits, testing each against the current modifiers */

   335

	for (i = 0, bit = NSAlphaShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {

   336

		unsigned int currentMask, newMask;

   337

   338

		currentMask = _current_mods & bit;

   339

		newMask     = newMods & bit;

   340

   341

		if (currentMask && currentMask != newMask) { /* modifier up event */

   342

			/* If this was Caps Lock, we need some additional voodoo to make SDL happy (is this needed in ottd?) */

   343

			if (bit == NSAlphaShiftKeyMask) QZ_KeyEvent(mapping[i], 0, YES);

   344

			QZ_KeyEvent(mapping[i], 0, NO);

   345

		} else if (newMask && currentMask != newMask) { /* modifier down event */

   346

			QZ_KeyEvent(mapping[i], 0, YES);

   347

			/* If this was Caps Lock, we need some additional voodoo to make SDL happy (is this needed in ottd?) */

   348

			if (bit == NSAlphaShiftKeyMask) QZ_KeyEvent(mapping[i], 0, NO);

   349

		}

   350

	}

   351

   352

	_current_mods = newMods;

   353

}

   354

   355

static void QZ_MouseMovedEvent(int x, int y)

   356

{

   357

	if (_cursor.fix_at) {

   358

		int dx = x - _cursor.pos.x;

   359

		int dy = y - _cursor.pos.y;

   360

   361

		if (dx != 0 || dy != 0) {

   362

			_cursor.delta.x += dx;

   363

			_cursor.delta.y += dy;

   364

   365

			QZ_WarpCursor(_cursor.pos.x, _cursor.pos.y);

   366

		}

   367

	} else {

   368

		_cursor.delta.x = x - _cursor.pos.x;

   369

		_cursor.delta.y = y - _cursor.pos.y;

   370

		_cursor.pos.x = x;

   371

		_cursor.pos.y = y;

   372

		_cursor.dirty = true;

   373

	}

   374

	HandleMouseEvents();

   375

}

   376

   377

   378

static void QZ_MouseButtonEvent(int button, BOOL down)

   379

{

   380

	switch (button) {

   381

		case 0:

   382

			if (down) {

   383

				_left_button_down = true;

   384

			} else {

   385

				_left_button_down = false;

   386

				_left_button_clicked = false;

   387

			}

   388

			HandleMouseEvents();

   389

			break;

   390

   391

		case 1:

   392

			if (down) {

   393

				_right_button_down = true;

   394

				_right_button_clicked = true;

   395

			} else {

   396

				_right_button_down = false;

   397

			}

   398

			HandleMouseEvents();

   399

			break;

   400

	}

   401

}

   402

   403

   404

   405

   406

static bool QZ_PollEvent()

   407

{

   408

	NSEvent *event;

   409

	NSPoint pt;

   410

	NSString *chars;

   411

#ifdef _DEBUG

   412

	uint32 et0, et;

   413

#endif

   414

   415

	assert(_cocoa_subdriver != NULL);

   416

   417

#ifdef _DEBUG

   418

	et0 = GetTick();

   419

#endif

   420

	event = [ NSApp nextEventMatchingMask:NSAnyEventMask

   421

			untilDate: [ NSDate distantPast ]

   422

			inMode: NSDefaultRunLoopMode dequeue:YES ];

   423

#ifdef _DEBUG

   424

	et = GetTick();

   425

	_tEvent+= et - et0;

   426

#endif

   427

   428

	if (event == nil) return false;

   429

	if (!_cocoa_subdriver->IsActive()) {

   430

		QZ_ShowMouse();

   431

		[NSApp sendEvent:event];

   432

		return true;

   433

	}

   434

   435

	QZ_DoUnsidedModifiers( [ event modifierFlags ] );

   436

   437

	switch ([event type]) {

   438

		case NSMouseMoved:

   439

		case NSOtherMouseDragged:

   440

		case NSLeftMouseDragged:

   441

			pt = _cocoa_subdriver->GetMouseLocation(event);

   442

			if (!_cocoa_subdriver->MouseIsInsideView(&pt) &&

   443

					!_emulating_right_button) {

   444

				QZ_ShowMouse();

   445

				[NSApp sendEvent:event];

   446

				break;

   447

			}

   448

   449

			QZ_HideMouse();

   450

			QZ_MouseMovedEvent((int)pt.x, (int)pt.y);

   451

			break;

   452

   453

		case NSRightMouseDragged:

   454

			pt = _cocoa_subdriver->GetMouseLocation(event);

   455

			QZ_HideMouse();

   456

			QZ_MouseMovedEvent((int)pt.x, (int)pt.y);

   457

			break;

   458

   459

		case NSLeftMouseDown:

   460

		{

   461

			uint32 keymask = 0;

   462

			if (_settings_client.gui.right_mouse_btn_emulation == RMBE_COMMAND) keymask |= NSCommandKeyMask;

   463

			if (_settings_client.gui.right_mouse_btn_emulation == RMBE_CONTROL) keymask |= NSControlKeyMask;

   464

   465

			pt = _cocoa_subdriver->GetMouseLocation(event);

   466

   467

			if (!([ event modifierFlags ] & keymask) ||

   468

					!_cocoa_subdriver->MouseIsInsideView(&pt)) {

   469

				[NSApp sendEvent:event];

   470

			}

   471

   472

			if (!_cocoa_subdriver->MouseIsInsideView(&pt)) {

   473

				QZ_ShowMouse();

   474

				break;

   475

			}

   476

   477

			QZ_HideMouse();

   478

			QZ_MouseMovedEvent((int)pt.x, (int)pt.y);

   479

   480

			/* Right mouse button emulation */

   481

			if ([ event modifierFlags ] & keymask) {

   482

				_emulating_right_button = true;

   483

				QZ_MouseButtonEvent(1, YES);

   484

			} else {

   485

				QZ_MouseButtonEvent(0, YES);

   486

			}

   487

			break;

   488

		}

   489

		case NSLeftMouseUp:

   490

			[NSApp sendEvent:event];

   491

   492

			pt = _cocoa_subdriver->GetMouseLocation(event);

   493

			if (!_cocoa_subdriver->MouseIsInsideView(&pt)) {

   494

				QZ_ShowMouse();

   495

				break;

   496

			}

   497

   498

			QZ_HideMouse();

   499

			QZ_MouseMovedEvent((int)pt.x, (int)pt.y);