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

/* Portions of CPS.h */

    29

struct CPSProcessSerNum {

    30

	UInt32 lo;

    31

	UInt32 hi;

    32

};

    33

    34

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

    35

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

    36

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

    37

    38

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

    39

#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4)

    40

@interface NSApplication(NSAppleMenu)

    41

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

    42

@end

    43

#endif

    44

    45

    46

/* Defined in stdbool.h */

    47

#ifndef __cplusplus

    48

# ifndef __BEOS__

    49

#  undef bool

    50

#  undef false

    51

#  undef true

    52

# endif

    53

#endif

    54

    55

    56

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

    57

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

    58

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

    59

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

    60

#include "cocoa_v.h"

    61

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

    62

#include "../../fileio.h"

    63

    64

#undef Point

    65

#undef Rect

    66

    67

    68

@interface OTTDMain : NSObject

    69

@end

    70

    71

    72

static NSAutoreleasePool *_ottd_autorelease_pool;

    73

static OTTDMain *_ottd_main;

    74

static bool _cocoa_video_started = false;

    75

static bool _cocoa_video_dialog = false;

    76

    77

CocoaSubdriver* _cocoa_subdriver = NULL;

    78

    79

    80

    81

/* The main class of the application, the application's delegate */

    82

@implementation OTTDMain

    83

/* Called when the internal event loop has just started running */

    84

- (void) applicationDidFinishLaunching: (NSNotification*) note

    85

{

    86

	/* Hand off to main application code */

    87

	QZ_GameLoop();

    88

    89

	/* We're done, thank you for playing */

    90

	[ NSApp stop:_ottd_main ];

    91

}

    92

    93

/* Display the in game quit confirmation dialog */

    94

- (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication*) sender

    95

{

    96

    97

	HandleExitGameRequest();

    98

    99

	return NSTerminateCancel; // NSTerminateLater ?

   100

}

   101

@end

   102

   103

static void setApplicationMenu()

   104

{

   105

	/* warning: this code is very odd */

   106

	NSMenu *appleMenu;

   107

	NSMenuItem *menuItem;

   108

	NSString *title;

   109

	NSString *appName;

   110

   111

	appName = @"OTTD";

   112

	appleMenu = [[NSMenu alloc] initWithTitle:appName];

   113

   114

	/* Add menu items */

   115

	title = [@"About " stringByAppendingString:appName];

   116

	[appleMenu addItemWithTitle:title action:@selector(orderFrontStandardAboutPanel:) keyEquivalent:@""];

   117

   118

	[appleMenu addItem:[NSMenuItem separatorItem]];

   119

   120

	title = [@"Hide " stringByAppendingString:appName];

   121

	[appleMenu addItemWithTitle:title action:@selector(hide:) keyEquivalent:@"h"];

   122

   123

	menuItem = (NSMenuItem*)[appleMenu addItemWithTitle:@"Hide Others" action:@selector(hideOtherApplications:) keyEquivalent:@"h"];

   124

	[menuItem setKeyEquivalentModifierMask:(NSAlternateKeyMask|NSCommandKeyMask)];

   125

   126

	[appleMenu addItemWithTitle:@"Show All" action:@selector(unhideAllApplications:) keyEquivalent:@""];

   127

   128

	[appleMenu addItem:[NSMenuItem separatorItem]];

   129

   130

	title = [@"Quit " stringByAppendingString:appName];

   131

	[appleMenu addItemWithTitle:title action:@selector(terminate:) keyEquivalent:@"q"];

   132

   133

   134

	/* Put menu into the menubar */

   135

	menuItem = [[NSMenuItem alloc] initWithTitle:@"" action:nil keyEquivalent:@""];

   136

	[menuItem setSubmenu:appleMenu];

   137

	[[NSApp mainMenu] addItem:menuItem];

   138

   139

	/* Tell the application object that this is now the application menu */

   140

	[NSApp setAppleMenu:appleMenu];

   141

   142

	/* Finally give up our references to the objects */

   143

	[appleMenu release];

   144

	[menuItem release];

   145

}

   146

   147

/* Create a window menu */

   148

static void setupWindowMenu()

   149

{

   150

	NSMenu* windowMenu;

   151

	NSMenuItem* windowMenuItem;

   152

	NSMenuItem* menuItem;

   153

   154

	windowMenu = [[NSMenu alloc] initWithTitle:@"Window"];

   155

   156

	/* "Minimize" item */

   157

	menuItem = [[NSMenuItem alloc] initWithTitle:@"Minimize" action:@selector(performMiniaturize:) keyEquivalent:@"m"];

   158

	[windowMenu addItem:menuItem];

   159

	[menuItem release];

   160

   161

	/* Put menu into the menubar */

   162

	windowMenuItem = [[NSMenuItem alloc] initWithTitle:@"Window" action:nil keyEquivalent:@""];

   163

	[windowMenuItem setSubmenu:windowMenu];

   164

	[[NSApp mainMenu] addItem:windowMenuItem];

   165

   166

	/* Tell the application object that this is now the window menu */

   167

	[NSApp setWindowsMenu:windowMenu];

   168

   169

	/* Finally give up our references to the objects */

   170

	[windowMenu release];

   171

	[windowMenuItem release];

   172

}

   173

   174

