]> sigrok.org Git - pulseview.git/blobdiff - pv/devicemanager.cpp
devices::Device: Moved in full_name and display_name
[pulseview.git] / pv / devicemanager.cpp
index 4c9f768a909a07e1585c84d9c0785c2c7b92d6e8..36d6fb6a44f1d0c10ae05a234503e5347122a85c 100644 (file)
@@ -18,8 +18,8 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "devicemanager.h"
-#include "sigsession.h"
+#include "devicemanager.hpp"
+#include "session.hpp"
 
 #include <cassert>
 #include <stdexcept>
 #include <string>
 #include <vector>
 
-#include <libsigrok/libsigrok.hpp>
+#include <libsigrokcxx/libsigrokcxx.hpp>
 
+#include <boost/algorithm/string/join.hpp>
 #include <boost/filesystem.hpp>
 
+#include <pv/devices/hardwaredevice.hpp>
+
+using boost::algorithm::join;
+
 using std::dynamic_pointer_cast;
 using std::list;
 using std::map;
-using std::ostringstream;
 using std::remove_if;
 using std::runtime_error;
 using std::shared_ptr;
@@ -46,14 +50,12 @@ using Glib::VariantBase;
 using sigrok::ConfigKey;
 using sigrok::Context;
 using sigrok::Driver;
