notcurses/include/ncpp/Menu.hh
Marek Habersack 64eeb95f1e [C++] Optionally enable throwing exceptions on errors
Nick prefers error handling based on exceptions in all cases, while I
prefer to save exception handling for truly exceptional situations -
function parameter validation and class constructor. However, there's no
need to not support both approaches, to be chosen at the discretion of
the developer.

NCPP follows RAII and all classes throw exceptions from their
constructors in case they cannot initialize properly. Likewise,
functions taking pointers that are required validate them and throw
exceptions whenever the requirement isn't met.

This commit goes one step further in that it enables optional validation
of notcurses function return values and throwing an
exception (`ncpp::call_error`) should the function signal an error. This
is disabled by default but it can be enabled by defining the
`NCPP_EXCEPTIONS_PLEASE` macro (preferably on the command line or
before *each* inclusion of any NCPP headers).

Out of necessity, this breaks the ABI (plus I found a handful of minor
issues in the code), but I think it's worth having this support in
place.
2020-04-15 12:10:14 -04:00

78 lines
1.5 KiB
C++

#ifndef __NCPP_MENU_HH
#define __NCPP_MENU_HH
#include <notcurses/notcurses.h>
#include "Root.hh"
namespace ncpp
{
class Plane;
class NCPP_API_EXPORT Menu : public Root
{
public:
static ncmenu_options default_options;
public:
explicit Menu (const ncmenu_options *opts = nullptr)
{
menu = ncmenu_create (get_notcurses (), opts == nullptr ? &default_options : opts);
if (menu == nullptr)
throw init_error ("notcurses failed to create a new menu");
}
~Menu ()
{
if (!is_notcurses_stopped ())
ncmenu_destroy (menu);
}
bool unroll (int sectionidx) const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_unroll (menu, sectionidx), -1);
}
bool rollup () const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_rollup (menu), -1);
}
bool nextsection () const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_nextsection (menu), -1);
}
bool prevsection () const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_prevsection (menu), -1);
}
bool nextitem () const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_nextitem (menu), -1);
}
bool previtem () const NOEXCEPT_MAYBE
{
return error_guard (ncmenu_previtem (menu), -1);
}
const char* get_selected (ncinput *ni = nullptr) const noexcept
{
return ncmenu_selected (menu, ni);
}
bool offer_input (const struct ncinput* nc) const noexcept
{
return ncmenu_offer_input (menu, nc);
}
Plane* get_plane () const noexcept;
private:
ncmenu *menu;
};
}
#endif