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

#include <AvailabilityMacros.h>

    12

#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4)

    13

/* On 10.4, we get tons of warnings that the QuickDraw functions are deprecated.

    14

 *  We know that. Don't keep bugging us about that. */

    15

#	undef AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4

    16

#	define AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER

    17

#endif

    18

    19

#import <Cocoa/Cocoa.h>

    20

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

    21

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

    22

#import <unistd.h>

    23

    24

/**

    25

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

    26

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

    27

 * gdb has limitations.

    28

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

    29

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

    30

 */

    31

    32

    33

/* Portions of CPS.h */

    34

typedef struct CPSProcessSerNum {

    35

	UInt32 lo;

    36

	UInt32 hi;

    37

} CPSProcessSerNum;

    38

    39

extern "C" OSErr CPSGetCurrentProcess(CPSProcessSerNum* psn);

    40

extern "C" OSErr CPSEnableForegroundOperation(CPSProcessSerNum* psn, UInt32 _arg2, UInt32 _arg3, UInt32 _arg4, UInt32 _arg5);

    41

extern "C" OSErr CPSSetFrontProcess(CPSProcessSerNum* psn);

    42

    43

/* From Menus.h (according to Xcode Developer Documentation) */

    46

    47

/* Disables a warning. This is needed since the method exists but has been dropped from the header, supposedly as of 10.4. */

    48

#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4)

    49

@interface NSApplication(NSAppleMenu)

    50

- (void)setAppleMenu:(NSMenu *)menu;

    51

@end

    52

#endif

    53

    54

    55

/* Defined in ppc/param.h or i386/param.h included from sys/param.h */

    56

#undef ALIGN

    57

/* Defined in stdbool.h */

    58

#ifndef __cplusplus

    59

# ifndef __BEOS__

    60

#  undef bool

    61

#  undef false

    62

#  undef true

    63

# endif

    64

#endif

    65

    66

    67

#include "../stdafx.h"

    68

#include "../debug.h"

    69

#include "../macros.h"

    70

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

    71

#include "cocoa_v.h"

    72

#include "cocoa_keys.h"

    73

    74

#undef Point

    75

#undef Rect

    76

    77

/* Taken from ../gfx.h */

    78

extern bool _dbg_screen_rect;

    79

    80

    81

/* Subclass of NSWindow to fix genie effect and support resize events  */

    82

@interface OTTD_QuartzWindow : NSWindow

    83

- (void)miniaturize:(id)sender;

    84

- (void)display;

    85

- (void)setFrame:(NSRect)frameRect display:(BOOL)flag;

    86

- (void)appDidHide:(NSNotification*)note;

    87

- (void)appWillUnhide:(NSNotification*)note;

    88

- (void)appDidUnhide:(NSNotification*)note;

    89

- (id)initWithContentRect:(NSRect)contentRect styleMask:(unsigned int)styleMask backing:(NSBackingStoreType)backingType defer:(BOOL)flag;

    90

@end

    91

    92

/* Delegate for our NSWindow to send ask for quit on close */

    93

@interface OTTD_QuartzWindowDelegate : NSObject

    94

- (BOOL)windowShouldClose:(id)sender;

    95

@end

    96

    97

@interface OTTDMain : NSObject

    98

@end

    99

   100

   101

/* Structure for rez switch gamma fades

   102

 * We can hide the monitor flicker by setting the gamma tables to 0

   103

 */

   104

#define QZ_GAMMA_TABLE_SIZE 256

   105

   106

typedef struct {

   107

	CGGammaValue red[QZ_GAMMA_TABLE_SIZE];

   108

	CGGammaValue green[QZ_GAMMA_TABLE_SIZE];

   109

	CGGammaValue blue[QZ_GAMMA_TABLE_SIZE];

   110

} OTTD_QuartzGammaTable;

   111

   112

/* Add methods to get at private members of NSScreen.

   113

 * Since there is a bug in Apple's screen switching code that does not update

   114

 * this variable when switching to fullscreen, we'll set it manually (but only

   115

 * for the main screen).

   116

 */

   117

@interface NSScreen (NSScreenAccess)

   118

	- (void) setFrame:(NSRect)frame;

   119

@end

   120

   121

@implementation NSScreen (NSScreenAccess)

   122

- (void) setFrame:(NSRect)frame;

   123

{

   124

	_frame = frame;

   125

}

   126

@end

   127

   128

   131

static void QZ_UpdatePalette(uint start, uint count);

   132

static void QZ_WarpCursor(int x, int y);

   135

static void CocoaVideoFullScreen(bool full_screen);

   136

   137

   138

static NSAutoreleasePool *_ottd_autorelease_pool;

   139

