mir/PowerToys
2
0
Fork 0
mirror of https://github.com/microsoft/PowerToys synced 2025-09-05 08:55:13 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

PowerToy project template update (#934)

Browse Source 
* Add PowerToy project template to the PowerToys solution
* Update PowerToy project template and create a separate solution for it
This commit is contained in:
yuyoyuppe
2019-12-16 13:12:36 +03:00
committed by GitHub
parent 7efe6f1d53
commit 7e91121a33
10 changed files with 392 additions and 334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
tools/project_template/ModuleTemplate/$projectname$.rc Normal file
View File

11
tools/project_template/ModuleTemplate/ModuleTemplate.vcxproj
View File

@@ -12,7 +12,7 @@
</ItemGroup>
<PropertyGroup Label="Globals">
<VCProjectVersion>15.0</VCProjectVersion>
<ProjectGuid>{44CC9375-3E6E-4D99-8913-7FB748807EBD}</ProjectGuid>
<ProjectGuid>{64A80062-4D8B-4229-8A38-DFA1D7497749}</ProjectGuid>
<Keyword>Win32Proj</Keyword>
<RootNamespace>templatenamespace</RootNamespace>
<WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
@@ -61,7 +61,6 @@
<PreprocessorDefinitions>_DEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>..\..\common\inc;..\..\common\Telemetry;..\;..\..\;..\..\..\deps\cpprestsdk\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
<LanguageStandard>stdcpplatest</LanguageStandard>
</ClCompile>
@@ -82,7 +81,6 @@
<PreprocessorDefinitions>NDEBUG;_WINDOWS;_USRDLL;%(PreprocessorDefinitions)</PreprocessorDefinitions>
<ConformanceMode>true</ConformanceMode>
<PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
<AdditionalIncludeDirectories>..\..\common\inc;..\..\common\Telemetry;..\;..\..\;..\..\..\deps\cpprestsdk\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
<RuntimeLibrary>MultiThreaded</RuntimeLibrary>
<LanguageStandard>stdcpplatest</LanguageStandard>
</ClCompile>
@@ -94,6 +92,11 @@
<OutputFile>$(OutDir)$(TargetName)$(TargetExt)</OutputFile>
</Link>
</ItemDefinitionGroup>
<ItemDefinitionGroup>
<ClCompile>
<AdditionalIncludeDirectories>$(SolutionDir)src\;$(SolutionDir)src\modules;$(SolutionDir)src\common\Telemetry;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
</ClCompile>
</ItemDefinitionGroup>
<ItemGroup>
<ClInclude Include="pch.h" />
<ClInclude Include="resource.h" />
@@ -110,7 +113,7 @@
<ClCompile Include="trace.cpp" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\common\common.vcxproj">
<ProjectReference Include="$(SolutionDir)src\common\common.vcxproj">
<Project>{74485049-c722-400f-abe5-86ac52d929b3}</Project>
</ProjectReference>
</ItemGroup>

562
tools/project_template/ModuleTemplate/dllmain.cpp
View File

@@ -7,19 +7,21 @@
extern "C" IMAGE_DOS_HEADER __ImageBase;
BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved) {
switch (ul_reason_for_call) {
case DLL_PROCESS_ATTACH:
Trace::RegisterProvider();
break;
case DLL_THREAD_ATTACH:
case DLL_THREAD_DETACH:
break;
case DLL_PROCESS_DETACH:
Trace::UnregisterProvider();
break;
}
return TRUE;
BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved)
{
switch (ul_reason_for_call)
{
case DLL_PROCESS_ATTACH:
Trace::RegisterProvider();
break;
case DLL_THREAD_ATTACH:
case DLL_THREAD_DETACH:
break;
case DLL_PROCESS_DETACH:
Trace::UnregisterProvider();
break;
}
return TRUE;
}
// The PowerToy name that will be shown in the settings.
@@ -28,297 +30,309 @@ const static wchar_t* MODULE_NAME = L"$projectname$";
const static wchar_t* MODULE_DESC = L"<no description>";
// These are the properties shown in the Settings page.
struct ModuleSettings {
// Add the PowerToy module properties with default values.
// Currently available types:
// - int
// - bool
// - string
struct ModuleSettings
{
// Add the PowerToy module properties with default values.
// Currently available types:
// - int
// - bool
// - string
//bool bool_prop = true;
//int int_prop = 10;
//std::wstring string_prop = L"The quick brown fox jumps over the lazy dog";
//std::wstring color_prop = L"#1212FF";
//bool bool_prop = true;
//int int_prop = 10;
//std::wstring string_prop = L"The quick brown fox jumps over the lazy dog";
//std::wstring color_prop = L"#1212FF";
} g_settings;
// Implement the PowerToy Module Interface and all the required methods.
class $safeprojectname$ : public PowertoyModuleIface {
class $safeprojectname$ : public PowertoyModuleIface
{
private:
// The PowerToy state.
bool m_enabled = false;
// The PowerToy state.
bool m_enabled = false;
// Load initial settings from the persisted values.
void init_settings();
// Load initial settings from the persisted values.
void init_settings();
public:
// Constructor
$safeprojectname$() {
init_settings();
};
// Constructor
$safeprojectname$()
{
init_settings();
};
// Destroy the powertoy and free memory
virtual void destroy() override {
delete this;
}
// Return the display name of the powertoy, this will be cached by the runner
virtual const wchar_t* get_name() override {
return MODULE_NAME;
}
// Return array of the names of all events that this powertoy listens for, with
// nullptr as the last element of the array. Nullptr can also be retured for empty
// list.
virtual const wchar_t** get_events() override {
static const wchar_t* events[] = { nullptr };
// Available events:
// - ll_keyboard
// - win_hook_event
//
// static const wchar_t* events[] = { ll_keyboard,
// win_hook_event,
// nullptr };
return events;
}
// Return JSON with the configuration options.
virtual bool get_config(wchar_t* buffer, int* buffer_size) override {
HINSTANCE hinstance = reinterpret_cast<HINSTANCE>(&__ImageBase);
// Create a Settings object.
PowerToysSettings::Settings settings(hinstance, get_name());
settings.set_description(MODULE_DESC);
// Show an overview link in the Settings page
//settings.set_overview_link(L"https://");
// Show a video link in the Settings page.
//settings.set_video_link(L"https://");
// A bool property with a toggle editor.
/*settings.add_bool_toogle(
L"bool_toggle_1", // property name.
L"This is what a BoolToggle property looks like", // description or resource id of the localized string.
g_settings.bool_prop // property value.
);*/
// An integer property with a spinner editor.
/*settings.add_int_spinner(
L"int_spinner_1", // property name
L"This is what a IntSpinner property looks like", // description or resource id of the localized string.
g_settings.int_prop, // property value.
0, // min value.
100, // max value.
10 // incremental step.
);*/
// A string property with a textbox editor.
/*settings.add_string(
L"string_text_1", // property name.
L"This is what a String property looks like", // description or resource id of the localized string.
g_settings.string_prop // property value.
);*/
// A string property with a color picker editor.
/*settings.add_color_picker(
L"color_picker_1", // property name.
L"This is what a ColorPicker property looks like", // description or resource id of the localized string.
g_settings.color_prop // property value.
);*/
// A custom action property. When using this settings type, the "PowertoyModuleIface::call_custom_action()"
// method should be overriden as well.
/*settings.add_custom_action(
L"custom_action_id", // action name.
L"This is what a CustomAction property looks like", // label above the field.
L"Call a custom action", // button text.
L"Press the button to call a custom action." // display values / extended info.
);*/
return settings.serialize_to_buffer(buffer, buffer_size);
}
// Signal from the Settings editor to call a custom action.
// This can be used to spawn more complex editors.
virtual void call_custom_action(const wchar_t* action) override {
static UINT custom_action_num_calls = 0;
try {
// Parse the action values, including name.
PowerToysSettings::CustomActionObject action_object =
PowerToysSettings::CustomActionObject::from_json_string(action);
/*
if (action_object.get_name() == L"custom_action_id") {
// Execute your custom action
}
*/
// Destroy the powertoy and free memory
virtual void destroy() override
{
delete this;
}
catch (std::exception& ex) {
// Improper JSON.
// Return the display name of the powertoy, this will be cached by the runner
virtual const wchar_t* get_name() override
{
return MODULE_NAME;
}
}
// Called by the runner to pass the updated settings values as a serialized JSON.
virtual void set_config(const wchar_t* config) override {
try {
// Parse the input JSON string.
PowerToysSettings::PowerToyValues values =
PowerToysSettings::PowerToyValues::from_json_string(config);
// Return array of the names of all events that this powertoy listens for, with
// nullptr as the last element of the array. Nullptr can also be retured for empty
// list.
virtual const wchar_t** get_events() override
{
static const wchar_t* events[] = { nullptr };
// Available events:
// - ll_keyboard
// - win_hook_event
//
// static const wchar_t* events[] = { ll_keyboard,
// win_hook_event,
// nullptr };
// Update a bool property.
/*
if (values.is_bool_value(L"bool_toggle_1")) {
g_settings.bool_prop = values.get_bool_value(L"bool_toggle_1");
}
*/
// Update an int property.
/*
if (values.is_int_value(L"int_spinner_1")) {
g_settings.int_prop = values.get_int_value(L"int_spinner_1");
}
*/
// Update a string property.
/*
if (values.is_string_value(L"string_text_1")) {
g_settings.string_prop = values.get_string_value(L"string_text_1");
}
*/
// Update a color property.
/*
if (values.is_string_value(L"color_picker_1")) {
g_settings.color_prop = values.get_string_value(L"color_picker_1");
}
*/
// If you don't need to do any custom processing of the settings, proceed
// to persists the values calling:
values.save_to_settings_file();
// Otherwise call a custom function to process the settings before saving them to disk:
// save_settings();
return events;
}
catch (std::exception& ex) {
// Improper JSON.
// Return JSON with the configuration options.
virtual bool get_config(wchar_t* buffer, int* buffer_size) override
{
HINSTANCE hinstance = reinterpret_cast<HINSTANCE>(&__ImageBase);
// Create a Settings object.
PowerToysSettings::Settings settings(hinstance, get_name());
settings.set_description(MODULE_DESC);
// Show an overview link in the Settings page
//settings.set_overview_link(L"https://");
// Show a video link in the Settings page.
//settings.set_video_link(L"https://");
// A bool property with a toggle editor.
//settings.add_bool_toogle(
// L"bool_toggle_1", // property name.
// L"This is what a BoolToggle property looks like", // description or resource id of the localized string.
// g_settings.bool_prop // property value.
//);
// An integer property with a spinner editor.
//settings.add_int_spinner(
// L"int_spinner_1", // property name
// L"This is what a IntSpinner property looks like", // description or resource id of the localized string.
// g_settings.int_prop, // property value.
// 0, // min value.
// 100, // max value.
// 10 // incremental step.
//);
// A string property with a textbox editor.
//settings.add_string(
// L"string_text_1", // property name.
// L"This is what a String property looks like", // description or resource id of the localized string.
// g_settings.string_prop // property value.
//);
// A string property with a color picker editor.
//settings.add_color_picker(
// L"color_picker_1", // property name.
// L"This is what a ColorPicker property looks like", // description or resource id of the localized string.
// g_settings.color_prop // property value.
//);
// A custom action property. When using this settings type, the "PowertoyModuleIface::call_custom_action()"
// method should be overriden as well.
//settings.add_custom_action(
// L"custom_action_id", // action name.
// L"This is what a CustomAction property looks like", // label above the field.
// L"Call a custom action", // button text.
// L"Press the button to call a custom action." // display values / extended info.
//);
return settings.serialize_to_buffer(buffer, buffer_size);
}
}
// Enable the powertoy
virtual void enable() {
m_enabled = true;
}
// Signal from the Settings editor to call a custom action.
// This can be used to spawn more complex editors.
virtual void call_custom_action(const wchar_t* action) override
{
static UINT custom_action_num_calls = 0;
try
{
// Parse the action values, including name.
PowerToysSettings::CustomActionObject action_object =
PowerToysSettings::CustomActionObject::from_json_string(action);
// Disable the powertoy
virtual void disable() {
m_enabled = false;
}
// Returns if the powertoys is enabled
virtual bool is_enabled() override {
return m_enabled;
}
// Handle incoming event, data is event-specific
virtual intptr_t signal_event(const wchar_t* name, intptr_t data) override {
if (wcscmp(name, ll_keyboard) == 0) {
auto& event = *(reinterpret_cast<LowlevelKeyboardEvent*>(data));
// Return 1 if the keypress is to be suppressed (not forwarded to Windows),
// otherwise return 0.
return 0;
//if (action_object.get_name() == L"custom_action_id") {
// // Execute your custom action
//}
}
catch (std::exception&)
{
// Improper JSON.
}
}
else if (wcscmp(name, win_hook_event) == 0) {
auto& event = *(reinterpret_cast<WinHookEvent*>(data));
// Return value is ignored
return 0;
// Called by the runner to pass the updated settings values as a serialized JSON.
virtual void set_config(const wchar_t* config) override
{
try
{
// Parse the input JSON string.
PowerToysSettings::PowerToyValues values =
PowerToysSettings::PowerToyValues::from_json_string(config);
// Update a bool property.
//if (auto v = values.get_bool_value(L"bool_toggle_1")) {
// g_settings.bool_prop = *v;
//}
// Update an int property.
//if (auto v = values.get_int_value(L"int_spinner_1")) {
// g_settings.int_prop = *v;
//}
// Update a string property.
//if (auto v = values.get_string_value(L"string_text_1")) {
// g_settings.string_prop = *v;
//}
// Update a color property.
//if (auto v = values.get_string_value(L"color_picker_1")) {
// g_settings.color_prop = *v;
//}
// If you don't need to do any custom processing of the settings, proceed
// to persists the values calling:
values.save_to_settings_file();
// Otherwise call a custom function to process the settings before saving them to disk:
// save_settings();
}
catch (std::exception&)
{
// Improper JSON.
}
}
// Enable the powertoy
virtual void enable()
{
m_enabled = true;
}
// Disable the powertoy
virtual void disable()
{
m_enabled = false;
}
// Returns if the powertoys is enabled
virtual bool is_enabled() override
{
return m_enabled;
}
// Handle incoming event, data is event-specific
virtual intptr_t signal_event(const wchar_t* name, intptr_t data) override
{
if (wcscmp(name, ll_keyboard) == 0)
{
auto& event = *(reinterpret_cast<LowlevelKeyboardEvent*>(data));
// Return 1 if the keypress is to be suppressed (not forwarded to Windows),
// otherwise return 0.
return 0;
}
else if (wcscmp(name, win_hook_event) == 0)
{
auto& event = *(reinterpret_cast<WinHookEvent*>(data));
// Return value is ignored
return 0;
}
return 0;
}
// This methods are part of an experimental features not fully supported yet
virtual void register_system_menu_helper(PowertoySystemMenuIface* helper) override
{
}
virtual void signal_system_menu_action(const wchar_t* name) override
{
}
return 0;
}
};
// Load the settings file.
void $safeprojectname$::init_settings() {
try {
// Load and parse the settings file for this PowerToy.
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file($safeprojectname$::get_name());
void $safeprojectname$::init_settings()
{
try
{
// Load and parse the settings file for this PowerToy.
PowerToysSettings::PowerToyValues settings =
PowerToysSettings::PowerToyValues::load_from_settings_file($safeprojectname$::get_name());
// Load a bool property.
/*
if (settings.is_bool_value(L"bool_toggle_1")) {
g_settings.bool_prop = settings.get_bool_value(L"bool_toggle_1");
}
*/
// Load a bool property.
//if (auto v = settings.get_bool_value(L"bool_toggle_1")) {
// g_settings.bool_prop = *v;
//}
// Load an int property.
/*
if (settings.is_int_value(L"int_spinner_1")) {
g_settings.int_prop = settings.get_int_value(L"int_spinner_1");
}
*/
// Load an int property.
//if (auto v = settings.get_int_value(L"int_spinner_1")) {
// g_settings.int_prop = *v;
//}
// Load a string property.
/*
if (settings.is_string_value(L"string_text_1")) {
g_settings.string_prop = settings.get_string_value(L"string_text_1");
}
*/
// Load a string property.
//if (auto v = settings.get_string_value(L"string_text_1")) {
// g_settings.string_prop = *v;
//}
// Load a color property.
/*
if (settings.is_string_value(L"color_picker_1")) {
g_settings.color_prop = settings.get_string_value(L"color_picker_1");
// Load a color property.
//if (auto v = settings.get_string_value(L"color_picker_1")) {
// g_settings.color_prop = *v;
//}
}
catch (std::exception&)
{
// Error while loading from the settings file. Let default values stay as they are.
}
*/
}
catch (std::exception& ex) {
// Error while loading from the settings file. Let default values stay as they are.
}
}
// This method of saving the module settings is only required if you need to do any
// custom processing of the settings before saving them to disk.
/*
void $projectname$::save_settings() {
try {
// Create a PowerToyValues object for this PowerToy
PowerToysSettings::PowerToyValues values(get_name());
//void $projectname$::save_settings() {
// try {
// // Create a PowerToyValues object for this PowerToy
// PowerToysSettings::PowerToyValues values(get_name());
//
// // Save a bool property.
// //values.add_property(
// // L"bool_toggle_1", // property name
// // g_settings.bool_prop // property value
// //);
//
// // Save an int property.
// //values.add_property(
// // L"int_spinner_1", // property name
// // g_settings.int_prop // property value
// //);
//
// // Save a string property.
// //values.add_property(
// // L"string_text_1", // property name
// // g_settings.string_prop // property value
// );
//
// // Save a color property.
// //values.add_property(
// // L"color_picker_1", // property name
// // g_settings.color_prop // property value
// //);
//
// // Save the PowerToyValues JSON to the power toy settings file.
// values.save_to_settings_file();
// }
// catch (std::exception ex) {
// // Couldn't save the settings.
// }
//}
// Save a bool property.
//values.add_property(
// L"bool_toggle_1", // property name
// g_settings.bool_prop // property value
//);
// Save an int property.
//values.add_property(
// L"int_spinner_1", // property name
// g_settings.int_prop // property value
//);
// Save a string property.
//values.add_property(
// L"string_text_1", // property name
// g_settings.string_prop // property value
);
// Save a color property.
//values.add_property(
// L"color_picker_1", // property name
// g_settings.color_prop // property value
//);
// Save the PowerToyValues JSON to the power toy settings file.
values.save_to_settings_file();
}
catch (std::exception ex) {
// Couldn't save the settings.
}
}
*/
extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create() {
return new $safeprojectname$();
}
extern "C" __declspec(dllexport) PowertoyModuleIface* __cdecl powertoy_create()
{
return new $safeprojectname$();
}

43
tools/project_template/ModuleTemplate/trace.cpp
View File

@@ -2,25 +2,28 @@
#include "trace.h"
TRACELOGGING_DEFINE_PROVIDER(
g_hProvider,
"Microsoft.PowerToys",
// {38e8889b-9731-53f5-e901-e8a7c1753074}
(0x38e8889b, 0x9731, 0x53f5, 0xe9, 0x01, 0xe8, 0xa7, 0xc1, 0x75, 0x30, 0x74),
TraceLoggingOptionProjectTelemetry());
void Trace::RegisterProvider() {
TraceLoggingRegister(g_hProvider);
}
void Trace::UnregisterProvider() {
TraceLoggingUnregister(g_hProvider);
}
void Trace::MyEvent() {
TraceLoggingWrite(
g_hProvider,
"PowerToyName::Event::MyEvent",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingBoolean(TRUE, "UTCReplace_AppSessionGuid"),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
"Microsoft.PowerToys",
// {38e8889b-9731-53f5-e901-e8a7c1753074}
(0x38e8889b, 0x9731, 0x53f5, 0xe9, 0x01, 0xe8, 0xa7, 0xc1, 0x75, 0x30, 0x74),
TraceLoggingOptionProjectTelemetry());
void Trace::RegisterProvider()
{
TraceLoggingRegister(g_hProvider);
}
void Trace::UnregisterProvider()
{
TraceLoggingUnregister(g_hProvider);
}
void Trace::MyEvent()
{
TraceLoggingWrite(
g_hProvider,
"PowerToyName_MyEvent",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingBoolean(TRUE, "UTCReplace_AppSessionGuid"),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}

9
tools/project_template/ModuleTemplate/trace.h
View File

@@ -1,8 +1,9 @@
#pragma once
class Trace {
class Trace
{
public:
static void RegisterProvider();
static void UnregisterProvider();
static void MyEvent();
static void RegisterProvider();
static void UnregisterProvider();
static void MyEvent();
};