Even more addons stuff

Author: Calebh101

addons.yaml

@@ -1,3 +1,9 @@
+# This file is used for defining addons.
+# For an example addon, see banana below.
+#
+# To generate the addon files, run this command:
+#   dart run dictionaries:addons
+
 banana:
   # The name of the package containing the code for your plugin.
   # This *must* match what's in your pubspec.yaml.
@@ -32,7 +38,9 @@ banana:
 
   # This is if you used a remote Git repository in one of your pubspec.yamls.
   # It can point to whatever Dart lets it point to.
-  # This is optional, and will only be used if your source is git.
+  #
+  # This is required if your source is git.
+  # It's required for consistency, as Dart locks remote Git repos anyways.
   #ref: "v11.3"
 
   # The ID of your addon.
@@ -42,39 +50,33 @@ banana:
   id: "com.calebh101.banana"
 
   # The name of your addon. This is pretty self-explanatory.
-  # This should match what your package defines.
   # This is required.
   name: "Banana"
 
-  # This should match what your package defines.
   # This is required.
   version: "1.0.0A"
 
   # A short description of your addon.
-  # This should match what your package defines.
   # This is not required.
   description: "BANANA! This addon is a showcase of what you can do with addons."
 
-  # This should match what your package defines.
   # This can either be not present (no authors), a string (1 author), or a list of strings.
   # This is not required and defaults to an empty list.
   authors: "Calebh101"
 
   # The main web page for your addon. This is pretty self explanatory.
-  # This should match what your package defines.
   # This is not required, but if present, it needs to be able to be parsed as a URI.
   mainpage: "https://github.com/Calebh101/Dictionaries/blob/main/addons/banana/README.md"
 
   # The repository for your addon, or where your code is hosted.
-  # This should match what your package defines.
   # This is not required, but if present, it needs to be able to be parsed as a URI.
   #
   # NOTE: This is required if your source is git.
   #repository: "https://github.com/Calebh101/Dictionaries"
 
   # This is the file that will be imported in the generated addon loader.
   # It must expose a `DictionariesAddon Function() load` function.
-  # This is not required, and it defaults to /init.dart.
+  # This is not required, and it defaults to /init.dart. This must start with a slash.
   #initfile: "/dictionaries_addon.dart"
 
 oc_snapshot:

bin/addons.dart

@@ -1,11 +1,12 @@
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:dictionaries/lib/plist_parser.dart';
 import 'package:path/path.dart' as p;
 import 'package:yaml/yaml.dart';
 import 'package:yaml_edit/yaml_edit.dart';
 
