Matthieu MEZIL : VS

How to have a property on ObjectContext which returns the derived entities? v2

Matthieu MEZIL — Thu, 21 Aug 2008 23:23:00 GMT

With Danny advices, I improve my custom code generator to do this in only one generation.

public class SampleEdmxCodeGenerator : BaseCodeGeneratorWithSite
{
    private EntityContainer _objectContext;
    private Dictionary<string, string> _entitySetNames;
    private Dictionary<string, List<string>> _typesHierarchyToAddInObjectContext;
 
    public Dictionary<string, string> EntitySetNames
    {
        get
        {
            if (_entitySetNames == null)
                _entitySetNames = new Dictionary<string, string>();
            return _entitySetNames;
        }
    }
    private Dictionary<string, List<string>> TypesHierarchyToAddInObjectContext
    {
        get
        {
            if (_typesHierarchyToAddInObjectContext == null)
                _typesHierarchyToAddInObjectContext = new Dictionary<string, List<string>>();
            return _typesHierarchyToAddInObjectContext;
        }
    }
    private IEnumerable<string> GetSubEntitiesOf(EntityType baseType)
    {
        var empty = Enumerable.Empty<string>();
        if (_typesHierarchyToAddInObjectContext == null)
            return empty;
        string baseTypeName = baseType.Name;
        if (!_typesHierarchyToAddInObjectContext.ContainsKey(baseTypeName))
            return empty;
        return TypesHierarchyToAddInObjectContext[baseTypeName];
    }
    private void AddSubEntities(string baseType, string typeToAdd)
    {
        string baseTypeName = baseType;
        if (!TypesHierarchyToAddInObjectContext.ContainsKey(baseTypeName))
            TypesHierarchyToAddInObjectContext.Add(baseTypeName, new List<string>());
        TypesHierarchyToAddInObjectContext[baseTypeName].Add(typeToAdd);
    }
 
    protected override string GetDefaultExtension()
    {
        return (".Designer" + base.GetDefaultExtension());
    }
 
