diff options
Diffstat (limited to 'Plugins/src/Attributes')
-rw-r--r-- | Plugins/src/Attributes/ConfigurationInitalizerAttribute.cs | 47 | ||||
-rw-r--r-- | Plugins/src/Attributes/ConsoleEventHandler.cs | 47 | ||||
-rw-r--r-- | Plugins/src/Attributes/LogInitializerAttribute.cs | 46 |
3 files changed, 140 insertions, 0 deletions
diff --git a/Plugins/src/Attributes/ConfigurationInitalizerAttribute.cs b/Plugins/src/Attributes/ConfigurationInitalizerAttribute.cs new file mode 100644 index 0000000..f214d2b --- /dev/null +++ b/Plugins/src/Attributes/ConfigurationInitalizerAttribute.cs @@ -0,0 +1,47 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins +* File: ConfigurationInitalizerAttribute.cs +* +* ConfigurationInitalizerAttribute.cs is part of VNLib.Plugins which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins. If not, see http://www.gnu.org/licenses/. +*/ + +using System; +using System.Text.Json; + +namespace VNLib.Plugins.Attributes +{ + /// <summary> + /// Set this attribute on an <see cref="IPlugin"/> instance method to define the configuration initializer. + /// This attribute can only be defined on a single instance method and cannot be overloaded. + /// <br></br> + /// A plugin host should invoke this method before <see cref="IPlugin.Load"/> + /// <br></br> + /// Method signature <code>public void [methodname] (<see cref="JsonDocument"/> config)</code> + /// </summary> + [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)] + public sealed class ConfigurationInitalizerAttribute : Attribute + { } + + /// <summary> + /// Represents a safe configuration initializer delegate method + /// </summary> + /// <param name="config">The configuration object that plugin will use</param> + public delegate void ConfigInitializer(JsonDocument config); +} diff --git a/Plugins/src/Attributes/ConsoleEventHandler.cs b/Plugins/src/Attributes/ConsoleEventHandler.cs new file mode 100644 index 0000000..f3bd061 --- /dev/null +++ b/Plugins/src/Attributes/ConsoleEventHandler.cs @@ -0,0 +1,47 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins +* File: ConsoleEventHandler.cs +* +* ConsoleEventHandler.cs is part of VNLib.Plugins which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +namespace VNLib.Plugins.Attributes +{ + /// <summary> + /// <para> + /// Set this attribute on an <see cref="IPlugin"/> instance method to define the console message event handler + /// This attribute can only be defined on a single instance method and cannot be overloaded. + /// </para> + /// <para> + /// Method signature <code>public void [methodname] (<see cref="string"/> command)</code> + /// </para> + /// </summary> + [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)] + public class ConsoleEventHandlerAttribute : Attribute + {} + + /// <summary> + /// Represents a safe console event delegate method + /// </summary> + /// <param name="command">The command to be passed to the plugin</param> + public delegate void ConsoleEventHandler(string command); +} diff --git a/Plugins/src/Attributes/LogInitializerAttribute.cs b/Plugins/src/Attributes/LogInitializerAttribute.cs new file mode 100644 index 0000000..61264fb --- /dev/null +++ b/Plugins/src/Attributes/LogInitializerAttribute.cs @@ -0,0 +1,46 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins +* File: LogInitializerAttribute.cs +* +* LogInitializerAttribute.cs is part of VNLib.Plugins which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published +* by the Free Software Foundation, either version 2 of the License, +* or (at your option) any later version. +* +* VNLib.Plugins is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +* General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with VNLib.Plugins. If not, see http://www.gnu.org/licenses/. +*/ + +using System; + +namespace VNLib.Plugins.Attributes +{ + /// <summary> + /// Set this attribute on an <see cref="IPlugin"/> instance method to define the log initalizer. + /// This attribute can only be defined on a single instance method and cannot be overloaded. + /// <br></br> + /// A plugin host should invoke this method before <see cref="IPlugin.Load"/> but after a <see cref="ConfigurationInitalizerAttribute"/> method + /// <br></br> + /// Method signature <code>public void [methodname] (<see cref="string"/>[] cmdArgs)</code> + /// </summary> + [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)] + public sealed class LogInitializerAttribute : Attribute + { } + + /// <summary> + /// Represents a safe logger initializer delegate method + /// </summary> + /// <param name="args">The arguments to pass to the log iniializer (usually command line args)</param> + public delegate void LogInitializer(string[] args); +} |