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

struct CPSProcessSerNum {

    35

	UInt32 lo;

    36

	UInt32 hi;

    37

};

    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) */

    44

extern "C" void ShowMenuBar();

    45

extern "C" void HideMenuBar();

    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 "../openttd.h"

    69

#include "../debug.h"

    70

#include "../macros.h"

    71

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

    72

#include "../variables.h"

    73

#include "../gfx.h"

    74

#include "cocoa_v.h"

    75

#include "cocoa_keys.h"

    76

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

    77

#include "../fileio.h"

    78

    79

#undef Point

    80

#undef Rect

    81

    90

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

    91

@interface OTTD_QuartzWindow : NSWindow

    92

- (void)miniaturize:(id)sender;

    93

- (void)display;

    94

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

    95

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

    96

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

    97

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

    98

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

    99

@end

   100

   101

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

   102

@interface OTTD_QuartzWindowDelegate : NSObject

   103

- (BOOL)windowShouldClose:(id)sender;

   104

@end

   105

   106

@interface OTTDMain : NSObject

   107

@end

   108

   109

   110

/* Structure for rez switch gamma fades

   111

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

   112

 */

   113

#define QZ_GAMMA_TABLE_SIZE 256

   114

   115

struct OTTD_QuartzGammaTable {

   116

	CGGammaValue red[QZ_GAMMA_TABLE_SIZE];

   117

	CGGammaValue green[QZ_GAMMA_TABLE_SIZE];

   118

	CGGammaValue blue[QZ_GAMMA_TABLE_SIZE];

   119

};

   120

   121

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

   122

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

   123

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

   124

 * for the main screen).

   125

 */

   126

@interface NSScreen (NSScreenAccess)

   127

	- (void) setFrame:(NSRect)frame;

   128

@end

   129

   130

@implementation NSScreen (NSScreenAccess)

   131

- (void) setFrame:(NSRect)frame;

   132

{

   133

	_frame = frame;

   134

}

   135

@end

   136

   137

   138

static void QZ_Draw();

   139

static void QZ_UnsetVideoMode();

   140

static void QZ_UpdatePalette(uint start, uint count);

   141

static void QZ_WarpCursor(int x, int y);

   142

static void QZ_ShowMouse();

   143

static void QZ_HideMouse();

   144

   145

   146

static NSAutoreleasePool *_ottd_autorelease_pool;

   147

static OTTDMain *_ottd_main;

   148

   149

   150

static struct CocoaVideoData {

   151

	bool isset;

   152

	bool issetting;

   153

   154

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

   155

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

   156

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

   157

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

   158

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

   159

   160

	uint32 device_width;

   161

	uint32 device_height;

   162

	uint32 device_bpp;

   163

   164

	void *realpixels;

   165

	uint8 *pixels;

   166

	uint32 width;

   167

	uint32 height;

   168

	uint32 pitch;

   169

	bool fullscreen;

   170

   171

	unsigned int current_mods;

   172

	bool tab_is_down;

   173

	bool emulating_right_button;

   174

   175

	bool cursor_visible;

   176

	bool active;

   177

   178

#ifdef _DEBUG

   179

	uint32 tEvent;

   180

#endif

   181

   182

	OTTD_QuartzWindow *window;

   183

	NSQuickDrawView *qdview;

   184

   185

#define MAX_DIRTY_RECTS 100

   186

	Rect dirty_rects[MAX_DIRTY_RECTS];

   187

	int num_dirty_rects;

   188

   189

	uint16 palette16[256];

   190

	uint32 palette32[256];

   191

} _cocoa_video_data;

   192

   193

static bool _cocoa_video_started = false;

   194

static bool _cocoa_video_dialog = false;

   195

   196

   197

   198

   199

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

   200

 *                             Game loop and accessories                      *

   201

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

   202

   203

static uint32 GetTick()

   204

{

   205

	struct timeval tim;

   206

   207

	gettimeofday(&tim, NULL);

   208

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

   209

}

   210

   211

static void QZ_CheckPaletteAnim()

   212

{

   213

	if (_pal_count_dirty != 0) {

   214

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   215

   216

		switch (blitter->UsePaletteAnimation()) {

   217

			case Blitter::PALETTE_ANIMATION_VIDEO_BACKEND:

   218

				QZ_UpdatePalette(_pal_first_dirty, _pal_count_dirty);

   219

				break;

   220

   221

			case Blitter::PALETTE_ANIMATION_BLITTER:

   222

				blitter->PaletteAnimate(_pal_first_dirty, _pal_count_dirty);

   223

				break;

   224

   225

			case Blitter::PALETTE_ANIMATION_NONE:

   226

				break;

   227

   228

			default:

   229

				NOT_REACHED();

   230

		}

   231

		_pal_count_dirty = 0;

   232

	}

   233

}

   234

   235

   236

   237

