feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReenigneArcher merged 1 commit into from
Jun 10, 2024
Merged

feat: add methods for getting API status and getting display name from ID #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/windows/include/displaydevice/windows/windisplaydevice.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
*/
explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

/** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
[[nodiscard]] bool
isApiAccessAvailable() const override;

/** For details @see WinDisplayDeviceInterface::getDisplayName */
[[nodiscard]] std::string
getDisplayName(const std::string &device_id) const override;

/** For details @see WinDisplayDeviceInterface::getCurrentTopology */
[[nodiscard]] ActiveTopology
getCurrentTopology() const override;
Expand Down
29 changes: 29 additions & 0 deletions src/windows/include/displaydevice/windows/windisplaydeviceinterface.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
*/
virtual ~WinDisplayDeviceInterface() = default;

/**
* @brief Check if the API for changing display settings is accessible.
* @returns True if display settings can be changed, false otherwise.
*
* EXAMPLES:
* ```cpp
* const WinDisplayDeviceInterface* iface = getIface(...);
* const bool have_access { iface->isApiAccessAvailable() };
* ```
*/
[[nodiscard]] virtual bool
isApiAccessAvailable() const = 0;

/**
* @brief Get display name associated with the device.
* @param device_id A device to get display name for.
* @returns A display name for the device, or an empty string if the device is inactive or not found.
* Empty string can also be returned if an error has occurred.
*
* EXAMPLES:
* ```cpp
* const std::string device_name { "MY_DEVICE_ID" };
* const WinDisplayDeviceInterface* iface = getIface(...);
* const std::string display_name = iface->getDisplayName(device_id);
* ```
*/
[[nodiscard]] virtual std::string
getDisplayName(const std::string &device_id) const = 0;

/**
* @brief Get the active (current) topology.
* @returns A list representing the current topology.
Expand Down
51 changes: 51 additions & 0 deletions src/windows/windisplaydevicegeneral.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
m_w_api { std::move(w_api) } {
if (!m_w_api) {
throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
}
}

bool
WinDisplayDevice::isApiAccessAvailable() const {
const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
if (!display_data) {
DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
return false;
}

// Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
// Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
// provided by Windows.
const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
return result == ERROR_SUCCESS;
}

std::string
WinDisplayDevice::getDisplayName(const std::string &device_id) const {
if (device_id.empty()) {
// Valid return, no error
return {};
}

const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
if (!display_data) {
// Error already logged
return {};
}

const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
if (!path) {
// Debug level, because inactive device is valid case for this function
DD_LOG(debug) << "Failed to find device for " << device_id << "!";
return {};
}

const auto display_name { m_w_api->getDisplayName(*path) };
if (display_name.empty()) {
// Theoretically possible due to some race condition in the OS...
DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
}

return display_name;
}
} // namespace display_device
146 changes: 141 additions & 5 deletions tests/unit/windows/test_windisplaydevicegeneral.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
// Convenience keywords for GMock
using ::testing::_;
using ::testing::HasSubstr;
using ::testing::Return;
using ::testing::StrictMock;

// Test fixture(s) for this file
class WinDisplayDeviceGeneral: public BaseTest {
public:
std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
display_device::WinDisplayDevice m_win_dd { m_layer };
};

class WinDisplayDeviceGeneralMocked: public BaseTest {
public:
std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
display_device::WinDisplayDevice m_win_dd { m_layer };
};

// Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

// Additional convenience global const(s)
const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
// There is no real way to make it return false without logging out or do something complicated :/
EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
.Times(1)
.WillOnce(Return(ut_consts::PAM_3_ACTIVE));
EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
.Times(1)
.WillOnce(Return(ERROR_SUCCESS));
EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
.Times(1)
.WillRepeatedly(Return("ErrorDesc"));

EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
.Times(1)
.WillOnce(Return(ut_consts::PAM_NULL));

EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
.Times(1)
.WillOnce(Return(ut_consts::PAM_3_ACTIVE));
EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
.Times(1)
.WillOnce(Return(ERROR_ACCESS_DENIED));
EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
.Times(1)
.WillRepeatedly(Return("ErrorDesc"));

EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
ASSERT_TRUE(all_devices);

for (const auto &path : all_devices->m_paths) {
const auto device_id { m_layer->getDeviceId(path) };
const auto display_name { m_win_dd.getDisplayName(device_id) };
const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

if (&path == active_path) {
EXPECT_EQ(display_name, m_layer->getDisplayName(path));
}
else {
EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
}
}
}

TEST_F_S_MOCKED(GetDisplayName) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
.Times(1)
.WillOnce(Return(ut_consts::PAM_3_ACTIVE));
EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
.Times(1)
.WillOnce(Return("PathX"));
EXPECT_CALL(*m_layer, getDeviceId(_))
.Times(1)
.WillOnce(Return("DeviceId1"));
EXPECT_CALL(*m_layer, getDisplayName(_))
.Times(2)
.WillOnce(Return("DisplayName1"))
.WillOnce(Return("DisplayName1"));

EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
.Times(1)
.WillOnce(Return(ut_consts::PAM_NULL));

EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
.Times(1)
.WillOnce(Return(ut_consts::PAM_EMPTY));

EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
.Times(1)
.WillOnce(Return(ut_consts::PAM_3_ACTIVE));
EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
.Times(1)
.WillOnce(Return("PathX"));
EXPECT_CALL(*m_layer, getDeviceId(_))
.Times(1)
.WillOnce(Return("DeviceId1"));
EXPECT_CALL(*m_layer, getDisplayName(_))
.Times(2)
.WillOnce(Return("DisplayName1"))
.WillOnce(Return(""));

EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: add methods for getting API status and getting display name from ID#46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ReenigneArcher
merged 1 commit into

from

Jun 10, 2024
 Merged


feat: add methods for getting API status and getting display name from ID
#46
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydevice.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,14 @@ namespace display_device {
 */
 explicit WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api);

 /** For details @see WinDisplayDeviceInterface::isApiAccessAvailable */
 [[nodiscard]] bool
 isApiAccessAvailable() const override;

 /** For details @see WinDisplayDeviceInterface::getDisplayName */
 [[nodiscard]] std::string
 getDisplayName(const std::string &device_id) const override;

 /** For details @see WinDisplayDeviceInterface::getCurrentTopology */
 [[nodiscard]] ActiveTopology
 getCurrentTopology() const override;