    protected override byte[] GenerateCode(string inputFileContent)
    {
        byte[] generatedCodeAsBytes = null;
 
        try
        {
            XElement csdlContent = ExtractCsdlContent(inputFileContent);
            if (csdlContent == null)
            {
                throw new InvalidOperationException("No CSDL content in input file");
            }
 
            _objectContext = null;
            _entitySetNames = null;
            _typesHierarchyToAddInObjectContext = null;
 
            LanguageOption languageOption = LanguageOption.GenerateCSharpCode;
            string fileExtension = base.GetCodeProvider().FileExtension;
            if (fileExtension != null && fileExtension.Length > 0)
            {
                fileExtension = "." + fileExtension.TrimStart(".".ToCharArray());
            }
            if (fileExtension.EndsWith(".vb", StringComparison.InvariantCultureIgnoreCase))
            {
                languageOption = LanguageOption.GenerateVBCode;
            }
            else if (fileExtension.EndsWith(".cs", StringComparison.InvariantCultureIgnoreCase))
            {
                languageOption = LanguageOption.GenerateCSharpCode;
            }
            else
            {
                throw new InvalidOperationException("Unsupported project language. Only C# and VB are supported.");
            }
 
            if (base.CodeGeneratorProgress != null)
            {
                base.CodeGeneratorProgress.Progress(33, 100);
            }
 
            EntityClassGenerator classGenerator;
            IList<EdmSchemaError> errors = null;
            using (StringWriter codeWriter = new StringWriter(CultureInfo.InvariantCulture))
            {
                using (XmlReader csdlReader = csdlContent.CreateReader())
                {
                    classGenerator = new EntityClassGenerator(languageOption);
                    classGenerator.OnTypeGenerated += new TypeGeneratedEventHandler(OnTypeGenerated);
                    classGenerator.OnPropertyGenerated += new PropertyGeneratedEventHandler(OnPropertyGenerated);
 
                    foreach (var entityType in from et in csdlContent.Descendants("{http://schemas.microsoft.com/ado/2006/04/edm}EntityType")
                                               let etBaseType = et.Attributes("BaseType").FirstOrDefault()
                                               where etBaseType != null
                                               select new { EntityType = et.Attribute("Name").Value, BaseType = etBaseType.Value })
                    {
                        var baseType = entityType.BaseType;
                        string baseTypeTmp;
                        while ((baseTypeTmp = (from et in csdlContent.Descendants("{http://schemas.microsoft.com/ado/2006/04/edm}EntityType")
                                               where et.Attribute("Name").Value == baseType
                                               let etBaseType = et.Attributes("BaseType").FirstOrDefault()
                                               where etBaseType != null
                                               select etBaseType.Value).FirstOrDefault()) != null)
                            baseTypeTmp = baseType;
                        Func<string, string> getSimpleName = entityTypeName => entityTypeName.Substring(entityTypeName.IndexOf(".") + 1);
                        AddSubEntities(getSimpleName(baseType), getSimpleName(entityType.EntityType));
                    }
 
                    errors = classGenerator.GenerateCode(csdlReader, codeWriter);
                }
                if (base.CodeGeneratorProgress != null)
                {
                    base.CodeGeneratorProgress.Progress(66, 100);
                }
                if (errors != null)
                {
                    foreach (EdmSchemaError error in errors)
                    {
                        int line = (error.Line == 0) ? 0 : (error.Line - 1);
                        int column = (error.Column == 0) ? 0 : (error.Column - 1);
 
                        if (error.Severity == EdmSchemaErrorSeverity.Warning)
                        {
                            base.GeneratorWarning(0, error.Message, (uint)line, (uint)column);
                        }
                        else
                        {
                            base.GeneratorError(4, error.Message, (uint)line, (uint)column);
                        }
                    }
                }
 
                generatedCodeAsBytes = Encoding.UTF8.GetBytes(codeWriter.ToString());
            }
            if (base.CodeGeneratorProgress != null)
            {
                base.CodeGeneratorProgress.Progress(100, 100);
            }
        }
        catch (Exception e)
        {
            base.GeneratorError(4, e.Message, 1, 1);
 
            generatedCodeAsBytes = null;
        }
 
        return generatedCodeAsBytes;
    }
 
    private void OnTypeGenerated(object sender, TypeGeneratedEventArgs eventArgs)
    {
        eventArgs.AdditionalAttributes.AddRange(CreateCodeAttributes(eventArgs.TypeSource));
 
        var objectContext = eventArgs.TypeSource as EntityContainer;
        if (objectContext != null)
        {
            _objectContext = objectContext;
            var baseEntitySets = _objectContext.MetadataProperties.FirstOrDefault(mp => mp.Name == "BaseEntitySets");
            if (baseEntitySets != null)
            {
                foreach (var entitySet in (ReadOnlyMetadataCollection<EntitySetBase>)baseEntitySets.Value)
                {
                    var derivedBaseEntityType = entitySet.ElementType as EntityType;
                    if (derivedBaseEntityType != null)
                    {
                        EntitySetNames.Add(derivedBaseEntityType.Name, entitySet.Name);
                        if (_typesHierarchyToAddInObjectContext != null)
                            foreach (var derivedEntityTypeName in GetSubEntitiesOf(derivedBaseEntityType))
                            {
                                var newProp = new CodeMemberProperty { Name = derivedEntityTypeName + "s", Attributes = MemberAttributes.Public | MemberAttributes.Final, Type = new CodeTypeReference("global::System.Linq.IQueryable<" + derivedEntityTypeName + ">") };
                                newProp.GetStatements.Add(new CodeMethodReturnStatement(new CodeMethodInvokeExpression(new CodeMethodReferenceExpression(new CodePropertyReferenceExpression(new CodeThisReferenceExpression(), _entitySetNames[derivedBaseEntityType.Name]), "OfType", new CodeTypeReference(derivedEntityTypeName)))));
                                eventArgs.AdditionalMembers.Add(newProp);
                            }
                    }
                }
            }
        }
    }
 