struct VkMapping {

   238

	unsigned short vk_from;

   239

	byte map_to;

   240

};

   241

   242

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

   243

   244

static const VkMapping _vk_mapping[] = {

   245

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

   246

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

   247

   248

	/* Pageup stuff + up/down */

   249

	AS(QZ_PAGEUP,   WKC_PAGEUP),

   250

	AS(QZ_PAGEDOWN, WKC_PAGEDOWN),

   251

   252

	AS(QZ_UP,    WKC_UP),

   253

	AS(QZ_DOWN,  WKC_DOWN),

   254

	AS(QZ_LEFT,  WKC_LEFT),

   255

	AS(QZ_RIGHT, WKC_RIGHT),

   256

   257

	AS(QZ_HOME, WKC_HOME),

   258

	AS(QZ_END,  WKC_END),

   259

   260

	AS(QZ_INSERT, WKC_INSERT),

   261

	AS(QZ_DELETE, WKC_DELETE),

   262

   263

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

   264

	AS(QZ_a, 'A'),

   265

	AS(QZ_b, 'B'),

   266

	AS(QZ_c, 'C'),

   267

	AS(QZ_d, 'D'),

   268

	AS(QZ_e, 'E'),

   269

	AS(QZ_f, 'F'),

   270

	AS(QZ_g, 'G'),

   271

	AS(QZ_h, 'H'),

   272

	AS(QZ_i, 'I'),

   273

	AS(QZ_j, 'J'),

   274

	AS(QZ_k, 'K'),

   275

	AS(QZ_l, 'L'),

   276

	AS(QZ_m, 'M'),

   277

	AS(QZ_n, 'N'),

   278

	AS(QZ_o, 'O'),

   279

	AS(QZ_p, 'P'),

   280

	AS(QZ_q, 'Q'),

   281

	AS(QZ_r, 'R'),

   282

	AS(QZ_s, 'S'),

   283

	AS(QZ_t, 'T'),

   284

	AS(QZ_u, 'U'),

   285

	AS(QZ_v, 'V'),

   286

	AS(QZ_w, 'W'),

   287

	AS(QZ_x, 'X'),

   288

	AS(QZ_y, 'Y'),

   289

	AS(QZ_z, 'Z'),

   290

	/* Same thing for digits */

   291

	AS(QZ_0, '0'),

   292

	AS(QZ_1, '1'),

   293

	AS(QZ_2, '2'),

   294

	AS(QZ_3, '3'),

   295

	AS(QZ_4, '4'),

   296

	AS(QZ_5, '5'),

   297

	AS(QZ_6, '6'),

   298

	AS(QZ_7, '7'),

   299

	AS(QZ_8, '8'),

   300

	AS(QZ_9, '9'),

   301

   302

	AS(QZ_ESCAPE,    WKC_ESC),

   303

	AS(QZ_PAUSE,     WKC_PAUSE),

   304

	AS(QZ_BACKSPACE, WKC_BACKSPACE),

   305

   306

	AS(QZ_SPACE,  WKC_SPACE),

   307

	AS(QZ_RETURN, WKC_RETURN),

   308

	AS(QZ_TAB,    WKC_TAB),

   309

   310

	/* Function keys */

   311

	AS(QZ_F1,  WKC_F1),

   312

	AS(QZ_F2,  WKC_F2),

   313

	AS(QZ_F3,  WKC_F3),

   314

	AS(QZ_F4,  WKC_F4),

   315

	AS(QZ_F5,  WKC_F5),

   316

	AS(QZ_F6,  WKC_F6),

   317

	AS(QZ_F7,  WKC_F7),

   318

	AS(QZ_F8,  WKC_F8),

   319

	AS(QZ_F9,  WKC_F9),

   320

	AS(QZ_F10, WKC_F10),

   321

	AS(QZ_F11, WKC_F11),

   322

	AS(QZ_F12, WKC_F12),

   323

   324

	/* Numeric part */

   325

	AS(QZ_KP0,         WKC_NUM_0),

   326

	AS(QZ_KP1,         WKC_NUM_1),

   327

	AS(QZ_KP2,         WKC_NUM_2),

   328

	AS(QZ_KP3,         WKC_NUM_3),

   329

	AS(QZ_KP4,         WKC_NUM_4),

   330

	AS(QZ_KP5,         WKC_NUM_5),

   331

	AS(QZ_KP6,         WKC_NUM_6),

   332

	AS(QZ_KP7,         WKC_NUM_7),

   333

	AS(QZ_KP8,         WKC_NUM_8),

   334

	AS(QZ_KP9,         WKC_NUM_9),

   335

	AS(QZ_KP_DIVIDE,   WKC_NUM_DIV),

   336

	AS(QZ_KP_MULTIPLY, WKC_NUM_MUL),

   337

	AS(QZ_KP_MINUS,    WKC_NUM_MINUS),

   338

	AS(QZ_KP_PLUS,     WKC_NUM_PLUS),

   339

	AS(QZ_KP_ENTER,    WKC_NUM_ENTER),

   340

	AS(QZ_KP_PERIOD,   WKC_NUM_DECIMAL),

   341

   342

	/* Other non-letter keys */

   343

	AS(QZ_SLASH,        WKC_SLASH),

   344

	AS(QZ_SEMICOLON,    WKC_SEMICOLON),

   345

	AS(QZ_EQUALS,       WKC_EQUALS),

   346

	AS(QZ_LEFTBRACKET,  WKC_L_BRACKET),

   347

	AS(QZ_BACKSLASH,    WKC_BACKSLASH),

   348

	AS(QZ_RIGHTBRACKET, WKC_R_BRACKET),

   349

   350

	AS(QZ_QUOTE,   WKC_SINGLEQUOTE),

   351

	AS(QZ_COMMA,   WKC_COMMA),

   352

	AS(QZ_MINUS,   WKC_MINUS),

   353

	AS(QZ_PERIOD,  WKC_PERIOD)

   354

};

   355

   356

   357

