Merge pull request #895 from stijnherreman/issue-677

Make the type converters available to custom pre-processing phase visitors. +semver:feature
aaubry · Jan 23, 2024 · 0ca7b09 · 0ca7b09
2 parents 04a9dbb + 3f75e84
commit 0ca7b09
Show file tree

Hide file tree

Showing 2 changed files with 159 additions and 2 deletions.
diff --git a/YamlDotNet/Serialization/SerializerBuilder.cs b/YamlDotNet/Serialization/SerializerBuilder.cs
@@ -388,6 +388,22 @@ public SerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVi
             return WithPreProcessingPhaseObjectGraphVisitor(objectGraphVisitor, w => w.OnTop());
         }
 
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector.</param>
+        public SerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(Func<IEnumerable<IYamlTypeConverter>, TObjectGraphVisitor> objectGraphVisitorFactory)
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            return WithPreProcessingPhaseObjectGraphVisitor(objectGraphVisitorFactory, w => w.OnTop());
+        }
+
         /// <summary>
         /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
         /// before emitting an object graph.
@@ -419,6 +435,38 @@ Action<IRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
             return this;
         }
 
+
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector.</param>
+        /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
+        public SerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
+            Func<IEnumerable<IYamlTypeConverter>, TObjectGraphVisitor> objectGraphVisitorFactory,
+            Action<IRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
+        )
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            if (objectGraphVisitorFactory == null)
+            {
+                throw new ArgumentNullException(nameof(objectGraphVisitorFactory));
+            }
+
+            if (where == null)
+            {
+                throw new ArgumentNullException(nameof(where));
+            }
+
+            where(preProcessingPhaseObjectGraphVisitorFactories.CreateRegistrationLocationSelector(typeof(TObjectGraphVisitor), typeConverters => objectGraphVisitorFactory(typeConverters)));
+            return this;
+        }
+
         /// <summary>
         /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
         /// before emitting an object graph.
@@ -428,7 +476,7 @@ Action<IRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
         /// before actually emitting it. This allows a visitor to collect information about the graph that
         /// can be used later by another visitor registered in the emission phase.
         /// </remarks>
-        /// <param name="objectGraphVisitorFactory">A factory that creates the <see cref="IObjectGraphVisitor{Nothing}" /> based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
         /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
         public SerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
             WrapperFactory<IObjectGraphVisitor<Nothing>, TObjectGraphVisitor> objectGraphVisitorFactory,
@@ -450,6 +498,37 @@ Action<ITrackingRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>
             return this;
         }
 
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
+        /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
+        public SerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
+            WrapperFactory<IEnumerable<IYamlTypeConverter>, IObjectGraphVisitor<Nothing>, TObjectGraphVisitor> objectGraphVisitorFactory,
+            Action<ITrackingRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
+        )
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            if (objectGraphVisitorFactory == null)
+            {
+                throw new ArgumentNullException(nameof(objectGraphVisitorFactory));
+            }
+
+            if (where == null)
+            {
+                throw new ArgumentNullException(nameof(where));
+            }
+
+            where(preProcessingPhaseObjectGraphVisitorFactories.CreateTrackingRegistrationLocationSelector(typeof(TObjectGraphVisitor), (wrapped, typeConverters) => objectGraphVisitorFactory(wrapped, typeConverters)));
+            return this;
+        }
+
         /// <summary>
         /// Unregisters an existing <see cref="IObjectGraphVisitor{Nothing}" /> of type <typeparam name="TObjectGraphVisitor" />.
         /// </summary>

diff --git a/YamlDotNet/Serialization/StaticSerializerBuilder.cs b/YamlDotNet/Serialization/StaticSerializerBuilder.cs
@@ -392,6 +392,22 @@ public StaticSerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectG
             return WithPreProcessingPhaseObjectGraphVisitor(objectGraphVisitor, w => w.OnTop());
         }
 
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector.</param>
+        public StaticSerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(Func<IEnumerable<IYamlTypeConverter>, TObjectGraphVisitor> objectGraphVisitorFactory)
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            return WithPreProcessingPhaseObjectGraphVisitor(objectGraphVisitorFactory, w => w.OnTop());
+        }
+
         /// <summary>
         /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
         /// before emitting an object graph.
@@ -432,7 +448,38 @@ Action<IRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
         /// before actually emitting it. This allows a visitor to collect information about the graph that
         /// can be used later by another visitor registered in the emission phase.
         /// </remarks>
-        /// <param name="objectGraphVisitorFactory">A factory that creates the <see cref="IObjectGraphVisitor{Nothing}" /> based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector.</param>
+        /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
+        public StaticSerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
+            Func<IEnumerable<IYamlTypeConverter>, TObjectGraphVisitor> objectGraphVisitorFactory,
+            Action<IRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
+        )
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            if (objectGraphVisitorFactory == null)
+            {
+                throw new ArgumentNullException(nameof(objectGraphVisitorFactory));
+            }
+
+            if (where == null)
+            {
+                throw new ArgumentNullException(nameof(where));
+            }
+
+            where(preProcessingPhaseObjectGraphVisitorFactories.CreateRegistrationLocationSelector(typeof(TObjectGraphVisitor), typeConverters => objectGraphVisitorFactory(typeConverters)));
+            return this;
+        }
+
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
         /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
         public StaticSerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
             WrapperFactory<IObjectGraphVisitor<Nothing>, TObjectGraphVisitor> objectGraphVisitorFactory,
@@ -454,6 +501,37 @@ Action<ITrackingRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>
             return this;
         }
 
+        /// <summary>
+        /// Registers an additional <see cref="IObjectGraphVisitor{Nothing}" /> to be used by the serializer
+        /// before emitting an object graph.
+        /// </summary>
+        /// <remarks>
+        /// Registering a visitor in the pre-processing phase enables to traverse the object graph once
+        /// before actually emitting it. This allows a visitor to collect information about the graph that
+        /// can be used later by another visitor registered in the emission phase.
+        /// </remarks>
+        /// <param name="objectGraphVisitorFactory">A function that instantiates the type inspector based on a previously registered <see cref="IObjectGraphVisitor{Nothing}" />.</param>
+        /// <param name="where">Configures the location where to insert the <see cref="IObjectGraphVisitor{Nothing}" /></param>
+        public StaticSerializerBuilder WithPreProcessingPhaseObjectGraphVisitor<TObjectGraphVisitor>(
+            WrapperFactory<IEnumerable<IYamlTypeConverter>, IObjectGraphVisitor<Nothing>, TObjectGraphVisitor> objectGraphVisitorFactory,
+            Action<ITrackingRegistrationLocationSelectionSyntax<IObjectGraphVisitor<Nothing>>> where
+        )
+            where TObjectGraphVisitor : IObjectGraphVisitor<Nothing>
+        {
+            if (objectGraphVisitorFactory == null)
+            {
+                throw new ArgumentNullException(nameof(objectGraphVisitorFactory));
+            }
+
+            if (where == null)
+            {
+                throw new ArgumentNullException(nameof(where));
+            }
+
+            where(preProcessingPhaseObjectGraphVisitorFactories.CreateTrackingRegistrationLocationSelector(typeof(TObjectGraphVisitor), (wrapped, typeConverters) => objectGraphVisitorFactory(wrapped, typeConverters)));
+            return this;
+        }
+
         /// <summary>
         /// Unregisters an existing <see cref="IObjectGraphVisitor{Nothing}" /> of type <typeparam name="TObjectGraphVisitor" />.
         /// </summary>