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"

    44

#include "cocoa_v.h"

    45

#include "cocoa_keys.h"

    46

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

    49

    50

    51

/* Right Mouse Button Emulation enum */

    52

enum {

    53

	RMBE_COMMAND,

    54

	RMBE_CONTROL,

    55

	RMBE_OFF,

    56

};

    57

    58

    59

static bool _show_mouse = true;

    60

static unsigned int _current_mods;

    61

static bool _tab_is_down;

    62

static bool _emulating_right_button;

    63

#ifdef _DEBUG

    64

static uint32 _tEvent;

    65

#endif

    66

    67

    68

static uint32 GetTick()

    69

{

    70

	struct timeval tim;

    71

    72

	gettimeofday(&tim, NULL);

    73

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

    74

}

    75

    76

    77

void QZ_ShowMouse()

    78

{

    79

	if (!_show_mouse) {

    80

		[ NSCursor unhide ];

    81

		_show_mouse = true;

    82

    83

		// Hide the openttd cursor when leaving the window

    84

		if (_cocoa_subdriver != NULL)

    85

			UndrawMouseCursor();

    86

		_cursor.in_window = false;

    87

	}

    88

}

    89

    90

void QZ_HideMouse()

    91

{

    92

	if (_show_mouse) {

    93

		/*

    94

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

    95

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

    96

		 */

    97

#ifndef _DEBUG

    98

		[ NSCursor hide ];

    99

#endif

   100

		_show_mouse = false;

   101

   102

		// Show the openttd cursor again

   103

		_cursor.in_window = true;

   104

	}

   105

}

   106

   107

static void QZ_WarpCursor(int x, int y)

   108

{

   109

	NSPoint p;

   110

	CGPoint cgp;

   111

   112

	assert(_cocoa_subdriver);

   113

   114

	/* Only allow warping when in foreground */

   115

	if (![ NSApp isActive ]) return;

   116

   117

	p = NSMakePoint(x, y);

   118

	cgp = _cocoa_subdriver->PrivateLocalToCG(&p);

   119

   120

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

   121

	CGSetLocalEventsSuppressionInterval(0.0);

   122

	/* Do the actual warp */

   123

	CGWarpMouseCursorPosition(cgp);

   124

   125

	/* Generate the mouse moved event */

   126

}

   127

   128

   129

static void QZ_CheckPaletteAnim()

   130

{

   131

	if (_pal_count_dirty != 0) {

   132

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   133

   134

		switch (blitter->UsePaletteAnimation()) {

   135

			case Blitter::PALETTE_ANIMATION_VIDEO_BACKEND:

   136

				_cocoa_subdriver->UpdatePalette(_pal_first_dirty, _pal_count_dirty);

   137

				break;

   138

   139

			case Blitter::PALETTE_ANIMATION_BLITTER:

   140

				blitter->PaletteAnimate(_pal_first_dirty, _pal_count_dirty);

   141

				break;

   142

   143

			case Blitter::PALETTE_ANIMATION_NONE:

   144

				break;

   145

   146

			default:

   147

				NOT_REACHED();

   148

		}

   149

		_pal_count_dirty = 0;

   150

	}

   151

}

   152

   153

   154

   155

struct VkMapping {

   156

	unsigned short vk_from;

   157

	byte map_to;

   158

};

   159

   160

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

   161

   162

