changeset 647:23fd8bad4006

Irccd: style (plugin) #782
author David Demelier <markand@malikania.fr>
date Sat, 24 Mar 2018 07:55:14 +0100
parents e4227aa185c2
children 8a9cac75608f
files libirccd-js/irccd/js/js_plugin.cpp libirccd-js/irccd/js/js_plugin.hpp libirccd-js/irccd/js/logger_jsapi.cpp libirccd-js/irccd/js/plugin_jsapi.cpp libirccd-js/irccd/js/timer_jsapi.cpp libirccd/irccd/daemon/command/plugin_config_command.cpp libirccd/irccd/daemon/command/plugin_info_command.cpp libirccd/irccd/daemon/command/plugin_list_command.cpp libirccd/irccd/daemon/plugin.hpp libirccd/irccd/daemon/service/plugin_service.cpp libirccd/irccd/daemon/service/plugin_service.hpp libirccd/irccd/daemon/service/server_service.cpp tests/src/libirccd-js/js-plugin/main.cpp tests/src/libirccd/command-plugin-config/main.cpp
diffstat 14 files changed, 74 insertions(+), 74 deletions(-) [+]
line wrap: on
line diff
--- a/libirccd-js/irccd/js/js_plugin.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd-js/irccd/js/js_plugin.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -103,7 +103,7 @@
     push(std::forward<Args>(args)...);
 
     if (duk_pcall(context_, sizeof... (Args)) != 0)
-        throw plugin_error(plugin_error::exec_error, name(), dukx_stack(context_, -1).stack());
+        throw plugin_error(plugin_error::exec_error, get_name(), dukx_stack(context_, -1).stack());
 
     duk_pop(context_);
 }