static uint32 QZ_MapKey(unsigned short sym)

   358

{

   359

	const VkMapping *map;

   360

	uint32 key = 0;

   361

   362

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

   363

		if (sym == map->vk_from) {

   364

			key = map->map_to;

   365

			break;

   366

		}

   367

	}

   368

   369

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

   371

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

   373

   374

	return key << 16;

   375

}

   376

   377

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

   378

{

   379

	switch (keycode) {

   380

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

   381

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

   382

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

   383

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

   384

   385

		case QZ_TAB: _cocoa_video_data.tab_is_down = down; break;

   386

   387

		case QZ_RETURN:

   388

		case QZ_f:

   389

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

   390

				_video_driver->ToggleFullscreen(!_fullscreen);

   391

			}

   392

			break;

   393

	}

   394

   395

	if (down) {

   396

		uint32 pressed_key = QZ_MapKey(keycode) | unicode;

   397

		HandleKeypress(pressed_key);

   398

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

   399

	} else {

   400

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

   401

	}

   402

}

   403

   404

static void QZ_DoUnsidedModifiers(unsigned int newMods)

   405

{

   406

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

   407

   408

	int i;

   409

	unsigned int bit;

   410

   411

	if (_cocoa_video_data.current_mods == newMods) return;

   412

   413

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

   414

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

   415

		unsigned int currentMask, newMask;

   416

   417

		currentMask = _cocoa_video_data.current_mods & bit;

   418

		newMask     = newMods & bit;

   419

   420

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

   421

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

   422

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

   423

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

   424

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

   425

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

   426

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

   427

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

   428

		}

   429

	}

   430

   431

	_cocoa_video_data.current_mods = newMods;

   432

}

   433

   434

static void QZ_MouseMovedEvent(int x, int y)

   435

{

   436

	if (_cursor.fix_at) {

   437

		int dx = x - _cursor.pos.x;

   438

		int dy = y - _cursor.pos.y;

   439

   440

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

   441

			_cursor.delta.x += dx;

   442

			_cursor.delta.y += dy;

   443

   444

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

   445

		}

   446

	} else {

   447

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

   448

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

   449

		_cursor.pos.x = x;

   450

		_cursor.pos.y = y;

   451

		_cursor.dirty = true;

   452

	}

   453

	HandleMouseEvents();

   454

}

   455

   456

   457

static void QZ_MouseButtonEvent(int button, BOOL down)

   458

{

   459

	switch (button) {

   460

		case 0:

   461

			if (down) {

   462

				_left_button_down = true;

   463

			} else {

   464

				_left_button_down = false;

   465

				_left_button_clicked = false;

   466

			}

   467

			HandleMouseEvents();

   468

			break;

   469

   470

		case 1:

   471

			if (down) {

   472

				_right_button_down = true;

   473

				_right_button_clicked = true;

   474

			} else {

   475

				_right_button_down = false;

   476

			}

   477

			HandleMouseEvents();

   478

			break;

   479

	}

   480

}

   481

   482

   483

static inline NSPoint QZ_GetMouseLocation(NSEvent *event)

   484

{

   485

	NSPoint pt;

   486

   487

	if (_cocoa_video_data.fullscreen) {

   488

		pt = [ NSEvent mouseLocation ];

   489

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

   490

	} else {

   491

		pt = [event locationInWindow];

   492

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

   493

	}

   494

   495

	return pt;

   496

}

   497

   498

static bool QZ_MouseIsInsideView(NSPoint *pt)

   499

{

   500

	if (_cocoa_video_data.fullscreen) {

   501

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

   502

	} else {

   503

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

   504

	}