Various minor whitespace and consistency fixes.
[pulseview.git] / pv / devices / hardwaredevice.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2015 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include <boost/algorithm/string/join.hpp>
22
23 #include <QString>
24
25 #include <libsigrokcxx/libsigrokcxx.hpp>
26
27 #include <pv/devicemanager.hpp>
28
29 #include "hardwaredevice.hpp"
30
31 using std::dynamic_pointer_cast;
32 using std::shared_ptr;
33 using std::static_pointer_cast;
34 using std::string;
35 using std::vector;
36
37 using boost::algorithm::join;
38
39 using sigrok::HardwareDevice;
40
41 namespace pv {
42 namespace devices {
43
44 HardwareDevice::HardwareDevice(const std::shared_ptr<sigrok::Context> &context,
45         std::shared_ptr<sigrok::HardwareDevice> device) :
46         context_(context),
47         device_open_(false)
48 {
49         device_ = device;
50 }
51
52 HardwareDevice::~HardwareDevice()
53 {
54         close();
55 }
56
57 string HardwareDevice::full_name() const
58 {
59         vector<string> parts = {device_->vendor(), device_->model(),
60                 device_->version(), device_->serial_number()};
61         if (device_->connection_id().length() > 0)
62                 parts.push_back("(" + device_->connection_id() + ")");
63         return join(parts, " ");
64 }
65
66 shared_ptr<sigrok::HardwareDevice> HardwareDevice::hardware_device() const
67 {
68         return static_pointer_cast<sigrok::HardwareDevice>(device_);
69 }
70
71 string HardwareDevice::display_name(
72         const DeviceManager &device_manager) const
73 {
74         const auto hw_dev = hardware_device();
75
76         // If we can find another device with the same model/vendor then
77         // we have at least two such devices and need to distinguish them.
78         const auto &devices = device_manager.devices();
79         const bool multiple_dev = hw_dev && any_of(
80                 devices.begin(), devices.end(),
81                 [&](shared_ptr<devices::HardwareDevice> dev) {
82                         return dev->hardware_device()->vendor() ==
83                                         hw_dev->vendor() &&
84                                 dev->hardware_device()->model() ==
85                                         hw_dev->model() &&
86                                 dev->device_ != device_;
87                 });
88
89         vector<string> parts = {device_->vendor(), device_->model()};
90
91         if (multiple_dev) {
92                 parts.push_back(device_->version());
93                 parts.push_back(device_->serial_number());
94
95                 if ((device_->serial_number().length() == 0) &&
96                         (device_->connection_id().length() > 0))
97                         parts.push_back("(" + device_->connection_id() + ")");
98         }
99
100         return join(parts, " ");
101 }
102
103 void HardwareDevice::open()
104 {
105         if (device_open_)
106                 close();
107
108         try {
109                 device_->open();
110         } catch (const sigrok::Error &e) {
111                 throw QString(e.what());
112         }
113
114         device_open_ = true;
115
116         // Set up the session
117         session_ = context_->create_session();
118         session_->add_device(device_);
119 }
120
121 void HardwareDevice::close()
122 {
123         if (device_open_)
124                 device_->close();
125
126         if (session_)
127                 session_->remove_devices();
128
129         device_open_ = false;
130 }
131
132 } // namespace devices
133 } // namespace pv