static OTTDMain *_ottd_main;

   140

   141

   142

static struct CocoaVideoData {

   143

	bool isset;

   144

	bool issetting;

   145

   146

	CGDirectDisplayID  display_id;         /* 0 == main display (only support single display) */

   147

	CFDictionaryRef    mode;               /* current mode of the display */

   148

	CFDictionaryRef    save_mode;          /* original mode of the display */

   149

	CFArrayRef         mode_list;          /* list of available fullscreen modes */

   150

	CGDirectPaletteRef palette;            /* palette of an 8-bit display */

   151

   152

	uint32 device_width;

   153

	uint32 device_height;

   154

	uint32 device_bpp;

   155

   156

	void *realpixels;

   157

	uint8 *pixels;

   158

	uint32 width;

   159

	uint32 height;

   160

	uint32 pitch;

   161

	bool fullscreen;

   162

   163

	unsigned int current_mods;

   164

	bool tab_is_down;

   165

	bool emulating_right_button;

   166

   167

	bool cursor_visible;

   168

	bool active;

   169

   170

#ifdef _DEBUG

   171

	uint32 tEvent;

   172

#endif

   173

   174

	OTTD_QuartzWindow *window;

   175

	NSQuickDrawView *qdview;

   176

   177

#define MAX_DIRTY_RECTS 100

   178

	Rect dirty_rects[MAX_DIRTY_RECTS];

   179

	int num_dirty_rects;

   180

   181

	uint16 palette16[256];

   182

	uint32 palette32[256];

   183

} _cocoa_video_data;

   184

   185

static bool _cocoa_video_started = false;

   186

static bool _cocoa_video_dialog = false;

   187

   188

   189

   190

   191

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

   192

 *                             Game loop and accessories                      *

   193

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

   194

   196

{

   197

	struct timeval tim;

   198

   199

	gettimeofday(&tim, NULL);

   200

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

   201

}

   202

   204

{

   205

	if (_pal_last_dirty != -1) {

   206

		QZ_UpdatePalette(_pal_first_dirty, _pal_last_dirty - _pal_first_dirty + 1);

   207

		_pal_last_dirty = -1;

   208

	}

   209

}

   210

   211

   212

   213

typedef struct VkMapping {

   214

	unsigned short vk_from;

   215

	byte map_to;

   216

} VkMapping;

   217

   218

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

   219

   220

