Add XML Serialization classes

fredrikhr · fredrikhr · commit 5c7c16cc9bca · 2024-05-28T22:07:02.000+02:00
diff --git a/sources/ClangSharp.PInvokeGenerator/GlobalSuppressions.cs b/sources/ClangSharp.PInvokeGenerator/GlobalSuppressions.cs
@@ -0,0 +1,16 @@
+// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage(
+    "Design",
+    "CA1002: Do not expose generic lists",
+    Scope = "namespaceAndDescendants",
+    Target = "~N:ClangSharp.XML",
+    Justification = nameof(System.Xml.Serialization)
+    )]
+
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/BindingsElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/BindingsElement.cs
@@ -0,0 +1,18 @@
+// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+[XmlRoot("bindings")]
+public sealed class BindingsElement
+{
+    [XmlElement("comment")]
+    public string? HeaderText { get; init; }
+
+    [XmlElement("namespace")]
+    public List<NamespaceElement> Namespaces { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/CSharpCodeElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/CSharpCodeElement.cs
@@ -0,0 +1,15 @@
+// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Xml;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public sealed class CSharpCodeElement
+{
+    [XmlText]
+    [XmlAnyElement]
+    public List<XmlNode> Segments { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/ConstantDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/ConstantDescElement.cs
@@ -0,0 +1,8 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class ConstantDescElement : FieldDescElement { }
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/DelegateDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/DelegateDescElement.cs
@@ -0,0 +1,8 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class DelegateDescElement : FunctionOrDelegateDescElement { }
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/EnumConstantDeclElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/EnumConstantDeclElement.cs
@@ -0,0 +1,10 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Diagnostics;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+[DebuggerDisplay($"{{{nameof(Name)},nq}}")]
+public class EnumConstantDeclElement : FieldDescElement { }
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/EnumDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/EnumDescElement.cs
@@ -0,0 +1,19 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class EnumDescElement : NamedAccessDescElement
+{
+    [XmlElement("attribute")]
+    public List<string> Attributes { get; } = [];
+
+    [XmlElement("type")]
+    public required string TypeName { get; init; }
+
+    [XmlElement("enumerator")]
+    public List<EnumConstantDeclElement> Enumerators { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/FieldDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/FieldDescElement.cs
@@ -0,0 +1,54 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Globalization;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+[DebuggerDisplay($"{{{nameof(AccessSpecifier)},nq}} {{{nameof(Type)}}} {{{nameof(Name)},nq}}")]
+public class FieldDescElement : NamedAccessDescElement
+{
+    [XmlAttribute("inherited")]
+    public string? InheritedFrom { get; init; }
+
+    [XmlAttribute("offset")]
+    public string? OffsetValue { get; init; }
+
+    [XmlIgnore]
+    public int? Offset
+    {
+        get
+        {
+            return int.TryParse(
+                OffsetValue,
+                CultureInfo.InvariantCulture,
+                out var offset
+                ) ? offset : null;
+        }
+
+        init
+        {
+            OffsetValue = value.HasValue
+                ? value.Value.ToString(CultureInfo.InvariantCulture)
+                : null;
+        }
+    }
+
+    [XmlElement("attribute")]
+    public List<string> Attributes { get; } = [];
+
+    [XmlElement("type")]
+    public required FieldTypeElement Type { get; init; }
+
+    [XmlElement("value")]
+    public ValueDescValueElement? Initializer { get; init; }
+
+    [XmlElement("get")]
+    public PropertyAccessorElement? Getter { get; init; }
+
+    [XmlElement("set")]
+    public PropertyAccessorElement? Setter { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/FieldTypeElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/FieldTypeElement.cs
@@ -0,0 +1,15 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class FieldTypeElement : TypeWithNativeTypeNameElement
+{
+    [XmlAttribute("count")]
+    public string? Count { get; init; }
+
+    [XmlAttribute("fixed")]
+    public string? FixedName { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/FunctionBodyElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/FunctionBodyElement.cs
@@ -0,0 +1,12 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class FunctionBodyElement
+{
+    [XmlElement("code")]
+    public CSharpCodeElement? Code { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/FunctionDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/FunctionDescElement.cs
@@ -0,0 +1,19 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class FunctionDescElement : FunctionOrDelegateDescElement
+{
+    [XmlElement("init")]
+    public List<TypeInitializationExpressionElement> TypeInitializationExpressions { get; } = [];
+
+    [XmlElement("body")]
+    public FunctionBodyElement? BlockBody { get; init; }
+
+    [XmlElement("code")]
+    public CSharpCodeElement? ExpressionBody { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/FunctionOrDelegateDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/FunctionOrDelegateDescElement.cs
@@ -0,0 +1,76 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Globalization;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public abstract class FunctionOrDelegateDescElement : NamedAccessDescElement
+{
+    [XmlAttribute("lib")]
+    public string? LibraryPath { get; init; }
+
+    [XmlAttribute("convention")]
+    public string? CallingConvention { get; init; }
+
+    [XmlAttribute("entrypoint")]
+    public string? EntryPoint { get; init; }
+
+    [XmlAttribute("setlasterror")]
+    public bool SetLastError { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool SetLastErrorSpecified => SetLastError;
+
+    [XmlAttribute("static")]
+    public bool IsStatic { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool IsStaticSpecified => IsStatic;
+
+    [XmlAttribute("unsafe")]
+    public bool IsUnsafe { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool IsUnsafeSpecified => IsUnsafe;
+
+    [XmlAttribute("vtblindex")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public string? VtblIndexValue { get; init; }
+
+    [XmlIgnore]
+    public long? VtblIndex
+    {
+        get
+        {
+            return !string.IsNullOrEmpty(VtblIndexValue)
+                && long.TryParse(
+                    VtblIndexValue,
+                    CultureInfo.InvariantCulture,
+                    out var vtblindex
+                    ) ? vtblindex : null;
+        }
+
+        init
+        {
+            VtblIndexValue = value.HasValue
+                ? value.Value.ToString(CultureInfo.InvariantCulture)
+                : null;
+        }
+    }
+
+    [XmlElement("attribute")]
+    public List<string> Attributes { get; } = [];
+
+    [XmlElement("type")]
+    public required TypeWithNativeTypeNameElement ReturnType { get; init; }
+
+    [XmlElement("param")]
+    public List<ParameterDescElement> Parameters { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/IidDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/IidDescElement.cs
@@ -0,0 +1,12 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class IidDescElement : NamedDescElement
+{
+    [XmlAttribute("value")]
+    public required string Value { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/IndexerDeclElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/IndexerDeclElement.cs
@@ -0,0 +1,29 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.ComponentModel;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class IndexerDeclElement
+{
+    [XmlAttribute("access")]
+    public required string AccessSpecifier { get; init; }
+
+    [XmlAttribute("unsafe")]
+    public bool IsUnsafe { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool IsUnsafeSpecified => IsUnsafe;
+
+    [XmlElement("type")]
+    public required string Type { get; init; }
+
+    [XmlElement("param")]
+    public required ParameterDescElement IndexerParameter { get; init; }
+
+    [XmlElement("get")]
+    public required PropertyAccessorElement Getter { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/InterfaceElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/InterfaceElement.cs
@@ -0,0 +1,15 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class InterfaceElement
+{
+    [XmlElement("constant", typeof(ConstantDescElement))]
+    [XmlElement("field", typeof(FieldDescElement))]
+    [XmlElement("function", typeof(FunctionDescElement))]
+    public List<NamedAccessDescElement> Decls { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/MethodClassElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/MethodClassElement.cs
@@ -0,0 +1,32 @@
+﻿// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+[XmlType]
+public class MethodClassElement : NamedAccessDescElement
+{
+    [XmlAttribute("static")]
+    public bool IsStatic { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool IsStaticSpecified => IsStatic;
+
+    [XmlAttribute("unsafe")]
+    public bool IsUnsafe { get; init; }
+
+    [XmlIgnore]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public bool IsUnsafeSpecified => IsUnsafe;
+
+    [XmlElement("constant", typeof(ConstantDescElement))]
+    [XmlElement("field", typeof(FieldDescElement))]
+    [XmlElement("function", typeof(FunctionDescElement))]
+    [XmlElement("delegate", typeof(DelegateDescElement))]
+    [XmlElement("iid", typeof(IidDescElement))]
+    public List<NamedDescElement> Decls { get; } = [];
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/NamedAccessDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/NamedAccessDescElement.cs
@@ -0,0 +1,12 @@
+// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+public abstract class NamedAccessDescElement : NamedDescElement
+{
+    [XmlAttribute("access")]
+    public required string AccessSpecifier { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/NamedDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/NamedDescElement.cs
@@ -0,0 +1,12 @@
+// Copyright © Tanner Gooding and Contributors. Licensed under the MIT License (MIT). See License.md in the repository root for more information.
+
+
+using System.Xml.Serialization;
+
+namespace ClangSharp.XML;
+
+public abstract class NamedDescElement
+{
+    [XmlAttribute("name")]
+    public required string Name { get; init; }
+}
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/NamespaceElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/NamespaceElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/ParameterDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/ParameterDescElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/PropertyAccessorElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/PropertyAccessorElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/StructDescElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/StructDescElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/TypeInitializationExpressionElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/TypeInitializationExpressionElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/TypeWithNativeTypeNameElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/TypeWithNativeTypeNameElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/ValueDescValueElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/ValueDescValueElement.cs
diff --git a/sources/ClangSharp.PInvokeGenerator/XML/VtblElement.cs b/sources/ClangSharp.PInvokeGenerator/XML/VtblElement.cs
diff --git a/tests/ClangSharp.PInvokeGenerator.UnitTests/PInvokeGeneratorTest.cs b/tests/ClangSharp.PInvokeGenerator.UnitTests/PInvokeGeneratorTest.cs
