Use libsigrok C++ bindings (patch version 7).
[pulseview.git] / pv / devicemanager.cpp
index 5a72b31b78563c73e3053e107d14b112c9e040b0..c06fd79f3b77891a8605a57c386bb68f806004cc 100644 (file)
  */
 
 #include "devicemanager.h"
+#include "sigsession.h"
 
 #include <cassert>
-#include <sstream>
 #include <stdexcept>
+#include <sstream>
 #include <string>
+#include <vector>
+
+#include <libsigrok/libsigrok.hpp>
+
+#include <boost/filesystem.hpp>
 
-#include <libsigrok/libsigrok.h>
+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;
+using std::string;
+using std::vector;
 
-using namespace std;
+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(struct sr_context *sr_ctx) :
-       _sr_ctx(sr_ctx)
+DeviceManager::DeviceManager(shared_ptr<Context> context) :
+       _context(context)
 {
-       init_drivers();
-       scan_all_drivers();
+       for (auto entry : context->drivers())
+               driver_scan(entry.second, map<const ConfigKey *, VariantBase>());
 }
 
 DeviceManager::~DeviceManager()
 {
-       release_devices();
 }
 
-const std::list<sr_dev_inst*>& DeviceManager::devices() const
+shared_ptr<Context> DeviceManager::context()
+{
+       return _context;
+}
+
+const list< shared_ptr<HardwareDevice> >& DeviceManager::devices() const
 {
        return _devices;
 }
 