static void setupApplication()

   175

{

   176

	CPSProcessSerNum PSN;

   177

   178

	/* Ensure the application object is initialised */

   179

	[NSApplication sharedApplication];

   180

   181

	/* Tell the dock about us */

   182

	if (!CPSGetCurrentProcess(&PSN) &&

   183

			!CPSEnableForegroundOperation(&PSN, 0x03, 0x3C, 0x2C, 0x1103) &&

   184

			!CPSSetFrontProcess(&PSN)) {

   185

		[NSApplication sharedApplication];

   186

	}

   187

   188

	/* Set up the menubar */

   189

	[NSApp setMainMenu:[[NSMenu alloc] init]];

   190

	setApplicationMenu();

   191

	setupWindowMenu();

   192

   193

	/* Create OTTDMain and make it the app delegate */

   194

	_ottd_main = [[OTTDMain alloc] init];

   195

	[NSApp setDelegate:_ottd_main];

   196

}

   197

   198

   199

static void QZ_UpdateVideoModes()

   200

{

   201

	uint i, count;

   202

	OTTDPoint modes[32];

   203

   204

	assert(_cocoa_subdriver != NULL);

   205

   206

	count = _cocoa_subdriver->ListModes(modes, lengthof(modes));

   207

   208

	for (i = 0; i < count; i++) {

   209

		_resolutions[i][0] = modes[i].x;

   210

		_resolutions[i][1] = modes[i].y;

   211

	}

   212

   213

	_num_resolutions = count;

   214

}

   215

   216

   217

void QZ_GameSizeChanged()

   218

{

   219

	if (_cocoa_subdriver == NULL) return;

   220

   221

	/* Tell the game that the resolution has changed */

   222

	_screen.width = _cocoa_subdriver->GetWidth();

   223

	_screen.height = _cocoa_subdriver->GetHeight();

   224

	_screen.pitch = _cocoa_subdriver->GetWidth();

   225

	_fullscreen = _cocoa_subdriver->IsFullscreen();

   226

   227

	GameSizeChanged();

   228

}

   229

   230

   231

static CocoaSubdriver *QZ_CreateWindowSubdriver(int width, int height, int bpp)

   232

{

   233

	CocoaSubdriver *ret;

   234

   236

	if (MacOSVersionIsAtLeast(10, 4, 0)) {

   237

		ret = QZ_CreateWindowQuartzSubdriver(width, height, bpp);

   238

		if (ret != NULL) return ret;

   239

	}

   241

   242

	ret = QZ_CreateWindowQuickdrawSubdriver(width, height, bpp);

   243

	if (ret != NULL) return ret;

   244

   245

	return NULL;

   246

}

   247

   248

   249

static CocoaSubdriver *QZ_CreateSubdriver(int width, int height, int bpp, bool fullscreen, bool fallback)

   250

{

   251

	CocoaSubdriver *ret;

   252

   253

	ret = fullscreen ? QZ_CreateFullscreenSubdriver(width, height, bpp) : QZ_CreateWindowSubdriver(width, height, bpp);

   254

	if (ret != NULL) return ret;

   255

   256

	if (!fallback) return NULL;

   257

   258

	/* Try again in 640x480 windowed */

   259

	DEBUG(driver, 0, "Setting video mode failed, falling back to 640x480 windowed mode.");

   260

	ret = QZ_CreateWindowSubdriver(640, 480, bpp);

   261

	if (ret != NULL) return ret;

   262

   263

#ifdef _DEBUG

   264

	/* Try fullscreen too when in debug mode */

   265

	DEBUG(driver, 0, "Setting video mode failed, falling back to 640x480 fullscreen mode.");

   266

	ret = QZ_CreateFullscreenSubdriver(640, 480, bpp);

   267

	if (ret != NULL) return ret;

   268

#endif

   269

   270

	return NULL;

   271

}

   272

   273

   274

static FVideoDriver_Cocoa iFVideoDriver_Cocoa;

   275

   276

void VideoDriver_Cocoa::Stop()

   277

{

   278

	if (!_cocoa_video_started) return;

   279

   280

	delete _cocoa_subdriver;

   281

	_cocoa_subdriver = NULL;

   282

   283

	[_ottd_main release];

   284

   285

	_cocoa_video_started = false;

   286

}

   287

   288

const char *VideoDriver_Cocoa::Start(const char * const *parm)

   289