    private void OnPropertyGenerated(object sender, PropertyGeneratedEventArgs eventArgs)
    {
        eventArgs.AdditionalAttributes.AddRange(CreateCodeAttributes(eventArgs.PropertySource));
    }
 
    private IList<CodeAttributeDeclaration> CreateCodeAttributes(MetadataItem item)
    {
        string xmlns = "http://tempuri.org/AttributeAnnotations";
 
        List<CodeAttributeDeclaration> codeAttributeDeclarations = new List<CodeAttributeDeclaration>();
        if (item != null)
        {
            IEnumerable<MetadataProperty> metadataProperties = item.MetadataProperties.Where(prop => prop.Name.StartsWith(xmlns));
            foreach (MetadataProperty metadataProperty in metadataProperties)
            {
                string metadataPropertyValue = (string)metadataProperty.Value;
                if (!String.IsNullOrEmpty(metadataPropertyValue))
                {
                    string[] attributes = metadataPropertyValue.Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
                    foreach (string attribute in attributes)
                    {
                        string attributeName = attribute;
                        string[] attributeParams = new string[1];
 
                        if (attribute.Contains('('))
                        {
                            attributeParams = attribute.Split(new char[] { '(', ')' }, StringSplitOptions.RemoveEmptyEntries);
                            attributeName = attributeParams[0];
                        }
 
                        CodeAttributeDeclaration codeAttributeDeclaration = new CodeAttributeDeclaration(attributeName);
 
                        foreach (string attributeParam in attributeParams.Skip(1))
                        {
                            object attributeParamObj = null;
                            bool attributeParamBool = false;
                            if (bool.TryParse(attributeParam, out attributeParamBool))
                            {
                                attributeParamObj = attributeParamBool;
                            }
                            else
                            {
                                attributeParamObj = attributeParam;
                            }
                            codeAttributeDeclaration.Arguments.Add(new CodeAttributeArgument(new CodePrimitiveExpression(attributeParamObj)));
                        }
                        codeAttributeDeclarations.Add(codeAttributeDeclaration);
                    }
                }
            }
        }
        return codeAttributeDeclarations;
    }
 
    private XElement ExtractCsdlContent(string inputFileContent)
    {
        XElement csdlContent = null;
        XNamespace edmxns = "http://schemas.microsoft.com/ado/2007/06/edmx";
        XNamespace edmns = "http://schemas.microsoft.com/ado/2006/04/edm";
 
        XDocument edmxDoc = XDocument.Load(new StringReader(inputFileContent));
        if (edmxDoc != null)
        {
            XElement edmxNode = edmxDoc.Element(edmxns + "Edmx");
            if (edmxNode != null)
            {
                XElement runtimeNode = edmxNode.Element(edmxns + "Runtime");
                if (runtimeNode != null)
                {
                    XElement conceptualModelsNode = runtimeNode.Element(edmxns + "ConceptualModels");
                    if (conceptualModelsNode != null)
                    {
                        csdlContent = conceptualModelsNode.Element(edmns + "Schema");
                    }
                }
            }
        }
        return csdlContent;
    }
}

How to debug a code generator used by VS?

Matthieu MEZIL — Thu, 21 Aug 2008 14:39:00 GMT

In my case, I wanted to debug my edmx CodeGen but you can do it for a lot of other cases.

So how to debug your CodeGen?

I think there is probably a better way but this is what I did:

In my CodeGen, I put a MessageBox.Show

I open 2 VS: one with my CodeGen code and one with the project which will run the CodeGen
In the second VS, I run the CodeGen (for the edmx CodeGen, I change the Custom Tool value). The generation pauses with the MessageBox
I go to the first VS, I attach the second devenv process. Then I put a breakpoint after the MessageBox.Show
I go back to the second VS and I validate the MessageBox
I go back to my first projet. I am on my breapoint and I can now debug my code generator

Nice isn't it?

How to have a property on ObjectContext which returns the derived entities?

Matthieu MEZIL — Thu, 21 Aug 2008 13:40:00 GMT

