Introduced a new function in every game which formats a game_state
[sgt/puzzles] / osx.m
diff --git a/osx.m b/osx.m
index 2a89705..28af613 100644 (file)
--- a/osx.m
+++ b/osx.m
@@ -1,15 +1,28 @@
 /*
  * Mac OS X / Cocoa front end to puzzles.
  *
- * TODO:
+ * Still to do:
+ * 
+ *  - I'd like to be able to call up context help for a specific
+ *    game at a time.
+ * 
+ * Mac interface issues that possibly could be done better:
+ * 
+ *  - is there a better approach to frontend_default_colour?
  *
- *  - status bar support.
+ *  - do we need any more options in the Window menu?
  *
+ *  - can / should we be doing anything with the titles of the
+ *    configuration boxes?
+ * 
  *  - not sure what I should be doing about default window
  *    placement. Centring new windows is a bit feeble, but what's
  *    better? Is there a standard way to tell the OS "here's the
  *    _size_ of window I want, now use your best judgment about the
  *    initial position"?
+ *     + there's a standard _policy_ on window placement, given in
+ *      the HI guidelines. Have to implement it ourselves though,
+ *      bah.
  *
  *  - a brief frob of the Mac numeric keypad suggests that it
  *    generates numbers no matter what you do. I wonder if I should
  *    should simply assign the number keys to UP_LEFT et al?
  *    They're not in use for anything else right now.
  *
- *  - proper fatal errors.
- *
- *  - is there a better approach to frontend_default_colour?
- *
- *  - do we need any more options in the Window menu?
- *
  *  - see if we can do anything to one-button-ise the multi-button
  *    dependent puzzle UIs:
  *     - Pattern is a _little_ unwieldy but not too bad (since
  *      even worse because rotation feels as if it ought to be the
  *      default action. I fear this is why the Flash Net had the
  *      UI it did...
+ *       + I've tried out an alternative dragging interface for
+ *         Net; it might work nicely for stylus-based platforms
+ *         where you have better hand/eye feedback for the thing
+ *         you're clicking on, but it's rather unwieldy on the
+ *         Mac. I fear even shift-clicking is better than that.
  *
- *  - Find out how to do help, and do some. We have a help file; at
- *    _worst_ this should involve a new Halibut back end, but I
- *    think help is HTML round here anyway so perhaps we can work
- *    with what we already have.
- * 
- *  - Can we arrange for a pop-up menu from the Dock icon which
- *    launches specific games, perhaps?
- *     + apparently we can; see the NSApplication method
- *      `applicationDockMenu:'. Good good. Do so.
- *
- *  - Why are the right and bottom edges of the Pattern grid one
- *    pixel thinner than they should be?
- * 
  *  - Should we _return_ to a game configuration sheet once an
  *    error is reported by midend_set_config, to allow the user to
  *    correct the one faulty input and keep the other five OK ones?
  *    nested sheet. On the other hand I think there are good
  *    practical reasons for wanting it that way. Uncertain.
  * 
+ *  - User feedback suggests we should have `File' and `Edit' menus
+ *    like everyone else, so some menu reorg is probably required,
+ *    along with some documentation rewording.
+ * 
+ *  - User feedback also dislikes nothing happening when you start
+ *    the app; they suggest a finder-like window containing an icon
+ *    for each puzzle type, enabling you to start one easily. Needs
+ *    thought.
+ * 
  * Grotty implementation details that could probably be improved:
  * 
  *  - I am _utterly_ unconvinced that NSImageView was the right way
 #import <Cocoa/Cocoa.h>
 #include "puzzles.h"
 
+/* ----------------------------------------------------------------------
+ * Global variables.
+ */
+
+/*
+ * The `Type' menu. We frob this dynamically to allow the user to
+ * choose a preset set of settings from the current game.
+ */
+NSMenu *typemenu;
+
+/* ----------------------------------------------------------------------
+ * Miscellaneous support routines that aren't part of any object or
+ * clearly defined subsystem.
+ */
+
 void fatal(char *fmt, ...)
 {
-    /* FIXME: This will do for testing, but should be GUI-ish instead. */
     va_list ap;
-
-    fprintf(stderr, "fatal error: ");
+    char errorbuf[2048];
+    NSAlert *alert;
 
     va_start(ap, fmt);
-    vfprintf(stderr, fmt, ap);
+    vsnprintf(errorbuf, lenof(errorbuf), fmt, ap);
     va_end(ap);
 
-    fprintf(stderr, "\n");
+    alert = [NSAlert alloc];
+    /*
+     * We may have come here because we ran out of memory, in which
+     * case it's entirely likely that that alloc will fail, so we
+     * should have a fallback of some sort.
+     */
+    if (!alert) {
+       fprintf(stderr, "fatal error (and NSAlert failed): %s\n", errorbuf);
+    } else {
+       alert = [[alert init] autorelease];
+       [alert addButtonWithTitle:@"Oh dear"];
+       [alert setInformativeText:[NSString stringWithCString:errorbuf]];
+       [alert runModal];
+    }
     exit(1);
 }
 
 void frontend_default_colour(frontend *fe, float *output)
 {
-    /* FIXME */
+    /* FIXME: Is there a system default we can tap into for this? */
     output[0] = output[1] = output[2] = 0.8F;
 }
