BitShares-Core  7.0.2
BitShares blockchain node software and command-line wallet software
template_plugin.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 template_plugin and contributors.
3  *
4  * The MIT License
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include <graphene/app/plugin.hpp>
28 
29 namespace graphene { namespace template_plugin {
30 using namespace chain;
31 
32 //
33 // Plugins should #define their SPACE_ID's so plugins with
34 // conflicting SPACE_ID assignments can be compiled into the
35 // same binary (by simply re-assigning some of the conflicting #defined
36 // SPACE_ID's in a build script).
37 //
38 // Assignment of SPACE_ID's cannot be done at run-time because
39 // various template automagic depends on them being known at compile
40 // time.
41 //
42 #ifndef template_plugin_SPACE_ID
43 #define template_plugin_SPACE_ID @SPACE_ID@
44 #endif
45 
46 
47 namespace detail
48 {
50 }
51 
53 {
54  public:
56  ~template_plugin() override;
57 
58  std::string plugin_name()const override;
59  std::string plugin_description()const override;
60  void plugin_set_program_options(
61  boost::program_options::options_description& cli,
62  boost::program_options::options_description& cfg) override;
63  void plugin_initialize(const boost::program_options::variables_map& options) override;
64  void plugin_startup() override;
65  void plugin_shutdown() override;
66 
67  private:
68  void cleanup();
69  std::unique_ptr<detail::template_plugin_impl> my;
70 };
71 
72 } } //graphene::template
database.hpp
plugin.hpp
graphene::app::application
Definition: application.hpp:91
graphene::app::plugin
Definition: plugin.hpp:100
graphene::template_plugin::template_plugin
Definition: template_plugin.hpp:52
graphene::template_plugin::detail::template_plugin_impl
Definition: template_plugin.cpp:32
graphene
Definition: api.cpp:48