With EF v1, we have an ObjectContext which has one property per EntitySet. The "problem" is that if you have an entity type Person and an entity type Employee which inherits Person, you will have only one property Persons because there is only one EntitySet Persons.

If you want to add a property Employees, you can do this:

public IQueryable<Employee> Employees
{
    get
    {
        return Persons.OfType<Employee>();
    }
}

Note that your ObjectContext generated class is partial.

Very easy!

As I said yesterday in this msdn forum thread, it is possible to customize the code generator in order to have this property directly on the generated code.

I use the SampleEdmxCodeGen project to do this:

public class SampleEdmxCodeGenerator : BaseCodeGeneratorWithSite
{
    private EntityContainer _objectContext;
    private Dictionary<string, EntitySetBase> _entitySetNames;
    private Dictionary<string, List<EntityType>> _typesHierarchyToAddInObjectContext;
    private bool _first = true;
 
    public Dictionary<string, EntitySetBase> EntitySetNames
    {
        get
        {
            if (_entitySetNames == null)
                _entitySetNames = new Dictionary<string, EntitySetBase>();
            return _entitySetNames;
        }
    }
    private Dictionary<string, List<EntityType>> TypesHierarchyToAddInObjectContext
    {
        get
        {
            if (_typesHierarchyToAddInObjectContext == null)
                _typesHierarchyToAddInObjectContext = new Dictionary<string, List<EntityType>>();
            return _typesHierarchyToAddInObjectContext;
        }
    }
    private IEnumerable<EntityType> GetSubEntitiesOf(EntityType baseType)
    {
        var empty = Enumerable.Empty<EntityType>();
        if (_typesHierarchyToAddInObjectContext == null)
            return empty;
        string baseTypeName = baseType.Name;
        if (!_typesHierarchyToAddInObjectContext.ContainsKey(baseTypeName))
            return empty;
        return TypesHierarchyToAddInObjectContext[baseTypeName];
    }
    private void AddSubEntities(EntityType baseType, EntityType typeToAdd)
    {
        string baseTypeName = baseType.Name;
        if (!TypesHierarchyToAddInObjectContext.ContainsKey(baseTypeName))
            TypesHierarchyToAddInObjectContext.Add(baseTypeName, new List<EntityType>());
        TypesHierarchyToAddInObjectContext[baseTypeName].Add(typeToAdd);
    }
 
    protected override string GetDefaultExtension()
    {
        return (".Designer" + base.GetDefaultExtension());
    }
 
