Merge branch 'dev' into AVX-Implementation

brainboxdotcc · Aug 3, 2023 · e1ef30a · e1ef30a
2 parents e41d55b + f5bcb01
commit e1ef30a
Show file tree

Hide file tree

Showing 94 changed files with 13,570 additions and 3,326 deletions.
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,2 @@
+# TODO: Discuss about -readability-identifier-length, -readability-avoid-const-params-in-decls
+Checks: "-*,bugprone-*,cert-*,clang-analyzer-*,concurrency-*,cppcoreguidelines-*,llvm-namespace-comment,modernize-*,performance-*,portability-*,readability-*,-bugprone-implicit-widening-of-multiplication-result, -bugprone-easily-swappable-parameters,-readability-identifier-length,-portability-restrict-system-includes,-modernize-use-trailing-return-type,-cppcoreguidelines-non-private-member-variables-in-classes,-readability-avoid-const-params-in-decls"
diff --git a/.cspell.json b/.cspell.json
@@ -96,12 +96,41 @@
 		"CORO",
 		"cback",
 		"mentionables",
-		"stringified"
+		"awaiter",
+		"checkered",
+		"ramen",
+		"dango",
+		"tanabata",
+		"diya",
+		"nazar",
+		"hamsa",
+		"tada",
+		"izakaya",
+		"rofl",
+		"thumbup",
+		"mwgb",
+		"mwbb",
+		"wwgb",
+		"mwgg",
+		"wwbb",
+		"wwgg",
+		"mmgb",
+		"mmgg",
+		"womans",
+		"mans",
+		"mens",
+		"womens",
+		"mmbb",
+		"fleur",
+		"koko",
+		"moyai",
+		"kaaba",
+		"stringified",
+		"STDCORO"
 	],
 	"flagWords": [
 		"hte"
 	],
 	"allowCompoundWords": true,
 	"useCompounds": true
 }
-
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -191,7 +191,7 @@ jobs:
         cfg:
           - {name: "ARM64", os: ubuntu-20.04, cmake-options: -DCMAKE_TOOLCHAIN_FILE=cmake/ARM64ToolChain.cmake}
           - {name: "ARMv7 HF", os: ubuntu-20.04, cmake-options: -DCMAKE_TOOLCHAIN_FILE=cmake/ARMv7ToolChain.cmake}
-          - {name: "Linux x86", os: ubuntu-22.04, cmake-options: -DCMAKE_TOOLCHAIN_FILE=cmake/LINUXx86ToolChain.cmake}
+          - {name: "Linux x86", os: ubuntu-20.04, cmake-options: -DCMAKE_TOOLCHAIN_FILE=cmake/LINUXx86ToolChain.cmake -DBUILD_VOICE_SUPPORT=OFF}
           - {name: "ARMv6", os: ubuntu-20.04, cmake-options: -DCMAKE_TOOLCHAIN_FILE=cmake/ARMv6ToolChain.cmake}
 
     name: ${{matrix.cfg.name}}

diff --git a/CMakeSettings.json b/CMakeSettings.json
@@ -3,13 +3,46 @@
     {
       "name": "x64-Debug",
       "generator": "Ninja",
+      "configurationType": "Debug",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    },
+    {
+      "name": "x64-Release",
+      "generator": "Ninja",
       "configurationType": "Release",
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "buildRoot": "${projectDir}\\out\\build\\${name}",
       "installRoot": "${projectDir}\\out\\install\\${name}",
       "cmakeCommandArgs": "",
       "buildCommandArgs": "",
       "ctestCommandArgs": ""
+    },
+    {
+      "name": "x64-Debug-Coro",
+      "generator": "Ninja",
+      "configurationType": "Debug",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "-DDPP_CORO=on",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    },
+    {
+      "name": "x64-Release-Coro",
+      "generator": "Ninja",
+      "configurationType": "Release",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "-DDPP_CORO=on",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
     }
   ]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,6 +15,4 @@ When contributing to this repository, please do not feel intimidated! We welcome
    including indent style etc).
 7. Your PR must pass the CI actions before being allowed to be merged. Our PR actions check that the
    build will compile on various platforms before release and makes precompiled versions of the library.