@@ -140,11 +140,11 @@
 
 void js_plugin::open()
 {
-    std::ifstream input(path());
+    std::ifstream input(get_path());
 
     // TODO: add error message here.
     if (!input)
-        throw plugin_error(plugin_error::exec_error, name(), std::strerror(errno));
+        throw plugin_error(plugin_error::exec_error, get_name(), std::strerror(errno));
 
     std::string data(
         std::istreambuf_iterator<char>(input.rdbuf()),
@@ -152,20 +152,20 @@
     );
 
     if (duk_peval_string(context_, data.c_str()))
-        throw plugin_error(plugin_error::exec_error, name(), dukx_stack(context_, -1).stack());
+        throw plugin_error(plugin_error::exec_error, get_name(), dukx_stack(context_, -1).stack());
 
     // Read metadata.
     duk_get_global_string(context_, "info");
 
     if (duk_get_type(context_, -1) == DUK_TYPE_OBJECT) {
         duk_get_prop_string(context_, -1, "author");
-        set_author(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : author());
+        set_author(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : get_author());
         duk_get_prop_string(context_, -2, "license");
-        set_license(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : license());
+        set_license(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : get_license());
         duk_get_prop_string(context_, -3, "summary");
-        set_summary(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : summary());
+        set_summary(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : get_summary());
         duk_get_prop_string(context_, -4, "version");
-        set_version(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : version());
+        set_version(duk_is_string(context_, -1) ? duk_get_string(context_, -1) : get_version());
         duk_pop_n(context_, 4);
     }
 
--- a/libirccd-js/irccd/js/js_plugin.hpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd-js/irccd/js/js_plugin.hpp	Sat Mar 24 07:55:14 2018 +0100
@@ -101,7 +101,7 @@
     /**
      * \copydoc plugin::config
      */
-    plugin_config config() override
+    plugin_config get_config() override
     {
         return get_table(config_property);
     }
@@ -117,7 +117,7 @@
     /**
      * \copydoc plugin::formats
      */
-    plugin_formats formats() override
+    plugin_formats get_formats() override
     {
         return get_table(format_property);
     }
@@ -133,7 +133,7 @@
     /**
      * \copydoc plugin::paths
      */
-    plugin_paths paths() override
+    plugin_paths get_paths() override
     {
         return get_table(paths_property);
     }
--- a/libirccd-js/irccd/js/logger_jsapi.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd-js/irccd/js/logger_jsapi.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -30,7 +30,7 @@
 
 duk_ret_t print(duk_context* ctx, std::ostream &out)
 {
-    out << "plugin " << dukx_get_plugin(ctx)->name() << ": " << duk_require_string(ctx, 0) << std::endl;
+    out << "plugin " << dukx_get_plugin(ctx)->get_name() << ": " << duk_require_string(ctx, 0) << std::endl;
 
     return 0;
 }
--- a/libirccd-js/irccd/js/plugin_jsapi.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd-js/irccd/js/plugin_jsapi.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -223,15 +223,15 @@
         return 0;
 
     duk_push_object(ctx);
-    dukx_push(ctx, plugin->name());
+    dukx_push(ctx, plugin->get_name());
     duk_put_prop_string(ctx, -2, "name");
-    dukx_push(ctx, plugin->author());
+    dukx_push(ctx, plugin->get_author());
     duk_put_prop_string(ctx, -2, "author");
-    dukx_push(ctx, plugin->license());
+    dukx_push(ctx, plugin->get_license());
     duk_put_prop_string(ctx, -2, "license");
-    dukx_push(ctx, plugin->summary());
+    dukx_push(ctx, plugin->get_summary());
     duk_put_prop_string(ctx, -2, "summary");
-    dukx_push(ctx, plugin->version());
+    dukx_push(ctx, plugin->get_version());
     duk_put_prop_string(ctx, -2, "version");
 
     return 1;
@@ -253,7 +253,7 @@
     duk_push_array(ctx);
 
     for (const auto& p : dukx_get_irccd(ctx).plugins().list()) {
-        dukx_push(ctx, p->name());
+        dukx_push(ctx, p->get_name());
         duk_put_prop_index(ctx, -2, i++);
     }
 
--- a/libirccd-js/irccd/js/timer_jsapi.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd-js/irccd/js/timer_jsapi.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -85,7 +85,7 @@
     duk_remove(ctx, -2);
 
     if (duk_pcall(ctx, 0)) {
-        dukx_get_irccd(ctx).log().warning() << "plugin: " << plugin->name()
+        dukx_get_irccd(ctx).log().warning() << "plugin: " << plugin->get_name()
             << " timer error:" << std::endl;
         dukx_get_irccd(ctx).log().warning() << "  "
             << dukx_stack(ctx, -1).what() << std::endl;
--- a/libirccd/irccd/daemon/command/plugin_config_command.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/command/plugin_config_command.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -34,15 +34,15 @@
 {
     assert(args.count("value") > 0);
 
-    auto var = args.find("variable");
-    auto value = args.find("value");
+    const auto var = args.find("variable");
+    const auto value = args.find("value");
 
     if (var == args.end() || !var->is_string())
         throw irccd_error(irccd_error::error::incomplete_message);
     if (value == args.end() || !value->is_string())
         throw irccd_error(irccd_error::error::incomplete_message);
 
-    auto config = plugin.config();
+    auto config = plugin.get_config();
 
     config[*var] = *value;
     plugin.set_config(config);
@@ -55,9 +55,9 @@
     auto var = args.find("variable");
 
     if (var != args.end() && var->is_string())
-        variables[var->get<std::string>()] = plugin.config()[*var];
+        variables[var->get<std::string>()] = plugin.get_config()[*var];
     else
-        for (const auto& pair : plugin.config())
+        for (const auto& pair : plugin.get_config())
             variables[pair.first] = pair.second;
 
     /*
--- a/libirccd/irccd/daemon/command/plugin_info_command.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/command/plugin_info_command.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -40,14 +40,14 @@
     if (!id || !string_util::is_identifier(*id))
         throw plugin_error(plugin_error::invalid_identifier);
 
-    auto plugin = irccd.plugins().require(*id);
+    const auto plugin = irccd.plugins().require(*id);
 
     client.send({
-        { "command",    "plugin-info"       },
-        { "author",     plugin->author()    },
-        { "license",    plugin->license()   },
-        { "summary",    plugin->summary()   },
-        { "version",    plugin->version()   }
+        { "command",    "plugin-info"           },
+        { "author",     plugin->get_author()    },
+        { "license",    plugin->get_license()   },
+        { "summary",    plugin->get_summary()   },
+        { "version",    plugin->get_version()   }
     });
 }
 
--- a/libirccd/irccd/daemon/command/plugin_list_command.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/command/plugin_list_command.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -35,7 +35,7 @@
     auto list = nlohmann::json::array();
 
     for (const auto& plugin : irccd.plugins().list())
-        list += plugin->name();
+        list += plugin->get_name();
 
     client.send({
         { "command",    "plugin-list"   },
--- a/libirccd/irccd/daemon/plugin.hpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/plugin.hpp	Sat Mar 24 07:55:14 2018 +0100
@@ -100,7 +100,7 @@
      *
      * \return the plugin name
      */
-    inline const std::string& name() const noexcept
+    inline const std::string& get_name() const noexcept
     {
         return name_;
     }
@@ -111,7 +111,7 @@
      * \return the plugin path
      * \note some plugins may not exist on the disk
      */
-    inline const std::string& path() const noexcept
+    inline const std::string& get_path() const noexcept
     {
         return path_;
     }
@@ -121,7 +121,7 @@
      *
      * \return the author
      */
-    inline const std::string& author() const noexcept
+    inline const std::string& get_author() const noexcept
     {
         return author_;
     }
@@ -141,7 +141,7 @@
      *
      * \return the license
      */
-    inline const std::string& license() const noexcept
+    inline const std::string& get_license() const noexcept
     {
         return license_;
     }
@@ -161,7 +161,7 @@
      *
      * \return the summary
      */
-    inline const std::string& summary() const noexcept
+    inline const std::string& get_summary() const noexcept
     {
         return summary_;
     }
@@ -181,7 +181,7 @@
      *
      * \return the version
      */
-    inline const std::string& version() const noexcept
+    inline const std::string& get_version() const noexcept
     {
         return version_;
     }
@@ -201,7 +201,7 @@
      *
      * \return the config
      */
-    virtual plugin_config config()
+    virtual plugin_config get_config()
     {
         return {};
     }
@@ -221,7 +221,7 @@
      *
      * \return the format
      */
-    virtual plugin_formats formats()
+    virtual plugin_formats get_formats()
     {
         return {};
     }
@@ -241,7 +241,7 @@
      *
      * \return the paths
      */
-    virtual plugin_paths paths()
+    virtual plugin_paths get_paths()
     {
         return {};
     }
--- a/libirccd/irccd/daemon/service/plugin_service.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/service/plugin_service.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -53,7 +53,7 @@
         try {
             plugin->handle_unload(irccd_);
         } catch (const std::exception& ex) {
-            irccd_.log().warning() << "plugin: " << plugin->name() << ": " << ex.what() << std::endl;
+            irccd_.log().warning() << "plugin: " << plugin->get_name() << ": " << ex.what() << std::endl;
         }
     }
 }
@@ -61,14 +61,14 @@
 bool plugin_service::has(const std::string& name) const noexcept
 {
     return std::count_if(plugins_.cbegin(), plugins_.cend(), [&] (const auto& plugin) {
-        return plugin->name() == name;
+        return plugin->get_name() == name;
     }) > 0;
 }
 
 std::shared_ptr<plugin> plugin_service::get(const std::string& name) const noexcept
 {
     auto it = std::find_if(plugins_.begin(), plugins_.end(), [&] (const auto& plugin) {
-        return plugin->name() == name;
+        return plugin->get_name() == name;
     });
 
     if (it == plugins_.end())
@@ -191,15 +191,15 @@
 
 void plugin_service::unload(const std::string& name)
 {
-    auto it = std::find_if(plugins_.begin(), plugins_.end(), [&] (const auto& plugin) {
-        return plugin->name() == name;
+    const auto it = std::find_if(plugins_.begin(), plugins_.end(), [&] (const auto& plugin) {
+        return plugin->get_name() == name;
     });
 
     if (it == plugins_.end())
         throw plugin_error(plugin_error::not_found, name);
 
     // Erase first, in case of throwing.
-    auto save = *it;
+    const auto save = *it;
 
     plugins_.erase(it);
     exec(save, &plugin::handle_unload, irccd_);
--- a/libirccd/irccd/daemon/service/plugin_service.hpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/service/plugin_service.hpp	Sat Mar 24 07:55:14 2018 +0100
@@ -200,9 +200,9 @@
         try {
             ((*plugin).*(fn))(std::forward<Args>(args)...);
         } catch (const std::exception& ex) {
-            throw plugin_error(plugin_error::exec_error, plugin->name(), ex.what());
+            throw plugin_error(plugin_error::exec_error, plugin->get_name(), ex.what());
         } catch (...) {
-            throw plugin_error(plugin_error::exec_error, plugin->name());
+            throw plugin_error(plugin_error::exec_error, plugin->get_name());
         }
     }
 
@@ -219,7 +219,7 @@
         auto plugin = find(name);
 
         if (!plugin)
-            throw plugin_error(plugin_error::not_found, plugin->name());
+            throw plugin_error(plugin_error::not_found, plugin->get_name());
 
         exec(plugin, fn, std::forward<Args>(args)...);
     }
--- a/libirccd/irccd/daemon/service/server_service.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/libirccd/irccd/daemon/service/server_service.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -42,7 +42,7 @@
 {
     for (auto& plugin : daemon.plugins().list()) {
         auto eventname = name_func(*plugin);
-        auto allowed = daemon.rules().solve(server, target, origin, plugin->name(), eventname);
+        auto allowed = daemon.rules().solve(server, target, origin, plugin->get_name(), eventname);
 
         if (!allowed) {
             daemon.log().debug("rule: event skipped on match");
@@ -54,7 +54,7 @@
         try {
             exec_func(*plugin);
         } catch (const std::exception& ex) {
-            daemon.log().warning() << "plugin " << plugin->name() << ": error: "
+            daemon.log().warning() << "plugin " << plugin->get_name() << ": error: "
                 << ex.what() << std::endl;
         }
     }
@@ -196,12 +196,12 @@
             return string_util::parse_message(
                 ev.message,
                 ev.server->get_command_char(),
-                plugin.name()
+                plugin.get_name()
             ).type == string_util::message_pack::type::command ? "onCommand" : "onMessage";
         },
         [=] (plugin& plugin) mutable {
             auto copy = ev;
-            auto pack = string_util::parse_message(copy.message, copy.server->get_command_char(), plugin.name());
+            auto pack = string_util::parse_message(copy.message, copy.server->get_command_char(), plugin.get_name());
 
             copy.message = pack.message;
 
--- a/tests/src/libirccd-js/js-plugin/main.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/tests/src/libirccd-js/js-plugin/main.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -58,9 +58,9 @@
     });
     plugin_->handle_load(irccd_);
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_CASE(fill)
@@ -73,9 +73,9 @@
     });
     plugin_->handle_load(irccd_);
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_CASE(merge_after)
@@ -88,9 +88,9 @@
         { "verbose",    "false" }
     });
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_SUITE_END()
@@ -126,27 +126,27 @@
 {
     load("test", CMAKE_CURRENT_SOURCE_DIR "/config-assign.js");
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_CASE(fill)
 {
     load("test", CMAKE_CURRENT_SOURCE_DIR "/config-fill.js");
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_CASE(merge_after)
 {
     load("test", CMAKE_CURRENT_SOURCE_DIR "/config-fill.js");
 
-    BOOST_TEST(plugin_->config().at("path") == "none");
-    BOOST_TEST(plugin_->config().at("verbose") == "false");
-    BOOST_TEST(plugin_->config().at("hard") == "true");
+    BOOST_TEST(plugin_->get_config().at("path") == "none");
+    BOOST_TEST(plugin_->get_config().at("verbose") == "false");
+    BOOST_TEST(plugin_->get_config().at("hard") == "true");
 }
 
 BOOST_AUTO_TEST_SUITE_END()
--- a/tests/src/libirccd/command-plugin-config/main.cpp	Sat Mar 24 07:37:21 2018 +0100
+++ b/tests/src/libirccd/command-plugin-config/main.cpp	Sat Mar 24 07:55:14 2018 +0100
@@ -37,7 +37,7 @@
     {
     }
 
-    plugin_config config() override
+    plugin_config get_config() override
     {
         return config_;
     }
@@ -63,10 +63,10 @@
     });
 
     wait_for([&] {
-        return !daemon_->plugins().require("test")->config().empty();
+        return !daemon_->plugins().require("test")->get_config().empty();
     });
 
-    auto config = daemon_->plugins().require("test")->config();
+    auto config = daemon_->plugins().require("test")->get_config();
 
     BOOST_TEST(!config.empty());
     BOOST_TEST(config["verbosy"] == "falsy");