/// <summary>
/// Generates all of the properties for the type.
/// </summary>
private void GenerateProperties()
{
IEnumerable <PropertyDescriptor> properties = TypeDescriptor.GetProperties(Type)
.Cast <PropertyDescriptor>()
.OrderBy(p => p.Name);
foreach (PropertyDescriptor pd in properties)
{
if (!ShouldDeclareProperty(pd))
{
continue;
}
// Generate a property getter/setter pair for every property whose type
// we support. Non supported property types will be skipped.
if (CanGenerateProperty(pd))
{
// Ensure the property is not virtual, abstract or new
// If there is a violation, we log the error and keep
// running to accumulate all such errors. This function
// may return an "okay" for non-error case polymorphics.
if (!CanGeneratePropertyIfPolymorphic(pd))
{
continue;
}
if (!GenerateNonSerializableProperty(pd))
{
Type propType = CodeGenUtilities.TranslateType(pd.PropertyType);
List <Type> typesToCodeGen = new List <Type>();
bool isTypeSafeToGenerate = true;
// Create a list containing the types we will require on the client
if (TypeUtility.IsPredefinedDictionaryType(propType))
{
typesToCodeGen.AddRange(CodeGenUtilities.GetDictionaryGenericArgumentTypes(propType));
}
else
{
typesToCodeGen.Add(TypeUtility.GetElementType(propType));
}
// We consider all predefined types as legal to code-gen *except* those
// that would generate a compile error on the client due to missing reference.
// We treat "don't know" and "false" as grounds for a warning.
// Note that we do this *after* TranslateType so that types like System.Data.Linq.Binary
// which cannot exist on the client anyway has been translated
foreach (Type type in typesToCodeGen)
{
// Enum (and nullable<enum>) types may require generation on client
Type nonNullableType = TypeUtility.GetNonNullableType(type);
if (nonNullableType.IsEnum)
{
// Register use of this enum type, which could cause deferred generation
ClientProxyGenerator.RegisterUseOfEnumType(nonNullableType);
}
// If this is not an enum or nullable<enum> and we're not generating the complex type, determine whether this
// property type is visible to the client. If it is not, log a warning.
else
{
// "Don't know" counts as "no"
CodeMemberShareKind enumShareKind = this.ClientProxyGenerator.GetTypeShareKind(nonNullableType);
if ((enumShareKind & CodeMemberShareKind.Shared) == 0)
{
this.ClientProxyGenerator.LogWarning(string.Format(CultureInfo.CurrentCulture, Resource.ClientCodeGen_PropertyType_Not_Shared, pd.Name, this.Type.FullName, type.FullName, this.ClientProxyGenerator.ClientProjectName));
isTypeSafeToGenerate = false; // Flag error but continue to allow accumulation of additional errors.
}
}
}
if (isTypeSafeToGenerate)
{
// Generate OnMethodXxxChanging/Changed partial methods.
// Note: the parameter type reference needs to handle the possibility the
// property type is defined in the project's root namespace and that VB prepends
// that namespace. The utility helper gives us the right type reference.
CodeTypeReference parameterTypeRef =
CodeGenUtilities.GetTypeReference(propType, ClientProxyGenerator, ProxyClass);
NotificationMethodGen.AddMethodFor(pd.Name + "Changing", new CodeParameterDeclarationExpression(parameterTypeRef, "value"), null);
NotificationMethodGen.AddMethodFor(pd.Name + "Changed", null);
GenerateProperty(pd);
}
}
}
else
{
OnPropertySkipped(pd);
}
}
}
/// <summary>
/// Generates a property getter/setter pair into the given proxy class to match the given property info.
/// </summary>
/// <param name="propertyDescriptor">PropertyDescriptor for the property to generate for.</param>
protected virtual void GenerateProperty(PropertyDescriptor propertyDescriptor)
{
string propertyName = propertyDescriptor.Name;
Type propertyType = CodeGenUtilities.TranslateType(propertyDescriptor.PropertyType);
// ----------------------------------------------------------------
// Property type ref
// ----------------------------------------------------------------
var propTypeReference = CodeGenUtilities.GetTypeReference(propertyType, ClientProxyGenerator, ProxyClass);
// ----------------------------------------------------------------
// Property decl
// ----------------------------------------------------------------
var property = new CodeMemberProperty();
property.Name = propertyName;
property.Type = propTypeReference;
property.Attributes = MemberAttributes.Public | MemberAttributes.Final; // final needed, else becomes virtual
List <Attribute> propertyAttributes = propertyDescriptor.ExplicitAttributes().Cast <Attribute>().ToList();
// Generate <summary> for property
string comment = string.Format(CultureInfo.CurrentCulture, Resource.CodeGen_Entity_Property_Summary_Comment, propertyName);
property.Comments.AddRange(CodeGenUtilities.GenerateSummaryCodeComment(comment, ClientProxyGenerator.IsCSharp));
// ----------------------------------------------------------------
// [DataMember] -> Add if not already present.
// ----------------------------------------------------------------
// Add if not already present.
if (!propertyAttributes.OfType <DataMemberAttribute>().Any())
{
CodeAttributeDeclaration dataMemberAtt = CodeGenUtilities.CreateAttributeDeclaration(typeof(DataMemberAttribute), ClientProxyGenerator, ProxyClass);
property.CustomAttributes.Add(dataMemberAtt);
}
// Here, we check for the existence of [ReadOnly(true)] attributes generated when
// the property does not not have a setter. We want to inject an [Editable(false)]
// attribute into the pipeline.
ReadOnlyAttribute readOnlyAttr = propertyAttributes.OfType <ReadOnlyAttribute>().SingleOrDefault();
if (readOnlyAttr != null && !propertyAttributes.OfType <EditableAttribute>().Any())
{
propertyAttributes.Add(new EditableAttribute(!readOnlyAttr.IsReadOnly));
// REVIEW: should we strip out [ReadOnly] attributes here?
}
// Here, we check for the presence of a complex type. If it exists we need to add a DisplayAttribute
// if not already there. DataSources windows do not handle complex types
if (TypeUtility.IsSupportedComplexType(propertyType) && !propertyAttributes.OfType <DisplayAttribute>().Any())
{
CodeAttributeDeclaration displayAttribute = CodeGenUtilities.CreateDisplayAttributeDeclaration(ClientProxyGenerator, ProxyClass);
property.CustomAttributes.Add(displayAttribute);
}
// ----------------------------------------------------------------
// Propagate the custom attributes
// ----------------------------------------------------------------
CustomAttributeGenerator.GenerateCustomAttributes(
ClientProxyGenerator,
ProxyClass,
ex => string.Format(CultureInfo.CurrentCulture, Resource.ClientCodeGen_Attribute_ThrewException_CodeTypeMember, ex.Message, property.Name, ProxyClass.Name, ex.InnerException.Message),
propertyAttributes.Cast <Attribute>(),
property.CustomAttributes,
property.Comments);
// ----------------------------------------------------------------
// backing private field (CodeDom doesn't yet know about auto properties)
// ----------------------------------------------------------------
string fieldName = CodeGenUtilities.MakeCompliantFieldName(propertyName);
var field = new CodeMemberField(propTypeReference, fieldName);
ProxyClass.Members.Add(field);
var fieldRef = new CodeFieldReferenceExpression(new CodeThisReferenceExpression(), fieldName);
var valueRef = new CodePropertySetValueReferenceExpression();
// ----------------------------------------------------------------
// getter body
// ----------------------------------------------------------------
property.GetStatements.Add(new CodeMethodReturnStatement(fieldRef));
// ----------------------------------------------------------------
// setter body
// ----------------------------------------------------------------
List <CodeStatement> bodyStatements = new List <CodeStatement>();
// this.OnPropertyXxxChanging(PropType value);
bodyStatements.Add(NotificationMethodGen.GetMethodInvokeExpressionStatementFor(propertyName + "Changing"));
bool propertyIsReadOnly = IsPropertyReadOnly(propertyDescriptor);
if (!propertyIsReadOnly)
{
bodyStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(new CodeThisReferenceExpression(), "RaiseDataMemberChanging", new CodePrimitiveExpression(propertyDescriptor.Name))));
}
// Generate the validation tests.
CodeStatement validationCode = GeneratePropertySetterValidation(propertyDescriptor.Name);
bodyStatements.Add(validationCode);
// this._field = value
bodyStatements.Add(new CodeAssignStatement(fieldRef, valueRef));
if (!propertyIsReadOnly)
{
bodyStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(new CodeThisReferenceExpression(), "RaiseDataMemberChanged", new CodePrimitiveExpression(propertyDescriptor.Name))));
}
else
{
// even read-only members need to raise PropertyChanged
bodyStatements.Add(new CodeExpressionStatement(new CodeMethodInvokeExpression(new CodeThisReferenceExpression(), "RaisePropertyChanged", new CodePrimitiveExpression(propertyDescriptor.Name))));
}
// this.OnPropertyXxxChanged();
bodyStatements.Add(NotificationMethodGen.GetMethodInvokeExpressionStatementFor(propertyName + "Changed"));
// if (this._field != value)...
CodeExpression valueTest = CodeGenUtilities.MakeNotEqual(propertyType, fieldRef, valueRef, ClientProxyGenerator.IsCSharp);
CodeConditionStatement body = new CodeConditionStatement(valueTest, bodyStatements.ToArray <CodeStatement>());
property.SetStatements.Add(body);
// add property
ProxyClass.Members.Add(property);
}
