OSDN Git Service

Fixed up the formatting of more multi-line comments.
[hengbandforosx/hengbandosx.git] / src / main-cocoa.m
1 /**
2  * \file main-cocoa.m
3  * \brief OS X front end
4  *
5  * Copyright (c) 2011 Peter Ammon
6  *
7  * This work is free software; you can redistribute it and/or modify it
8  * under the terms of either:
9  *
10  * a) the GNU General Public License as published by the Free Software
11  *    Foundation, version 2, or
12  *
13  * b) the "Angband licence":
14  *    This software may be copied and distributed for educational, research,
15  *    and not for profit purposes provided that this copyright and statement
16  *    are included in all such copies.  Other copyrights may also apply.
17  */
18
19 #include "angband.h"
20 /* This is not included in angband.h in Hengband. */
21 #include "grafmode.h"
22
23 #if defined(MACH_O_COCOA)
24
25 /* Mac headers */
26 #import "cocoa/AppDelegate.h"
27 //#include <Carbon/Carbon.h> /* For keycodes */
28 /* Hack - keycodes to enable compiling in macOS 10.14 */
29 #define kVK_Return 0x24
30 #define kVK_Tab    0x30
31 #define kVK_Delete 0x33
32 #define kVK_Escape 0x35
33 #define kVK_ANSI_KeypadEnter 0x4C
34
35 static NSString * const AngbandDirectoryNameLib = @"lib";
36 static NSString * const AngbandDirectoryNameBase = @VERSION_NAME;
37
38 static NSString * const AngbandMessageCatalog = @"Localizable";
39 static NSString * const AngbandTerminalsDefaultsKey = @"Terminals";
40 static NSString * const AngbandTerminalRowsDefaultsKey = @"Rows";
41 static NSString * const AngbandTerminalColumnsDefaultsKey = @"Columns";
42 static NSString * const AngbandTerminalVisibleDefaultsKey = @"Visible";
43 static NSString * const AngbandGraphicsDefaultsKey = @"GraphicsID";
44 static NSString * const AngbandBigTileDefaultsKey = @"UseBigTiles";
45 static NSString * const AngbandFrameRateDefaultsKey = @"FramesPerSecond";
46 static NSString * const AngbandSoundDefaultsKey = @"AllowSound";
47 static NSInteger const AngbandWindowMenuItemTagBase = 1000;
48 static NSInteger const AngbandCommandMenuItemTagBase = 2000;
49
50 /* Global defines etc from Angband 3.5-dev - NRM */
51 #define ANGBAND_TERM_MAX 8
52
53 #define MAX_COLORS 256
54 #define MSG_MAX SOUND_MAX
55
56 /* End Angband stuff - NRM */
57
58 /* Application defined event numbers */
59 enum
60 {
61     AngbandEventWakeup = 1
62 };
63
64 /* Delay handling of pre-emptive "quit" event */
65 static BOOL quit_when_ready = FALSE;
66
67 /* Set to indicate the game is over and we can quit without delay */
68 static Boolean game_is_finished = FALSE;
69
70 /* Our frames per second (e.g. 60). A value of 0 means unthrottled. */
71 static int frames_per_second;
72
73 /* Force a new game or not? */
74 static bool new_game = FALSE;
75
76 @class AngbandView;
77
78 #ifdef JP
79 static wchar_t convert_two_byte_eucjp_to_utf16_native(const char *cp);
80 #endif
81
82 /**
83  * Load sound effects based on sound.cfg within the xtra/sound directory;
84  * bridge to Cocoa to use NSSound for simple loading and playback, avoiding
85  * I/O latency by caching all sounds at the start.  Inherits full sound
86  * format support from Quicktime base/plugins.
87  * pelpel favoured a plist-based parser for the future but .cfg support
88  * improves cross-platform compatibility.
89  */
90 @interface AngbandSoundCatalog : NSObject {
91 @private
92     /**
93      * Stores instances of NSSound keyed by path so the same sound can be
94      * used for multiple events.
95      */
96     NSMutableDictionary *soundsByPath;
97     /**
98      * Stores arrays of NSSound keyed by event number.
99      */
100     NSMutableDictionary *soundArraysByEvent;
101 }
102
103 /**
104  * If NO, then playSound effectively becomes a do nothing operation.
105  */
106 @property (getter=isEnabled) BOOL enabled;
107
108 /**
109  * Set up for lazy initialization in playSound().  Set enabled to NO.
110  */
111 - (id)init;
112
113 /**
114  * If self.enabled is YES and the given event has one or more sounds
115  * corresponding to it in the catalog, plays one of those sounds, chosen at
116  * random.
117  */
118 - (void)playSound:(int)event;
119
120 /**
121  * Impose an arbitrary limit on the number of possible samples per event.
122  * Currently not declaring this as a class property for compatibility with
123  * versions of Xcode prior to 8.
124  */
125 + (int)maxSamples;
126
127 /**
128  * Return the shared sound catalog instance, creating it if it does not
129  * exist yet.  Currently not declaring this as a class property for
130  * compatibility with versions of Xcode prior to 8.
131  */
132 + (AngbandSoundCatalog*)sharedSounds;
133
134 /**
135  * Release any resources associated with shared sounds.
136  */
137 + (void)clearSharedSounds;
138
139 @end
140
141 @implementation AngbandSoundCatalog
142
143 - (id)init {
144     if (self = [super init]) {
145         self->soundsByPath = nil;
146         self->soundArraysByEvent = nil;
147         self->_enabled = NO;
148     }
149     return self;
150 }
151
152 - (void)playSound:(int)event {
153     if (! self.enabled) {
154         return;
155     }
156
157     /* Initialize when the first sound is played. */
158     if (self->soundArraysByEvent == nil) {
159         /* Build the "sound" path */
160         char sound_dir[1024];
161         path_build(sound_dir, sizeof(sound_dir), ANGBAND_DIR_XTRA, "sound");
162
163         /* Find and open the config file */
164         char path[1024];
165         path_build(path, sizeof(path), sound_dir, "sound.cfg");
166         FILE *fff = my_fopen(path, "r");
167
168         /* Handle errors */
169         if (!fff) {
170             NSLog(@"The sound configuration file could not be opened.");
171             return;
172         }
173
174         self->soundsByPath = [[NSMutableDictionary alloc] init];
175         self->soundArraysByEvent = [[NSMutableDictionary alloc] init];
176         @autoreleasepool {
177             /*
178              * This loop may take a while depending on the count and size of
179              * samples to load.
180              */
181
182             /* Parse the file */
183             /* Lines are always of the form "name = sample [sample ...]" */
184             char buffer[2048];
185             while (my_fgets(fff, buffer, sizeof(buffer)) == 0) {
186                 char *msg_name;
187                 char *cfg_sample_list;
188                 char *search;
189                 char *cur_token;
190                 char *next_token;
191                 int event;
192
193                 /* Skip anything not beginning with an alphabetic character */
194                 if (!buffer[0] || !isalpha((unsigned char)buffer[0])) continue;
195
196                 /* Split the line into two: message name, and the rest */
197                 search = strchr(buffer, ' ');
198                 cfg_sample_list = strchr(search + 1, ' ');
199                 if (!search) continue;
200                 if (!cfg_sample_list) continue;
201
202                 /* Set the message name, and terminate at first space */
203                 msg_name = buffer;
204                 search[0] = '\0';
205
206                 /* Make sure this is a valid event name */
207                 for (event = MSG_MAX - 1; event >= 0; event--) {
208                     if (strcmp(msg_name, angband_sound_name[event]) == 0)
209                         break;
210                 }
211                 if (event < 0) continue;
212
213                 /*
214                  * Advance the sample list pointer so it's at the beginning of
215                  * text.
216                  */
217                 cfg_sample_list++;
218                 if (!cfg_sample_list[0]) continue;
219
220                 /* Terminate the current token */
221                 cur_token = cfg_sample_list;
222                 search = strchr(cur_token, ' ');
223                 if (search) {
224                     search[0] = '\0';
225                     next_token = search + 1;
226                 } else {
227                     next_token = NULL;
228                 }
229
230                 /*
231                  * Now we find all the sample names and add them one by one
232                  */
233                 while (cur_token) {
234                     NSMutableArray *soundSamples =
235                         [self->soundArraysByEvent
236                              objectForKey:[NSNumber numberWithInteger:event]];
237                     if (soundSamples == nil) {
238                         soundSamples = [[NSMutableArray alloc] init];
239                         [self->soundArraysByEvent
240                              setObject:soundSamples
241                              forKey:[NSNumber numberWithInteger:event]];
242                     }
243                     int num = (int) soundSamples.count;
244
245                     /* Don't allow too many samples */
246                     if (num >= [AngbandSoundCatalog maxSamples]) break;
247
248                     NSString *token_string =
249                         [NSString stringWithUTF8String:cur_token];
250                     NSSound *sound =
251                         [self->soundsByPath objectForKey:token_string];
252
253                     if (! sound) {
254                         /*
255                          * We have to load the sound. Build the path to the
256                          * sample.
257                          */
258                         path_build(path, sizeof(path), sound_dir, cur_token);
259                         struct stat stb;
260                         if (stat(path, &stb) == 0) {
261                             /* Load the sound into memory */
262                             sound = [[NSSound alloc]
263                                          initWithContentsOfFile:[NSString stringWithUTF8String:path]
264                                          byReference:YES];
265                             if (sound) {
266                                 [self->soundsByPath setObject:sound
267                                             forKey:token_string];
268                             }
269                         }
270                     }
271
272                     /* Store it if we loaded it */
273                     if (sound) {
274                         [soundSamples addObject:sound];
275                     }
276
277                     /* Figure out next token */
278                     cur_token = next_token;
279                     if (next_token) {
280                          /* Try to find a space */
281                          search = strchr(cur_token, ' ');
282
283                          /*
284                           * If we can find one, terminate, and set new "next".
285                           */
286                          if (search) {
287                              search[0] = '\0';
288                              next_token = search + 1;
289                          } else {
290                              /* Otherwise prevent infinite looping */
291                              next_token = NULL;
292                          }
293                     }
294                 }
295             }
296         }
297
298         /* Close the file */
299         my_fclose(fff);
300     }
301
302     @autoreleasepool {
303         NSMutableArray *samples =
304             [self->soundArraysByEvent
305                  objectForKey:[NSNumber numberWithInteger:event]];
306
307         if (samples == nil || samples.count == 0) {
308             return;
309         }
310
311         /* Choose a random event. */
312         int s = randint0((int) samples.count);
313         NSSound *sound = samples[s];
314
315         if ([sound isPlaying])
316             [sound stop];
317
318         /* Play the sound. */
319         [sound play];
320     }
321 }
322
323 + (int)maxSamples {
324     return 16;
325 }
326
327 /**
328  * For sharedSounds and clearSharedSounds.
329  */
330 static __strong AngbandSoundCatalog* gSharedSounds = nil;
331
332 + (AngbandSoundCatalog*)sharedSounds {
333     if (gSharedSounds == nil) {
334         gSharedSounds = [[AngbandSoundCatalog alloc] init];
335     }
336     return gSharedSounds;
337 }
338
339 + (void)clearSharedSounds {
340     gSharedSounds = nil;
341 }
342
343 @end
344
345 /**
346  * Each location in the terminal either stores a character, a tile,
347  * padding for a big tile, or padding for a big character (for example a
348  * kanji that takes two columns).  These structures represent that.  Note
349  * that tiles do not overlap with each other (excepting the double-height
350  * tiles, i.e. from the Shockbolt set; that's handled as a special case).
351  * Characters can overlap horizontally:  that is for handling fonts that
352  * aren't fixed width.
353  */
354 struct TerminalCellChar {
355     wchar_t glyph;
356     int attr;
357 };
358 struct TerminalCellTile {
359     /*
360      * These are the coordinates, within the tile set, for the foreground
361      * tile and background tile.
362      */
363     char fgdCol, fgdRow, bckCol, bckRow;
364 };
365 struct TerminalCellPadding {
366        /*
367         * If the cell at (x, y) is padding, the cell at (x - hoff, y - voff)
368         * has the attributes affecting the padded region.
369         */
370     unsigned char hoff, voff;
371 };
372 struct TerminalCell {
373     union {
374         struct TerminalCellChar ch;
375         struct TerminalCellTile ti;
376         struct TerminalCellPadding pd;
377     } v;
378     /*
379      * Used for big characters or tiles which are hscl x vscl cells.
380      * The upper left corner of the big tile or character is marked as
381      * TERM_CELL_TILE or TERM_CELL_CHAR.  The remainder are marked as
382      * TERM_CELL_TILE_PADDING or TERM_CELL_CHAR_PADDING and have hscl and
383      * vscl set to matcn what's in the upper left corner.  Big tiles are
384      * tiles scaled up to occupy more space.  Big characters, on the other
385      * hand, are characters that naturally take up more space than standard
386      * for the font with the assumption that vscl will be one for any big
387      * character and hscl will hold the number of columns it occupies (likely
388      * just 2, i.e. for Japanese kanji).
389      */
390     unsigned char hscl;
391     unsigned char vscl;
392     /*
393      * Hold the offsets, as fractions of the tile size expressed as the
394      * rational numbers hoff_n / hoff_d and voff_n / voff_d, within the tile
395      * or character.  For something that is not a big tile or character, these
396      * will be 0, 0, 1, and 1.  For a big tile or character, these will be
397      * set when the tile or character is changed to be 0, 0, hscl, and vscl
398      * for the upper left corner and i, j, hscl, vscl for the padding element
399      * at (i, j) relative to the upper left corner.  For a big tile or
400      * character that is partially overwritten, these are not modified in the
401      * parts that are not overwritten while hscl, vscl, and, for padding,
402      * v.pd.hoff and v.pd.voff are.
403      */
404     unsigned char hoff_n;
405     unsigned char voff_n;
406     unsigned char hoff_d;
407     unsigned char voff_d;
408     /*
409      * Is either TERM_CELL_CHAR, TERM_CELL_CHAR_PADDING, TERM_CELL_TILE, or
410      * TERM_CELL_TILE_PADDING.
411      */
412     unsigned char form;
413 };
414 #define TERM_CELL_CHAR (0x1)
415 #define TERM_CELL_CHAR_PADDING (0x2)
416 #define TERM_CELL_TILE (0x4)
417 #define TERM_CELL_TILE_PADDING (0x8)
418
419 struct TerminalCellBlock {
420     int ulcol, ulrow, w, h;
421 };
422
423 struct TerminalCellLocation {
424     int col, row;
425 };
426
427 typedef int (*TerminalCellPredicate)(const struct TerminalCell*);
428
429 static int isTileTop(const struct TerminalCell *c)
430 {
431     return (c->form == TERM_CELL_TILE ||
432             (c->form == TERM_CELL_TILE_PADDING && c->v.pd.voff == 0)) ? 1 : 0;
433 }
434
435 static int isPartiallyOverwrittenBigChar(const struct TerminalCell *c)
436 {
437     if ((c->form & (TERM_CELL_CHAR | TERM_CELL_CHAR_PADDING)) != 0) {
438         /*
439          * When the tile is set in Term_pict_cocoa, hoff_d is the same as hscl
440          * and voff_d is the same as vscl.  hoff_d and voff_d aren't modified
441          * after that, but hscl and vscl are in response to partial overwrites.
442          * If they're diffent, an overwrite has occurred.
443          */
444         return ((c->hoff_d > 1 || c->voff_d > 1) &&
445                 (c->hoff_d != c->hscl || c->voff_d != c->vscl)) ? 1 : 0;
446     }
447     return 0;
448 }
449
450 static int isCharNoPartial(const struct TerminalCell *c)
451 {
452     return ((c->form & (TERM_CELL_CHAR | TERM_CELL_CHAR_PADDING)) != 0 &&
453             ! isPartiallyOverwrittenBigChar(c)) ? 1 : 0;
454 }
455
456 /**
457  * Since the drawing is decoupled from Angband's calls to the text_hook,
458  * pict_hook, wipe_hook, curs_hook, and bigcurs_hook callbacks of a terminal,
459  * maintain a version of the Terminal contents.
460  */
461 @interface TerminalContents : NSObject {
462 @private
463     struct TerminalCell *cells;
464 }
465
466 /**
467  * Initialize with zero columns and zero rows.
468  */
469 - (id)init;
470
471 /**
472  * Initialize with nCol columns and nRow rows.  All elements will be set to
473  * blanks.
474  */
475 - (id)initWithColumns:(int)nCol rows:(int)nRow NS_DESIGNATED_INITIALIZER;
476
477 /**
478  * Resize to be nCol by nRow.  Current contents still within the new bounds
479  * are preserved.  Added areas are filled with blanks.
480  */
481 - (void)resizeWithColumns:(int)nCol rows:(int)nRow;
482
483 /**
484  * Get the contents of a given cell.
485  */
486 - (const struct TerminalCell*)getCellAtColumn:(int)icol row:(int)irow;
487
488 /**
489  * Scans the row, irow, starting at the column, icol0, and stopping before the
490  * column, icol1.  Returns the column index for the first cell that's within
491  * the given type mask, tm.  If all of the cells in that range are not within
492  * the given type mask, returns icol1.
493  */
494 - (int)scanForTypeMaskInRow:(int)irow mask:(unsigned int)tm col0:(int)icol0
495                        col1:(int)icol1;
496
497 /**
498  * Scans the w x h block whose upper left corner is at (icol, irow).  The
499  * scan starts at (icol + pcurs->col, irow + pcurs->row) and proceeds from
500  * left to right and top to bottom.  At exit, pcurs will have the location
501  * (relative to icol, irow) of the first cell encountered that's within the
502  * given type mask, tm.  If no such cell was found, pcurs->col will be w
503  * and pcurs->row will be h.
504  */
505 - (void)scanForTypeMaskInBlockAtColumn:(int)icol row:(int)irow width:(int)w
506                                 height:(int)h mask:(unsigned int)tm
507                                 cursor:(struct TerminalCellLocation*)pcurs;
508
509 /**
510  * Scans the row, irow, starting at the column, icol0, and stopping before the
511  * column, icol1.  Returns the column index for the first cell that
512  * func(cell_address) != rval.  If all of the cells in the range satisfy the
513  * predicate, returns icol1.
514  */
515 - (int)scanForPredicateInRow:(int)irow
516                    predicate:(TerminalCellPredicate)func
517                      desired:(int)rval
518                         col0:(int)icol0
519                         col1:(int)icol1;
520
521 /**
522  * Change the contents to have the given string of n characters appear with
523  * the leftmost character at (icol, irow).
524  */
525 - (void)setUniformAttributeTextRunAtColumn:(int)icol
526                                        row:(int)irow
527                                          n:(int)n
528                                     glyphs:(const char*)g
529                                  attribute:(int)a;
530
531 /**
532  * Change the contents to have a tile scaled to w x h appear with its upper
533  * left corner at (icol, irow).
534  */
535 - (void)setTileAtColumn:(int)icol
536                     row:(int)irow
537        foregroundColumn:(char)fgdCol
538           foregroundRow:(char)fgdRow
539        backgroundColumn:(char)bckCol
540           backgroundRow:(char)bckRow
541               tileWidth:(int)w
542              tileHeight:(int)h;
543
544 /**
545  * Wipe the w x h block whose upper left corner is at (icol, irow).
546  */
547 - (void)wipeBlockAtColumn:(int)icol row:(int)irow width:(int)w height:(int)h;
548
549 /**
550  * Wipe all the contents.
551  */
552 - (void)wipe;
553
554 /**
555  * Wipe any tiles.
556  */
557 - (void)wipeTiles;
558
559 /**
560  * Thie is a helper function for wipeBlockAtColumn.
561  */
562 - (void)wipeBlockAuxAtColumn:(int)icol row:(int)irow width:(int)w
563                       height:(int)h;
564
565 /**
566  * This is a helper function for checkForBigStuffOverwriteAtColumn.
567  */
568 - (void) splitBlockAtColumn:(int)icol row:(int)irow n:(int)nsub
569                      blocks:(const struct TerminalCellBlock*)b;
570
571 /**
572  * This is a helper function for setUniformAttributeTextRunAtColumn,
573  * setTileAtColumn, and wipeBlockAtColumn.  If a modification could partially
574  * overwrite a big character or tile, make adjustments so what's left can
575  * be handled appropriately in rendering.
576  */
577 - (void)checkForBigStuffOverwriteAtColumn:(int)icol row:(int)irow
578                                     width:(int)w height:(int)h;
579
580 /**
581  * Position the upper left corner of the cursor at (icol, irow) and have it
582  * encompass w x h cells.
583  */
584 - (void)setCursorAtColumn:(int)icol row:(int)irow width:(int)w height:(int)h;
585
586 /**
587  * Remove the cursor.  cursorColumn and cursorRow will be -1 until
588  * setCursorAtColumn is called.
589  */
590 - (void)removeCursor;
591
592 /**
593  * Verify that everying is consistent.
594  */
595 - (void)assertInvariants;
596
597 /**
598  * Is the number of columns.
599  */
600 @property (readonly) int columnCount;
601
602 /**
603  * Is the number of rows.
604  */
605 @property (readonly) int rowCount;
606
607 /**
608  * Is the column index for the upper left corner of the cursor.  It will be -1
609  * if the cursor is disabled.
610  */
611 @property (readonly) int cursorColumn;
612
613 /**
614  * Is the row index for the upper left corner of the cursor.  It will be -1
615  * if the cursor is disabled.
616  */
617 @property (readonly) int cursorRow;
618
619 /**
620  * Is the cursor width in number of cells.
621  */
622 @property (readonly) int cursorWidth;
623
624 /**
625  * Is the cursor height in number of cells.
626  */
627 @property (readonly) int cursorHeight;
628
629 /**
630  * Return the character to be used for blanks.
631  */
632 + (wchar_t)getBlankChar;
633
634 /**
635  * Return the attribute to be used for blanks.
636  */
637 + (int)getBlankAttribute;
638
639 @end
640
641 @implementation TerminalContents
642
643 - (id)init
644 {
645     return [self initWithColumns:0 rows:0];
646 }
647
648 - (id)initWithColumns:(int)nCol rows:(int)nRow
649 {
650     if (self = [super init]) {
651         self->cells = malloc(nCol * nRow * sizeof(struct TerminalCell));
652         self->_columnCount = nCol;
653         self->_rowCount = nRow;
654         self->_cursorColumn = -1;
655         self->_cursorRow = -1;
656         self->_cursorWidth = 1;
657         self->_cursorHeight = 1;
658         [self wipe];
659     }
660     return self;
661 }
662
663 - (void)dealloc
664 {
665     if (self->cells != 0) {
666         free(self->cells);
667         self->cells = 0;
668     }
669 }
670
671 - (void)resizeWithColumns:(int)nCol rows:(int)nRow
672 {
673     /*
674      * Potential issue: big tiles or characters can become clipped by the
675      * resize.  That will only matter if drawing occurs before the contents
676      * are updated by Angband.  Even then, unless the drawing mode is used
677      * where AppKit doesn't clip to the window bounds, the only artifact will
678      * be clipping when drawn which is acceptable and doesn't require
679      * additional logic to either filter out the clipped big stuff here or
680      * to just clear it when drawing.
681      */
682     struct TerminalCell *newCells =
683         malloc(nCol * nRow * sizeof(struct TerminalCell));
684     struct TerminalCell *cellsOutCursor = newCells;
685     const struct TerminalCell *cellsInCursor = self->cells;
686     int nColCommon = (nCol < self.columnCount) ? nCol : self.columnCount;
687     int nRowCommon = (nRow < self.rowCount) ? nRow : self.rowCount;
688     wchar_t blank = [TerminalContents getBlankChar];
689     int blank_attr = [TerminalContents getBlankAttribute];
690     int i;
691
692     for (i = 0; i < nRowCommon; ++i) {
693         (void) memcpy(
694             cellsOutCursor,
695             cellsInCursor,
696             nColCommon * sizeof(struct TerminalCell));
697         cellsInCursor += self.columnCount;
698         for (int j = nColCommon; j < nCol; ++j) {
699             cellsOutCursor[j].v.ch.glyph = blank;
700             cellsOutCursor[j].v.ch.attr = blank_attr;
701             cellsOutCursor[j].hscl = 1;
702             cellsOutCursor[j].vscl = 1;
703             cellsOutCursor[j].hoff_n = 0;
704             cellsOutCursor[j].voff_n = 0;
705             cellsOutCursor[j].hoff_d = 1;
706             cellsOutCursor[j].voff_d = 1;
707             cellsOutCursor[j].form = TERM_CELL_CHAR;
708         }
709         cellsOutCursor += nCol;
710     }
711     while (cellsOutCursor != newCells + nCol * nRow) {
712         cellsOutCursor->v.ch.glyph = blank;
713         cellsOutCursor->v.ch.attr = blank_attr;
714         cellsOutCursor->hscl = 1;
715         cellsOutCursor->vscl = 1;
716         cellsOutCursor->hoff_n = 0;
717         cellsOutCursor->voff_n = 0;
718         cellsOutCursor->hoff_d = 1;
719         cellsOutCursor->voff_d = 1;
720         cellsOutCursor->form = TERM_CELL_CHAR;
721         ++cellsOutCursor;
722     }
723
724     free(self->cells);
725     self->cells = newCells;
726     self->_columnCount = nCol;
727     self->_rowCount = nRow;
728     if (self->_cursorColumn >= nCol || self->_cursorRow >= nRow) {
729         self->_cursorColumn = -1;
730         self->_cursorRow = -1;
731     } else {
732         if (self->_cursorColumn + self->_cursorWidth > nCol) {
733             self->_cursorWidth = nCol - self->_cursorColumn;
734         }
735         if (self->_cursorRow + self->_cursorHeight > nRow) {
736             self->_cursorHeight = nRow - self->_cursorRow;
737         }
738     }
739 }
740
741 - (const struct TerminalCell*)getCellAtColumn:(int)icol row:(int)irow
742 {
743     return self->cells + icol + irow * self.columnCount;
744 }
745
746 - (int)scanForTypeMaskInRow:(int)irow mask:(unsigned int)tm col0:(int)icol0
747                        col1:(int)icol1
748 {
749     int i = icol0;
750     const struct TerminalCell *cellsRow =
751         self->cells + irow * self.columnCount;
752
753     while (1) {
754         if (i >= icol1) {
755             return icol1;
756         }
757         if ((cellsRow[i].form & tm) != 0) {
758             return i;
759         }
760         ++i;
761     }
762 }
763
764 - (void)scanForTypeMaskInBlockAtColumn:(int)icol row:(int)irow width:(int)w
765                                 height:(int)h mask:(unsigned int)tm
766                                 cursor:(struct TerminalCellLocation*)pcurs
767 {
768     const struct TerminalCell *cellsRow =
769         self->cells + (irow + pcurs->row) * self.columnCount;
770     while (1) {
771         if (pcurs->col == w) {
772             if (pcurs->row >= h - 1) {
773                 pcurs->row = h;
774                 return;
775             }
776             ++pcurs->row;
777             pcurs->col = 0;
778             cellsRow += self.columnCount;
779         }
780
781         if ((cellsRow[icol + pcurs->col].form & tm) != 0) {
782             return;
783         }
784
785         ++pcurs->col;
786     }
787 }
788
789 - (int)scanForPredicateInRow:(int)irow
790                    predicate:(TerminalCellPredicate)func
791                      desired:(int)rval
792                         col0:(int)icol0
793                         col1:(int)icol1
794 {
795     int i = icol0;
796     const struct TerminalCell *cellsRow =
797         self->cells + irow * self.columnCount;
798
799     while (1) {
800         if (i >= icol1) {
801             return icol1;
802         }
803         if (func(cellsRow + i) != rval) {
804             return i;
805         }
806         ++i;
807     }
808 }
809
810 - (void)setUniformAttributeTextRunAtColumn:(int)icol
811                                        row:(int)irow
812                                          n:(int)n
813                                     glyphs:(const char*)g
814                                  attribute:(int)a
815 {
816     [self checkForBigStuffOverwriteAtColumn:icol row:irow width:n height:1];
817
818     struct TerminalCell *cellsRow = self->cells + irow * self.columnCount;
819     int i = icol;
820
821     while (i < icol + n) {
822 #ifdef JP
823         if (iskanji(*g)) {
824             if (i == n - 1) {
825                 /*
826                  * The second byte of the character is past the end.  Ignore
827                  * the character.
828                  */
829                 break;
830             }
831             cellsRow[i].v.ch.glyph = convert_two_byte_eucjp_to_utf16_native(g);
832             cellsRow[i].v.ch.attr = a;
833             cellsRow[i].hscl = 2;
834             cellsRow[i].vscl = 1;
835             cellsRow[i].hoff_n = 0;
836             cellsRow[i].voff_n = 0;
837             cellsRow[i].hoff_d = 2;
838             cellsRow[i].voff_d = 1;
839             cellsRow[i].form = TERM_CELL_CHAR;
840             ++i;
841             cellsRow[i].v.pd.hoff = 1;
842             cellsRow[i].v.pd.voff = 0;
843             cellsRow[i].hscl = 2;
844             cellsRow[i].vscl = 1;
845             cellsRow[i].hoff_n = 1;
846             cellsRow[i].voff_n = 0;
847             cellsRow[i].hoff_d = 2;
848             cellsRow[i].voff_d = 1;
849             cellsRow[i].form = TERM_CELL_CHAR_PADDING;
850             ++i;
851             g += 2;
852         } else {
853             cellsRow[i].v.ch.glyph = *g++;
854             cellsRow[i].v.ch.attr = a;
855             cellsRow[i].hscl = 1;
856             cellsRow[i].vscl = 1;
857             cellsRow[i].hoff_n = 0;
858             cellsRow[i].voff_n = 0;
859             cellsRow[i].hoff_d = 1;
860             cellsRow[i].voff_d = 1;
861             cellsRow[i].form = TERM_CELL_CHAR;
862             ++i;
863         }
864 #else
865         cellsRow[i].v.ch.glyph = *g++;
866         cellsRow[i].v.ch.attr = a;
867         cellsRow[i].hscl = 1;
868         cellsRow[i].vscl = 1;
869         cellsRow[i].hoff_n = 0;
870         cellsRow[i].voff_n = 0;
871         cellsRow[i].hoff_d = 1;
872         cellsRow[i].voff_d = 1;
873         cellsRow[i].form = TERM_CELL_CHAR;
874         ++i;
875 #endif /* JP */
876     }
877 }
878
879 - (void)setTileAtColumn:(int)icol
880                     row:(int)irow
881        foregroundColumn:(char)fgdCol
882           foregroundRow:(char)fgdRow
883        backgroundColumn:(char)bckCol
884           backgroundRow:(char)bckRow
885               tileWidth:(int)w
886              tileHeight:(int)h
887 {
888     [self checkForBigStuffOverwriteAtColumn:icol row:irow width:w height:h];
889
890     struct TerminalCell *cellsRow = self->cells + irow * self.columnCount;
891
892     cellsRow[icol].v.ti.fgdCol = fgdCol;
893     cellsRow[icol].v.ti.fgdRow = fgdRow;
894     cellsRow[icol].v.ti.bckCol = bckCol;
895     cellsRow[icol].v.ti.bckRow = bckRow;
896     cellsRow[icol].hscl = w;
897     cellsRow[icol].vscl = h;
898     cellsRow[icol].hoff_n = 0;
899     cellsRow[icol].voff_n = 0;
900     cellsRow[icol].hoff_d = w;
901     cellsRow[icol].voff_d = h;
902     cellsRow[icol].form = TERM_CELL_TILE;
903
904     int ic;
905     for (ic = icol + 1; ic < icol + w; ++ic) {
906         cellsRow[ic].v.pd.hoff = ic - icol;
907         cellsRow[ic].v.pd.voff = 0;
908         cellsRow[ic].hscl = w;
909         cellsRow[ic].vscl = h;
910         cellsRow[ic].hoff_n = ic - icol;
911         cellsRow[ic].voff_n = 0;
912         cellsRow[ic].hoff_d = w;
913         cellsRow[ic].voff_d = h;
914         cellsRow[ic].form = TERM_CELL_TILE_PADDING;
915     }
916     cellsRow += self.columnCount;
917     for (int ir = irow + 1; ir < irow + h; ++ir) {
918         for (ic = icol; ic < icol + w; ++ic) {
919             cellsRow[ic].v.pd.hoff = ic - icol;
920             cellsRow[ic].v.pd.voff = ir - irow;
921             cellsRow[ic].hscl = w;
922             cellsRow[ic].vscl = h;
923             cellsRow[ic].hoff_n = ic - icol;
924             cellsRow[ic].voff_n = ir - irow;
925             cellsRow[ic].hoff_d = w;
926             cellsRow[ic].voff_d = h;
927             cellsRow[ic].form = TERM_CELL_TILE_PADDING;
928         }
929         cellsRow += self.columnCount;
930     }
931 }
932
933 - (void)wipeBlockAtColumn:(int)icol row:(int)irow width:(int)w height:(int)h
934 {
935     [self checkForBigStuffOverwriteAtColumn:icol row:irow width:w height:h];
936     [self wipeBlockAuxAtColumn:icol row:irow width:w height:h];
937 }
938
939 - (void)wipe
940 {
941     wchar_t blank = [TerminalContents getBlankChar];
942     int blank_attr = [TerminalContents getBlankAttribute];
943     struct TerminalCell *cellCursor = self->cells +
944         self.columnCount * self.rowCount;
945
946     while (cellCursor != self->cells) {
947         --cellCursor;
948         cellCursor->v.ch.glyph = blank;
949         cellCursor->v.ch.attr = blank_attr;
950         cellCursor->hscl = 1;
951         cellCursor->vscl = 1;
952         cellCursor->hoff_n = 0;
953         cellCursor->voff_n = 0;
954         cellCursor->hoff_d = 1;
955         cellCursor->voff_d = 1;
956         cellCursor->form = TERM_CELL_CHAR;
957     }
958 }
959
960 - (void)wipeTiles
961 {
962     wchar_t blank = [TerminalContents getBlankChar];
963     int blank_attr = [TerminalContents getBlankAttribute];
964     struct TerminalCell *cellCursor = self->cells +
965         self.columnCount * self.rowCount;
966
967     while (cellCursor != self->cells) {
968         --cellCursor;
969         if ((cellCursor->form &
970              (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
971             cellCursor->v.ch.glyph = blank;
972             cellCursor->v.ch.attr = blank_attr;
973             cellCursor->hscl = 1;
974             cellCursor->vscl = 1;
975             cellCursor->hoff_n = 0;
976             cellCursor->voff_n = 0;
977             cellCursor->hoff_d = 1;
978             cellCursor->voff_d = 1;
979             cellCursor->form = TERM_CELL_CHAR;
980         }
981     }
982 }
983
984 - (void)wipeBlockAuxAtColumn:(int)icol row:(int)irow width:(int)w
985                       height:(int)h
986 {
987     struct TerminalCell *cellsRow = self->cells + irow * self.columnCount;
988     wchar_t blank = [TerminalContents getBlankChar];
989     int blank_attr = [TerminalContents getBlankAttribute];
990
991     for (int ir = irow; ir < irow + h; ++ir) {
992         for (int ic = icol; ic < icol + w; ++ic) {
993             cellsRow[ic].v.ch.glyph = blank;
994             cellsRow[ic].v.ch.attr = blank_attr;
995             cellsRow[ic].hscl = 1;
996             cellsRow[ic].vscl = 1;
997             cellsRow[ic].hoff_n = 0;
998             cellsRow[ic].voff_n = 0;
999             cellsRow[ic].hoff_d = 1;
1000             cellsRow[ic].voff_d = 1;
1001             cellsRow[ic].form = TERM_CELL_CHAR;
1002         }
1003         cellsRow += self.columnCount;
1004     }
1005 }
1006
1007 - (void) splitBlockAtColumn:(int)icol row:(int)irow n:(int)nsub
1008                      blocks:(const struct TerminalCellBlock*)b
1009 {
1010     const struct TerminalCell *pulold = [self getCellAtColumn:icol row:irow];
1011
1012     for (int isub = 0; isub < nsub; ++isub) {
1013         struct TerminalCell* cellsRow =
1014             self->cells + b[isub].ulrow * self.columnCount;
1015
1016         /*
1017          * Copy the data from the upper left corner of the big block to
1018          * the upper left corner of the piece.
1019          */
1020         if (b[isub].ulcol != icol || b[isub].ulrow != irow) {
1021             if (pulold->form == TERM_CELL_CHAR) {
1022                 cellsRow[b[isub].ulcol].v.ch = pulold->v.ch;
1023                 cellsRow[b[isub].ulcol].form = TERM_CELL_CHAR;
1024             } else {
1025                 cellsRow[b[isub].ulcol].v.ti = pulold->v.ti;
1026                 cellsRow[b[isub].ulcol].form = TERM_CELL_TILE;
1027             }
1028         }
1029         cellsRow[b[isub].ulcol].hscl = b[isub].w;
1030         cellsRow[b[isub].ulcol].vscl = b[isub].h;
1031
1032         /*
1033          * Point the padding elements in the piece to the new upper left
1034          * corner.
1035          */
1036         int ic;
1037         for (ic = b[isub].ulcol + 1; ic < b[isub].ulcol + b[isub].w; ++ic) {
1038             cellsRow[ic].v.pd.hoff = ic - b[isub].ulcol;
1039             cellsRow[ic].v.pd.voff = 0;
1040             cellsRow[ic].hscl = b[isub].w;
1041             cellsRow[ic].vscl = b[isub].h;
1042         }
1043         cellsRow += self.columnCount;
1044         for (int ir = b[isub].ulrow + 1;
1045              ir < b[isub].ulrow + b[isub].h;
1046              ++ir) {
1047             for (ic = b[isub].ulcol; ic < b[isub].ulcol + b[isub].w; ++ic) {
1048                 cellsRow[ic].v.pd.hoff = ic - b[isub].ulcol;
1049                 cellsRow[ic].v.pd.voff = ir - b[isub].ulrow;
1050                 cellsRow[ic].hscl = b[isub].w;
1051                 cellsRow[ic].vscl = b[isub].h;
1052             }
1053             cellsRow += self.columnCount;
1054         }
1055     }
1056 }
1057
1058 - (void)checkForBigStuffOverwriteAtColumn:(int)icol row:(int)irow
1059                                     width:(int)w height:(int)h
1060 {
1061     int ire = irow + h, ice = icol + w;
1062
1063     for (int ir = irow; ir < ire; ++ir) {
1064         for (int ic = icol; ic < ice; ++ic) {
1065             const struct TerminalCell *pcell =
1066                 [self getCellAtColumn:ic row:ir];
1067
1068             if ((pcell->form & (TERM_CELL_CHAR | TERM_CELL_TILE)) != 0 &&
1069                 (pcell->hscl > 1 || pcell->vscl > 1)) {
1070                 /*
1071                  * Lost chunk including upper left corner.  Split into at most
1072                  * two new blocks.
1073                  */
1074                 /*
1075                  * Tolerate blocks that were clipped by a resize at some point.
1076                  */
1077                 int wb = (ic + pcell->hscl <= self.columnCount) ?
1078                     pcell->hscl : self.columnCount - ic;
1079                 int hb = (ir + pcell->vscl <= self.rowCount) ?
1080                     pcell->vscl : self.rowCount - ir;
1081                 struct TerminalCellBlock blocks[2];
1082                 int nsub = 0, ww, hw;
1083
1084                 if (ice < ic + wb) {
1085                     /* Have something to the right not overwritten. */
1086                     blocks[nsub].ulcol = ice;
1087                     blocks[nsub].ulrow = ir;
1088                     blocks[nsub].w = ic + wb - ice;
1089                     blocks[nsub].h = (ire < ir + hb) ? ire - ir : hb;
1090                     ++nsub;
1091                     ww = ice - ic;
1092                 } else {
1093                     ww = wb;
1094                 }
1095                 if (ire < ir + hb) {
1096                     /* Have something below not overwritten. */
1097                     blocks[nsub].ulcol = ic;
1098                     blocks[nsub].ulrow = ire;
1099                     blocks[nsub].w = wb;
1100                     blocks[nsub].h = ir + hb - ire;
1101                     ++nsub;
1102                     hw = ire - ir;
1103                 } else {
1104                     hw = hb;
1105                 }
1106                 if (nsub > 0) {
1107                     [self splitBlockAtColumn:ic row:ir n:nsub blocks:blocks];
1108                 }
1109                 /*
1110                  * Wipe the part of the block that's destined to be overwritten
1111                  * so it doesn't receive further consideration in this loop.
1112                  * For efficiency, would like to have the loop skip over it or
1113                  * fill it with the desired content, but this is easier to
1114                  * implement.
1115                  */
1116                 [self wipeBlockAuxAtColumn:ic row:ir width:ww height:hw];
1117             } else if ((pcell->form & (TERM_CELL_CHAR_PADDING |
1118                                        TERM_CELL_TILE_PADDING)) != 0) {
1119                 /*
1120                  * Lost a chunk that doesn't cover the upper left corner.  In
1121                  * general will split into up to four new blocks (one above,
1122                  * one to the left, one to the right, and one below).
1123                  */
1124                 int pcol = ic - pcell->v.pd.hoff;
1125                 int prow = ir - pcell->v.pd.voff;
1126                 const struct TerminalCell *pcell2 =
1127                     [self getCellAtColumn:pcol row:prow];
1128
1129                 /*
1130                  * Tolerate blocks that were clipped by a resize at some point.
1131                  */
1132                 int wb = (pcol + pcell2->hscl <= self.columnCount) ?
1133                     pcell2->hscl : self.columnCount - pcol;
1134                 int hb = (prow + pcell2->vscl <= self.rowCount) ?
1135                     pcell2->vscl : self.rowCount - prow;
1136                 struct TerminalCellBlock blocks[4];
1137                 int nsub = 0, ww, hw;
1138
1139                 if (prow < ir) {
1140                     /* Have something above not overwritten. */
1141                     blocks[nsub].ulcol = pcol;
1142                     blocks[nsub].ulrow = prow;
1143                     blocks[nsub].w = wb;
1144                     blocks[nsub].h = ir - prow;
1145                     ++nsub;
1146                 }
1147                 if (pcol < ic) {
1148                     /* Have something to the left not overwritten. */
1149                     blocks[nsub].ulcol = pcol;
1150                     blocks[nsub].ulrow = ir;
1151                     blocks[nsub].w = ic - pcol;
1152                     blocks[nsub].h =
1153                         (ire < prow + hb) ? ire - ir : prow + hb - ir;
1154                     ++nsub;
1155                 }
1156                 if (ice < pcol + wb) {
1157                     /* Have something to the right not overwritten. */
1158                     blocks[nsub].ulcol = ice;
1159                     blocks[nsub].ulrow = ir;
1160                     blocks[nsub].w = pcol + wb - ice;
1161                     blocks[nsub].h =
1162                         (ire < prow + hb) ? ire - ir : prow + hb - ir;
1163                     ++nsub;
1164                     ww = ice - ic;
1165                 } else {
1166                     ww = pcol + wb - ic;
1167                 }
1168                 if (ire < prow + hb) {
1169                     /* Have something below not overwritten. */
1170                     blocks[nsub].ulcol = pcol;
1171                     blocks[nsub].ulrow = ire;
1172                     blocks[nsub].w = wb;
1173                     blocks[nsub].h = prow + hb - ire;
1174                     ++nsub;
1175                     hw = ire - ir;
1176                 } else {
1177                     hw = prow + hb - ir;
1178                 }
1179
1180                 [self splitBlockAtColumn:pcol row:prow n:nsub blocks:blocks];
1181                 /* Same rationale for wiping as above. */
1182                 [self wipeBlockAuxAtColumn:ic row:ir width:ww height:hw];
1183             }
1184         }
1185     }
1186 }
1187
1188 - (void)setCursorAtColumn:(int)icol row:(int)irow width:(int)w height:(int)h
1189 {
1190     self->_cursorColumn = icol;
1191     self->_cursorRow = irow;
1192     self->_cursorWidth = w;
1193     self->_cursorHeight = h;
1194 }
1195
1196 - (void)removeCursor
1197 {
1198     self->_cursorColumn = -1;
1199     self->_cursorHeight = -1;
1200     self->_cursorWidth = 1;
1201     self->_cursorHeight = 1;
1202 }
1203
1204 - (void)assertInvariants
1205 {
1206     const struct TerminalCell *cellsRow = self->cells;
1207
1208     /*
1209      * The comments with the definition for TerminalCell define the
1210      * relationships of hoff_n, voff_n, hoff_d, voff_d, hscl, and vscl
1211      * asserted here.
1212      */
1213     for (int ir = 0; ir < self.rowCount; ++ir) {
1214         for (int ic = 0; ic < self.columnCount; ++ic) {
1215             switch (cellsRow[ic].form) {
1216             case TERM_CELL_CHAR:
1217                 assert(cellsRow[ic].hscl > 0 && cellsRow[ic].vscl > 0);
1218                 assert(cellsRow[ic].hoff_n < cellsRow[ic].hoff_d &&
1219                        cellsRow[ic].voff_n < cellsRow[ic].voff_d);
1220                 if (cellsRow[ic].hscl == cellsRow[ic].hoff_d) {
1221                     assert(cellsRow[ic].hoff_n == 0);
1222                 }
1223                 if (cellsRow[ic].vscl == cellsRow[ic].voff_d) {
1224                     assert(cellsRow[ic].voff_n == 0);
1225                 }
1226                 /*
1227                  * Verify that the padding elements have the correct tag
1228                  * and point back to this cell.
1229                  */
1230                 if (cellsRow[ic].hscl > 1 || cellsRow[ic].vscl > 1) {
1231                     const struct TerminalCell *cellsRow2 = cellsRow;
1232
1233                     for (int ir2 = ir; ir2 < ir + cellsRow[ic].vscl; ++ir2) {
1234                         for (int ic2 = ic;
1235                              ic2 < ic + cellsRow[ic].hscl;
1236                              ++ic2) {
1237                             if (ir2 == ir && ic2 == ic) {
1238                                 continue;
1239                             }
1240                             assert(cellsRow2[ic2].form ==
1241                                    TERM_CELL_CHAR_PADDING);
1242                             assert(ic2 - cellsRow2[ic2].v.pd.hoff == ic &&
1243                                    ir2 - cellsRow2[ic2].v.pd.voff == ir);
1244                         }
1245                         cellsRow2 += self.columnCount;
1246                     }
1247                 }
1248                 break;
1249
1250             case TERM_CELL_TILE:
1251                 assert(cellsRow[ic].hscl > 0 && cellsRow[ic].vscl > 0);
1252                 assert(cellsRow[ic].hoff_n < cellsRow[ic].hoff_d &&
1253                        cellsRow[ic].voff_n < cellsRow[ic].voff_d);
1254                 if (cellsRow[ic].hscl == cellsRow[ic].hoff_d) {
1255                     assert(cellsRow[ic].hoff_n == 0);
1256                 }
1257                 if (cellsRow[ic].vscl == cellsRow[ic].voff_d) {
1258                     assert(cellsRow[ic].voff_n == 0);
1259                 }
1260                 /*
1261                  * Verify that the padding elements have the correct tag
1262                  * and point back to this cell.
1263                  */
1264                 if (cellsRow[ic].hscl > 1 || cellsRow[ic].vscl > 1) {
1265                     const struct TerminalCell *cellsRow2 = cellsRow;
1266
1267                     for (int ir2 = ir; ir2 < ir + cellsRow[ic].vscl; ++ir2) {
1268                         for (int ic2 = ic;
1269                              ic2 < ic + cellsRow[ic].hscl;
1270                              ++ic2) {
1271                             if (ir2 == ir && ic2 == ic) {
1272                                 continue;
1273                             }
1274                             assert(cellsRow2[ic2].form ==
1275                                    TERM_CELL_TILE_PADDING);
1276                             assert(ic2 - cellsRow2[ic2].v.pd.hoff == ic &&
1277                                    ir2 - cellsRow2[ic2].v.pd.voff == ir);
1278                         }
1279                         cellsRow2 += self.columnCount;
1280                     }
1281                 }
1282                 break;
1283
1284             case TERM_CELL_CHAR_PADDING:
1285                 assert(cellsRow[ic].hscl > 0 && cellsRow[ic].vscl > 0);
1286                 assert(cellsRow[ic].hoff_n < cellsRow[ic].hoff_d &&
1287                        cellsRow[ic].voff_n < cellsRow[ic].voff_d);
1288                 assert(cellsRow[ic].hoff_n > 0 || cellsRow[ic].voff_n > 0);
1289                 if (cellsRow[ic].hscl == cellsRow[ic].hoff_d) {
1290                     assert(cellsRow[ic].hoff_n == cellsRow[ic].v.pd.hoff);
1291                 }
1292                 if (cellsRow[ic].vscl == cellsRow[ic].voff_d) {
1293                     assert(cellsRow[ic].voff_n == cellsRow[ic].v.pd.voff);
1294                 }
1295                 assert(ic >= cellsRow[ic].v.pd.hoff &&
1296                        ir >= cellsRow[ic].v.pd.voff);
1297                 /*
1298                  * Verify that it's padding for something that can point
1299                  * back to it.
1300                  */
1301                 {
1302                     const struct TerminalCell *parent =
1303                         [self getCellAtColumn:(ic - cellsRow[ic].v.pd.hoff)
1304                               row:(ir - cellsRow[ic].v.pd.voff)];
1305
1306                     assert(parent->form == TERM_CELL_CHAR);
1307                     assert(parent->hscl > cellsRow[ic].v.pd.hoff &&
1308                            parent->vscl > cellsRow[ic].v.pd.voff);
1309                     assert(parent->hscl == cellsRow[ic].hscl &&
1310                            parent->vscl == cellsRow[ic].vscl);
1311                     assert(parent->hoff_d == cellsRow[ic].hoff_d &&
1312                            parent->voff_d == cellsRow[ic].voff_d);
1313                 }
1314                 break;
1315
1316             case TERM_CELL_TILE_PADDING:
1317                 assert(cellsRow[ic].hscl > 0 && cellsRow[ic].vscl > 0);
1318                 assert(cellsRow[ic].hoff_n < cellsRow[ic].hoff_d &&
1319                        cellsRow[ic].voff_n < cellsRow[ic].voff_d);
1320                 assert(cellsRow[ic].hoff_n > 0 || cellsRow[ic].voff_n > 0);
1321                 if (cellsRow[ic].hscl == cellsRow[ic].hoff_d) {
1322                     assert(cellsRow[ic].hoff_n == cellsRow[ic].v.pd.hoff);
1323                 }
1324                 if (cellsRow[ic].vscl == cellsRow[ic].voff_d) {
1325                     assert(cellsRow[ic].voff_n == cellsRow[ic].v.pd.voff);
1326                 }
1327                 assert(ic >= cellsRow[ic].v.pd.hoff &&
1328                        ir >= cellsRow[ic].v.pd.voff);
1329                 /*
1330                  * Verify that it's padding for something that can point
1331                  * back to it.
1332                  */
1333                 {
1334                     const struct TerminalCell *parent =
1335                         [self getCellAtColumn:(ic - cellsRow[ic].v.pd.hoff)
1336                               row:(ir - cellsRow[ic].v.pd.voff)];
1337
1338                     assert(parent->form == TERM_CELL_TILE);
1339                     assert(parent->hscl > cellsRow[ic].v.pd.hoff &&
1340                            parent->vscl > cellsRow[ic].v.pd.voff);
1341                     assert(parent->hscl == cellsRow[ic].hscl &&
1342                            parent->vscl == cellsRow[ic].vscl);
1343                     assert(parent->hoff_d == cellsRow[ic].hoff_d &&
1344                            parent->voff_d == cellsRow[ic].voff_d);
1345                 }
1346                 break;
1347
1348             default:
1349                 assert(0);
1350             }
1351         }
1352         cellsRow += self.columnCount;
1353     }
1354 }
1355
1356 + (wchar_t)getBlankChar
1357 {
1358     return L' ';
1359 }
1360
1361 + (int)getBlankAttribute
1362 {
1363     return 0;
1364 }
1365
1366 @end
1367
1368 /**
1369  * TerminalChanges is used to track changes made via the text_hook, pict_hook,
1370  * wipe_hook, curs_hook, and bigcurs_hook callbacks on the terminal since the
1371  * last call to xtra_hook for TERM_XTRA_FRESH.  The locations marked as changed
1372  * can then be used to make bounding rectangles for the regions that need to
1373  * be redisplayed.
1374  */
1375 @interface TerminalChanges : NSObject {
1376     int* colBounds;
1377     /*
1378      * Outside of firstChangedRow, lastChangedRow and what's in colBounds, the
1379      * contents of this are handled lazily.
1380      */
1381     BOOL* marks;
1382 }
1383
1384 /**
1385  * Initialize with zero columns and zero rows.
1386  */
1387 - (id)init;
1388
1389 /**
1390  * Initialize with nCol columns and nRow rows.  No changes will be marked.
1391  */
1392 - (id)initWithColumns:(int)nCol rows:(int)nRow NS_DESIGNATED_INITIALIZER;
1393
1394 /**
1395  * Resize to be nCol by nRow.  Current contents still within the new bounds
1396  * are preserved.  Added areas are marked as unchanged.
1397  */
1398 - (void)resizeWithColumns:(int)nCol rows:(int)nRow;
1399
1400 /**
1401  * Clears all marked changes.
1402  */
1403 - (void)clear;
1404
1405 - (BOOL)isChangedAtColumn:(int)icol row:(int)irow;
1406
1407 /**
1408  * Scans the row, irow, starting at the column, icol0, and stopping before the
1409  * column, icol1.  Returns the column index for the first cell that is
1410  * changed.  The returned index will be equal to icol1 if all of the cells in
1411  * the range are unchanged.
1412  */
1413 - (int)scanForChangedInRow:(int)irow col0:(int)icol0 col1:(int)icol1;
1414
1415 /**
1416  * Scans the row, irow, starting at the column, icol0, and stopping before the
1417  * column, icol1.  returns the column index for the first cell that has not
1418  * changed.  The returned index will be equal to icol1 if all of the cells in
1419  * the range have changed.
1420  */
1421 - (int)scanForUnchangedInRow:(int)irow col0:(int)icol0 col1:(int)icol1;
1422
1423 - (void)markChangedAtColumn:(int)icol row:(int)irow;
1424
1425 - (void)markChangedRangeAtColumn:(int)icol row:(int)irow width:(int)w;
1426
1427 /**
1428  * Marks the block as changed who's upper left hand corner is at (icol, irow).
1429  */
1430 - (void)markChangedBlockAtColumn:(int)icol
1431                              row:(int)irow
1432                            width:(int)w
1433                           height:(int)h;
1434
1435 /**
1436  * Returns the index of the first changed column in the given row.  That index
1437  * will be equal to the number of columns if there are no changes in the row.
1438  */
1439 - (int)getFirstChangedColumnInRow:(int)irow;
1440
1441 /**
1442  * Returns the index of the last changed column in the given row.  That index
1443  * will be equal to -1 if there are no changes in the row.
1444  */
1445 - (int)getLastChangedColumnInRow:(int)irow;
1446
1447 /**
1448  * Is the number of columns.
1449  */
1450 @property (readonly) int columnCount;
1451
1452 /**
1453  * Is the number of rows.
1454  */
1455 @property (readonly) int rowCount;
1456
1457 /**
1458  * Is the index of the first row with changes.  Will be equal to the number
1459  * of rows if there are no changes.
1460  */
1461 @property (readonly) int firstChangedRow;
1462
1463 /**
1464  * Is the index of the last row with changes.  Will be equal to -1 if there
1465  * are no changes.
1466  */
1467 @property (readonly) int lastChangedRow;
1468
1469 @end
1470
1471 @implementation TerminalChanges
1472
1473 - (id)init
1474 {
1475     return [self initWithColumns:0 rows:0];
1476 }
1477
1478 - (id)initWithColumns:(int)nCol rows:(int)nRow
1479 {
1480     if (self = [super init]) {
1481         self->colBounds = malloc(2 * nRow * sizeof(int));
1482         self->marks = malloc(nCol * nRow * sizeof(BOOL));
1483         self->_columnCount = nCol;
1484         self->_rowCount = nRow;
1485         [self clear];
1486     }
1487     return self;
1488 }
1489
1490 - (void)dealloc
1491 {
1492     if (self->marks != 0) {
1493         free(self->marks);
1494         self->marks = 0;
1495     }
1496     if (self->colBounds != 0) {
1497         free(self->colBounds);
1498         self->colBounds = 0;
1499     }
1500 }
1501
1502 - (void)resizeWithColumns:(int)nCol rows:(int)nRow
1503 {
1504     int* newColBounds = malloc(2 * nRow * sizeof(int));
1505     BOOL* newMarks = malloc(nCol * nRow * sizeof(BOOL));
1506     int nRowCommon = (nRow < self.rowCount) ? nRow : self.rowCount;
1507
1508     if (self.firstChangedRow <= self.lastChangedRow &&
1509         self.firstChangedRow < nRowCommon) {
1510         BOOL* marksOutCursor = newMarks + self.firstChangedRow * nCol;
1511         const BOOL* marksInCursor =
1512             self->marks + self.firstChangedRow * self.columnCount;
1513         int nColCommon = (nCol < self.columnCount) ? nCol : self.columnCount;
1514
1515         if (self.lastChangedRow >= nRowCommon) {
1516             self->_lastChangedRow = nRowCommon - 1;
1517         }
1518         for (int i = self.firstChangedRow; i <= self.lastChangedRow; ++i) {
1519             if (self->colBounds[i + i] < nColCommon) {
1520                 newColBounds[i + i] = self->colBounds[i + i];
1521                 newColBounds[i + i + 1] =
1522                     (self->colBounds[i + i + 1] < nColCommon) ?
1523                     self->colBounds[i + i + 1] : nColCommon - 1;
1524                 (void) memcpy(
1525                     marksOutCursor + self->colBounds[i + i],
1526                     marksInCursor + self->colBounds[i + i],
1527                     (newColBounds[i + i + 1] - newColBounds[i + i] + 1) *
1528                         sizeof(BOOL));
1529                 marksInCursor += self.columnCount;
1530                 marksOutCursor += nCol;
1531             } else {
1532                 self->colBounds[i + i] = nCol;
1533                 self->colBounds[i + i + 1] = -1;
1534             }
1535         }
1536     } else {
1537         self->_firstChangedRow = nRow;
1538         self->_lastChangedRow = -1;
1539     }
1540
1541     free(self->colBounds);
1542     self->colBounds = newColBounds;
1543     free(self->marks);
1544     self->marks = newMarks;
1545     self->_columnCount = nCol;
1546     self->_rowCount = nRow;
1547 }
1548
1549 - (void)clear
1550 {
1551     self->_firstChangedRow = self.rowCount;
1552     self->_lastChangedRow = -1;
1553 }
1554
1555 - (BOOL)isChangedAtColumn:(int)icol row:(int)irow
1556 {
1557     if (irow < self.firstChangedRow || irow > self.lastChangedRow) {
1558         return NO;
1559     }
1560     if (icol < self->colBounds[irow + irow] ||
1561         icol > self->colBounds[irow + irow + 1]) {
1562         return NO;
1563     }
1564     return self->marks[icol + irow * self.columnCount];
1565 }
1566
1567 - (int)scanForChangedInRow:(int)irow col0:(int)icol0 col1:(int)icol1
1568 {
1569     if (irow < self.firstChangedRow || irow > self.lastChangedRow ||
1570         icol0 > self->colBounds[irow + irow + 1]) {
1571         return icol1;
1572     }
1573
1574     int i = (icol0 > self->colBounds[irow + irow]) ?
1575         icol0 : self->colBounds[irow + irow];
1576     int i1 = (icol1 <= self->colBounds[irow + irow + 1]) ?
1577         icol1 : self->colBounds[irow + irow + 1] + 1;
1578     const BOOL* marksCursor = self->marks + irow * self.columnCount;
1579     while (1) {
1580         if (i >= i1) {
1581             return icol1;
1582         }
1583         if (marksCursor[i]) {
1584             return i;
1585         }
1586         ++i;
1587     }
1588 }
1589
1590 - (int)scanForUnchangedInRow:(int)irow col0:(int)icol0 col1:(int)icol1
1591 {
1592     if (irow < self.firstChangedRow || irow > self.lastChangedRow ||
1593         icol0 < self->colBounds[irow + irow] ||
1594         icol0 > self->colBounds[irow + irow + 1]) {
1595         return icol0;
1596     }
1597
1598     int i = icol0;
1599     int i1 = (icol1 <= self->colBounds[irow + irow + 1]) ?
1600         icol1 : self->colBounds[irow + irow + 1] + 1;
1601     const BOOL* marksCursor = self->marks + irow * self.columnCount;
1602     while (1) {
1603         if (i >= i1 || ! marksCursor[i]) {
1604             return i;
1605         }
1606         ++i;
1607     }
1608 }
1609
1610 - (void)markChangedAtColumn:(int)icol row:(int)irow
1611 {
1612     [self markChangedBlockAtColumn:icol row:irow width:1 height:1];
1613 }
1614
1615 - (void)markChangedRangeAtColumn:(int)icol row:(int)irow width:(int)w
1616 {
1617     [self markChangedBlockAtColumn:icol row:irow width:w height:1];
1618 }
1619
1620 - (void)markChangedBlockAtColumn:(int)icol
1621                              row:(int)irow
1622                            width:(int)w
1623                           height:(int)h
1624 {
1625     if (irow + h <= self.firstChangedRow) {
1626         /* All prior marked regions are on rows after the requested block. */
1627         if (self.firstChangedRow > self.lastChangedRow) {
1628             self->_lastChangedRow = irow + h - 1;
1629         } else {
1630             for (int i = irow + h; i < self.firstChangedRow; ++i) {
1631                 self->colBounds[i + i] = self.columnCount;
1632                 self->colBounds[i + i + 1] = -1;
1633             }
1634         }
1635         self->_firstChangedRow = irow;
1636
1637         BOOL* marksCursor = self->marks + irow * self.columnCount;
1638         for (int i = irow; i < irow + h; ++i) {
1639             self->colBounds[i + i] = icol;
1640             self->colBounds[i + i + 1] = icol + w - 1;
1641             for (int j = icol; j < icol + w; ++j) {
1642                 marksCursor[j] = YES;
1643             }
1644             marksCursor += self.columnCount;
1645         }
1646     } else if (irow > self.lastChangedRow) {
1647         /* All prior marked regions are on rows before the requested block. */
1648         int i;
1649
1650         for (i = self.lastChangedRow + 1; i < irow; ++i) {
1651             self->colBounds[i + i] = self.columnCount;
1652             self->colBounds[i + i + 1] = -1;
1653         }
1654         self->_lastChangedRow = irow + h - 1;
1655
1656         BOOL* marksCursor = self->marks + irow * self.columnCount;
1657         for (i = irow; i < irow + h; ++i) {
1658             self->colBounds[i + i] = icol;
1659             self->colBounds[i + i + 1] = icol + w - 1;
1660             for (int j = icol; j < icol + w; ++j) {
1661                 marksCursor[j] = YES;
1662             }
1663             marksCursor += self.columnCount;
1664         }
1665     } else {
1666         /*
1667          * There's overlap between the rows of the requested block and prior
1668          * marked regions.
1669          */
1670         BOOL* marksCursor = self->marks + irow * self.columnCount;
1671         int irow0, h0;
1672
1673         if (irow < self.firstChangedRow) {
1674             /* Handle any leading rows where there's no overlap. */
1675             for (int i = irow; i < self.firstChangedRow; ++i) {
1676                 self->colBounds[i + i] = icol;
1677                 self->colBounds[i + i + 1] = icol + w - 1;
1678                 for (int j = icol; j < icol + w; ++j) {
1679                     marksCursor[j] = YES;
1680                 }
1681                 marksCursor += self.columnCount;
1682             }
1683             irow0 = self.firstChangedRow;
1684             h0 = irow + h - self.firstChangedRow;
1685             self->_firstChangedRow = irow;
1686         } else {
1687             irow0 = irow;
1688             h0 = h;
1689         }
1690
1691         /* Handle potentially overlapping rows */
1692         if (irow0 + h0 > self.lastChangedRow + 1) {
1693             h0 = self.lastChangedRow + 1 - irow0;
1694             self->_lastChangedRow = irow + h - 1;
1695         }
1696
1697         int i;
1698         for (i = irow0; i < irow0 + h0; ++i) {
1699             if (icol + w <= self->colBounds[i + i]) {
1700                 int j;
1701
1702                 for (j = icol; j < icol + w; ++j) {
1703                     marksCursor[j] = YES;
1704                 }
1705                 if (self->colBounds[i + i] > self->colBounds[i + i + 1]) {
1706                     self->colBounds[i + i + 1] = icol + w - 1;
1707                 } else {
1708                     for (j = icol + w; j < self->colBounds[i + i]; ++j) {
1709                         marksCursor[j] = NO;
1710                     }
1711                 }
1712                 self->colBounds[i + i] = icol;
1713             } else if (icol > self->colBounds[i + i + 1]) {
1714                 int j;
1715
1716                 for (j = self->colBounds[i + i + 1] + 1; j < icol; ++j) {
1717                     marksCursor[j] = NO;
1718                 }
1719                 for (j = icol; j < icol + w; ++j) {
1720                     marksCursor[j] = YES;
1721                 }
1722                 self->colBounds[i + i + 1] = icol + w - 1;
1723             } else {
1724                 if (icol < self->colBounds[i + i]) {
1725                     self->colBounds[i + i] = icol;
1726                 }
1727                 if (icol + w > self->colBounds[i + i + 1]) {
1728                     self->colBounds[i + i + 1] = icol + w - 1;
1729                 }
1730                 for (int j = icol; j < icol + w; ++j) {
1731                     marksCursor[j] = YES;
1732                 }
1733             }
1734             marksCursor += self.columnCount;
1735         }
1736
1737         /* Handle any trailing rows where there's no overlap. */
1738         for (i = irow0 + h0; i < irow + h; ++i) {
1739             self->colBounds[i + i] = icol;
1740             self->colBounds[i + i + 1] = icol + w - 1;
1741             for (int j = icol; j < icol + w; ++j) {
1742                 marksCursor[j] = YES;
1743             }
1744             marksCursor += self.columnCount;
1745         }
1746     }
1747 }
1748
1749 - (int)getFirstChangedColumnInRow:(int)irow
1750 {
1751     if (irow < self.firstChangedRow || irow > self.lastChangedRow) {
1752         return self.columnCount;
1753     }
1754     return self->colBounds[irow + irow];
1755 }
1756
1757 - (int)getLastChangedColumnInRow:(int)irow
1758 {
1759     if (irow < self.firstChangedRow || irow > self.lastChangedRow) {
1760         return -1;
1761     }
1762     return self->colBounds[irow + irow + 1];
1763 }
1764
1765 @end
1766
1767
1768 /**
1769  * Draws one tile as a helper function for AngbandContext's drawRect.
1770  */
1771 static void draw_image_tile(
1772     NSGraphicsContext* nsContext,
1773     CGContextRef cgContext,
1774     CGImageRef image,
1775     NSRect srcRect,
1776     NSRect dstRect,
1777     NSCompositingOperation op)
1778 {
1779     /* Flip the source rect since the source image is flipped */
1780     CGAffineTransform flip = CGAffineTransformIdentity;
1781     flip = CGAffineTransformTranslate(flip, 0.0, CGImageGetHeight(image));
1782     flip = CGAffineTransformScale(flip, 1.0, -1.0);
1783     CGRect flippedSourceRect =
1784         CGRectApplyAffineTransform(NSRectToCGRect(srcRect), flip);
1785
1786     /*
1787      * When we use high-quality resampling to draw a tile, pixels from outside
1788      * the tile may bleed in, causing graphics artifacts. Work around that.
1789      */
1790     CGImageRef subimage =
1791         CGImageCreateWithImageInRect(image, flippedSourceRect);
1792     [nsContext setCompositingOperation:op];
1793     CGContextDrawImage(cgContext, NSRectToCGRect(dstRect), subimage);
1794     CGImageRelease(subimage);
1795 }
1796
1797
1798 /*
1799  * The max number of glyphs we support.  Currently this only affects
1800  * updateGlyphInfo() for the calculation of the tile size, fontAscender,
1801  * fontDescender, nColPre, and nColPost.  The rendering in drawWChar() will
1802  * work for a glyph not in updateGlyphInfo()'s set, and that is used for
1803  * rendering Japanese characters, though there may be clipping or clearing
1804  * artifacts because it wasn't included in updateGlyphInfo()'s calculations.
1805  */
1806 #define GLYPH_COUNT 256
1807
1808 /*
1809  * An AngbandContext represents a logical Term (i.e. what Angband thinks is
1810  * a window).
1811  */
1812 @interface AngbandContext : NSObject <NSWindowDelegate>
1813 {
1814 @public
1815
1816     /* The Angband term */
1817     term *terminal;
1818
1819 @private
1820     /* Is the last time we drew, so we can throttle drawing. */
1821     CFAbsoluteTime lastRefreshTime;
1822
1823     /* Flags whether or not a fullscreen transition is in progress. */
1824     BOOL inFullscreenTransition;
1825
1826     /* Our view */
1827     AngbandView *angbandView;
1828 }
1829
1830 /* Column and row counts, by default 80 x 24 */
1831 @property (readonly) int cols;
1832 @property (readonly) int rows;
1833
1834 /* The size of the border between the window edge and the contents */
1835 @property (readonly) NSSize borderSize;
1836
1837 /* The font of this context */
1838 @property NSFont *angbandViewFont;
1839
1840 /* The size of one tile */
1841 @property (readonly) NSSize tileSize;
1842
1843 /* Font's ascender and descender */
1844 @property (readonly) CGFloat fontAscender;
1845 @property (readonly) CGFloat fontDescender;
1846
1847 /*
1848  * These are the number of columns before or after, respectively, a text
1849  * change that may need to be redrawn.
1850  */
1851 @property (readonly) int nColPre;
1852 @property (readonly) int nColPost;
1853
1854 /* If this context owns a window, here it is. */
1855 @property NSWindow *primaryWindow;
1856
1857 /* Holds our version of the contents of the terminal. */
1858 @property TerminalContents *contents;
1859
1860 /*
1861  * Marks which locations have been changed by the text_hook, pict_hook,
1862  * wipe_hook, curs_hook, and bigcurs_hhok callbacks on the terminal since
1863  * the last call to xtra_hook with TERM_XTRA_FRESH.
1864  */
1865 @property TerminalChanges *changes;
1866
1867 @property (nonatomic, assign) BOOL hasSubwindowFlags;
1868 @property (nonatomic, assign) BOOL windowVisibilityChecked;
1869
1870 - (void)resizeWithColumns:(int)nCol rows:(int)nRow;
1871
1872 /**
1873  * Based on what has been marked as changed, inform AppKit of the bounding
1874  * rectangles for the changed areas.
1875  */
1876 - (void)computeInvalidRects;
1877
1878 - (void)drawRect:(NSRect)rect inView:(NSView *)view;
1879
1880 /* Called at initialization to set the term */
1881 - (void)setTerm:(term *)t;
1882
1883 /* Called when the context is going down. */
1884 - (void)dispose;
1885
1886 /*
1887  * Return the rect in view coordinates for the block of cells whose upper
1888  * left corner is (x,y).
1889  */
1890 - (NSRect)viewRectForCellBlockAtX:(int)x y:(int)y width:(int)w height:(int)h;
1891
1892 /* Draw the given wide character into the given tile rect. */
1893 - (void)drawWChar:(wchar_t)wchar inRect:(NSRect)tile screenFont:(NSFont*)font
1894           context:(CGContextRef)ctx;
1895
1896 /*
1897  * Returns the primary window for this angband context, creating it if
1898  * necessary
1899  */
1900 - (NSWindow *)makePrimaryWindow;
1901
1902 /* Handle becoming the main window */
1903 - (void)windowDidBecomeMain:(NSNotification *)notification;
1904
1905 /* Return whether the context's primary window is ordered in or not */
1906 - (BOOL)isOrderedIn;
1907
1908 /*
1909  * Return whether the context's primary window is the main window.
1910  * Since the terminals other than terminal 0 are configured as panels in
1911  * Hengband, this will only be true for terminal 0.
1912  */
1913 - (BOOL)isMainWindow;
1914
1915 /*
1916  * Return whether the context's primary window is the destination for key
1917  * input.
1918  */
1919 - (BOOL)isKeyWindow;
1920
1921 /* Invalidate the whole image */
1922 - (void)setNeedsDisplay:(BOOL)val;
1923
1924 /* Invalidate part of the image, with the rect expressed in view coordinates */
1925 - (void)setNeedsDisplayInRect:(NSRect)rect;
1926
1927 /* Display (flush) our Angband views */
1928 - (void)displayIfNeeded;
1929
1930 /*
1931  * Resize context to size of contentRect, and optionally save size to
1932  * defaults
1933  */
1934 - (void)resizeTerminalWithContentRect: (NSRect)contentRect saveToDefaults: (BOOL)saveToDefaults;
1935
1936 /*
1937  * Change the minimum size and size increments for the window associated with
1938  * the context.  termIdx is the index for the terminal:  pass it so this
1939  * function can be used when self->terminal has not yet been set.
1940  */
1941 - (void)constrainWindowSize:(int)termIdx;
1942
1943 - (void)saveWindowVisibleToDefaults: (BOOL)windowVisible;
1944 - (BOOL)windowVisibleUsingDefaults;
1945
1946 /* Class methods */
1947 /**
1948  * Gets the default font for all contexts.  Currently not declaring this as
1949  * a class property for compatibility with versions of Xcode prior to 8.
1950  */
1951 + (NSFont*)defaultFont;
1952 /**
1953  * Sets the default font for all contexts.
1954  */
1955 + (void)setDefaultFont:(NSFont*)font;
1956
1957 /* Internal methods */
1958 /* Set the title for the primary window. */
1959 - (void)setDefaultTitle:(int)termIdx;
1960
1961 @end
1962
1963 /**
1964  * Generate a mask for the subwindow flags. The mask is just a safety check to
1965  * make sure that our windows show and hide as expected.  This function allows
1966  * for future changes to the set of flags without needed to update it here
1967  * (unless the underlying types change).
1968  */
1969 u32b AngbandMaskForValidSubwindowFlags(void)
1970 {
1971     int windowFlagBits = sizeof(*(window_flag)) * CHAR_BIT;
1972     int maxBits = MIN( 16, windowFlagBits );
1973     u32b mask = 0;
1974
1975     for( int i = 0; i < maxBits; i++ )
1976     {
1977         if( window_flag_desc[i] != NULL )
1978         {
1979             mask |= (1 << i);
1980         }
1981     }
1982
1983     return mask;
1984 }
1985
1986 /**
1987  * Check for changes in the subwindow flags and update window visibility.
1988  * This seems to be called for every user event, so we don't
1989  * want to do any unnecessary hiding or showing of windows.
1990  */
1991 static void AngbandUpdateWindowVisibility(void)
1992 {
1993     /*
1994      * Because this function is called frequently, we'll make the mask static.
1995      * It doesn't change between calls, as the flags themselves are hardcoded
1996      */
1997     static u32b validWindowFlagsMask = 0;
1998
1999     if( validWindowFlagsMask == 0 )
2000     {
2001         validWindowFlagsMask = AngbandMaskForValidSubwindowFlags();
2002     }
2003
2004     /*
2005      * Loop through all of the subwindows and see if there is a change in the
2006      * flags. If so, show or hide the corresponding window. We don't care about
2007      * the flags themselves; we just want to know if any are set.
2008      */
2009     for( int i = 1; i < ANGBAND_TERM_MAX; i++ )
2010     {
2011         AngbandContext *angbandContext =
2012             (__bridge AngbandContext*) (angband_term[i]->data);
2013
2014         if( angbandContext == nil )
2015         {
2016             continue;
2017         }
2018
2019         /*
2020          * This horrible mess of flags is so that we can try to maintain some
2021          * user visibility preference. This should allow the user a window and
2022          * have it stay closed between application launches. However, this
2023          * means that when a subwindow is turned on, it will no longer appear
2024          * automatically. Angband has no concept of user control over window
2025          * visibility, other than the subwindow flags.
2026          */
2027         if( !angbandContext.windowVisibilityChecked )
2028         {
2029             if( [angbandContext windowVisibleUsingDefaults] )
2030             {
2031                 [angbandContext.primaryWindow orderFront: nil];
2032                 angbandContext.windowVisibilityChecked = YES;
2033             }
2034             else
2035             {
2036                 [angbandContext.primaryWindow close];
2037                 angbandContext.windowVisibilityChecked = NO;
2038             }
2039         }
2040         else
2041         {
2042             BOOL termHasSubwindowFlags = ((window_flag[i] & validWindowFlagsMask) > 0);
2043
2044             if( angbandContext.hasSubwindowFlags && !termHasSubwindowFlags )
2045             {
2046                 [angbandContext.primaryWindow close];
2047                 angbandContext.hasSubwindowFlags = NO;
2048                 [angbandContext saveWindowVisibleToDefaults: NO];
2049             }
2050             else if( !angbandContext.hasSubwindowFlags && termHasSubwindowFlags )
2051             {
2052                 [angbandContext.primaryWindow orderFront: nil];
2053                 angbandContext.hasSubwindowFlags = YES;
2054                 [angbandContext saveWindowVisibleToDefaults: YES];
2055             }
2056         }
2057     }
2058
2059     /* Make the main window key so that user events go to the right spot */
2060     AngbandContext *mainWindow =
2061         (__bridge AngbandContext*) (angband_term[0]->data);
2062     [mainWindow.primaryWindow makeKeyAndOrderFront: nil];
2063 }
2064
2065 /**
2066  * ------------------------------------------------------------------------
2067  * Graphics support
2068  * ------------------------------------------------------------------------ */
2069
2070 /**
2071  * The tile image
2072  */
2073 static CGImageRef pict_image;
2074
2075 /**
2076  * Numbers of rows and columns in a tileset,
2077  * calculated by the PICT/PNG loading code
2078  */
2079 static int pict_cols = 0;
2080 static int pict_rows = 0;
2081
2082 /**
2083  * Requested graphics mode (as a grafID).
2084  * The current mode is stored in current_graphics_mode.
2085  */
2086 static int graf_mode_req = 0;
2087
2088 /**
2089  * Helper function to check the various ways that graphics can be enabled,
2090  * guarding against NULL
2091  */
2092 static BOOL graphics_are_enabled(void)
2093 {
2094     return current_graphics_mode
2095         && current_graphics_mode->grafID != GRAPHICS_NONE;
2096 }
2097
2098 /**
2099  * Like graphics_are_enabled(), but test the requested graphics mode.
2100  */
2101 static BOOL graphics_will_be_enabled(void)
2102 {
2103     if (graf_mode_req == GRAPHICS_NONE) {
2104         return NO;
2105     }
2106
2107     graphics_mode *new_mode = get_graphics_mode(graf_mode_req);
2108     return new_mode && new_mode->grafID != GRAPHICS_NONE;
2109 }
2110
2111 /**
2112  * Hack -- game in progress
2113  */
2114 static Boolean game_in_progress = FALSE;
2115
2116
2117 #pragma mark Prototypes
2118 static BOOL redraw_for_tiles_or_term0_font(void);
2119 static void wakeup_event_loop(void);
2120 static void hook_plog(const char *str);
2121 static void hook_quit(const char * str);
2122 static NSString* get_lib_directory(void);
2123 static NSString* get_doc_directory(void);
2124 static NSString* AngbandCorrectedDirectoryPath(NSString *originalPath);
2125 static void prepare_paths_and_directories(void);
2126 static void load_prefs(void);
2127 static void init_windows(void);
2128 static void handle_open_when_ready(void);
2129 static void play_sound(int event);
2130 static BOOL check_events(int wait);
2131 static BOOL send_event(NSEvent *event);
2132 static void set_color_for_index(int idx);
2133 static void record_current_savefile(void);
2134
2135 /**
2136  * Available values for 'wait'
2137  */
2138 #define CHECK_EVENTS_DRAIN -1
2139 #define CHECK_EVENTS_NO_WAIT    0
2140 #define CHECK_EVENTS_WAIT 1
2141
2142
2143 /**
2144  * Note when "open"/"new" become valid
2145  */
2146 static bool initialized = FALSE;
2147
2148 /* Methods for getting the appropriate NSUserDefaults */
2149 @interface NSUserDefaults (AngbandDefaults)
2150 + (NSUserDefaults *)angbandDefaults;
2151 @end
2152
2153 @implementation NSUserDefaults (AngbandDefaults)
2154 + (NSUserDefaults *)angbandDefaults
2155 {
2156     return [NSUserDefaults standardUserDefaults];
2157 }
2158 @end
2159
2160 /*
2161  * Methods for pulling images out of the Angband bundle (which may be separate
2162  * from the current bundle in the case of a screensaver
2163  */
2164 @interface NSImage (AngbandImages)
2165 + (NSImage *)angbandImage:(NSString *)name;
2166 @end
2167
2168 /* The NSView subclass that draws our Angband image */
2169 @interface AngbandView : NSView {
2170 @private
2171     NSBitmapImageRep *cacheForResize;
2172     NSRect cacheBounds;
2173 }
2174
2175 @property (nonatomic, weak) AngbandContext *angbandContext;
2176
2177 @end
2178
2179 @implementation NSImage (AngbandImages)
2180
2181 /*
2182  * Returns an image in the resource directoy of the bundle containing the
2183  * Angband view class.
2184  */
2185 + (NSImage *)angbandImage:(NSString *)name
2186 {
2187     NSBundle *bundle = [NSBundle bundleForClass:[AngbandView class]];
2188     NSString *path = [bundle pathForImageResource:name];
2189     return (path) ? [[NSImage alloc] initByReferencingFile:path] : nil;
2190 }
2191
2192 @end
2193
2194
2195 @implementation AngbandContext
2196
2197 - (NSSize)baseSize
2198 {
2199     /*
2200      * We round the base size down. If we round it up, I believe we may end up
2201      * with pixels that nobody "owns" that may accumulate garbage. In general
2202      * rounding down is harmless, because any lost pixels may be sopped up by
2203      * the border.
2204      */
2205     return NSMakeSize(
2206         floor(self.cols * self.tileSize.width + 2 * self.borderSize.width),
2207         floor(self.rows * self.tileSize.height + 2 * self.borderSize.height));
2208 }
2209
2210 /* qsort-compatible compare function for CGSizes */
2211 static int compare_advances(const void *ap, const void *bp)
2212 {
2213     const CGSize *a = ap, *b = bp;
2214     return (a->width > b->width) - (a->width < b->width);
2215 }
2216
2217 /**
2218  * Precompute certain metrics (tileSize, fontAscender, fontDescender, nColPre,
2219  * and nColPost) for the current font.
2220  */
2221 - (void)updateGlyphInfo
2222 {
2223     NSFont *screenFont = [self.angbandViewFont screenFont];
2224
2225     /* Generate a string containing each MacRoman character */
2226     /*
2227      * Here and below, dynamically allocate working arrays rather than put them
2228      * on the stack in case limited stack space is an issue.
2229      */
2230     unsigned char *latinString = malloc(GLYPH_COUNT);
2231     if (latinString == 0) {
2232         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2233                                         reason:@"latinString in updateGlyphInfo"
2234                                         userInfo:nil];
2235         @throw exc;
2236     }
2237     size_t i;
2238     for (i=0; i < GLYPH_COUNT; i++) latinString[i] = (unsigned char)i;
2239
2240     /* Turn that into unichar. Angband uses ISO Latin 1. */
2241     NSString *allCharsString = [[NSString alloc] initWithBytes:latinString
2242         length:GLYPH_COUNT encoding:NSISOLatin1StringEncoding];
2243     unichar *unicharString = malloc(GLYPH_COUNT * sizeof(unichar));
2244     if (unicharString == 0) {
2245         free(latinString);
2246         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2247                                         reason:@"unicharString in updateGlyphInfo"
2248                                         userInfo:nil];
2249         @throw exc;
2250     }
2251     unicharString[0] = 0;
2252     [allCharsString getCharacters:unicharString range:NSMakeRange(0, MIN(GLYPH_COUNT, [allCharsString length]))];
2253     allCharsString = nil;
2254     free(latinString);
2255
2256     /* Get glyphs */
2257     CGGlyph *glyphArray = calloc(GLYPH_COUNT, sizeof(CGGlyph));
2258     if (glyphArray == 0) {
2259         free(unicharString);
2260         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2261                                         reason:@"glyphArray in updateGlyphInfo"
2262                                         userInfo:nil];
2263         @throw exc;
2264     }
2265     CTFontGetGlyphsForCharacters((CTFontRef)screenFont, unicharString,
2266                                  glyphArray, GLYPH_COUNT);
2267     free(unicharString);
2268
2269     /* Get advances. Record the max advance. */
2270     CGSize *advances = malloc(GLYPH_COUNT * sizeof(CGSize));
2271     if (advances == 0) {
2272         free(glyphArray);
2273         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2274                                         reason:@"advances in updateGlyphInfo"
2275                                         userInfo:nil];
2276         @throw exc;
2277     }
2278     CTFontGetAdvancesForGlyphs(
2279         (CTFontRef)screenFont, kCTFontHorizontalOrientation, glyphArray,
2280         advances, GLYPH_COUNT);
2281     CGFloat *glyphWidths = malloc(GLYPH_COUNT * sizeof(CGFloat));
2282     if (glyphWidths == 0) {
2283         free(glyphArray);
2284         free(advances);
2285         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2286                                         reason:@"glyphWidths in updateGlyphInfo"
2287                                         userInfo:nil];
2288         @throw exc;
2289     }
2290     for (i=0; i < GLYPH_COUNT; i++) {
2291         glyphWidths[i] = advances[i].width;
2292     }
2293
2294     /*
2295      * For good non-mono-font support, use the median advance. Start by sorting
2296      * all advances.
2297      */
2298     qsort(advances, GLYPH_COUNT, sizeof *advances, compare_advances);
2299
2300     /* Skip over any initially empty run */
2301     size_t startIdx;
2302     for (startIdx = 0; startIdx < GLYPH_COUNT; startIdx++)
2303     {
2304         if (advances[startIdx].width > 0) break;
2305     }
2306
2307     /* Pick the center to find the median */
2308     CGFloat medianAdvance = 0;
2309     /* In case we have all zero advances for some reason */
2310     if (startIdx < GLYPH_COUNT)
2311     {
2312         medianAdvance = advances[(startIdx + GLYPH_COUNT)/2].width;
2313     }
2314
2315     free(advances);
2316
2317     /*
2318      * Record the ascender and descender.  Some fonts, for instance DIN
2319      * Condensed and Rockwell in 10.14, the ascent on '@' exceeds that
2320      * reported by [screenFont ascender].  Get the overall bounding box
2321      * for the glyphs and use that instead of the ascender and descender
2322      * values if the bounding box result extends farther from the baseline.
2323      */
2324     CGRect bounds = CTFontGetBoundingRectsForGlyphs(
2325         (CTFontRef) screenFont, kCTFontHorizontalOrientation, glyphArray,
2326         NULL, GLYPH_COUNT);
2327     self->_fontAscender = [screenFont ascender];
2328     if (self->_fontAscender < bounds.origin.y + bounds.size.height) {
2329         self->_fontAscender = bounds.origin.y + bounds.size.height;
2330     }
2331     self->_fontDescender = [screenFont descender];
2332     if (self->_fontDescender > bounds.origin.y) {
2333         self->_fontDescender = bounds.origin.y;
2334     }
2335
2336     /*
2337      * Record the tile size.  Round both values up to have tile boundaries
2338      * match pixel boundaries.
2339      */
2340     self->_tileSize.width = ceil(medianAdvance);
2341     self->_tileSize.height = ceil(self.fontAscender - self.fontDescender);
2342
2343     /*
2344      * Determine whether neighboring columns need to be redrawn when a
2345      * character changes.
2346      */
2347     CGRect *boxes = malloc(GLYPH_COUNT * sizeof(CGRect));
2348     if (boxes == 0) {
2349         free(glyphWidths);
2350         free(glyphArray);
2351         NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
2352                                         reason:@"boxes in updateGlyphInfo"
2353                                         userInfo:nil];
2354         @throw exc;
2355     }
2356     CGFloat beyond_right = 0.;
2357     CGFloat beyond_left = 0.;
2358     CTFontGetBoundingRectsForGlyphs(
2359         (CTFontRef)screenFont,
2360         kCTFontHorizontalOrientation,
2361         glyphArray,
2362         boxes,
2363         GLYPH_COUNT);
2364     for (i = 0; i < GLYPH_COUNT; i++) {
2365         /* Account for the compression and offset used by drawWChar(). */
2366         CGFloat compression, offset;
2367         CGFloat v;
2368
2369         if (glyphWidths[i] <= self.tileSize.width) {
2370             compression = 1.;
2371             offset = 0.5 * (self.tileSize.width - glyphWidths[i]);
2372         } else {
2373             compression = self.tileSize.width / glyphWidths[i];
2374             offset = 0.;
2375         }
2376         v = (offset + boxes[i].origin.x) * compression;
2377         if (beyond_left > v) {
2378             beyond_left = v;
2379         }
2380         v = (offset + boxes[i].origin.x + boxes[i].size.width) * compression;
2381         if (beyond_right < v) {
2382             beyond_right = v;
2383         }
2384     }
2385     free(boxes);
2386     self->_nColPre = ceil(-beyond_left / self.tileSize.width);
2387     if (beyond_right > self.tileSize.width) {
2388         self->_nColPost =
2389             ceil((beyond_right - self.tileSize.width) / self.tileSize.width);
2390     } else {
2391         self->_nColPost = 0;
2392     }
2393
2394     free(glyphWidths);
2395     free(glyphArray);
2396 }
2397
2398
2399 - (void)requestRedraw
2400 {
2401     if (! self->terminal) return;
2402     
2403     term *old = Term;
2404     
2405     /* Activate the term */
2406     Term_activate(self->terminal);
2407     
2408     /* Redraw the contents */
2409     Term_redraw();
2410     
2411     /* Flush the output */
2412     Term_fresh();
2413     
2414     /* Restore the old term */
2415     Term_activate(old);
2416 }
2417
2418 - (void)setTerm:(term *)t
2419 {
2420     self->terminal = t;
2421 }
2422
2423 /**
2424  * If we're trying to limit ourselves to a certain number of frames per second,
2425  * then compute how long it's been since we last drew, and then wait until the
2426  * next frame has passed. */
2427 - (void)throttle
2428 {
2429     if (frames_per_second > 0)
2430     {
2431         CFAbsoluteTime now = CFAbsoluteTimeGetCurrent();
2432         CFTimeInterval timeSinceLastRefresh = now - self->lastRefreshTime;
2433         CFTimeInterval timeUntilNextRefresh = (1. / (double)frames_per_second) - timeSinceLastRefresh;
2434         
2435         if (timeUntilNextRefresh > 0)
2436         {
2437             usleep((unsigned long)(timeUntilNextRefresh * 1000000.));
2438         }
2439     }
2440     self->lastRefreshTime = CFAbsoluteTimeGetCurrent();
2441 }
2442
2443 - (void)drawWChar:(wchar_t)wchar inRect:(NSRect)tile screenFont:(NSFont*)font
2444           context:(CGContextRef)ctx
2445 {
2446     CGFloat tileOffsetY = self.fontAscender;
2447     CGFloat tileOffsetX = 0.0;
2448     UniChar unicharString[2] = {(UniChar)wchar, 0};
2449
2450     /* Get glyph and advance */
2451     CGGlyph thisGlyphArray[1] = { 0 };
2452     CGSize advances[1] = { { 0, 0 } };
2453     CTFontGetGlyphsForCharacters(
2454         (CTFontRef)font, unicharString, thisGlyphArray, 1);
2455     CGGlyph glyph = thisGlyphArray[0];
2456     CTFontGetAdvancesForGlyphs(
2457         (CTFontRef)font, kCTFontHorizontalOrientation, thisGlyphArray,
2458         advances, 1);
2459     CGSize advance = advances[0];
2460
2461     /*
2462      * If our font is not monospaced, our tile width is deliberately not big
2463      * enough for every character. In that event, if our glyph is too wide, we
2464      * need to compress it horizontally. Compute the compression ratio.
2465      * 1.0 means no compression.
2466      */
2467     double compressionRatio;
2468     if (advance.width <= NSWidth(tile))
2469     {
2470         /* Our glyph fits, so we can just draw it, possibly with an offset */
2471         compressionRatio = 1.0;
2472         tileOffsetX = (NSWidth(tile) - advance.width)/2;
2473     }
2474     else
2475     {
2476         /* Our glyph doesn't fit, so we'll have to compress it */
2477         compressionRatio = NSWidth(tile) / advance.width;
2478         tileOffsetX = 0;
2479     }
2480
2481     /* Now draw it */
2482     CGAffineTransform textMatrix = CGContextGetTextMatrix(ctx);
2483     CGFloat savedA = textMatrix.a;
2484
2485     /* Set the position */
2486     textMatrix.tx = tile.origin.x + tileOffsetX;
2487     textMatrix.ty = tile.origin.y + tileOffsetY;
2488
2489     /* Maybe squish it horizontally. */
2490     if (compressionRatio != 1.)
2491     {
2492         textMatrix.a *= compressionRatio;
2493     }
2494
2495     CGContextSetTextMatrix(ctx, textMatrix);
2496     CGContextShowGlyphsAtPositions(ctx, &glyph, &CGPointZero, 1);
2497
2498     /* Restore the text matrix if we messed with the compression ratio */
2499     if (compressionRatio != 1.)
2500     {
2501         textMatrix.a = savedA;
2502     }
2503
2504     CGContextSetTextMatrix(ctx, textMatrix);
2505 }
2506
2507 - (NSRect)viewRectForCellBlockAtX:(int)x y:(int)y width:(int)w height:(int)h
2508 {
2509     return NSMakeRect(
2510         x * self.tileSize.width + self.borderSize.width,
2511         y * self.tileSize.height + self.borderSize.height,
2512         w * self.tileSize.width, h * self.tileSize.height);
2513 }
2514
2515 - (void)setSelectionFont:(NSFont*)font adjustTerminal: (BOOL)adjustTerminal
2516 {
2517     /* Record the new font */
2518     self.angbandViewFont = font;
2519
2520     /* Update our glyph info */
2521     [self updateGlyphInfo];
2522
2523     if( adjustTerminal )
2524     {
2525         /*
2526          * Adjust terminal to fit window with new font; save the new columns
2527          * and rows since they could be changed
2528          */
2529         NSRect contentRect =
2530             [self.primaryWindow
2531                  contentRectForFrameRect: [self.primaryWindow frame]];
2532
2533         [self constrainWindowSize:[self terminalIndex]];
2534         NSSize size = self.primaryWindow.contentMinSize;
2535         BOOL windowNeedsResizing = NO;
2536         if (contentRect.size.width < size.width) {
2537             contentRect.size.width = size.width;
2538             windowNeedsResizing = YES;
2539         }
2540         if (contentRect.size.height < size.height) {
2541             contentRect.size.height = size.height;
2542             windowNeedsResizing = YES;
2543         }
2544         if (windowNeedsResizing) {
2545             size.width = contentRect.size.width;
2546             size.height = contentRect.size.height;
2547             [self.primaryWindow setContentSize:size];
2548         }
2549         [self resizeTerminalWithContentRect: contentRect saveToDefaults: YES];
2550     }
2551 }
2552
2553 - (id)init
2554 {
2555     if ((self = [super init]))
2556     {
2557         /* Default rows and cols */
2558         self->_cols = 80;
2559         self->_rows = 24;
2560
2561         /* Default border size */
2562         self->_borderSize = NSMakeSize(2, 2);
2563
2564         self->_nColPre = 0;
2565         self->_nColPost = 0;
2566
2567         self->_contents =
2568             [[TerminalContents alloc] initWithColumns:self->_cols
2569                                       rows:self->_rows];
2570         self->_changes =
2571             [[TerminalChanges alloc] initWithColumns:self->_cols
2572                                      rows:self->_rows];
2573         self->lastRefreshTime = CFAbsoluteTimeGetCurrent();
2574         self->inFullscreenTransition = NO;
2575
2576         self->_windowVisibilityChecked = NO;
2577     }
2578     return self;
2579 }
2580
2581 /**
2582  * Destroy all the receiver's stuff. This is intended to be callable more than
2583  * once.
2584  */
2585 - (void)dispose
2586 {
2587     self->terminal = NULL;
2588
2589     /* Disassociate ourselves from our view. */
2590     [self->angbandView setAngbandContext:nil];
2591     self->angbandView = nil;
2592
2593     /* Font */
2594     self.angbandViewFont = nil;
2595
2596     /* Window */
2597     [self.primaryWindow setDelegate:nil];
2598     [self.primaryWindow close];
2599     self.primaryWindow = nil;
2600
2601     /* Contents and pending changes */
2602     self.contents = nil;
2603     self.changes = nil;
2604 }
2605
2606 /* Usual Cocoa fare */
2607 - (void)dealloc
2608 {
2609     [self dispose];
2610 }
2611
2612 - (void)resizeWithColumns:(int)nCol rows:(int)nRow
2613 {
2614     [self.contents resizeWithColumns:nCol rows:nRow];
2615     [self.changes resizeWithColumns:nCol rows:nRow];
2616     self->_cols = nCol;
2617     self->_rows = nRow;
2618 }
2619
2620 /**
2621  * For defaultFont and setDefaultFont.
2622  */
2623 static __strong NSFont* gDefaultFont = nil;
2624
2625 + (NSFont*)defaultFont
2626 {
2627     return gDefaultFont;
2628 }
2629
2630 + (void)setDefaultFont:(NSFont*)font
2631 {
2632     gDefaultFont = font;
2633 }
2634
2635 - (void)setDefaultTitle:(int)termIdx
2636 {
2637     NSMutableString *title =
2638         [NSMutableString stringWithCString:angband_term_name[termIdx]
2639 #ifdef JP
2640                          encoding:NSJapaneseEUCStringEncoding
2641 #else
2642                          encoding:NSMacOSRomanStringEncoding
2643 #endif
2644         ];
2645     [title appendFormat:@" %dx%d", self.cols, self.rows];
2646     [[self makePrimaryWindow] setTitle:title];
2647 }
2648
2649 - (NSWindow *)makePrimaryWindow
2650 {
2651     if (! self.primaryWindow)
2652     {
2653         /*
2654          * This has to be done after the font is set, which it already is in
2655          * term_init_cocoa()
2656          */
2657         NSSize sz = self.baseSize;
2658         NSRect contentRect = NSMakeRect( 0.0, 0.0, sz.width, sz.height );
2659
2660         NSUInteger styleMask = NSTitledWindowMask | NSResizableWindowMask | NSMiniaturizableWindowMask;
2661
2662         /*
2663          * Make every window other than the main window closable, also create
2664          * them as utility panels to get the thinner title bar and other
2665          * attributes that already match up with how those windows are used.
2666          */
2667         if ((__bridge AngbandContext*) (angband_term[0]->data) != self)
2668         {
2669             NSPanel *panel =
2670                 [[NSPanel alloc] initWithContentRect:contentRect
2671                                  styleMask:(styleMask | NSClosableWindowMask |
2672                                             NSUtilityWindowMask)
2673                                  backing:NSBackingStoreBuffered defer:YES];
2674
2675             panel.floatingPanel = NO;
2676             self.primaryWindow = panel;
2677         } else {
2678             self.primaryWindow =
2679                 [[NSWindow alloc] initWithContentRect:contentRect
2680                                   styleMask:styleMask
2681                                   backing:NSBackingStoreBuffered defer:YES];
2682         }
2683
2684         /* Not to be released when closed */
2685         [self.primaryWindow setReleasedWhenClosed:NO];
2686         [self.primaryWindow setExcludedFromWindowsMenu: YES]; /* we're using custom window menu handling */
2687
2688         /* Make the view */
2689         self->angbandView = [[AngbandView alloc] initWithFrame:contentRect];
2690         [angbandView setAngbandContext:self];
2691         [angbandView setNeedsDisplay:YES];
2692         [self.primaryWindow setContentView:angbandView];
2693
2694         /* We are its delegate */
2695         [self.primaryWindow setDelegate:self];
2696     }
2697     return self.primaryWindow;
2698 }
2699
2700
2701 - (void)computeInvalidRects
2702 {
2703     for (int irow = self.changes.firstChangedRow;
2704          irow <= self.changes.lastChangedRow;
2705          ++irow) {
2706         int icol = [self.changes scanForChangedInRow:irow
2707                         col0:0 col1:self.cols];
2708
2709         while (icol < self.cols) {
2710             /* Find the end of the changed region. */
2711             int jcol =
2712                 [self.changes scanForUnchangedInRow:irow col0:(icol + 1)
2713                      col1:self.cols];
2714
2715             /*
2716              * If the last column is a character, extend the region drawn
2717              * because characters can exceed the horizontal bounds of the cell
2718              * and those parts will need to be cleared.  Don't extend into a
2719              * tile because the clipping is set while drawing to never
2720              * extend text into a tile.  For a big character that's been
2721              * partially overwritten, allow what comes after the point
2722              * where the overwrite occurred to influence the stuff before
2723              * but not vice versa.  If extending the region reaches another
2724              * changed block, find the end of that block and repeat the
2725              * process.
2726              */
2727             /*
2728              * A value of zero means checking for a character immediately
2729              * prior to the column, isrch.  A value of one means checking for
2730              * something past the end that could either influence the changed
2731              * region (within nColPre of it and no intervening tile) or be
2732              * influenced by it (within nColPost of it and no intervening
2733              * tile or partially overwritten big character).  A value of two
2734              * means checking for something past the end which is both changed
2735              * and could affect the part of the unchanged region that has to
2736              * be redrawn because it is affected by the prior changed region
2737              * Values of three and four are like one and two, respectively,
2738              * but indicate that a partially overwritten big character was
2739              * found.
2740              */
2741             int stage = 0;
2742             int isrch = jcol;
2743             int irng0 = jcol;
2744             int irng1 = jcol;
2745             while (1) {
2746                 if (stage == 0) {
2747                     const struct TerminalCell *pcell =
2748                         [self.contents getCellAtColumn:(isrch - 1) row:irow];
2749                     if ((pcell->form &
2750                          (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
2751                         break;
2752                     } else {
2753                         irng0 = isrch + self.nColPre;
2754                         if (irng0 > self.cols) {
2755                             irng0 = self.cols;
2756                         }
2757                         irng1 = isrch + self.nColPost;
2758                         if (irng1 > self.cols) {
2759                             irng1 = self.cols;
2760                         }
2761                         if (isrch < irng0 || isrch < irng1) {
2762                             stage = isPartiallyOverwrittenBigChar(pcell) ?
2763                                 3 : 1;
2764                         } else {
2765                             break;
2766                         }
2767                     }
2768                 }
2769
2770                 if (stage == 1) {
2771                     const struct TerminalCell *pcell =
2772                         [self.contents getCellAtColumn:isrch row:irow];
2773
2774                     if ((pcell->form &
2775                          (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
2776                         /*
2777                          * Check if still in the region that could be
2778                          * influenced by the changed region.  If so,
2779                          * everything up to the tile will be redrawn anyways
2780                          * so combine the regions if the tile has changed
2781                          * as well.  Otherwise, terminate the search since
2782                          * the tile doesn't allow influence to propagate
2783                          * through it and don't want to affect what's in the
2784                          * tile.
2785                          */
2786                         if (isrch < irng1) {
2787                             if ([self.changes isChangedAtColumn:isrch
2788                                      row:irow]) {
2789                                 jcol = [self.changes scanForUnchangedInRow:irow
2790                                             col0:(isrch + 1) col1:self.cols];
2791                                 if (jcol < self.cols) {
2792                                     stage = 0;
2793                                     isrch = jcol;
2794                                     continue;
2795                                 }
2796                             }
2797                         }
2798                         break;
2799                     } else {
2800                         /*
2801                          * With a changed character, combine the regions (if
2802                          * still in the region affected by the changed region
2803                          * am going to redraw everything up to this new region
2804                          * anyway; if only in the region that can affect the
2805                          * changed region, this changed text could influence
2806                          * the current changed region).
2807                          */
2808                         if ([self.changes isChangedAtColumn:isrch row:irow]) {
2809                             jcol = [self.changes scanForUnchangedInRow:irow
2810                                         col0:(isrch + 1) col1:self.cols];
2811                             if (jcol < self.cols) {
2812                                 stage = 0;
2813                                 isrch = jcol;
2814                                 continue;
2815                             }
2816                             break;
2817                         }
2818
2819                         if (isrch < irng1) {
2820                             /*
2821                              * Can be affected by the changed region so
2822                              * has to be redrawn.
2823                              */
2824                             ++jcol;
2825                         }
2826                         ++isrch;
2827                         if (isrch >= irng1) {
2828                             irng0 = jcol + self.nColPre;
2829                             if (irng0 > self.cols) {
2830                                 irng0 = self.cols;
2831                             }
2832                             if (isrch >= irng0) {
2833                                 break;
2834                             }
2835                             stage = isPartiallyOverwrittenBigChar(pcell) ?
2836                                 4 : 2;
2837                         } else if (isPartiallyOverwrittenBigChar(pcell)) {
2838                             stage = 3;
2839                         }
2840                     }
2841                 }
2842
2843                 if (stage == 2) {
2844                     /*
2845                      * Looking for a later changed region that could influence
2846                      * the region that has to be redrawn.  The region that has
2847                      * to be redrawn ends just before jcol.
2848                      */
2849                     const struct TerminalCell *pcell =
2850                         [self.contents getCellAtColumn:isrch row:irow];
2851
2852                     if ((pcell->form &
2853                          (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
2854                         /* Can not spread influence through a tile. */
2855                         break;
2856                     }
2857                     if ([self.changes isChangedAtColumn:isrch row:irow]) {
2858                         /*
2859                          * Found one.  Combine with the one ending just before
2860                          * jcol.
2861                          */
2862                         jcol = [self.changes scanForUnchangedInRow:irow
2863                                     col0:(isrch + 1) col1:self.cols];
2864                         if (jcol < self.cols) {
2865                             stage = 0;
2866                             isrch = jcol;
2867                             continue;
2868                         }
2869                         break;
2870                     }
2871
2872                     ++isrch;
2873                     if (isrch >= irng0) {
2874                         break;
2875                     }
2876                     if (isPartiallyOverwrittenBigChar(pcell)) {
2877                         stage = 4;
2878                     }
2879                 }
2880
2881                 if (stage == 3) {
2882                     const struct TerminalCell *pcell =
2883                         [self.contents getCellAtColumn:isrch row:irow];
2884
2885                     /*
2886                      * Have encountered a partially overwritten big character
2887                      * but still may be in the region that could be influenced
2888                      * by the changed region.  That influence can not extend
2889                      * past the past the padding for the partially overwritten
2890                      * character.
2891                      */
2892                     if ((pcell->form & (TERM_CELL_CHAR | TERM_CELL_TILE |
2893                                         TERM_CELL_TILE_PADDING)) != 0) {
2894                         if (isrch < irng1) {
2895                             /*
2896                              * Still can be affected by the changed region
2897                              * so everything up to isrch will be redrawn
2898                              * anyways.  If this location has changed,
2899                              * merge the changed regions.
2900                              */
2901                             if ([self.changes isChangedAtColumn:isrch
2902                                      row:irow]) {
2903                                 jcol = [self.changes scanForUnchangedInRow:irow
2904                                             col0:(isrch + 1) col1:self.cols];
2905                                 if (jcol < self.cols) {
2906                                     stage = 0;
2907                                     isrch = jcol;
2908                                     continue;
2909                                 }
2910                                 break;
2911                             }
2912                         }
2913                         if ((pcell->form &
2914                              (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
2915                             /*
2916                              * It's a tile.  That blocks influence in either
2917                              * direction.
2918                              */
2919                             break;
2920                         }
2921
2922                         /*
2923                          * The partially overwritten big character was
2924                          * overwritten by a character.  Check to see if it
2925                          * can either influence the unchanged region that
2926                          * has to redrawn or the changed region prior to
2927                          * that.
2928                          */
2929                         if (isrch >= irng0) {
2930                             break;
2931                         }
2932                         stage = 4;
2933                     } else {
2934                         if (isrch < irng1) {
2935                             /*
2936                              * Can be affected by the changed region so has to
2937                              * be redrawn.
2938                              */
2939                             ++jcol;
2940                         }
2941                         ++isrch;
2942                         if (isrch >= irng1) {
2943                             irng0 = jcol + self.nColPre;
2944                             if (irng0 > self.cols) {
2945                                 irng0 = self.cols;
2946                             }
2947                             if (isrch >= irng0) {
2948                                 break;
2949                             }
2950                             stage = 4;
2951                         }
2952                     }
2953                 }
2954
2955                 if (stage == 4) {
2956                     /*
2957                      * Have already encountered a partially overwritten big
2958                      * character.  Looking for a later changed region that
2959                      * could influence the region that has to be redrawn
2960                      * The region that has to be redrawn ends just before jcol.
2961                      */
2962                     const struct TerminalCell *pcell =
2963                         [self.contents getCellAtColumn:isrch row:irow];
2964
2965                     if ((pcell->form &
2966                          (TERM_CELL_TILE | TERM_CELL_TILE_PADDING)) != 0) {
2967                         /* Can not spread influence through a tile. */
2968                         break;
2969                     }
2970                     if (pcell->form == TERM_CELL_CHAR) {
2971                         if ([self.changes isChangedAtColumn:isrch row:irow]) {
2972                             /*
2973                              * Found a changed region.  Combine with the one
2974                              * ending just before jcol.
2975                              */
2976                             jcol = [self.changes scanForUnchangedInRow:irow
2977                                         col0:(isrch + 1) col1:self.cols];
2978                             if (jcol < self.cols) {
2979                                 stage = 0;
2980                                 isrch = jcol;
2981                                 continue;
2982                             }
2983                             break;
2984                         }
2985                     }
2986                     ++isrch;
2987                     if (isrch >= irng0) {
2988                         break;
2989                     }
2990                 }
2991             }
2992
2993             /*
2994              * Check to see if there's characters before the changed region
2995              * that would have to be redrawn because it's influenced by the
2996              * changed region.  Do not have to check for merging with a prior
2997              * region because of the screening already done.
2998              */
2999             if (self.nColPre > 0 &&
3000                 ([self.contents getCellAtColumn:icol row:irow]->form &
3001                  (TERM_CELL_CHAR | TERM_CELL_CHAR_PADDING)) != 0) {
3002                 int irng = icol - self.nColPre;
3003
3004                 if (irng < 0) {
3005                     irng = 0;
3006                 }
3007                 while (icol > irng &&
3008                        ([self.contents getCellAtColumn:(icol - 1)
3009                              row:irow]->form &
3010                         (TERM_CELL_CHAR | TERM_CELL_CHAR_PADDING)) != 0) {
3011                     --icol;
3012                 }
3013             }
3014
3015             NSRect r = [self viewRectForCellBlockAtX:icol y:irow
3016                              width:(jcol - icol) height:1];
3017             [self setNeedsDisplayInRect:r];
3018
3019             icol = [self.changes scanForChangedInRow:irow col0:jcol
3020                         col1:self.cols];
3021         }
3022     }
3023 }
3024
3025
3026 #pragma mark View/Window Passthrough
3027
3028 /*
3029  * This is a qsort-compatible compare function for NSRect, to get them in
3030  * ascending order by y origin.
3031  */
3032 static int compare_nsrect_yorigin_greater(const void *ap, const void *bp)
3033 {
3034     const NSRect *arp = ap;
3035     const NSRect *brp = bp;
3036     return (arp->origin.y > brp->origin.y) - (arp->origin.y < brp->origin.y);
3037 }
3038
3039 /**
3040  * This is a helper function for drawRect.
3041  */
3042 - (void)renderTileRunInRow:(int)irow col0:(int)icol0 col1:(int)icol1
3043                      nsctx:(NSGraphicsContext*)nsctx ctx:(CGContextRef)ctx
3044                  grafWidth:(int)graf_width grafHeight:(int)graf_height
3045                overdrawRow:(int)overdraw_row overdrawMax:(int)overdraw_max
3046 {
3047     /* Save the compositing mode since it is modified below. */
3048     NSCompositingOperation op = nsctx.compositingOperation;
3049
3050     while (icol0 < icol1) {
3051         const struct TerminalCell *pcell =
3052             [self.contents getCellAtColumn:icol0 row:irow];
3053         NSRect destinationRect =
3054             [self viewRectForCellBlockAtX:icol0 y:irow
3055                   width:pcell->hscl height:pcell->vscl];
3056         NSRect fgdRect = NSMakeRect(
3057             graf_width * (pcell->v.ti.fgdCol +
3058                           pcell->hoff_n / (1.0 * pcell->hoff_d)),
3059             graf_height * (pcell->v.ti.fgdRow +
3060                            pcell->voff_n / (1.0 * pcell->voff_d)),
3061             graf_width * pcell->hscl / (1.0 * pcell->hoff_d),
3062             graf_height * pcell->vscl / (1.0 * pcell->voff_d));
3063         NSRect bckRect = NSMakeRect(
3064             graf_width * (pcell->v.ti.bckCol +
3065                           pcell->hoff_n / (1.0 * pcell->hoff_d)),
3066             graf_height * (pcell->v.ti.bckRow +
3067                            pcell->voff_n / (1.0 * pcell->voff_d)),
3068             graf_width * pcell->hscl / (1.0 * pcell->hoff_d),
3069             graf_height * pcell->vscl / (1.0 * pcell->voff_d));
3070         int dbl_height_bck = overdraw_row && (irow > 2) &&
3071             (pcell->v.ti.bckRow >= overdraw_row &&
3072              pcell->v.ti.bckRow <= overdraw_max);
3073         int dbl_height_fgd = overdraw_row && (irow > 2) &&
3074             (pcell->v.ti.fgdRow >= overdraw_row) &&
3075             (pcell->v.ti.fgdRow <= overdraw_max);
3076         int aligned_row = 0, aligned_col = 0;
3077         int is_first_piece = 0, simple_upper = 0;
3078
3079         /* Initialize stuff for handling a double-height tile. */
3080         if (dbl_height_bck || dbl_height_fgd) {
3081             if (self->terminal == angband_term[0]) {
3082                 aligned_col = ((icol0 - COL_MAP) / pcell->hoff_d) *
3083                     pcell->hoff_d + COL_MAP;
3084             } else {
3085                 aligned_col = (icol0 / pcell->hoff_d) * pcell->hoff_d;
3086             }
3087             aligned_row = ((irow - ROW_MAP) / pcell->voff_d) *
3088                 pcell->voff_d + ROW_MAP;
3089
3090             /*
3091              * If the lower half has been broken into multiple pieces, only
3092              * do the work of rendering whatever is necessary for the upper
3093              * half when drawing the first piece (the one closest to the
3094              * upper left corner).
3095              */
3096             struct TerminalCellLocation curs = { 0, 0 };
3097
3098             [self.contents scanForTypeMaskInBlockAtColumn:aligned_col
3099                  row:aligned_row width:pcell->hoff_d height:pcell->voff_d
3100                  mask:TERM_CELL_TILE cursor:&curs];
3101             if (curs.col + aligned_col == icol0 &&
3102                 curs.row + aligned_row == irow) {
3103                 is_first_piece = 1;
3104
3105                 /*
3106                  * Hack:  lookup the previous row to determine how much of the
3107                  * tile there is shown to apply it the upper half of the
3108                  * double-height tile.  That will do the right thing if there
3109                  * is a menu displayed in that row but isn't right if there's
3110                  * an object/creature/feature there that doesn't have a
3111                  * mapping to the tile set and is rendered with a character.
3112                  */
3113                 curs.col = 0;
3114                 curs.row = 0;
3115                 [self.contents scanForTypeMaskInBlockAtColumn:aligned_col
3116                      row:(aligned_row - pcell->voff_d) width:pcell->hoff_d
3117                      height:pcell->voff_d mask:TERM_CELL_TILE cursor:&curs];
3118                 if (curs.col == 0 && curs.row == 0) {
3119                     const struct TerminalCell *pcell2 =
3120                         [self.contents
3121                              getCellAtColumn:(aligned_col + curs.col)
3122                              row:(aligned_row + curs.row - pcell->voff_d)];
3123
3124                     if (pcell2->hscl == pcell2->hoff_d &&
3125                         pcell2->vscl == pcell2->voff_d) {
3126                         /*
3127                          * The tile in the previous row hasn't been clipped
3128                          * or partially overwritten.  Use a streamlined
3129                          * rendering procedure.
3130                          */
3131                         simple_upper = 1;
3132                     }
3133                 }
3134             }
3135         }
3136
3137         /*
3138          * Draw the background.  For a double-height tile, this is only the
3139          * the lower half.
3140          */
3141         draw_image_tile(
3142             nsctx, ctx, pict_image, bckRect, destinationRect, NSCompositeCopy);
3143         if (dbl_height_bck && is_first_piece) {
3144             /* Combine upper half with previously drawn row. */
3145             if (simple_upper) {
3146                 const struct TerminalCell *pcell2 =
3147                     [self.contents getCellAtColumn:aligned_col
3148                          row:(aligned_row - pcell->voff_d)];
3149                 NSRect drect2 =
3150                     [self viewRectForCellBlockAtX:aligned_col
3151                           y:(aligned_row - pcell->voff_d)
3152                           width:pcell2->hscl height:pcell2->vscl];
3153                 NSRect brect2 = NSMakeRect(
3154                     graf_width * pcell->v.ti.bckCol,
3155                     graf_height * (pcell->v.ti.bckRow - 1),
3156                     graf_width, graf_height);
3157
3158                 draw_image_tile(nsctx, ctx, pict_image, brect2, drect2,
3159                                 NSCompositeSourceOver);
3160             } else {
3161                 struct TerminalCellLocation curs = { 0, 0 };
3162
3163                 [self.contents scanForTypeMaskInBlockAtColumn:aligned_col
3164                      row:(aligned_row - pcell->voff_d) width:pcell->hoff_d
3165                      height:pcell->voff_d mask:TERM_CELL_TILE
3166                      cursor:&curs];
3167                 while (curs.col < pcell->hoff_d &&
3168                        curs.row < pcell->voff_d) {
3169                     const struct TerminalCell *pcell2 =
3170                         [self.contents getCellAtColumn:(aligned_col + curs.col)
3171                              row:(aligned_row + curs.row - pcell->voff_d)];
3172                     NSRect drect2 =
3173                         [self viewRectForCellBlockAtX:(aligned_col + curs.col)
3174                               y:(aligned_row + curs.row - pcell->voff_d)
3175                               width:pcell2->hscl height:pcell2->vscl];
3176                     /*
3177                      * Column and row in the tile set are from the
3178                      * double-height tile at *pcell, but the offsets within
3179                      * that and size are from what's visible for *pcell2.
3180                      */
3181                     NSRect brect2 = NSMakeRect(
3182                         graf_width * (pcell->v.ti.bckCol +
3183                                       pcell2->hoff_n / (1.0 * pcell2->hoff_d)),
3184                         graf_height * (pcell->v.ti.bckRow - 1 +
3185                                        pcell2->voff_n /
3186                                        (1.0 * pcell2->voff_d)),
3187                         graf_width * pcell2->hscl / (1.0 * pcell2->hoff_d),
3188                         graf_height * pcell2->vscl / (1.0 * pcell2->voff_d));
3189
3190                     draw_image_tile(nsctx, ctx, pict_image, brect2, drect2,
3191                                     NSCompositeSourceOver);
3192                     curs.col += pcell2->hscl;
3193                     [self.contents
3194                          scanForTypeMaskInBlockAtColumn:aligned_col
3195                          row:(aligned_row - pcell->voff_d)
3196                          width:pcell->hoff_d height:pcell->voff_d
3197                          mask:TERM_CELL_TILE cursor:&curs];
3198                 }
3199             }
3200         }
3201
3202         /* Skip drawing the foreground if it is the same as the background. */
3203         if (fgdRect.origin.x != bckRect.origin.x ||
3204             fgdRect.origin.y != bckRect.origin.y) {
3205             if (is_first_piece && dbl_height_fgd) {
3206                 if (simple_upper) {
3207                     if (pcell->hoff_n == 0 && pcell->voff_n == 0 &&
3208                         pcell->hscl == pcell->hoff_d) {
3209                         /*
3210                          * Render upper and lower parts as one since they
3211                          * are contiguous.
3212                          */
3213                         fgdRect.origin.y -= graf_height;
3214                         fgdRect.size.height += graf_height;
3215                         destinationRect.origin.y -=
3216                             destinationRect.size.height;
3217                         destinationRect.size.height +=
3218                             destinationRect.size.height;
3219                     } else {
3220                         /* Not contiguous.  Render the upper half. */
3221                         NSRect drect2 =
3222                             [self viewRectForCellBlockAtX:aligned_col
3223                                   y:(aligned_row - pcell->voff_d)
3224                                   width:pcell->hoff_d height:pcell->voff_d];
3225                         NSRect frect2 = NSMakeRect(
3226                             graf_width * pcell->v.ti.fgdCol,
3227                             graf_height * (pcell->v.ti.fgdRow - 1),
3228                             graf_width, graf_height);
3229
3230                         draw_image_tile(
3231                             nsctx, ctx, pict_image, frect2, drect2,
3232                             NSCompositeSourceOver);
3233                     }
3234                 } else {
3235                     /* Render the upper half pieces. */
3236                     struct TerminalCellLocation curs = { 0, 0 };
3237
3238                     while (1) {
3239                         [self.contents
3240                              scanForTypeMaskInBlockAtColumn:aligned_col
3241                              row:(aligned_row - pcell->voff_d)
3242                              width:pcell->hoff_d height:pcell->voff_d
3243                              mask:TERM_CELL_TILE cursor:&curs];
3244
3245                         if (curs.col >= pcell->hoff_d ||
3246                             curs.row >= pcell->voff_d) {
3247                             break;
3248                         }
3249
3250                         const struct TerminalCell *pcell2 =
3251                             [self.contents
3252                                  getCellAtColumn:(aligned_col + curs.col)
3253                                  row:(aligned_row + curs.row - pcell->voff_d)];
3254                         NSRect drect2 =
3255                             [self viewRectForCellBlockAtX:(aligned_col + curs.col)
3256                                   y:(aligned_row + curs.row - pcell->voff_d)
3257                                   width:pcell2->hscl height:pcell2->vscl];
3258                         NSRect frect2 = NSMakeRect(
3259                             graf_width * (pcell->v.ti.fgdCol +
3260                                           pcell2->hoff_n /
3261                                           (1.0 * pcell2->hoff_d)),
3262                             graf_height * (pcell->v.ti.fgdRow - 1 +
3263                                            pcell2->voff_n /
3264                                            (1.0 * pcell2->voff_d)),
3265                             graf_width * pcell2->hscl / (1.0 * pcell2->hoff_d),
3266                             graf_height * pcell2->vscl /
3267                                 (1.0 * pcell2->voff_d));
3268
3269                         draw_image_tile(nsctx, ctx, pict_image, frect2, drect2,
3270                                         NSCompositeSourceOver);
3271                         curs.col += pcell2->hscl;
3272                     }
3273                 }
3274             }
3275             /*
3276              * Render the foreground (if a double height tile and the bottom
3277              * part is contiguous with the upper part this also render the
3278              * upper part.
3279              */
3280             draw_image_tile(
3281                 nsctx, ctx, pict_image, fgdRect, destinationRect,
3282                 NSCompositeSourceOver);
3283         }
3284         icol0 = [self.contents scanForTypeMaskInRow:irow mask:TERM_CELL_TILE
3285                      col0:(icol0+pcell->hscl) col1:icol1];
3286     }
3287
3288     /* Restore the compositing mode. */
3289     nsctx.compositingOperation = op;
3290 }
3291
3292 /**
3293  * This is what our views call to get us to draw to the window
3294  */
3295 - (void)drawRect:(NSRect)rect inView:(NSView *)view
3296 {
3297     /*
3298      * Take this opportunity to throttle so we don't flush faster than desired.
3299      */
3300     [self throttle];
3301
3302     CGFloat bottomY =
3303         self.borderSize.height + self.tileSize.height * self.rows;
3304     CGFloat rightX =
3305         self.borderSize.width + self.tileSize.width * self.cols;
3306
3307     const NSRect *invalidRects;
3308     NSInteger invalidCount;
3309     [view getRectsBeingDrawn:&invalidRects count:&invalidCount];
3310
3311     /*
3312      * If the non-border areas need rendering, set some things up so they can
3313      * be reused for each invalid rectangle.
3314      */
3315     NSGraphicsContext *nsctx = nil;
3316     CGContextRef ctx = 0;
3317     NSFont* screenFont = nil;
3318     int graf_width = 0, graf_height = 0;
3319     int overdraw_row = 0, overdraw_max = 0;
3320     wchar_t blank = 0;
3321     if (rect.origin.x < rightX &&
3322         rect.origin.x + rect.size.width > self.borderSize.width &&
3323         rect.origin.y < bottomY &&
3324         rect.origin.y + rect.size.height > self.borderSize.height) {
3325         nsctx = [NSGraphicsContext currentContext];
3326         ctx = [nsctx graphicsPort];
3327         screenFont = [self.angbandViewFont screenFont];
3328         [screenFont set];
3329         blank = [TerminalContents getBlankChar];
3330         if (use_graphics) {
3331             graf_width = current_graphics_mode->cell_width;
3332             graf_height = current_graphics_mode->cell_height;
3333             overdraw_row = current_graphics_mode->overdrawRow;
3334             overdraw_max = current_graphics_mode->overdrawMax;
3335         }
3336     }
3337
3338     /*
3339      * With double height tiles, need to have rendered prior rows (i.e.
3340      * smaller y) before the current one.  Since the invalid rectanges are
3341      * processed in order, ensure that by sorting the invalid rectangles in
3342      * increasing order of y origin (AppKit guarantees the invalid rectanges
3343      * are non-overlapping).
3344      */
3345     NSRect* sortedRects = 0;
3346     const NSRect* workingRects;
3347     if (overdraw_row && invalidCount > 1) {
3348         sortedRects = malloc(invalidCount * sizeof(NSRect));
3349         if (sortedRects == 0) {
3350             NSException *exc = [NSException exceptionWithName:@"OutOfMemory"
3351                                             reason:@"sorted rects in drawRect"
3352                                             userInfo:nil];
3353             @throw exc;
3354         }
3355         (void) memcpy(
3356             sortedRects, invalidRects, invalidCount * sizeof(NSRect));
3357         qsort(sortedRects, invalidCount, sizeof(NSRect),
3358               compare_nsrect_yorigin_greater);
3359         workingRects = sortedRects;
3360     } else {
3361         workingRects = invalidRects;
3362     }
3363
3364     /*
3365      * Use -2 for unknown.  Use -1 for Cocoa's blackColor.  All others are the
3366      * Angband color index.
3367      */
3368     int alast = -2;
3369     int redrawCursor = 0;
3370
3371     for (NSInteger irect = 0; irect < invalidCount; ++irect) {
3372         NSRect modRect, clearRect;
3373         CGFloat edge;
3374         int iRowFirst, iRowLast;
3375         int iColFirst, iColLast;
3376
3377         /* Handle the top border. */
3378         if (workingRects[irect].origin.y < self.borderSize.height) {
3379             edge =
3380                 workingRects[irect].origin.y + workingRects[irect].size.height;
3381             if (edge <= self.borderSize.height) {
3382                 if (alast != -1) {
3383                     [[NSColor blackColor] set];
3384                     alast = -1;
3385                 }
3386                 NSRectFill(workingRects[irect]);
3387                 continue;
3388             }
3389             clearRect = workingRects[irect];
3390             clearRect.size.height =
3391                 self.borderSize.height - workingRects[irect].origin.y;
3392             if (alast != -1) {
3393                 [[NSColor blackColor] set];
3394                 alast = -1;
3395             }
3396             NSRectFill(clearRect);
3397             modRect.origin.x = workingRects[irect].origin.x;
3398             modRect.origin.y = self.borderSize.height;
3399             modRect.size.width = workingRects[irect].size.width;
3400             modRect.size.height = edge - self.borderSize.height;
3401         } else {
3402             modRect = workingRects[irect];
3403         }
3404
3405         /* Handle the left border. */
3406         if (modRect.origin.x < self.borderSize.width) {
3407             edge = modRect.origin.x + modRect.size.width;
3408             if (edge <= self.borderSize.width) {
3409                 if (alast != -1) {
3410                     alast = -1;
3411                     [[NSColor blackColor] set];
3412                 }
3413                 NSRectFill(modRect);
3414                 continue;
3415             }
3416             clearRect = modRect;
3417             clearRect.size.width = self.borderSize.width - clearRect.origin.x;
3418             if (alast != -1) {
3419                 alast = -1;
3420                 [[NSColor blackColor] set];
3421             }
3422             NSRectFill(clearRect);
3423             modRect.origin.x = self.borderSize.width;
3424             modRect.size.width = edge - self.borderSize.width;
3425         }
3426
3427         iRowFirst = floor((modRect.origin.y - self.borderSize.height) /
3428                           self.tileSize.height);
3429         iColFirst = floor((modRect.origin.x - self.borderSize.width) /
3430                           self.tileSize.width);
3431         edge = modRect.origin.y + modRect.size.height;
3432         if (edge <= bottomY) {
3433             iRowLast =
3434                 ceil((edge - self.borderSize.height) / self.tileSize.height);
3435         } else {
3436             iRowLast = self.rows;
3437         }
3438         edge = modRect.origin.x + modRect.size.width;
3439         if (edge <= rightX) {
3440             iColLast =
3441                 ceil((edge - self.borderSize.width) / self.tileSize.width);
3442         } else {
3443             iColLast = self.cols;
3444         }
3445
3446         if (self.contents.cursorColumn != -1 &&
3447             self.contents.cursorRow != -1 &&
3448             self.contents.cursorColumn + self.contents.cursorWidth - 1 >=
3449             iColFirst &&
3450             self.contents.cursorColumn < iColLast &&
3451             self.contents.cursorRow + self.contents.cursorHeight - 1 >=
3452             iRowFirst &&
3453             self.contents.cursorRow < iRowLast) {
3454             redrawCursor = 1;
3455         }
3456
3457         for (int irow = iRowFirst; irow < iRowLast; ++irow) {
3458             int icol =
3459                 [self.contents scanForTypeMaskInRow:irow
3460                      mask:(TERM_CELL_CHAR | TERM_CELL_TILE)
3461                      col0:iColFirst col1:iColLast];
3462
3463             while (1) {
3464                 if (icol >= iColLast) {
3465                     break;
3466                 }
3467
3468                 if ([self.contents getCellAtColumn:icol row:irow]->form ==
3469                     TERM_CELL_TILE) {
3470                     /*
3471                      * It is a tile.  Identify how far the run of tiles goes.
3472                      */
3473                     int jcol = [self.contents scanForPredicateInRow:irow
3474                                     predicate:isTileTop desired:1
3475                                     col0:(icol + 1) col1:iColLast];
3476
3477                     [self renderTileRunInRow:irow col0:icol col1:jcol
3478                           nsctx:nsctx ctx:ctx
3479                           grafWidth:graf_width grafHeight:graf_height
3480                           overdrawRow:overdraw_row overdrawMax:overdraw_max];
3481                     icol = jcol;
3482                 } else {
3483                     /*
3484                      * It is a character.  Identify how far the run of
3485                      * characters goes.
3486                      */
3487                     int jcol = [self.contents scanForPredicateInRow:irow
3488                                     predicate:isCharNoPartial desired:1
3489                                     col0:(icol + 1) col1:iColLast];
3490                     int jcol2;
3491
3492                     if (jcol < iColLast &&
3493                         isPartiallyOverwrittenBigChar(
3494                             [self.contents getCellAtColumn:jcol row:irow])) {
3495                         jcol2 = [self.contents scanForTypeMaskInRow:irow
3496                                      mask:~TERM_CELL_CHAR_PADDING
3497                                      col0:(jcol + 1) col1:iColLast];
3498                     } else {
3499                         jcol2 = jcol;
3500                     }
3501
3502                     /*
3503                      * Set up clipping rectangle for text.  Save the
3504                      * graphics context so the clipping rectangle can be
3505                      * forgotten.  Use CGContextBeginPath to clear the current
3506                      * path so it does not affect clipping.  Do not call
3507                      * CGContextSetTextDrawingMode() to include clipping since
3508                      * that does not appear to necessary on 10.14 and is
3509                      * actually detrimental:  when displaying more than one
3510                      * character, only the first is visible.
3511                      */
3512                     CGContextSaveGState(ctx);
3513                     CGContextBeginPath(ctx);
3514                     NSRect r = [self viewRectForCellBlockAtX:icol y:irow
3515                                      width:(jcol2 - icol) height:1];
3516                     CGContextClipToRect(ctx, r);
3517
3518                     /*
3519                      * See if the region to be rendered needs to be expanded:
3520                      * adjacent text that could influence what's in the clipped
3521                      * region.
3522                      */
3523                     int isrch = icol;
3524                     int irng = icol - self.nColPost;
3525                     if (irng < 1) {
3526                         irng = 1;
3527                     }
3528
3529                     while (1) {
3530                         if (isrch <= irng) {
3531                             break;
3532                         }
3533
3534                         const struct TerminalCell *pcell2 =
3535                             [self.contents getCellAtColumn:(isrch - 1)
3536                                  row:irow];
3537                         if (pcell2->form == TERM_CELL_CHAR) {
3538                             --isrch;
3539                             if (pcell2->v.ch.glyph != blank) {
3540                                 icol = isrch;
3541                             }
3542                         } else if (pcell2->form == TERM_CELL_CHAR_PADDING) {
3543                             /*
3544                              * Only extend the rendering if this is padding
3545                              * for a character that hasn't been partially
3546                              * overwritten.
3547                              */
3548                             if (! isPartiallyOverwrittenBigChar(pcell2)) {
3549                                 if (isrch - pcell2->v.pd.hoff >= 0) {
3550                                     const struct TerminalCell* pcell3 =
3551                                         [self.contents
3552                                              getCellAtColumn:(isrch - pcell2->v.pd.hoff)
3553                                              row:irow];
3554
3555                                     if (pcell3->v.ch.glyph != blank) {
3556                                         icol = isrch - pcell2->v.pd.hoff;
3557                                         isrch = icol - 1;
3558                                     } else {
3559                                         isrch = isrch - pcell2->v.pd.hoff - 1;
3560                                     }
3561                                 } else {
3562                                     /* Should not happen, corrupt offset. */
3563                                     --isrch;
3564                                 }
3565                             } else {
3566                                 break;
3567                             }
3568                         } else {
3569                             /*
3570                              * Tiles or tile padding block anything before
3571                              * them from rendering after them.
3572                              */
3573                             break;
3574                         }
3575                     }
3576
3577                     isrch = jcol2;
3578                     irng = jcol2 + self.nColPre;
3579                     if (irng > self.cols) {
3580                         irng = self.cols;
3581                     }
3582                     while (1) {
3583                         if (isrch >= irng) {
3584                             break;
3585                         }
3586
3587                         const struct TerminalCell *pcell2 =
3588                             [self.contents getCellAtColumn:isrch row:irow];
3589                         if (pcell2->form == TERM_CELL_CHAR) {
3590                             if (pcell2->v.ch.glyph != blank) {
3591                                 jcol2 = isrch;
3592                             }
3593                             ++isrch;
3594                         } else if (pcell2->form == TERM_CELL_CHAR_PADDING) {
3595                             ++isrch;
3596                         } else {
3597                             break;
3598                         }
3599                     }
3600
3601                     /* Render text. */
3602                     /* Clear where rendering will be done. */
3603                     if (alast != -1) {
3604                         [[NSColor blackColor] set];
3605                         alast = -1;
3606                     }
3607                     r = [self viewRectForCellBlockAtX:icol y:irow
3608                               width:(jcol - icol) height:1];
3609                     NSRectFill(r);
3610
3611                     while (icol < jcol) {
3612                         const struct TerminalCell *pcell =
3613                             [self.contents getCellAtColumn:icol row:irow];
3614
3615                         /*
3616                          * For blanks, clearing was all that was necessary.
3617                          * Don't redraw them.
3618                          */
3619                         if (pcell->v.ch.glyph != blank) {
3620                             int a = pcell->v.ch.attr % MAX_COLORS;
3621
3622                             if (alast != a) {
3623                                 alast = a;
3624                                 set_color_for_index(a);
3625                             }
3626                             r = [self viewRectForCellBlockAtX:icol
3627                                       y:irow width:pcell->hscl
3628                                       height:1];
3629                             [self drawWChar:pcell->v.ch.glyph inRect:r
3630                                   screenFont:screenFont context:ctx];
3631                         }
3632                         icol += pcell->hscl;
3633                     }
3634
3635                     /*
3636                      * Forget the clipping rectangle.  As a side effect, lose
3637                      * the color.
3638                      */
3639                     CGContextRestoreGState(ctx);
3640                     alast = -2;
3641                 }
3642                 icol =
3643                     [self.contents scanForTypeMaskInRow:irow
3644                          mask:(TERM_CELL_CHAR | TERM_CELL_TILE)
3645                          col0:icol col1:iColLast];
3646             }
3647         }
3648
3649         /* Handle the right border. */
3650         edge = modRect.origin.x + modRect.size.width;
3651         if (edge > rightX) {
3652             if (modRect.origin.x >= rightX) {
3653                 if (alast != -1) {
3654                     alast = -1;
3655                     [[NSColor blackColor] set];
3656                 }
3657                 NSRectFill(modRect);
3658                 continue;
3659             }
3660             clearRect = modRect;
3661             clearRect.origin.x = rightX;
3662             clearRect.size.width = edge - rightX;
3663             if (alast != -1) {
3664                 alast = -1;
3665                 [[NSColor blackColor] set];
3666             }
3667             NSRectFill(clearRect);
3668             modRect.size.width = edge - modRect.origin.x;
3669         }
3670
3671         /* Handle the bottom border. */
3672         edge = modRect.origin.y + modRect.size.height;
3673         if (edge > bottomY) {
3674             if (modRect.origin.y < bottomY) {
3675                 modRect.origin.y = bottomY;
3676                 modRect.size.height = edge - bottomY;
3677             }
3678             if (alast != -1) {
3679                 alast = -1;
3680                 [[NSColor blackColor] set];
3681             }
3682             NSRectFill(modRect);
3683         }
3684     }
3685
3686     if (redrawCursor) {
3687         NSRect r = [self viewRectForCellBlockAtX:self.contents.cursorColumn
3688                          y:self.contents.cursorRow
3689                          width:self.contents.cursorWidth
3690                          height:self.contents.cursorHeight];
3691         [[NSColor yellowColor] set];
3692         NSFrameRectWithWidth(r, 1);
3693     }
3694
3695     free(sortedRects);
3696 }
3697
3698 - (BOOL)isOrderedIn
3699 {
3700     return [[self->angbandView window] isVisible];
3701 }
3702
3703 - (BOOL)isMainWindow
3704 {
3705     return [[self->angbandView window] isMainWindow];
3706 }
3707
3708 - (BOOL)isKeyWindow
3709 {
3710     return [[self->angbandView window] isKeyWindow];
3711 }
3712
3713 - (void)setNeedsDisplay:(BOOL)val
3714 {
3715     [self->angbandView setNeedsDisplay:val];
3716 }
3717
3718 - (void)setNeedsDisplayInRect:(NSRect)rect
3719 {
3720     [self->angbandView setNeedsDisplayInRect:rect];
3721 }
3722
3723 - (void)displayIfNeeded
3724 {
3725     [self->angbandView displayIfNeeded];
3726 }
3727
3728 - (int)terminalIndex
3729 {
3730         int termIndex = 0;
3731
3732         for( termIndex = 0; termIndex < ANGBAND_TERM_MAX; termIndex++ )
3733         {
3734                 if( angband_term[termIndex] == self->terminal )
3735                 {
3736                         break;
3737                 }
3738         }
3739
3740         return termIndex;
3741 }
3742
3743 - (void)resizeTerminalWithContentRect: (NSRect)contentRect saveToDefaults: (BOOL)saveToDefaults
3744 {
3745     CGFloat newRows = floor(
3746         (contentRect.size.height - (self.borderSize.height * 2.0)) /
3747         self.tileSize.height);
3748     CGFloat newColumns = floor(
3749         (contentRect.size.width - (self.borderSize.width * 2.0)) /
3750         self.tileSize.width);
3751
3752     if (newRows < 1 || newColumns < 1) return;
3753     [self resizeWithColumns:newColumns rows:newRows];
3754
3755     int termIndex = [self terminalIndex];
3756     [self setDefaultTitle:termIndex];
3757
3758     if( saveToDefaults )
3759     {
3760         NSArray *terminals = [[NSUserDefaults standardUserDefaults] valueForKey: AngbandTerminalsDefaultsKey];
3761
3762         if( termIndex < (int)[terminals count] )
3763         {
3764             NSMutableDictionary *mutableTerm = [[NSMutableDictionary alloc] initWithDictionary: [terminals objectAtIndex: termIndex]];
3765             [mutableTerm setValue: [NSNumber numberWithInteger: self.cols]
3766                          forKey: AngbandTerminalColumnsDefaultsKey];
3767             [mutableTerm setValue: [NSNumber numberWithInteger: self.rows]
3768                          forKey: AngbandTerminalRowsDefaultsKey];
3769
3770             NSMutableArray *mutableTerminals = [[NSMutableArray alloc] initWithArray: terminals];
3771             [mutableTerminals replaceObjectAtIndex: termIndex withObject: mutableTerm];
3772
3773             [[NSUserDefaults standardUserDefaults] setValue: mutableTerminals forKey: AngbandTerminalsDefaultsKey];
3774         }
3775     }
3776
3777     term *old = Term;
3778     Term_activate( self->terminal );
3779     Term_resize( self.cols, self.rows );
3780     Term_redraw();
3781     Term_activate( old );
3782 }
3783
3784 - (void)constrainWindowSize:(int)termIdx
3785 {
3786     NSSize minsize;
3787
3788     if (termIdx == 0) {
3789         minsize.width = 80;
3790         minsize.height = 24;
3791     } else {
3792         minsize.width = 1;
3793         minsize.height = 1;
3794     }
3795     minsize.width =
3796         minsize.width * self.tileSize.width + self.borderSize.width * 2.0;
3797     minsize.height =
3798         minsize.height * self.tileSize.height + self.borderSize.height * 2.0;
3799     [[self makePrimaryWindow] setContentMinSize:minsize];
3800     self.primaryWindow.contentResizeIncrements = self.tileSize;
3801 }
3802
3803 - (void)saveWindowVisibleToDefaults: (BOOL)windowVisible
3804 {
3805         int termIndex = [self terminalIndex];
3806         BOOL safeVisibility = (termIndex == 0) ? YES : windowVisible; /* Ensure main term doesn't go away because of these defaults */
3807         NSArray *terminals = [[NSUserDefaults standardUserDefaults] valueForKey: AngbandTerminalsDefaultsKey];
3808
3809         if( termIndex < (int)[terminals count] )
3810         {
3811                 NSMutableDictionary *mutableTerm = [[NSMutableDictionary alloc] initWithDictionary: [terminals objectAtIndex: termIndex]];
3812                 [mutableTerm setValue: [NSNumber numberWithBool: safeVisibility] forKey: AngbandTerminalVisibleDefaultsKey];
3813
3814                 NSMutableArray *mutableTerminals = [[NSMutableArray alloc] initWithArray: terminals];
3815                 [mutableTerminals replaceObjectAtIndex: termIndex withObject: mutableTerm];
3816
3817                 [[NSUserDefaults standardUserDefaults] setValue: mutableTerminals forKey: AngbandTerminalsDefaultsKey];
3818         }
3819 }
3820
3821 - (BOOL)windowVisibleUsingDefaults
3822 {
3823         int termIndex = [self terminalIndex];
3824
3825         if( termIndex == 0 )
3826         {
3827                 return YES;
3828         }
3829
3830         NSArray *terminals = [[NSUserDefaults standardUserDefaults] valueForKey: AngbandTerminalsDefaultsKey];
3831         BOOL visible = NO;
3832
3833         if( termIndex < (int)[terminals count] )
3834         {
3835                 NSDictionary *term = [terminals objectAtIndex: termIndex];
3836                 NSNumber *visibleValue = [term valueForKey: AngbandTerminalVisibleDefaultsKey];
3837
3838                 if( visibleValue != nil )
3839                 {
3840                         visible = [visibleValue boolValue];
3841                 }
3842         }
3843
3844         return visible;
3845 }
3846
3847 #pragma mark -
3848 #pragma mark NSWindowDelegate Methods
3849
3850 /*- (void)windowWillStartLiveResize: (NSNotification *)notification
3851
3852 }*/ 
3853
3854 - (void)windowDidEndLiveResize: (NSNotification *)notification
3855 {
3856     NSWindow *window = [notification object];
3857     NSRect contentRect = [window contentRectForFrameRect: [window frame]];
3858     [self resizeTerminalWithContentRect: contentRect saveToDefaults: !(self->inFullscreenTransition)];
3859 }
3860
3861 /*- (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
3862 {
3863 } */
3864
3865 - (void)windowWillEnterFullScreen: (NSNotification *)notification
3866 {
3867     self->inFullscreenTransition = YES;
3868 }
3869
3870 - (void)windowDidEnterFullScreen: (NSNotification *)notification
3871 {
3872     NSWindow *window = [notification object];
3873     NSRect contentRect = [window contentRectForFrameRect: [window frame]];
3874     self->inFullscreenTransition = NO;
3875     [self resizeTerminalWithContentRect: contentRect saveToDefaults: NO];
3876 }
3877
3878 - (void)windowWillExitFullScreen: (NSNotification *)notification
3879 {
3880     self->inFullscreenTransition = YES;
3881 }
3882
3883 - (void)windowDidExitFullScreen: (NSNotification *)notification
3884 {
3885     NSWindow *window = [notification object];
3886     NSRect contentRect = [window contentRectForFrameRect: [window frame]];
3887     self->inFullscreenTransition = NO;
3888     [self resizeTerminalWithContentRect: contentRect saveToDefaults: NO];
3889 }
3890
3891 - (void)windowDidBecomeMain:(NSNotification *)notification
3892 {
3893     NSWindow *window = [notification object];
3894
3895     if( window != self.primaryWindow )
3896     {
3897         return;
3898     }
3899
3900     int termIndex = [self terminalIndex];
3901     NSMenuItem *item = [[[NSApplication sharedApplication] windowsMenu] itemWithTag: AngbandWindowMenuItemTagBase + termIndex];
3902     [item setState: NSOnState];
3903
3904     if( [[NSFontPanel sharedFontPanel] isVisible] )
3905     {
3906         [[NSFontPanel sharedFontPanel] setPanelFont:self.angbandViewFont
3907                                        isMultiple: NO];
3908     }
3909 }
3910
3911 - (void)windowDidResignMain: (NSNotification *)notification
3912 {
3913     NSWindow *window = [notification object];
3914
3915     if( window != self.primaryWindow )
3916     {
3917         return;
3918     }
3919
3920     int termIndex = [self terminalIndex];
3921     NSMenuItem *item = [[[NSApplication sharedApplication] windowsMenu] itemWithTag: AngbandWindowMenuItemTagBase + termIndex];
3922     [item setState: NSOffState];
3923 }
3924
3925 - (void)windowWillClose: (NSNotification *)notification
3926 {
3927     /*
3928      * If closing only because the application is terminating, don't update
3929      * the visible state for when the application is relaunched.
3930      */
3931     if (! quit_when_ready) {
3932         [self saveWindowVisibleToDefaults: NO];
3933     }
3934 }
3935
3936 @end
3937
3938
3939 @implementation AngbandView
3940
3941 - (BOOL)isOpaque
3942 {
3943     return YES;
3944 }
3945
3946 - (BOOL)isFlipped
3947 {
3948     return YES;
3949 }
3950
3951 - (void)drawRect:(NSRect)rect
3952 {
3953     if ([self inLiveResize]) {
3954         /*
3955          * Always anchor the cached area to the upper left corner of the view.
3956          * Any parts on the right or bottom that can't be drawn from the cached
3957          * area are simply cleared.  Will fill them with appropriate content
3958          * when resizing is done.
3959          */
3960         const NSRect *rects;
3961         NSInteger count;
3962
3963         [self getRectsBeingDrawn:&rects count:&count];
3964         if (count > 0) {
3965             NSRect viewRect = [self visibleRect];
3966
3967             [[NSColor blackColor] set];
3968             while (count-- > 0) {
3969                 CGFloat drawTop = rects[count].origin.y - viewRect.origin.y;
3970                 CGFloat drawBottom = drawTop + rects[count].size.height;
3971                 CGFloat drawLeft = rects[count].origin.x - viewRect.origin.x;
3972                 CGFloat drawRight = drawLeft + rects[count].size.width;
3973                 /*
3974                  * modRect and clrRect, like rects[count], are in the view
3975                  * coordinates with y flipped.  cacheRect is in the bitmap
3976                  * coordinates and y is not flipped.
3977                  */
3978                 NSRect modRect, clrRect, cacheRect;
3979
3980                 /*
3981                  * Clip by bottom edge of cached area.  Clear what's below
3982                  * that.
3983                  */
3984                 if (drawTop >= self->cacheBounds.size.height) {
3985                     NSRectFill(rects[count]);
3986                     continue;
3987                 }
3988                 modRect.origin.x = rects[count].origin.x;
3989                 modRect.origin.y = rects[count].origin.y;
3990                 modRect.size.width = rects[count].size.width;
3991                 cacheRect.origin.y = drawTop;
3992                 if (drawBottom > self->cacheBounds.size.height) {
3993                     CGFloat excess =
3994                         drawBottom - self->cacheBounds.size.height;
3995
3996                     modRect.size.height = rects[count].size.height - excess;
3997                     cacheRect.origin.y = 0;
3998                     clrRect.origin.x = modRect.origin.x;
3999                     clrRect.origin.y = modRect.origin.y + modRect.size.height;
4000                     clrRect.size.width = modRect.size.width;
4001                     clrRect.size.height = excess;
4002                     NSRectFill(clrRect);
4003                 } else {
4004                     modRect.size.height = rects[count].size.height;
4005                     cacheRect.origin.y = self->cacheBounds.size.height -
4006                         rects[count].size.height;
4007                 }
4008                 cacheRect.size.height = modRect.size.height;
4009
4010                 /*
4011                  * Clip by right edge of cached area.  Clear what's to the
4012                  * right of that and copy the remainder from the cache.
4013                  */
4014                 if (drawLeft >= self->cacheBounds.size.width) {
4015                     NSRectFill(modRect);
4016                     continue;
4017                 }
4018                 cacheRect.origin.x = drawLeft;
4019                 if (drawRight > self->cacheBounds.size.width) {
4020                     CGFloat excess = drawRight - self->cacheBounds.size.width;
4021
4022                     modRect.size.width -= excess;
4023                     cacheRect.size.width =
4024                         self->cacheBounds.size.width - drawLeft;
4025                     clrRect.origin.x = modRect.origin.x + modRect.size.width;
4026                     clrRect.origin.y = modRect.origin.y;
4027                     clrRect.size.width = excess;
4028                     clrRect.size.height = modRect.size.height;
4029                     NSRectFill(clrRect);
4030                 } else {
4031                     cacheRect.size.width = drawRight - drawLeft;
4032                 }
4033                 [self->cacheForResize drawInRect:modRect fromRect:cacheRect
4034                      operation:NSCompositeCopy fraction:1.0
4035                      respectFlipped:YES hints:nil];
4036             }
4037         }
4038     } else if (! self.angbandContext) {
4039         /* Draw bright orange, 'cause this ain't right */
4040         [[NSColor orangeColor] set];
4041         NSRectFill([self bounds]);
4042     } else {
4043         /* Tell the Angband context to draw into us */
4044         [self.angbandContext drawRect:rect inView:self];
4045     }
4046 }
4047
4048 /**
4049  * Override NSView's method to set up a cache that's used in drawRect to
4050  * handle drawing during a resize.
4051  */
4052 - (void)viewWillStartLiveResize
4053 {
4054     [super viewWillStartLiveResize];
4055     self->cacheBounds = [self visibleRect];
4056     self->cacheForResize =
4057         [self bitmapImageRepForCachingDisplayInRect:self->cacheBounds];
4058     if (self->cacheForResize != nil) {
4059         [self cacheDisplayInRect:self->cacheBounds
4060               toBitmapImageRep:self->cacheForResize];
4061     } else {
4062         self->cacheBounds.size.width = 0.;
4063         self->cacheBounds.size.height = 0.;
4064     }
4065 }
4066
4067 /**
4068  * Override NSView's method to release the cache set up in
4069  * viewWillStartLiveResize.
4070  */
4071 - (void)viewDidEndLiveResize
4072 {
4073     [super viewDidEndLiveResize];
4074     self->cacheForResize = nil;
4075     [self setNeedsDisplay:YES];
4076 }
4077
4078 @end
4079
4080 /**
4081  * Delay handling of double-clicked savefiles
4082  */
4083 Boolean open_when_ready = FALSE;
4084
4085
4086
4087 /**
4088  * ------------------------------------------------------------------------
4089  * Some generic functions
4090  * ------------------------------------------------------------------------ */
4091
4092 /**
4093  * Sets an Angband color at a given index
4094  */
4095 static void set_color_for_index(int idx)
4096 {
4097     u16b rv, gv, bv;
4098     
4099     /* Extract the R,G,B data */
4100     rv = angband_color_table[idx][1];
4101     gv = angband_color_table[idx][2];
4102     bv = angband_color_table[idx][3];
4103     
4104     CGContextSetRGBFillColor([[NSGraphicsContext currentContext] graphicsPort], rv/255., gv/255., bv/255., 1.);
4105 }
4106
4107 /**
4108  * Remember the current character in UserDefaults so we can select it by
4109  * default next time.
4110  */
4111 static void record_current_savefile(void)
4112 {
4113     NSString *savefileString = [[NSString stringWithCString:savefile encoding:NSMacOSRomanStringEncoding] lastPathComponent];
4114     if (savefileString)
4115     {
4116         NSUserDefaults *angbandDefs = [NSUserDefaults angbandDefaults];
4117         [angbandDefs setObject:savefileString forKey:@"SaveFile"];
4118     }
4119 }
4120
4121
4122 #ifdef JP
4123 /**
4124  * Convert a two-byte EUC-JP encoded character (both *cp and (*cp + 1) are in
4125  * the range, 0xA1-0xFE, or *cp is 0x8E) to a utf16 value in the native byte
4126  * ordering.
4127  */
4128 static wchar_t convert_two_byte_eucjp_to_utf16_native(const char *cp)
4129 {
4130     NSString* str = [[NSString alloc] initWithBytes:cp length:2
4131                                       encoding:NSJapaneseEUCStringEncoding];
4132     wchar_t result = [str characterAtIndex:0];
4133     str = nil;
4134     return result;
4135 }
4136 #endif /* JP */
4137
4138
4139 /**
4140  * ------------------------------------------------------------------------
4141  * Support for the "z-term.c" package
4142  * ------------------------------------------------------------------------ */
4143
4144
4145 /**
4146  * Initialize a new Term
4147  */
4148 static void Term_init_cocoa(term *t)
4149 {
4150     @autoreleasepool {
4151         AngbandContext *context = [[AngbandContext alloc] init];
4152
4153         /* Give the term ownership of the context */
4154         t->data = (void *)CFBridgingRetain(context);
4155
4156         /* Handle graphics */
4157         t->higher_pict = !! use_graphics;
4158         t->always_pict = FALSE;
4159
4160         NSDisableScreenUpdates();
4161
4162         /*
4163          * Figure out the frame autosave name based on the index of this term
4164          */
4165         NSString *autosaveName = nil;
4166         int termIdx;
4167         for (termIdx = 0; termIdx < ANGBAND_TERM_MAX; termIdx++)
4168         {
4169             if (angband_term[termIdx] == t)
4170             {
4171                 autosaveName =
4172                     [NSString stringWithFormat:@"AngbandTerm-%d", termIdx];
4173                 break;
4174             }
4175         }
4176
4177         /* Set its font. */
4178         NSString *fontName =
4179             [[NSUserDefaults angbandDefaults]
4180                 stringForKey:[NSString stringWithFormat:@"FontName-%d", termIdx]];
4181         if (! fontName) fontName = [[AngbandContext defaultFont] fontName];
4182
4183         /*
4184          * Use a smaller default font for the other windows, but only if the
4185          * font hasn't been explicitly set.
4186          */
4187         float fontSize =
4188             (termIdx > 0) ? 10.0 : [[AngbandContext defaultFont] pointSize];
4189         NSNumber *fontSizeNumber =
4190             [[NSUserDefaults angbandDefaults]
4191                 valueForKey: [NSString stringWithFormat: @"FontSize-%d", termIdx]];
4192
4193         if( fontSizeNumber != nil )
4194         {
4195             fontSize = [fontSizeNumber floatValue];
4196         }
4197
4198         [context setSelectionFont:[NSFont fontWithName:fontName size:fontSize]
4199                  adjustTerminal: NO];
4200
4201         NSArray *terminalDefaults =
4202             [[NSUserDefaults standardUserDefaults]
4203                 valueForKey: AngbandTerminalsDefaultsKey];
4204         NSInteger rows = 24;
4205         NSInteger columns = 80;
4206
4207         if( termIdx < (int)[terminalDefaults count] )
4208         {
4209             NSDictionary *term = [terminalDefaults objectAtIndex: termIdx];
4210             NSInteger defaultRows =
4211                 [[term valueForKey: AngbandTerminalRowsDefaultsKey]
4212                     integerValue];
4213             NSInteger defaultColumns =
4214                 [[term valueForKey: AngbandTerminalColumnsDefaultsKey]
4215                     integerValue];
4216
4217             if (defaultRows > 0) rows = defaultRows;
4218             if (defaultColumns > 0) columns = defaultColumns;
4219         }
4220
4221         [context resizeWithColumns:columns rows:rows];
4222
4223         /* Get the window */
4224         NSWindow *window = [context makePrimaryWindow];
4225
4226         /* Set its title and, for auxiliary terms, tentative size */
4227         [context setDefaultTitle:termIdx];
4228         [context constrainWindowSize:termIdx];
4229
4230         /*
4231          * If this is the first term, and we support full screen (Mac OS X Lion
4232          * or later), then allow it to go full screen (sweet). Allow other
4233          * terms to be FullScreenAuxilliary, so they can at least show up.
4234          * Unfortunately in Lion they don't get brought to the full screen
4235          * space; but they would only make sense on multiple displays anyways
4236          * so it's not a big loss.
4237          */
4238         if ([window respondsToSelector:@selector(toggleFullScreen:)])
4239         {
4240             NSWindowCollectionBehavior behavior = [window collectionBehavior];
4241             behavior |=
4242                 (termIdx == 0 ?
4243                  NSWindowCollectionBehaviorFullScreenPrimary :
4244                  NSWindowCollectionBehaviorFullScreenAuxiliary);
4245             [window setCollectionBehavior:behavior];
4246         }
4247
4248         /* No Resume support yet, though it would not be hard to add */
4249         if ([window respondsToSelector:@selector(setRestorable:)])
4250         {
4251             [window setRestorable:NO];
4252         }
4253
4254         /* default window placement */ {
4255             static NSRect overallBoundingRect;
4256
4257             if( termIdx == 0 )
4258             {
4259                 /*
4260                  * This is a bit of a trick to allow us to display multiple
4261                  * windows in the "standard default" window position in OS X:
4262                  * the upper center of the screen.  The term sizes set in
4263                  * load_prefs() are based on a 5-wide by 3-high grid, with the
4264                  * main term being 4/5 wide by 2/3 high (hence the scaling to
4265                  * find what the containing rect would be).
4266                  */
4267                 NSRect originalMainTermFrame = [window frame];
4268                 NSRect scaledFrame = originalMainTermFrame;
4269                 scaledFrame.size.width *= 5.0 / 4.0;
4270                 scaledFrame.size.height *= 3.0 / 2.0;
4271                 scaledFrame.size.width += 1.0; /* spacing between window columns */
4272                 scaledFrame.size.height += 1.0; /* spacing between window rows */
4273                 [window setFrame: scaledFrame  display: NO];
4274                 [window center];
4275                 overallBoundingRect = [window frame];
4276                 [window setFrame: originalMainTermFrame display: NO];
4277             }
4278
4279             static NSRect mainTermBaseRect;
4280             NSRect windowFrame = [window frame];
4281
4282             if( termIdx == 0 )
4283             {
4284                 /*
4285                  * The height and width adjustments were determined
4286                  * experimentally, so that the rest of the windows line up
4287                  * nicely without overlapping.
4288                  */
4289                 windowFrame.size.width += 7.0;
4290                 windowFrame.size.height += 9.0;
4291                 windowFrame.origin.x = NSMinX( overallBoundingRect );
4292                 windowFrame.origin.y =
4293                     NSMaxY( overallBoundingRect ) - NSHeight( windowFrame );
4294                 mainTermBaseRect = windowFrame;
4295             }
4296             else if( termIdx == 1 )
4297             {
4298                 windowFrame.origin.x = NSMinX( mainTermBaseRect );
4299                 windowFrame.origin.y =
4300                     NSMinY( mainTermBaseRect ) - NSHeight( windowFrame ) - 1.0;
4301             }
4302             else if( termIdx == 2 )
4303             {
4304                 windowFrame.origin.x = NSMaxX( mainTermBaseRect ) + 1.0;
4305                 windowFrame.origin.y =
4306                     NSMaxY( mainTermBaseRect ) - NSHeight( windowFrame );
4307             }
4308             else if( termIdx == 3 )
4309             {
4310                 windowFrame.origin.x = NSMaxX( mainTermBaseRect ) + 1.0;
4311                 windowFrame.origin.y =
4312                     NSMinY( mainTermBaseRect ) - NSHeight( windowFrame ) - 1.0;
4313             }
4314             else if( termIdx == 4 )
4315             {
4316                 windowFrame.origin.x = NSMaxX( mainTermBaseRect ) + 1.0;
4317                 windowFrame.origin.y = NSMinY( mainTermBaseRect );
4318             }
4319             else if( termIdx == 5 )
4320             {
4321                 windowFrame.origin.x =
4322                     NSMinX( mainTermBaseRect ) + NSWidth( windowFrame ) + 1.0;
4323                 windowFrame.origin.y =
4324                     NSMinY( mainTermBaseRect ) - NSHeight( windowFrame ) - 1.0;
4325             }
4326
4327             [window setFrame: windowFrame display: NO];
4328         }
4329
4330         /*
4331          * Override the default frame above if the user has adjusted windows in
4332          * the past
4333          */
4334         if (autosaveName) [window setFrameAutosaveName:autosaveName];
4335
4336         /*
4337          * Tell it about its term. Do this after we've sized it so that the
4338          * sizing doesn't trigger redrawing and such.
4339          */
4340         [context setTerm:t];
4341
4342         /*
4343          * Only order front if it's the first term. Other terms will be ordered
4344          * front from AngbandUpdateWindowVisibility(). This is to work around a
4345          * problem where Angband aggressively tells us to initialize terms that
4346          * don't do anything!
4347          */
4348         if (t == angband_term[0])
4349             [context.primaryWindow makeKeyAndOrderFront: nil];
4350
4351         NSEnableScreenUpdates();
4352
4353         /* Set "mapped" flag */
4354         t->mapped_flag = true;
4355     }
4356 }
4357
4358
4359
4360 /**
4361  * Nuke an old Term
4362  */
4363 static void Term_nuke_cocoa(term *t)
4364 {
4365     @autoreleasepool {
4366         AngbandContext *context = (__bridge AngbandContext*) (t->data);
4367         if (context)
4368         {
4369             /* Tell the context to get rid of its windows, etc. */
4370             [context dispose];
4371
4372             /* Balance our CFBridgingRetain from when we created it */
4373             CFRelease(t->data);
4374
4375             /* Done with it */
4376             t->data = NULL;
4377         }
4378     }
4379 }
4380
4381 /**
4382  * Returns the CGImageRef corresponding to an image with the given path.
4383  * Transfers ownership to the caller.
4384  */
4385 static CGImageRef create_angband_image(NSString *path)
4386 {
4387     CGImageRef decodedImage = NULL, result = NULL;
4388     
4389     /* Try using ImageIO to load the image */
4390     if (path)
4391     {
4392         NSURL *url = [[NSURL alloc] initFileURLWithPath:path isDirectory:NO];
4393         if (url)
4394         {
4395             NSDictionary *options = [[NSDictionary alloc] initWithObjectsAndKeys:(id)kCFBooleanTrue, kCGImageSourceShouldCache, nil];
4396             CGImageSourceRef source = CGImageSourceCreateWithURL((CFURLRef)url, (CFDictionaryRef)options);
4397             if (source)
4398             {
4399                 /*
4400                  * We really want the largest image, but in practice there's
4401                  * only going to be one
4402                  */
4403                 decodedImage = CGImageSourceCreateImageAtIndex(source, 0, (CFDictionaryRef)options);
4404                 CFRelease(source);
4405             }
4406         }
4407     }
4408     
4409     /*
4410      * Draw the sucker to defeat ImageIO's weird desire to cache and decode on
4411      * demand. Our images aren't that big!
4412      */
4413     if (decodedImage)
4414     {
4415         size_t width = CGImageGetWidth(decodedImage), height = CGImageGetHeight(decodedImage);
4416         
4417         /* Compute our own bitmap info */
4418         CGBitmapInfo imageBitmapInfo = CGImageGetBitmapInfo(decodedImage);
4419         CGBitmapInfo contextBitmapInfo = kCGBitmapByteOrderDefault;
4420         
4421         switch (imageBitmapInfo & kCGBitmapAlphaInfoMask) {
4422             case kCGImageAlphaNone:
4423             case kCGImageAlphaNoneSkipLast:
4424             case kCGImageAlphaNoneSkipFirst:
4425                 /* No alpha */
4426                 contextBitmapInfo |= kCGImageAlphaNone;
4427                 break;
4428             default:
4429                 /* Some alpha, use premultiplied last which is most efficient. */
4430                 contextBitmapInfo |= kCGImageAlphaPremultipliedLast;
4431                 break;
4432         }
4433
4434         /* Draw the source image flipped, since the view is flipped */
4435         CGContextRef ctx = CGBitmapContextCreate(NULL, width, height, CGImageGetBitsPerComponent(decodedImage), CGImageGetBytesPerRow(decodedImage), CGImageGetColorSpace(decodedImage), contextBitmapInfo);
4436         if (ctx) {
4437             CGContextSetBlendMode(ctx, kCGBlendModeCopy);
4438             CGContextTranslateCTM(ctx, 0.0, height);
4439             CGContextScaleCTM(ctx, 1.0, -1.0);
4440             CGContextDrawImage(
4441                 ctx, CGRectMake(0, 0, width, height), decodedImage);
4442             result = CGBitmapContextCreateImage(ctx);
4443             CFRelease(ctx);
4444         }
4445
4446         CGImageRelease(decodedImage);
4447     }
4448     return result;
4449 }
4450
4451 /**
4452  * React to changes
4453  */
4454 static errr Term_xtra_cocoa_react(void)
4455 {
4456     /* Don't actually switch graphics until the game is running */
4457     if (!initialized || !game_in_progress) return (-1);
4458
4459     @autoreleasepool {
4460         /* Handle graphics */
4461         int expected_graf_mode = (current_graphics_mode) ?
4462             current_graphics_mode->grafID : GRAPHICS_NONE;
4463         if (graf_mode_req != expected_graf_mode)
4464         {
4465             graphics_mode *new_mode;
4466             if (graf_mode_req != GRAPHICS_NONE) {
4467                 new_mode = get_graphics_mode(graf_mode_req);
4468             } else {
4469                 new_mode = NULL;
4470             }
4471
4472             /* Get rid of the old image. CGImageRelease is NULL-safe. */
4473             CGImageRelease(pict_image);
4474             pict_image = NULL;
4475
4476             /* Try creating the image if we want one */
4477             if (new_mode != NULL)
4478             {
4479                 NSString *img_path =
4480                     [NSString stringWithFormat:@"%s/%s", new_mode->path, new_mode->file];
4481                 pict_image = create_angband_image(img_path);
4482
4483                 /* If we failed to create the image, revert to ASCII. */
4484                 if (! pict_image) {
4485                     new_mode = NULL;
4486                     if (use_bigtile) {
4487                         arg_bigtile = FALSE;
4488                     }
4489                     [[NSUserDefaults angbandDefaults]
4490                         setInteger:GRAPHICS_NONE
4491                         forKey:AngbandGraphicsDefaultsKey];
4492
4493                     NSString *msg = NSLocalizedStringWithDefaultValue(
4494                         @"Error.TileSetLoadFailed",
4495                         AngbandMessageCatalog,
4496                         [NSBundle mainBundle],
4497                         @"Failed to Load Tile Set",
4498                         @"Alert text for failed tile set load");
4499                     NSString *info = NSLocalizedStringWithDefaultValue(
4500                         @"Error.TileSetRevertToASCII",
4501                         AngbandMessageCatalog,
4502                         [NSBundle mainBundle],
4503                         @"Could not load the tile set.  Switched back to ASCII.",
4504                         @"Alert informative message for failed tile set load");
4505                     NSAlert *alert = [[NSAlert alloc] init];
4506                     alert.messageText = msg;
4507                     alert.informativeText = info;
4508                     [alert runModal];
4509                 }
4510             }
4511
4512             if (graphics_are_enabled()) {
4513                 /*
4514                  * The contents stored in the AngbandContext may have
4515                  * references to the old tile set.  Out of an abundance
4516                  * of caution, clear those references in case there's an
4517                  * attempt to redraw the contents before the core has the
4518                  * chance to update it via the text_hook, pict_hook, and
4519                  * wipe_hook.
4520                  */
4521                 for (int iterm = 0; iterm < ANGBAND_TERM_MAX; ++iterm) {
4522                     AngbandContext* aContext =
4523                         (__bridge AngbandContext*) (angband_term[iterm]->data);
4524
4525                     [aContext.contents wipeTiles];
4526                 }
4527             }
4528
4529             /* Record what we did */
4530             use_graphics = new_mode ? new_mode->grafID : 0;
4531             ANGBAND_GRAF = (new_mode ? new_mode->graf : "ascii");
4532             current_graphics_mode = new_mode;
4533
4534             /* Enable or disable higher picts.  */
4535             for (int iterm = 0; iterm < ANGBAND_TERM_MAX; ++iterm) {
4536                 if (angband_term[iterm]) {
4537                     angband_term[iterm]->higher_pict = !! use_graphics;
4538                 }
4539             }
4540
4541             if (pict_image && current_graphics_mode)
4542             {
4543                 /*
4544                  * Compute the row and column count via the image height and
4545                  * width.
4546                  */
4547                 pict_rows = (int)(CGImageGetHeight(pict_image) /
4548                                   current_graphics_mode->cell_height);
4549                 pict_cols = (int)(CGImageGetWidth(pict_image) /
4550                                   current_graphics_mode->cell_width);
4551             }
4552             else
4553             {
4554                 pict_rows = 0;
4555                 pict_cols = 0;
4556             }
4557
4558             /* Reset visuals */
4559             if (arg_bigtile == use_bigtile && character_generated)
4560             {
4561                 reset_visuals();
4562             }
4563         }
4564
4565         if (arg_bigtile != use_bigtile) {
4566             if (character_generated)
4567             {
4568                 /* Reset visuals */
4569                 reset_visuals();
4570             }
4571
4572             Term_activate(angband_term[0]);
4573             Term_resize(angband_term[0]->wid, angband_term[0]->hgt);
4574         }
4575     }
4576
4577     /* Success */
4578     return (0);
4579 }
4580
4581
4582 /**
4583  * Do a "special thing"
4584  */
4585 static errr Term_xtra_cocoa(int n, int v)
4586 {
4587     errr result = 0;
4588     @autoreleasepool {
4589         AngbandContext* angbandContext =
4590             (__bridge AngbandContext*) (Term->data);
4591
4592         /* Analyze */
4593         switch (n) {
4594             /* Make a noise */
4595         case TERM_XTRA_NOISE:
4596             NSBeep();
4597             break;
4598
4599             /*  Make a sound */
4600         case TERM_XTRA_SOUND:
4601             play_sound(v);
4602             break;
4603
4604             /* Process random events */
4605         case TERM_XTRA_BORED:
4606             /*
4607              * Show or hide cocoa windows based on the subwindow flags set by
4608              * the user.
4609              */
4610             AngbandUpdateWindowVisibility();
4611             /* Process an event */
4612             (void)check_events(CHECK_EVENTS_NO_WAIT);
4613             break;
4614
4615             /* Process pending events */
4616         case TERM_XTRA_EVENT:
4617             /* Process an event */
4618             (void)check_events(v);
4619             break;
4620
4621             /* Flush all pending events (if any) */
4622         case TERM_XTRA_FLUSH:
4623             /* Hack -- flush all events */
4624             while (check_events(CHECK_EVENTS_DRAIN)) /* loop */;
4625
4626             break;
4627
4628             /* Hack -- Change the "soft level" */
4629         case TERM_XTRA_LEVEL:
4630             /*
4631              * Here we could activate (if requested), but I don't think
4632              * Angband should be telling us our window order (the user
4633              * should decide that), so do nothing.
4634              */
4635             break;
4636
4637             /* Clear the screen */
4638         case TERM_XTRA_CLEAR:
4639             [angbandContext.contents wipe];
4640             [angbandContext setNeedsDisplay:YES];
4641             break;
4642
4643             /* React to changes */
4644         case TERM_XTRA_REACT:
4645             result = Term_xtra_cocoa_react();
4646             break;
4647
4648             /* Delay (milliseconds) */
4649         case TERM_XTRA_DELAY:
4650             /* If needed */
4651             if (v > 0) {
4652                 double seconds = v / 1000.;
4653                 NSDate* date = [NSDate dateWithTimeIntervalSinceNow:seconds];
4654                 do {
4655                     NSEvent* event;
4656                     do {
4657                         event = [NSApp nextEventMatchingMask:-1
4658                                        untilDate:date
4659                                        inMode:NSDefaultRunLoopMode
4660                                        dequeue:YES];
4661                         if (event) send_event(event);
4662                     } while (event);
4663                 } while ([date timeIntervalSinceNow] >= 0);
4664             }
4665             break;
4666
4667             /* Draw the pending changes. */
4668         case TERM_XTRA_FRESH:
4669             {
4670                 /*
4671                  * Check the cursor visibility since the core will tell us
4672                  * explicitly to draw it, but tells us implicitly to forget it
4673                  * by simply telling us to redraw a location.
4674                  */
4675                 int isVisible = 0;
4676
4677                 Term_get_cursor(&isVisible);
4678                 if (! isVisible) {
4679                     [angbandContext.contents removeCursor];
4680                 }
4681                 [angbandContext computeInvalidRects];
4682                 [angbandContext.changes clear];
4683             }
4684             break;
4685
4686         default:
4687             /* Oops */
4688             result = 1;
4689             break;
4690         }
4691     }
4692
4693     return result;
4694 }
4695
4696 static errr Term_curs_cocoa(TERM_LEN x, TERM_LEN y)
4697 {
4698     AngbandContext *angbandContext = (__bridge AngbandContext*) (Term->data);
4699
4700     [angbandContext.contents setCursorAtColumn:x row:y width:1 height:1];
4701     /*
4702      * Unfortunately, this (and the same logic in Term_bigcurs_cocoa) will
4703      * also trigger what's under the cursor to be redrawn as well, even if
4704      * it has not changed.  In the current drawing implementation, that
4705      * inefficiency seems unavoidable.
4706      */
4707     [angbandContext.changes markChangedAtColumn:x row:y];
4708
4709     /* Success */
4710     return 0;
4711 }
4712
4713 /**
4714  * Draw a cursor that's two tiles wide.  For Japanese, that's used when
4715  * the cursor points at a kanji character, irregardless of whether operating
4716  * in big tile mode.
4717  */
4718 static errr Term_bigcurs_cocoa(TERM_LEN x, TERM_LEN y)
4719 {
4720     AngbandContext *angbandContext = (__bridge AngbandContext*) (Term->data);
4721
4722     [angbandContext.contents setCursorAtColumn:x row:y width:2 height:1];
4723     [angbandContext.changes markChangedBlockAtColumn:x row:y width:2 height:1];
4724
4725     /* Success */
4726     return 0;
4727 }
4728
4729 /**
4730  * Low level graphics (Assumes valid input)
4731  *
4732  * Erase "n" characters starting at (x,y)
4733  */
4734 static errr Term_wipe_cocoa(TERM_LEN x, TERM_LEN y, int n)
4735 {
4736     AngbandContext *angbandContext = (__bridge AngbandContext*) (Term->data);
4737
4738     [angbandContext.contents wipeBlockAtColumn:x row:y width:n height:1];
4739     [angbandContext.changes markChangedRangeAtColumn:x row:y width:n];
4740
4741     /* Success */
4742     return 0;
4743 }
4744
4745 static errr Term_pict_cocoa(TERM_LEN x, TERM_LEN y, int n,
4746                             TERM_COLOR *ap, concptr cp,
4747                             const TERM_COLOR *tap, concptr tcp)
4748 {
4749     /* Paranoia: Bail if graphics aren't enabled */
4750     if (! graphics_are_enabled()) return -1;
4751
4752     AngbandContext* angbandContext = (__bridge AngbandContext*) (Term->data);
4753     int step = (use_bigtile) ? 2 : 1;
4754
4755     int alphablend;
4756     if (use_graphics) {
4757         CGImageAlphaInfo ainfo = CGImageGetAlphaInfo(pict_image);
4758
4759         alphablend = (ainfo & (kCGImageAlphaPremultipliedFirst |
4760                                kCGImageAlphaPremultipliedLast)) ? 1 : 0;
4761     } else {
4762         alphablend = 0;
4763     }
4764
4765     for (int i = x; i < x + n * step; i += step) {
4766         TERM_COLOR a = *ap;
4767         char c = *cp;
4768         TERM_COLOR ta = *tap;
4769         char tc = *tcp;
4770
4771         ap += step;
4772         cp += step;
4773         tap += step;
4774         tcp += step;
4775         if (use_graphics && (a & 0x80) && (c & 0x80)) {
4776             char fgdRow = ((byte)a & 0x7F) % pict_rows;
4777             char fgdCol = ((byte)c & 0x7F) % pict_cols;
4778             char bckRow, bckCol;
4779
4780             if (alphablend) {
4781                 bckRow = ((byte)ta & 0x7F) % pict_rows;
4782                 bckCol = ((byte)tc & 0x7F) % pict_cols;
4783             } else {
4784                 /*
4785                  * Not blending so make the background the same as the
4786                  * the foreground.
4787                  */
4788                 bckRow = fgdRow;
4789                 bckCol = fgdCol;
4790             }
4791             [angbandContext.contents setTileAtColumn:i row:y
4792                            foregroundColumn:fgdCol
4793                            foregroundRow:fgdRow
4794                            backgroundColumn:bckCol
4795                            backgroundRow:bckRow
4796                            tileWidth:step
4797                            tileHeight:1];
4798             [angbandContext.changes markChangedBlockAtColumn:i row:y
4799                            width:step height:1];
4800         }
4801     }
4802
4803     /* Success */
4804     return (0);
4805 }
4806
4807 /**
4808  * Low level graphics.  Assumes valid input.
4809  *
4810  * Draw several ("n") chars, with an attr, at a given location.
4811  */
4812 static errr Term_text_cocoa(
4813     TERM_LEN x, TERM_LEN y, int n, TERM_COLOR a, concptr cp)
4814 {
4815     AngbandContext* angbandContext = (__bridge AngbandContext*) (Term->data);
4816
4817     [angbandContext.contents setUniformAttributeTextRunAtColumn:x
4818                    row:y n:n glyphs:cp attribute:a];
4819     [angbandContext.changes markChangedRangeAtColumn:x row:y width:n];
4820
4821     /* Success */
4822     return 0;
4823 }
4824
4825 #if 0
4826 /*
4827  * From the Linux mbstowcs(3) man page:
4828  * If dest is NULL, n is ignored, and the conversion proceeds as above,
4829  * except that the converted wide characters are not written out to
4830  * memory, and that no length limit exists.
4831  */
4832 static size_t Term_mbcs_cocoa(wchar_t *dest, const char *src, int n)
4833 {
4834     int i;
4835     int count = 0;
4836
4837     /*
4838      * Unicode code point to UTF-8
4839      * 0x0000-0x007f:    0xxxxxxx
4840      * 0x0080-0x07ff:    110xxxxx 10xxxxxx
4841      * 0x0800-0xffff:    1110xxxx 10xxxxxx 10xxxxxx
4842      * 0x10000-0x1fffff: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
4843      * Note that UTF-16 limits Unicode to 0x10ffff. This code is not
4844      * endian-agnostic.
4845      */
4846     for (i = 0; i < n || dest == NULL; i++) {
4847         if ((src[i] & 0x80) == 0) {
4848             if (dest != NULL) dest[count] = src[i];
4849             if (src[i] == 0) break;
4850         } else if ((src[i] & 0xe0) == 0xc0) {
4851             if (dest != NULL) dest[count] =
4852                             (((unsigned char)src[i] & 0x1f) << 6)|
4853                             ((unsigned char)src[i+1] & 0x3f);
4854             i++;
4855         } else if ((src[i] & 0xf0) == 0xe0) {
4856             if (dest != NULL) dest[count] =
4857                             (((unsigned char)src[i] & 0x0f) << 12) |
4858                             (((unsigned char)src[i+1] & 0x3f) << 6) |
4859                             ((unsigned char)src[i+2] & 0x3f);
4860             i += 2;
4861         } else if ((src[i] & 0xf8) == 0xf0) {
4862             if (dest != NULL) dest[count] =
4863                             (((unsigned char)src[i] & 0x0f) << 18) |
4864                             (((unsigned char)src[i+1] & 0x3f) << 12) |
4865                             (((unsigned char)src[i+2] & 0x3f) << 6) |
4866                             ((unsigned char)src[i+3] & 0x3f);
4867             i += 3;
4868         } else {
4869             /* Found an invalid multibyte sequence */
4870             return (size_t)-1;
4871         }
4872         count++;
4873     }
4874     return count;
4875 }
4876 #endif
4877
4878 /**
4879  * Handle redrawing for a change to the tile set, tile scaling, or main window
4880  * font.  Returns YES if the redrawing was initiated.  Otherwise returns NO.
4881  */
4882 static BOOL redraw_for_tiles_or_term0_font(void)
4883 {
4884     /*
4885      * In Angband 4.2, do_cmd_redraw() will always clear, but only provides
4886      * something to replace the erased content if a character has been
4887      * generated.  In Hengband, do_cmd_redraw() isn't safe to call unless a
4888      * character has been generated.  Therefore, only call it if a character
4889      * has been generated.
4890      */
4891     if (character_generated) {
4892         do_cmd_redraw();
4893         wakeup_event_loop();
4894         return YES;
4895     }
4896     return NO;
4897 }
4898
4899 /**
4900  * Post a nonsense event so that our event loop wakes up
4901  */
4902 static void wakeup_event_loop(void)
4903 {
4904     /* Big hack - send a nonsense event to make us update */
4905     NSEvent *event = [NSEvent otherEventWithType:NSApplicationDefined location:NSZeroPoint modifierFlags:0 timestamp:0 windowNumber:0 context:NULL subtype:AngbandEventWakeup data1:0 data2:0];
4906     [NSApp postEvent:event atStart:NO];
4907 }
4908
4909
4910 /**
4911  * Handle the "open_when_ready" flag
4912  */
4913 static void handle_open_when_ready(void)
4914 {
4915     /* Check the flag XXX XXX XXX make a function for this */
4916     if (open_when_ready && initialized && !game_in_progress)
4917     {
4918         /* Forget */
4919         open_when_ready = FALSE;
4920         
4921         /* Game is in progress */
4922         game_in_progress = TRUE;
4923         
4924         /* Wait for a keypress */
4925         pause_line(Term->hgt - 1);
4926     }
4927 }
4928
4929
4930 /**
4931  * Handle quit_when_ready, by Peter Ammon,
4932  * slightly modified to check inkey_flag.
4933  */
4934 static void quit_calmly(void)
4935 {
4936     /* Quit immediately if game's not started */
4937     if (!game_in_progress || !character_generated) quit(NULL);
4938
4939     /* Save the game and Quit (if it's safe) */
4940     if (inkey_flag)
4941     {
4942         /* Hack -- Forget messages and term */
4943         msg_flag = FALSE;
4944         Term->mapped_flag = FALSE;
4945
4946         /* Save the game */
4947         do_cmd_save_game(FALSE);
4948         record_current_savefile();
4949
4950         /* Quit */
4951         quit(NULL);
4952     }
4953
4954     /* Wait until inkey_flag is set */
4955 }
4956
4957
4958
4959 /**
4960  * Returns YES if we contain an AngbandView (and hence should direct our events
4961  * to Angband)
4962  */
4963 static BOOL contains_angband_view(NSView *view)
4964 {
4965     if ([view isKindOfClass:[AngbandView class]]) return YES;
4966     for (NSView *subview in [view subviews]) {
4967         if (contains_angband_view(subview)) return YES;
4968     }
4969     return NO;
4970 }
4971
4972
4973 /**
4974  * Queue mouse presses if they occur in the map section of the main window.
4975  */
4976 static void AngbandHandleEventMouseDown( NSEvent *event )
4977 {
4978 #if 0
4979         AngbandContext *angbandContext = [[[event window] contentView] angbandContext];
4980         AngbandContext *mainAngbandContext =
4981             (__bridge AngbandContext*) (angband_term[0]->data);
4982
4983         if (mainAngbandContext.primaryWindow &&
4984             [[event window] windowNumber] ==
4985             [mainAngbandContext.primaryWindow windowNumber])
4986         {
4987                 int cols, rows, x, y;
4988                 Term_get_size(&cols, &rows);
4989                 NSSize tileSize = angbandContext.tileSize;
4990                 NSSize border = angbandContext.borderSize;
4991                 NSPoint windowPoint = [event locationInWindow];
4992
4993                 /*
4994                  * Adjust for border; add border height because window origin
4995                  * is at bottom
4996                  */
4997                 windowPoint = NSMakePoint( windowPoint.x - border.width, windowPoint.y + border.height );
4998
4999                 NSPoint p = [[[event window] contentView] convertPoint: windowPoint fromView: nil];
5000                 x = floor( p.x / tileSize.width );
5001                 y = floor( p.y / tileSize.height );
5002
5003                 /*
5004                  * Being safe about this, since xcode doesn't seem to like the
5005                  * bool_hack stuff
5006                  */
5007                 BOOL displayingMapInterface = ((int)inkey_flag != 0);
5008
5009                 /* Sidebar plus border == thirteen characters; top row is reserved. */
5010                 /* Coordinates run from (0,0) to (cols-1, rows-1). */
5011                 BOOL mouseInMapSection = (x > 13 && x <= cols - 1 && y > 0  && y <= rows - 2);
5012
5013                 /*
5014                  * If we are displaying a menu, allow clicks anywhere within
5015                  * the terminal bounds; if we are displaying the main game
5016                  * interface, only allow clicks in the map section
5017                  */
5018                 if ((!displayingMapInterface && x >= 0 && x < cols &&
5019                      y >= 0 && y < rows) ||
5020                      (displayingMapInterface && mouseInMapSection))
5021                 {
5022                         /*
5023                          * [event buttonNumber] will return 0 for left click,
5024                          * 1 for right click, but this is safer
5025                          */
5026                         int button = ([event type] == NSLeftMouseDown) ? 1 : 2;
5027
5028 #ifdef KC_MOD_ALT
5029                         NSUInteger eventModifiers = [event modifierFlags];
5030                         byte angbandModifiers = 0;
5031                         angbandModifiers |= (eventModifiers & NSShiftKeyMask) ? KC_MOD_SHIFT : 0;
5032                         angbandModifiers |= (eventModifiers & NSControlKeyMask) ? KC_MOD_CONTROL : 0;
5033                         angbandModifiers |= (eventModifiers & NSAlternateKeyMask) ? KC_MOD_ALT : 0;
5034                         button |= (angbandModifiers & 0x0F) << 4; /* encode modifiers in the button number (see Term_mousepress()) */
5035 #endif
5036
5037                         Term_mousepress(x, y, button);
5038                 }
5039         }
5040 #endif
5041
5042         /* Pass click through to permit focus change, resize, etc. */
5043         [NSApp sendEvent:event];
5044 }
5045
5046
5047
5048 /**
5049  * Encodes an NSEvent Angband-style, or forwards it along.  Returns YES if the
5050  * event was sent to Angband, NO if Cocoa (or nothing) handled it
5051  */
5052 static BOOL send_event(NSEvent *event)
5053 {
5054
5055     /* If the receiving window is not an Angband window, then do nothing */
5056     if (! contains_angband_view([[event window] contentView]))
5057     {
5058         [NSApp sendEvent:event];
5059         return NO;
5060     }
5061
5062     /* Analyze the event */
5063     switch ([event type])
5064     {
5065         case NSKeyDown:
5066         {
5067             /* Try performing a key equivalent */
5068             if ([[NSApp mainMenu] performKeyEquivalent:event]) break;
5069             
5070             unsigned modifiers = [event modifierFlags];
5071             
5072             /* Send all NSCommandKeyMasks through */
5073             if (modifiers & NSCommandKeyMask)
5074             {
5075                 [NSApp sendEvent:event];
5076                 break;
5077             }
5078             
5079             if (! [[event characters] length]) break;
5080             
5081             
5082             /* Extract some modifiers */
5083             int mc = !! (modifiers & NSControlKeyMask);
5084             int ms = !! (modifiers & NSShiftKeyMask);
5085             int mo = !! (modifiers & NSAlternateKeyMask);
5086             int kp = !! (modifiers & NSNumericPadKeyMask);
5087             
5088             
5089             /* Get the Angband char corresponding to this unichar */
5090             unichar c = [[event characters] characterAtIndex:0];
5091             char ch;
5092             /*
5093              * Have anything from the numeric keypad generate a macro
5094              * trigger so that shift or control modifiers can be passed.
5095              */
5096             if (c <= 0x7F && !kp)
5097             {
5098                 ch = (char) c;
5099             }
5100             else {
5101                 /*
5102                  * The rest of Hengband uses Angband 2.7's or so key handling:
5103                  * so for the rest do something like the encoding that
5104                  * main-win.c does:  send a macro trigger with the Unicode
5105                  * value encoded into printable ASCII characters.
5106                  */
5107                 ch = '\0';
5108             }
5109             
5110             /* override special keys */
5111             switch([event keyCode]) {
5112                 case kVK_Return: ch = '\r'; break;
5113                 case kVK_Escape: ch = 27; break;
5114                 case kVK_Tab: ch = '\t'; break;
5115                 case kVK_Delete: ch = '\b'; break;
5116                 case kVK_ANSI_KeypadEnter: ch = '\r'; kp = TRUE; break;
5117             }
5118
5119             /* Hide the mouse pointer */
5120             [NSCursor setHiddenUntilMouseMoves:YES];
5121             
5122             /* Enqueue it */
5123             if (ch != '\0')
5124             {
5125                 Term_keypress(ch);
5126             }
5127             else
5128             {
5129                 /*
5130                  * Could use the hexsym global but some characters overlap with
5131                  * those used to indicate modifiers.
5132                  */
5133                 const char encoded[16] = {
5134                     '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b',
5135                     'c', 'd', 'e', 'f'
5136                 };
5137
5138                 /* Begin the macro trigger. */
5139                 Term_keypress(31);
5140
5141                 /* Send the modifiers. */
5142                 if (mc) Term_keypress('C');
5143                 if (ms) Term_keypress('S');
5144                 if (mo) Term_keypress('O');
5145                 if (kp) Term_keypress('K');
5146
5147                 do {
5148                     Term_keypress(encoded[c & 0xF]);
5149                     c >>= 4;
5150                 } while (c > 0);
5151
5152                 /* End the macro trigger. */
5153                 Term_keypress(13);
5154             }
5155             
5156             break;
5157         }
5158             
5159         case NSLeftMouseDown:
5160                 case NSRightMouseDown:
5161                         AngbandHandleEventMouseDown(event);
5162             break;
5163
5164         case NSApplicationDefined:
5165         {
5166             if ([event subtype] == AngbandEventWakeup)
5167             {
5168                 return YES;
5169             }
5170             break;
5171         }
5172             
5173         default:
5174             [NSApp sendEvent:event];
5175             return YES;
5176     }
5177     return YES;
5178 }
5179
5180 /**
5181  * Check for Events, return TRUE if we process any
5182  */
5183 static BOOL check_events(int wait)
5184 {
5185     BOOL result = YES;
5186
5187     @autoreleasepool {
5188         /* Handles the quit_when_ready flag */
5189         if (quit_when_ready) quit_calmly();
5190
5191         NSDate* endDate;
5192         if (wait == CHECK_EVENTS_WAIT) endDate = [NSDate distantFuture];
5193         else endDate = [NSDate distantPast];
5194
5195         NSEvent* event;
5196         for (;;) {
5197             if (quit_when_ready)
5198             {
5199                 /* send escape events until we quit */
5200                 Term_keypress(0x1B);
5201                 result = NO;
5202                 break;
5203             }
5204             else {
5205                 event = [NSApp nextEventMatchingMask:-1 untilDate:endDate
5206                                inMode:NSDefaultRunLoopMode dequeue:YES];
5207                 if (! event) {
5208                     result = NO;
5209                     break;
5210                 }
5211                 if (send_event(event)) break;
5212             }
5213         }
5214     }
5215
5216     return result;
5217 }
5218
5219 /**
5220  * Hook to tell the user something important
5221  */
5222 static void hook_plog(const char * str)
5223 {
5224     if (str)
5225     {
5226         NSString *msg = NSLocalizedStringWithDefaultValue(
5227             @"Warning", AngbandMessageCatalog, [NSBundle mainBundle],
5228             @"Warning", @"Alert text for generic warning");
5229         NSString *info = [NSString stringWithCString:str
5230 #ifdef JP
5231                                    encoding:NSJapaneseEUCStringEncoding
5232 #else
5233                                    encoding:NSMacOSRomanStringEncoding
5234 #endif
5235         ];
5236         NSAlert *alert = [[NSAlert alloc] init];
5237
5238         alert.messageText = msg;
5239         alert.informativeText = info;
5240         [alert runModal];
5241     }
5242 }
5243
5244
5245 /**
5246  * Hook to tell the user something, and then quit
5247  */
5248 static void hook_quit(const char * str)
5249 {
5250     for (int i = ANGBAND_TERM_MAX - 1; i >= 0; --i) {
5251         if (angband_term[i]) {
5252             term_nuke(angband_term[i]);
5253         }
5254     }
5255     [AngbandSoundCatalog clearSharedSounds];
5256     [AngbandContext setDefaultFont:nil];
5257     plog(str);
5258     exit(0);
5259 }
5260
5261 /**
5262  * Return the path for Angband's lib directory and bail if it isn't found. The
5263  * lib directory should be in the bundle's resources directory, since it's
5264  * copied when built.
5265  */
5266 static NSString* get_lib_directory(void)
5267 {
5268     NSString *bundleLibPath = [[[NSBundle mainBundle] resourcePath] stringByAppendingPathComponent: AngbandDirectoryNameLib];
5269     BOOL isDirectory = NO;
5270     BOOL libExists = [[NSFileManager defaultManager] fileExistsAtPath: bundleLibPath isDirectory: &isDirectory];
5271
5272     if( !libExists || !isDirectory )
5273     {
5274         NSLog( @"%@: can't find %@/ in bundle: isDirectory: %d libExists: %d", @VERSION_NAME, AngbandDirectoryNameLib, isDirectory, libExists );
5275
5276         NSString *msg = NSLocalizedStringWithDefaultValue(
5277             @"Error.MissingResources",
5278             AngbandMessageCatalog,
5279             [NSBundle mainBundle],
5280             @"Missing Resources",
5281             @"Alert text for missing resources");
5282         NSString *info = NSLocalizedStringWithDefaultValue(
5283             @"Error.MissingAngbandLib",
5284             AngbandMessageCatalog,
5285             [NSBundle mainBundle],
5286             @"Hengband was unable to find required resources and must quit. Please report a bug on the Angband forums.",
5287             @"Alert informative message for missing Angband lib/ folder");
5288         NSString *quit_label = NSLocalizedStringWithDefaultValue(
5289             @"Label.Quit", AngbandMessageCatalog, [NSBundle mainBundle],
5290             @"Quit", @"Quit");
5291         NSAlert *alert = [[NSAlert alloc] init];
5292         /*
5293          * Note that NSCriticalAlertStyle was deprecated in 10.10.  The
5294          * replacement is NSAlertStyleCritical.
5295          */
5296         alert.alertStyle = NSCriticalAlertStyle;
5297         alert.messageText = msg;
5298         alert.informativeText = info;
5299         [alert addButtonWithTitle:quit_label];
5300         [alert runModal];
5301         exit(0);
5302     }
5303
5304     return bundleLibPath;
5305 }
5306
5307 /**
5308  * Return the path for the directory where Angband should look for its standard
5309  * user file tree.
5310  */
5311 static NSString* get_doc_directory(void)
5312 {
5313         NSString *documents = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
5314
5315 #if defined(SAFE_DIRECTORY)
5316         NSString *versionedDirectory = [NSString stringWithFormat: @"%@-%s", AngbandDirectoryNameBase, VERSION_STRING];
5317         return [documents stringByAppendingPathComponent: versionedDirectory];
5318 #else
5319         return [documents stringByAppendingPathComponent: AngbandDirectoryNameBase];
5320 #endif
5321 }
5322
5323 /**
5324  * Adjust directory paths as needed to correct for any differences needed by
5325  * Angband.  init_file_paths() currently requires that all paths provided have
5326  * a trailing slash and all other platforms honor this.
5327  *
5328  * \param originalPath The directory path to adjust.
5329  * \return A path suitable for Angband or nil if an error occurred.
5330  */
5331 static NSString* AngbandCorrectedDirectoryPath(NSString *originalPath)
5332 {
5333         if ([originalPath length] == 0) {
5334                 return nil;
5335         }
5336
5337         if (![originalPath hasSuffix: @"/"]) {
5338                 return [originalPath stringByAppendingString: @"/"];
5339         }
5340
5341         return originalPath;
5342 }
5343
5344 /**
5345  * Give Angband the base paths that should be used for the various directories
5346  * it needs. It will create any needed directories.
5347  */
5348 static void prepare_paths_and_directories(void)
5349 {
5350         char libpath[PATH_MAX + 1] = "\0";
5351         NSString *libDirectoryPath =
5352             AngbandCorrectedDirectoryPath(get_lib_directory());
5353         [libDirectoryPath getFileSystemRepresentation: libpath maxLength: sizeof(libpath)];
5354
5355         char basepath[PATH_MAX + 1] = "\0";
5356         NSString *angbandDocumentsPath =
5357             AngbandCorrectedDirectoryPath(get_doc_directory());
5358         [angbandDocumentsPath getFileSystemRepresentation: basepath maxLength: sizeof(basepath)];
5359
5360         init_file_paths(libpath, basepath);
5361         create_needed_dirs();
5362 }
5363
5364 /**
5365  * Create and initialize Angband terminal number "i".
5366  */
5367 static term *term_data_link(int i)
5368 {
5369     NSArray *terminalDefaults = [[NSUserDefaults standardUserDefaults]
5370                                     valueForKey: AngbandTerminalsDefaultsKey];
5371     NSInteger rows = 24;
5372     NSInteger columns = 80;
5373
5374     if (i < (int)[terminalDefaults count]) {
5375         NSDictionary *term = [terminalDefaults objectAtIndex:i];
5376         rows = [[term valueForKey: AngbandTerminalRowsDefaultsKey]
5377                    integerValue];
5378         columns = [[term valueForKey: AngbandTerminalColumnsDefaultsKey]
5379                       integerValue];
5380     }
5381
5382     /* Allocate */
5383     term *newterm = ZNEW(term);
5384
5385     /* Initialize the term */
5386     term_init(newterm, columns, rows, 256 /* keypresses, for some reason? */);
5387
5388     /* Use a "software" cursor */
5389     newterm->soft_cursor = TRUE;
5390
5391     /* Disable the per-row flush notifications since they are not used. */
5392     newterm->never_frosh = TRUE;
5393
5394     /*
5395      * Differentiate between BS/^h, Tab/^i, ... so ^h and ^j work under the
5396      * roguelike command set.
5397      */
5398     /* newterm->complex_input = TRUE; */
5399
5400     /* Erase with "white space" */
5401     newterm->attr_blank = TERM_WHITE;
5402     newterm->char_blank = ' ';
5403
5404     /* Prepare the init/nuke hooks */
5405     newterm->init_hook = Term_init_cocoa;
5406     newterm->nuke_hook = Term_nuke_cocoa;
5407
5408     /* Prepare the function hooks */
5409     newterm->xtra_hook = Term_xtra_cocoa;
5410     newterm->wipe_hook = Term_wipe_cocoa;
5411     newterm->curs_hook = Term_curs_cocoa;
5412     newterm->bigcurs_hook = Term_bigcurs_cocoa;
5413     newterm->text_hook = Term_text_cocoa;
5414     newterm->pict_hook = Term_pict_cocoa;
5415     /* newterm->mbcs_hook = Term_mbcs_cocoa; */
5416
5417     /* Global pointer */
5418     angband_term[i] = newterm;
5419
5420     return newterm;
5421 }
5422
5423 /**
5424  * Load preferences from preferences file for current host+current user+
5425  * current application.
5426  */
5427 static void load_prefs(void)
5428 {
5429     NSUserDefaults *defs = [NSUserDefaults angbandDefaults];
5430
5431     /* Make some default defaults */
5432     NSMutableArray *defaultTerms = [[NSMutableArray alloc] init];
5433
5434     /*
5435      * The following default rows/cols were determined experimentally by first
5436      * finding the ideal window/font size combinations. But because of awful
5437      * temporal coupling in Term_init_cocoa(), it's impossible to set up the
5438      * defaults there, so we do it this way.
5439      */
5440     for (NSUInteger i = 0; i < ANGBAND_TERM_MAX; i++) {
5441         int columns, rows;
5442         BOOL visible = YES;
5443
5444         switch (i) {
5445         case 0:
5446             columns = 129;
5447             rows = 32;
5448             break;
5449         case 1:
5450             columns = 84;
5451             rows = 20;
5452             break;
5453         case 2:
5454             columns = 42;
5455             rows = 24;
5456             break;
5457         case 3:
5458             columns = 42;
5459             rows = 20;
5460             break;
5461         case 4:
5462             columns = 42;
5463             rows = 16;
5464             break;
5465         case 5:
5466             columns = 84;
5467             rows = 20;
5468             break;
5469         default:
5470             columns = 80;
5471             rows = 24;
5472             visible = NO;
5473             break;
5474         }
5475
5476         NSDictionary *standardTerm =
5477             [NSDictionary dictionaryWithObjectsAndKeys:
5478                           [NSNumber numberWithInt: rows], AngbandTerminalRowsDefaultsKey,
5479                           [NSNumber numberWithInt: columns], AngbandTerminalColumnsDefaultsKey,
5480                           [NSNumber numberWithBool: visible], AngbandTerminalVisibleDefaultsKey,
5481                           nil];
5482         [defaultTerms addObject: standardTerm];
5483     }
5484
5485     NSDictionary *defaults = [[NSDictionary alloc] initWithObjectsAndKeys:
5486 #ifdef JP
5487                               @"Osaka", @"FontName",
5488 #else
5489                               @"Menlo", @"FontName",
5490 #endif
5491                               [NSNumber numberWithFloat:13.f], @"FontSize",
5492                               [NSNumber numberWithInt:60], AngbandFrameRateDefaultsKey,
5493                               [NSNumber numberWithBool:YES], AngbandSoundDefaultsKey,
5494                               [NSNumber numberWithInt:GRAPHICS_NONE], AngbandGraphicsDefaultsKey,
5495                               [NSNumber numberWithBool:YES], AngbandBigTileDefaultsKey,
5496                               defaultTerms, AngbandTerminalsDefaultsKey,
5497                               nil];
5498     [defs registerDefaults:defaults];
5499
5500     /* Preferred graphics mode */
5501     graf_mode_req = [defs integerForKey:AngbandGraphicsDefaultsKey];
5502     if (graphics_will_be_enabled() &&
5503         [defs boolForKey:AngbandBigTileDefaultsKey] == YES) {
5504         use_bigtile = TRUE;
5505         arg_bigtile = TRUE;
5506     } else {
5507         use_bigtile = FALSE;
5508         arg_bigtile = FALSE;
5509     }
5510
5511     /* Use sounds; set the Angband global */
5512     if ([defs boolForKey:AngbandSoundDefaultsKey] == YES) {
5513         use_sound = TRUE;
5514         [AngbandSoundCatalog sharedSounds].enabled = YES;
5515     } else {
5516         use_sound = FALSE;
5517         [AngbandSoundCatalog sharedSounds].enabled = NO;
5518     }
5519
5520     /* fps */
5521     frames_per_second = [defs integerForKey:AngbandFrameRateDefaultsKey];
5522
5523     /* Font */
5524     [AngbandContext
5525         setDefaultFont:[NSFont fontWithName:[defs valueForKey:@"FontName-0"]
5526                                size:[defs floatForKey:@"FontSize-0"]]];
5527     if (! [AngbandContext defaultFont])
5528         [AngbandContext
5529             setDefaultFont:[NSFont fontWithName:@"Menlo" size:13.]];
5530 }
5531
5532 /**
5533  * Play sound effects asynchronously.  Select a sound from any available
5534  * for the required event, and bridge to Cocoa to play it.
5535  */
5536 static void play_sound(int event)
5537 {
5538     [[AngbandSoundCatalog sharedSounds] playSound:event];
5539 }
5540
5541 /**
5542  * Allocate the primary Angband terminal and activate it.  Allocate the other
5543  * Angband terminals.
5544  */
5545 static void init_windows(void)
5546 {
5547     /* Create the primary window */
5548     term *primary = term_data_link(0);
5549
5550     /* Prepare to create any additional windows */
5551     for (int i = 1; i < ANGBAND_TERM_MAX; i++) {
5552         term_data_link(i);
5553     }
5554
5555     /* Activate the primary term */
5556     Term_activate(primary);
5557 }
5558
5559 /**
5560  * ------------------------------------------------------------------------
5561  * Main program
5562  * ------------------------------------------------------------------------ */
5563
5564 @implementation AngbandAppDelegate
5565
5566 @synthesize graphicsMenu=_graphicsMenu;
5567 @synthesize commandMenu=_commandMenu;
5568 @synthesize commandMenuTagMap=_commandMenuTagMap;
5569
5570 - (IBAction)newGame:sender
5571 {
5572     /* Game is in progress */
5573     game_in_progress = TRUE;
5574     new_game = TRUE;
5575 }
5576
5577 - (IBAction)editFont:sender
5578 {
5579     NSFontPanel *panel = [NSFontPanel sharedFontPanel];
5580     NSFont *termFont = [AngbandContext defaultFont];
5581
5582     int i;
5583     for (i=0; i < ANGBAND_TERM_MAX; i++) {
5584         AngbandContext *context =
5585             (__bridge AngbandContext*) (angband_term[i]->data);
5586         if ([context isKeyWindow]) {
5587             termFont = [context angbandViewFont];
5588             break;
5589         }
5590     }
5591
5592     [panel setPanelFont:termFont isMultiple:NO];
5593     [panel orderFront:self];
5594 }
5595
5596 /**
5597  * Implement NSObject's changeFont() method to receive a notification about the
5598  * changed font.  Note that, as of 10.14, changeFont() is deprecated in
5599  * NSObject - it will be removed at some point and the application delegate
5600  * will have to be declared as implementing the NSFontChanging protocol.
5601  */
5602 - (void)changeFont:(id)sender
5603 {
5604     int mainTerm;
5605     for (mainTerm=0; mainTerm < ANGBAND_TERM_MAX; mainTerm++) {
5606         AngbandContext *context =
5607             (__bridge AngbandContext*) (angband_term[mainTerm]->data);
5608         if ([context isKeyWindow]) {
5609             break;
5610         }
5611     }
5612
5613     /* Bug #1709: Only change font for angband windows */
5614     if (mainTerm == ANGBAND_TERM_MAX) return;
5615
5616     NSFont *oldFont = [AngbandContext defaultFont];
5617     NSFont *newFont = [sender convertFont:oldFont];
5618     if (! newFont) return; /*paranoia */
5619
5620     /* Store as the default font if we changed the first term */
5621     if (mainTerm == 0) {
5622         [AngbandContext setDefaultFont:newFont];
5623     }
5624
5625     /* Record it in the preferences */
5626     NSUserDefaults *defs = [NSUserDefaults angbandDefaults];
5627     [defs setValue:[newFont fontName] 
5628         forKey:[NSString stringWithFormat:@"FontName-%d", mainTerm]];
5629     [defs setFloat:[newFont pointSize]
5630         forKey:[NSString stringWithFormat:@"FontSize-%d", mainTerm]];
5631
5632     NSDisableScreenUpdates();
5633
5634     /* Update window */
5635     AngbandContext *angbandContext =
5636         (__bridge AngbandContext*) (angband_term[mainTerm]->data);
5637     [(id)angbandContext setSelectionFont:newFont adjustTerminal: YES];
5638
5639     NSEnableScreenUpdates();
5640
5641     if (mainTerm != 0 || ! redraw_for_tiles_or_term0_font()) {
5642         [(id)angbandContext requestRedraw];
5643     }
5644 }
5645
5646 - (IBAction)openGame:sender
5647 {
5648     @autoreleasepool {
5649         BOOL selectedSomething = NO;
5650         int panelResult;
5651
5652         /* Get where we think the save files are */
5653         NSURL *startingDirectoryURL =
5654             [NSURL fileURLWithPath:[NSString stringWithCString:ANGBAND_DIR_SAVE encoding:NSASCIIStringEncoding]
5655                    isDirectory:YES];
5656
5657         /* Set up an open panel */
5658         NSOpenPanel* panel = [NSOpenPanel openPanel];
5659         [panel setCanChooseFiles:YES];
5660         [panel setCanChooseDirectories:NO];
5661         [panel setResolvesAliases:YES];
5662         [panel setAllowsMultipleSelection:NO];
5663         [panel setTreatsFilePackagesAsDirectories:YES];
5664         [panel setDirectoryURL:startingDirectoryURL];
5665
5666         /* Run it */
5667         panelResult = [panel runModal];
5668         if (panelResult == NSOKButton)
5669         {
5670             NSArray* fileURLs = [panel URLs];
5671             if ([fileURLs count] > 0 && [[fileURLs objectAtIndex:0] isFileURL])
5672             {
5673                 NSURL* savefileURL = (NSURL *)[fileURLs objectAtIndex:0];
5674                 /*
5675                  * The path property doesn't do the right thing except for
5676                  * URLs with the file scheme. We had
5677                  * getFileSystemRepresentation here before, but that wasn't
5678                  * introduced until OS X 10.9.
5679                  */
5680                 selectedSomething = [[savefileURL path]
5681                                         getCString:savefile
5682                                         maxLength:sizeof savefile
5683                                         encoding:NSMacOSRomanStringEncoding];
5684             }
5685         }
5686
5687         if (selectedSomething)
5688         {
5689             /* Remember this so we can select it by default next time */
5690             record_current_savefile();
5691
5692             /* Game is in progress */
5693             game_in_progress = TRUE;
5694         }
5695     }
5696 }
5697
5698 - (IBAction)saveGame:sender
5699 {
5700     /* Hack -- Forget messages */
5701     msg_flag = FALSE;
5702     
5703     /* Save the game */
5704     do_cmd_save_game(FALSE);
5705     
5706     /*
5707      * Record the current save file so we can select it by default next time.
5708      * It's a little sketchy that this only happens when we save through the
5709      * menu; ideally game-triggered saves would trigger it too.
5710      */
5711     record_current_savefile();
5712 }
5713
5714 /**
5715  * Entry point for initializing Angband
5716  */
5717 - (void)beginGame
5718 {
5719     @autoreleasepool {
5720         /* Hooks in some "z-util.c" hooks */
5721         plog_aux = hook_plog;
5722         quit_aux = hook_quit;
5723
5724         /* Initialize file paths */
5725         prepare_paths_and_directories();
5726
5727         /* Note the "system" */
5728         ANGBAND_SYS = "coc";
5729
5730         /* Load possible graphics modes */
5731         init_graphics_modes();
5732
5733         /* Load preferences */
5734         load_prefs();
5735
5736         /* Prepare the windows */
5737         init_windows();
5738
5739         /* Set up game event handlers */
5740         /* init_display(); */
5741
5742         /* Register the sound hook */
5743         /* sound_hook = play_sound; */
5744
5745         /* Initialize some save file stuff */
5746         player_euid = geteuid();
5747         player_egid = getegid();
5748
5749         /* Initialise game */
5750         init_angband();
5751
5752         /* We are now initialized */
5753         initialized = TRUE;
5754
5755         /* Handle "open_when_ready" */
5756         handle_open_when_ready();
5757
5758         /* Handle pending events (most notably update) and flush input */
5759         Term_flush();
5760
5761         /*
5762          * Prompt the user; assume the splash screen is 80 x 23 and position
5763          * relative to that rather than center based on the full size of the
5764          * window.
5765          */
5766         int message_row = 23;
5767         Term_erase(0, message_row, 255);
5768         put_str(
5769 #ifdef JP
5770             "['ファイル' メニューから '新規' または '開く' を選択します]",
5771             message_row, (80 - 59) / 2
5772 #else
5773             "[Choose 'New' or 'Open' from the 'File' menu]",
5774             message_row, (80 - 45) / 2
5775 #endif
5776         );
5777         Term_fresh();
5778     }
5779
5780     while (!game_in_progress) {
5781         @autoreleasepool {
5782             NSEvent *event = [NSApp nextEventMatchingMask:NSAnyEventMask untilDate:[NSDate distantFuture] inMode:NSDefaultRunLoopMode dequeue:YES];
5783             if (event) [NSApp sendEvent:event];
5784         }
5785     }
5786
5787     /*
5788      * Play a game -- "new_game" is set by "new", "open" or the open document
5789      * even handler as appropriate
5790      */
5791     Term_fresh();
5792     play_game(new_game);
5793
5794     quit(NULL);
5795 }
5796
5797 /**
5798  * Implement NSObject's validateMenuItem() method to override enabling or
5799  * disabling a menu item.  Note that, as of 10.14, validateMenuItem() is
5800  * deprecated in NSObject - it will be removed at some point and the
5801  * application delegate will have to be declared as implementing the
5802  * NSMenuItemValidation protocol.
5803  */
5804 - (BOOL)validateMenuItem:(NSMenuItem *)menuItem
5805 {
5806     SEL sel = [menuItem action];
5807     NSInteger tag = [menuItem tag];
5808
5809     if( tag >= AngbandWindowMenuItemTagBase && tag < AngbandWindowMenuItemTagBase + ANGBAND_TERM_MAX )
5810     {
5811         if( tag == AngbandWindowMenuItemTagBase )
5812         {
5813             /* The main window should always be available and visible */
5814             return YES;
5815         }
5816         else
5817         {
5818             /*
5819              * Another window is only usable after Term_init_cocoa() has
5820              * been called for it.  For Angband, if window_flag[i] is nonzero
5821              * then that has happened for window i.  For Hengband, that is
5822              * not the case so also test angband_term[i]->data.
5823              */
5824             NSInteger subwindowNumber = tag - AngbandWindowMenuItemTagBase;
5825             return (angband_term[subwindowNumber]->data != 0
5826                     && window_flag[subwindowNumber] > 0);
5827         }
5828
5829         return NO;
5830     }
5831
5832     if (sel == @selector(newGame:))
5833     {
5834         return ! game_in_progress;
5835     }
5836     else if (sel == @selector(editFont:))
5837     {
5838         return YES;
5839     }
5840     else if (sel == @selector(openGame:))
5841     {
5842         return ! game_in_progress;
5843     }
5844     else if (sel == @selector(setRefreshRate:) &&
5845              [[menuItem parentItem] tag] == 150)
5846     {
5847         NSInteger fps = [[NSUserDefaults standardUserDefaults] integerForKey:AngbandFrameRateDefaultsKey];
5848         [menuItem setState: ([menuItem tag] == fps)];
5849         return YES;
5850     }
5851     else if( sel == @selector(setGraphicsMode:) )
5852     {
5853         NSInteger requestedGraphicsMode = [[NSUserDefaults standardUserDefaults] integerForKey:AngbandGraphicsDefaultsKey];
5854         [menuItem setState: (tag == requestedGraphicsMode)];
5855         return YES;
5856     }
5857     else if( sel == @selector(toggleSound:) )
5858     {
5859         BOOL is_on = [[NSUserDefaults standardUserDefaults]
5860                          boolForKey:AngbandSoundDefaultsKey];
5861
5862         [menuItem setState: ((is_on) ? NSOnState : NSOffState)];
5863         return YES;
5864     }
5865     else if (sel == @selector(toggleWideTiles:)) {
5866         BOOL is_on = [[NSUserDefaults standardUserDefaults]
5867                          boolForKey:AngbandBigTileDefaultsKey];
5868
5869         [menuItem setState: ((is_on) ? NSOnState : NSOffState)];
5870         return YES;
5871     }
5872     else if( sel == @selector(sendAngbandCommand:) ||
5873              sel == @selector(saveGame:) )
5874     {
5875         /*
5876          * we only want to be able to send commands during an active game
5877          * after the birth screens
5878          */
5879         return !!game_in_progress && character_generated;
5880     }
5881     else return YES;
5882 }
5883
5884
5885 - (IBAction)setRefreshRate:(NSMenuItem *)menuItem
5886 {
5887     frames_per_second = [menuItem tag];
5888     [[NSUserDefaults angbandDefaults] setInteger:frames_per_second forKey:AngbandFrameRateDefaultsKey];
5889 }
5890
5891 - (void)setGraphicsMode:(NSMenuItem *)sender
5892 {
5893     /* We stashed the graphics mode ID in the menu item's tag */
5894     graf_mode_req = [sender tag];
5895
5896     /* Stash it in UserDefaults */
5897     [[NSUserDefaults angbandDefaults] setInteger:graf_mode_req forKey:AngbandGraphicsDefaultsKey];
5898
5899     if (! graphics_will_be_enabled()) {
5900         if (use_bigtile) {
5901             arg_bigtile = FALSE;
5902         }
5903     } else if ([[NSUserDefaults angbandDefaults] boolForKey:AngbandBigTileDefaultsKey] == YES &&
5904                ! use_bigtile) {
5905         arg_bigtile = TRUE;
5906     }
5907
5908     if (arg_bigtile != use_bigtile) {
5909         Term_activate(angband_term[0]);
5910         Term_resize(angband_term[0]->wid, angband_term[0]->hgt);
5911     }
5912     redraw_for_tiles_or_term0_font();
5913 }
5914
5915 - (void)selectWindow: (id)sender
5916 {
5917     NSInteger subwindowNumber =
5918         [(NSMenuItem *)sender tag] - AngbandWindowMenuItemTagBase;
5919     AngbandContext *context =
5920         (__bridge AngbandContext*) (angband_term[subwindowNumber]->data);
5921     [context.primaryWindow makeKeyAndOrderFront: self];
5922     [context saveWindowVisibleToDefaults: YES];
5923 }
5924
5925 - (IBAction) toggleSound: (NSMenuItem *) sender
5926 {
5927     BOOL is_on = (sender.state == NSOnState);
5928
5929     /* Toggle the state and update the Angband global and preferences. */
5930     if (is_on) {
5931         sender.state = NSOffState;
5932         use_sound = FALSE;
5933         [AngbandSoundCatalog sharedSounds].enabled = NO;
5934     } else {
5935         sender.state = NSOnState;
5936         use_sound = TRUE;
5937         [AngbandSoundCatalog sharedSounds].enabled = YES;
5938     }
5939     [[NSUserDefaults angbandDefaults] setBool:(! is_on)
5940                                       forKey:AngbandSoundDefaultsKey];
5941 }
5942
5943 - (IBAction)toggleWideTiles:(NSMenuItem *) sender
5944 {
5945     BOOL is_on = (sender.state == NSOnState);
5946
5947     /* Toggle the state and update the Angband globals and preferences. */
5948     sender.state = (is_on) ? NSOffState : NSOnState;
5949     [[NSUserDefaults angbandDefaults] setBool:(! is_on)
5950                                       forKey:AngbandBigTileDefaultsKey];
5951     if (graphics_are_enabled()) {
5952         arg_bigtile = (is_on) ? FALSE : TRUE;
5953         if (arg_bigtile != use_bigtile) {
5954             Term_activate(angband_term[0]);
5955             Term_resize(angband_term[0]->wid, angband_term[0]->hgt);
5956             redraw_for_tiles_or_term0_font();
5957         }
5958     }
5959 }
5960
5961 - (void)prepareWindowsMenu
5962 {
5963     @autoreleasepool {
5964         /*
5965          * Get the window menu with default items and add a separator and
5966          * item for the main window.
5967          */
5968         NSMenu *windowsMenu = [[NSApplication sharedApplication] windowsMenu];
5969         [windowsMenu addItem: [NSMenuItem separatorItem]];
5970
5971         NSString *title1 = [NSString stringWithCString:angband_term_name[0]
5972 #ifdef JP
5973                                      encoding:NSJapaneseEUCStringEncoding
5974 #else
5975                                      encoding:NSMacOSRomanStringEncoding
5976 #endif
5977         ];
5978         NSMenuItem *angbandItem = [[NSMenuItem alloc] initWithTitle:title1 action: @selector(selectWindow:) keyEquivalent: @"0"];
5979         [angbandItem setTarget: self];
5980         [angbandItem setTag: AngbandWindowMenuItemTagBase];
5981         [windowsMenu addItem: angbandItem];
5982
5983         /* Add items for the additional term windows */
5984         for( NSInteger i = 1; i < ANGBAND_TERM_MAX; i++ )
5985         {
5986             NSString *title = [NSString stringWithCString:angband_term_name[i]
5987 #ifdef JP
5988                                         encoding:NSJapaneseEUCStringEncoding
5989 #else
5990                                         encoding:NSMacOSRomanStringEncoding
5991 #endif
5992             ];
5993             NSString *keyEquivalent =
5994                 [NSString stringWithFormat: @"%ld", (long)i];
5995             NSMenuItem *windowItem =
5996                 [[NSMenuItem alloc] initWithTitle: title
5997                                     action: @selector(selectWindow:)
5998                                     keyEquivalent: keyEquivalent];
5999             [windowItem setTarget: self];
6000             [windowItem setTag: AngbandWindowMenuItemTagBase + i];
6001             [windowsMenu addItem: windowItem];
6002         }
6003     }
6004 }
6005
6006 /**
6007  * Send a command to Angband via a menu item. This places the appropriate key
6008  * down events into the queue so that it seems like the user pressed them
6009  * (instead of trying to use the term directly).
6010  */
6011 - (void)sendAngbandCommand: (id)sender
6012 {
6013     NSMenuItem *menuItem = (NSMenuItem *)sender;
6014     NSString *command = [self.commandMenuTagMap objectForKey: [NSNumber numberWithInteger: [menuItem tag]]];
6015     AngbandContext* context =
6016         (__bridge AngbandContext*) (angband_term[0]->data);
6017     NSInteger windowNumber = [context.primaryWindow windowNumber];
6018
6019     /* Send a \ to bypass keymaps */
6020     NSEvent *escape = [NSEvent keyEventWithType: NSKeyDown
6021                                        location: NSZeroPoint
6022                                   modifierFlags: 0
6023                                       timestamp: 0.0
6024                                    windowNumber: windowNumber
6025                                         context: nil
6026                                      characters: @"\\"
6027                     charactersIgnoringModifiers: @"\\"
6028                                       isARepeat: NO
6029                                         keyCode: 0];
6030     [[NSApplication sharedApplication] postEvent: escape atStart: NO];
6031
6032     /* Send the actual command (from the original command set) */
6033     NSEvent *keyDown = [NSEvent keyEventWithType: NSKeyDown
6034                                         location: NSZeroPoint
6035                                    modifierFlags: 0
6036                                        timestamp: 0.0
6037                                     windowNumber: windowNumber
6038                                          context: nil
6039                                       characters: command
6040                      charactersIgnoringModifiers: command
6041                                        isARepeat: NO
6042                                          keyCode: 0];
6043     [[NSApplication sharedApplication] postEvent: keyDown atStart: NO];
6044 }
6045
6046 /**
6047  * Set up the command menu dynamically, based on CommandMenu.plist.
6048  */
6049 - (void)prepareCommandMenu
6050 {
6051     @autoreleasepool {
6052         NSString *commandMenuPath =
6053             [[NSBundle mainBundle] pathForResource: @"CommandMenu"
6054                                    ofType: @"plist"];
6055         NSArray *commandMenuItems =
6056             [[NSArray alloc] initWithContentsOfFile: commandMenuPath];
6057         NSMutableDictionary *angbandCommands =
6058             [[NSMutableDictionary alloc] init];
6059         NSString *tblname = @"CommandMenu";
6060         NSInteger tagOffset = 0;
6061
6062         for( NSDictionary *item in commandMenuItems )
6063         {
6064             BOOL useShiftModifier =
6065                 [[item valueForKey: @"ShiftModifier"] boolValue];
6066             BOOL useOptionModifier =
6067                 [[item valueForKey: @"OptionModifier"] boolValue];
6068             NSUInteger keyModifiers = NSCommandKeyMask;
6069             keyModifiers |= (useShiftModifier) ? NSShiftKeyMask : 0;
6070             keyModifiers |= (useOptionModifier) ? NSAlternateKeyMask : 0;
6071
6072             NSString *lookup = [item valueForKey: @"Title"];
6073             NSString *title = NSLocalizedStringWithDefaultValue(
6074                 lookup, tblname, [NSBundle mainBundle], lookup, @"");
6075             NSString *key = [item valueForKey: @"KeyEquivalent"];
6076             NSMenuItem *menuItem =
6077                 [[NSMenuItem alloc] initWithTitle: title
6078                                     action: @selector(sendAngbandCommand:)
6079                                     keyEquivalent: key];
6080             [menuItem setTarget: self];
6081             [menuItem setKeyEquivalentModifierMask: keyModifiers];
6082             [menuItem setTag: AngbandCommandMenuItemTagBase + tagOffset];
6083             [self.commandMenu addItem: menuItem];
6084
6085             NSString *angbandCommand = [item valueForKey: @"AngbandCommand"];
6086             [angbandCommands setObject: angbandCommand
6087                              forKey: [NSNumber numberWithInteger: [menuItem tag]]];
6088             tagOffset++;
6089         }
6090
6091         self.commandMenuTagMap = [[NSDictionary alloc]
6092                                      initWithDictionary: angbandCommands];
6093     }
6094 }
6095
6096 - (void)awakeFromNib
6097 {
6098     [super awakeFromNib];
6099
6100     [self prepareWindowsMenu];
6101     [self prepareCommandMenu];
6102 }
6103
6104 - (void)applicationDidFinishLaunching:sender
6105 {
6106     [self beginGame];
6107     
6108     /*
6109      * Once beginGame finished, the game is over - that's how Angband works,
6110      * and we should quit
6111      */
6112     game_is_finished = TRUE;
6113     [NSApp terminate:self];
6114 }
6115
6116 - (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender
6117 {
6118     if (p_ptr->playing == FALSE || game_is_finished == TRUE)
6119     {
6120         quit_when_ready = true;
6121         return NSTerminateNow;
6122     }
6123     else if (! inkey_flag)
6124     {
6125         /* For compatibility with other ports, do not quit in this case */
6126         return NSTerminateCancel;
6127     }
6128     else
6129     {
6130         /* Stop playing */
6131         /* player->upkeep->playing = FALSE; */
6132
6133         /*
6134          * Post an escape event so that we can return from our get-key-event
6135          * function
6136          */
6137         wakeup_event_loop();
6138         quit_when_ready = true;
6139         /*
6140          * Must return Cancel, not Later, because we need to get out of the
6141          * run loop and back to Angband's loop
6142          */
6143         return NSTerminateCancel;
6144     }
6145 }
6146
6147 /**
6148  * Dynamically build the Graphics menu
6149  */
6150 - (void)menuNeedsUpdate:(NSMenu *)menu {
6151     
6152     /* Only the graphics menu is dynamic */
6153     if (! [menu isEqual:self.graphicsMenu])
6154         return;
6155     
6156     /*
6157      * If it's non-empty, then we've already built it. Currently graphics modes
6158      * won't change once created; if they ever can we can remove this check.
6159      * Note that the check mark does change, but that's handled in
6160      * validateMenuItem: instead of menuNeedsUpdate:
6161      */
6162     if ([menu numberOfItems] > 0)
6163         return;
6164     
6165     /* This is the action for all these menu items */
6166     SEL action = @selector(setGraphicsMode:);
6167     
6168     /* Add an initial Classic ASCII menu item */
6169     NSString *tblname = @"GraphicsMenu";
6170     NSString *key = @"Classic ASCII";
6171     NSString *title = NSLocalizedStringWithDefaultValue(
6172         key, tblname, [NSBundle mainBundle], key, @"");
6173     NSMenuItem *classicItem = [menu addItemWithTitle:title action:action keyEquivalent:@""];
6174     [classicItem setTag:GRAPHICS_NONE];
6175     
6176     /* Walk through the list of graphics modes */
6177     if (graphics_modes) {
6178         NSInteger i;
6179
6180         for (i=0; graphics_modes[i].pNext; i++)
6181         {
6182             const graphics_mode *graf = &graphics_modes[i];
6183
6184             if (graf->grafID == GRAPHICS_NONE) {
6185                 continue;
6186             }
6187             /* Make the title. NSMenuItem throws on a nil title, so ensure it's
6188                    * not nil. */
6189             key = [[NSString alloc] initWithUTF8String:graf->menuname];
6190             title = NSLocalizedStringWithDefaultValue(
6191                 key, tblname, [NSBundle mainBundle], key, @"");
6192
6193             /* Make the item */
6194             NSMenuItem *item = [menu addItemWithTitle:title action:action keyEquivalent:@""];
6195             [item setTag:graf->grafID];
6196         }
6197     }
6198 }
6199
6200 /**
6201  * Delegate method that gets called if we're asked to open a file.
6202  */
6203 - (void)application:(NSApplication *)sender openFiles:(NSArray *)filenames
6204 {
6205     /* Can't open a file once we've started */
6206     if (game_in_progress) {
6207         [[NSApplication sharedApplication]
6208             replyToOpenOrPrint:NSApplicationDelegateReplyFailure];
6209         return;
6210     }
6211
6212     /* We can only open one file. Use the last one. */
6213     NSString *file = [filenames lastObject];
6214     if (! file) {
6215         [[NSApplication sharedApplication]
6216             replyToOpenOrPrint:NSApplicationDelegateReplyFailure];
6217         return;
6218     }
6219
6220     /* Put it in savefile */
6221     if (! [file getFileSystemRepresentation:savefile maxLength:sizeof savefile]) {
6222         [[NSApplication sharedApplication]
6223             replyToOpenOrPrint:NSApplicationDelegateReplyFailure];
6224         return;
6225     }
6226
6227     game_in_progress = TRUE;
6228
6229     /*
6230      * Wake us up in case this arrives while we're sitting at the Welcome
6231      * screen!
6232      */
6233     wakeup_event_loop();
6234
6235     [[NSApplication sharedApplication]
6236         replyToOpenOrPrint:NSApplicationDelegateReplySuccess];
6237 }
6238
6239 @end
6240
6241 int main(int argc, char* argv[])
6242 {
6243     NSApplicationMain(argc, (void*)argv);
6244     return (0);
6245 }
6246
6247 #endif /* MACINTOSH || MACH_O_COCOA */