Add a strongly typed layer for parts and elements (#1185)

Author: twsouthwick

gen/DocumentFormat.OpenXml.Generator.Models/Generators/Elements/DataModelWriterExtensions.cs

@@ -11,6 +11,15 @@ namespace DocumentFormat.OpenXml.Generator.Generators.Elements;
 
 public static class DataModelWriterExtensions
 {
+    private static HashSet<string> _typedBasedClasses = new()
+    {
+        "OpenXmlElement",
+        "OpenXmlCompositeElement",
+        "OpenXmlLeafElement",
+        "OpenXmlLeafTextElement",
+        "OpenXmlPartRootElement",
+    };
+
     public static bool GetDataModelSyntax(this IndentedTextWriter writer, OpenXmlGeneratorServices services, SchemaNamespace model)
     {
         foreach (var ns in GetNamespaces(model, services).Distinct().OrderBy(n => n))
@@ -53,6 +62,21 @@ public static bool GetDataModelSyntax(this IndentedTextWriter writer, OpenXmlGen
         return delimiter.Count > 0;
     }
 
+    private static string GetBaseName(SchemaType type)
+    {
+        if (type.IsPart)
+        {
+            return "TypedOpenXmlPartRootElement";
+        }
+
+        if (_typedBasedClasses.Contains(type.BaseClass))
+        {
+            return $"Typed{type.BaseClass}";
+        }
+
+        return type.BaseClass;
+    }
+
     private static void WriteType(this IndentedTextWriter writer, OpenXmlGeneratorServices services, SchemaType element)
     {
         writer.WriteDocumentationComment(BuildTypeComments(services, element));
@@ -69,7 +93,7 @@ private static void WriteType(this IndentedTextWriter writer, OpenXmlGeneratorSe
         writer.Write("partial class ");
         writer.Write(className);
         writer.Write(" : ");
-        writer.WriteLine(element.IsPart ? "OpenXmlPartRootElement" : element.BaseClass);
+        writer.WriteLine(GetBaseName(element));
 
         using (writer.AddBlock(new() { AddNewLineBeforeClosing = true, IncludeTrailingNewline = false }))
         {

gen/DocumentFormat.OpenXml.Generator.Models/Generators/Parts/PartWriter.cs

@@ -49,6 +49,7 @@ public static void WritePart(this IndentedTextWriter writer, OpenXmlGeneratorSer
             writer.Write("public partial class ");
             writer.Write(type.Name);
             writer.Write(" : ");
+
             writer.Write(type.Base);
 
             if (type.HasFixedContent)

gen/DocumentFormat.OpenXml.Generator.Models/Models/Part.cs

@@ -5,9 +5,15 @@ namespace DocumentFormat.OpenXml.Generator.Models;
 
 public class Part
 {
+    private string _base = null!;
+
     public string Name { get; set; } = null!;
 
-    public string Base { get; set; } = null!;
+    public string Base
+    {
+        get => _base;
+        set => _base = value.Equals("OpenXmlPart") ? "TypedOpenXmlPart" : value;
+    }
 
     public bool HasFixedContent => ContentType is not null;
 

src/DocumentFormat.OpenXml/AlternateContentChoice.cs

@@ -12,6 +12,8 @@ namespace DocumentFormat.OpenXml
     /// </summary>
     public class AlternateContentChoice : OpenXmlCompositeElement
     {
+        internal static OpenXmlQualifiedName InternalQName => new(AlternateContent.InternalQName.Namespace.Uri, Name);
+
         private const string Name = "Choice";
 
         /// <summary>

src/DocumentFormat.OpenXml/AlternateContentFallback.cs

@@ -12,6 +12,8 @@ namespace DocumentFormat.OpenXml
     /// </summary>
     public class AlternateContentFallback : OpenXmlCompositeElement
     {
+        internal static OpenXmlQualifiedName InternalQName => new(AlternateContent.InternalQName.Namespace.Uri, Name);
+
         private const string Name = "Fallback";
 
         /// <summary>

src/DocumentFormat.OpenXml/Features/DefaultFeatures.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using DocumentFormat.OpenXml.Framework.Metadata;
 using System;
 
 namespace DocumentFormat.OpenXml.Features
@@ -14,6 +15,8 @@ internal partial class DefaultFeatures : IFeatureCollection
         public int Revision => 0;
 
         [KnownFeature(typeof(IOpenXmlNamespaceIdResolver), typeof(OpenXmlNamespaceIdResolver))]
+        [KnownFeature(typeof(IOpenXmlNamespaceResolver), typeof(NoDataNamespaceResolver))]
+        [KnownFeature(typeof(IElementMetadataFactoryFeature), typeof(ElementMetadataFactoryFeature))]
         [ThreadSafe]
         public partial TFeature? Get<TFeature>();
 

src/DocumentFormat.OpenXml/Features/NoDataNamespaceResolver.cs

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using DocumentFormat.OpenXml.Framework;
+using DocumentFormat.OpenXml.Framework.Metadata;
+using System;
+using System.Collections.Generic;
+using System.Xml;
+
+namespace DocumentFormat.OpenXml.Features
+{
+    internal class NoDataNamespaceResolver : IOpenXmlNamespaceResolver
+    {
+        public IDictionary<string, string> GetNamespacesInScope(XmlNamespaceScope scope) => new Dictionary<string, string>();
+
+        public FileFormatVersions GetVersion(OpenXmlNamespace ns) => FileFormatVersions.Office2007;
+
+        public string? LookupNamespace(string prefix) => null;
+
+        public string? LookupPrefix(string namespaceName) => null;
+
+        public bool TryGetExtendedNamespace(OpenXmlNamespace ns, out OpenXmlNamespace extNamespaceUri)
+        {
+            extNamespaceUri = default;
+            return false;
+        }
+
+        public bool TryGetTransitionalNamespace(OpenXmlNamespace ns, out OpenXmlNamespace transitionalNamespace)
+        {
+            transitionalNamespace = default;
+            return false;
+        }
+
+        public bool TryGetTransitionalRelationship(OpenXmlNamespace ns, out OpenXmlNamespace transitionalRelationship)
+        {
+            transitionalRelationship = default;
+            return false;
+        }
+    }
+}

src/DocumentFormat.OpenXml/Features/TypedFeatures.cs

@@ -32,7 +32,6 @@ public static IFeatureCollection Shared
     [KnownFeature(typeof(IRootElementFactory), typeof(ReflectionBasedRootElementFactory))]
     [KnownFeature(typeof(IPartMetadataFeature), typeof(CachedPartMetadataProvider))]
     [KnownFeature(typeof(IOpenXmlNamespaceResolver), typeof(OpenXmlNamespaceResolver))]
-    [KnownFeature(typeof(IElementMetadataFactoryFeature), typeof(TypedElementMetadataFactoryFeature))]
     [KnownFeature(typeof(IPartFactory), typeof(ReflectionPartFactory))]
     [DelegatedFeature(nameof(FeatureCollection.Default), typeof(FeatureCollection))]
     [ThreadSafe]

src/DocumentFormat.OpenXml/Framework/Metadata/TypedElementMetadataFactoryFeature.cs renamed to src/DocumentFormat.OpenXml/Framework/Metadata/ElementMetadataFactoryFeature.cs

@@ -8,7 +8,7 @@
 
 namespace DocumentFormat.OpenXml.Framework.Metadata
 {
-    internal class TypedElementMetadataFactoryFeature : IElementMetadataFactoryFeature
+    internal class ElementMetadataFactoryFeature : IElementMetadataFactoryFeature
     {
         private readonly ConcurrentDictionary<Type, ElementMetadata> _lookup = new(new[]
         {

src/DocumentFormat.OpenXml/OpenXmlCompositeElement.cs

@@ -19,6 +19,8 @@ namespace DocumentFormat.OpenXml
     /// </summary>
     public abstract class OpenXmlCompositeElement : OpenXmlElement
     {
+        private protected const string UseGenericVersion = "Should use the generic version of this. This overload will be removed in a future version.";
+
         private OpenXmlElement? _lastChild;
 
         /// <summary>
@@ -42,7 +44,7 @@ protected OpenXmlCompositeElement(string outerXml)
         /// Initializes a new instance of the OpenXmlCompositeElement class using the supplied collection of elements.
         /// </summary>
         /// <param name="childrenElements">A collection of elements.</param>
-        [Obsolete("Should use the generic version of this. This overload will be removed in a future version.")]
+        [Obsolete(UseGenericVersion)]
         protected OpenXmlCompositeElement(IEnumerable childrenElements)
             : this()
         {