Update upstream source from tag 'upstream/0.35'
[ncmpc-debian.git] / src / hscroll.hxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2019 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 HSCROLL_H
21 #define HSCROLL_H
22
23 #include "BasicMarquee.hxx"
24 #include "AsioServiceFwd.hxx"
25
26 #include <curses.h>
27
28 #include <boost/asio/steady_timer.hpp>
29
30 enum class Style : unsigned;
31
32 /**
33  * This class is used to auto-scroll text which does not fit on the
34  * screen.  Call hscroll_init() to initialize the object,
35  * hscroll_clear() to free resources, and hscroll_set() to begin
36  * scrolling.
37  */
38 class hscroll {
39         WINDOW *const w;
40
41         BasicMarquee basic;
42
43         /**
44          * The postion on the screen.
45          */
46         unsigned x, y;
47
48         /**
49          * Style for drawing the text.
50          */
51         Style style;
52
53         attr_t attr;
54
55         /**
56          * A timer which updates the scrolled area every second.
57          */
58         boost::asio::steady_timer timer;
59
60 public:
61         hscroll(boost::asio::io_service &io_service,
62                 WINDOW *_w, const char *_separator) noexcept
63                 :w(_w), basic(_separator), timer(io_service)
64         {
65         }
66
67         bool IsDefined() const noexcept {
68                 return basic.IsDefined();
69         }
70
71         /**
72          * Sets a text to scroll.  This installs a timer which redraws
73          * every second with the current window attributes.  Call
74          * hscroll_clear() to disable it.
75          */
76         void Set(unsigned x, unsigned y, unsigned width, const char *text,
77                  Style style, attr_t attr=0) noexcept;
78
79         /**
80          * Removes the text and the timer.  It may be reused with
81          * Set().
82          */
83         void Clear() noexcept;
84
85         void Rewind() noexcept {
86                 basic.Rewind();
87         }
88
89         void Step() noexcept {
90                 basic.Step();
91         }
92
93         /**
94          * Explicitly draws the scrolled text.  Calling this function
95          * is only allowed if there is a text currently.
96          */
97         void Paint() const noexcept;
98
99 private:
100         void TimerCallback(const boost::system::error_code &error) noexcept;
101
102         void ScheduleTimer() noexcept {
103                 boost::system::error_code error;
104                 timer.expires_from_now(std::chrono::seconds(1), error);
105                 timer.async_wait(std::bind(&hscroll::TimerCallback, this,
106                                            std::placeholders::_1));
107         }
108 };
109
110 #endif