src/Page.hxx

   1 /* ncmpc (Ncurses MPD Client)
   2  * (c) 2004-2018 The Music Player Daemon Project
   3  * Project homepage: http://musicpd.org
   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 2 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 along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef NCMPC_PAGE_HXX
  21 #define NCMPC_PAGE_HXX
  22
  23 #include "config.h"
  24 #include "Point.hxx"
  25 #include "Size.hxx"
  26 #include "util/Compiler.h"
  27
  28 #include <curses.h>
  29
  30 #include <utility>
  31
  32 #include <stddef.h>
  33
  34 enum class Command : unsigned;
  35 struct mpdclient;
  36
  37 class Page {
  38         Size last_size{0, 0};
  39
  40         /**
  41          * The MPD idle event mask pending to be submitted to
  42          * Update().
  43          */
  44         unsigned pending_events = ~0u;
  45
  46         /**
  47          * Does this page need to be repainted?
  48          */
  49         bool dirty = true;
  50
  51 public:
  52         virtual ~Page() noexcept = default;
  53
  54         bool IsDirty() const noexcept {
  55                 return dirty;
  56         }
  57
  58         void SetDirty(bool _dirty=true) noexcept {
  59                 dirty = _dirty;
  60         }
  61
  62         void Resize(Size new_size) noexcept {
  63                 if (new_size == last_size)
  64                         return;
  65
  66                 last_size = new_size;
  67                 OnResize(new_size);
  68         }
  69
  70         void AddPendingEvents(unsigned events) noexcept {
  71                 pending_events |= events;
  72         }
  73
  74         void Update(struct mpdclient &c) noexcept {
  75                 Update(c, std::exchange(pending_events, 0));
  76         }
  77
  78 protected:
  79         const Size &GetLastSize() const noexcept {
  80                 return last_size;
  81         }
  82
  83 public:
  84         virtual void OnOpen(struct mpdclient &) noexcept {}
  85         virtual void OnClose() noexcept {}
  86         virtual void OnResize(Size size) noexcept = 0;
  87         virtual void Paint() const noexcept = 0;
  88         virtual void Update(struct mpdclient &, unsigned) noexcept {}
  89
  90         /**
  91          * Handle a command.
  92          *
  93          * @returns true if the command should not be handled by the
  94          * ncmpc core
  95          */
  96         virtual bool OnCommand(struct mpdclient &c, Command cmd) = 0;
  97
  98 #ifdef HAVE_GETMOUSE
  99         /**
 100          * Handle a mouse event.
 101          *
 102          * @return true if the event was handled (and should not be
 103          * handled by the ncmpc core)
 104          */
 105         virtual bool OnMouse(gcc_unused struct mpdclient &c,
 106                              gcc_unused Point position,
 107                              gcc_unused mmask_t bstate) {
 108                 return false;
 109         }
 110 #endif
 111
 112         gcc_pure
 113         virtual const char *GetTitle(char *s, size_t size) const noexcept = 0;
 114 };
 115
 116 #endif