Refactor NTWidgetBuilder (#306)

Cleanup some generics, and rename it to NTWidgetRegistry, which is a
better fitting name

Author: Gold872

lib/main.dart

@@ -17,7 +17,7 @@ import 'package:elastic_dashboard/services/app_distributor.dart';
 import 'package:elastic_dashboard/services/field_images.dart';
 import 'package:elastic_dashboard/services/log.dart';
 import 'package:elastic_dashboard/services/nt_connection.dart';
-import 'package:elastic_dashboard/services/nt_widget_builder.dart';
+import 'package:elastic_dashboard/services/nt_widget_registry.dart';
 import 'package:elastic_dashboard/services/settings.dart';
 
 import 'package:path_provider/path_provider.dart'
@@ -76,7 +76,7 @@ void main() async {
       Defaults.logLevel;
   Logger.level = logLevel;
 
-  NTWidgetBuilder.ensureInitialized();
+  NTWidgetRegistry.ensureInitialized();
 
   String ipAddress =
       preferences.getString(PrefKeys.ipAddress) ?? Defaults.ipAddress;

lib/services/nt_widget_builder.dart lib/services/nt_widget_registry.dartlib/services/nt_widget_builder.dart renamed to lib/services/nt_widget_registry.dart

@@ -47,15 +47,15 @@ import 'package:elastic_dashboard/widgets/nt_widgets/single_topic/toggle_button.
 import 'package:elastic_dashboard/widgets/nt_widgets/single_topic/toggle_switch.dart';
 import 'package:elastic_dashboard/widgets/nt_widgets/single_topic/voltage_view.dart';
 
-typedef NTModelJsonProvider =
-    NTWidgetModel Function({
+typedef NTModelJsonProvider<T extends NTWidgetModel> =
+    T Function({
       required Map<String, dynamic> jsonData,
       required NTConnection ntConnection,
       required SharedPreferences preferences,
     });
 
-typedef NTModelProvider =
-    NTWidgetModel Function({
+typedef NTModelProvider<T extends NTWidgetModel> =
+    T Function({
       required NTConnection ntConnection,
       required SharedPreferences preferences,
       required String topic,
@@ -64,17 +64,17 @@ typedef NTModelProvider =
       NT4StructMeta? ntStructMeta,
     });
 
-typedef MultiTopicNTModelProvider =
-    MultiTopicNTWidgetModel Function({
+typedef MultiTopicNTModelProvider<T extends MultiTopicNTWidgetModel> =
+    T Function({
       required NTConnection ntConnection,
       required SharedPreferences preferences,
       required String topic,
       double? period,
     });
 
-typedef NTWidgetProvider = NTWidget Function({Key? key});
+typedef NTWidgetProvider<T extends NTWidget> = T Function({Key? key});
 
-class NTWidgetBuilder {
+class NTWidgetRegistry {
   static final Map<String, NTWidgetProvider> _widgetNameBuildMap = {};
 
   static final Map<String, NTModelProvider> _modelNameBuildMap = {};
@@ -89,7 +89,7 @@ class NTWidgetBuilder {
 
   static const double _normalSize = 128.0;
 
-  NTWidgetBuilder._();
+  NTWidgetRegistry._();
 
   static bool _initialized = false;
   static void ensureInitialized() {
@@ -556,120 +556,76 @@ class NTWidgetBuilder {
   }
 
   static void registerSingleTopic<
-    ModelType extends NTWidgetModel,
+    ModelType extends SingleTopicNTWidgetModel,
     WidgetType extends NTWidget
   >({
     required String name,
-    required SingleTopicNTWidgetModel Function({
-      NT4Type? dataType,
-      double period,
-      required NT4StructMeta? ntStructMeta,
-      required NTConnection ntConnection,
-      required SharedPreferences preferences,
-      required String topic,
-    })
-    model,
-    required NTWidgetProvider widget,
-    required NTWidgetModel Function({
-      required Map<String, dynamic> jsonData,
-      required NTConnection ntConnection,
-      required SharedPreferences preferences,
-    })
-    fromJson,
+    Set<String>? aliases,
+    required NTModelProvider<ModelType> model,
+    required NTWidgetProvider<WidgetType> widget,
+    required NTModelJsonProvider<ModelType> fromJson,
     double? minWidth,
     double? minHeight,
     double? defaultWidth,
     double? defaultHeight,
-    Set<String>? aliases,
-  }) {
-    registerWithAlias(
-      names: {name, ...?aliases},
-      model:
-          ({
-            NT4Type? dataType,
-            double? period,
-            NT4StructMeta? ntStructMeta,
-            required NTConnection ntConnection,
-            required SharedPreferences preferences,
-            required String topic,
-          }) => model(
-            dataType: dataType,
-            period:
-                period ??
-                (preferences.getDouble(PrefKeys.defaultPeriod) ??
-                    Defaults.defaultPeriod),
-            ntStructMeta: ntStructMeta,
-            ntConnection: ntConnection,
-            preferences: preferences,
-            topic: topic,
-          ),
-      widget: widget,
-      fromJson:
-          ({
-            required Map<String, dynamic> jsonData,
-            required NTConnection ntConnection,
-            required SharedPreferences preferences,
-          }) => fromJson(
-            jsonData: jsonData,
-            ntConnection: ntConnection,
-            preferences: preferences,
-          ),
-      minWidth: minWidth,
-      minHeight: minHeight,
-      defaultWidth: defaultWidth,
-      defaultHeight: defaultHeight,
-    );
-  }
+  }) => registerWithAlias(
+    names: {name, ...?aliases},
+    model: model,
+    widget: widget,
+    fromJson: fromJson,
+    minWidth: minWidth,
+    minHeight: minHeight,
+    defaultWidth: defaultWidth,
+    defaultHeight: defaultHeight,
+  );
 
   static void registerMultiTopic<
     ModelType extends MultiTopicNTWidgetModel,
     WidgetType extends NTWidget
   >({
     required String name,
-    required MultiTopicNTModelProvider model,
-    required NTWidgetProvider widget,
-    required NTModelJsonProvider fromJson,
+    Set<String>? aliases,
+    required MultiTopicNTModelProvider<ModelType> model,
+    required NTWidgetProvider<WidgetType> widget,
+    required NTModelJsonProvider<ModelType> fromJson,
     double? minWidth,
     double? minHeight,
     double? defaultWidth,
     double? defaultHeight,
-    Set<String>? aliases,
-  }) {
-    registerWithAlias(
-      names: {name, ...?aliases},
-      model:
-          ({
-            required NTConnection ntConnection,
-            required SharedPreferences preferences,
-            required String topic,
-            double? period,
-            NT4Type? dataType,
-            NT4StructMeta? ntStructMeta,
-          }) => model(
-            ntConnection: ntConnection,
-            preferences: preferences,
-            topic: topic,
-            period: period,
-          ),
-      widget: widget,
-      fromJson: fromJson,
-      minWidth: minWidth,
-      minHeight: minHeight,
-      defaultWidth: defaultWidth,
-      defaultHeight: defaultHeight,
-    );
-  }
+  }) => registerWithAlias(
+    names: {name, ...?aliases},
+    model:
+        ({
+          required NTConnection ntConnection,
+          required SharedPreferences preferences,
+          required String topic,
+          double? period,
+          NT4Type? dataType,
+          NT4StructMeta? ntStructMeta,
+        }) => model(
+          ntConnection: ntConnection,
+          preferences: preferences,
+          topic: topic,
+          period: period,
+        ),
+    widget: widget,
+    fromJson: fromJson,
+    minWidth: minWidth,
+    minHeight: minHeight,
+    defaultWidth: defaultWidth,
+    defaultHeight: defaultHeight,
+  );
 
   static void
   register<ModelType extends NTWidgetModel, WidgetType extends NTWidget>({
     required String name,
-    required NTModelProvider model,
-    required NTWidgetProvider widget,
-    required NTModelJsonProvider fromJson,
-    double? minWidth,
-    double? minHeight,
-    double? defaultWidth,
-    double? defaultHeight,
+    required NTModelProvider<ModelType> model,
+    required NTWidgetProvider<WidgetType> widget,
+    required NTModelJsonProvider<ModelType> fromJson,
+    required double? minWidth,
+    required double? minHeight,
+    required double? defaultWidth,
+    required double? defaultHeight,
   }) {
     _modelNameBuildMap.addAll({name: model});
     _modelJsonBuildMap.addAll({name: fromJson});
@@ -690,17 +646,17 @@ class NTWidgetBuilder {
   }
 
   static void registerWithAlias<
-    ModelType extends SingleTopicNTWidgetModel,
+    ModelType extends NTWidgetModel,
     WidgetType extends NTWidget
   >({
     required Set<String> names,
-    required NTModelProvider model,
-    required NTWidgetProvider widget,
-    required NTModelJsonProvider fromJson,
-    double? minWidth,
-    double? minHeight,
-    double? defaultWidth,
-    double? defaultHeight,
+    required NTModelProvider<ModelType> model,
+    required NTWidgetProvider<WidgetType> widget,
+    required NTModelJsonProvider<ModelType> fromJson,
+    required double? minWidth,
+    required double? minHeight,
+    required double? defaultWidth,
+    required double? defaultHeight,
   }) {
     for (String name in names) {
       register(

lib/widgets/draggable_containers/models/nt_widget_container_model.dart

@@ -5,7 +5,7 @@ import 'package:flutter_context_menu/flutter_context_menu.dart';
 import 'package:provider/provider.dart';
 
 import 'package:elastic_dashboard/services/nt_connection.dart';
-import 'package:elastic_dashboard/services/nt_widget_builder.dart';
+import 'package:elastic_dashboard/services/nt_widget_registry.dart';
 import 'package:elastic_dashboard/services/settings.dart';
 import 'package:elastic_dashboard/services/text_formatter_builder.dart';
 import 'package:elastic_dashboard/widgets/dialog_widgets/dialog_dropdown_chooser.dart';
@@ -41,10 +41,10 @@ class NTWidgetContainerModel extends WidgetContainerModel {
   void init() {
     super.init();
 
-    minWidth = NTWidgetBuilder.getMinimumWidth(childModel);
-    minHeight = NTWidgetBuilder.getMinimumHeight(childModel);
+    minWidth = NTWidgetRegistry.getMinimumWidth(childModel);
+    minHeight = NTWidgetRegistry.getMinimumHeight(childModel);
 
-    NTWidget? childWidget = NTWidgetBuilder.buildNTWidgetFromModel(childModel);
+    NTWidget? childWidget = NTWidgetRegistry.buildNTWidgetFromModel(childModel);
 
     if (childWidget != null) {
       child = childWidget;
@@ -88,7 +88,7 @@ class NTWidgetContainerModel extends WidgetContainerModel {
 
     String type = tryCast(jsonData['type']) ?? '';
 
-    childModel = NTWidgetBuilder.buildNTModelFromJson(
+    childModel = NTWidgetRegistry.buildNTModelFromJson(
       ntConnection,
       preferences,
       type,
@@ -352,7 +352,7 @@ class NTWidgetContainerModel extends WidgetContainerModel {
     childModel.unSubscribe();
     childModel.dispose();
 
-    childModel = NTWidgetBuilder.buildNTModelFromType(
+    childModel = NTWidgetRegistry.buildNTModelFromType(
       ntConnection,
       preferences,
       switch (childModel) {
@@ -371,21 +371,21 @@ class NTWidgetContainerModel extends WidgetContainerModel {
                 Defaults.defaultGraphPeriod,
     );
 
-    NTWidget? newWidget = NTWidgetBuilder.buildNTWidgetFromModel(childModel);
+    NTWidget? newWidget = NTWidgetRegistry.buildNTWidgetFromModel(childModel);
 
     newWidget ??= const EmptyNTWidget();
 
     child = newWidget;
 
-    minWidth = NTWidgetBuilder.getMinimumWidth(childModel);
-    minHeight = NTWidgetBuilder.getMinimumHeight(childModel);
+    minWidth = NTWidgetRegistry.getMinimumWidth(childModel);
+    minHeight = NTWidgetRegistry.getMinimumHeight(childModel);
 
     notifyListeners();
   }
 
   void updateMinimumSize() {
-    minWidth = NTWidgetBuilder.getMinimumWidth(childModel);
-    minHeight = NTWidgetBuilder.getMinimumHeight(childModel);
+    minWidth = NTWidgetRegistry.getMinimumWidth(childModel);
+    minHeight = NTWidgetRegistry.getMinimumHeight(childModel);
 
     notifyListeners();
   }

lib/widgets/network_tree/networktables_tree_row.dart

@@ -5,7 +5,7 @@ import 'package:shared_preferences/shared_preferences.dart';
 
 import 'package:elastic_dashboard/services/nt4_type.dart';
 import 'package:elastic_dashboard/services/nt_connection.dart';
-import 'package:elastic_dashboard/services/nt_widget_builder.dart';
+import 'package:elastic_dashboard/services/nt_widget_registry.dart';
 import 'package:elastic_dashboard/services/settings.dart';
 import 'package:elastic_dashboard/widgets/draggable_containers/draggable_widget_container.dart';
 import 'package:elastic_dashboard/widgets/draggable_containers/models/nt_widget_container_model.dart';
@@ -198,7 +198,7 @@ class NetworkTableTreeRow {
       return null;
     }
 
-    return NTWidgetBuilder.buildNTModelFromType(
+    return NTWidgetRegistry.buildNTModelFromType(
       ntConnection,
       preferences,
       entry?.meta,
@@ -229,7 +229,7 @@ class NetworkTableTreeRow {
   }) async {
     NTWidgetModel? primary = await getPrimaryWidget();
 
-    if (primary == null || !NTWidgetBuilder.isRegistered(primary.type)) {
+    if (primary == null || !NTWidgetRegistry.isRegistered(primary.type)) {
       primary?.unSubscribe();
       primary?.softDispose(deleting: true);
       primary?.dispose();
@@ -248,7 +248,7 @@ class NetworkTableTreeRow {
       return null;
     }
 
-    NTWidget? widget = NTWidgetBuilder.buildNTWidgetFromModel(primary);
+    NTWidget? widget = NTWidgetRegistry.buildNTWidgetFromModel(primary);
 
     if (widget == null) {
       primary.unSubscribe();
@@ -257,8 +257,8 @@ class NetworkTableTreeRow {
       return null;
     }
 
-    double width = NTWidgetBuilder.getDefaultWidth(primary);
-    double height = NTWidgetBuilder.getDefaultHeight(primary);
+    double width = NTWidgetRegistry.getDefaultWidth(primary);
+    double height = NTWidgetRegistry.getDefaultHeight(primary);
 
     return NTWidgetContainerModel(
       ntConnection: ntConnection,
@@ -274,7 +274,7 @@ class NetworkTableTreeRow {
     if (primary == null) {
       return null;
     }
-    NTWidget? widget = NTWidgetBuilder.buildNTWidgetFromModel(primary);
+    NTWidget? widget = NTWidgetRegistry.buildNTWidgetFromModel(primary);
 
     if (widget == null) {
       primary.unSubscribe();
@@ -284,8 +284,8 @@ class NetworkTableTreeRow {
       return null;
     }
 
-    double width = NTWidgetBuilder.getDefaultWidth(primary);
-    double height = NTWidgetBuilder.getDefaultHeight(primary);
+    double width = NTWidgetRegistry.getDefaultWidth(primary);
+    double height = NTWidgetRegistry.getDefaultHeight(primary);
 
     return WidgetContainer(
       title: rowName,