]> sigrok.org Git - pulseview.git/blobdiff - pv/devicemanager.cpp
devices::Device: Moved in full_name and display_name
[pulseview.git] / pv / devicemanager.cpp
index 5a72b31b78563c73e3053e107d14b112c9e040b0..36d6fb6a44f1d0c10ae05a234503e5347122a85c 100644 (file)
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include "devicemanager.h"
+#include "devicemanager.hpp"
+#include "session.hpp"
 
 #include <cassert>
-#include <sstream>
 #include <stdexcept>
+#include <sstream>
 #include <string>
+#include <vector>
+
+#include <libsigrokcxx/libsigrokcxx.hpp>
+
+#include <boost/algorithm/string/join.hpp>
+#include <boost/filesystem.hpp>
+
+#include <pv/devices/hardwaredevice.hpp>
+
+using boost::algorithm::join;
 
-#include <libsigrok/libsigrok.h>
+using std::dynamic_pointer_cast;
+using std::list;
+using std::map;
+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::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
+const std::shared_ptr<sigrok::Context>& DeviceManager::context() const
 {
-       return _devices;
+       return context_;
 }
 
-list<sr_dev_inst*> DeviceManager::driver_scan(
-       struct sr_dev_driver *const driver, GSList *const drvopts)
+shared_ptr<Context> DeviceManager::context()
 {
-       list<sr_dev_inst*> driver_devices;
+       return context_;
+}
+
+const list< shared_ptr<devices::HardwareDevice> >&
+DeviceManager::devices() const
+{
+       return devices_;
+}
+
+list< shared_ptr<devices::HardwareDevice> >
+DeviceManager::driver_scan(
+       shared_ptr<Driver> driver, map<const ConfigKey *, VariantBase> drvopts)
+{
+       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.
-       list<sr_dev_inst*>::iterator i = _devices.begin();
-       while (i != _devices.end()) {
-               if ((*i)->driver == driver)
-                       i = _devices.erase(i);
-               else
-                       i++;
+       devices_.remove_if([&](shared_ptr<devices::HardwareDevice> device) {
+               return device->hardware_device()->driver() == driver; });
+
+       // Do the scan
+       auto devices = driver->scan(drvopts);
+
+       // 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);
        }
 
-       // Clear all the old device instances from this driver
-       sr_dev_clear(driver);
+       for (shared_ptr<devices::HardwareDevice> device : driver_devices)
+               build_display_name(device);
 
-       // 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);
-       driver_devices.sort(compare_devices);
-
-       // Add the scanned devices to the main list
-       _devices.insert(_devices.end(), driver_devices.begin(),
+       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;
 }
 
-string DeviceManager::format_device_title(const sr_dev_inst *const sdi)
+const map<string, string> DeviceManager::get_device_info(
+       shared_ptr<devices::Device> device)
+{
+       map<string, string> result;
+
+       assert(device);
+
+       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<devices::HardwareDevice> DeviceManager::find_device_from_info(
+       const map<string, string> search_info)
 {
-       ostringstream s;
+       shared_ptr<devices::HardwareDevice> last_resort_dev;
+       map<string, string> dev_info;
+
+       for (shared_ptr<devices::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;
 
-       assert(sdi);
+               // 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;
 
-       if (sdi->vendor && sdi->vendor[0]) {
-               s << sdi->vendor;
-               if ((sdi->model && sdi->model[0]) ||
-                       (sdi->version && sdi->version[0]))
-                       s << ' ';
+               // 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->model && sdi->model[0]) {
-               s << sdi->model;
-               if (sdi->version && sdi->version[0])
-                       s << ' ';
+       // 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::build_display_name(shared_ptr<devices::Device> 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) {
+               full_names_[device] = display_names_[device] =
+                       boost::filesystem::path(
+                       session_device->parent()->filename()).filename().string();
+               return;
        }
 
-       if (sdi->version && sdi->version[0])
-               s << sdi->version;
+       // 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()};
 
-       return s.str();
+       if (sr_dev->connection_id().length() > 0)
+               parts.push_back("("+sr_dev->connection_id()+")");
+
+       full_names_[device] = join(parts, " ");
+
+       // Next, build the display name. It only contains fields as required.
+
+       // 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()+")");
+       }
+
+       display_names_[device] = join(parts, " ");
 }
 
-void DeviceManager::init_drivers()
+const std::string DeviceManager::get_display_name(
+       std::shared_ptr<devices::Device> dev)
 {
-       // 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));
-               }
-       }
+       return display_names_[dev];
 }
 
-void DeviceManager::release_devices()
+const std::string DeviceManager::get_full_name(
+       std::shared_ptr<devices::Device> dev)
 {
-       sr_dev_driver **const drivers = sr_driver_list();
-       for (sr_dev_driver **driver = drivers; *driver; driver++)
-               sr_dev_clear(*driver);
+       return full_names_[dev];
 }
 
-void DeviceManager::scan_all_drivers()
+void DeviceManager::update_display_name(
+       std::shared_ptr<devices::Device> dev)
 {
-       // 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);
+       build_display_name(dev);
 }
 
-bool DeviceManager::compare_devices(const sr_dev_inst *const a,
-       const sr_dev_inst *const b)
+bool DeviceManager::compare_devices(
+       shared_ptr<devices::Device> a, shared_ptr<devices::Device> b)
 {
-       return format_device_title(a).compare(format_device_title(b)) < 0;
+       assert(a);
+       assert(b);
+
+       return display_names_[a].compare(display_names_[b]) < 0;
 }
 
 } // namespace pv