split into headers, use actual queue

Author: prevter

CMakeLists.txt

@@ -5,7 +5,7 @@ project(discord-rpc)
 set(CMAKE_CXX_STANDARD 23)
 include(cmake/CPM.cmake)
 
-add_library(${PROJECT_NAME} STATIC src/discord-rpc.cpp src/serialization.cpp)
+add_library(${PROJECT_NAME} STATIC src/discord-rpc.cpp src/serialization.cpp src/command-queue.cpp)
 target_include_directories(${PROJECT_NAME} PUBLIC include)
 
 # Windows has some extra code

README.md

@@ -6,13 +6,14 @@ A simple Discord Rich Presence library for C++ made from scratch.
 **Checklist**:
 - [x] Handshake
 - [x] Update presence with custom data
-- [x] Buttons support
+- [x] More features (buttons, activity type, etc.)
 - [x] Linux support
 - [x] MacOS support
 - [x] Windows support
 - [x] Out-of-the-box Wine support *(Only supports Wine Staging 10.2+ because of AF_UNIX socket support)*
 - [ ] Events (join, spectate, etc.)
 - [ ] Auto register (for steam games)
+- [ ] Social SDK features
 - [ ] Documentation
 - [ ] Examples
 
@@ -26,7 +27,7 @@ that uses a modern C++ style and has more features.
 
 ### Features
 - **Modern C++**: This library is written in C++23 and follows builder patterns as much as possible.
-- **Buttons**: Undocumented/unimplemented feature in discord, that allows you to add custom links to your presence.
+- **More features**: Implements new features from Discord RPC documentation that is not present in the original library, such as buttons, activity type, and more.
 - **Project integration**: Say goodbye to copying library files or dealing with RapidJSON errors. This library can be easily integrated into your project without any hassle.
 - **Cross-platform**: This library is designed to work on all supported platforms, including Linux, macOS, and Windows.
 - **Wine support**: Library provides internal layer to support Wine, no extra configuration needed.

include/discord-rpc.hpp

@@ -10,6 +10,9 @@
 #include <mutex>
 #include <string>
 
