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