genode/repos/os/src/server/input_filter/connection.h

98 lines
2.2 KiB
C
Raw Normal View History

/*
* \brief Connection for incoming input events
* \author Norman Feske
* \date 2017-02-01
*/
/*
* Copyright (C) 2017 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU Affero General Public License version 3.
*/
#ifndef _INPUT_FILTER__CONNECTION_H_
#define _INPUT_FILTER__CONNECTION_H_
/* Genode includes */
#include <input_session/connection.h>
#include <base/session_label.h>
/* local includes */
#include <types.h>
namespace Input_filter { struct Input_connection; }
class Input_filter::Input_connection
{
public:
Follow practices suggested by "Effective C++" The patch adjust the code of the base, base-<kernel>, and os repository. To adapt existing components to fix violations of the best practices suggested by "Effective C++" as reported by the -Weffc++ compiler argument. The changes follow the patterns outlined below: * A class with virtual functions can no longer publicly inherit base classed without a vtable. The inherited object may either be moved to a member variable, or inherited privately. The latter would be used for classes that inherit 'List::Element' or 'Avl_node'. In order to enable the 'List' and 'Avl_tree' to access the meta data, the 'List' must become a friend. * Instead of adding a virtual destructor to abstract base classes, we inherit the new 'Interface' class, which contains a virtual destructor. This way, single-line abstract base classes can stay as compact as they are now. The 'Interface' utility resides in base/include/util/interface.h. * With the new warnings enabled, all member variables must be explicitly initialized. Basic types may be initialized with '='. All other types are initialized with braces '{ ... }' or as class initializers. If basic types and non-basic types appear in a row, it is nice to only use the brace syntax (also for basic types) and align the braces. * If a class contains pointers as members, it must now also provide a copy constructor and assignment operator. In the most cases, one would make them private, effectively disallowing the objects to be copied. Unfortunately, this warning cannot be fixed be inheriting our existing 'Noncopyable' class (the compiler fails to detect that the inheriting class cannot be copied and still gives the error). For now, we have to manually add declarations for both the copy constructor and assignment operator as private class members. Those declarations should be prepended with a comment like this: /* * Noncopyable */ Thread(Thread const &); Thread &operator = (Thread const &); In the future, we should revisit these places and try to replace the pointers with references. In the presence of at least one reference member, the compiler would no longer implicitly generate a copy constructor. So we could remove the manual declaration. Issue #465
2017-12-21 15:42:15 +01:00
struct Avail_handler : Interface { virtual void handle_input_avail() = 0; };
private:
Session_label const _label;
Input::Connection _connection;
Attached_dataspace _events_ds;
Avail_handler &_avail_handler;
unsigned _key_cnt = 0;
Signal_handler<Input_connection> _input_handler;
void _handle_input() { _avail_handler.handle_input_avail(); }
size_t _num_ev = 0;
size_t const _max_events = _events_ds.size() / sizeof(Input::Event);
public:
static char const *name() { return "input"; }
Input_connection(Env &env, Session_label const &label,
Follow practices suggested by "Effective C++" The patch adjust the code of the base, base-<kernel>, and os repository. To adapt existing components to fix violations of the best practices suggested by "Effective C++" as reported by the -Weffc++ compiler argument. The changes follow the patterns outlined below: * A class with virtual functions can no longer publicly inherit base classed without a vtable. The inherited object may either be moved to a member variable, or inherited privately. The latter would be used for classes that inherit 'List::Element' or 'Avl_node'. In order to enable the 'List' and 'Avl_tree' to access the meta data, the 'List' must become a friend. * Instead of adding a virtual destructor to abstract base classes, we inherit the new 'Interface' class, which contains a virtual destructor. This way, single-line abstract base classes can stay as compact as they are now. The 'Interface' utility resides in base/include/util/interface.h. * With the new warnings enabled, all member variables must be explicitly initialized. Basic types may be initialized with '='. All other types are initialized with braces '{ ... }' or as class initializers. If basic types and non-basic types appear in a row, it is nice to only use the brace syntax (also for basic types) and align the braces. * If a class contains pointers as members, it must now also provide a copy constructor and assignment operator. In the most cases, one would make them private, effectively disallowing the objects to be copied. Unfortunately, this warning cannot be fixed be inheriting our existing 'Noncopyable' class (the compiler fails to detect that the inheriting class cannot be copied and still gives the error). For now, we have to manually add declarations for both the copy constructor and assignment operator as private class members. Those declarations should be prepended with a comment like this: /* * Noncopyable */ Thread(Thread const &); Thread &operator = (Thread const &); In the future, we should revisit these places and try to replace the pointers with references. In the presence of at least one reference member, the compiler would no longer implicitly generate a copy constructor. So we could remove the manual declaration. Issue #465
2017-12-21 15:42:15 +01:00
Avail_handler &avail_handler, Allocator &)
:
_label(label),
_connection(env, label.string()),
_events_ds(env.rm(), _connection.dataspace()),
_avail_handler(avail_handler),
_input_handler(env.ep(), *this, &Input_connection::_handle_input)
{
_connection.sigh(_input_handler);
}
virtual ~Input_connection() { }
Session_label label() const { return _label; }
template <typename FUNC>
void for_each_event(FUNC const &func) const
{
Input::Event const *event_ptr = _events_ds.local_addr<Input::Event const>();
for (size_t i = 0; i < _num_ev; i++)
func(*event_ptr++);
}
void flush()
{
_num_ev = min(_max_events, (size_t)_connection.flush());
auto update_key_cnt = [&] (Input::Event const &event)
{
if (event.press()) _key_cnt++;
if (event.release()) _key_cnt--;
};
for_each_event(update_key_cnt);
}
bool idle() const { return _key_cnt == 0; }
bool pending() const { return _num_ev > 0; }
};
#endif /* _INPUT_FILTER__CONNECTION_H_ */