-list<sr_dev_inst*> DeviceManager::driver_scan(
-       struct sr_dev_driver *const driver, GSList *const drvopts)
+list< shared_ptr<HardwareDevice> > DeviceManager::driver_scan(
+       shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
 {
-       list<sr_dev_inst*> driver_devices;
+       list< shared_ptr<HardwareDevice> > driver_devices;
 
        assert(driver);
 
        // Remove any device instances from this driver from the device
        // list. They will not be valid after the scan.
-       list<sr_dev_inst*>::iterator i = _devices.begin();
-       while (i != _devices.end()) {
-               if ((*i)->driver == driver)
-                       i = _devices.erase(i);
-               else
-                       i++;
-       }
-
-       // Clear all the old device instances from this driver
-       sr_dev_clear(driver);
+       remove_if(_devices.begin(), _devices.end(),
+               [&](shared_ptr<HardwareDevice> device) {
+                       return device->driver() == driver; });
 
        // Do the scan
-       GSList *const devices = sr_driver_scan(driver, drvopts);
-       for (GSList *l = devices; l; l = l->next)
-               driver_devices.push_back((sr_dev_inst*)l->data);
-       g_slist_free(devices);
+       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
@@ -83,63 +99,115 @@ list<sr_dev_inst*> DeviceManager::driver_scan(
        return driver_devices;
 }
 
-string DeviceManager::format_device_title(const sr_dev_inst *const sdi)
+const map<string, string> DeviceManager::get_device_info(
+       shared_ptr<Device> device)
 {
-       ostringstream s;
-
-       assert(sdi);
-
-       if (sdi->vendor && sdi->vendor[0]) {
-               s << sdi->vendor;
-               if ((sdi->model && sdi->model[0]) ||
-                       (sdi->version && sdi->version[0]))
-                       s << ' ';
-       }
+       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();
+
+       return result;
+}
 
-       if (sdi->model && sdi->model[0]) {
-               s << sdi->model;
-               if (sdi->version && sdi->version[0])
-                       s << ' ';
+const shared_ptr<HardwareDevice> DeviceManager::find_device_from_info(
+       const map<string, string> search_info)
+{
+       shared_ptr<HardwareDevice> last_resort_dev;
+       map<string, string> dev_info;
+
+       last_resort_dev = NULL;
+
+       for (shared_ptr<HardwareDevice> dev : _devices) {
+               assert(dev);
+               dev_info = get_device_info(dev);
+
+               // If present, vendor and model always have to match.
+               if (dev_info.count("vendor") > 0 && search_info.count("vendor") > 0)
+                       if (dev_info.at("vendor") != search_info.at("vendor")) continue;
+
+               if (dev_info.count("model") > 0 && search_info.count("model") > 0)
+                       if (dev_info.at("model") != search_info.at("model")) continue;
+
+               // Most unique match: vendor/model/serial_num (but don't match a S/N of 0)
+               if ((dev_info.count("serial_num") > 0) && (dev_info.at("serial_num") != "0")
+                               && search_info.count("serial_num") > 0)
+                       if (dev_info.at("serial_num") == search_info.at("serial_num") &&
+                                       dev_info.at("serial_num") != "0")
+                               return dev;
+
+               // Second best match: vendor/model/connection_id
+               if (dev_info.count("connection_id") > 0 &&
+                       search_info.count("connection_id") > 0)
+                       if (dev_info.at("connection_id") == search_info.at("connection_id"))
+                               return dev;
+
+               // Last resort: vendor/model/version
+               if (dev_info.count("version") > 0 &&
+                       search_info.count("version") > 0)
+                       if (dev_info.at("version") == search_info.at("version") &&
+                                       dev_info.at("version") != "0")
+                               return dev;
+
+               // For this device, we merely have a vendor/model match.
+               last_resort_dev = dev;
        }
 
-       if (sdi->version && sdi->version[0])
-               s << sdi->version;
-
-       return s.str();
+       // If there wasn't even a vendor/model/version match, we end up here.
+       // This is usually the case for devices with only vendor/model data.
+       // The selected device may be wrong with multiple such devices attached
+       // but it is the best we can do at this point. After all, there may be
+       // only one such device and we do want to select it in this case.
+       return last_resort_dev;
 }
 
-void DeviceManager::init_drivers()
+string DeviceManager::device_description(shared_ptr<Device> device)
 {
-       // Initialise all libsigrok drivers
-       sr_dev_driver **const drivers = sr_driver_list();
-       for (sr_dev_driver **driver = drivers; *driver; driver++) {
-               if (sr_driver_init(_sr_ctx, *driver) != SR_OK) {
-                       throw runtime_error(
-                               string("Failed to initialize driver ") +
-                               string((*driver)->name));
+       auto session_device = dynamic_pointer_cast<SessionDevice>(device);
+
+       if (session_device)
+               return boost::filesystem::path(
+                       session_device->parent()->filename()).filename().string();
+
+       ostringstream s;
+
+       vector<string> parts = {device->vendor(), device->model(),
+               device->version(), device->serial_number()};
+
+       for (size_t i = 0; i < parts.size(); i++)
+       {
+               if (parts[i].length() > 0)
+               {
+                       if (i != 0)
+                               s << " ";
+                       s << parts[i];
                }
        }
-}
 
-void DeviceManager::release_devices()
-{
-       sr_dev_driver **const drivers = sr_driver_list();
-       for (sr_dev_driver **driver = drivers; *driver; driver++)
-               sr_dev_clear(*driver);
-}
+       if (device->serial_number().length() == 0 &&
+                       device->connection_id().length() > 0)
+               s << " " << device->connection_id();
 
-void DeviceManager::scan_all_drivers()
-{
-       // Scan all drivers for all devices.
-       struct sr_dev_driver **const drivers = sr_driver_list();
-       for (struct sr_dev_driver **driver = drivers; *driver; driver++)
-               driver_scan(*driver);
+       return s.str();
 }
 
-bool DeviceManager::compare_devices(const sr_dev_inst *const a,
-       const sr_dev_inst *const b)
+bool DeviceManager::compare_devices(shared_ptr<HardwareDevice> a,
+       shared_ptr<HardwareDevice> b)
 {
-       return format_device_title(a).compare(format_device_title(b)) < 0;
+       assert(a);
+       assert(b);
+
+       return device_description(a).compare(device_description(b)) < 0;
 }
 
 } // namespace pv