feat: Initial WinApiLayer with some methods#15

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 4 commits into from
Apr 22, 2024
Merged

feat: Initial WinApiLayer with some methods #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5edb488
feat: Initial WinApiLayer with some methods
FrogTheFrog Apr 20, 2024
bf7797d
Make sure that test ENV has at least 1 active device
FrogTheFrog Apr 20, 2024
e363ae5
Make linter happy again
FrogTheFrog Apr 20, 2024
f49a393
Address review points
FrogTheFrog Apr 21, 2024
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: 4 additions & 4 deletions src/logging.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
* ```
*/
void
set_log_level(const log_level_e log_level);
set_log_level(log_level_e log_level);

/**
* @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
* ```
*/
[[nodiscard]] bool
is_log_level_enabled(const log_level_e log_level) const;
is_log_level_enabled(log_level_e log_level) const;

/**
* @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
* ```
*/
void
write(const log_level_e log_level, std::string value);
write(log_level_e log_level, std::string value);

/**
* @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
* @brief Constructor scoped writer utility.
* @param log_level Level to be used when writing out the output.
*/
explicit log_writer_t(const logger_t::log_level_e log_level);
explicit log_writer_t(logger_t::log_level_e log_level);

/**
* @brief Write out the accumulated output.
Expand Down
198 changes: 198 additions & 0 deletions src/platf/windows/winapilayer.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
namespace {
/** @brief Dumps the result of @see query_display_config into a string */
std::string
dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
std::ostringstream output;
std::ios state(nullptr);
state.copyfmt(output);

// clang-format off
output << "sourceInfo:" << std::endl;
output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
output << " id: " << info.sourceInfo.id << std::endl;
output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
output.copyfmt(state);
output << "targetInfo:" << std::endl;
output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
output << " id: " << info.targetInfo.id << std::endl;
output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
output.copyfmt(state);
output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
// clang-format on

return output.str();
}

/** @brief Dumps the result of @see query_display_config into a string */
std::string
dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
std::stringstream output;
std::ios state(nullptr);
state.copyfmt(output);

if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
// clang-format off
output << "width: " << info.sourceMode.width << std::endl;
output << "height: " << info.sourceMode.height << std::endl;
output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
// clang-format on
}
else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
// clang-format off
output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
// clang-format on
}
else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
// TODO: One day MinGW will add updated struct definition and the following code can be enabled
// clang-format off
// output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
// output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
// output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
// clang-format on
output << "NOT SUPPORTED BY COMPILER YET...";
}
else {
output << "NOT IMPLEMENTED YET...";
}

return output.str();
}

/** @brief Dumps the result of @see query_display_config into a string */
std::string
dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
std::ostringstream output;

output << std::endl
<< "Got " << paths.size() << " path(s):";
bool path_dumped { false };
for (auto i { 0u }; i < paths.size(); ++i) {
output << std::endl
<< "----------------------------------------[index: " << i << "]" << std::endl;

output << dump_path(paths[i]);
path_dumped = true;
}

if (path_dumped) {
output << std::endl
<< std::endl;
}

output << "Got " << modes.size() << " mode(s):";
for (auto i { 0u }; i < modes.size(); ++i) {
output << std::endl
<< "----------------------------------------[index: " << i << "]" << std::endl;

output << dump_mode(modes[i]);
}

return output.str();
}
} // namespace

std::string
WinApiLayer::get_error_string(LONG error_code) const {
std::ostringstream error;
error << "[code: ";
switch (error_code) {
case ERROR_INVALID_PARAMETER:
error << "ERROR_INVALID_PARAMETER";
break;
case ERROR_NOT_SUPPORTED:
error << "ERROR_NOT_SUPPORTED";
break;
case ERROR_ACCESS_DENIED:
error << "ERROR_ACCESS_DENIED";
break;
case ERROR_INSUFFICIENT_BUFFER:
error << "ERROR_INSUFFICIENT_BUFFER";
break;
case ERROR_GEN_FAILURE:
error << "ERROR_GEN_FAILURE";
break;
case ERROR_SUCCESS:
error << "ERROR_SUCCESS";
break;
default:
error << error_code;
break;
}
error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
return error.str();
}

