829cd4a2d0
Refactor message handling so that message buffering and window handling are in the main window code, leaving only message window rendering to the platform code.
207 lines
4.8 KiB
C++
207 lines
4.8 KiB
C++
#ifndef _messagebuffer__hpp__included__
|
|
#define _messagebuffer__hpp__included__
|
|
|
|
#include <stdexcept>
|
|
#include <map>
|
|
#include <set>
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
class messagebuffer
|
|
{
|
|
public:
|
|
/**
|
|
* Update handler.
|
|
*/
|
|
class update_handler
|
|
{
|
|
public:
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~update_handler() throw();
|
|
/**
|
|
* Handle update.
|
|
*/
|
|
virtual void messagebuffer_update() throw(std::bad_alloc, std::runtime_error) = 0;
|
|
};
|
|
/**
|
|
* Create new message buffer with specified maximum message count.
|
|
*
|
|
* Parameter maxmessages: The maximum number of messages.
|
|
* Parameter windowsize: The initial window size.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::logic_error: Windowsize is greater than maxmessages or maxmessages is zero.
|
|
*/
|
|
messagebuffer(size_t maxmessages, size_t windowsize) throw(std::bad_alloc, std::logic_error);
|
|
|
|
/**
|
|
* Add a new message to the buffer.
|
|
*
|
|
* Parameter msg: The new message to add.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void add_message(const std::string& msg) throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Read a message.
|
|
*
|
|
* Parameter msgnum: Number of message to read.
|
|
* Returns: The read message.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::logic_error: Invalid message number.
|
|
*/
|
|
const std::string& get_message(size_t msgnum) throw(std::bad_alloc, std::logic_error);
|
|
|
|
/**
|
|
* Get the number of first message present.
|
|
*
|
|
* Returns: The number of first message present.
|
|
*/
|
|
size_t get_msg_first() throw();
|
|
|
|
/**
|
|
* Get the number of messages present.
|
|
*
|
|
* Returns: The number of messages present.
|
|
*/
|
|
size_t get_msg_count() throw();
|
|
|
|
/**
|
|
* Get the number of first message visible.
|
|
*
|
|
* Returns: The number of first message visible.
|
|
*/
|
|
size_t get_visible_first() throw();
|
|
|
|
/**
|
|
* Get the number of messages visible.
|
|
*
|
|
* Returns: The number of messages visible.
|
|
*/
|
|
size_t get_visible_count() throw();
|
|
|
|
/**
|
|
* Is there more messages after the current window?
|
|
*
|
|
* Returns: True if there is, false if not.
|
|
*/
|
|
bool is_more_messages() throw();
|
|
|
|
/**
|
|
* Freeze scrolling
|
|
*/
|
|
void freeze_scrolling() throw();
|
|
|
|
/**
|
|
* Unfreeze scrolling
|
|
*/
|
|
void unfreeze_scrolling() throw();
|
|
|
|
/**
|
|
* Freeze updates
|
|
*/
|
|
void freeze_updates() throw();
|
|
|
|
/**
|
|
* Unfreeze updates
|
|
*
|
|
* Returns: True if update is needed.
|
|
*/
|
|
bool unfreeze_updates() throw();
|
|
|
|
/**
|
|
* Scroll to beginning.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_beginning() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Scroll up one page.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_up_page() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Scroll up one line.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_up_line() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Scroll down one line.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_down_line() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Scroll down one page.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_down_page() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Scroll to beginning.
|
|
*
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::runtime_error: Thrown through from update handler.
|
|
*/
|
|
void scroll_end() throw(std::bad_alloc, std::runtime_error);
|
|
|
|
/**
|
|
* Register an update handler.
|
|
*
|
|
* Parameter handler: The new handler.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
*/
|
|
void register_handler(update_handler& handler) throw(std::bad_alloc);
|
|
|
|
/**
|
|
* Unregister an update handler.
|
|
*
|
|
* Parameter handler: The handler to remove.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
*/
|
|
void unregister_handler(update_handler& handler) throw();
|
|
|
|
/**
|
|
* Change the window size.
|
|
*
|
|
* Parameter windowsize: The new window size.
|
|
* Throws std::bad_alloc: Not enough memory.
|
|
* Throws std::logic_error: Windowsize is greater than maxmessages or maxmessages is zero.
|
|
*/
|
|
void set_max_window_size(size_t windowsize) throw(std::bad_alloc, std::logic_error);
|
|
|
|
/**
|
|
* Read the window size.
|
|
*/
|
|
size_t get_max_window_size() throw();
|
|
private:
|
|
void send_notifications();
|
|
std::map<uint64_t, std::string> messages;
|
|
uint64_t first_present_message;
|
|
uint64_t next_message_number;
|
|
uint64_t window_start;
|
|
size_t max_messages;
|
|
size_t window_size;
|
|
bool scroll_frozen;
|
|
bool updates_frozen;
|
|
uint64_t window_start_at_freeze;
|
|
uint64_t window_size_at_freeze;
|
|
uint64_t next_message_number_at_freeze;
|
|
std::set<update_handler*> handlers;
|
|
};
|
|
|
|
#endif
|