    protected override byte[] GenerateCode(string inputFileContent)
    {
        byte[] generatedCodeAsBytes = null;
 
        try
        {
            XElement csdlContent = ExtractCsdlContent(inputFileContent);
            if (csdlContent == null)
            {
                throw new InvalidOperationException("No CSDL content in input file");
            }
 
            _objectContext = null;
            _entitySetNames = null;
            _typesHierarchyToAddInObjectContext = null;
 
            _first = true;
 
            // Determine language for generated code
            LanguageOption languageOption = LanguageOption.GenerateCSharpCode;
            string fileExtension = base.GetCodeProvider().FileExtension;
            if (fileExtension != null && fileExtension.Length > 0)
            {
                fileExtension = "." + fileExtension.TrimStart(".".ToCharArray());
            }
            if (fileExtension.EndsWith(".vb", StringComparison.InvariantCultureIgnoreCase))
            {
                languageOption = LanguageOption.GenerateVBCode;
            }
            else if (fileExtension.EndsWith(".cs", StringComparison.InvariantCultureIgnoreCase))
            {
                languageOption = LanguageOption.GenerateCSharpCode;
            }
            else
            {
                throw new InvalidOperationException("Unsupported project language. Only C# and VB are supported.");
            }
 
            if (base.CodeGeneratorProgress != null)
            {
                base.CodeGeneratorProgress.Progress(33, 100);
            }
 
            EntityClassGenerator classGenerator;
            IList<EdmSchemaError> errors = null;
            StringWriter codeWriter = new StringWriter(CultureInfo.InvariantCulture);
            for (int i = 0; i < 2; i++)
            {
                using (XmlReader csdlReader = csdlContent.CreateReader())
                {
                    classGenerator = new EntityClassGenerator(languageOption);
                    classGenerator.OnTypeGenerated += new TypeGeneratedEventHandler(OnTypeGenerated);
                    classGenerator.OnPropertyGenerated += new PropertyGeneratedEventHandler(OnPropertyGenerated);
 
                    errors = classGenerator.GenerateCode(csdlReader, codeWriter);
                }
                if (! _first)
                    break;
                _first = false;
                if (base.CodeGeneratorProgress != null)
                {
                    base.CodeGeneratorProgress.Progress(66, 100);
                }
                codeWriter.Dispose();
                codeWriter = new StringWriter(CultureInfo.InvariantCulture);
            }
            if (errors != null)
            {
                foreach (EdmSchemaError error in errors)
                {
                    int line = (error.Line == 0) ? 0 : (error.Line - 1);
                    int column = (error.Column == 0) ? 0 : (error.Column - 1);
 
                    if (error.Severity == EdmSchemaErrorSeverity.Warning)
                    {
                        base.GeneratorWarning(0, error.Message, (uint)line, (uint)column);
                    }
                    else
                    {
                        base.GeneratorError(4, error.Message, (uint)line, (uint)column);
                    }
                }
            }
 
            generatedCodeAsBytes = Encoding.UTF8.GetBytes(codeWriter.ToString());
            codeWriter.Dispose();
            if (base.CodeGeneratorProgress != null)
            {
                base.CodeGeneratorProgress.Progress(100, 100);
            }
        }
        catch (Exception e)
        {
            base.GeneratorError(4, e.Message, 1, 1);
 
            generatedCodeAsBytes = null;
        }
 
        return generatedCodeAsBytes;
    }
 
    private void OnTypeGenerated(object sender, TypeGeneratedEventArgs eventArgs)
    {
        var entityType = eventArgs.TypeSource as System.Data.Metadata.Edm.EntityType;
        if (_first)
        {
            if (entityType != null)
            {
                EdmType baseType;
                if ((baseType = entityType.BaseType) != null)
                {
                    //System.Windows.Forms.MessageBox.Show("");
                    while (baseType.BaseType != null)
                        baseType = baseType.BaseType;
                    var baseEntityType = baseType as EntityType;
                    AddSubEntities(baseEntityType, entityType);
                }
            }
        }
        else
        {
            eventArgs.AdditionalAttributes.AddRange(CreateCodeAttributes(eventArgs.TypeSource));
            var objectContext = eventArgs.TypeSource as EntityContainer;
            if (objectContext != null)
            {
                _objectContext = objectContext;
                var baseEntitySets = _objectContext.MetadataProperties.FirstOrDefault(mp => mp.Name == "BaseEntitySets");
                if (baseEntitySets != null)
                {
                    foreach (var entitySet in (ReadOnlyMetadataCollection<EntitySetBase>)baseEntitySets.Value)
                    {
                        var derivedBaseEntityType = entitySet.ElementType as EntityType;
                        if (derivedBaseEntityType != null)
                        {
                            EntitySetNames.Add(derivedBaseEntityType.Name, entitySet);
                            if (_typesHierarchyToAddInObjectContext != null)
                                foreach (var derivedEntityType in GetSubEntitiesOf(derivedBaseEntityType))
                                {
                                    string derivedEntityTypeName = derivedEntityType.Name;
                                    var newProp = new CodeMemberProperty { Name = derivedEntityTypeName + "s", Attributes = MemberAttributes.Public | MemberAttributes.Final, Type = new CodeTypeReference("global::System.Linq.IQueryable<" + derivedEntityTypeName + ">") };
                                    newProp.GetStatements.Add(new CodeMethodReturnStatement(new CodeMethodInvokeExpression(new CodeMethodReferenceExpression(new CodePropertyReferenceExpression(new CodeThisReferenceExpression(), _entitySetNames[derivedBaseEntityType.Name].Name), "OfType", new CodeTypeReference(derivedEntityTypeName)))));
                                    eventArgs.AdditionalMembers.Add(newProp);
                                }
                        }
                    }
                }
            }
        }
    }
 
