Observable logics improved

Hypocrite.Avalonia/MVVM/ViewModelBase.cs

@@ -7,7 +7,7 @@
 
 namespace Hypocrite.Mvvm
 {
- public class ViewModelBase : EngineViewModelBase, INavigationAware
+ public class ViewModelBase : CoreViewModelBase, INavigationAware
  {
  public ViewModelBase()
  {

Hypocrite.Core/Mvvm/Events/DialogEvents.cs → Hypocrite.Core/Events/DialogEvents.cs

@@ -1,6 +1,6 @@
 using Prism.Events;
 
-namespace Hypocrite.Core.Mvvm.Events
+namespace Hypocrite.Core.Events
 {
  public class DialogClosedEvent : PubSubEvent
  {

Hypocrite.Core/Events/NavigationEvent.cs

@@ -0,0 +1,9 @@
+using Hypocrite.Core.Mvvm;
+using Prism.Events;
+
+namespace Hypocrite.Core.Events
+{
+ public class NavigationEvent : PubSubEvent<CoreViewModelBase>
+ {
+ }
+}

Hypocrite.Core/Mvvm/Events/PreviewDoneEvent.cs → Hypocrite.Core/Events/PreviewDoneEvent.cs

@@ -1,6 +1,6 @@
 using Prism.Events;
 
-namespace Hypocrite.Core.Mvvm.Events
+namespace Hypocrite.Core.Events
 {
  public class PreviewDoneEvent : PubSubEvent
  {

Hypocrite.Core/Events/PropertySetEventHandler.cs

@@ -0,0 +1,37 @@
+using System;
+
+namespace Hypocrite.Core.Events
+{
+ //
+ // Summary:
+ // Represents the method that will handle the BindableObject.PropertySet
+ // event raised when a property is set on a component.
+ //
+ // Parameters:
+ // sender:
+ // The source of the event.
+ //
+ // e:
+ // A Hypocrite.Core.Events.PropertySetEventArgs that contains the event data.
+ public delegate void PropertySetEventHandler(object sender, PropertySetEventArgs e);
+
+ /// <summary>
+ /// Provides data for the <see langword='PropertySet'/> event.
+ /// </summary>
+ public class PropertySetEventArgs : EventArgs
+ {
+ /// <summary>
+ /// Initializes a new instance of the <see cref='Events.PropertySetEventArgs'/>
+ /// class.
+ /// </summary>
+ public PropertySetEventArgs(string propertyName)
+ {
+ PropertyName = propertyName;
+ }
+
+ /// <summary>
+ /// Indicates the name of the property that set.
+ /// </summary>
+ public virtual string PropertyName { get; }
+ }
+}

Hypocrite.Core/Events/PropertySettingEventHandler.cs

@@ -0,0 +1,37 @@
+using System;
+
+namespace Hypocrite.Core.Events
+{
+ //
+ // Summary:
+ // Represents the method that will handle the BindableObject.PropertySetting
+ // event raised when a property is setting on a component.
+ //
+ // Parameters:
+ // sender:
+ // The source of the event.
+ //
+ // e:
+ // A Hypocrite.Core.Events.PropertySettingEventArgs that contains the event data.
+ public delegate void PropertySettingEventHandler(object sender, PropertySettingEventArgs e);
+
+ /// <summary>
+ /// Provides data for the <see langword='PropertySetting'/> event.
+ /// </summary>
+ public class PropertySettingEventArgs : EventArgs
+ {
+ /// <summary>
+ /// Initializes a new instance of the <see cref='Events.PropertySettingEventArgs'/>
+ /// class.
+ /// </summary>
+ public PropertySettingEventArgs(string propertyName)
+ {
+ PropertyName = propertyName;
+ }
+
+ /// <summary>
+ /// Indicates the name of the property that is setting.
+ /// </summary>
+ public virtual string PropertyName { get; }
+ }
+}

Hypocrite.Core/Mvvm/Events/WindowProgressChangedEvent.cs → Hypocrite.Core/Events/WindowProgressChangedEvent.cs

@@ -1,6 +1,6 @@
 using Prism.Events;
 
-namespace Hypocrite.Core.Mvvm.Events
+namespace Hypocrite.Core.Events
 {
  public class WindowProgressChangedEvent : PubSubEvent<bool>
  {

Hypocrite.Core/Extensions/BindableObjectExtensions.cs

@@ -1,8 +1,6 @@
 using Hypocrite.Core.Mvvm;
-using Hypocrite.Core.Mvvm.ObserverLogics;
+using Hypocrite.Core.Reactive;
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Linq.Expressions;
 using System.Reflection;
 using System.Runtime.CompilerServices;
@@ -18,7 +16,7 @@ public static class BindableObjectExtensions
  /// </summary>
  /// <typeparam name="TObj">The type of the This.</typeparam>
  /// <typeparam name="TRet">The type of the return value.</typeparam>
- /// <param name="reactiveObject">The <see cref="BindableObject"/> raising the notification.</param>
+ /// <param name="bindableObject">The <see cref="BindableObject"/> raising the notification.</param>
  /// <param name="backingField">A Reference to the backing field for this
  /// property.</param>
  /// <param name="newValue">The new value.</param>
@@ -33,21 +31,34 @@ public static class BindableObjectExtensions
  where TObj : BindableObject
  {
 #if NET6_0_OR_GREATER
- ArgumentNullException.ThrowIfNull(propertyName);
+  ArgumentNullException.ThrowIfNull(propertyName);
 #else
  if (propertyName is null)
  {
  throw new ArgumentNullException(nameof(propertyName));
  }
 #endif
+ bindableObject.SetProperty(ref backingField, newValue, propertyName);
+ return newValue;
+ }
 
- if (EqualityComparer<TRet>.Default.Equals(backingField, newValue))
+ /// <summary>
+ /// WhenPropertySet returns an Observable representing the
+ /// property set notifications for a specific property on a
+ /// BindableObject.
+ /// </summary>
+ /// <param name="sender">The object where the property chain starts.</param>
+ /// <param name="property">The first property chain to reference. This will be a expression pointing to a end property or field.</param>
+ public static IObservable<TRet> WhenPropertySet<TSender, TRet>(
+ this TSender sender,
+ Expression<Func<TSender, TRet>> property, bool initialCall = false)
+ {
+ var mi = property.Body.GetMemberInfo();
+ if (mi.MemberType == MemberTypes.Property && mi is PropertyInfo pi && sender is BindableObject bindableObject)
  {
- return newValue;
+ return new PropertySetObservable<TRet>(bindableObject, pi, initialCall);
  }
-
- bindableObject.SetProperty(ref backingField, newValue, propertyName);
- return newValue;
+ return null;
  }
 
  /// <summary>
@@ -59,12 +70,12 @@ public static class BindableObjectExtensions
  /// <param name="property">The first property chain to reference. This will be a expression pointing to a end property or field.</param>
  public static IObservable<TRet> WhenPropertyChanged<TSender, TRet>(
  this TSender sender,
- Expression<Func<TSender, TRet>> property)
+ Expression<Func<TSender, TRet>> property, bool initialCall = false)
  {
  var mi = property.Body.GetMemberInfo();
  if (mi.MemberType == MemberTypes.Property && mi is PropertyInfo pi && sender is BindableObject bindableObject)
  {
- return new PropertyChangedObservable<TRet>(bindableObject, pi);
+ return new PropertyChangedObservable<TRet>(bindableObject, pi, initialCall);
  }
  return null;
  }
@@ -76,11 +87,30 @@ public static class BindableObjectExtensions
  /// </summary>
  /// <param name="sender">The object where the property chain starts.</param>
  public static IObservable<TRet> WhenAnyPropertyChanged<TSender, TRet>(
- this TSender sender)
+ this TSender sender, bool initialCall = false)
  {
  if (sender is BindableObject bindableObject)
  {
- return new PropertyChangedObservable<TRet>(bindableObject, null);
+ return new PropertyChangedObservable<TRet>(bindableObject, null, initialCall);
+ }
+ return null;
+ }
+
+ /// <summary>
+ /// WhenPropertySet returns an Observable representing the
+ /// property is setting notifications for a specific property on a
+ /// BindableObject.
+ /// </summary>
+ /// <param name="sender">The object where the property chain starts.</param>
+ /// <param name="property">The first property chain to reference. This will be a expression pointing to a end property or field.</param>
+ public static IObservable<TRet> WhenPropertySetting<TSender, TRet>(
+ this TSender sender,
+ Expression<Func<TSender, TRet>> property, bool initialCall = false)
+ {
+ var mi = property.Body.GetMemberInfo();
+ if (mi.MemberType == MemberTypes.Property && mi is PropertyInfo pi && sender is BindableObject bindableObject)
+ {
+ return new PropertySetObservable<TRet>(bindableObject, pi, initialCall, false);
  }
  return null;
  }
@@ -94,12 +124,12 @@ public static class BindableObjectExtensions
  /// <param name="property">The first property chain to reference. This will be a expression pointing to a end property or field.</param>
  public static IObservable<TRet> WhenPropertyChanging<TSender, TRet>(
  this TSender sender,
- Expression<Func<TSender, TRet>> property)
+ Expression<Func<TSender, TRet>> property, bool initialCall = false)
  {
  var mi = property.Body.GetMemberInfo();
  if (mi.MemberType == MemberTypes.Property && mi is PropertyInfo pi && sender is BindableObject bindableObject)
  {
- return new PropertyChangedObservable<TRet>(bindableObject, pi, false);
+ return new PropertyChangedObservable<TRet>(bindableObject, pi, initialCall, false);
  }
  return null;
  }
@@ -111,11 +141,11 @@ public static class BindableObjectExtensions
  /// </summary>
  /// <param name="sender">The object where the property chain starts.</param>
  public static IObservable<TRet> WhenAnyPropertyChanging<TSender, TRet>(
- this TSender sender)
+ this TSender sender, bool initialCall = false)
  {
  if (sender is BindableObject bindableObject)
  {
- return new PropertyChangedObservable<TRet>(bindableObject, null, false);
+ return new PropertyChangedObservable<TRet>(bindableObject, null, initialCall, false);
  }
  return null;
  }

Hypocrite.Core/Extensions/ObservableExtensions.cs

@@ -1,4 +1,4 @@
-using Hypocrite.Core.Mvvm.ObserverLogics;
+using Hypocrite.Core.Reactive;
 using Hypocrite.Core.Utils;
 using System;
 using System.Collections.Generic;

Hypocrite.Core/Mvvm/BindableObject.cs

@@ -1,4 +1,5 @@
-using System;
+using Hypocrite.Core.Events;
+using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.ComponentModel;
@@ -15,10 +16,12 @@ namespace Hypocrite.Core.Mvvm
  public abstract class BindableObject : INotifyPropertyChanged
  {
  /// <summary>
- /// Occurs when a property value changes.
+ /// Occurs when a property value changes/set.
  /// </summary>
  public event PropertyChangedEventHandler PropertyChanged;
  public event PropertyChangingEventHandler PropertyChanging;
+ public event PropertySetEventHandler PropertySet;
+ public event PropertySettingEventHandler PropertySetting;
 
  // public ObservableCollection<IObservable> PropertyChangedObservables { get; set; } = new ObservableCollection<System.IObservable>();
 
@@ -54,14 +57,19 @@ public virtual bool SetProperty<T>(ref T storage, T value, [CallerMemberName] st
  /// desired value.</returns>
  public virtual bool SetPropertyWithCallback<T>(ref T storage, T value, Action onChanged, [CallerMemberName] string propertyName = null)
  {
- if (EqualityComparer<T>.Default.Equals(storage, value)) return false;
+ bool isDifferent = !EqualityComparer<T>.Default.Equals(storage, value);
 
- RaisePropertyChanging(propertyName);
- storage = value;
- onChanged?.Invoke();
- RaisePropertyChanged(propertyName);
+ RaisePropertySetting(propertyName);
+ if (isDifferent)
+ {
+ RaisePropertyChanging(propertyName);
+ storage = value;
+ onChanged?.Invoke();
+ RaisePropertyChanged(propertyName);
+ }
+ RaisePropertySet(propertyName);
 
- return true;
+ return isDifferent;
  }
 
  /// <summary>
@@ -86,6 +94,28 @@ protected void RaisePropertyChanged([CallerMemberName] string propertyName = nul
  OnPropertyChanged(new PropertyChangedEventArgs(propertyName));
  }
 
+ /// <summary>
+ /// Raises this object's PropertySetting event.
+ /// </summary>
+ /// <param name="propertyName">Name of the property used to notify listeners. This
+ /// value is optional and can be provided automatically when invoked from compilers
+ /// that support <see cref="CallerMemberNameAttribute"/>.</param>
+ protected void RaisePropertySetting([CallerMemberName] string propertyName = null)
+ {
+ OnPropertySetting(new PropertySettingEventArgs(propertyName));
+ }
+
+ /// <summary>
+ /// Raises this object's PropertySet event.
+ /// </summary>
+ /// <param name="propertyName">Name of the property used to notify listeners. This
+ /// value is optional and can be provided automatically when invoked from compilers
+ /// that support <see cref="CallerMemberNameAttribute"/>.</param>
+ protected void RaisePropertySet([CallerMemberName] string propertyName = null)
+ {
+ OnPropertySet(new PropertySetEventArgs(propertyName));
+ }
+
  /// <summary>
  /// Raises this object's PropertyChanging event.
  /// </summary>
@@ -103,5 +133,23 @@ protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)
  {
  PropertyChanged?.Invoke(this, args);
  }
+
+ /// <summary>
+ /// Raises this object's PropertySetting event.
+ /// </summary>
+ /// <param name="args">The PropertySettingEventArgs</param>
+ protected virtual void OnPropertySetting(PropertySettingEventArgs args)
+ {
+ PropertySetting?.Invoke(this, args);
+ }
+
+ /// <summary>
+ /// Raises this object's PropertySet event.
+ /// </summary>
+ /// <param name="args">The PropertySetEventArgs</param>
+ protected virtual void OnPropertySet(PropertySetEventArgs args)
+ {
+ PropertySet?.Invoke(this, args);
+ }
  }
 }

Hypocrite.Core/Mvvm/EngineViewModelBase.cs → Hypocrite.Core/Mvvm/CoreViewModelBase.cs

@@ -1,15 +1,15 @@
-using Hypocrite.Core.Interfaces;
-using Hypocrite.Core.Mvvm.Events;
+using Hypocrite.Core.Events;
+using Hypocrite.Core.Interfaces;
 using Hypocrite.Core.Logging.Interfaces;
 using Prism.Events;
 using Prism.Ioc;
 using Prism.Mvvm;
 
 namespace Hypocrite.Core.Mvvm
 {
- public class EngineViewModelBase : BindableObject, IViewModel
+ public class CoreViewModelBase : BindableObject, IViewModel
  {
- public EngineViewModelBase()
+ public CoreViewModelBase()
  {
  viewModelName = GetType().FullName;
  }