1 #Region "Microsoft.VisualBasic::b1d95fd6d421d1d8173e61a1f2d1d020, Microsoft.VisualBasic.Core\ComponentModel\DataSource\SchemaMaps\BindProperty(Of T).vb"
2
3     ' Author:
4     
5     '       asuka (amethyst.asuka@gcmodeller.org)
6     '       xie (genetics@smrucc.org)
7     '       xieguigang (xie.guigang@live.com)
8     
9     ' Copyright (c) 2018 GPL3 Licensed
10     
11     
12     ' GNU GENERAL PUBLIC LICENSE (GPL3)
13     
14     
15     ' This program is free software: you can redistribute it and/or modify
16     ' it under the terms of the GNU General Public License as published by
17     ' the Free Software Foundation, either version 3 of the License, or
18     ' (at your option) any later version.
19     
20     ' This program is distributed in the hope that it will be useful,
21     ' but WITHOUT ANY WARRANTY; without even the implied warranty of
22     ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23     ' GNU General Public License for more details.
24     
25     ' You should have received a copy of the GNU General Public License
26     ' along with this program. If not, see <http://www.gnu.org/licenses/>.
27
28
29
30     ' /********************************************************************************/
31
32     ' Summaries:
33
34     '     Structure BindProperty
35     
36     '         Properties: Identity, IsNull, IsPrimitive, Type
37     
38     '         Constructor: (+4 OverloadsSub New
39     
40     '         Function: FromSchemaTable, GetValue, ToString
41     
42     '         SubSetValue
43     
44     
45     ' /********************************************************************************/
46
47 #End Region
48
49 Imports System.Reflection
50 Imports System.Runtime.CompilerServices
51 Imports Microsoft.VisualBasic.ComponentModel.Collection.Generic
52 Imports Microsoft.VisualBasic.Emit.Delegates
53
54 Namespace ComponentModel.DataSourceModel.SchemaMaps
55
56     ''' <summary>
57     ''' Schema for <see cref="Attribute"/> and its bind <see cref="PropertyInfo"/>/<see cref="FieldInfo"/> object target.
58     ''' (使用这个对象将公共的域或者属性的读写统一起来)
59     ''' </summary>
60     ''' <typeparam name="T"></typeparam>
61     Public Structure BindProperty(Of T As Attribute)
62         Implements IReadOnlyId
63         Implements INamedValue
64         Implements IProperty
65
66         ''' <summary>
67         ''' The property/field object that bind with its custom attribute <see cref="field"/> of type <typeparamref name="T"/>
68         ''' </summary>
69         Dim member As MemberInfo
70         ''' <summary>
71         ''' The flag for this field binding.
72         ''' </summary>
73         Dim field As T
74         Dim name As String
75
76         ReadOnly __setValue As Action(Of ObjectObject)
77         ReadOnly __getValue As Func(Of ObjectObject)
78
79 #Region "Property List"
80
81         ''' <summary>
82         ''' Gets the type of this <see cref="member"/>.
83         ''' </summary>
84         ''' <returns></returns>
85         Public ReadOnly Property Type As Type
86
87         ''' <summary>
88         ''' The map name or the <see cref="PropertyInfo.Name"/>.
89         ''' (这个属性会首先查找标记的自定义属性的名称结果,如果不存在才会使用属性或者字段的反射成员名称)
90         ''' </summary>
91         ''' <returns></returns>
92         Public Property Identity As String Implements IReadOnlyId.Identity, INamedValue.Key
93             <MethodImpl(MethodImplOptions.AggressiveInlining)>
94             Get
95                 If name.StringEmpty Then
96                     name = member.Name
97                 End If
98
99                 Return name
100             End Get
101             Friend Set(value As String)
102                 name = value
103             End Set
104         End Property
105
106         ''' <summary>
107         ''' Is this map data is null on its attribute or property data?
108         ''' </summary>
109         ''' <returns></returns>
110         Public ReadOnly Property IsNull As Boolean
111             <MethodImpl(MethodImplOptions.AggressiveInlining)>
112             Get
113                 Return member Is Nothing OrElse field Is Nothing
114             End Get
115         End Property
116
117         ''' <summary>
118         ''' Gets a value indicating whether the <see cref="System.Type"/> is one of the primitive types.
119         ''' </summary>
120         ''' <returns>
121         ''' true if the <see cref="System.Type"/> is one of the primitive types; otherwise, false.
122         ''' </returns>
123         Public ReadOnly Property IsPrimitive As Boolean
124             <MethodImpl(MethodImplOptions.AggressiveInlining)>
125             Get
126                 Return Scripting.IsPrimitive(Type)
127             End Get
128         End Property
129 #End Region
130
131         Sub New(attr As T, prop As PropertyInfo)
132             field = attr
133             member = prop
134             Type = prop.PropertyType
135
136             ' Compile the property get/set as the delegate
137             With prop
138                 __setValue = AddressOf prop.SetValue  ' .DeclaringType.PropertySet(.Name)
139                 __getValue = AddressOf prop.GetValue  ' .DeclaringType.PropertyGet(.Name)
140             End With
141         End Sub
142
143         <MethodImpl(MethodImplOptions.AggressiveInlining)>
144         Sub New([property] As PropertyInfo)
145             Call Me.New(Nothing, [property])
146         End Sub
147
148         <MethodImpl(MethodImplOptions.AggressiveInlining)>
149         Sub New(field As FieldInfo)
150             Call Me.New(Nothing, field)
151         End Sub
152
153         Sub New(attr As T, field As FieldInfo)
154             Me.field = attr
155             Me.member = field
156             Type = field.FieldType
157
158             With field
159                 __setValue = AddressOf field.SetValue  ' .DeclaringType.FieldSet(.Name)
160                 __getValue = AddressOf field.GetValue  ' .DeclaringType.FieldGet(.Name)
161             End With
162         End Sub
163
164         ' Exceptions:
165         '   T:System.ArgumentException:
166         '     The index array does not contain the type of arguments needed.-or- The property's
167         '     set accessor is not found. -or-value cannot be converted to the type of System.Reflection.PropertyInfo.PropertyType.
168         '
169         '   T:System.Reflection.TargetException:
170         '     In the .NET for Windows Store apps or the Portable Class Library, catch System.Exception
171         '     instead.The object does not match the target type, or a property is an instance
172         '     property but obj is null.
173         '
174         '   T:System.Reflection.TargetParameterCountException:
175         '     The number of parameters in index does not match the number of parameters the
176         '     indexed property takes.
177         '
178         '   T:System.MethodAccessException:
179         '     In the .NET for Windows Store apps or the Portable Class Library, catch the base
180         '     class exception, System.MemberAccessException, instead.There was an illegal attempt
181         '     to access a private or protected method inside a class.
182         '
183         '   T:System.Reflection.TargetInvocationException:
184         '     An error occurred while setting the property value. For example, an index value
185         '     specified for an indexed property is out of range. The System.Exception.InnerException
186         '     property indicates the reason for the error.
187
188         ''' <summary>
189         ''' Sets the property value of a specified object with optional index values for
190         ''' index properties.
191         ''' (这个设置值的函数只适用于``Class``类型,对于``Structure``类型而言,则无法正常的工作)
192         ''' </summary>
193         ''' <param name="obj">The object whose property value will be set.</param>
194         ''' <param name="value">The new property value.</param>
195         ''' 
196         <MethodImpl(MethodImplOptions.AggressiveInlining)>
197         Public Sub SetValue(obj As Object, value As ObjectImplements IProperty.SetValue
198             ' 2017-6-26 目前value参数为空值的话,会报错,故而在这里添加了一个If分支判断
199             If value IsNot Nothing Then
200                 Call __setValue(obj, value)
201             End If
202         End Sub
203
204         ' Exceptions:
205         '   T:System.ArgumentException:
206         '     The index array does not contain the type of arguments needed.-or- The property's
207         '     get accessor is not found.
208         '
209         '   T:System.Reflection.TargetException:
210         '     In the .NET for Windows Store apps or the Portable Class Library, catch System.Exception
211         '     instead.The object does not match the target type, or a property is an instance
212         '     property but obj is null.
213         '
214         '   T:System.Reflection.TargetParameterCountException:
215         '     The number of parameters in index does not match the number of parameters the
216         '     indexed property takes.
217         '
218         '   T:System.MethodAccessException:
219         '     In the .NET for Windows Store apps or the Portable Class Library, catch the base
220         '     class exception, System.MemberAccessException, instead.There was an illegal attempt
221         '     to access a private or protected method inside a class.
222         '
223         '   T:System.Reflection.TargetInvocationException:
224         '     An error occurred while retrieving the property value. For example, an index
225         '     value specified for an indexed property is out of range. The System.Exception.InnerException
226         '     property indicates the reason for the error.
227
228         ''' <summary>
229         ''' Returns the property value of a specified object with optional index values for
230         ''' indexed properties.
231         ''' </summary>
232         ''' <param name="x">The object whose property value will be returned.</param>
233         ''' <returns>The property value of the specified object.</returns>
234         ''' 
235         <MethodImpl(MethodImplOptions.AggressiveInlining)>
236         Public Function GetValue(x As ObjectAs Object Implements IProperty.GetValue
237             Return __getValue(x)
238         End Function
239
240         ''' <summary>
241         ''' Display this schema maps in Visualbasic style.
242         ''' </summary>
243         ''' <returns></returns>
244         Public Overrides Function ToString() As String
245             Return $"Dim {member.Name} As {Type.FullName}"
246         End Function
247
248         <MethodImpl(MethodImplOptions.AggressiveInlining)>
249         Public Shared Function FromSchemaTable(x As KeyValuePair(Of T, PropertyInfo)) As BindProperty(Of T)
250             Return New BindProperty(Of T) With {
251                 .field = x.Key,
252                 .member = x.Value
253             }
254         End Function
255     End Structure
256 End Namespace