src/motif.h

   1 /*
   2  * X11 GUI for slide puzzle game
   3  * Copyright © 2022 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 #ifndef RRACE_MOTIF_H_
  20 #define RRACE_MOTIF_H_
  21
  22 #include <inttypes.h>
  23 #include "colour.h"
  24 #include "game.h"
  25
  26 struct app_state {
  27         struct board board;
  28
  29         Widget game, goal;
  30
  31         struct xcounter *timer;
  32
  33         /* Current window width/height for resize handling. */
  34         Dimension game_sz[2], goal_sz[2];
  35
  36         XtIntervalId timer_tick;
  37
  38         XtIntervalId render_tick;
  39         XtWorkProcId render_proc;
  40
  41         uint_least32_t render_game_mask;
  42         uint_least16_t render_goal_mask;
  43         uint_least16_t game_tile_sz, goal_tile_sz;
  44
  45         /* If true, the goal will be displayed over the main play area. */
  46         int view_goal_on_game;
  47
  48         /* Whether to set _NET_WM_ICON property on WMShell */
  49         int use_ewmh_icons;
  50
  51         GC tile_gc;
  52         Pixmap icon_pixmap;
  53         uint_least32_t tile_colour[TILE_MAX-1][3];
  54 };
  55
  56 void ui_initialize(struct app_state *state, Widget shell);
  57 void ui_show_about(struct app_state *state, Widget shell);
  58 void ui_timer_update(struct app_state *state, int_fast32_t elapsed);
  59
  60 void x11_initialize(struct app_state *state, Widget shell);
  61 void x11_redraw_icon(struct app_state *state, Widget shell);
  62 void x11_redraw_game(struct app_state *state, uint_fast32_t mask);
  63
  64 /*
  65  * Redraw goal tiles immediately.  The mask specifies which tiles will
  66  * be redrawn, in the same bit arrangement as the board goal bitmaps.
  67  * Tiles corresponding to set bits in mask are redrawn, and tiles
  68  * corresponding to clear bits are not redrawn.
  69  *
  70  * Additionally, if icon_shell is non-null (with the caller passing the
  71  * application shell widget), the program's icon pixmap is updated to
  72  * match the current goal.
  73  */
  74 void x11_redraw_goal(struct app_state *state, uint_fast32_t mask,
  75                                               Widget icon_shell);
  76
  77 /*
  78  * Mark tiles for redraw.  The redraw is not performed immediately, but
  79  * rather a background task is installed to perform the redraw at a later
  80  * time.
  81  *
  82  * The mode parameter may be one of the following enumerated values:
  83  *
  84  *   * RENDER_MODE_GAME: mark game tiles for update.
  85  *   * RENDER_MODE_GOAL: mark goal tiles for update.
  86  *   * RENDER_MODE_BOTH: mark both game and goal tiles for update (probably
  87  *                       only useful if mask has all bits set).
  88  */
  89 void x11_queue_render(struct app_state *state, uint_fast32_t mask, int mode);
  90
  91 enum {
  92         RENDER_MODE_GOAL = 1,
  93         RENDER_MODE_GAME = 2,
  94         RENDER_MODE_BOTH = 3
  95 };
  96
  97 #endif