std::optional<WinApiLayerInterface::path_and_mode_data_t>
WinApiLayer::query_display_config(query_type_e type) const {
std::vector<DISPLAYCONFIG_PATH_INFO> paths;
std::vector<DISPLAYCONFIG_MODE_INFO> modes;
LONG result = ERROR_SUCCESS;

// When we want to enable/disable displays, we need to get all paths as they will not be active.
// This will require some additional filtering of duplicate and otherwise useless paths.
UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

do {
UINT32 path_count { 0 };
UINT32 mode_count { 0 };

result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
if (result != ERROR_SUCCESS) {
DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
return std::nullopt;
}

paths.resize(path_count);
modes.resize(mode_count);
result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

// The function may have returned fewer paths/modes than estimated
paths.resize(path_count);
modes.resize(mode_count);

// It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
// that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
} while (result == ERROR_INSUFFICIENT_BUFFER);

if (result != ERROR_SUCCESS) {
DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
return std::nullopt;
}

DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
<< dump_paths_and_modes(paths, modes) << "\n";
return path_and_mode_data_t { paths, modes };
}

} // namespace display_device
20 changes: 20 additions & 0 deletions src/platf/windows/winapilayer.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
/**
* @brief Default implementation for the WinApiLayerInterface.
*/
class WinApiLayer: public WinApiLayerInterface {
public:
/** For details @see WinApiLayerInterface::get_error_string */
[[nodiscard]] std::string
get_error_string(LONG error_code) const override;

/** For details @see WinApiLayerInterface::query_display_config */
[[nodiscard]] std::optional<path_and_mode_data_t>
query_display_config(query_type_e type) const override;
};
} // namespace display_device
66 changes: 66 additions & 0 deletions src/platf/windows/winapilayerinterface.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
/**
* @brief Lowest level Windows API wrapper for easy mocking.
*/
class WinApiLayerInterface {
public:
/**
* @brief Type of query the OS should perform while searching for display devices.
*/
enum class query_type_e {
Active, /**< The device path must be active. */
All /**< The device path can be active or inactive. */
};

/**
* @brief Contains currently available paths and associated modes.
*/
struct path_and_mode_data_t {
std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
};

/**
* @brief Default virtual destructor.
*/
virtual ~WinApiLayerInterface() = default;

/**
* @brief Stringify the error code from Windows API.
* @param error_code Error code to stringify.
* @returns String containing the error code in a readable format + a system message describing the code.
*
* EXAMPLES:
* ```cpp
* const WinApiLayerInterface* iface = getIface(...);
* const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
* ```
*/
[[nodiscard]] virtual std::string
get_error_string(LONG error_code) const = 0;

/**
* @brief Query Windows for the device paths and associated modes.
* @param type Specify device type to query for.
* @returns Data containing paths and modes, empty optional if we have failed to query.
*
* EXAMPLES:
* ```cpp
* const WinApiLayerInterface* iface = getIface(...);
* const auto display_data = iface->query_display_config(query_type_e::Active);
* ```
*/
[[nodiscard]] virtual std::optional<path_and_mode_data_t>
query_display_config(query_type_e type) const = 0;
};
} // namespace display_device
Loading
, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading

, '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: Initial WinApiLayer with some methods#15

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 4 commits into

from

Apr 22, 2024
 Merged


feat: Initial WinApiLayer with some methods
#15
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5edb488

feat: Initial WinApiLayer with some methods


FrogTheFrog Apr 20, 2024
bf7797d

Make sure that test ENV has at least 1 active device


FrogTheFrog Apr 20, 2024
e363ae5

Make linter happy again


FrogTheFrog Apr 20, 2024
f49a393

Address review points