-using sigrok::Device;
-using sigrok::HardwareDevice;
 using sigrok::SessionDevice;
 
 namespace pv {
 
 DeviceManager::DeviceManager(shared_ptr<Context> context) :
-       _context(context)
+       context_(context)
 {
        for (auto entry : context->drivers())
                driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
@@ -63,71 +65,86 @@ DeviceManager::~DeviceManager()
 {
 }
 
+const std::shared_ptr<sigrok::Context>& DeviceManager::context() const
+{
+       return context_;
+}
+
 shared_ptr<Context> DeviceManager::context()
 {
-       return _context;
+       return context_;
 }
 
-const list< shared_ptr<HardwareDevice> >& DeviceManager::devices() const
+const list< shared_ptr<devices::HardwareDevice> >&
+DeviceManager::devices() const
 {
-       return _devices;
+       return devices_;
 }
 
-list< shared_ptr<HardwareDevice> > DeviceManager::driver_scan(
+list< shared_ptr<devices::HardwareDevice> >
+DeviceManager::driver_scan(
        shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
 {
-       list< shared_ptr<HardwareDevice> > driver_devices;
+       list< shared_ptr<devices::HardwareDevice> > driver_devices;
 
        assert(driver);
 
        // Remove any device instances from this driver from the device
        // list. They will not be valid after the scan.
-       _devices.remove_if([&](shared_ptr<HardwareDevice> device) {
-               return device->driver() == driver; });
+       devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
+               return device->hardware_device()->driver() == driver; });
 
        // Do the scan
        auto devices = driver->scan(drvopts);
-       driver_devices.insert(driver_devices.end(), devices.begin(), devices.end());
-       driver_devices.sort(compare_devices);
 
-       // Add the scanned devices to the main list
-       _devices.insert(_devices.end(), driver_devices.begin(),
+       // Add the scanned devices to the main list, set display names and sort.
+       for (shared_ptr<sigrok::HardwareDevice> device : devices) {
+               const shared_ptr<devices::HardwareDevice> d(
+                       new devices::HardwareDevice(context_, device));
+               driver_devices.push_back(d);
+       }
+
+       for (shared_ptr<devices::HardwareDevice> device : driver_devices)
+               build_display_name(device);
+
+       devices_.insert(devices_.end(), driver_devices.begin(),
                driver_devices.end());
-       _devices.sort(compare_devices);
+       devices_.sort([&](shared_ptr<devices::Device> a,
+               shared_ptr<devices::Device> b)
+               { return compare_devices(a, b); });
 
        return driver_devices;
 }
 
 const map<string, string> DeviceManager::get_device_info(
-       shared_ptr<Device> device)
+       shared_ptr<devices::Device> device)
 {
        map<string, string> result;
 
        assert(device);
 
-       if (device->vendor().length() > 0)
-               result["vendor"] = device->vendor();
-       if (device->model().length() > 0)
-               result["model"] = device->model();
-       if (device->version().length() > 0)
-               result["version"] = device->version();
-       if (device->serial_number().length() > 0)
-               result["serial_num"] = device->serial_number();
-       if (device->connection_id().length() > 0)
-               result["connection_id"] = device->connection_id();
+       const shared_ptr<sigrok::Device> sr_dev = device->device();
+       if (sr_dev->vendor().length() > 0)
+               result["vendor"] = sr_dev->vendor();
+       if (sr_dev->model().length() > 0)
+               result["model"] = sr_dev->model();
+       if (sr_dev->version().length() > 0)
+               result["version"] = sr_dev->version();
+       if (sr_dev->serial_number().length() > 0)
+               result["serial_num"] = sr_dev->serial_number();
+       if (sr_dev->connection_id().length() > 0)
+               result["connection_id"] = sr_dev->connection_id();
 
        return result;
 }
 
-const shared_ptr<HardwareDevice> DeviceManager::find_device_from_info(
+const shared_ptr<devices::HardwareDevice> DeviceManager::find_device_from_info(
        const map<string, string> search_info)
 {
-       shared_ptr<HardwareDevice> last_resort_dev;
+       shared_ptr<devices::HardwareDevice> last_resort_dev;
        map<string, string> dev_info;
 
-       last_resort_dev = NULL;
-
-       for (shared_ptr<HardwareDevice> dev : _devices) {
+       for (shared_ptr<devices::HardwareDevice> dev : devices_) {
                assert(dev);
                dev_info = get_device_info(dev);
 
@@ -170,43 +187,80 @@ const shared_ptr<HardwareDevice> DeviceManager::find_device_from_info(
        return last_resort_dev;
 }
 
-string DeviceManager::device_description(shared_ptr<Device> device)
+void DeviceManager::build_display_name(shared_ptr<devices::Device> device)
 {
-       auto session_device = dynamic_pointer_cast<SessionDevice>(device);
+       const shared_ptr<sigrok::Device> sr_dev = device->device();
+       auto session_device = dynamic_pointer_cast<sigrok::SessionDevice>(sr_dev);
+       auto hardware_device = dynamic_pointer_cast<sigrok::HardwareDevice>(sr_dev);
 
-       if (session_device)
-               return boost::filesystem::path(
+       if (session_device) {
+               full_names_[device] = display_names_[device] =
+                       boost::filesystem::path(
                        session_device->parent()->filename()).filename().string();
+               return;
+       }
+
+       // First, build the device's full name. It always contains all
+       // possible information.
+       vector<string> parts = {sr_dev->vendor(), sr_dev->model(),
+               sr_dev->version(), sr_dev->serial_number()};
+
+       if (sr_dev->connection_id().length() > 0)
+               parts.push_back("("+sr_dev->connection_id()+")");
 
-       ostringstream s;
+       full_names_[device] = join(parts, " ");
 
-       vector<string> parts = {device->vendor(), device->model(),
-               device->version(), device->serial_number()};
+       // Next, build the display name. It only contains fields as required.
 
-       for (size_t i = 0; i < parts.size(); i++)
-       {
-               if (parts[i].length() > 0)
-               {
-                       if (i != 0)
-                               s << " ";
-                       s << parts[i];
-               }
+       // If we can find another device with the same model/vendor then
+       // we have at least two such devices and need to distinguish them.
+       const bool multiple_dev = hardware_device && any_of(
+               devices_.begin(), devices_.end(),
+               [&](shared_ptr<devices::HardwareDevice> dev) {
+                       return (dev->device()->vendor() == hardware_device->vendor() &&
+                               dev->device()->model() == hardware_device->model()) &&
+                               dev != device;
+               } );
+
+       parts = {sr_dev->vendor(), sr_dev->model()};
+
+       if (multiple_dev) {
+               parts.push_back(sr_dev->version());
+               parts.push_back(sr_dev->serial_number());
+
+               if ((sr_dev->serial_number().length() == 0) &&
+                       (sr_dev->connection_id().length() > 0))
+                       parts.push_back("("+sr_dev->connection_id()+")");
        }
 
-       if (device->serial_number().length() == 0 &&
-                       device->connection_id().length() > 0)
-               s << " " << device->connection_id();
+       display_names_[device] = join(parts, " ");
+}
 
-       return s.str();
+const std::string DeviceManager::get_display_name(
+       std::shared_ptr<devices::Device> dev)
+{
+       return display_names_[dev];
+}
+
+const std::string DeviceManager::get_full_name(
+       std::shared_ptr<devices::Device> dev)
+{
+       return full_names_[dev];
+}
+
+void DeviceManager::update_display_name(
+       std::shared_ptr<devices::Device> dev)
+{
+       build_display_name(dev);
 }
 
-bool DeviceManager::compare_devices(shared_ptr<HardwareDevice> a,
-       shared_ptr<HardwareDevice> b)
+bool DeviceManager::compare_devices(
+       shared_ptr<devices::Device> a, shared_ptr<devices::Device> b)
 {
        assert(a);
        assert(b);
 
-       return device_description(a).compare(device_description(b)) < 0;
+       return display_names_[a].compare(display_names_[b]) < 0;
 }
 
 } // namespace pv