aermicioi.aedi.factory.factory source code

1 /**
2 
3 
4 License:
5 	Boost Software License - Version 1.0 - August 17th, 2003
6 
7     Permission is hereby granted, free of charge, to any person or organization
8     obtaining a copy of the software and accompanying documentation covered by
9     this license (the "Software") to use, reproduce, display, distribute,
10     execute, and transmit the Software, and to prepare derivative works of the
11     Software, and to permit third-parties to whom the Software is furnished to
12     do so, all subject to the following:
13 
14     The copyright notices in the Software and this entire statement, including
15     the above license grant, this restriction and the following disclaimer,
16     must be included in all copies of the Software, in whole or in part, and
17     all derivative works of the Software, unless such copies or derivative
18     works are solely in the form of machine-executable object code generated by
19     a source language processor.
20 
21     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23     FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24     SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25     FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26     ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27     DEALINGS IN THE SOFTWARE.
28 
29 Authors:
30 	Alexandru Ermicioi
31 **/
32 module aermicioi.aedi.factory.factory;
33 
34 import aermicioi.aedi.storage.allocator_aware;
35 import aermicioi.aedi.storage.locator_aware;
36 import aermicioi.aedi.storage.locator;
37 
38 /**
39 Interface for objects able to create some instance of type T.
40 
41 Intent of this interface is to provide a single entry for objects, able to
42 instantiate something.
43 **/
44 @safe interface Factory(T) : LocatorAware!(), AllocatorAware!() {
45 
46 	public {
47 
48 		/**
49 		Instantiates component of type T.
50 
51 		Returns:
52 			T instantiated component.
53 		**/
54 		T factory() @safe;
55 
56         /**
57         Destructs a component of type T.
58 
59         Params:
60             component = component that is to ve destroyed.
61         **/
62         void destruct(ref T component) @safe;
63 
64 		@property {
65 
66 		    /**
67     		Get the type info of T that is created.
68 
69     		Returns:
70     			TypeInfo object of created component.
71     		**/
72     		TypeInfo type() @safe nothrow const;
73 		}
74 	}
75 }
76 
77 alias ObjectFactory = Factory!Object;
78 
79 /**
80 A mixin that implements a destruct delegating mechanism to decorated factory
81 **/
82 @safe mixin template DestructDecoratorMixin(T : Factory!Z, Z) {
83 
84     /**
85     Destructs a component of type T.
86 
87     Params:
88         component = component that is to ve destroyed.
89     **/
90     void destruct(ref Z component) @safe
91     in (decorator !is null, "A factory that decorates another cannot destroy a component when no decorated factory is set.")
92     {
93 
94         this.decorated.destruct(component);
95     }
96 }
97 
98 /**
99 A mixin that implements a factory delegating mechanism to decorated factory
100 **/
101 @safe mixin template FactoryDecoratorMixin(T : Factory!Z, Z) {
102 
103     /**
104     Instantiates component of type T.
105 
106     Returns:
107         T instantiated component.
108     **/
109     Z factory() @safe
110     in (decorator !is null, "A factory that decorates another cannot create a component when no decorated factory is set.")
111     {
112         return this.decorated.factory();
113     }
114 }