1 
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2017-2018 Francois Beaune, The appleseedhq Organization
9 //
10 // Permission is hereby granted, free of charge, to any person obtaining a copy
11 // of this software and associated documentation files (the "Software"), to deal
12 // in the Software without restriction, including without limitation the rights
13 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 // copies of the Software, and to permit persons to whom the Software is
15 // furnished to do so, subject to the following conditions:
16 //
17 // The above copyright notice and this permission notice shall be included in
18 // all copies or substantial portions of the Software.
19 //
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 // THE SOFTWARE.
27 //
28 
29 #pragma once
30 
31 // appleseed.foundation headers.
32 #include "foundation/utility/api/apiarray.h"
33 #include "foundation/utility/searchpaths.h"
34 
35 // appleseed.main headers.
36 #include "main/dllsymbol.h"
37 
38 // Forward declarations.
39 namespace renderer  { class IObjectFactory; }
40 namespace renderer  { class Object; }
41 namespace renderer  { class Plugin; }
42 
43 namespace renderer
44 {
45 
46 //
47 // An array of object factories.
48 //
49 
50 APPLESEED_DECLARE_APIARRAY(ObjectFactoryArray, IObjectFactory*);
51 
52 
53 //
54 // Object factory registrar.
55 //
56 
57 class APPLESEED_DLLSYMBOL ObjectFactoryRegistrar
58 {
59   public:
60     typedef Object EntityType;
61     typedef IObjectFactory FactoryType;
62     typedef ObjectFactoryArray FactoryArrayType;
63 
64     // Constructor.
65     explicit ObjectFactoryRegistrar(
66         const foundation::SearchPaths& search_paths = foundation::SearchPaths());
67 
68     // Destructor.
69     ~ObjectFactoryRegistrar();
70 
71     // Register a factory defined in a plugin.
72     void register_factory_plugin(Plugin* plugin, void* plugin_entry_point);
73 
74     // Retrieve the registered factories.
75     FactoryArrayType get_factories() const;
76 
77     // Lookup a factory by name.
78     const FactoryType* lookup(const char* name) const;
79 
80   private:
81     struct Impl;
82     Impl* impl;
83 };
84 
85 }   // namespace renderer
86