FrogTheFrog Apr 21, 2024

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: 4 additions & 4 deletions
src/logging.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -56,7 +56,7 @@ namespace display_device {
 * ```
 */
 void
 set_log_level(const log_level_e log_level);
 set_log_level(log_level_e log_level);

 /**
 * @brief Check if log level is currently enabled.
Expand All@@ -69,7 +69,7 @@ namespace display_device {
 * ```
 */
 [[nodiscard]] bool
 is_log_level_enabled(const log_level_e log_level) const;
 is_log_level_enabled(log_level_e log_level) const;

 /**
 * @brief Set custom callback for writing the logs.
Expand All@@ -96,7 +96,7 @@ namespace display_device {
 * ```
 */
 void
 write(const log_level_e log_level, std::string value);
 write(log_level_e log_level, std::string value);

 /**
 * @brief A deleted copy constructor for singleton pattern.
Expand DownExpand Up@@ -130,7 +130,7 @@ namespace display_device {
 * @brief Constructor scoped writer utility.
 * @param log_level Level to be used when writing out the output.
 */
 explicit log_writer_t(const logger_t::log_level_e log_level);
 explicit log_writer_t(logger_t::log_level_e log_level);

 /**
 * @brief Write out the accumulated output.
Expand Down

198 changes: 198 additions & 0 deletions
src/platf/windows/winapilayer.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
// class header include
#include "winapilayer.h"

// system includes
#include <iomanip>

// local includes
#include "src/logging.h"

namespace display_device {
 namespace {
 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_path(const DISPLAYCONFIG_PATH_INFO &info) {
 std::ostringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 // clang-format off
 output << "sourceInfo:" << std::endl;
 output << " adapterId: [" << info.sourceInfo.adapterId.HighPart << ", " << info.sourceInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.sourceInfo.id << std::endl;
 output << " cloneGroupId: " << info.sourceInfo.cloneGroupId << std::endl;
 output << " sourceModeInfoIdx: " << info.sourceInfo.sourceModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.sourceInfo.modeInfoIdx << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.sourceInfo.statusFlags << std::endl;
 output.copyfmt(state);
 output << "targetInfo:" << std::endl;
 output << " adapterId: [" << info.targetInfo.adapterId.HighPart << ", " << info.targetInfo.adapterId.LowPart << "]" << std::endl;
 output << " id: " << info.targetInfo.id << std::endl;
 output << " desktopModeInfoIdx: " << info.targetInfo.desktopModeInfoIdx << std::endl;
 output << " targetModeInfoIdx: " << info.targetInfo.targetModeInfoIdx << std::endl;
 output << " modeInfoIdx: " << info.targetInfo.modeInfoIdx << std::endl;
 output << " outputTechnology: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.outputTechnology << std::endl;
 output << " rotation: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.rotation << std::endl;
 output << " scaling: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scaling << std::endl;
 output.copyfmt(state);
 output << " refreshRate: " << info.targetInfo.refreshRate.Numerator << "/" << info.targetInfo.refreshRate.Denominator << std::endl;
 output << " scanLineOrdering: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.scanLineOrdering << std::endl;
 output << " targetAvailable: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.targetAvailable << std::endl;
 output << " statusFlags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.targetInfo.statusFlags << std::endl;
 output << "flags: 0x" << std::uppercase << std::setfill('0') << std::setw(8) << std::hex << info.flags;
 // clang-format on

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_mode(const DISPLAYCONFIG_MODE_INFO &info) {
 std::stringstream output;
 std::ios state(nullptr);
 state.copyfmt(output);

 if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_SOURCE) {
 // clang-format off
 output << "width: " << info.sourceMode.width << std::endl;
 output << "height: " << info.sourceMode.height << std::endl;
 output << "pixelFormat: " << info.sourceMode.pixelFormat << std::endl;
 output << "position: [" << info.sourceMode.position.x << ", " << info.sourceMode.position.y << "]";
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_TARGET) {
 // clang-format off
 output << "pixelRate: " << info.targetMode.targetVideoSignalInfo.pixelRate << std::endl;
 output << "hSyncFreq: " << info.targetMode.targetVideoSignalInfo.hSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.hSyncFreq.Denominator << std::endl;
 output << "vSyncFreq: " << info.targetMode.targetVideoSignalInfo.vSyncFreq.Numerator << "/" << info.targetMode.targetVideoSignalInfo.vSyncFreq.Denominator << std::endl;
 output << "activeSize: [" << info.targetMode.targetVideoSignalInfo.activeSize.cx << ", " << info.targetMode.targetVideoSignalInfo.activeSize.cy << "]" << std::endl;
 output << "totalSize: [" << info.targetMode.targetVideoSignalInfo.totalSize.cx << ", " << info.targetMode.targetVideoSignalInfo.totalSize.cy << "]" << std::endl;
 output << "videoStandard: " << info.targetMode.targetVideoSignalInfo.videoStandard << std::endl;
 output << "scanLineOrdering: " << info.targetMode.targetVideoSignalInfo.scanLineOrdering;
 // clang-format on
 }
 else if (info.infoType == DISPLAYCONFIG_MODE_INFO_TYPE_DESKTOP_IMAGE) {
 // TODO: One day MinGW will add updated struct definition and the following code can be enabled
 // clang-format off
 // output << "PathSourceSize: [" << info.desktopImageInfo.PathSourceSize.x << ", " << info.desktopImageInfo.PathSourceSize.y << "]" << std::endl;
 // output << "DesktopImageRegion: [" << info.desktopImageInfo.DesktopImageRegion.bottom << ", " << info.desktopImageInfo.DesktopImageRegion.left << ", " << info.desktopImageInfo.DesktopImageRegion.right << ", " << info.desktopImageInfo.DesktopImageRegion.top << "]" << std::endl;
 // output << "DesktopImageClip: [" << info.desktopImageInfo.DesktopImageClip.bottom << ", " << info.desktopImageInfo.DesktopImageClip.left << ", " << info.desktopImageInfo.DesktopImageClip.right << ", " << info.desktopImageInfo.DesktopImageClip.top << "]";
 // clang-format on
 output << "NOT SUPPORTED BY COMPILER YET...";
 }
 else {
 output << "NOT IMPLEMENTED YET...";
 }

 return output.str();
 }

 /** @brief Dumps the result of @see query_display_config into a string */
 std::string
 dump_paths_and_modes(const std::vector<DISPLAYCONFIG_PATH_INFO> &paths,
 const std::vector<DISPLAYCONFIG_MODE_INFO> &modes) {
 std::ostringstream output;

 output << std::endl
 << "Got " << paths.size() << " path(s):";
 bool path_dumped { false };
 for (auto i { 0u }; i < paths.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_path(paths[i]);
 path_dumped = true;
 }

 if (path_dumped) {
 output << std::endl
 << std::endl;
 }

 output << "Got " << modes.size() << " mode(s):";
 for (auto i { 0u }; i < modes.size(); ++i) {
 output << std::endl
 << "----------------------------------------[index: " << i << "]" << std::endl;

 output << dump_mode(modes[i]);
 }

 return output.str();
 }
 } // namespace

 std::string
 WinApiLayer::get_error_string(LONG error_code) const {
 std::ostringstream error;
 error << "[code: ";
 switch (error_code) {
 case ERROR_INVALID_PARAMETER:
 error << "ERROR_INVALID_PARAMETER";
 break;
 case ERROR_NOT_SUPPORTED:
 error << "ERROR_NOT_SUPPORTED";
 break;
 case ERROR_ACCESS_DENIED:
 error << "ERROR_ACCESS_DENIED";
 break;
 case ERROR_INSUFFICIENT_BUFFER:
 error << "ERROR_INSUFFICIENT_BUFFER";
 break;
 case ERROR_GEN_FAILURE:
 error << "ERROR_GEN_FAILURE";
 break;
 case ERROR_SUCCESS:
 error << "ERROR_SUCCESS";
 break;
 default:
 error << error_code;
 break;
 }
 error << ", message: " << std::system_category().message(static_cast<int>(error_code)) << "]";
 return error.str();
 }

 std::optional<WinApiLayerInterface::path_and_mode_data_t>
 WinApiLayer::query_display_config(query_type_e type) const {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths;
 std::vector<DISPLAYCONFIG_MODE_INFO> modes;
 LONG result = ERROR_SUCCESS;

 // When we want to enable/disable displays, we need to get all paths as they will not be active.
 // This will require some additional filtering of duplicate and otherwise useless paths.
 UINT32 flags = type == query_type_e::Active ? QDC_ONLY_ACTIVE_PATHS : QDC_ALL_PATHS;
 flags |= QDC_VIRTUAL_MODE_AWARE; // supported from W10 onwards

 do {
 UINT32 path_count { 0 };
 UINT32 mode_count { 0 };

 result = GetDisplayConfigBufferSizes(flags, &path_count, &mode_count);
 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to get display paths and modes!";
 return std::nullopt;
 }

 paths.resize(path_count);
 modes.resize(mode_count);
 result = QueryDisplayConfig(flags, &path_count, paths.data(), &mode_count, modes.data(), nullptr);

 // The function may have returned fewer paths/modes than estimated
 paths.resize(path_count);
 modes.resize(mode_count);

 // It's possible that between the call to GetDisplayConfigBufferSizes and QueryDisplayConfig
 // that the display state changed, so loop on the case of ERROR_INSUFFICIENT_BUFFER.
 } while (result == ERROR_INSUFFICIENT_BUFFER);

 if (result != ERROR_SUCCESS) {
 DD_LOG(error) << get_error_string(result) << " failed to query display paths and modes!";
 return std::nullopt;
 }

 DD_LOG(verbose) << "Result of " << (type == query_type_e::Active ? "ACTIVE" : "ALL") << " display config query:\n"
 << dump_paths_and_modes(paths, modes) << "\n";
 return path_and_mode_data_t { paths, modes };
 }

} // namespace display_device