-void status_bar(frontend *fe, char *text)
-{
-    /* FIXME */
-}
 
 void get_random_seed(void **randseed, int *randseedsize)
 {
@@ -112,16 +143,6 @@ void get_random_seed(void **randseed, int *randseedsize)
 }
 
 /* ----------------------------------------------------------------------
- * Global variables.
- */
-
-/*
- * The `Type' menu. We frob this dynamically to allow the user to
- * choose a preset set of settings from the current game.
- */
-NSMenu *typemenu;
-
-/* ----------------------------------------------------------------------
  * Tiny extension to NSMenuItem which carries a payload of a `void
  * *', allowing several menu items to invoke the same message but
  * pass different data through it.
@@ -266,6 +287,7 @@ struct frontend {
     int cfg_which;
     NSView **cfg_controls;
     int cfg_ncontrols;
+    NSTextField *status;
 }
 - (id)initWithGame:(const game *)g;
 - dealloc;
@@ -273,6 +295,7 @@ struct frontend {
 - (void)keyDown:(NSEvent *)ev;
 - (void)activateTimer;
 - (void)deactivateTimer;
+- (void)setStatusLine:(NSString *)text;
 @end
 
 @implementation MyImageView
@@ -349,27 +372,33 @@ struct frontend {
 @implementation GameWindow
 - (void)setupContentView
 {
-    NSSize size = {0,0};
+    NSRect frame;
     int w, h;
 
+    if (status) {
+       frame = [status frame];
+       frame.origin.y = frame.size.height;
+    } else
+       frame.origin.y = 0;
+    frame.origin.x = 0;
+
     midend_size(me, &w, &h);
-    size.width = w;
-    size.height = h;
+    frame.size.width = w;
+    frame.size.height = h;
 
-    fe.image = [[NSImage alloc] initWithSize:size];
+    fe.image = [[NSImage alloc] initWithSize:frame.size];
     [fe.image setFlipped:YES];
-    fe.view = [[MyImageView alloc]
-              initWithFrame:[self contentRectForFrameRect:[self frame]]];
+    fe.view = [[MyImageView alloc] initWithFrame:frame];
     [fe.view setImage:fe.image];
     [fe.view setWindow:self];
 
     midend_redraw(me);
 
-    [self setContentView:fe.view];
+    [[self contentView] addSubview:fe.view];
 }
 - (id)initWithGame:(const game *)g
 {
-    NSRect rect = { {0,0}, {0,0} };
+    NSRect rect = { {0,0}, {0,0} }, rect2;
     int w, h;
 
     ourgame = g;
@@ -388,6 +417,27 @@ struct frontend {
     rect.size.width = w;
     rect.size.height = h;
 
+    /*
+     * Create the status bar, which will just be an NSTextField.
+     */
+    if (ourgame->wants_statusbar()) {
+       status = [[NSTextField alloc] initWithFrame:NSMakeRect(0,0,100,50)];
+       [status setEditable:NO];
+       [status setSelectable:NO];
+       [status setBordered:YES];
+       [status setBezeled:YES];
+       [status setBezelStyle:NSTextFieldSquareBezel];
+       [status setDrawsBackground:YES];
+       [[status cell] setTitle:@""];
+       [status sizeToFit];
+       rect2 = [status frame];
+       rect.size.height += rect2.size.height;
+       rect2.size.width = rect.size.width;
+       rect2.origin.x = rect2.origin.y = 0;
+       [status setFrame:rect2];
+    } else
+       status = nil;
+
     self = [super initWithContentRect:rect
            styleMask:(NSTitledWindowMask | NSMiniaturizableWindowMask |
                       NSClosableWindowMask)
@@ -411,6 +461,8 @@ struct frontend {
     }
 
     [self setupContentView];
+    if (status)
+       [[self contentView] addSubview:status];
     [self setIgnoresMouseEvents:NO];
 
     [self center];                    /* :-) */
@@ -519,6 +571,28 @@ struct frontend {
     [self processButton:'r'&0x1F x:-1 y:-1];
 }
 
+- (void)copy:(id)sender
+{
+    char *text;
+
+    if ((text = midend_text_format(me)) != NULL) {
+       NSPasteboard *pb = [NSPasteboard generalPasteboard];
+       NSArray *a = [NSArray arrayWithObject:NSStringPboardType];
+       [pb declareTypes:a owner:nil];
+       [pb setString:[NSString stringWithCString:text]
+        forType:NSStringPboardType];
+    } else
+       NSBeep();
+}
+
+- (BOOL)validateMenuItem:(NSMenuItem *)item
+{
+    if ([item action] == @selector(copy:))
+       return (ourgame->can_format_as_text ? YES : NO);
+    else
+       return [super validateMenuItem:item];
+}
+
 - (void)clearTypeMenu
 {
     while ([typemenu numberOfItems] > 1)
@@ -580,6 +654,13 @@ struct frontend {
     size.width = w;
     size.height = h;
 
+    if (status) {
+       NSRect frame = [status frame];
+       size.height += frame.size.height;
+       frame.size.width = size.width;
+       [status setFrame:frame];
+    }
+
     NSDisableScreenUpdates();
     [self setContentSize:size];
     [self setupContentView];
@@ -688,10 +769,6 @@ struct frontend {
            if (leftw < rect.size.width + 1) leftw = rect.size.width + 1;
            cfg_controls[cfg_ncontrols++] = tf;
 
-           /* We impose a minimum width on editable NSTextFields to
-            * stop them looking _completely_ silly. */
-           if (rightw < 75) rightw = 75;
-
            tf = [[NSTextField alloc] initWithFrame:tmprect];
            [tf setEditable:YES];
            [tf setSelectable:YES];
@@ -699,6 +776,17 @@ struct frontend {
            [[tf cell] setTitle:[NSString stringWithCString:i->sval]];
            [tf sizeToFit];
            rect = [tf frame];
+           /*
+            * We impose a minimum and maximum width on editable
+            * NSTextFields. If we allow them to size themselves to
+            * the contents of the text within them, then they will
+            * look very silly if that text is only one or two
+            * characters, and equally silly if it's an absolutely
+            * enormous Rectangles or Pattern game ID!
+            */
+           if (rect.size.width < 75) rect.size.width = 75;
+           if (rect.size.width > 400) rect.size.width = 400;
+
            if (thish < rect.size.height + 1) thish = rect.size.height + 1;
            if (rightw < rect.size.width + 1) rightw = rect.size.width + 1;
            cfg_controls[cfg_ncontrols++] = tf;
@@ -896,7 +984,7 @@ struct frontend {
        error = midend_set_config(me, cfg_which, cfg);
        if (error) {
            NSAlert *alert = [[[NSAlert alloc] init] autorelease];
-           [alert addButtonWithTitle:@"OK"];
+           [alert addButtonWithTitle:@"Bah"];
            [alert setInformativeText:[NSString stringWithCString:error]];
            [alert beginSheetModalForWindow:self modalDelegate:nil
             didEndSelector:nil contextInfo:nil];
@@ -917,6 +1005,11 @@ struct frontend {
     [self sheetEndWithStatus:NO];
 }
 
+- (void)setStatusLine:(NSString *)text
+{
+    [[status cell] setTitle:text];
+}
+
 @end
 
 /*
@@ -1010,7 +1103,7 @@ void draw_text(frontend *fe, int x, int y, int fonttype, int fontsize,
 }
 void draw_update(frontend *fe, int x, int y, int w, int h)
 {
-    /* FIXME */
+    [fe->view setNeedsDisplayInRect:NSMakeRect(x,y,w,h)];
 }
 void clip(frontend *fe, int x, int y, int w, int h)
 {
@@ -1035,7 +1128,6 @@ void start_draw(frontend *fe)
 void end_draw(frontend *fe)
 {
     [fe->image unlockFocus];
-    [fe->view setNeedsDisplay];
 }
 
 void deactivate_timer(frontend *fe)
@@ -1047,6 +1139,11 @@ void activate_timer(frontend *fe)
     [fe->window activateTimer];
 }
 
+void status_bar(frontend *fe, char *text)
+{
+    [fe->window setStatusLine:[NSString stringWithCString:text]];
+}
+
 /* ----------------------------------------------------------------------
  * AppController: the object which receives the messages from all
  * menu selections that aren't standard OS X functions.
@@ -1054,12 +1151,12 @@ void activate_timer(frontend *fe)
 @interface AppController : NSObject
 {
 }
-- (IBAction)newGame:(id)sender;
+- (void)newGame:(id)sender;
 @end
 
 @implementation AppController
 
-- (IBAction)newGame:(id)sender
+- (void)newGame:(id)sender
 {
     const game *g = [sender getPayload];
     id win;
@@ -1068,6 +1165,23 @@ void activate_timer(frontend *fe)
     [win makeKeyAndOrderFront:self];
 }
 
+- (NSMenu *)applicationDockMenu:(NSApplication *)sender
+{
+    NSMenu *menu = newmenu("Dock Menu");
+    {
+       int i;
+
+       for (i = 0; i < gamecount; i++) {
+           id item =
+               initnewitem([DataMenuItem allocWithZone:[NSMenu menuZone]],
+                           menu, gamelist[i]->name, "", self,
+                           @selector(newGame:));
+           [item setPayload:(void *)gamelist[i]];
+       }
+    }
+    return menu;
+}
+
 @end
 
 /* ----------------------------------------------------------------------
@@ -1088,6 +1202,7 @@ int main(int argc, char **argv)
     [NSApp setApplicationIconImage:icon];
 
     controller = [[[AppController alloc] init] autorelease];
+    [NSApp setDelegate:controller];
 
     [NSApp setMainMenu: newmenu("Main Menu")];
 
@@ -1122,6 +1237,8 @@ int main(int argc, char **argv)
     item = newitem(menu, "Undo", "z", NULL, @selector(undoMove:));
     item = newitem(menu, "Redo", "S-z", NULL, @selector(redoMove:));
     [menu addItem:[NSMenuItem separatorItem]];
+    item = newitem(menu, "Copy", "c", NULL, @selector(copy:));
+    [menu addItem:[NSMenuItem separatorItem]];
     item = newitem(menu, "Close", "w", NULL, @selector(performClose:));
 
     menu = newsubmenu([NSApp mainMenu], "Type");
@@ -1132,6 +1249,9 @@ int main(int argc, char **argv)
     [NSApp setWindowsMenu: menu];
     item = newitem(menu, "Minimise Window", "m", NULL, @selector(performMiniaturize:));
 
+    menu = newsubmenu([NSApp mainMenu], "Help");
+    item = newitem(menu, "Puzzles Help", "?", NSApp, @selector(showHelp:));
+
     [NSApp run];
     [pool release];
 }