File: FactoryGenerator.cs

package info (click to toggle)
mono 6.8.0.105%2Bdfsg-3.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,284,512 kB
  • sloc: cs: 11,172,132; xml: 2,850,069; ansic: 671,653; cpp: 122,091; perl: 59,366; javascript: 30,841; asm: 22,168; makefile: 20,093; sh: 15,020; python: 4,827; pascal: 925; sql: 859; sed: 16; php: 1
file content (189 lines) | stat: -rw-r--r-- 8,245 bytes parent folder | download | duplicates (7)
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
//------------------------------------------------------------------------------
// <copyright file="FactoryGenerator.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
//------------------------------------------------------------------------------

#if !DONTUSEFACTORYGENERATOR

using System;
using System.Reflection;
using System.Reflection.Emit;
using System.Threading;
using System.Security;
using System.Security.Permissions;

namespace System.Web.Util {
    /*
     * Factory Generator class
     * A factory generator is useful for cases where a large number of late-bound
     * classes need to be instantiated.
     *
     * Normally, to create an instance of type t, you call the following code:
     *
     *      ISomeInterface o = (ISomeInterface) Activator.CreateInstance(t);
     *
     * This assumes that the default constructor is used, and that the type t
     * implements the interface ISomeInterface.
     *
     * The factory generator, on the other hand, can use reflection emit APIs
     * to dynamically generate a class factory for t. The generated class has
     * the equivalent of the following code:
     *
     *      class X : ISomeInterfaceFactory {
     *          public ISomeInterface CreateInstance() {
     *              return new t();
     *          }
     *      }
     *
     * It then instantiates and returns an object of this type. You can then
     * call CreateInstance to create an instance of the type, which is
     * significantly faster.
     *
     * A single instance of a FactoryGenerator can generate factories for
     * multiple types. However, it builds all these types into a single
     * dynamically generated assembly. CLR implementation prevents this
     * assembly from being unloaded until the process exits.
     *
     * The FactoryGenerator is (almost) a templated type. It takes two
     * types in its constructor:
     *
     *   returnedType is the type common to all classes for which factories
     *      are to be generated. In the example above, this would be
     *      ISomeInterface.
     *   factoryInterface is the interface implemented by the dynamically
     *      generated class factory, and should include a method named
     *      CreateInstance, that takes no parameters and returns an object
     *      of the type specified by returnedType. In the example above,
     *      this would be ISomeInterfaceFactory.
     *
     * Copyright (c) 2003 Microsoft Corporation
     */

    internal class FactoryGenerator {
        private Type _factoryInterface;
        private Type _returnedType;
        private MethodInfo _methodToOverride;
        private ModuleBuilder _dynamicModule = null;
        private Type[] _emptyParameterList = new Type[] { };
        private Type[] _interfacesToImplement;

        internal FactoryGenerator() : this(typeof(object), typeof(IWebObjectFactory)) {}

        private FactoryGenerator(Type returnedType, Type factoryInterface) {
            _returnedType = returnedType;
            _factoryInterface = factoryInterface;

            // Get the CreateInstance method, and make sure it has
            // the correct signature.

            _methodToOverride = factoryInterface.GetMethod("CreateInstance", new Type[0]);
            if (_methodToOverride.ReturnType != _returnedType) {
                throw new ArgumentException(SR.GetString(SR.FactoryInterface));
            }

            // This will be needed later, when building the dynamic class.
            _interfacesToImplement = new Type[1];
            _interfacesToImplement[0] = factoryInterface;
        }

        // A type must be public and have a parameterless constructor, in order for us to be able to
        // create a factory for the type.  Throws if either of these conditions are not true.
        internal static void CheckPublicParameterlessConstructor(Type type) {
            if (type == null) {
                throw new ArgumentNullException("type");
            }

            if (!(type.IsPublic || type.IsNestedPublic)) {
                throw new InvalidOperationException(SR.GetString(SR.FactoryGenerator_TypeNotPublic, type.Name));
            }

            ConstructorInfo constructor = type.GetConstructor(Type.EmptyTypes);
            if (constructor == null) {
                throw new InvalidOperationException(SR.GetString(SR.FactoryGenerator_TypeHasNoParameterlessConstructor, type.Name));
            }
        }

        private static String GetUniqueCompilationName() {
            return Guid.NewGuid().ToString().Replace('-', '_');
        }

        Type GetFactoryTypeWithAssert(Type type) {
            CheckPublicParameterlessConstructor(type);

            // Create the dynamic assembly if needed.
            Type factoryType;

            if (_dynamicModule == null) {
                lock (this) {
                    if (_dynamicModule == null) {

                        // Use a unique name for each assembly.
                        String name = GetUniqueCompilationName();

                        AssemblyName assemblyName = new AssemblyName();
                        assemblyName.Name = "A_" + name;

                        // Create a new assembly.
                        AssemblyBuilder newAssembly =
                           Thread.GetDomain().DefineDynamicAssembly(assemblyName,
                                                                    AssemblyBuilderAccess.Run,
                                                                    null, //directory to persist assembly
                                                                    true, //isSynchronized
                                                                    null  //assembly attributes
                                                                    );

                        // Create a single module in the assembly.
                        _dynamicModule = newAssembly.DefineDynamicModule("M_" + name);
                    }
                }
            }

            // Give the factory a unique name.

            String typeName = GetUniqueCompilationName();
            TypeBuilder factoryTypeBuilder = _dynamicModule.DefineType("T_" + typeName,
                                                                       TypeAttributes.Public,
                                                                       typeof(Object),
                                                                       _interfacesToImplement);

            // Define the CreateInstance method. It must be virtual to be an interface implementation.

            MethodBuilder method = factoryTypeBuilder.DefineMethod("CreateInstance",
                                                                   MethodAttributes.Public |
                                                                        MethodAttributes.Virtual,
                                                                   _returnedType,
                                                                   null);

            // Generate IL. The generated IL corresponds to "return new type()"
            //      newobj <type_constructor>
            //      ret

            ILGenerator il = method.GetILGenerator();
            ConstructorInfo cons = type.GetConstructor(Type.EmptyTypes);
            il.Emit(OpCodes.Newobj, cons);
            il.Emit(OpCodes.Ret);

            // Specify that this method implements CreateInstance from the inherited interface.
            factoryTypeBuilder.DefineMethodOverride(method, _methodToOverride);

            // Bake in the type.
            factoryType = factoryTypeBuilder.CreateType();

            return factoryType;
        }

        internal IWebObjectFactory CreateFactory(Type type) {
            Debug.Trace("FactoryGenerator", "Creating generator for type " + type.FullName);

            Type factoryType = GetFactoryTypeWithAssert(type);

            // Create the type. This is the only place where Activator.CreateInstance is used,
            // reducing the calls to it from 1 per instance to 1 per type.
            return (IWebObjectFactory) Activator.CreateInstance(factoryType);
        }
    }

}

#endif