All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
interfaceFactory.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PLUG_INTERFACEFACTORY_H
25 #define PLUG_INTERFACEFACTORY_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/type.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 // For use by \c PLUG_REGISTER_INTERFACE_SINGLETON_TYPE.
35 class Plug_InterfaceFactory {
36 public:
37  struct Base : public TfType::FactoryBase {
38  public:
39  virtual void* New() = 0;
40  };
41 
42  template <class Interface, class Implementation>
43  struct SingletonFactory : public Base {
44  public:
45  virtual void* New()
46  {
47  static_assert(std::is_abstract<Interface>::value,
48  "Interface type must be abstract.");
49  static Implementation impl;
50  return static_cast<Interface*>(&impl);
51  }
52  };
53 };
54 
67 #define PLUG_REGISTER_INTERFACE_SINGLETON_TYPE(Interface, Implementation) \
68 TF_REGISTRY_FUNCTION(TfType) \
69 { \
70  TfType::Define<Interface>() \
71  .SetFactory<Plug_InterfaceFactory::SingletonFactory< \
72  Interface, Implementation> >(); \
73 }
74 
75 PXR_NAMESPACE_CLOSE_SCOPE
76 
77 #endif // PLUG_INTERFACEFACTORY_H
Base class of all factory types.
Definition: type.h:79