src/curses.c

   1 /*
   2  * Curses UI for slide puzzle game
   3  * Copyright © 2022-2023 Nick Bowler
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <config.h>
  20 #include <stdlib.h>
  21 #include <locale.h>
  22 #include <assert.h>
  23 #include <getopt.h>
  24 #include <curses.h>
  25
  26 #include "help.h"
  27 #include "version.h"
  28
  29 #include "cursesui.h"
  30 #include "cursesopt.h"
  31
  32 enum {
  33         GAME_YPOS = 1 // top row of game and goal areas.
  34 };
  35
  36 static const char *progname = "rrace";
  37 static const struct option lopts[] = { LOPTS_INITIALIZER, {0} };
  38
  39 static struct app_state state;
  40
  41 static void print_version(void)
  42 {
  43         version_print_head("rrace-curses", stdout);
  44         puts("License GPLv3+: GNU GPL version 3 or any later version");
  45         puts("This is free software: you are free to change and redistribute it.");
  46         puts("There is NO WARRANTY, to the extent permitted by law.");
  47 }
  48
  49 static void print_usage(FILE *f)
  50 {
  51         fprintf(f, "Usage: %s [options]\n", progname);
  52         if (f != stdout)
  53                 fprintf(f, "Try %s --help for more information.\n", progname);
  54 }
  55
  56 static void print_help(void)
  57 {
  58         struct lopt_help help = {0};
  59         const struct option *opt;
  60
  61         print_usage(stdout);
  62
  63         putchar('\n');
  64         puts("Options:");
  65         for (opt = lopts; opt->name; opt++) {
  66                 if (!lopt_get_help(opt, &help))
  67                         continue;
  68                 help_print_option(opt, help.arg, help.desc, 20);
  69         }
  70         putchar('\n');
  71
  72         printf("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
  73 }
  74
  75 static void draw_tile(WINDOW **win, unsigned colour, unsigned selected,
  76                       unsigned x, unsigned y, unsigned start_column)
  77 {
  78         WINDOW *border = win[PLAYWIN_TILEBORDER], *fill = win[PLAYWIN_TILEFILL];
  79         int w, h, attr, ch, bc = selected ? '#' : 0;
  80
  81         assert(colour < TILE_MAX);
  82         attr = COLOR_PAIR(colour);
  83         switch (colour) {
  84         case TILE_RED:    ch = 'X'; break;
  85         case TILE_ORANGE: ch = '|'; break;
  86         case TILE_GREEN:  ch = '+'; break;
  87         case TILE_YELLOW: ch = '~'; attr |= A_BOLD; break;
  88         case TILE_BLUE:   ch = 'o'; attr |= A_BOLD; break;
  89         case TILE_WHITE:  ch = '.'; attr |= A_BOLD; break;
  90
  91         case TILE_EMPTY: attr = A_BOLD|COLOR_PAIR(RR_COLOUR_SHADOW);
  92         }
  93
  94         getmaxyx(border, h, w);
  95         w = 2*(w+1)/2;
  96
  97         if (mvwin(border, 1+GAME_YPOS+h*y, start_column+w*x) == ERR)
  98                 return;
  99
 100         if (colour != TILE_EMPTY) {
 101                 mvderwin(fill, 1, 1);
 102                 wbkgdset(fill, A_REVERSE|attr|ch);
 103                 werase(fill);
 104         } else {
 105                 werase(border);
 106         }
 107
 108         if (bc || colour) {
 109                 wattrset(border, attr);
 110                 wborder(border, bc, bc, bc, bc, bc, bc, bc, bc);
 111         }
 112
 113         wnoutrefresh(border);
 114 }
 115
 116 static int
 117 redraw_tile(WINDOW **win, unsigned x, unsigned y, unsigned start_column,
 118             uint_least32_t *gp, unsigned selected)
 119 {
 120         unsigned tile = board_tile(gp, 5*y+x);
 121
 122         assert(tile < TILE_MAX);
 123         draw_tile(win, tile, selected, x, y, start_column);
 124         return tile;
 125 }
 126
 127 static void redraw_area_border(WINDOW **win, unsigned x, unsigned sz)
 128 {
 129         int w, h, tr = 0, rs = 0, br = 0, bs = 0, bl = 0;
 130         WINDOW *area = win[PLAYWIN_AREA];
 131
 132         getmaxyx(stdscr, h, w);
 133
 134         if (h <= GAME_YPOS+1) {
 135                 bl = ACS_ULCORNER, br = ACS_URCORNER;
 136         } else if (h <= 3*sz+GAME_YPOS+1) {
 137                 bl = br = ACS_VLINE, bs = ' ';
 138         }
 139
 140         if (w <= x+1) {
 141                 tr = ACS_ULCORNER, br = ACS_LLCORNER;
 142         } else if (w <= 6*sz+x+2) {
 143                 tr = ACS_HLINE, rs = ' ';
 144                 br = br ? ' ' : ACS_HLINE;
 145         }
 146
 147         wborder(area, 0, rs, 0, bs, 0, tr, bl, br);
 148         wnoutrefresh(area);
 149 }
 150
 151 static void curs_redraw_game(struct app_state *state, uint_fast32_t mask)
 152 {
 153         uint_least32_t buf[3], *gp = state->board.game;
 154         int i;
 155
 156         if (mask == -1)
 157                 redraw_area_border(state->gamewin, 2, 5);
 158
 159         if (state->view_goal_on_game)
 160                 gp = game_overlay_goal(&state->board, buf);
 161
 162         for (i = 0; i < 25; i++) {
 163                 if (mask & 1) {
 164                         redraw_tile(state->gamewin, i%5, i/5,
 165                                     4, gp, i == state->cursor);
 166                 }
 167                 mask >>= 1;
 168         }
 169 }
 170
 171 static void curs_redraw_goal(struct app_state *state, uint_fast32_t mask)
 172 {
 173         uint_least32_t gp[3] = {
 174                 state->board.goal[0],
 175                 state->board.goal[1],
 176                 state->board.goal[2]
 177         };
 178         int i, x, y;
 179
 180         if (!state->goalwin[PLAYWIN_AREA])
 181                 return;
 182
 183         getbegyx(state->goalwin[PLAYWIN_AREA], y, x);
 184         if (mask == -1)
 185                 redraw_area_border(state->goalwin, x, 3);
 186
 187         for (i = 0; i < 9; i++) {
 188                 if (mask & 1) {
 189                         redraw_tile(state->goalwin, i%3, i/3, x+2, gp, 0);
 190                 }
 191                 mask >>= 1;
 192         }
 193 }
 194
 195 /* Thin wrapper around wresize which returns ERR if support is unavailable. */
 196 static int do_wresize(WINDOW *window, int h, int w)
 197 {
 198 #if HAVE_CURSES_WRESIZE
 199         return wresize(window, h, w);
 200 #endif
 201         return ERR;
 202 }
 203
 204 static WINDOW *realloc_area(WINDOW **orig, int h, int w, int y, int x)
 205 {
 206         WINDOW *win = *orig;
 207
 208         if (win) {
 209                 if (do_wresize(win, h, w) != ERR) {
 210                         mvwin(win, y, x);
 211                         return win;
 212                 }
 213
 214                 delwin(win);
 215         }
 216
 217         if (w > 0 && h > 0)
 218                 return *orig = subwin(stdscr, h, w, y, x);
 219         return *orig = NULL;
 220 }
 221
 222 static void realloc_tiles(WINDOW **win, int h)
 223 {
 224         WINDOW *border = win[PLAYWIN_TILEBORDER], *fill = win[PLAYWIN_TILEFILL];
 225         int w = 2*h - 1;
 226
 227         if (fill && border) {
 228                 int old_w, old_h;
 229
 230                 if (do_wresize(fill, h-2, w-2) != ERR
 231                     && do_wresize(border, h, w) != ERR)
 232                         return;
 233
 234                 getmaxyx(border, old_h, old_w);
 235                 if (old_h == h)
 236                         return;
 237         }
 238
 239         if (fill)
 240                 delwin(fill);
 241         if (border)
 242                 delwin(border);
 243
 244         win[PLAYWIN_TILEBORDER] = border = newwin(h, w, 0, 0);
 245         win[PLAYWIN_TILEFILL] = derwin(border, h-2, w-2, 1, 1);
 246 }
 247
 248 static void setup_mainwin(struct app_state *state)
 249 {
 250         int w, h, gamesz, goalsz, scr_w, scr_h, split;
 251
 252         getmaxyx(stdscr, scr_h, scr_w);
 253
 254         /* First try to fit the game tiles based on window height. */
 255         gamesz = MAX(3, (scr_h - 4) / 5);
 256
 257         /* Adjust downward until we can fit smallest possible goal area. */
 258         for (; split = 5+10*gamesz, gamesz > 3; gamesz--) {
 259                 if (split + 20 < scr_w)
 260                         break;
 261         }
 262
 263         /* Pick a goal size that will fit in the remaining area */
 264         goalsz = MAX(3, (scr_w - split - 4) / 6);
 265         if (goalsz >= gamesz)
 266                 goalsz = MAX(3, gamesz - 1);
 267
 268         realloc_tiles(state->gamewin, gamesz);
 269         realloc_tiles(state->goalwin, goalsz);
 270
 271         /* Frame for game area */
 272         w = MIN(scr_w-2, 3+10*gamesz);
 273         h = MIN(scr_h-GAME_YPOS, 2+5*gamesz);
 274         realloc_area(&state->gamewin[PLAYWIN_AREA], h, w, GAME_YPOS, 2);
 275
 276         /* Frame for goal area */
 277         w = MIN(scr_w-split, 3+6*goalsz);
 278         h = MIN(scr_h-GAME_YPOS, 2+3*goalsz);
 279         realloc_area(&state->goalwin[PLAYWIN_AREA], h, w, GAME_YPOS, split);
 280
 281         /* Status area */
 282         w = MAX(0, scr_w-split-1);
 283         realloc_area(&state->timer, 1, w, GAME_YPOS+h, split+1);
 284
 285         /* Toolbar */
 286         realloc_area(&state->toolbar, 1, scr_w, scr_h-1, 0);
 287         curs_draw_toolbar(state);
 288 }
 289
 290 static void app_initialize(int argc, char **argv)
 291 {
 292         int enable_mouse = 1;
 293         int opt;
 294
 295         if (argc > 0)
 296                 progname = argv[0];
 297
 298         while ((opt = getopt_long(argc, argv, SOPT_STRING, lopts, 0)) != -1) {
 299                 switch (opt) {
 300                 case LOPT_MOUSE:
 301                         enable_mouse = 2;
 302                         break;
 303                 case LOPT_NO_MOUSE:
 304                         enable_mouse = 0;
 305                         break;
 306                 case LOPT_VERSION:
 307                         print_version();
 308                         exit(EXIT_SUCCESS);
 309                 case LOPT_HELP:
 310                         print_help();
 311                         exit(EXIT_SUCCESS);
 312                 default:
 313                         print_usage(stderr);
 314                         exit(EXIT_FAILURE);
 315                 }
 316         }
 317
 318         game_reset(&state.board);
 319         state.cursor = -1;
 320
 321         initscr();
 322         start_color();
 323         curs_set(0);
 324
 325         cbreak();
 326         keypad(stdscr, TRUE);
 327         if (enable_mouse) {
 328                 /*
 329                  * While we only care about a subset of these events, for
 330                  * some reason with ncurses failing to enable all of them
 331                  * causes timeout to stop working when disabled buttons are
 332                  * pressed (or released).
 333                  *
 334                  * It is not known if other curses have this problem; at least
 335                  * pdcurses does not, but the extra events should be harmless
 336                  * in any case.
 337                  */
 338 #if HAVE_CURSES_MOUSE_SUPPORT
 339                 unsigned long mask = BUTTON1_PRESSED | BUTTON1_RELEASED
 340                                    | BUTTON2_PRESSED | BUTTON2_RELEASED
 341                                    | BUTTON3_PRESSED | BUTTON3_RELEASED
 342 #ifdef BUTTON4_PRESSED
 343                                    | BUTTON4_PRESSED | BUTTON4_RELEASED
 344 #endif
 345 #ifdef BUTTON5_PRESSED
 346                                    | BUTTON5_PRESSED | BUTTON5_RELEASED
 347 #endif
 348                                    ;
 349 #if HAVE_CURSES_MOUSE_SET
 350                 mouse_set(mask);
 351 #elif HAVE_CURSES_MOUSEMASK
 352                 mousemask(mask, NULL);
 353 #endif
 354 #if HAVE_CURSES_MOUSEINTERVAL
 355                 mouseinterval(0);
 356 #endif
 357 #endif /* HAVE_CURSES_MOUSE_SUPPORT */
 358         }
 359
 360         noecho();
 361
 362         init_pair(TILE_RED, COLOR_RED, COLOR_BLACK);
 363         init_pair(TILE_ORANGE, COLOR_YELLOW, COLOR_BLACK);
 364         init_pair(TILE_YELLOW, COLOR_YELLOW, COLOR_BLACK);
 365         init_pair(TILE_GREEN, COLOR_GREEN, COLOR_BLACK);
 366         init_pair(TILE_BLUE, COLOR_BLUE, COLOR_BLACK);
 367         init_pair(TILE_WHITE, COLOR_WHITE, COLOR_BLACK);
 368         init_pair(RR_COLOUR_SHADOW, COLOR_BLACK, COLOR_BLACK);
 369         init_pair(RR_COLOUR_TOOLBAR, COLOR_CYAN, COLOR_BLACK);
 370
 371         setup_mainwin(&state);
 372         refresh();
 373 }
 374
 375 static void update_timer(struct app_state *state, uint_fast32_t ms)
 376 {
 377         unsigned sec, min;
 378
 379         state->timer_ms = ms;
 380         sec = ms / 1000; ms %= 1000;
 381         min = sec / 60; sec %= 60;
 382         mvwprintw(state->timer, 0, 0, "Time: %u:%.2u.%.3u",
 383                   min, sec, (unsigned)ms);
 384         wclrtoeol(state->timer);
 385         wnoutrefresh(state->timer);
 386 }
 387
 388 static uint_fast32_t do_move(struct app_state *state, int x, int y)
 389 {
 390         uint_fast32_t mask;
 391
 392         if ((mask = game_do_move(&state->board, x, y)) != 0) {
 393                 uint_fast32_t goal = game_check_goal(&state->board);
 394
 395                 if (state->view_goal_on_game) {
 396                         state->view_goal_on_game = 0;
 397                         mask |= goal;
 398                 }
 399
 400                 if (goal == 0) {
 401                         /* Solved! */
 402                         update_timer(state, game_finish(&state->board));
 403                         mask |= ~GOAL_MASK;
 404                         state->cursor = -1;
 405                         timeout(-1);
 406                 }
 407
 408                 curs_redraw_game(state, mask);
 409                 doupdate();
 410         }
 411
 412         return mask;
 413 }
 414
 415 static void do_reset_cursor(struct app_state *state)
 416 {
 417         state->cursor = 5*state->board.y + state->board.x;
 418 }
 419
 420 void curs_new_game(struct app_state *state)
 421 {
 422         game_reset(&state->board);
 423
 424         do_reset_cursor(state);
 425         state->view_goal_on_game = 0;
 426         curs_redraw_game(state, -1);
 427         curs_redraw_goal(state, -1);
 428         update_timer(state, 0);
 429         doupdate();
 430
 431         timeout(33);
 432         game_begin(&state->board);
 433 }
 434
 435 #if HAVE_CURSES_MOUSE_SUPPORT
 436 /*
 437  * Given x, y as screen coordinates, record which (if any) toolbar function
 438  * label is at that position, to be performed later.
 439  *
 440  * If no function is indicated, returns zero.  Otherwise, returns non-zero.
 441  */
 442 static int press_toolbar(struct app_state *state, int x, int y)
 443 {
 444         return state->toolbar_click = curs_toolbar_mouse_func(state, x, y);
 445 }
 446
 447 /*
 448  * Given x, y as screen coordinates, perform the toolbar action.
 449  *
 450  * Perform the action previously recorded by press_toolbar, if and only if
 451  * the x, y screen coordinates correspond to the same function.
 452  */
 453 static void release_toolbar(struct app_state *state, int x, int y)
 454 {
 455         int func = curs_toolbar_mouse_func(state, x, y);
 456
 457         if (func && state->toolbar_click == func) {
 458                 curs_execute_function(state, func);
 459         }
 460
 461         state->toolbar_click = 0;
 462 }
 463
 464 /*
 465  * Given x, y as screen coordinates, determine which (if any) game tile is
 466  * at that position.
 467  *
 468  * If there is no such tile, performs no action and returns 0.
 469  *
 470  * Otherwise, attempts to move that tile and returns non-zero.
 471  */
 472 static int press_tile(struct app_state *state, int x, int y)
 473 {
 474         int game_x, game_y, tile_w, tile_h;
 475         uint_fast32_t cursor_mask, move_mask;
 476
 477         getbegyx(state->gamewin[PLAYWIN_AREA], game_y, game_x);
 478         getmaxyx(state->gamewin[PLAYWIN_TILEBORDER], tile_h, tile_w);
 479         tile_w += tile_w & 1;
 480
 481         /* special case the left spacer column */
 482         if (x == game_x+1)
 483                 x++;
 484
 485         if (x < game_x+2 || (x -= game_x+2)/5 >= tile_w)
 486                 return 0;
 487         if (y < game_y+1 || (y -= game_y+1)/5 >= tile_h)
 488                 return 0;
 489
 490         /* OK, selected a tile. */
 491         x /= tile_w;
 492         y /= tile_h;
 493
 494         /* Disable the keyboard cursor due to mouse action */
 495         cursor_mask = state->cursor < 0 ? -1 : 1ul << state->cursor;
 496         state->cursor = -1;
 497
 498         move_mask = do_move(state, x, y);
 499         if ((cursor_mask & move_mask) == 0) {
 500                 curs_redraw_game(state, cursor_mask);
 501                 doupdate();
 502         }
 503
 504         return 1;
 505 }
 506
 507 static void do_mouse(struct app_state *state)
 508 {
 509         unsigned long bstate;
 510         int x, y;
 511
 512 #if HAVE_CURSES_GETMOUSE_NCURSES
 513         MEVENT mev;
 514
 515         if (getmouse(&mev) == ERR)
 516                 return;
 517
 518         x = mev.x, y = mev.y;
 519         bstate = mev.bstate;
 520 #elif HAVE_CURSES_REQUEST_MOUSE_POS
 521         request_mouse_pos();
 522         x = MOUSE_X_POS;
 523         y = MOUSE_Y_POS;
 524
 525         bstate = 0;
 526
 527 #define set_bstate_helper(button) do { if (BUTTON_CHANGED(button)) \
 528         switch (BUTTON_STATUS(button)) { \
 529         case BUTTON_RELEASED: bstate |= BUTTON ## button ##  _RELEASED; break; \
 530         case BUTTON_PRESSED:  bstate |= BUTTON ## button ##  _PRESSED; break; \
 531         } \
 532 } while (0);
 533
 534         set_bstate_helper(1);
 535         set_bstate_helper(3);
 536 #endif
 537         if (bstate & BUTTON3_PRESSED) {
 538                 state->view_goal_on_game = 1;
 539                 curs_redraw_game(state, game_check_goal(&state->board));
 540                 doupdate();
 541         }
 542
 543         if (bstate & BUTTON3_RELEASED) {
 544                 state->view_goal_on_game = 0;
 545                 curs_redraw_game(state, game_check_goal(&state->board));
 546                 doupdate();
 547         }
 548
 549         /* Ignore button1 if holding button3 to view goal */
 550         if (state->view_goal_on_game & 1)
 551                 return;
 552
 553         if (bstate & BUTTON1_PRESSED) {
 554                 if (press_toolbar(state, x, y));
 555                 else if (press_tile(state, x, y));
 556         }
 557
 558         if (bstate & BUTTON1_RELEASED) {
 559                 release_toolbar(state, x, y);
 560         }
 561 }
 562 #endif /* HAVE_CURSES_MOUSE_SUPPORT */
 563
 564 static void do_move_cursor(struct app_state *state, int c)
 565 {
 566         uint_fast32_t mask = 0;
 567
 568         if (state->cursor < 0) {
 569                 /* Cursor was hidden; reset it */
 570                 do_reset_cursor(state);
 571         } else {
 572                 mask = 1ul << state->cursor;
 573         }
 574
 575         if (state->view_goal_on_game) {
 576                 state->view_goal_on_game = 0;
 577                 mask |= game_check_goal(&state->board);
 578         }
 579
 580         switch (c) {
 581         case KEY_UP:
 582                 if ((state->cursor -= 5) < 0)
 583                         state->cursor += 25;
 584                 break;
 585         case KEY_DOWN:
 586                 if ((state->cursor += 5) >= 25)
 587                         state->cursor -= 25;
 588                 break;
 589         case KEY_LEFT:
 590                 if ((state->cursor -= 1) % 5 == 4 || state->cursor < 0)
 591                         state->cursor += 5;
 592                 break;
 593         case KEY_RIGHT:
 594                 if ((state->cursor += 1) % 5 == 0)
 595                         state->cursor -= 5;
 596                 break;
 597         }
 598
 599         curs_redraw_game(state, mask | 1ul << state->cursor);
 600         doupdate();
 601 }
 602
 603 static void do_keystroke(struct app_state *state, int c)
 604 {
 605         int last_input = state->last_input;
 606         state->last_input = c;
 607
 608         switch (c) {
 609         case KEY_DOWN: case KEY_UP: case KEY_LEFT: case KEY_RIGHT:
 610                 do_move_cursor(state, c);
 611                 break;
 612         case '\t':
 613                 state->view_goal_on_game ^= 2u;
 614                 curs_redraw_game(state, game_check_goal(&state->board));
 615                 doupdate();
 616                 break;
 617         case ' ':
 618                 if (!(state->view_goal_on_game & 1) && state->cursor >= 0)
 619                         do_move(state, state->cursor%5, state->cursor/5);
 620                 break;
 621         }
 622
 623         /* ESC+# keys */
 624         if (last_input == '\33' && c >= '0' && c <= '9') {
 625                 curs_execute_function(state, (c -= '0') == 0 ? 10 : c);
 626         }
 627
 628         /* F# keys */
 629         if (c >= KEY_F(1) && c <= KEY_F(10)) {
 630                 curs_execute_function(state, c - KEY_F0);
 631         }
 632 }
 633
 634 /* One iteration of main input loop */
 635 void do_mainloop(struct app_state *state)
 636 {
 637         int c = getch();
 638
 639         switch (c) {
 640 #ifdef KEY_RESIZE
 641         case KEY_RESIZE:
 642                 setup_mainwin(state);
 643                 clear();
 644                 refresh();
 645                 curs_redraw_game(state, -1);
 646                 curs_redraw_goal(state, -1);
 647                 curs_draw_toolbar(state);
 648                 update_timer(state, state->timer_ms);
 649                 doupdate();
 650                 break;
 651 #endif
 652 #if HAVE_CURSES_MOUSE_SUPPORT
 653         case KEY_MOUSE:
 654                 do_mouse(state);
 655                 break;
 656 #endif
 657         default:
 658                 do_keystroke(state, c);
 659         case ERR:;
 660         }
 661
 662         if (state->board.x <= 4) {
 663                 update_timer(state, game_elapsed(&state->board));
 664                 doupdate();
 665         }
 666 }
 667
 668 int main(int argc, char **argv)
 669 {
 670         setlocale(LC_ALL, "");
 671         app_initialize(argc, argv);
 672
 673         curs_new_game(&state);
 674         while (1)
 675                 do_mainloop(&state);
 676         abort();
 677 }