Settings: Add SIGROKDECODE_DIR notice so that users are aware
[pulseview.git] / pv / devicemanager.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef PULSEVIEW_PV_DEVICEMANAGER_HPP
21 #define PULSEVIEW_PV_DEVICEMANAGER_HPP
22
23 #include <list>
24 #include <map>
25 #include <memory>
26 #include <set>
27 #include <string>
28 #include <vector>
29
30 using std::list;
31 using std::map;
32 using std::set;
33 using std::shared_ptr;
34 using std::string;
35 using std::vector;
36
37 namespace Glib {
38 class VariantBase;
39 }
40
41 namespace sigrok {
42 class ConfigKey;
43 class Context;
44 class Driver;
45 }
46
47 using sigrok::ConfigKey;
48
49 namespace pv {
50
51 namespace devices {
52 class Device;
53 class HardwareDevice;
54 }
55
56 class Session;
57
58 class DeviceManager
59 {
60 public:
61         DeviceManager(shared_ptr<sigrok::Context> context,
62                 std::string driver, bool do_scan);
63
64         ~DeviceManager() = default;
65
66         const shared_ptr<sigrok::Context>& context() const;
67
68         shared_ptr<sigrok::Context> context();
69
70         const list< shared_ptr<devices::HardwareDevice> >& devices() const;
71         shared_ptr<devices::HardwareDevice> user_spec_device() const;
72
73         bool driver_supported(shared_ptr<sigrok::Driver> driver) const;
74
75         list< shared_ptr<devices::HardwareDevice> > driver_scan(
76                 shared_ptr<sigrok::Driver> driver,
77                 map<const sigrok::ConfigKey *, Glib::VariantBase> drvopts);
78
79         const map<string, string> get_device_info(
80                 const shared_ptr<devices::Device> device);
81
82         const shared_ptr<devices::HardwareDevice> find_device_from_info(
83                 const map<string, string> search_info);
84
85 private:
86         bool compare_devices(shared_ptr<devices::Device> a,
87                 shared_ptr<devices::Device> b);
88
89         static map<const ConfigKey *, Glib::VariantBase>
90         drive_scan_options(vector<string> user_spec,
91                 set<const ConfigKey *> driver_opts);
92
93 protected:
94         shared_ptr<sigrok::Context> context_;
95         list< shared_ptr<devices::HardwareDevice> > devices_;
96         shared_ptr<devices::HardwareDevice> user_spec_device_;
97 };
98
99 } // namespace pv
100
101 #endif // PULSEVIEW_PV_DEVICEMANAGER_HPP