    private void OnPropertyGenerated(object sender, PropertyGeneratedEventArgs eventArgs)
    {
        if (!_first)
            eventArgs.AdditionalAttributes.AddRange(CreateCodeAttributes(eventArgs.PropertySource));
    }
 
    private IList<CodeAttributeDeclaration> CreateCodeAttributes(MetadataItem item)
    {
        string xmlns = "http://tempuri.org/AttributeAnnotations";
 
        List<CodeAttributeDeclaration> codeAttributeDeclarations = new List<CodeAttributeDeclaration>();
        if (item != null)
        {
            IEnumerable<MetadataProperty> metadataProperties = item.MetadataProperties.Where(prop => prop.Name.StartsWith(xmlns));
            foreach (MetadataProperty metadataProperty in metadataProperties)
            {
                string metadataPropertyValue = (string)metadataProperty.Value;
                if (!String.IsNullOrEmpty(metadataPropertyValue))
                {
                    string[] attributes = metadataPropertyValue.Split(new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
                    foreach (string attribute in attributes)
                    {
                        string attributeName = attribute;
                        string[] attributeParams = new string[1];
 
                        if (attribute.Contains('('))
                        {
                            attributeParams = attribute.Split(new char[] { '(', ')' }, StringSplitOptions.RemoveEmptyEntries);
                            attributeName = attributeParams[0];
                        }
 
                        CodeAttributeDeclaration codeAttributeDeclaration = new CodeAttributeDeclaration(attributeName);
 
                        foreach (string attributeParam in attributeParams.Skip(1))
                        {
                            object attributeParamObj = null;
                            bool attributeParamBool = false;
                            if (bool.TryParse(attributeParam, out attributeParamBool))
                            {
                                attributeParamObj = attributeParamBool;
                            }
                            else
                            {
                                attributeParamObj = attributeParam;
                            }
                            codeAttributeDeclaration.Arguments.Add(new CodeAttributeArgument(new CodePrimitiveExpression(attributeParamObj)));
                        }
                        codeAttributeDeclarations.Add(codeAttributeDeclaration);
                    }
                }
            }
        }
        return codeAttributeDeclarations;
    }
 
    private XElement ExtractCsdlContent(string inputFileContent)
    {
        XElement csdlContent = null;
        XNamespace edmxns = "http://schemas.microsoft.com/ado/2007/06/edmx";
        XNamespace edmns = "http://schemas.microsoft.com/ado/2006/04/edm";
 
        XDocument edmxDoc = XDocument.Load(new StringReader(inputFileContent));
        if (edmxDoc != null)
        {
            XElement edmxNode = edmxDoc.Element(edmxns + "Edmx");
            if (edmxNode != null)
            {
                XElement runtimeNode = edmxNode.Element(edmxns + "Runtime");
                if (runtimeNode != null)
                {
                    XElement conceptualModelsNode = runtimeNode.Element(edmxns + "ConceptualModels");
                    if (conceptualModelsNode != null)
                    {
                        csdlContent = conceptualModelsNode.Element(edmns + "Schema");
                    }
                }
            }
        }
        return csdlContent;
    }
}

The big difference between this and my previous custom generator is that, as the context is generated before the entity types, I must run the generation twice. The first to identify the sub entity types and the second to actually generate the code.

Debug with the .Net Framework code

Matthieu MEZIL — Thu, 21 Aug 2008 08:27:00 GMT

With VS2008, we were able to Debug with the .Net Framework code. But there weren't all the dll.

With the SP1, yes!

Moreover, the activation of this is really easier than before. You don't have anything to do! You just need to go to the call stack, to right click on a Framework method, to go to "Load Symbols From" and then "Microsoft Symbol Servers".

Enjoy