static const VkMapping _vk_mapping[] = {

   163

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

   164

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

   165

   166

	/* Pageup stuff + up/down */

   167

	AS(QZ_PAGEUP,   WKC_PAGEUP),

   168

	AS(QZ_PAGEDOWN, WKC_PAGEDOWN),

   169

   170

	AS(QZ_UP,    WKC_UP),

   171

	AS(QZ_DOWN,  WKC_DOWN),

   172

	AS(QZ_LEFT,  WKC_LEFT),

   173

	AS(QZ_RIGHT, WKC_RIGHT),

   174

   175

	AS(QZ_HOME, WKC_HOME),

   176

	AS(QZ_END,  WKC_END),

   177

   178

	AS(QZ_INSERT, WKC_INSERT),

   179

	AS(QZ_DELETE, WKC_DELETE),

   180

   181

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

   182

	AS(QZ_a, 'A'),

   183

	AS(QZ_b, 'B'),

   184

	AS(QZ_c, 'C'),

   185

	AS(QZ_d, 'D'),

   186

	AS(QZ_e, 'E'),

   187

	AS(QZ_f, 'F'),

   188

	AS(QZ_g, 'G'),

   189

	AS(QZ_h, 'H'),

   190

	AS(QZ_i, 'I'),

   191

	AS(QZ_j, 'J'),

   192

	AS(QZ_k, 'K'),

   193

	AS(QZ_l, 'L'),

   194

	AS(QZ_m, 'M'),

   195

	AS(QZ_n, 'N'),

   196

	AS(QZ_o, 'O'),

   197

	AS(QZ_p, 'P'),

   198

	AS(QZ_q, 'Q'),

   199

	AS(QZ_r, 'R'),

   200

	AS(QZ_s, 'S'),

   201

	AS(QZ_t, 'T'),

   202

	AS(QZ_u, 'U'),

   203

	AS(QZ_v, 'V'),

   204

	AS(QZ_w, 'W'),

   205

	AS(QZ_x, 'X'),

   206

	AS(QZ_y, 'Y'),

   207

	AS(QZ_z, 'Z'),

   208

	/* Same thing for digits */

   209

	AS(QZ_0, '0'),

   210

	AS(QZ_1, '1'),

   211

	AS(QZ_2, '2'),

   212

	AS(QZ_3, '3'),

   213

	AS(QZ_4, '4'),

   214

	AS(QZ_5, '5'),

   215

	AS(QZ_6, '6'),

   216

	AS(QZ_7, '7'),

   217

	AS(QZ_8, '8'),

   218

	AS(QZ_9, '9'),

   219

   220

	AS(QZ_ESCAPE,    WKC_ESC),

   221

	AS(QZ_PAUSE,     WKC_PAUSE),

   222

	AS(QZ_BACKSPACE, WKC_BACKSPACE),

   223

   224

	AS(QZ_SPACE,  WKC_SPACE),

   225

	AS(QZ_RETURN, WKC_RETURN),

   226

	AS(QZ_TAB,    WKC_TAB),

   227

   228

	/* Function keys */

   229

	AS(QZ_F1,  WKC_F1),

   230

	AS(QZ_F2,  WKC_F2),

   231

	AS(QZ_F3,  WKC_F3),

   232

	AS(QZ_F4,  WKC_F4),

   233

	AS(QZ_F5,  WKC_F5),

   234

	AS(QZ_F6,  WKC_F6),

   235

	AS(QZ_F7,  WKC_F7),

   236

	AS(QZ_F8,  WKC_F8),

   237

	AS(QZ_F9,  WKC_F9),

   238

	AS(QZ_F10, WKC_F10),

   239

	AS(QZ_F11, WKC_F11),

   240

	AS(QZ_F12, WKC_F12),

   241

   242

	/* Numeric part */

   243

	AS(QZ_KP0,         WKC_NUM_0),

   244

	AS(QZ_KP1,         WKC_NUM_1),

   245

	AS(QZ_KP2,         WKC_NUM_2),

   246

	AS(QZ_KP3,         WKC_NUM_3),

   247

	AS(QZ_KP4,         WKC_NUM_4),

   248

	AS(QZ_KP5,         WKC_NUM_5),

   249

	AS(QZ_KP6,         WKC_NUM_6),

   250

	AS(QZ_KP7,         WKC_NUM_7),

   251

	AS(QZ_KP8,         WKC_NUM_8),

   252

	AS(QZ_KP9,         WKC_NUM_9),

   253

	AS(QZ_KP_DIVIDE,   WKC_NUM_DIV),

   254

	AS(QZ_KP_MULTIPLY, WKC_NUM_MUL),

   255

	AS(QZ_KP_MINUS,    WKC_NUM_MINUS),

   256

	AS(QZ_KP_PLUS,     WKC_NUM_PLUS),

   257

	AS(QZ_KP_ENTER,    WKC_NUM_ENTER),

   258

	AS(QZ_KP_PERIOD,   WKC_NUM_DECIMAL),

   259

   260

	/* Other non-letter keys */

   261

	AS(QZ_SLASH,        WKC_SLASH),

   262

	AS(QZ_SEMICOLON,    WKC_SEMICOLON),

   263

	AS(QZ_EQUALS,       WKC_EQUALS),

   264

	AS(QZ_LEFTBRACKET,  WKC_L_BRACKET),

   265

	AS(QZ_BACKSLASH,    WKC_BACKSLASH),

   266

	AS(QZ_RIGHTBRACKET, WKC_R_BRACKET),

   267

   268

	AS(QZ_QUOTE,   WKC_SINGLEQUOTE),

   269

	AS(QZ_COMMA,   WKC_COMMA),

   270

	AS(QZ_MINUS,   WKC_MINUS),

   271

	AS(QZ_PERIOD,  WKC_PERIOD)

   272

};

   273

   274

   275

static uint32 QZ_MapKey(unsigned short sym)

   276

{

   277

	const VkMapping *map;

   278

	uint32 key = 0;

   279

   280

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

   281

		if (sym == map->vk_from) {

   282

			key = map->map_to;

   283

			break;

   284

		}

   285

	}

   286

   287

	if (_current_mods & NSShiftKeyMask)     key |= WKC_SHIFT;

   288

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

   289

	if (_current_mods & NSAlternateKeyMask) key |= WKC_ALT;

   290

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

   291

   292

	return key << 16;

   293

}

   294

   295

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

   296

{

   297

	switch (keycode) {

   298

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

   299

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

   300

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

   301

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

   302

   303

		case QZ_TAB: _tab_is_down = down; break;

   304

   305

		case QZ_RETURN:

   306

		case QZ_f:

   307

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

   308

				_video_driver->ToggleFullscreen(!_fullscreen);

   309

			}

   310

			break;

   311

	}

   312

   313

	if (down) {

   314

		uint32 pressed_key = QZ_MapKey(keycode) | unicode;

   315

		HandleKeypress(pressed_key);

   316

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

   317

	} else {

   318

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

   319

	}

   320

}

   321

   322

