src/screen.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008-2014 by Andrzej Rybczak                            *
   3  *   electricityispower@gmail.com                                          *
   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     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.              *
  19  ***************************************************************************/
  20
  21 #ifndef NCMPCPP_SCREEN_H
  22 #define NCMPCPP_SCREEN_H
  23
  24 #include "menu.h"
  25 #include "scrollpad.h"
  26 #include "screen_type.h"
  27
  28 void drawSeparator(int x);
  29 void genericMouseButtonPressed(NC::Window &w, MEVENT me);
  30 void scrollpadMouseButtonPressed(NC::Scrollpad &w, MEVENT me);
  31
  32 /// An interface for various instantiations of Screen template class. Since C++ doesn't like
  33 /// comparison of two different instantiations of the same template class we need the most
  34 /// basic class to be non-template to allow it.
  35 struct BaseScreen
  36 {
  37         BaseScreen() : hasToBeResized(false) { }
  38         virtual ~BaseScreen() { }
  39
  40         /// @see Screen::isActiveWindow()
  41         virtual bool isActiveWindow(const NC::Window &w_) = 0;
  42
  43         /// @see Screen::activeWindow()
  44         virtual void *activeWindow() = 0;
  45
  46         /// @see Screen::refresh()
  47         virtual void refresh() = 0;
  48
  49         /// @see Screen::refreshWindow()
  50         virtual void refreshWindow() = 0;
  51
  52         /// @see Screen::scroll()
  53         virtual void scroll(NC::Scroll where) = 0;
  54
  55         /// Method used for switching to screen
  56         virtual void switchTo() = 0;
  57
  58         /// Method that should resize screen
  59         /// if requested by hasToBeResized
  60         virtual void resize() = 0;
  61
  62         /// @return ncurses timeout parameter for the screen
  63         virtual int windowTimeout() = 0;
  64
  65         /// @return title of the screen
  66         virtual std::wstring title() = 0;
  67
  68         /// @return type of the screen
  69         virtual ScreenType type() = 0;
  70
  71         /// If the screen contantly has to update itself
  72         /// somehow, it should be called by this function.
  73         virtual void update() = 0;
  74
  75         /// Invoked after Enter was pressed
  76         virtual void enterPressed() = 0;
  77
  78         /// Invoked after Space was pressed
  79         virtual void spacePressed() = 0;
  80
  81         /// @see Screen::mouseButtonPressed()
  82         virtual void mouseButtonPressed(MEVENT me) = 0;
  83
  84         /// @return true if screen is mergable, ie. can be "proper" subwindow
  85         /// if one of the screens is locked. Screens that somehow resemble popups
  86         /// will want to return false here.
  87         virtual bool isMergable() = 0;
  88
  89         /// Locks current screen.
  90         /// @return true if lock was successful, false otherwise. Note that
  91         /// if there is already locked screen, it'll not overwrite it.
  92         bool lock();
  93
  94         /// Should be set to true each time screen needs resize
  95         bool hasToBeResized;
  96
  97         /// Unlocks a screen, ie. hides merged window (if there is one set).
  98         static void unlock();
  99
 100 protected:
 101         /// @return true if screen can be locked. Note that returning
 102         /// false here doesn't neccesarily mean that screen is also not
 103         /// mergable (eg. lyrics screen is not lockable since that wouldn't
 104         /// make much sense, but it's perfectly fine to merge it).
 105         virtual bool isLockable() = 0;
 106
 107         /// Gets X offset and width of current screen to be used eg. in resize() function.
 108         /// @param adjust_locked_screen indicates whether this function should
 109         /// automatically adjust locked screen's dimensions (if there is one set)
 110         /// if current screen is going to be subwindow.
 111         void getWindowResizeParams(size_t &x_offset, size_t &width, bool adjust_locked_screen = true);
 112 };
 113
 114 void applyToVisibleWindows(std::function<void(BaseScreen *)> f);
 115 void updateInactiveScreen(BaseScreen *screen_to_be_set);
 116 bool isVisible(BaseScreen *screen);
 117
 118 /// Class that all screens should derive from. It provides basic interface
 119 /// for the screen to be working properly and assumes that we didn't forget
 120 /// about anything vital.
 121 ///
 122 template <typename WindowT> struct Screen : public BaseScreen
 123 {
 124         typedef WindowT WindowType;
 125         typedef typename std::add_lvalue_reference<WindowType>::type WindowReference;
 126
 127 private:
 128         template <bool IsPointer, typename Result> struct getObject { };
 129         template <typename Result> struct getObject<true, Result> {
 130                 static Result apply(WindowType w) { return *w; }
 131         };
 132         template <typename Result> struct getObject<false, Result> {
 133                 static Result apply(WindowReference w) { return w; }
 134         };
 135
 136         typedef getObject<
 137                 std::is_pointer<WindowT>::value,
 138                 typename std::add_lvalue_reference<
 139                         typename std::remove_pointer<WindowT>::type
 140                 >::type
 141         > Accessor;
 142
 143 public:
 144         Screen() { }
 145         Screen(WindowT w_) : w(w_) { }
 146
 147         virtual ~Screen() { }
 148
 149         virtual bool isActiveWindow(const NC::Window &w_) OVERRIDE {
 150                 return &Accessor::apply(w) == &w_;
 151         }
 152
 153         /// Since some screens contain more that one window
 154         /// it's useful to determine the one that is being
 155         /// active
 156         /// @return address to window object cast to void *
 157         virtual void *activeWindow() OVERRIDE {
 158                 return &Accessor::apply(w);
 159         }
 160
 161         /// Refreshes whole screen
 162         virtual void refresh() OVERRIDE {
 163                 Accessor::apply(w).display();
 164         }
 165
 166         /// Refreshes active window of the screen
 167         virtual void refreshWindow() OVERRIDE {
 168                 Accessor::apply(w).display();
 169         }
 170
 171         /// Scrolls the screen by given amount of lines and
 172         /// if fancy scrolling feature is disabled, enters the
 173         /// loop that holds main loop until user releases the key
 174         /// @param where indicates where one wants to scroll
 175         virtual void scroll(NC::Scroll where) OVERRIDE {
 176                 Accessor::apply(w).scroll(where);
 177         }
 178
 179         /// @return timeout parameter used for the screen (in ms)
 180         /// @default 500
 181         virtual int windowTimeout() OVERRIDE {
 182                 return 500;
 183         }
 184
 185         /// Invoked after there was one of mouse buttons pressed
 186         /// @param me struct that contains coords of where the click
 187         /// had its place and button actions
 188         virtual void mouseButtonPressed(MEVENT me) OVERRIDE {
 189                 genericMouseButtonPressed(Accessor::apply(w), me);
 190         }
 191
 192         /// @return currently active window
 193         WindowReference main() {
 194                 return w;
 195         }
 196
 197 protected:
 198         /// Template parameter that should indicate the main type
 199         /// of window used by the screen. What is more, it should
 200         /// always be assigned to the currently active window (if
 201         /// acreen contains more that one)
 202         WindowT w;
 203 };
 204
 205 /// Specialization for Screen<Scrollpad>::mouseButtonPressed that should
 206 /// not scroll whole page, but rather a few lines (the number of them is
 207 /// defined in the config)
 208 template <> inline void Screen<NC::Scrollpad>::mouseButtonPressed(MEVENT me) {
 209         scrollpadMouseButtonPressed(w, me);
 210 }
 211
 212 #endif // NCMPCPP_SCREEN_H
 213