Expand Down

29 changes: 29 additions & 0 deletions
src/windows/include/displaydevice/windows/windisplaydeviceinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,35 @@ namespace display_device {
 */
 virtual ~WinDisplayDeviceInterface() = default;

 /**
 * @brief Check if the API for changing display settings is accessible.
 * @returns True if display settings can be changed, false otherwise.
 *
 * EXAMPLES:
 * ```cpp
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const bool have_access { iface->isApiAccessAvailable() };
 * ```
 */
 [[nodiscard]] virtual bool
 isApiAccessAvailable() const = 0;

 /**
 * @brief Get display name associated with the device.
 * @param device_id A device to get display name for.
 * @returns A display name for the device, or an empty string if the device is inactive or not found.
 * Empty string can also be returned if an error has occurred.
 *
 * EXAMPLES:
 * ```cpp
 * const std::string device_name { "MY_DEVICE_ID" };
 * const WinDisplayDeviceInterface* iface = getIface(...);
 * const std::string display_name = iface->getDisplayName(device_id);
 * ```
 */
 [[nodiscard]] virtual std::string
 getDisplayName(const std::string &device_id) const = 0;

 /**
 * @brief Get the active (current) topology.
 * @returns A list representing the current topology.
Expand Down

51 changes: 51 additions & 0 deletions
src/windows/windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,62 @@
// system includes
#include <stdexcept>

// local includes
#include "displaydevice/logging.h"
#include "displaydevice/windows/winapiutils.h"

namespace display_device {
 WinDisplayDevice::WinDisplayDevice(std::shared_ptr<WinApiLayerInterface> w_api):
 m_w_api { std::move(w_api) } {
 if (!m_w_api) {
 throw std::logic_error { "Nullptr provided for WinApiLayerInterface in WinDisplayDevice!" };
 }
 }

 bool
 WinDisplayDevice::isApiAccessAvailable() const {
 const auto display_data { m_w_api->queryDisplayConfig(QueryType::All) };
 if (!display_data) {
 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable failed while querying display data.";
 return false;
 }

 // Here we are supplying the retrieved display data back to SetDisplayConfig (with VALIDATE flag only, so that we make no actual changes).
 // Unless something is really broken on Windows, this call should never fail under normal circumstances - the configuration is 100% correct, since it was
 // provided by Windows.
 const UINT32 flags { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
 const LONG result { m_w_api->setDisplayConfig(display_data->m_paths, display_data->m_modes, flags) };

 DD_LOG(debug) << "WinDisplayDevice::isApiAccessAvailable result: " << m_w_api->getErrorString(result);
 return result == ERROR_SUCCESS;
 }

 std::string
 WinDisplayDevice::getDisplayName(const std::string &device_id) const {
 if (device_id.empty()) {
 // Valid return, no error
 return {};
 }

 const auto display_data { m_w_api->queryDisplayConfig(QueryType::Active) };
 if (!display_data) {
 // Error already logged
 return {};
 }

 const auto path { win_utils::getActivePath(*m_w_api, device_id, display_data->m_paths) };
 if (!path) {
 // Debug level, because inactive device is valid case for this function
 DD_LOG(debug) << "Failed to find device for " << device_id << "!";
 return {};
 }

 const auto display_name { m_w_api->getDisplayName(*path) };
 if (display_name.empty()) {
 // Theoretically possible due to some race condition in the OS...
 DD_LOG(error) << "Device " << device_id << " has no display name assigned.";
 }

 return display_name;
 }
} // namespace display_device

146 changes: 141 additions & 5 deletions
tests/unit/windows/test_windisplaydevicegeneral.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,19 +1,155 @@
// system includes
#include <gmock/gmock.h>

// local includes
#include "displaydevice/windows/winapilayer.h"
#include "displaydevice/windows/winapiutils.h"
#include "displaydevice/windows/windisplaydevice.h"
#include "fixtures.h"
#include "utils/comparison.h"
#include "utils/mockwinapilayer.h"

namespace {
 // Convenience keywords for GMock
 using ::testing::_;
 using ::testing::HasSubstr;
 using ::testing::Return;
 using ::testing::StrictMock;

 // Test fixture(s) for this file
 class WinDisplayDeviceGeneral: public BaseTest {
 public:
 std::shared_ptr<display_device::WinApiLayer> m_layer { std::make_shared<display_device::WinApiLayer>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 class WinDisplayDeviceGeneralMocked: public BaseTest {
 public:
 std::shared_ptr<StrictMock<display_device::MockWinApiLayer>> m_layer { std::make_shared<StrictMock<display_device::MockWinApiLayer>>() };
 display_device::WinDisplayDevice m_win_dd { m_layer };
 };

 // Specialized TEST macro(s) for this test file
#define TEST_S(...) DD_MAKE_TEST(TEST, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneral, __VA_ARGS__)
#define TEST_F_S_MOCKED(...) DD_MAKE_TEST(TEST_F, WinDisplayDeviceGeneralMocked, __VA_ARGS__)

 // Additional convenience global const(s)
 const UINT32 FLAGS { SDC_VALIDATE | SDC_USE_SUPPLIED_DISPLAY_CONFIG | SDC_VIRTUAL_MODE_AWARE };
} // namespace

TEST_S(NullptrLayerProvided) {
TEST_F_S(NullptrLayerProvided) {
 EXPECT_THAT([]() { const auto win_dd { display_device::WinDisplayDevice { nullptr } }; },
 ThrowsMessage<std::logic_error>(HasSubstr("Nullptr provided for WinApiLayerInterface in WinDisplayDevice!")));
}

TEST_F_S(IsApiAccessAvailable) {
 // There is no real way to make it return false without logging out or do something complicated :/
 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_SUCCESS));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_SUCCESS))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_TRUE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S_MOCKED(IsApiAccessAvailable, FailedToSetDisplayConfig) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::All))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, setDisplayConfig(ut_consts::PAM_3_ACTIVE->m_paths, ut_consts::PAM_3_ACTIVE->m_modes, FLAGS))
 .Times(1)
 .WillOnce(Return(ERROR_ACCESS_DENIED));
 EXPECT_CALL(*m_layer, getErrorString(ERROR_ACCESS_DENIED))
 .Times(1)
 .WillRepeatedly(Return("ErrorDesc"));

 EXPECT_FALSE(m_win_dd.isApiAccessAvailable());
}

TEST_F_S(GetDisplayName) {
 const auto all_devices { m_layer->queryDisplayConfig(display_device::QueryType::All) };
 ASSERT_TRUE(all_devices);

 for (const auto &path : all_devices->m_paths) {
 const auto device_id { m_layer->getDeviceId(path) };
 const auto display_name { m_win_dd.getDisplayName(device_id) };
 const auto active_path { display_device::win_utils::getActivePath(*m_layer, device_id, all_devices->m_paths) };

 if (&path == active_path) {
 EXPECT_EQ(display_name, m_layer->getDisplayName(path));
 }
 else {
 EXPECT_EQ(display_name, active_path ? m_layer->getDisplayName(*active_path) : std::string {});
 }
 }
}

TEST_F_S_MOCKED(GetDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return("DisplayName1"));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), "DisplayName1");
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDeviceId) {
 EXPECT_EQ(m_win_dd.getDisplayName(""), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetDisplayData) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_NULL));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, FailedToGetActivePath) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_EMPTY));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}

TEST_F_S_MOCKED(GetDisplayName, EmptyDisplayName) {
 EXPECT_CALL(*m_layer, queryDisplayConfig(display_device::QueryType::Active))
 .Times(1)
 .WillOnce(Return(ut_consts::PAM_3_ACTIVE));
 EXPECT_CALL(*m_layer, getMonitorDevicePath(_))
 .Times(1)
 .WillOnce(Return("PathX"));
 EXPECT_CALL(*m_layer, getDeviceId(_))
 .Times(1)
 .WillOnce(Return("DeviceId1"));
 EXPECT_CALL(*m_layer, getDisplayName(_))
 .Times(2)
 .WillOnce(Return("DisplayName1"))
 .WillOnce(Return(""));

 EXPECT_EQ(m_win_dd.getDisplayName("DeviceId1"), std::string {});
}