static void QZ_DoUnsidedModifiers(unsigned int newMods)

   323

{

   324

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

   325

   326

	int i;

   327

	unsigned int bit;

   328

   329

	if (_current_mods == newMods) return;

   330

   331

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

   332

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

   333

		unsigned int currentMask, newMask;

   334

   335

		currentMask = _current_mods & bit;

   336

		newMask     = newMods & bit;

   337

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

		}

   347

	}

   348

   349

	_current_mods = newMods;

   350

}

   351

   352

static void QZ_MouseMovedEvent(int x, int y)

   353

{

   354

	if (_cursor.fix_at) {

   355

		int dx = x - _cursor.pos.x;

   356

		int dy = y - _cursor.pos.y;

   357

   358

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

   359

			_cursor.delta.x += dx;

   360

			_cursor.delta.y += dy;

   361

   362

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

   363

		}

   364

	} else {

   365

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

   366

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

   367

		_cursor.pos.x = x;

   368

		_cursor.pos.y = y;

   369

		_cursor.dirty = true;

   370

	}

   371

	HandleMouseEvents();

   372

}

   373

   374

   375

static void QZ_MouseButtonEvent(int button, BOOL down)

   376

{

   377

	switch (button) {

   378

		case 0:

   379

			if (down) {

   380

				_left_button_down = true;

   381

			} else {

   382

				_left_button_down = false;

   383

				_left_button_clicked = false;

   384

			}

   385

			HandleMouseEvents();

   386

			break;

   387

   388

		case 1:

   389

			if (down) {

   390

				_right_button_down = true;

   391

				_right_button_clicked = true;

   392

			} else {

   393

				_right_button_down = false;

   394

			}

   395

			HandleMouseEvents();

   396

			break;

   397

	}

   398

}

   399

   400

   401

   402

   403

static bool QZ_PollEvent()

   404

{

   405

	NSEvent *event;

   406

	NSPoint pt;

   407

	NSString *chars;

   408

#ifdef _DEBUG

   409

	uint32 et0, et;

   410

#endif

   411

   412

	assert(_cocoa_subdriver != NULL);

   413

   414

#ifdef _DEBUG

   415

	et0 = GetTick();

   416

#endif

   417

	event = [ NSApp nextEventMatchingMask:NSAnyEventMask

   418

			untilDate: [ NSDate distantPast ]

   419

			inMode: NSDefaultRunLoopMode dequeue:YES ];

   420

#ifdef _DEBUG

   421

	et = GetTick();

   422

	_tEvent+= et - et0;

   423

#endif

   424

   425

	if (event == nil) return false;

   426

	if (!_cocoa_subdriver->IsActive()) {

   427

		QZ_ShowMouse();

   428

		[NSApp sendEvent:event];

   429

		return true;

   430

	}

   431

   432

	QZ_DoUnsidedModifiers( [ event modifierFlags ] );

   433

   434

	switch ([event type]) {

   435

		case NSMouseMoved:

   436

		case NSOtherMouseDragged:

   437

		case NSLeftMouseDragged:

   438

			pt = _cocoa_subdriver->GetMouseLocation(event);

   439

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

   440

					!_emulating_right_button) {

   441

				QZ_ShowMouse();

   442

				[NSApp sendEvent:event];

   443

				break;

   444

			}

   445

   446

			QZ_HideMouse();

   447

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

   448

			break;

   449

   450

		case NSRightMouseDragged:

   451

			pt = _cocoa_subdriver->GetMouseLocation(event);

   452

			QZ_HideMouse();

   453

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

   454

			break;

   455

   456

		case NSLeftMouseDown:

   457

		{

   458

			uint32 keymask = 0;

   459

			if (_patches.right_mouse_btn_emulation == RMBE_COMMAND) keymask |= NSCommandKeyMask;

   460

			if (_patches.right_mouse_btn_emulation == RMBE_CONTROL) keymask |= NSControlKeyMask;

   461

   462

			pt = _cocoa_subdriver->GetMouseLocation(event);

   463

   464

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

   465

					!_cocoa_subdriver->MouseIsInsideView(&pt)) {

   466

				[NSApp sendEvent:event];

   467

			}

   468

   469

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

   470

				QZ_ShowMouse();

   471

				break;

   472

			}

   473

   474

			QZ_HideMouse();

   475

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

   476

   477

			/* Right mouse button emulation */

   478

			if ([ event modifierFlags ] & keymask) {

   479

				_emulating_right_button = true;

   480

				QZ_MouseButtonEvent(1, YES);

   481

			} else {

   482

				QZ_MouseButtonEvent(0, YES);

   483

			}

   484

			break;

   485

		}

   486

		case NSLeftMouseUp:

   487

			[NSApp sendEvent:event];

   488

   489

			pt = _cocoa_subdriver->GetMouseLocation(event);

   490

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

   491

				QZ_ShowMouse();

   492

				break;

   493

			}

   494

   495

			QZ_HideMouse();

   496

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

   497

   498

			/* Right mouse button emulation */

   499

			if (_emulating_right_button) {