From 1ed1ce9506e65f76fe5236194516f23d662bba0b Mon Sep 17 00:00:00 2001 From: Vaxry <43317083+vaxerski@users.noreply.github.com> Date: Sun, 5 May 2024 17:16:00 +0100 Subject: internal: new shared_ptr and weak_ptr implementation (#5883) moves std::shared_ptrs to a new implementation Advantages: - you can dereference a weak_ptr directly. This will obviously segfault on a nullptr deref if it's expired. - this is useful to avoid the .lock() hell where we are 100% sure the pointer _should_ be valid. (and if it isn't, it should throw.) - weak_ptrs are still valid while the SP is being destroyed. - reasoning: while an object (e.g. CWindow) is being destroyed, its `weak_ptr self` should be accessible (the sp is still alive, and so is CWindow), but it's not because by stl it's already expired (to prevent resurrection) - this impl solves it differently. w_p is expired, but can still be dereferenced and used. Creating `s_p`s is not possible anymore, though. - this is useful in destructors and callbacks. --- src/plugins/PluginAPI.hpp | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'src/plugins/PluginAPI.hpp') diff --git a/src/plugins/PluginAPI.hpp b/src/plugins/PluginAPI.hpp index df04efbe..83db5f85 100644 --- a/src/plugins/PluginAPI.hpp +++ b/src/plugins/PluginAPI.hpp @@ -23,6 +23,7 @@ Feel like the API is missing something you'd like to use in your plugin? Open an #include "../helpers/Color.hpp" #include "HookSystem.hpp" #include "../SharedDefs.hpp" +#include "../defines.hpp" #include "../version.h" #include @@ -63,9 +64,6 @@ class IHyprWindowDecoration; struct SConfigValue; class CWindow; -typedef std::shared_ptr PHLWINDOW; -typedef std::weak_ptr PHLWINDOWREF; - /* These methods are for the plugin to implement Methods marked with REQUIRED are required. @@ -144,7 +142,7 @@ namespace HyprlandAPI { WARNING: Losing this pointer will unregister the callback! */ - APICALL [[nodiscard]] std::shared_ptr registerCallbackDynamic(HANDLE handle, const std::string& event, HOOK_CALLBACK_FN fn); + APICALL [[nodiscard]] SP registerCallbackDynamic(HANDLE handle, const std::string& event, HOOK_CALLBACK_FN fn); /* Unregisters a callback. If the callback was dynamic, frees the memory. @@ -153,7 +151,7 @@ namespace HyprlandAPI { Deprecated: just reset the pointer you received with registerCallbackDynamic */ - APICALL [[deprecated]] bool unregisterCallback(HANDLE handle, std::shared_ptr fn); + APICALL [[deprecated]] bool unregisterCallback(HANDLE handle, SP fn); /* Calls a hyprctl command. @@ -281,14 +279,14 @@ namespace HyprlandAPI { returns: Pointer. Nullptr on fail. */ - APICALL std::shared_ptr registerHyprCtlCommand(HANDLE handle, SHyprCtlCommand cmd); + APICALL SP registerHyprCtlCommand(HANDLE handle, SHyprCtlCommand cmd); /* Unregisters a hyprctl command returns: true on success. False otherwise. */ - APICALL bool unregisterHyprCtlCommand(HANDLE handle, std::shared_ptr cmd); + APICALL bool unregisterHyprCtlCommand(HANDLE handle, SP cmd); }; /* -- cgit v1.2.3