static const VkMapping _vk_mapping[] = {

   221

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

   222

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

   223

   224

	// Pageup stuff + up/down

   225

	//AM(SDLK_PAGEUP, SDLK_PAGEDOWN, WKC_PAGEUP, WKC_PAGEDOWN),  <==== Does this include HOME/END?

   226

	AS(QZ_PAGEUP,   WKC_PAGEUP),

   227

	AS(QZ_PAGEDOWN, WKC_PAGEDOWN),

   228

   229

	AS(QZ_UP,    WKC_UP),

   230

	AS(QZ_DOWN,  WKC_DOWN),

   231

	AS(QZ_LEFT,  WKC_LEFT),

   232

	AS(QZ_RIGHT, WKC_RIGHT),

   233

   234

	AS(QZ_HOME, WKC_HOME),

   235

	AS(QZ_END,  WKC_END),

   236

   237

	AS(QZ_INSERT, WKC_INSERT),

   238

	AS(QZ_DELETE, WKC_DELETE),

   239

   240

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

   241

	AS(QZ_a, 'A'),

   242

	AS(QZ_b, 'B'),

   243

	AS(QZ_c, 'C'),

   244

	AS(QZ_d, 'D'),

   245

	AS(QZ_e, 'E'),

   246

	AS(QZ_f, 'F'),

   247

	AS(QZ_g, 'G'),

   248

	AS(QZ_h, 'H'),

   249

	AS(QZ_i, 'I'),

   250

	AS(QZ_j, 'J'),

   251

	AS(QZ_k, 'K'),

   252

	AS(QZ_l, 'L'),

   253

	AS(QZ_m, 'M'),

   254

	AS(QZ_n, 'N'),

   255

	AS(QZ_o, 'O'),

   256

	AS(QZ_p, 'P'),

   257

	AS(QZ_q, 'Q'),

   258

	AS(QZ_r, 'R'),

   259

	AS(QZ_s, 'S'),

   260

	AS(QZ_t, 'T'),

   261

	AS(QZ_u, 'U'),

   262

	AS(QZ_v, 'V'),

   263

	AS(QZ_w, 'W'),

   264

	AS(QZ_x, 'X'),

   265

	AS(QZ_y, 'Y'),

   266

	AS(QZ_z, 'Z'),

   267

	// Same thing for digits

   268

	AS(QZ_0, '0'),

   269

	AS(QZ_1, '1'),

   270

	AS(QZ_2, '2'),

   271

	AS(QZ_3, '3'),

   272

	AS(QZ_4, '4'),

   273

	AS(QZ_5, '5'),

   274

	AS(QZ_6, '6'),

   275

	AS(QZ_7, '7'),

   276

	AS(QZ_8, '8'),

   277

	AS(QZ_9, '9'),

   278

   279

	AS(QZ_ESCAPE,    WKC_ESC),

   280

	AS(QZ_PAUSE,     WKC_PAUSE),

   281

	AS(QZ_BACKSPACE, WKC_BACKSPACE),

   282

   283

	AS(QZ_SPACE,  WKC_SPACE),

   284

	AS(QZ_RETURN, WKC_RETURN),

   285

	AS(QZ_TAB,    WKC_TAB),

   286

   287

	// Function keys

   288

	AS(QZ_F1,  WKC_F1),

   289

	AS(QZ_F2,  WKC_F2),

   290

	AS(QZ_F3,  WKC_F3),

   291

	AS(QZ_F4,  WKC_F4),

   292

	AS(QZ_F5,  WKC_F5),

   293

	AS(QZ_F6,  WKC_F6),

   294

	AS(QZ_F7,  WKC_F7),

   295

	AS(QZ_F8,  WKC_F8),

   296

	AS(QZ_F9,  WKC_F9),

   297

	AS(QZ_F10, WKC_F10),

   298

	AS(QZ_F11, WKC_F11),

   299

	AS(QZ_F12, WKC_F12),

   300

   301

	// Numeric part.

   302

	AS(QZ_KP0,         WKC_NUM_0),

   303

	AS(QZ_KP1,         WKC_NUM_1),

   304

	AS(QZ_KP2,         WKC_NUM_2),

   305

	AS(QZ_KP3,         WKC_NUM_3),

   306

	AS(QZ_KP4,         WKC_NUM_4),

   307

	AS(QZ_KP5,         WKC_NUM_5),

   308

	AS(QZ_KP6,         WKC_NUM_6),

   309

	AS(QZ_KP7,         WKC_NUM_7),

   310

	AS(QZ_KP8,         WKC_NUM_8),

   311

	AS(QZ_KP9,         WKC_NUM_9),

   312

	AS(QZ_KP_DIVIDE,   WKC_NUM_DIV),

   313

	AS(QZ_KP_MULTIPLY, WKC_NUM_MUL),

   314

	AS(QZ_KP_MINUS,    WKC_NUM_MINUS),

   315

	AS(QZ_KP_PLUS,     WKC_NUM_PLUS),

   316

	AS(QZ_KP_ENTER,    WKC_NUM_ENTER),

   317

	AS(QZ_KP_PERIOD,   WKC_NUM_DECIMAL)

   318

};

   319

   320

   321

static uint32 QZ_MapKey(unsigned short sym)

   322

{

   323

	const VkMapping *map;

   324

	uint32 key = 0;

   325

   326

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

   327

		if (sym == map->vk_from) {

   328

			key = map->map_to;

   329

			break;

   330

		}

   331

	}

   332

   333

	if (_cocoa_video_data.current_mods & NSShiftKeyMask)     key |= WKC_SHIFT;

   334

	if (_cocoa_video_data.current_mods & NSControlKeyMask)   key |= WKC_CTRL;

   335

	if (_cocoa_video_data.current_mods & NSAlternateKeyMask) key |= WKC_ALT;

   336

	if (_cocoa_video_data.current_mods & NSCommandKeyMask)   key |= WKC_META;

   337

   338

	return key << 16;

   339

}

   340

   341

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

   342

{

   343

	switch (keycode) {

   344

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

   345

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

   346

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

   347

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

   348

   349

		case QZ_TAB: _cocoa_video_data.tab_is_down = down; break;

   350

   351

		case QZ_RETURN:

   352

		case QZ_f:

   353

			if (down && (_cocoa_video_data.current_mods & NSCommandKeyMask)) {

   354

				CocoaVideoFullScreen(!_fullscreen);

   355

			}

   356

			break;

   357

	}

   358

   359

	if (down) {

   360

		uint32 pressed_key = QZ_MapKey(keycode) | unicode;

   361

		HandleKeypress(pressed_key);

   362

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

   363

	} else {

   364

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

   365

	}

   366

}

   367

   368

static void QZ_DoUnsidedModifiers(unsigned int newMods)

   369