20 changes: 20 additions & 0 deletions
src/platf/windows/winapilayer.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
#pragma once

// local includes
#include "winapilayerinterface.h"

namespace display_device {
 /**
 * @brief Default implementation for the WinApiLayerInterface.
 */
 class WinApiLayer: public WinApiLayerInterface {
 public:
 /** For details @see WinApiLayerInterface::get_error_string */
 [[nodiscard]] std::string
 get_error_string(LONG error_code) const override;

 /** For details @see WinApiLayerInterface::query_display_config */
 [[nodiscard]] std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const override;
 };
} // namespace display_device

66 changes: 66 additions & 0 deletions
src/platf/windows/winapilayerinterface.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
#pragma once

// the most stupid and smelly windows include
#include <windows.h>

// system includes
#include <optional>
#include <string>
#include <vector>

namespace display_device {
 /**
 * @brief Lowest level Windows API wrapper for easy mocking.
 */
 class WinApiLayerInterface {
 public:
 /**
 * @brief Type of query the OS should perform while searching for display devices.
 */
 enum class query_type_e {
 Active, /**< The device path must be active. */
 All /**< The device path can be active or inactive. */
 };

 /**
 * @brief Contains currently available paths and associated modes.
 */
 struct path_and_mode_data_t {
 std::vector<DISPLAYCONFIG_PATH_INFO> paths; /**< Available display paths. */
 std::vector<DISPLAYCONFIG_MODE_INFO> modes; /**< Display modes for ACTIVE displays. */
 };

 /**
 * @brief Default virtual destructor.
 */
 virtual ~WinApiLayerInterface() = default;

 /**
 * @brief Stringify the error code from Windows API.
 * @param error_code Error code to stringify.
 * @returns String containing the error code in a readable format + a system message describing the code.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const std::string error_message = iface->get_error_string(ERROR_NOT_SUPPORTED);
 * ```
 */
 [[nodiscard]] virtual std::string
 get_error_string(LONG error_code) const = 0;

 /**
 * @brief Query Windows for the device paths and associated modes.
 * @param type Specify device type to query for.
 * @returns Data containing paths and modes, empty optional if we have failed to query.
 *
 * EXAMPLES:
 * ```cpp
 * const WinApiLayerInterface* iface = getIface(...);
 * const auto display_data = iface->query_display_config(query_type_e::Active);
 * ```
 */
 [[nodiscard]] virtual std::optional<path_and_mode_data_t>
 query_display_config(query_type_e type) const = 0;
 };
} // namespace display_device
Loading