+#include "discord-rpc/commands.hpp"
+#include "discord-rpc/presence.hpp"
+
 namespace discord {
     class Connection;
     struct IOWorker;
@@ -25,155 +28,6 @@ namespace discord {
         int premium_type = 0;
     };
 
-    enum class PartyPrivacy : int32_t {
-        Private = 0,
-        Public  = 1,
-    };
-
-    enum class ActivityType : int32_t {
-        Game = 0,
-        Streaming = 1,
-        Listening = 2,
-        Watching = 3,
-        Custom = 4, // Note: only works for bot accounts
-        Competing = 5,
-    };
-
-    enum class StatusDisplayType {
-        Name = 0,
-        State = 1,
-        Details = 2,
-    };
-
-    class Presence {
-    public:
-        #define GENERATE_GETSET_LRVALUE(type, name, member) \
-        Presence& set##name(type const& member) noexcept { m_##member = member; return *this; } \
-        Presence& set##name(type&& member) noexcept { m_##member = std::move(member); return *this; }\
-        type const& get##name() const noexcept { return m_##member; }
-
-        #define GENERATE_GETSET_VALUE(type, name, member) \
-        Presence& set##name(type member) noexcept { m_##member = member; return *this; } \
-        type get##name() const noexcept { return m_##member; }
-
-        #define GENERATE_GETSET_BUTTON(index) \
-        Button& getButton##index() noexcept { return m_buttons[index - 1]; } \
-        Button const& getButton##index() const noexcept { return m_buttons[index - 1]; } \
-        Presence& setButton##index(Button const& button) noexcept { m_buttons[index - 1] = button; return *this; } \
-        Presence& setButton##index(Button&& button) noexcept { m_buttons[index - 1] = std::move(button); return *this; } \
-        Presence& setButton##index(std::string const& label, std::string const& url, bool enabled = true) noexcept { \
-            m_buttons[index - 1].set(label, url, enabled); \
-            return *this; \
-        } \
-        Presence& setButton##index(std::string&& label, std::string&& url, bool enabled = true) noexcept { \
-            m_buttons[index - 1].set(std::move(label), std::move(url), enabled); \
-            return *this; \
-        }
-
-        class Button {
-        public:
-            [[nodiscard]] bool isEnabled() const noexcept { return enabled; }
-            [[nodiscard]] std::string const& getLabel() const noexcept { return label; }
-            [[nodiscard]] std::string const& getURL() const noexcept { return url; }
-
-            Button& setEnabled(bool enabled) noexcept {
-                this->enabled = enabled;
-                return *this;
-            }
-
-            Button& setLabel(std::string const& label) noexcept {
-                this->label = label;
-                return *this;
-            }
-
-            Button& setLabel(std::string&& label) noexcept {
-                this->label = std::move(label);
-                return *this;
-            }
-
-            Button& setURL(std::string const& url) noexcept {
-                this->url = url;
-                return *this;
-            }
-
-            Button& setURL(std::string&& url) noexcept {
-                this->url = std::move(url);
-                return *this;
-            }
-
-            Button& set(std::string const& label, std::string const& url, bool enabled = true) noexcept {
-                this->label = label;
-                this->url = url;
-                this->enabled = enabled;
-                return *this;
-            }
-
-            Button& set(std::string&& label, std::string&& url, bool enabled = true) noexcept {
-                this->label = std::move(label);
-                this->url = std::move(url);
-                this->enabled = enabled;
-                return *this;
-            }
-
-        private:
-            bool enabled = false;
-            std::string label;
-            std::string url;
-        };
-
-        GENERATE_GETSET_LRVALUE(std::string, State, state)
-        GENERATE_GETSET_LRVALUE(std::string, Details, details)
-        GENERATE_GETSET_VALUE(int64_t, StartTimestamp, startTimestamp)
-        GENERATE_GETSET_VALUE(int64_t, EndTimestamp, endTimestamp)
-        GENERATE_GETSET_LRVALUE(std::string, LargeImageKey, largeImageKey)
-        GENERATE_GETSET_LRVALUE(std::string, LargeImageText, largeImageText)
-        GENERATE_GETSET_LRVALUE(std::string, SmallImageKey, smallImageKey)
-        GENERATE_GETSET_LRVALUE(std::string, SmallImageText, smallImageText)
-        GENERATE_GETSET_LRVALUE(std::string, PartyID, partyID)
-        GENERATE_GETSET_VALUE(int32_t, PartySize, partySize)
-        GENERATE_GETSET_VALUE(int32_t, PartyMax, partyMax)
-        GENERATE_GETSET_VALUE(PartyPrivacy, PartyPrivacy, partyPrivacy)
-        GENERATE_GETSET_VALUE(ActivityType, ActivityType, activityType)
-        GENERATE_GETSET_VALUE(StatusDisplayType, StatusDisplayType, statusDisplayType)
-        GENERATE_GETSET_LRVALUE(std::string, MatchSecret, matchSecret)
-        GENERATE_GETSET_LRVALUE(std::string, JoinSecret, joinSecret)
-        GENERATE_GETSET_LRVALUE(std::string, SpectateSecret, spectateSecret)
-        GENERATE_GETSET_VALUE(bool, Instance, instance)
-
-        GENERATE_GETSET_BUTTON(1)
-        GENERATE_GETSET_BUTTON(2)
-
-        #undef GENERATE_GETSET_BUTTON
-        #undef GENERATE_GETSET_LRVALUE
-        #undef GENERATE_GETSET_VALUE
-
-        Presence& clear() noexcept;
-
-        /// Calls the RPCManager::refresh() function to update the presence
-        void refresh() const noexcept;
-
-    private:
-        std::string m_state;
-        std::string m_details;
-        int64_t m_startTimestamp = 0;
-        int64_t m_endTimestamp = 0;
-        std::string m_largeImageKey;
-        std::string m_largeImageText;
-        std::string m_smallImageKey;
-        std::string m_smallImageText;
-        std::string m_partyID;
-        int32_t m_partySize = 0;
-        int32_t m_partyMax = 0;
-        PartyPrivacy m_partyPrivacy = PartyPrivacy::Private;
-        ActivityType m_activityType = ActivityType::Game;
-        StatusDisplayType m_statusDisplayType = StatusDisplayType::Name;
-        std::string m_matchSecret;
-        std::string m_joinSecret;
-        std::string m_spectateSecret;
-        std::array<Button, 2> m_buttons;
-        bool m_instance = false;
-    };
-
     class RPCManager {
     private:
         // prevent construction from outside
@@ -274,9 +128,7 @@ namespace discord {
         std::chrono::time_point<std::chrono::system_clock> m_nextConnect = std::chrono::system_clock::now();
         size_t m_processID = 0;
         int m_nonce = 1;
-        std::string m_queuedPresence{};
-        std::mutex m_queuePresenceMutex{};
-        std::atomic_bool m_updatePresence = false;
+        CommandQueue m_commandQueue{};
     };
 }
 

include/discord-rpc/command-queue.hpp

@@ -0,0 +1,43 @@
+#pragma once
+#ifndef DISCORD_RPC_COMMAND_QUEUE_HPP
+#define DISCORD_RPC_COMMAND_QUEUE_HPP
+
+#include <queue>
+#include <mutex>
+#include <string>
+#include <optional>
+
+namespace discord {
+    /// @brief A simple command queue for Discord RPC commands
+    class CommandQueue {
+    public:
+        CommandQueue() noexcept = default;
+        ~CommandQueue() noexcept = default;
+
+        /// @brief Adds a command to the queue
+        void push(std::string const& command) noexcept;
+        void push(std::string&& command) noexcept;
+
+        /// @brief Pushes a new command to the queue and returns a reference to the prepared command.
+        /// Mutex remains locked after this call, so make sure to call `finish()` after filling the command.
+        std::string& prepare() noexcept;
+
+        /// @brief Unlocks the mutex after a `prepare()` call.
+        void finish() noexcept;
+
+        /// @brief Pops a command from the queue
+        std::optional<std::string> pop() noexcept;
+
+        /// @brief Checks if the queue is empty
+        bool empty() const noexcept;
+
+        /// @brief Returns the size of the queue
+        size_t size() const noexcept;
+
+    private:
+        std::queue<std::string> m_queue; ///< The internal command queue
+        mutable std::mutex m_mutex;      ///< Mutex for thread safety
+    };
+}
+
+#endif // DISCORD_RPC_COMMAND_QUEUE_HPP