From b485408f20c39ae8d05372a5faffe15653c74705 Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@airwebreathe.org.uk>
Date: Fri, 3 Apr 2015 11:35:49 +0100
Subject: [PATCH 1/1] devices::Device: Moved in full_name and display_name

---
 pv/devices/device.hpp         | 18 ++++++++++++-
 pv/devices/hardwaredevice.cpp | 50 +++++++++++++++++++++++++++++++++++
 pv/devices/hardwaredevice.hpp | 12 +++++++++
 pv/devices/sessionfile.cpp    | 10 +++++++
 pv/devices/sessionfile.hpp    | 10 +++++++
 5 files changed, 99 insertions(+), 1 deletion(-)

diff --git a/pv/devices/device.hpp b/pv/devices/device.hpp
index 529fdd5b..7e0b58ad 100644
--- a/pv/devices/device.hpp
+++ b/pv/devices/device.hpp
@@ -22,7 +22,7 @@
 #define PULSEVIEW_PV_DEVICES_DEVICE_HPP
 
 #include <memory>
-
+#include <string>
 
 namespace sigrok {
 class Device;
@@ -30,6 +30,9 @@ class Session;
 } // namespace sigrok
 
 namespace pv {
+
+class DeviceManager;
+
 namespace devices {
 
 class Device
@@ -44,6 +47,19 @@ public:
 
 	std::shared_ptr<sigrok::Device> device() const;
 
+	/**
+	 * Builds the full name. It only contains all the fields.
+	 */
+	virtual std::string full_name() const = 0;
+
+	/**
+	 * Builds the display name. It only contains fields as required.
+	 * @param device_manager a reference to the device manager is needed
+	 * so that other similarly titled devices can be detected.
+	 */
+	virtual std::string display_name(
+		const DeviceManager &device_manager) const = 0;
+
 	virtual void create() = 0;
 
 	virtual void run();
diff --git a/pv/devices/hardwaredevice.cpp b/pv/devices/hardwaredevice.cpp
index 4fa27f6d..6374dafe 100644
--- a/pv/devices/hardwaredevice.cpp
+++ b/pv/devices/hardwaredevice.cpp
@@ -18,14 +18,25 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+#include <boost/algorithm/string/join.hpp>
+
 #include <QString>
 
 #include <libsigrokcxx/libsigrokcxx.hpp>
 
+#include <pv/devicemanager.hpp>
+
 #include "hardwaredevice.hpp"
 
+using std::dynamic_pointer_cast;
 using std::shared_ptr;
 using std::static_pointer_cast;
+using std::string;
+using std::vector;
+
+using boost::algorithm::join;
+
+using sigrok::HardwareDevice;
 
 namespace pv {
 namespace devices {
@@ -42,10 +53,49 @@ HardwareDevice::~HardwareDevice() {
 		session_->remove_devices();
 }
 
+string HardwareDevice::full_name() const {
+	vector<string> parts = {device_->vendor(), device_->model(),
+		device_->version(), device_->serial_number()};
+	if (device_->connection_id().length() > 0)
+		parts.push_back("(" + device_->connection_id() + ")");
+	return join(parts, " ");
+}
+
 shared_ptr<sigrok::HardwareDevice> HardwareDevice::hardware_device() const {
 	return static_pointer_cast<sigrok::HardwareDevice>(device_);
 }
 
+string HardwareDevice::display_name(
+	const DeviceManager &device_manager) const {
+	const auto hw_dev = hardware_device();
+
+	// 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 auto &devices = device_manager.devices();
+	const bool multiple_dev = hw_dev && any_of(
+		devices.begin(), devices.end(),
+		[&](shared_ptr<devices::HardwareDevice> dev) {
+			return dev->hardware_device()->vendor() ==
+					hw_dev->vendor() &&
+				dev->hardware_device()->model() ==
+					hw_dev->model() &&
+				dev->device_ != device_;
+		});
+
+	vector<string> parts = {device_->vendor(), device_->model()};
+
+	if (multiple_dev) {
+		parts.push_back(device_->version());
+		parts.push_back(device_->serial_number());
+
+		if ((device_->serial_number().length() == 0) &&
+			(device_->connection_id().length() > 0))
+			parts.push_back("(" + device_->connection_id() + ")");
+	}
+
+	return join(parts, " ");
+}
+
 void HardwareDevice::create() {
 	// Open the device
         try {
diff --git a/pv/devices/hardwaredevice.hpp b/pv/devices/hardwaredevice.hpp
index 41d79068..9f052d7e 100644
--- a/pv/devices/hardwaredevice.hpp
+++ b/pv/devices/hardwaredevice.hpp
@@ -41,6 +41,18 @@ public:
 
 	std::shared_ptr<sigrok::HardwareDevice> hardware_device() const;
 
+	/**
+	 * Builds the full name. It only contains all the fields.
+	 */
+	std::string full_name() const;
+
+	/**
+	 * Builds the display name. It only contains fields as required.
+	 * @param device_manager a reference to the device manager is needed
+	 * so that other similarly titled devices can be detected.
+	 */
+	std::string display_name(const DeviceManager &device_manager) const;
+
 	void create();
 
 private:
diff --git a/pv/devices/sessionfile.cpp b/pv/devices/sessionfile.cpp
index 4ca982ae..687c52bd 100644
--- a/pv/devices/sessionfile.cpp
+++ b/pv/devices/sessionfile.cpp
@@ -20,6 +20,8 @@
 
 #include <libsigrokcxx/libsigrokcxx.hpp>
 
+#include <boost/filesystem.hpp>
+
 #include "sessionfile.hpp"
 
 namespace pv {
@@ -31,6 +33,14 @@ SessionFile::SessionFile(const std::shared_ptr<sigrok::Context> &context,
 	file_name_(file_name) {
 }
 
+std::string SessionFile::full_name() const {
+	return boost::filesystem::path(file_name_).filename().string();
+}
+
+std::string SessionFile::display_name(const DeviceManager&) const {
+	return SessionFile::full_name();
+}
+
 void SessionFile::create() {
 	session_ = context_->load_session(file_name_);
 	device_ = session_->devices()[0];
diff --git a/pv/devices/sessionfile.hpp b/pv/devices/sessionfile.hpp
index 0fcaa34c..a4b69d3e 100644
--- a/pv/devices/sessionfile.hpp
+++ b/pv/devices/sessionfile.hpp
@@ -39,6 +39,16 @@ public:
 	SessionFile(const std::shared_ptr<sigrok::Context> &context,
 		const std::string &file_name);
 
+	/**
+	 * Builds the full name. It only contains all the fields.
+	 */
+	std::string full_name() const;
+
+	/**
+	 * Builds the display name. It only contains fields as required.
+	 */
+	std::string display_name(const DeviceManager&) const;
+
 	void create();
 
 private:
-- 
2.30.2