Skip to content

Extending Signal's API #7

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 3 additions & 0 deletions packages/reactter/lib/src/internals.dart
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ part 'interfaces/context.dart';
part 'interfaces/hook.dart';
part 'interfaces/observer.dart';
part 'interfaces/state.dart';
part 'signal/internal/state_dependency.dart';
part 'signal/internal/state_subscriber.dart';
part 'signal/internal/signal_runtime.dart';
part 'env.dart';
32 changes: 32 additions & 0 deletions packages/reactter/lib/src/signal/computed.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
part of 'signal.dart';

class Computed<T> with RtState, StateSubscriber, StateDependency {
final T Function() compute;
bool _isComputed = false;

@override
final String? debugLabel;

late T _valueComputed;

T get value {
if (!_isComputed) performDepedencyUpdate();

SignalRuntime.link(this);

return _valueComputed;
}

Computed(this.compute, [this.debugLabel]);

@override
void performDepedencyUpdate() {
final value = linkDependencies(compute);

if (!_isComputed || _valueComputed != value) {
_valueComputed = value;
_isComputed = true;
notify();
}
}
}
12 changes: 12 additions & 0 deletions packages/reactter/lib/src/signal/effect.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
part of 'signal.dart';

class Effect with RtState, StateSubscriber {
final Function() fn;

Effect(this.fn) {
performDepedencyUpdate();
}

@override
void performDepedencyUpdate() => linkDependencies(fn);
}
56 changes: 56 additions & 0 deletions packages/reactter/lib/src/signal/internal/signal_runtime.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
part of '../../internals.dart';

class SignalRuntime {
static StateSubscriber? _currentSub;
static bool isRunning = false;

static void link(StateDependency dep) {
if (_currentSub == null) return;

_currentSub?._deps.add(dep);

if (_currentSub is Effect) {
dep._effects.add(_currentSub as Effect);
} else {
dep._subs.add(_currentSub!);
}
}

static void propagate(StateDependency dep) {
dep.shouldNotify = true;

if (isRunning) return;

isRunning = true;
Set<StateSubscriber> subsPending = dep._subs;
Set<Effect> effectsPending = {};

while (subsPending.isNotEmpty) {
final subs = subsPending.toList(growable: false);
subsPending = {};

for (final sub in subs) {
if (subsPending.contains(sub)) continue;

sub.performDepedencyUpdate();

if (sub is! StateDependency) continue;

final dep = sub as StateDependency;

if (!dep.shouldNotify) continue;

subsPending.addAll(dep._subs);
effectsPending.addAll(dep._effects);
dep.shouldNotify = false;
}
}

for (final effect in effectsPending) {
effect.performDepedencyUpdate();
}

isRunning = false;
dep.shouldNotify = false;
}
}
19 changes: 19 additions & 0 deletions packages/reactter/lib/src/signal/internal/state_dependency.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
part of '../../internals.dart';

mixin StateDependency on RtState {
final Set<StateSubscriber> _subs = {};
final Set<Effect> _effects = {};
bool shouldNotify = false;

@override
void update(Function fnUpdate) {
super.update(fnUpdate);
SignalRuntime.propagate(this);
}

@override
void notify() {
super.notify();
SignalRuntime.propagate(this);
}
}
26 changes: 26 additions & 0 deletions packages/reactter/lib/src/signal/internal/state_subscriber.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
part of '../../internals.dart';

mixin StateSubscriber on RtState {
StateSubscriber? _prevSub;
final Set<StateDependency> _deps = {};

void performDepedencyUpdate();

@override
void dispose() {
_deps.clear();
_prevSub = null;

super.dispose();
}

T linkDependencies<T>(T Function() fn) {
try {
_prevSub = SignalRuntime._currentSub;
SignalRuntime._currentSub = this;
return fn();
} finally {
SignalRuntime._currentSub = _prevSub;
}
}
}
46 changes: 14 additions & 32 deletions packages/reactter/lib/src/signal/signal.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'dart:math';
import 'package:reactter/src/framework.dart';
import 'package:reactter/src/internals.dart';

part 'extensions/signal_bigint.dart';
part 'extensions/signal_bool.dart';
Expand All @@ -12,6 +13,8 @@ part 'extensions/signal_map.dart';
part 'extensions/signal_num.dart';
part 'extensions/signal_set.dart';
part 'extensions/signal_string.dart';
part 'computed.dart';
part 'effect.dart';

/// This enumeration is used to represent different events that can occur when
/// getting or setting the value of a `Signal` object.
Expand Down Expand Up @@ -86,23 +89,19 @@ enum SignalEvent { onGetValue, onSetValue }
/// package on your dependencies and use its Widgets.
///
/// {@endtemplate}
class Signal<T> with RtState {
bool _shouldGetValueNotify = true;
bool _shouldSetValueNotify = true;

class Signal<T> with RtState, StateDependency {
T _value;
final String? _debugLabel;

@override
String? get debugLabel => _debugLabel ?? super.debugLabel;

@override
Map<String, dynamic> get debugInfo => {'value': value};
Map<String, dynamic> get debugInfo => {'value': _value};

/// Returns the [value] of the signal.
T get value {
_notifyGetValue();

SignalRuntime.link(this);
return _value;
}

Expand All @@ -111,10 +110,7 @@ class Signal<T> with RtState {
set value(T val) {
if (_value == val) return;

update((_) {
_value = val;
_notifySetValue();
});
update((_) => _value = val);
}

/// {@macro reactter.signal}
Expand All @@ -134,19 +130,21 @@ class Signal<T> with RtState {
T call([T? val]) {
assert(!isDisposed, "You can call when it's been disposed");

if (val != null) value = val;
if (val == null) return value;

if (val != _value) update((_) => _value = val);

return value;
return _value;
}

/// Executes [callback], and notifies the listeners about the update.
@override
void update(void Function(T value) fnUpdate) {
super.update(() => fnUpdate(value));
super.update(() => fnUpdate(_value));
}

@override
String toString() => value.toString();
String toString() => _value.toString();

@override
// ignore: unnecessary_overrides
Expand All @@ -173,23 +171,7 @@ class Signal<T> with RtState {
///
@override
bool operator ==(Object other) =>
other is Signal<T> ? identical(this, other) : value == other;

void _notifyGetValue() {
if (!_shouldGetValueNotify) return;

_shouldGetValueNotify = false;
Rt.emit(Signal, SignalEvent.onGetValue, this);
_shouldGetValueNotify = true;
}

void _notifySetValue() {
if (!_shouldSetValueNotify) return;

_shouldSetValueNotify = false;
Rt.emit(Signal, SignalEvent.onSetValue, this);
_shouldSetValueNotify = true;
}
other is Signal<T> ? identical(this, other) : _value == other;
}

extension SignalNullExt<T> on Signal<T?> {
Expand Down