-8. If you are on the discord server for the project and your PR is accepted, let a moderator know and we
-   will grant you the 'Contributors' role.
-
+8. Automated changes e.g. via grammarly or a static analysis tool will not usually be accepted into the code without proper thought out justification (by a human being, not an AI or an App) as to why the changes are required. Generally a PR should do more than fix a single spelling error for example as this just takes precious time for something which could be resolved a direct commit to the dev branch.
diff --git a/README.md b/README.md
@@ -7,7 +7,9 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/39b054c38bba411d9b25b39524016c9e)](https://www.codacy.com/gh/brainboxdotcc/DPP/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=brainboxdotcc/DPP&amp;utm_campaign=Badge_Grade) 
 ![Lines of code](https://img.shields.io/tokei/lines/github/brainboxdotcc/DPP) 
 [![D++ CI](https://github.com/brainboxdotcc/DPP/actions/workflows/ci.yml/badge.svg)](https://github.com/brainboxdotcc/DPP/actions/workflows/ci.yml)
-[![AUR version](https://img.shields.io/aur/version/dpp)](https://aur.archlinux.org/packages/dpp) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![AUR version](https://img.shields.io/aur/version/dpp)](https://aur.archlinux.org/packages/dpp)
+![vcpkg version](https://img.shields.io/vcpkg/v/dpp)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 </div>
 
@@ -88,6 +90,20 @@ For running your bot on a **Raspberry Pi**, we offer a prebuilt .deb package for
 ### Other OS
 The library should work fine on other operating systems as well, and if you run a D++ bot on something not listed here, please let us know!
 
+## Getting Started
+
+### Installation
+
+D++ can be easily installed using various package managers. Please refer [to our documentation](https://dpp.dev/md_docpages_01_installing.html) for installation tutorials based on your preferred package manager.
+
+### Building from Source
+
+If you prefer to build the library from source, detailed instructions are available [here](https://dpp.dev/install-from-source.html).
+
+### FAQ
+
+For frequently asked questions and their answers, please visit our [FAQ page](https://dpp.dev/md_docpages_01_frequently_asked_questions.html).
+
 ## 🤝 Contributing
 
 Contributions, issues and feature requests are welcome. After cloning and setting up project locally, you can just submit 

diff --git a/buildtools/classes/Generator/CoroGenerator.php b/buildtools/classes/Generator/CoroGenerator.php
@@ -54,6 +54,7 @@ public function generateHeaderStart(): string
     public function generateCppStart(): string
     {
         return $this->generateHeaderStart() . <<<EOT
+#ifdef DPP_CORO
 
 #include <dpp/export.h>
 #include <dpp/snowflake.h>
@@ -80,27 +81,24 @@ public function checkForChanges(): bool
         }
 
         echo "-- Autogenerating include/dpp/cluster_coro_calls.h\n";
+        echo "-- Autogenerating src/dpp/cluster_coro_calls.cpp\n";
         return true;
     }
 
     /**
      * @inheritDoc
      */
-    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string
+    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string
     {
-        $parameterNames = preg_replace('/^, /', '', $parameterNames);
-        if (!empty($parameterNames)) {
-            $parameterNames .= ', ';
-        }
-        return "auto inline co_{$currentFunction}($noDefaults) {\n\treturn dpp::awaitable(this, [&] (auto cc) { this->$currentFunction({$parameterNames}cc); }); \n}\n\n";
+        return "awaitable<confirmation_callback_t> co_{$currentFunction}($parameters);\n\n";
     }
 
     /**
      * @inheritDoc
      */
-    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string
+    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string
     {
-        return '';
+        return "awaitable<confirmation_callback_t> cluster::co_${currentFunction}($noDefaults) {\n\treturn {this, static_cast<void (cluster::*)($parameterTypes". (!empty($parameterTypes) ? ", " : "") . "command_completion_event_t)>(&cluster::$currentFunction)$parameterNames};\n}\n\n";
     }
 
     /**
@@ -116,7 +114,7 @@ public function getCommentArray(): array
      */
     public function saveHeader(string $content): void
     {
-		$content .= "auto inline co_request(const std::string &url, http_method method, const std::string &postdata = \"\", const std::string &mimetype = \"text/plain\", const std::multimap<std::string, std::string> &headers = {}) {\n\treturn dpp::awaitable(this, [&] (auto cc) { this->request(url, method, cc, mimetype, headers); }); \n}\n\n";
+        $content .= "awaitable<http_request_completion_t> co_request(const std::string &url, http_method method, const std::string &postdata = \"\", const std::string &mimetype = \"text/plain\", const std::multimap<std::string, std::string> &headers = {});\n\n";
         file_put_contents('include/dpp/cluster_coro_calls.h', $content);
     }
 
@@ -125,7 +123,11 @@ public function saveHeader(string $content): void
      */
     public function saveCpp(string $cppcontent): void
     {
-	/* No cpp file to save, code is all inline */
+        $cppcontent .= "dpp::awaitable<dpp::http_request_completion_t> dpp::cluster::co_request(const std::string &url, http_method method, const std::string &postdata, const std::string &mimetype, const std::multimap<std::string, std::string> &headers) {\n\treturn awaitable<http_request_completion_t>{[&](auto &&cc) { this->request(url, method, cc, postdata, mimetype, headers); }};\n}
+
+#endif
+";
+        file_put_contents('src/dpp/cluster_coro_calls.cpp', $cppcontent);
     }
 
 }
diff --git a/buildtools/classes/Generator/SyncGenerator.php b/buildtools/classes/Generator/SyncGenerator.php
@@ -86,17 +86,17 @@ public function checkForChanges(): bool
     /**
      * @inheritDoc
      */
-    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string
+    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string
     {
         return "$returnType {$currentFunction}_sync($parameters);\n\n";
     }
 
     /**
      * @inheritDoc
      */
-    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string
+    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string
     {
-        return "$returnType cluster::{$currentFunction}_sync($noDefaults) {\n\treturn dpp::sync<$returnType>(this, &cluster::$currentFunction$parameterNames);\n}\n\n";
+        return "$returnType cluster::{$currentFunction}_sync($noDefaults) {\n\treturn dpp::sync<$returnType>(this, static_cast<void (cluster::*)($parameterTypes". (!empty($parameterTypes) ? ", " : "") . "command_completion_event_t)>(&cluster::$currentFunction)$parameterNames);\n}\n\n";
     }
 
     /**

diff --git a/buildtools/classes/Packager/Vcpkg.php b/buildtools/classes/Packager/Vcpkg.php
@@ -138,7 +138,6 @@ function constructPortAndVersionFile(string $sha512 = "0"): string
     OUT_SOURCE_PATH SOURCE_PATH
     REPO brainboxdotcc/DPP
     REF "v${VERSION}"
-    # Auto-generated by release CI action at brainboxdotcc/DPP
     SHA512 ' . $sha512 . '
 )
 
@@ -158,11 +157,7 @@ function constructPortAndVersionFile(string $sha512 = "0"): string
     file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/bin" "${CURRENT_PACKAGES_DIR}/debug/bin")
 endif()
 
-file(
-    INSTALL "${SOURCE_PATH}/LICENSE"
-    DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}"
-    RENAME copyright
-)
+vcpkg_install_copyright(FILE_LIST "${SOURCE_PATH}/LICENSE")
 
 file(COPY "${CMAKE_CURRENT_LIST_DIR}/usage" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}")
 ';

diff --git a/buildtools/classes/StructGeneratorInterface.php b/buildtools/classes/StructGeneratorInterface.php
@@ -38,7 +38,7 @@ public function checkForchanges(): bool;
      * @param string $parameterNames Parameter names only
      * @return string header content to append
      */
-    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string;
+    public function generateHeaderDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string;
 
     /**
      * Generate cpp definition for a function
@@ -50,7 +50,7 @@ public function generateHeaderDef(string $returnType, string $currentFunction, s
      * @param string $parameterNames Parameter names only
      * @return string cpp content to append
      */
-    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterNames): string;
+    public function generateCppDef(string $returnType, string $currentFunction, string $parameters, string $noDefaults, string $parameterTypes, string $parameterNames): string;
 
     /**
      * Return comment lines to add to each header definition

diff --git a/buildtools/emojis.php b/buildtools/emojis.php
@@ -0,0 +1,36 @@
+<?php
+
+echo "-- Autogenrating include/dpp/unicode_emoji.h\n";
+
+$url = "https://raw.githubusercontent.com/ArkinSolomon/discord-emoji-converter/master/emojis.json";
+
+$header = <<<END
+#pragma once
+
+namespace dpp {
+
+/**
+ * The unicode emojis in this namespace are auto-generated from {$url}
+ *
+ * If you want to use this, you have to pull the header in separately. e.g.
+ * ```cpp
+ * #include <dpp/dpp.h>
+ * #include <dpp/unicode_emoji.h>
+ * ```
+ */
+namespace unicode_emoji {
+
+END;
+
+/* This JSON is generated originally via the NPM package maintained by Discord themselves at https://www.npmjs.com/package/discord-emoji */
+$emojis = json_decode(file_get_contents($url));
+if ($emojis) {
+    foreach ($emojis as $name=>$code) {
+        if (preg_match("/^\d+/", $name)) {
+            $name = "_" . $name;
+        }
+        $header .= "	constexpr const char[] " .$name . " = \"$code\";\n";
+    }
+    $header .= "}\n};\n";
+    file_put_contents("include/dpp/unicode_emoji.h", $header);
+}
diff --git a/buildtools/make_struct.php b/buildtools/make_struct.php
@@ -20,16 +20,6 @@
 
 /* These methods have signatures incompatible with this script */
 $blacklist = [
-    'channel_edit_permissions',
-    'message_add_reaction',
-    'message_delete_reaction',
-    'message_delete_reaction_emoji',
-    'message_delete_all_reactions',
-    'message_delete_own_reaction',
-    'message_get_reactions',
-    'channel_typing',
-    'application_role_connection_get', // TODO: rest_request_vector
-    'application_role_connection_update',
 ];
 
 /* The script cannot determine the correct return type of these methods,
@@ -41,7 +31,19 @@
     'guild_search_members' => 'guild_member_map',
     'message_create' => 'message',
     'message_edit' => 'message',
+    'message_add_reaction' => 'confirmation',
+    'message_delete_reaction' => 'confirmation',
+    'message_delete_reaction_emoji' => 'confirmation',
+    'message_delete_all_reactions' => 'confirmation',
+    'message_delete_own_reaction' => 'confirmation',
+    'channel_edit_permissions' => 'confirmation',
+    'channel_typing' => 'confirmation',
+    'message_get_reactions' => 'emoji_map',
     'thread_create_in_forum' => 'thread',
+    'threads_get_active' => 'active_threads',
+    'user_get_cached' => 'user_identified',
+    'application_role_connection_get' => 'application_role_connection',
+    'application_role_connection_update' => 'application_role_connection'
 ];
 
 /* Get the contents of cluster.h into an array */
@@ -61,8 +63,11 @@
     exit(0);
 }
 
+$lastFunc = '<none>';
+$l = 0;
 /* Scan every line of the C++ source */
 foreach ($clustercpp as $cpp) {
+    $l++;
     /* Look for declaration of function body */
     if ($state == STATE_SEARCH_FOR_FUNCTION &&
         preg_match('/^\s*void\s+cluster::([^(]+)\s*\((.*)command_completion_event_t\s*callback\s*\)/', $cpp, $matches)) {
@@ -96,25 +101,34 @@
         if (!in_array($currentFunction, $blacklist)) {
             $parameterList = explode(',', $parameters);
             $parameterNames = [];
+            $parameterTypes = [];
             foreach ($parameterList as $parameter) {
                 $parts = explode(' ', trim($parameter));
-                $parameterNames[] = trim(preg_replace('/[\s\*\&]+/', '', $parts[count($parts) - 1]));
+                $name = trim(preg_replace('/[\s\*\&]+/', '', $parts[count($parts) - 1]));
+                $parameterNames[] = $name;
+                $parameterTypes[] = trim(substr($parameter, 0, strlen($parameter) - strlen($name)));
             }
             $content .= getComments($generator, $currentFunction, $returnType, $parameterNames) . "\n";
             $fullParameters = getFullParameters($currentFunction, $parameterNames);
             $parameterNames = trim(join(', ', $parameterNames));
+            $parameterTypes = trim(join(', ', $parameterTypes));
             if (!empty($parameterNames)) {
                 $parameterNames = ', ' . $parameterNames;
             }
             $noDefaults = $parameters;
             $parameters = !empty($fullParameters) ? $fullParameters : $parameters;
-            $content .= $generator->generateHeaderDef($returnType, $currentFunction, $parameters, $noDefaults, $parameterNames);
-            $cppcontent .= $generator->generateCppDef($returnType, $currentFunction, $parameters, $noDefaults, $parameterNames);
+            $content .= $generator->generateHeaderDef($returnType, $currentFunction, $parameters, $noDefaults, $parameterTypes, $parameterNames);
+            $cppcontent .= $generator->generateCppDef($returnType, $currentFunction, $parameters, $noDefaults, $parameterTypes, $parameterNames);
         }
+        $lastFunc = $currentFunction;
         $currentFunction = $parameters = $returnType = '';
         $state = STATE_SEARCH_FOR_FUNCTION;
     }
 }
+if ($state != STATE_SEARCH_FOR_FUNCTION) {
+    die("\n\n\nBuilding headers is broken ($l) - state machine finished in the middle of function $currentFunction (previous $lastFunc) with parameters $parameters rv $returnType state=$state\n\n\n");
+}
+
 $content .= <<<EOT
 
 /* End of auto-generated definitions */