src/statusbar.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_STATUSBAR_H
  22 #define NCMPCPP_STATUSBAR_H
  23
  24 #include <boost/format.hpp>
  25 #include "settings.h"
  26 #include "gcc.h"
  27 #include "interfaces.h"
  28 #include "window.h"
  29
  30 namespace Progressbar {//
  31
  32 /// locks progressbar (usually used for seeking)
  33 void lock();
  34
  35 /// unlocks progressbar (usually right after seeking is done)
  36 void unlock();
  37
  38 /// @return true if progressbar is unlocked
  39 bool isUnlocked();
  40
  41 /// draws progressbar
  42 void draw(unsigned elapsed, unsigned time);
  43
  44 }
  45
  46 namespace Statusbar{//
  47
  48 /// locks statusbar (usually for prompting the user)
  49 void lock();
  50
  51 /// unlocks statusbar (usually after prompting the user)
  52 void unlock();
  53
  54 /// @return true if statusbar is unlocked
  55 bool isUnlocked();
  56
  57 /// tries to clear current message put there using Statusbar::printf if there is any
  58 void tryRedraw();
  59
  60 /// clears statusbar and move cursor to beginning of line
  61 /// @return window object that represents statusbar
  62 NC::Window &put();
  63
  64 namespace Helpers {//
  65
  66 /// called when statusbar window detects incoming idle notification
  67 void mpd();
  68
  69 /// called each time user types another character while inside Window::getString
  70 bool getString(const char *);
  71
  72 /// called each time user changes current filter (while being inside Window::getString)
  73 struct ApplyFilterImmediately
  74 {
  75         template <typename StringT>
  76         ApplyFilterImmediately(Filterable *f, StringT &&filter)
  77         : m_f(f), m_s(std::forward<StringT>(filter)) { }
  78
  79         bool operator()(const char *s);
  80
  81 private:
  82         Filterable *m_f;
  83         std::string m_s;
  84 };
  85
  86 struct TryExecuteImmediateCommand
  87 {
  88         bool operator()(const char *s);
  89
  90 private:
  91         std::string m_s;
  92 };
  93
  94 }
  95
  96 /// displays message in statusbar for a given period of time
  97 void print(int delay, const std::string& message);
  98
  99 /// displays message in statusbar for period of time set in configuration file
 100 inline void print(const std::string &message)
 101 {
 102         print(Config.message_delay_time, message);
 103 }
 104
 105 /// displays formatted message in statusbar for period of time set in configuration file
 106 template <typename FormatT>
 107 void printf(FormatT &&fmt)
 108 {
 109         print(Config.message_delay_time, boost::format(std::forward<FormatT>(fmt)).str());
 110 }
 111 template <typename FormatT, typename ArgT, typename... Args>
 112 void printf(FormatT &&fmt, ArgT &&arg, Args&&... args)
 113 {
 114         printf(boost::format(std::forward<FormatT>(fmt)) % std::forward<ArgT>(arg),
 115                 std::forward<Args>(args)...
 116         );
 117 }
 118
 119 /// displays formatted message in statusbar for a given period of time
 120 template <typename FormatT>
 121 void printf(int delay, FormatT &&fmt)
 122 {
 123         print(delay, boost::format(std::forward<FormatT>(fmt)).str());
 124 }
 125 template <typename FormatT, typename ArgT, typename... Args>
 126 void printf(int delay, FormatT &&fmt, ArgT &&arg, Args&&... args)
 127 {
 128         printf(delay, boost::format(std::forward<FormatT>(fmt)) % std::forward<ArgT>(arg),
 129                 std::forward<Args>(args)...
 130         );
 131 }
 132
 133 }
 134
 135 #endif // NCMPCPP_STATUSBAR_H