Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Made AvaloniaPropertyMetadata immutable after property initialization #15384

Merged
merged 2 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/Avalonia.Base/AvaloniaProperty.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ private protected AvaloniaProperty(
AvaloniaPropertyMetadata metadata,
Action<AvaloniaObject, bool>? notifying = null)
{
_ = name ?? throw new ArgumentNullException(nameof(name));
ThrowHelper.ThrowIfNull(name, nameof(name));
ThrowHelper.ThrowIfNull(valueType, nameof(valueType));
ThrowHelper.ThrowIfNull(ownerType, nameof(ownerType));
ThrowHelper.ThrowIfNull(metadata, nameof(metadata));

if (name.Contains('.'))
{
Expand All @@ -60,11 +63,12 @@ private protected AvaloniaProperty(
_metadata = new Dictionary<Type, AvaloniaPropertyMetadata>();

Name = name;
PropertyType = valueType ?? throw new ArgumentNullException(nameof(valueType));
OwnerType = ownerType ?? throw new ArgumentNullException(nameof(ownerType));
PropertyType = valueType;
OwnerType = ownerType;
Notifying = notifying;
Id = s_nextId++;

metadata.Freeze();
_metadata.Add(hostType, metadata ?? throw new ArgumentNullException(nameof(metadata)));
MrJul marked this conversation as resolved.
Show resolved Hide resolved
_defaultMetadata = metadata.GenerateTypeSafeMetadata();
_singleMetadata = new(hostType, metadata);
Expand Down Expand Up @@ -584,6 +588,7 @@ private protected void OverrideMetadata(Type type, AvaloniaPropertyMetadata meta

var baseMetadata = GetMetadata(type);
metadata.Merge(baseMetadata, this);
metadata.Freeze();
_metadata.Add(type, metadata);
_metadataCache.Clear();

Expand Down
14 changes: 14 additions & 0 deletions src/Avalonia.Base/AvaloniaPropertyMetadata.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System;
using Avalonia.Data;

namespace Avalonia
Expand All @@ -7,6 +8,7 @@ namespace Avalonia
/// </summary>
public abstract class AvaloniaPropertyMetadata
{
private bool _isReadOnly;
private BindingMode _defaultBindingMode;

/// <summary>
Expand Down Expand Up @@ -54,6 +56,11 @@ public virtual void Merge(
AvaloniaPropertyMetadata baseMetadata,
AvaloniaProperty property)
{
if (_isReadOnly)
{
throw new InvalidOperationException("The metadata is read-only.");
}

if (_defaultBindingMode == BindingMode.Default)
{
_defaultBindingMode = baseMetadata.DefaultBindingMode;
Expand All @@ -62,6 +69,13 @@ public virtual void Merge(
EnableDataValidation ??= baseMetadata.EnableDataValidation;
}

/// <summary>
/// Makes this instance read-only.
/// No further modifications are allowed after this call.
/// </summary>
public void Freeze()
=> _isReadOnly = true;

/// <summary>
/// Gets a copy of this object configured for use with any owner type.
/// </summary>
Expand Down
1 change: 1 addition & 0 deletions src/Avalonia.Base/DirectProperty.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ public DirectProperty<TNewOwner, TValue> AddOwner<TNewOwner>(
enableDataValidation: enableDataValidation);

metadata.Merge(GetMetadata<TOwner>(), this);
metadata.Freeze();

var result = new DirectProperty<TNewOwner, TValue>(
(DirectPropertyBase<TValue>)this,
Expand Down
8 changes: 7 additions & 1 deletion src/Avalonia.Base/DirectPropertyMetadata`1.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ public override void Merge(AvaloniaPropertyMetadata baseMetadata, AvaloniaProper
}
}

public override AvaloniaPropertyMetadata GenerateTypeSafeMetadata() => new DirectPropertyMetadata<TValue>(UnsetValue, DefaultBindingMode, EnableDataValidation);
/// <inheritdoc />
public override AvaloniaPropertyMetadata GenerateTypeSafeMetadata()
{
var copy = new DirectPropertyMetadata<TValue>(UnsetValue, DefaultBindingMode, EnableDataValidation);
copy.Freeze();
return copy;
}
}
}
8 changes: 7 additions & 1 deletion src/Avalonia.Base/StyledPropertyMetadata`1.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ public override void Merge(AvaloniaPropertyMetadata baseMetadata, AvaloniaProper
}
}

public override AvaloniaPropertyMetadata GenerateTypeSafeMetadata() => new StyledPropertyMetadata<TValue>(DefaultValue, DefaultBindingMode, enableDataValidation: EnableDataValidation ?? false);
/// <inheritdoc />
public override AvaloniaPropertyMetadata GenerateTypeSafeMetadata()
{
var copy = new StyledPropertyMetadata<TValue>(DefaultValue, DefaultBindingMode, null, EnableDataValidation ?? false);
copy.Freeze();
return copy;
}
}
}
21 changes: 21 additions & 0 deletions tests/Avalonia.Base.UnitTests/AvaloniaPropertyTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,27 @@ public void OverrideMetadata_Should_Merge_Values()
Assert.Equal(BindingMode.TwoWay, result.DefaultBindingMode);
}

[Fact]
public void Default_Metadata_Cannot_Be_Changed_After_Property_Initialization()
{
var metadata = new TestMetadata();
var property = new TestProperty<string>("test", typeof(Class1), metadata);

Assert.Throws<InvalidOperationException>(() => metadata.Merge(new TestMetadata(), property));
}

[Fact]
public void Overridden_Metadata_Cannot_Be_Changed_After_OverrideMetadata()
{
var metadata = new TestMetadata(BindingMode.TwoWay);
var overridden = new TestMetadata();
var property = new TestProperty<string>("test", typeof(Class1), metadata);

property.OverrideMetadata<Class2>(overridden);

Assert.Throws<InvalidOperationException>(() => overridden.Merge(new TestMetadata(), property));
}

[Fact]
public void Changed_Observable_Fired()
{
Expand Down
20 changes: 20 additions & 0 deletions tests/Avalonia.Base.UnitTests/DirectPropertyTests.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System;
using Xunit;

namespace Avalonia.Base.UnitTests
Expand Down Expand Up @@ -46,6 +47,25 @@ public void AddOwnered_Properties_Should_Share_Observables()
Assert.Same(p1.Changed, p2.Changed);
}

[Fact]
public void Default_GetMetadata_Cannot_Be_Changed()
{
var p1 = Class1.FooProperty;
var metadata = p1.GetMetadata<Class1>();

Assert.Throws<InvalidOperationException>(() => metadata.Merge(new DirectPropertyMetadata<string>(), p1));
}

[Fact]
public void AddOwnered_GetMetadata_Cannot_Be_Changed()
{
var p1 = Class1.FooProperty;
var p2 = p1.AddOwner<Class2>(_ => null, (_, _) => { });
var metadata = p2.GetMetadata<Class2>();

Assert.Throws<InvalidOperationException>(() => metadata.Merge(new DirectPropertyMetadata<string>(), p2));
}

private class Class1 : AvaloniaObject
{
public static readonly DirectProperty<Class1, string> FooProperty =
Expand Down
28 changes: 28 additions & 0 deletions tests/Avalonia.Base.UnitTests/StyledPropertyTests.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System;
using Xunit;

namespace Avalonia.Base.UnitTests
Expand Down Expand Up @@ -32,6 +33,33 @@ public void AddOwnered_Property_Should_Be_Same()
Assert.Same(p1, p2);
}

[Fact]
public void Default_GetMetadata_Cannot_Be_Changed()
{
var p1 = new StyledProperty<string>(
"p1",
typeof(Class1),
typeof(Class1),
new StyledPropertyMetadata<string>());
var metadata = p1.GetMetadata<Class1>();

Assert.Throws<InvalidOperationException>(() => metadata.Merge(new StyledPropertyMetadata<string>(), p1));
}

[Fact]
public void AddOwnered_GetMetadata_Cannot_Be_Changed()
{
var p1 = new StyledProperty<string>(
"p1",
typeof(Class1),
typeof(Class1),
new StyledPropertyMetadata<string>());
var p2 = p1.AddOwner<Class2>();
var metadata = p2.GetMetadata<Class2>();

Assert.Throws<InvalidOperationException>(() => metadata.Merge(new StyledPropertyMetadata<string>(), p2));
}

private class Class1 : AvaloniaObject
{
}
Expand Down
Loading