{

   290

	int width, height, bpp;

   291

   292

	if (!MacOSVersionIsAtLeast(10, 3, 0)) return "The Cocoa video driver requires Mac OS X 10.3 or later.";

   293

   294

	if (_cocoa_video_started) return "Already started";

   295

	_cocoa_video_started = true;

   296

   297

	setupApplication();

   298

   299

	/* Don't create a window or enter fullscreen if we're just going to show a dialog. */

   300

	if (_cocoa_video_dialog) return NULL;

   301

   302

	width = _cur_resolution[0];

   303

	height = _cur_resolution[1];

   304

	bpp = BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth();

   305

   306

	_cocoa_subdriver = QZ_CreateSubdriver(width, height, bpp, _fullscreen, true);

   307

	if (_cocoa_subdriver == NULL) {

   308

		Stop();

   309

		return "Could not create subdriver";

   310

	}

   311

   312

	QZ_GameSizeChanged();

   313

   314

	QZ_UpdateVideoModes();

   315

   316

	return NULL;

   317

}

   318

   319

void VideoDriver_Cocoa::MakeDirty(int left, int top, int width, int height)

   320

{

   321

	assert(_cocoa_subdriver != NULL);

   322

   323

	_cocoa_subdriver->MakeDirty(left, top, width, height);

   324

}

   325

   326

void VideoDriver_Cocoa::MainLoop()

   327

{

   328

	/* Start the main event loop */

   329

	[NSApp run];

   330

}

   331

   332

bool VideoDriver_Cocoa::ChangeResolution(int w, int h)

   333

{

   334

	bool ret;

   335

   336

	assert(_cocoa_subdriver != NULL);

   337

   338

	ret = _cocoa_subdriver->ChangeResolution(w, h);

   339

   340

	QZ_GameSizeChanged();

   341

   342

	QZ_UpdateVideoModes();

   343

   344

	return ret;

   345

}

   346

   347

void VideoDriver_Cocoa::ToggleFullscreen(bool full_screen)

   348

{

   349

	bool oldfs;

   350

   351

	assert(_cocoa_subdriver != NULL);

   352

   353

	oldfs = _cocoa_subdriver->IsFullscreen();

   354

	if (full_screen != oldfs) {

   355

		int width  = _cocoa_subdriver->GetWidth();

   356

		int height = _cocoa_subdriver->GetHeight();

   357

		int bpp    = BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth();

   358

   359

		delete _cocoa_subdriver;

   360

		_cocoa_subdriver = NULL;

   361

   362

		_cocoa_subdriver = QZ_CreateSubdriver(width, height, bpp, full_screen, false);

   363

		if (_cocoa_subdriver == NULL) {

   364

			_cocoa_subdriver = QZ_CreateSubdriver(width, height, bpp, oldfs, true);

   365

			if (_cocoa_subdriver == NULL) error("Cocoa: Failed to create subdriver");

   366

		}

   367

	}

   368

   369

	QZ_GameSizeChanged();

   370

   371

	QZ_UpdateVideoModes();

   372

}

   373

   374

   375

/* This is needed since sometimes assert is called before the videodriver is initialized */

   376

void CocoaDialog(const char* title, const char* message, const char* buttonLabel)

   377

{

   378

	bool wasstarted;

   379

   380

	_cocoa_video_dialog = true;

   381

   382

	wasstarted = _cocoa_video_started;

   383

	if (_video_driver == NULL) {

   384

		setupApplication(); // Setup application before showing dialog

   385

	} else if (!_cocoa_video_started && _video_driver->Start(NULL) != NULL) {

   386

		fprintf(stderr, "%s: %s\n", title, message);

   387

		return;

   388

	}

   389

   390

	NSRunAlertPanel([NSString stringWithCString: title], [NSString stringWithCString: message], [NSString stringWithCString: buttonLabel], nil, nil);

   391

   392

	if (!wasstarted && _video_driver != NULL) _video_driver->Stop();

   393

   394

	_cocoa_video_dialog = false;

   395

}

   396

   397

/* This is needed since OS X application bundles do not have a

   398

 * current directory and the data files are 'somewhere' in the bundle */

   399

void cocoaSetApplicationBundleDir()

   400

{

   401

	char tmp[MAXPATHLEN];

   402

	CFURLRef url = CFBundleCopyResourcesDirectoryURL(CFBundleGetMainBundle());

   403

	if (CFURLGetFileSystemRepresentation(url, true, (unsigned char*)tmp, MAXPATHLEN)) {

   404

		AppendPathSeparator(tmp, lengthof(tmp));

   405

		_searchpaths[SP_APPLICATION_BUNDLE_DIR] = strdup(tmp);

   406

	} else {

   407

		_searchpaths[SP_APPLICATION_BUNDLE_DIR] = NULL;

   408

	}

   409

   410

	CFRelease(url);

   411

}

   412

   413

/* These are called from main() to prevent a _NSAutoreleaseNoPool error when

   414

 * exiting before the cocoa video driver has been loaded

   415

 */

   416

void cocoaSetupAutoreleasePool()

   417

{

   418

	_ottd_autorelease_pool = [[NSAutoreleasePool alloc] init];

   419

}

   420

   421

void cocoaReleaseAutoreleasePool()

   422

{

   423

	[_ottd_autorelease_pool release];

   424

}

   425

   426

#endif /* WITH_COCOA */