Merge pull request #289 from SixLabors/js/nullable-enable

Enable nullability checks

Author: JimBobSquarePants

src/ImageSharp.Drawing/Processing/Brush.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 namespace SixLabors.ImageSharp.Drawing.Processing;
 
 /// <summary>
@@ -37,10 +35,10 @@ public abstract BrushApplicator<TPixel> CreateApplicator<TPixel>(
         where TPixel : unmanaged, IPixel<TPixel>;
 
     /// <inheritdoc/>
-    public abstract bool Equals(Brush other);
+    public abstract bool Equals(Brush? other);
 
     /// <inheritdoc/>
-    public override bool Equals(object obj) => this.Equals(obj as Brush);
+    public override bool Equals(object? obj) => this.Equals(obj as Brush);
 
     /// <inheritdoc/>
     public abstract override int GetHashCode();

src/ImageSharp.Drawing/Processing/DrawingOptionsDefaultsExtensions.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 using System.Numerics;
 
 namespace SixLabors.ImageSharp.Drawing.Processing;
@@ -49,7 +47,7 @@ public static void SetDrawingTransform(this Configuration configuration, Matrix3
     /// <returns>The matrix.</returns>
     public static Matrix3x2 GetDrawingTransform(this IImageProcessingContext context)
     {
-        if (context.Properties.TryGetValue(DrawingTransformMatrixKey, out object options) && options is Matrix3x2 go)
+        if (context.Properties.TryGetValue(DrawingTransformMatrixKey, out object? options) && options is Matrix3x2 go)
         {
             return go;
         }
@@ -66,7 +64,7 @@ public static Matrix3x2 GetDrawingTransform(this IImageProcessingContext context
     /// <returns>The globally configured default matrix.</returns>
     public static Matrix3x2 GetDrawingTransform(this Configuration configuration)
     {
-        if (configuration.Properties.TryGetValue(DrawingTransformMatrixKey, out object options) && options is Matrix3x2 go)
+        if (configuration.Properties.TryGetValue(DrawingTransformMatrixKey, out object? options) && options is Matrix3x2 go)
         {
             return go;
         }

src/ImageSharp.Drawing/Processing/Extensions/DrawTextExtensions.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 using SixLabors.Fonts;
 using SixLabors.ImageSharp.Drawing.Processing.Processors.Text;
 
@@ -163,8 +161,8 @@ public static IImageProcessingContext DrawText(
         this IImageProcessingContext source,
         RichTextOptions textOptions,
         string text,
-        Brush brush,
-        Pen pen) =>
+        Brush? brush,
+        Pen? pen) =>
         source.DrawText(source.GetDrawingOptions(), textOptions, text, brush, pen);
 
     /// <summary>
@@ -221,8 +219,8 @@ public static IImageProcessingContext DrawText(
         DrawingOptions drawingOptions,
         string text,
         Font font,
-        Brush brush,
-        Pen pen,
+        Brush? brush,
+        Pen? pen,
         PointF location)
     {
         RichTextOptions textOptions = new(font) { Origin = location };
@@ -244,7 +242,7 @@ public static IImageProcessingContext DrawText(
         DrawingOptions drawingOptions,
         RichTextOptions textOptions,
         string text,
-        Brush brush,
-        Pen pen)
+        Brush? brush,
+        Pen? pen)
         => source.ApplyProcessor(new DrawTextProcessor(drawingOptions, textOptions, text, brush, pen));
 }

src/ImageSharp.Drawing/Processing/GradientBrush.cs

@@ -32,7 +32,7 @@ protected GradientBrush(GradientRepetitionMode repetitionMode, params ColorStop[
     protected ColorStop[] ColorStops { get; }
 
     /// <inheritdoc />
-    public override bool Equals(Brush other)
+    public override bool Equals(Brush? other)
     {
         if (other is GradientBrush brush)
         {

src/ImageSharp.Drawing/Processing/ImageBrush.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 using System.Buffers;
 using SixLabors.ImageSharp.Memory;
 
@@ -47,7 +45,7 @@ internal ImageBrush(Image image, RectangleF region)
     }
 
     /// <inheritdoc />
-    public override bool Equals(Brush other)
+    public override bool Equals(Brush? other)
     {
         if (other is ImageBrush ib)
         {
@@ -83,10 +81,8 @@ public override BrushApplicator<TPixel> CreateApplicator<TPixel>(
     private class ImageBrushApplicator<TPixel> : BrushApplicator<TPixel>
         where TPixel : unmanaged, IPixel<TPixel>
     {
-        private ImageFrame<TPixel> sourceFrame;
-
-        private Image<TPixel> sourceImage;
-
+        private readonly ImageFrame<TPixel> sourceFrame;
+        private readonly Image<TPixel> sourceImage;
         private readonly bool shouldDisposeImage;
 
         /// <summary>
@@ -158,10 +154,7 @@ protected override void Dispose(bool disposing)
                 this.sourceImage?.Dispose();
             }
 
-            this.sourceImage = null;
-            this.sourceFrame = null;
             this.isDisposed = true;
-
             base.Dispose(disposing);
         }
 

src/ImageSharp.Drawing/Processing/LinearGradientBrush.cs

@@ -32,7 +32,7 @@ public LinearGradientBrush(
     }
 
     /// <inheritdoc/>
-    public override bool Equals(Brush other)
+    public override bool Equals(Brush? other)
     {
         if (other is LinearGradientBrush brush)
         {

src/ImageSharp.Drawing/Processing/PathGradientBrush.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 using System.Numerics;
 using SixLabors.ImageSharp.Drawing.Utilities;
 
@@ -76,7 +74,7 @@ public PathGradientBrush(PointF[] points, Color[] colors, Color centerColor)
     }
 
     /// <inheritdoc />
-    public override bool Equals(Brush other)
+    public override bool Equals(Brush? other)
     {
         if (other is PathGradientBrush brush)
         {
@@ -123,7 +121,7 @@ private static Color CalculateCenterColor(Color[] colors)
         return new Color(colors.Select(c => (Vector4)c).Aggregate((p1, p2) => p1 + p2) / colors.Length);
     }
 
-    private static float DistanceBetween(PointF p1, PointF p2) => ((Vector2)(p2 - p1)).Length();
+    private static float DistanceBetween(Vector2 p1, Vector2 p2) => (p2 - p1).Length();
 
     private readonly struct Intersection
     {
@@ -178,13 +176,14 @@ public Vector4 ColorAt(float distance)
 
         public Vector4 ColorAt(PointF point) => this.ColorAt(DistanceBetween(point, this.Start));
 
-        public bool Equals(Edge other)
-            => other.Start == this.Start &&
-                other.End == this.End &&
-                other.StartColor.Equals(this.StartColor) &&
-                other.EndColor.Equals(this.EndColor);
+        public bool Equals(Edge? other)
+            => other != null &&
+               other.Start == this.Start &&
+               other.End == this.End &&
+               other.StartColor.Equals(this.StartColor) &&
+               other.EndColor.Equals(this.EndColor);
 
-        public override bool Equals(object obj) => this.Equals(obj as Edge);
+        public override bool Equals(object? obj) => this.Equals(obj as Edge);
 
         public override int GetHashCode()
             => HashCode.Combine(this.Start, this.End, this.StartColor, this.EndColor);
@@ -249,7 +248,7 @@ public PathGradientBrushApplicator(
         {
             get
             {
-                var point = new Vector2(x, y);
+                Vector2 point = new(x, y);
 
                 if (point == this.center)
                 {
@@ -278,7 +277,7 @@ public PathGradientBrushApplicator(
                     return px;
                 }
 
-                var direction = Vector2.Normalize(point - this.center);
+                Vector2 direction = Vector2.Normalize(point - this.center);
                 Vector2 end = point + (direction * this.maxDistance);
 
                 (Edge Edge, Vector2 Point)? isc = this.FindIntersection(point, end);
@@ -294,7 +293,7 @@ public PathGradientBrushApplicator(
                 float length = DistanceBetween(intersection, this.center);
                 float ratio = length > 0 ? DistanceBetween(intersection, point) / length : 0;
 
-                var color = Vector4.Lerp(edgeColor, this.centerColor, ratio);
+                Vector4 color = Vector4.Lerp(edgeColor, this.centerColor, ratio);
 
                 TPixel pixel = default;
                 pixel.FromScaledVector4(color);
@@ -305,8 +304,8 @@ public PathGradientBrushApplicator(
         /// <inheritdoc />
         public override void Apply(Span<float> scanline, int x, int y)
         {
-            Span<float> amounts = this.blenderBuffers.AmountSpan.Slice(0, scanline.Length);
-            Span<TPixel> overlays = this.blenderBuffers.OverlaySpan.Slice(0, scanline.Length);
+            Span<float> amounts = this.blenderBuffers.AmountSpan[..scanline.Length];
+            Span<TPixel> overlays = this.blenderBuffers.OverlaySpan[..scanline.Length];
             float blendPercentage = this.Options.BlendPercentage;
 
             // TODO: Remove bounds checks.
@@ -355,7 +354,7 @@ protected override void Dispose(bool disposing)
         {
             Vector2 ip = default;
             Vector2 closestIntersection = default;
-            Edge closestEdge = null;
+            Edge? closestEdge = null;
             const float minDistance = float.MaxValue;
             foreach (Edge edge in this.edges)
             {
@@ -385,9 +384,9 @@ private static bool FindPointOnTriangle(Vector2 v1, Vector2 v2, Vector2 v3, Vect
             Vector2 pv2 = point - v2;
             Vector2 pv3 = point - v3;
 
-            var d1 = Vector3.Cross(new Vector3(e1.X, e1.Y, 0), new Vector3(pv1.X, pv1.Y, 0));
-            var d2 = Vector3.Cross(new Vector3(e2.X, e2.Y, 0), new Vector3(pv2.X, pv2.Y, 0));
-            var d3 = Vector3.Cross(new Vector3(e3.X, e3.Y, 0), new Vector3(pv3.X, pv3.Y, 0));
+            Vector3 d1 = Vector3.Cross(new Vector3(e1.X, e1.Y, 0), new Vector3(pv1.X, pv1.Y, 0));
+            Vector3 d2 = Vector3.Cross(new Vector3(e2.X, e2.Y, 0), new Vector3(pv2.X, pv2.Y, 0));
+            Vector3 d3 = Vector3.Cross(new Vector3(e3.X, e3.Y, 0), new Vector3(pv3.X, pv3.Y, 0));
 
             if (Math.Sign(Vector3.Dot(d1, d2)) * Math.Sign(Vector3.Dot(d1, d3)) == -1 || Math.Sign(Vector3.Dot(d1, d2)) * Math.Sign(Vector3.Dot(d2, d3)) == -1)
             {

src/ImageSharp.Drawing/Processing/PatternBrush.cs

@@ -84,7 +84,7 @@ internal PatternBrush(PatternBrush brush)
     }
 
     /// <inheritdoc />
-    public override bool Equals(Brush other)
+    public override bool Equals(Brush? other)
     {
         if (other is PatternBrush sb)
         {

src/ImageSharp.Drawing/Processing/PatternPen.cs

@@ -63,7 +63,7 @@ public PatternPen(PenOptions options)
     }
 
     /// <inheritdoc/>
-    public override bool Equals(Pen other)
+    public override bool Equals(Pen? other)
     {
         if (other is PatternPen)
         {

src/ImageSharp.Drawing/Processing/Pen.cs

@@ -1,8 +1,6 @@
 // Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-#nullable disable
-
 namespace SixLabors.ImageSharp.Drawing.Processing;
 
 /// <summary>
@@ -52,7 +50,9 @@ protected Pen(Brush strokeFill, float strokeWidth)
     /// <param name="strokePattern">The stroke pattern.</param>
     protected Pen(Brush strokeFill, float strokeWidth, float[] strokePattern)
     {
+        Guard.NotNull(strokeFill, nameof(strokeFill));
         Guard.MustBeGreaterThan(strokeWidth, 0, nameof(strokeWidth));
+        Guard.NotNull(strokePattern, nameof(strokePattern));
 
         this.StrokeFill = strokeFill;
         this.StrokeWidth = strokeWidth;
@@ -104,19 +104,18 @@ public IPath GeneratePath(IPath path)
     public abstract IPath GeneratePath(IPath path, float strokeWidth);
 
     /// <inheritdoc/>
-    public virtual bool Equals(Pen other)
-        => this.StrokeWidth == other.StrokeWidth
+    public virtual bool Equals(Pen? other)
+        => other != null
+        && this.StrokeWidth == other.StrokeWidth
         && this.JointStyle == other.JointStyle
         && this.EndCapStyle == other.EndCapStyle
         && this.StrokeFill.Equals(other.StrokeFill)
         && this.StrokePattern.SequenceEqual(other.StrokePattern);
 
     /// <inheritdoc/>
-    public override bool Equals(object obj) => this.Equals(obj as Pen);
+    public override bool Equals(object? obj) => this.Equals(obj as Pen);
 
     /// <inheritdoc/>
     public override int GetHashCode()
-
-        // TODO: StrokePattern should be part of the hash-code.
-        => HashCode.Combine(this.StrokeWidth, this.JointStyle, this.EndCapStyle, this.StrokeFill);
+        => HashCode.Combine(this.StrokeWidth, this.JointStyle, this.EndCapStyle, this.StrokeFill, this.pattern);
 }