-Future<void> main(List<String> arguments) async {
+void main(List<String> arguments) {
   Directory root = Directory.current;
   Directory lib = Directory(p.join(root.path, "lib"));
 
@@ -66,6 +67,7 @@ Future<void> main(List<String> arguments) async {
 
       case AddonSource.git:
         if (data["repository"] is! String) throw Exception("repository must be a string.");
+        if (data["ref"] is! String) throw Exception("ref must be a string.");
 
         pubspecEntry = {"git": {
           "url": data["repository"] as String,
@@ -76,21 +78,25 @@ Future<void> main(List<String> arguments) async {
         break;
     }
 
-    Addon addon = Addon(debug: data["debug"] == true, packageName: data["package"], id: data["id"] ?? "com.unknown", name: data["name"] ?? "Unknown", version: data["version"] ?? "Unknown", description: data["description"], authors: authors, mainpage: Uri.tryParse(data["mainpage"] ?? ""), repository: Uri.tryParse(data["repository"] ?? ""), source: source, pubspecEntry: pubspecEntry, initFile: data["initfile"] is String ? data["initfile"] : Addon.defaultInitFile);
+    Addon addon = Addon(debug: data["debug"] == true, packageName: data["package"], id: data["id"] ?? "com.unknown", name: data["name"] ?? "Unknown", version: data["version"] ?? "Unknown", description: data["description"], authors: authors, mainpage: data["mainpage"] is String ? Uri.tryParse(data["mainpage"]) : null, repository: data["repository"] is String ? Uri.tryParse(data["repository"]) : null, source: source, pubspecEntry: pubspecEntry, initFile: data["initfile"] is String ? data["initfile"] : Addon.defaultInitFile);
     addons.add(addon);
   }
 
-  List<String> imports = ["import 'package:dictionaries/core/addonloader.dart';", ...addons.map((x) => "import 'package:${x.packageName}${x.initFile}.dart' as ${x.packageName};")];
-  List<String> loadStatements = [...addons.map((x) => "(load: ${x.packageName}.load, debug: ${x.debug})")];
+  List<String> imports = ["import 'package:dictionaries/core/addonloader.dart';", ...addons.map((x) => "import 'package:${x.packageName}${x.initFile}' as ${x.packageName};")];
+  List<String> loadStatements = [...addons.map((x) => "(id: '${x.id}', load: ${x.packageName}.load, debug: ${x.debug})")];
+  List<String> infoStatements = [...addons.map((x) => "'${x.id}': ${jsonEncode(x.toJson())}")];
 
   String result = """
 // This is an auto-generated file. Do not edit this.
 ${imports.join("\n")}
-List<({DictionariesAddon Function() load, bool debug})> loadAddons() => [${loadStatements.join(",")}];
+List<({DictionariesAddon Function() load, bool debug, String id})> loadAddons() => [${loadStatements.join(",")}];
+Map<String, Map<String, dynamic>> loadAddonInfo() => {${infoStatements.join(",")}};
 """.trim();
 
   print("Ready to write out to ${loader.path} and ${pubspec.path}. Press any key to continue.");
-  int byte = (await stdin.first)[0];
+  stdin..lineMode = false..echoMode = false;
+  stdin.readByteSync();
+  stdin..lineMode = true..echoMode = true;
   loader.writeAsStringSync(result);
 
   final editor = YamlEditor(pubspec.readAsStringSync());
@@ -126,4 +132,21 @@ class Addon {
   const Addon({required this.packageName, required this.debug, required this.id, required this.name, required this.version, required this.description, required this.authors, required this.mainpage, required this.repository, required this.source, required this.pubspecEntry, required this.initFile});
 
   static const String defaultInitFile = "/init.dart";
+
+  Map<String, dynamic> toJson() {
+    return {
+      "packageName": packageName,
+      "initFile": initFile,
+      "debug": debug,
+      "id": id,
+      "name": name,
+      "version": version,
+      "description": description,
+      "authors": authors,
+      "mainPage": mainpage?.toString(),
+      "repository": repository?.toString(),
+      "source": source.name,
+      "pubspecEntry": pubspecEntry,
+    };
+  }
 }

lib/addons.dart

@@ -2,6 +2,7 @@ library;
 
 import 'dart:async';
 
+import 'package:dictionaries/core/addonloader.g.dart';
 import 'package:dictionaries/injections.dart';
 import 'package:dictionaries/ui/header.dart';
 import 'package:dictionaries/addons.dart';
@@ -19,25 +20,12 @@ abstract class DictionariesAddon {
 
   /// The ID of your addon. This should follow the Java naming procedure, and the final identifier should be lower snake case. Example:
   ///
-  /// `com.calebh101.oc_snapshot`
-  final String id;
-
-  /// The version of your addon. This can be in any format you like.
-  final String version;
-
-  /// The optional short description of your addon.
-  final String? description;
-
-  /// A list of names of who made this, This can be in any format you like.
-  final List<String> authors;
-
-  /// A link to your addon's optional "main page". Take this how you'd like, but [repository] is a separate property for an addon's repository.
-  final Uri? mainpage;
-
-  /// An addon's open source repository.
+  /// ```
+  /// com.calebh101.oc_snapshot
+  /// ```
   ///
-  /// Reminder: Your addon must be open-source and publicly available to be able to be used in Dictionaries!
-  final Uri? repository;
+  /// This should match what's defined in `addons.yaml`.
+  final String id;
 
   /// If this addon should be completely ignored by the loader.
   final bool doNotShow;
@@ -47,19 +35,22 @@ abstract class DictionariesAddon {
   DictionariesAddon({
     required this.name,
     required this.id,
-    required this.version,
-    this.authors = const [],
-    this.description,
-    this.mainpage,
-    this.repository,
     this.doNotShow = false,
   });
 
   /// This is called to register your addon.
   /// **Do not call this yourself**.
-  FutureOr<void> register(bool debug) async {
-    InjectionCollection.instance.addons.add(this);
+  FutureOr<bool> register(bool debug) async {
+    Map<String, dynamic>? data = loadAddonInfo()[id];
+
+    if (data == null) {
+      Logger.warn("Addon $id not found in loadAddonInfo! Did you forget to add your addon in addons.yaml?");
+      return false;
+    }
+
+    InjectionCollection.instance.addons.add(DictionariesAddonData(this, data));
     await onRegister(debug);
+    return true;
   }
 
   /// This is called when your addon is registered. You don't call this, but you *override* this in your class.
@@ -89,7 +80,7 @@ final class DictionariesMaterialAppInjection {
   }
 }
 
-class DictionariesMenuBarInjection {
+final class DictionariesMenuBarInjection {
   final List<DictionariesMenuBarInjectionKey> keys;
   final List<DictionariesMenuBarEntry> entries;
   final DictionariesMenuBarPosition? rightAfter;
@@ -101,7 +92,7 @@ class DictionariesMenuBarInjection {
   }
 }
 
-class DictionariesMenuBarInjectionKey {
+final class DictionariesMenuBarInjectionKey {
   final String id;
   final String? defaultName;
 
@@ -111,9 +102,14 @@ class DictionariesMenuBarInjectionKey {
   String toString() {
     return "DictionariesMenuBarInjectionKey(id: $id, defaultName; $defaultName)";
   }
+
+  @override
+  bool operator ==(Object other) {
+    return other is DictionariesMenuBarInjectionKey && id == other.id;
+  }
 }
 
-class DictionariesMenuBarDeletion {
+final class DictionariesMenuBarDeletion {
   final List<DictionariesMenuBarInjectionKey> keys;
   const DictionariesMenuBarDeletion(this.keys);
 
@@ -122,15 +118,15 @@ class DictionariesMenuBarDeletion {
   }
 }
 
-class DictionariesMenuBarPosition {
+final class DictionariesMenuBarPosition {
   final bool leading;
   final String? text;
 
   const DictionariesMenuBarPosition.fromKey(String key) : text = key, leading = false;
   const DictionariesMenuBarPosition.leading() : text = null, leading = true;
 }
 
-class AddonLogger {
+final class AddonLogger {
   static void print(AddonContext context, Object? input, {List<Object?>? attachments}) {
     Logger.print("${context.id}: $input", attachments: attachments);
   }

lib/core/addonloader.g.dart

@@ -2,4 +2,5 @@
 import 'package:dictionaries/core/addonloader.dart';
 import 'package:banana/init.dart' as banana;
 import 'package:dictionaries_oc_snapshot/init.dart' as dictionaries_oc_snapshot;
-List<({DictionariesAddon Function() load, bool debug})> loadAddons() => [(load: banana.load, debug: true),(load: dictionaries_oc_snapshot.load, debug: true)];
+List<({DictionariesAddon Function() load, bool debug, String id})> loadAddons() => [(id: 'com.calebh101.banana', load: banana.load, debug: true),(id: 'com.calebh101.oc_snapshot', load: dictionaries_oc_snapshot.load, debug: true)];
+Map<String, Map<String, dynamic>> loadAddonInfo() => {'com.calebh101.banana': {"packageName":"banana","initFile":"/init.dart","debug":true,"id":"com.calebh101.banana","name":"Banana","version":"1.0.0A","description":"BANANA! This addon is a showcase of what you can do with addons.","authors":["Calebh101"],"mainPage":"https://github.com/Calebh101/Dictionaries/blob/main/addons/banana/README.md","repository":null,"source":"relativePath","pubspecEntry":{"path":"addons/banana"}},'com.calebh101.oc_snapshot': {"packageName":"dictionaries_oc_snapshot","initFile":"/init.dart","debug":true,"id":"com.calebh101.oc_snapshot","name":"OC Snapshot","version":"1.0.0A","description":null,"authors":["Calebh101"],"mainPage":null,"repository":null,"source":"relativePath","pubspecEntry":{"path":"addons/dictionaries_oc_snapshot"}}};

lib/injections.dart

@@ -4,16 +4,27 @@ class InjectionCollection {
   InjectionCollection();
   static late InjectionCollection instance;
 
-  List<DictionariesAddon> addons = [];
+  List<DictionariesAddonData> addons = [];
 
   List<Injection<DictionariesMenuBarInjection>> menuBarInjections = [];
   List<Injection<DictionariesMenuBarDeletion>> menuBarDeletions = [];
   List<Injection<DictionariesMaterialAppInjection>> materialAppInjections = [];
+
+  void setInstance() {
+    instance = this;
+  }
 }
 
 class Injection<T> {
   final AddonContext context;
   final T injection;
 
   const Injection(this.context, this.injection);
+}
+
+class DictionariesAddonData {
+  final DictionariesAddon addon;
+  final Map<String, dynamic> data;
+
+  const DictionariesAddonData(this.addon, this.data);
 }

lib/main.dart

@@ -0,0 +1,12 @@
+import 'package:dictionaries/core/addonloader.g.dart';
+import 'package:dictionaries/injections.dart';
+import 'package:styled_logger/styled_logger.dart';
+
+void main(List<String> arguments) {
+  InjectionCollection injectionCollection = InjectionCollection()..setInstance();
+
+  for (final x in loadAddons()) {
+    Logger.print("Loading addon ${x.id}...");
+    x.load.call();
+  }
+}

lib/ui/header.dart

@@ -8,9 +8,13 @@ import 'package:menu_bar/menu_bar.dart';
 import 'package:styled_logger/styled_logger.dart';
 import 'package:menu_bar/src/entry.dart';
 
+typedef OnActivate = void Function(BuildContext context);
+
 final menuBarProvider = StateProvider<List<DictionariesMenuBarEntry>>((r) => []);
 final headerTitleProvider = StateProvider<String?>((r) => null);
 
+Map<DictionariesMenuBarInjectionKey, OnActivate> onActivates = {};
+
 bool get isPlatformMenuBarSupported {
   return Environment.isMacos;
 }
@@ -86,14 +90,30 @@ void injectAllMenuBarEntries(List<DictionariesMenuBarEntry> current, List<Dictio
 class DictionariesMenuBarEntry {
   final String id;
   final String? text;
-  final void Function(BuildContext context)? onActivate;
+  final OnActivate? onActivate;
   final List<DictionariesMenuBarEntry> children;
   final MenuSerializableShortcut? shortcut;
   final bool divider;
 
   const DictionariesMenuBarEntry(this.id, this.text, {this.onActivate, this.shortcut, this.children = const []}) : divider = false;
   const DictionariesMenuBarEntry.divider(this.id) : text = null, onActivate = null, shortcut = null, children = const [], divider = true;
 
+  void activate(BuildContext context) {
+    if (!isActive) return;
+    if (onActivate != null) return onActivate!.call(context);
+    if (onActivates.keys.any((x) => x.id == id)) return onActivates.entries.firstWhere((x) => x.key.id == id).value.call(context);
+  }
+
+  bool get isActive {
+    return onActivate != null || onActivates.entries.any((x) => x.key.id == id);
+  }
+
+  static bool injectHandler(DictionariesMenuBarInjectionKey key, OnActivate onActivate) {
+    if (onActivates.containsKey(key)) return false;
+    onActivates[key] = onActivate;
+    return true;
+  }
+
   static const String dividerAfterExport = "DividerAfterExport";
   static const String beforeDownloadOriginalFile = "BeforeDownloadOriginalFile";
 

pubspec.yaml

@@ -46,6 +46,7 @@ dependencies:
   path: ^1.9.1
   quick_listener: ^0.0.1
   flutter_riverpod: ^3.2.0
+
   banana:
     path: addons/banana
   dictionaries_oc_snapshot: