plugin.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Cryptonomex, Inc., and contributors.
 *
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once

#include <graphene/app/application.hpp>

#include <boost/program_options.hpp>
#include <fc/io/json.hpp>

namespace graphene { namespace app {

class abstract_plugin
{
   public:
      explicit abstract_plugin(application& a) : _app(a) {}
      virtual ~abstract_plugin() = default;

      virtual std::string plugin_name()const = 0;

      virtual std::string plugin_description()const = 0;

      application& app()const { return _app; }

      virtual void plugin_initialize( const boost::program_options::variables_map& options ) = 0;

      virtual void plugin_startup() = 0;

      virtual void plugin_shutdown() = 0;

      virtual void plugin_set_program_options(
         boost::program_options::options_description& command_line_options,
         boost::program_options::options_description& config_file_options
         ) = 0;
   protected:
      application& _app;
};

class plugin : public abstract_plugin
{
   public:
      using abstract_plugin::abstract_plugin;

      std::string plugin_name()const override;
      std::string plugin_description()const override;
      void plugin_initialize( const boost::program_options::variables_map& options ) override;
      void plugin_startup() override;
      void plugin_shutdown() override;
      void plugin_set_program_options(
         boost::program_options::options_description& command_line_options,
         boost::program_options::options_description& config_file_options
         ) override;

      chain::database& database() { return *app().chain_database(); }
   protected:
      net::node_ptr p2p_node() const { return app().p2p_node(); }
};

template<typename T>
T dejsonify(const string& s, uint32_t max_depth)
{
   return fc::json::from_string(s).as<T>(max_depth);
}

namespace impl {
   template<typename T>
   T dejsonify( const string& s )
   {
      return graphene::app::dejsonify<T>( s, GRAPHENE_MAX_NESTED_OBJECTS );
   }
}

#define DEFAULT_VALUE_VECTOR(value) default_value({fc::json::to_string(value)}, fc::json::to_string(value))
#define LOAD_VALUE_SET(options, name, container, type) \
do { \
   if( options.count(name) > 0 ) { \
      const std::vector<std::string>& ops = options[name].as<std::vector<std::string>>(); \
      std::transform(ops.begin(), ops.end(), std::inserter(container, container.end()), \
                     &graphene::app::impl::dejsonify<type>); \
   } \
} while (false)

} } //graphene::app