Mir
wrapper.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Christopher James Halse Rogers <christopher.halse.rogers@canonical.com>
17  */
18 
19 #ifndef MIR_UDEV_WRAPPER_H_
20 #define MIR_UDEV_WRAPPER_H_
21 
22 #include <memory>
23 #include <libudev.h>
24 
25 namespace mir
26 {
27 namespace udev
28 {
29 
30 class Device;
31 class Enumerator;
32 
33 class Context
34 {
35 public:
36  Context();
37  ~Context() noexcept;
38 
39  Context(Context const&) = delete;
40  Context& operator=(Context const&) = delete;
41 
42  std::shared_ptr<Device> device_from_syspath(std::string const& syspath);
43 
44  ::udev* ctx() const;
45 
46 private:
47  ::udev* const context;
48 };
49 
50 class Device
51 {
52 public:
53  virtual ~Device() = default;
54 
55  Device(Device const&) = delete;
56  Device& operator=(Device const&) = delete;
57 
58  virtual char const* subsystem() const = 0;
59  virtual char const* devtype() const = 0;
60  virtual char const* devpath() const = 0;
61  virtual char const* devnode() const = 0;
62 protected:
63  Device() = default;
64 };
65 
66 bool operator==(Device const& lhs, Device const& rhs);
67 bool operator!=(Device const& lhs, Device const& rhs);
68 
70 {
71 public:
72  Enumerator(std::shared_ptr<Context> const& ctx);
73  ~Enumerator() noexcept;
74 
75  Enumerator(Enumerator const&) = delete;
76  Enumerator& operator=(Enumerator const&) = delete;
77 
78  void scan_devices();
79 
80  void match_subsystem(std::string const& subsystem);
81  void match_parent(Device const& parent);
82  void match_sysname(std::string const& sysname);
83 
84  class iterator :
85  public std::iterator<std::input_iterator_tag, Device>
86  {
87  public:
89  iterator operator++(int);
90 
91  bool operator==(iterator const& rhs) const;
92  bool operator!=(iterator const& rhs) const;
93 
94  Device const& operator*() const;
95  Device const* operator->() const;
96  private:
97  friend class Enumerator;
98 
99  iterator ();
100  iterator (std::shared_ptr<Context> const& ctx, udev_list_entry* entry);
101 
102  void increment();
103 
104  std::shared_ptr<Context> ctx;
105  udev_list_entry* entry;
106 
107  std::shared_ptr<Device> current;
108  };
109 
110  iterator begin();
111  iterator end();
112 
113 private:
114  std::shared_ptr<Context> const ctx;
115  udev_enumerate* const enumerator;
116  bool scanned;
117 };
118 
119 class Monitor
120 {
121 public:
122  enum EventType {
126  };
127 
128  Monitor(const Context& ctx);
129  ~Monitor() noexcept;
130 
131  Monitor(Monitor const&) = delete;
132  Monitor& operator=(Monitor const&) = delete;
133 
134  void enable(void);
135  int fd(void) const;
136 
137  void filter_by_subsystem(std::string const& subsystem);
138  void filter_by_subsystem_and_type(std::string const& subsystem, std::string const& devtype);
139 
140  void process_events(std::function<void(EventType, Device const&)> const& handler) const;
141 
142 private:
143  udev_monitor* const monitor;
144  bool enabled;
145 };
146 
147 }
148 }
149 #endif // MIR_UDEV_WRAPPER_H_
Device & operator=(Device const &)=delete
All things Mir.
Definition: buffer_stream.h:37
Definition: wrapper.h:119
~Monitor() noexcept
Definition: udev_wrapper.cpp:253
Enumerator & operator=(Enumerator const &)=delete
iterator begin()
Definition: udev_wrapper.cpp:200
void process_events(std::function< void(EventType, Device const &)> const &handler) const
Definition: udev_wrapper.cpp:276
Definition: wrapper.h:69
virtual char const * devpath() const =0
STL namespace.
int fd(void) const
Definition: udev_wrapper.cpp:288
Monitor(const Context &ctx)
Definition: udev_wrapper.cpp:243
iterator & operator++()
Definition: udev_wrapper.cpp:134
Device const & operator*() const
Definition: udev_wrapper.cpp:157
~Enumerator() noexcept
Definition: udev_wrapper.cpp:174
EventType
Definition: wrapper.h:122
bool operator==(iterator const &rhs) const
Definition: udev_wrapper.cpp:147
Definition: wrapper.h:123
Enumerator(std::shared_ptr< Context > const &ctx)
Definition: udev_wrapper.cpp:167
virtual ~Device()=default
Definition: wrapper.h:50
iterator end()
Definition: udev_wrapper.cpp:209
Definition: wrapper.h:124
bool operator==(Device const &lhs, Device const &rhs)
Definition: udev_wrapper.cpp:82
void match_sysname(std::string const &sysname)
Definition: udev_wrapper.cpp:195
void match_parent(Device const &parent)
Definition: udev_wrapper.cpp:190
::udev * ctx() const
Definition: udev_wrapper.cpp:235
Context()
Definition: udev_wrapper.cpp:218
std::shared_ptr< Device > device_from_syspath(std::string const &syspath)
Definition: udev_wrapper.cpp:230
Context & operator=(Context const &)=delete
Definition: wrapper.h:125
void filter_by_subsystem(std::string const &subsystem)
Definition: udev_wrapper.cpp:293
bool operator!=(iterator const &rhs) const
Definition: udev_wrapper.cpp:152
virtual char const * devtype() const =0
void enable(void)
Definition: udev_wrapper.cpp:259
void match_subsystem(std::string const &subsystem)
Definition: udev_wrapper.cpp:185
~Context() noexcept
Definition: udev_wrapper.cpp:225
bool operator!=(Device const &lhs, Device const &rhs)
Definition: udev_wrapper.cpp:88
virtual char const * subsystem() const =0
Definition: wrapper.h:84
Device const * operator->() const
Definition: udev_wrapper.cpp:162
Definition: wrapper.h:33
void scan_devices()
Definition: udev_wrapper.cpp:179
virtual char const * devnode() const =0
void filter_by_subsystem_and_type(std::string const &subsystem, std::string const &devtype)
Definition: udev_wrapper.cpp:300

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015