{

   370

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

   371

   372

	int i;

   373

	unsigned int bit;

   374

   375

	if (_cocoa_video_data.current_mods == newMods) return;

   376

   377

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

   378

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

   379

		unsigned int currentMask, newMask;

   380

   381

		currentMask = _cocoa_video_data.current_mods & bit;

   382

		newMask     = newMods & bit;

   383

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

		}

   393

	}

   394

   395

	_cocoa_video_data.current_mods = newMods;

   396

}

   397

   398

static void QZ_MouseMovedEvent(int x, int y)

   399

{

   400

	if (_cursor.fix_at) {

   401

		int dx = x - _cursor.pos.x;

   402

		int dy = y - _cursor.pos.y;

   403

   404

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

   405

			_cursor.delta.x += dx;

   406

			_cursor.delta.y += dy;

   407

   408

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

   409

		}

   410

	} else {

   411

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

   412

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

   413

		_cursor.pos.x = x;

   414

		_cursor.pos.y = y;

   415

		_cursor.dirty = true;

   416

	}

   417

	HandleMouseEvents();

   418

}

   419

   420

   421

static void QZ_MouseButtonEvent(int button, BOOL down)

   422

{

   423

	switch (button) {

   424

		case 0:

   425

			if (down) {

   426

				_left_button_down = true;

   427

			} else {

   428

				_left_button_down = false;

   429

				_left_button_clicked = false;

   430

			}

   431

			HandleMouseEvents();

   432

			break;

   433

   434

		case 1:

   435

			if (down) {

   436

				_right_button_down = true;

   437

				_right_button_clicked = true;

   438

			} else {

   439

				_right_button_down = false;

   440

			}

   441

			HandleMouseEvents();

   442

			break;

   443

	}

   444

}

   445

   446

   447

static inline NSPoint QZ_GetMouseLocation(NSEvent *event)

   448

{

   449

	NSPoint pt;

   450

   451

	if (_cocoa_video_data.fullscreen) {

   452

		pt = [ NSEvent mouseLocation ];

   453

		pt.y = _cocoa_video_data.height - pt.y;

   454

	} else {

   455

		pt = [event locationInWindow];

   456

		pt = [_cocoa_video_data.qdview convertPoint:pt fromView:nil];

   457

	}

   458

   459

	return pt;

   460

}

   461

   462

static bool QZ_MouseIsInsideView(NSPoint *pt)

   463

{

   464

	if (_cocoa_video_data.fullscreen) {

   465

		return pt->x >= 0 && pt->y >= 0 && pt->x < _cocoa_video_data.width && pt->y < _cocoa_video_data.height;

   466

	} else {

   467

		return [ _cocoa_video_data.qdview mouse:*pt inRect:[ _cocoa_video_data.qdview bounds ] ];

   468

	}

   469

}

   470

   471

   473

{

   474

	NSEvent *event;

   475

	NSPoint pt;

   476

	NSString *chars;

   477

#ifdef _DEBUG

   478

	uint32 et0, et;

   479

#endif

   480

   481

#ifdef _DEBUG

   482

	et0 = GetTick();

   483

#endif

   484

	event = [ NSApp nextEventMatchingMask:NSAnyEventMask

   485

			untilDate: [ NSDate distantPast ]

   486

			inMode: NSDefaultRunLoopMode dequeue:YES ];

   487

#ifdef _DEBUG

   488

	et = GetTick();

   489

	_cocoa_video_data.tEvent+= et - et0;

   490

#endif

   491

   492

	if (event == nil) return false;

   493

	if (!_cocoa_video_data.active) {

   494

		QZ_ShowMouse();

   495

		[NSApp sendEvent:event];

   496

		return true;

   497

	}

   498

   499

	QZ_DoUnsidedModifiers( [ event modifierFlags ] );

   500

   501

	switch ([event type]) {

   502

		case NSMouseMoved:

   503

		case NSOtherMouseDragged:

   504

		case NSRightMouseDragged:

   505

		case NSLeftMouseDragged:

   506

			pt = QZ_GetMouseLocation(event);

   507

			if (!QZ_MouseIsInsideView(&pt) &&

   508

					!_cocoa_video_data.emulating_right_button) {

   509

				QZ_ShowMouse();

   510

				[NSApp sendEvent:event];

   511

				break;

   512

			}

   513

   514

			QZ_HideMouse();

   515

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

   516

			break;

   517

   518

		case NSLeftMouseDown:

   519

			pt = QZ_GetMouseLocation(event);

   520

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

   521

					!QZ_MouseIsInsideView(&pt)) {

   522

				[NSApp sendEvent:event];

   523

			}

   524

   525

			if (!QZ_MouseIsInsideView(&pt)) {

   526

				QZ_ShowMouse();

   527

				break;