Files
ncmpcpp/src/menu.h
2012-09-04 23:05:58 +02:00

799 lines
25 KiB
C++

/***************************************************************************
* Copyright (C) 2008-2012 by Andrzej Rybczak *
* electricityispower@gmail.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef _MENU_H
#define _MENU_H
#include <cassert>
#include <functional>
#include <iterator>
#include <set>
#include "error.h"
#include "regexes.h"
#include "strbuffer.h"
#include "window.h"
namespace NC {
/// This template class is generic menu capable of
/// holding any std::vector compatible values.
template <typename T> struct Menu : public Window
{
struct Item
{
friend struct Menu<T>;
Item()
: m_is_bold(false), m_is_selected(false), m_is_inactive(false), m_is_separator(false) { }
Item(const T &value_, bool is_bold, bool is_inactive)
: m_value(value_), m_is_bold(is_bold), m_is_selected(false), m_is_inactive(is_inactive), m_is_separator(false) { }
T &value() { return m_value; }
const T &value() const { return m_value; }
void setBold(bool is_bold) { m_is_bold = is_bold; }
void setSelected(bool is_selected) { m_is_selected = is_selected; }
void setInactive(bool is_inactive) { m_is_inactive = is_inactive; }
void setSeparator(bool is_separator) { m_is_separator = is_separator; }
bool isBold() const { return m_is_bold; }
bool isSelected() const { return m_is_selected; }
bool isInactive() const { return m_is_inactive; }
bool isSeparator() const { return m_is_separator; }
private:
// make those private, they shouldn't be used
Item(const Item &) { assert(false); }
Item &operator=(const Item &) { assert(false); }
static Item *mkSeparator()
{
Item *i = new Item;
i->m_is_separator = true;
return i;
}
T m_value;
bool m_is_bold;
bool m_is_selected;
bool m_is_inactive;
bool m_is_separator;
};
template <typename ValueT, typename BaseIterator> class ItemIterator
: public std::iterator<std::random_access_iterator_tag, ValueT>
{
friend struct Menu<T>;
BaseIterator m_it;
explicit ItemIterator(BaseIterator it) : m_it(it) { }
// base iterator's value_type doesn't change between const and non-const
// version, so we need to strip const off ValueT too for proper template
// version to be instantiated.
static const bool referenceValue = !std::is_same<
typename std::remove_const<ValueT>::type,
typename std::remove_pointer<typename BaseIterator::value_type>::type
>::value;
template <typename Result, bool referenceValue> struct getObject { };
template <typename Result> struct getObject<Result, true> {
static Result &apply(BaseIterator it) { return (*it)->value(); }
};
template <typename Result> struct getObject<Result, false> {
static Result &apply(BaseIterator it) { return **it; }
};
public:
ItemIterator() { }
ValueT &operator*() const { return getObject<ValueT, referenceValue>::apply(m_it); }
ValueT *operator->() const { return &getObject<ValueT, referenceValue>::apply(m_it); }
ItemIterator &operator++() { ++m_it; return *this; }
ItemIterator operator++(int) { return ItemIterator(m_it++); }
ItemIterator &operator--() { --m_it; return *this; }
ItemIterator operator--(int) { return ItemIterator(m_it--); }
ValueT &operator[](ptrdiff_t n) const {
return getObject<ValueT, referenceValue>::apply(m_it + n);
}
ItemIterator &operator+=(ptrdiff_t n) { m_it += n; return *this; }
ItemIterator operator+(ptrdiff_t n) const { return ItemIterator(m_it + n); }
ItemIterator &operator-=(ptrdiff_t n) { m_it -= n; return *this; }
ItemIterator operator-(ptrdiff_t n) const { return ItemIterator(m_it - n); }
ptrdiff_t operator-(const ItemIterator &rhs) const { return m_it - rhs.m_it; }
template <typename Iterator>
bool operator==(const Iterator &rhs) const { return m_it == rhs.m_it; }
template <typename Iterator>
bool operator!=(const Iterator &rhs) const { return m_it != rhs.m_it; }
template <typename Iterator>
bool operator<(const Iterator &rhs) const { return m_it < rhs.m_it; }
template <typename Iterator>
bool operator<=(const Iterator &rhs) const { return m_it <= rhs.m_it; }
template <typename Iterator>
bool operator>(const Iterator &rhs) const { return m_it > rhs.m_it; }
template <typename Iterator>
bool operator>=(const Iterator &rhs) const { return m_it >= rhs.m_it; }
/// non-const to const conversion
template <typename Iterator>
operator ItemIterator<typename std::add_const<ValueT>::type, Iterator>() {
return ItemIterator<typename std::add_const<ValueT>::type, Iterator>(m_it);
}
const BaseIterator &base() const { return m_it; }
};
typedef ItemIterator<
Item, typename std::vector<Item *>::iterator
> Iterator;
typedef ItemIterator<
const Item, typename std::vector<Item *>::const_iterator
> ConstIterator;
typedef std::reverse_iterator<Iterator> ReverseIterator;
typedef std::reverse_iterator<ConstIterator> ConstReverseIterator;
typedef ItemIterator<
T, typename std::vector<Item *>::iterator
> ValueIterator;
typedef ItemIterator<
typename std::add_const<T>::type, typename std::vector<Item *>::const_iterator
> ConstValueIterator;
typedef std::reverse_iterator<ValueIterator> ReverseValueIterator;
typedef std::reverse_iterator<ConstValueIterator> ConstReverseValueIterator;
/// Function helper prototype used to display each option on the screen.
/// If not set by setItemDisplayer(), menu won't display anything.
/// @see setItemDisplayer()
typedef std::function<void(Menu<T> &)> ItemDisplayer;
typedef std::function<bool(const Item &)> FilterFunction;
/// Constructs an empty menu with given parameters
/// @param startx X position of left upper corner of constructed menu
/// @param starty Y position of left upper corner of constructed menu
/// @param width width of constructed menu
/// @param height height of constructed menu
/// @param title title of constructed menu
/// @param color base color of constructed menu
/// @param border border of constructed menu
Menu(size_t startx, size_t starty, size_t width, size_t height,
const std::string &title, Color color, Border border);
/// Destroys the object and frees memory
virtual ~Menu();
/// Sets helper function that is responsible for displaying items
/// @param ptr function pointer that matches the ItemDisplayer prototype
void setItemDisplayer(const ItemDisplayer &f) { m_item_displayer = f; }
/// Reserves the size for internal container (this just calls std::vector::reserve())
/// @param size requested size
void reserve(size_t size);
/// Resizes the list to given size (adequate to std::vector::resize())
/// @param size requested size
void resizeList(size_t size);
/// Adds new option to list
/// @param item object that has to be added
/// @param is_bold defines the initial state of bold attribute
/// @param is_static defines the initial state of static attribute
void addItem(const T &item, bool is_bold = 0, bool is_static = 0);
/// Adds separator to list
void addSeparator();
/// Inserts new option to list at given position
/// @param pos initial position of inserted item
/// @param item object that has to be inserted
/// @param is_bold defines the initial state of bold attribute
/// @param is_static defines the initial state of static attribute
void insertItem(size_t pos, const T &Item, bool is_bold = 0, bool is_static = 0);
/// Inserts separator to list at given position
/// @param pos initial position of inserted separator
void insertSeparator(size_t pos);
/// Deletes item from given position
/// @param pos given position of item to be deleted
void deleteItem(size_t pos);
/// Swaps the content of two items
/// @param one position of first item
/// @param two position of second item
void Swap(size_t one, size_t two);
/// Moves the highlighted position to the given line of window
/// @param y Y position of menu window to be highlighted
/// @return true if the position is reachable, false otherwise
bool Goto(size_t y);
/// Checks whether list contains selected positions
/// @return true if it contains them, false otherwise
bool hasSelected() const;
/// Highlights given position
/// @param pos position to be highlighted
void highlight(size_t pos);
/// @return currently highlighted position
size_t choice() const;
void filter(ConstIterator first, ConstIterator last, const FilterFunction &f);
void applyCurrentFilter(ConstIterator first, ConstIterator last);
bool search(ConstIterator first, ConstIterator last, const FilterFunction &f);
/// Clears filter results
void clearFilterResults();
void clearFilter();
/// Clears search results
void clearSearchResults();
/// Moves current position in the list to the next found one
/// @param wrap if true, this function will go to the first
/// found pos after the last one, otherwise it'll do nothing.
void nextFound(bool wrap);
/// Moves current position in the list to the previous found one
/// @param wrap if true, this function will go to the last
/// found pos after the first one, otherwise it'll do nothing.
void prevFound(bool wrap);
/// @return const reference to currently used filter function
const FilterFunction &getFilter() { return m_filter; }
/// @return true if list is currently filtered, false otherwise
bool isFiltered() { return m_options_ptr == &m_filtered_options; }
/// Turns off filtering
void showAll() { m_options_ptr = &m_options; }
/// Turns on filtering
void showFiltered() { m_options_ptr = &m_filtered_options; }
/// Refreshes the menu window
/// @see Window::Refresh()
virtual void refresh() OVERRIDE;
/// Scrolls by given amount of lines
/// @param where indicated where exactly one wants to go
/// @see Window::Scroll()
virtual void scroll(Where where) OVERRIDE;
/// Cleares all options, used filters etc. It doesn't reset highlighted position though.
/// @see reset()
virtual void clear() OVERRIDE;
/// Sets highlighted position to 0
void reset();
/// Sets prefix, that is put before each selected item to indicate its selection
/// Note that the passed variable is not deleted along with menu object.
/// @param b pointer to buffer that contains the prefix
void setSelectedPrefix(const Buffer &b) { m_selected_prefix = b; }
/// Sets suffix, that is put after each selected item to indicate its selection
/// Note that the passed variable is not deleted along with menu object.
/// @param b pointer to buffer that contains the suffix
void setSelectedSuffix(const Buffer &b) { m_selected_suffix = b; }
/// Sets custom color of highlighted position
/// @param col custom color
void setHighlightColor(Color color) { m_highlight_color = color; }
/// @return state of highlighting
bool isHighlighted() { return m_highlight_enabled; }
/// Turns on/off highlighting
/// @param state state of hihglighting
void setHighlighting(bool state) { m_highlight_enabled = state; }
/// Turns on/off cyclic scrolling
/// @param state state of cyclic scrolling
void cyclicScrolling(bool state) { m_cyclic_scroll_enabled = state; }
/// Turns on/off centered cursor
/// @param state state of centered cursor
void centeredCursor(bool state) { m_autocenter_cursor = state; }
/// Checks if list is empty
/// @return true if list is empty, false otherwise
/// @see reallyEmpty()
bool empty() const { return m_options_ptr->empty(); }
/// Checks if list is really empty since Empty() may not
/// be accurate if filter is set)
/// @return true if list is empty, false otherwise
/// @see Empty()
bool reallyEmpty() const { return m_options.empty(); }
/// @return size of the list
size_t size() const { return m_options_ptr->size(); }
/// @return currently drawn item. The result is defined only within
/// drawing function that is called by Refresh()
/// @see Refresh()
ConstIterator drawn() const { return begin() + m_drawn_position; }
/// @return reference to last item on the list
/// @throw List::InvalidItem if requested item is separator
Menu<T>::Item &back() { return *m_options_ptr->back(); }
/// @return const reference to last item on the list
/// @throw List::InvalidItem if requested item is separator
const Menu<T>::Item &back() const { return *m_options_ptr->back(); }
/// @return reference to curently highlighted object
Menu<T>::Item &current() { return *(*m_options_ptr)[m_highlight]; }
/// @return const reference to curently highlighted object
const Menu<T>::Item &current() const { return *(*m_options_ptr)[m_highlight]; }
/// @param pos requested position
/// @return reference to item at given position
/// @throw std::out_of_range if given position is out of range
Menu<T>::Item &at(size_t pos) { return *m_options_ptr->at(pos); }
/// @param pos requested position
/// @return const reference to item at given position
/// @throw std::out_of_range if given position is out of range
const Menu<T>::Item &at(size_t pos) const { return *m_options_ptr->at(pos); }
/// @param pos requested position
/// @return const reference to item at given position
const Menu<T>::Item &operator[](size_t pos) const { return *(*m_options_ptr)[pos]; }
/// @param pos requested position
/// @return const reference to item at given position
Menu<T>::Item &operator[](size_t pos) { return *(*m_options_ptr)[pos]; }
Iterator currentI() { return Iterator(m_options_ptr->begin() + m_highlight); }
ConstIterator currentI() const { return ConstIterator(m_options_ptr->begin() + m_highlight); }
ValueIterator currentVI() { return ValueIterator(m_options_ptr->begin() + m_highlight); }
ConstValueIterator currentVI() const { return ConstValueIterator(m_options_ptr->begin() + m_highlight); }
Iterator begin() { return Iterator(m_options_ptr->begin()); }
ConstIterator begin() const { return ConstIterator(m_options_ptr->begin()); }
Iterator end() { return Iterator(m_options_ptr->end()); }
ConstIterator end() const { return ConstIterator(m_options_ptr->end()); }
ReverseIterator rbegin() { return ReverseIterator(end()); }
ConstReverseIterator rbegin() const { return ConstReverseIterator(end()); }
ReverseIterator rend() { return ReverseIterator(begin()); }
ConstReverseIterator rend() const { return ConstReverseIterator(begin()); }
ValueIterator beginV() { return ValueIterator(m_options_ptr->begin()); }
ConstValueIterator beginV() const { return ConstValueIterator(m_options_ptr->begin()); }
ValueIterator endV() { return ValueIterator(m_options_ptr->end()); }
ConstValueIterator endV() const { return ConstValueIterator(m_options_ptr->end()); }
ReverseValueIterator rbeginV() { return ReverseValueIterator(endV()); }
ConstReverseIterator rbeginV() const { return ConstReverseValueIterator(endV()); }
ReverseValueIterator rendV() { return ReverseValueIterator(beginV()); }
ConstReverseValueIterator rendV() const { return ConstReverseValueIterator(beginV()); }
private:
bool isHighlightable(size_t pos)
{
return !(*m_options_ptr)[pos]->isSeparator() && !(*m_options_ptr)[pos]->isInactive();
}
ItemDisplayer m_item_displayer;
FilterFunction m_filter;
FilterFunction m_searcher;
std::vector<Item *> *m_options_ptr;
std::vector<Item *> m_options;
std::vector<Item *> m_filtered_options;
std::set<size_t> m_found_positions;
size_t m_beginning;
size_t m_highlight;
Color m_highlight_color;
bool m_highlight_enabled;
bool m_cyclic_scroll_enabled;
bool m_autocenter_cursor;
size_t m_drawn_position;
Buffer m_selected_prefix;
Buffer m_selected_suffix;
};
template <typename T> Menu<T>::Menu(size_t startx,
size_t starty,
size_t width,
size_t height,
const std::string &title,
Color color,
Border border)
: Window(startx, starty, width, height, title, color, border),
m_item_displayer(0),
m_options_ptr(&m_options),
m_beginning(0),
m_highlight(0),
m_highlight_color(m_base_color),
m_highlight_enabled(true),
m_cyclic_scroll_enabled(false),
m_autocenter_cursor(false)
{
}
template <typename T> Menu<T>::~Menu()
{
for (auto it = m_options.begin(); it != m_options.end(); ++it)
delete *it;
}
template <typename T> void Menu<T>::reserve(size_t size_)
{
m_options.reserve(size_);
}
template <typename T> void Menu<T>::resizeList(size_t new_size)
{
if (new_size > m_options.size())
{
m_options.resize(new_size);
for (size_t i = 0; i < new_size; ++i)
if (!m_options[i])
m_options[i] = new Item();
}
else if (new_size < m_options.size())
{
for (size_t i = new_size; i < m_options.size(); ++i)
delete m_options[i];
m_options.resize(new_size);
}
}
template <typename T> void Menu<T>::addItem(const T &item, bool is_bold, bool is_inactive)
{
m_options.push_back(new Item(item, is_bold, is_inactive));
}
template <typename T> void Menu<T>::addSeparator()
{
m_options.push_back(Item::mkSeparator());
}
template <typename T> void Menu<T>::insertItem(size_t pos, const T &item, bool is_bold, bool is_inactive)
{
m_options.insert(m_options.begin()+pos, new Item(item, is_bold, is_inactive));
}
template <typename T> void Menu<T>::insertSeparator(size_t pos)
{
m_options.insert(m_options.begin()+pos, Item::mkSeparator());
}
template <typename T> void Menu<T>::deleteItem(size_t pos)
{
assert(m_options_ptr != &m_filtered_options);
assert(pos < m_options.size());
delete m_options[pos];
m_options.erase(m_options.begin()+pos);
}
template <typename T> void Menu<T>::Swap(size_t one, size_t two)
{
std::swap(m_options.at(one), m_options.at(two));
}
template <typename T> bool Menu<T>::Goto(size_t y)
{
if (!isHighlightable(m_beginning+y))
return false;
m_highlight = m_beginning+y;
return true;
}
template <typename T> void Menu<T>::refresh()
{
if (m_options_ptr->empty())
{
Window::clear();
Window::refresh();
return;
}
size_t max_beginning = m_options_ptr->size() < m_height ? 0 : m_options_ptr->size()-m_height;
m_beginning = std::min(m_beginning, max_beginning);
// if highlighted position is off the screen, make it visible
m_highlight = std::min(m_highlight, m_beginning+m_height-1);
// if highlighted position is invalid, correct it
m_highlight = std::min(m_highlight, m_options_ptr->size()-1);
if (!isHighlightable(m_highlight))
{
scroll(wUp);
if (!isHighlightable(m_highlight))
scroll(wDown);
}
size_t line = 0;
m_drawn_position = m_beginning;
for (size_t &i = m_drawn_position; i < m_beginning+m_height; ++i, ++line)
{
goToXY(0, line);
if (i >= m_options_ptr->size())
{
for (; line < m_height; ++line)
mvwhline(m_window, line, 0, KEY_SPACE, m_width);
break;
}
if ((*m_options_ptr)[i]->isSeparator())
{
mvwhline(m_window, line, 0, 0, m_width);
continue;
}
if ((*m_options_ptr)[i]->isBold())
*this << fmtBold;
if (m_highlight_enabled && i == m_highlight)
{
*this << fmtReverse;
*this << m_highlight_color;
}
mvwhline(m_window, line, 0, KEY_SPACE, m_width);
if ((*m_options_ptr)[i]->isSelected())
*this << m_selected_prefix;
if (m_item_displayer)
m_item_displayer(*this);
if ((*m_options_ptr)[i]->isSelected())
*this << m_selected_suffix;
if (m_highlight_enabled && i == m_highlight)
{
*this << clEnd;
*this << fmtReverseEnd;
}
if ((*m_options_ptr)[i]->isBold())
*this << fmtBoldEnd;
}
Window::refresh();
}
template <typename T> void Menu<T>::scroll(Where where)
{
if (m_options_ptr->empty())
return;
size_t max_highlight = m_options_ptr->size()-1;
size_t max_beginning = m_options_ptr->size() < m_height ? 0 : m_options_ptr->size()-m_height;
size_t max_visible_highlight = m_beginning+m_height-1;
switch (where)
{
case wUp:
{
if (m_highlight <= m_beginning && m_highlight > 0)
--m_beginning;
if (m_highlight == 0)
{
if (m_cyclic_scroll_enabled)
return scroll(wEnd);
break;
}
else
--m_highlight;
if (!isHighlightable(m_highlight))
scroll(m_highlight == 0 && !m_cyclic_scroll_enabled ? wDown : wUp);
break;
}
case wDown:
{
if (m_highlight >= max_visible_highlight && m_highlight < max_highlight)
++m_beginning;
if (m_highlight == max_highlight)
{
if (m_cyclic_scroll_enabled)
return scroll(wHome);
break;
}
else
++m_highlight;
if (!isHighlightable(m_highlight))
scroll(m_highlight == max_highlight && !m_cyclic_scroll_enabled ? wUp : wDown);
break;
}
case wPageUp:
{
if (m_cyclic_scroll_enabled && m_highlight == 0)
return scroll(wEnd);
if (m_highlight < m_height)
m_highlight = 0;
else
m_highlight -= m_height;
if (m_beginning < m_height)
m_beginning = 0;
else
m_beginning -= m_height;
if (!isHighlightable(m_highlight))
scroll(m_highlight == 0 && !m_cyclic_scroll_enabled ? wDown : wUp);
break;
}
case wPageDown:
{
if (m_cyclic_scroll_enabled && m_highlight == max_highlight)
return scroll(wHome);
m_highlight += m_height;
m_beginning += m_height;
m_beginning = std::min(m_beginning, max_beginning);
m_highlight = std::min(m_highlight, max_highlight);
if (!isHighlightable(m_highlight))
scroll(m_highlight == max_highlight && !m_cyclic_scroll_enabled ? wUp : wDown);
break;
}
case wHome:
{
m_highlight = 0;
m_beginning = 0;
if (!isHighlightable(m_highlight))
scroll(wDown);
break;
}
case wEnd:
{
m_highlight = max_highlight;
m_beginning = max_beginning;
if (!isHighlightable(m_highlight))
scroll(wUp);
break;
}
}
if (m_autocenter_cursor)
highlight(m_highlight);
}
template <typename T> void Menu<T>::reset()
{
m_highlight = 0;
m_beginning = 0;
}
template <typename T> void Menu<T>::clear()
{
for (auto it = m_options.begin(); it != m_options.end(); ++it)
delete *it;
clearFilterResults();
m_options.clear();
m_found_positions.clear();
m_options_ptr = &m_options;
}
template <typename T> bool Menu<T>::hasSelected() const
{
for (auto it = begin(); it != end(); ++it)
if (it->isSelected())
return true;
return false;
}
template <typename T> void Menu<T>::highlight(size_t pos)
{
m_highlight = pos;
size_t half_height = m_height/2;
if (pos < half_height)
m_beginning = 0;
else
m_beginning = pos-half_height;
}
template <typename T> size_t Menu<T>::choice() const
{
assert(!empty());
return m_highlight;
}
template <typename T>
void Menu<T>::filter(ConstIterator first, ConstIterator last, const FilterFunction &f)
{
assert(m_options_ptr != &m_filtered_options);
clearFilterResults();
m_filter = f;
for (auto it = first; it != last; ++it)
if (m_filter(*it))
m_filtered_options.push_back(*it.base());
if (m_filtered_options == m_options)
m_filtered_options.clear();
else
m_options_ptr = &m_filtered_options;
}
template <typename T>
void Menu<T>::applyCurrentFilter(ConstIterator first, ConstIterator last)
{
assert(m_filter);
filter(first, last, m_filter);
}
template <typename T> void Menu<T>::clearFilterResults()
{
m_filtered_options.clear();
m_options_ptr = &m_options;
}
template <typename T> void Menu<T>::clearFilter()
{
m_filter = 0;
}
template <typename T>
bool Menu<T>::search(ConstIterator first, ConstIterator last, const FilterFunction &f)
{
m_found_positions.clear();
m_searcher = f;
for (auto it = first; it != last; ++it)
{
if (m_searcher(*it))
{
size_t pos = it-begin();
m_found_positions.insert(pos);
}
}
return !m_found_positions.empty();
}
template <typename T> void Menu<T>::clearSearchResults()
{
m_found_positions.clear();
}
template <typename T> void Menu<T>::nextFound(bool wrap)
{
if (m_found_positions.empty())
return;
auto next = m_found_positions.upper_bound(m_highlight);
if (next != m_found_positions.end())
highlight(*next);
else if (wrap)
highlight(*m_found_positions.begin());
}
template <typename T> void Menu<T>::prevFound(bool wrap)
{
if (m_found_positions.empty())
return;
auto prev = m_found_positions.lower_bound(m_highlight);
if (prev != m_found_positions.begin())
highlight(*--prev);
else if (wrap)
highlight(*m_found_positions.rbegin());
}
}
#endif