File: PluginPtr.hh

package info (click to toggle)
ignition-plugin 1.2.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 728 kB
  • sloc: cpp: 4,712; ansic: 277; ruby: 128; sh: 38; makefile: 12
file content (200 lines) | stat: -rw-r--r-- 6,679 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * 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.
 *
 */


#ifndef IGNITION_PLUGIN_DETAIL_PLUGINPTR_HH_
#define IGNITION_PLUGIN_DETAIL_PLUGINPTR_HH_

#include <memory>
#include <utility>
#include <ignition/plugin/PluginPtr.hh>
#include <ignition/plugin/utility.hh>

namespace ignition
{
  namespace plugin
  {
    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr()
      : dataPtr(new PluginType)
    {
      // Do nothing
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        const TemplatePluginPtr &_other)
      : dataPtr(new PluginType)
    {
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    // the following is a false positive with cppcheck 1.82 fixed in 1.83
    // cppcheck-suppress syntaxError
    template <typename OtherPluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        const TemplatePluginPtr<OtherPluginType> &_other)
      : dataPtr(new PluginType)
    {
      static_assert(ConstCompatible<PluginType, OtherPluginType>::value,
                "The requested PluginPtr cast would discard const qualifiers");
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        const TemplatePluginPtr &_other)
    {
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
      return *this;
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    template <typename OtherPluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        const TemplatePluginPtr<OtherPluginType> &_other)
    {
      static_assert(ConstCompatible<PluginType, OtherPluginType>::value,
                "The requested PluginPtr cast would discard const qualifiers");
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
      return *this;
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        TemplatePluginPtr &&_other)
      : dataPtr(std::move(_other.dataPtr))
    {
      // Do nothing
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        TemplatePluginPtr &&_other)
    {
      this->dataPtr = std::move(_other.dataPtr);
      return *this;
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        std::nullptr_t)
    {
      this->Clear();
      return *this;
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    PluginType* TemplatePluginPtr<PluginType>::operator ->() const
    {
      return dataPtr.get();
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    PluginType& TemplatePluginPtr<PluginType>::operator *() const
    {
      return (*dataPtr);
    }

    //////////////////////////////////////////////////
    #define DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR(op)\
      template <typename PluginType>\
      bool TemplatePluginPtr<PluginType>::operator op (\
            const TemplatePluginPtr &_other) const\
      {\
        return (this->dataPtr->PrivateGetInstancePtr() op \
                _other.dataPtr->PrivateGetInstancePtr() );\
      }

    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( == )  // NOLINT
    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( < )   // NOLINT
    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( > )   // NOLINT
    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( != )  // NOLINT
    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( <= )  // NOLINT
    DETAIL_IGN_PLUGIN_PLUGINPTR_IMPLEMENT_OPERATOR( >= )  // NOLINT

    //////////////////////////////////////////////////
    template <typename PluginType>
    std::size_t TemplatePluginPtr<PluginType>::Hash() const
    {
      return std::hash< std::shared_ptr<void> >()(
                   this->dataPtr->PrivateGetInstancePtr());
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    bool TemplatePluginPtr<PluginType>::IsEmpty() const
    {
      return (nullptr == this->dataPtr->PrivateGetInstancePtr());
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::operator bool() const
    {
      return !this->IsEmpty();
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    void TemplatePluginPtr<PluginType>::Clear()
    {
      this->dataPtr->PrivateCreatePluginInstance(nullptr, nullptr);
    }

    //////////////////////////////////////////////////
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        const ConstInfoPtr &_info,
        const std::shared_ptr<void> &_dlHandlePtr)
      : dataPtr(new PluginType)
    {
      dataPtr->PrivateCreatePluginInstance(_info, _dlHandlePtr);
    }
  }
}

// Note that opening up namespace std is legal here because we are specializing
// a templated structure from the STL, which is permitted (and even encouraged).
namespace std
{
  /// \brief Template specialization that provides a hash function for PluginPtr
  /// so that it can easily be used in STL objects like std::unordered_set and
  /// std::unordered_map
  template <typename PluginType>
  struct hash<ignition::plugin::TemplatePluginPtr<PluginType>>
  {
    size_t operator()(
        const ignition::plugin::TemplatePluginPtr<PluginType> &ptr) const
    {
      return ptr.Hash();
    }
  };
}

#endif