config class, basic doc

Author: braindigitalis

README.md

@@ -13,8 +13,40 @@ No support is offered for this software at present. Your mileage may vary. I hav
 
 libmysqlclient-dev
 D++
+fmtlib
 A C++ compiler capable of building D++ bots with coroutine support, if you want to use the asynchronous interface
 
 ## Documentation
 
 All functions in the `db` namespace have Doxygen comment blocks.
+
+## Using the wrapper
+
+This is an example of using the asynchronous interface:
+
+```cpp
+#include <dpp/dpp.h>
+#include "database.h"
+#include "config.h"
+
+int main(int argc, char const *argv[]) {
+	std::setlocale(LC_ALL, "en_GB.UTF-8");
+
+	config::init("../config.json");
+		
+	dpp::cluster bot(config::get("token"));
+
+	bot.on_ready([&bot](const dpp::ready_t& event) -> dpp::task<void> {
+		auto rs = co_await db::co_query("SELECT * FROM bigtable WHERE bar = ?", { "baz" });
+		std::cout << "Number of rows returned: " << rs.size() << "\n";
+		if (!rs.empty()) {
+			std::cout << "First row 'bar' value: " << rs[0].at("bar") << "\n";
+		}
+		co_return;
+	});
+
+	db::init(bot);
+
+	bot.start(dpp::st_wait);
+}
+```

config.cpp

@@ -0,0 +1,43 @@
+/************************************************************************************
+ * 
+ * dpp-mysql - An asynchronous MySQL database wrapper for D++ bots
+ *
+ * Copyright 2020-2024 Craig Edwards <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ************************************************************************************/
+#include <dpp/dpp.h>
+#include <dpp/json.h>
+#include <fstream>
+
+namespace config {
+
+	static json configdocument;
+
+	void init(const std::string& config_file) {
+		std::ifstream configfile(config_file);
+		configfile >> configdocument;
+	}
+
+	bool exists(const std::string& key) {
+		return configdocument.contains(key);
+	}
+
+	json& get(const std::string& key) {
+		if (key.empty()) {
+			return configdocument;
+		}
+		return configdocument.at(key);
+	}
+};

config.h

@@ -0,0 +1,47 @@
+/************************************************************************************
+ * 
+ * dpp-mysql - An asynchronous MySQL database wrapper for D++ bots
+ *
+ * Copyright 2020-2024 Craig Edwards <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ ************************************************************************************/
+#pragma once
+#include <dpp/json_fwd.h>
+
+namespace config {
+
+	/**
+	 * @brief Initialise config file
+	 * 
+	 * @param config_file Config file to read
+	 */
+	void init(const std::string& config_file);
+
+	/**
+	 * @brief Get all config values from a specific key
+	 * 
+	 * @param key The key, if empty/omitted the root node is returned
+	 * @return json& configuration or empty container if not found
+	 */
+	json& get(const std::string& key = "");
+
+	/**
+	 * Returns true if the specified key exists
+	 * @param key
+	 * @return true if key exists
+	 */
+	bool exists(const std::string& key);
+
+};

database.cpp

@@ -18,9 +18,8 @@
  *
  ************************************************************************************/
 
-#include <ssod/ssod.h>
-#include <ssod/database.h>
-#include <ssod/config.h>
+#include "database.h"
+#include "config.h"
 #include <mysql/mysql.h>
 #include <fmt/format.h>
 #include <unordered_map>