happy at last

jk, im still miserable

Author: MF366-Coding

WriterSharp.PluginApi.V0/Class1.cs

@@ -0,0 +1,25 @@
+using WriterSharp.PluginApi.V0.Language;
+
+
+namespace WriterSharp.PluginApi.V0
+{
+
+	/// <summary>
+	/// Blueprint for plugin contexts.
+	/// </summary>
+	public interface IPluginContext
+	{
+
+		// todo: code logger and file service interfaces
+		ILogger Logger { get; set; }
+
+		IFileService FileService { get; set; }
+
+		/// <summary>
+		/// The global WriterSharp language manager.
+		/// </summary>
+		ILanguageManager LanguageManager { get; set; }
+
+	}
+
+}

WriterSharp.PluginApi.V0/IPluginContext.cs

@@ -0,0 +1,38 @@
+namespace WriterSharp.PluginApi.V0
+{
+	
+	/// <summary>
+	/// Blueprint for a plugin.
+	/// </summary>
+	public interface IWriterSharpPlugin
+	{
+
+		/// <summary>
+		/// The name of the plugin.
+		/// </summary>
+		string Name { get; }
+
+		/// <summary>
+		/// The version of the plugin.
+		/// </summary>
+		string Version { get; }
+		
+		/// <summary>
+		/// The author of the plugin.
+		/// </summary>
+		string Author { get; }
+
+		/// <summary>
+		/// Initializes the current plugin.
+		/// </summary>
+		/// <param name="context">The context to give this plugin.</param>
+		void Initialize(IPluginContext context);
+
+		/// <summary>
+		/// Safely shuts down a plugin.
+		/// </summary>
+		void Shutdown();
+
+	}
+
+}

WriterSharp.PluginApi.V0/IWriterSharpPlugin.cs

@@ -0,0 +1,78 @@
+using System;
+
+
+namespace WriterSharp.PluginApi.V0.Language
+{
+
+	/// <summary>
+	/// Blueprint for language managers.
+	/// </summary>
+	public interface ILanguageManager
+	{
+
+		/// <summary>
+		/// Registers a language into WriterSharp.
+		/// </summary>
+		/// <param name="language">The language</param>
+		/// <returns>A GUID that can be used to unregister this language later on</returns>
+		public Guid RegisterLanguage(
+			LanguageDefinition language
+		);
+
+		/// <summary>
+		/// Retrieves a registered language.
+		/// </summary>
+		/// <param name="id">The language ID</param>
+		/// <returns>The language</returns>
+		public LanguageDefinition GetLanguage(
+			string id
+		);
+
+		/// <summary>
+		/// Checks if a language is registered.
+		/// </summary>
+		/// <param name="id">The language ID</param>
+		/// <returns>Is the language registered?</returns>
+		public bool IsRegistered(
+			string id
+		);
+
+		/// <summary>
+		/// Checks if a language is registered.
+		/// </summary>
+		/// <param name="language">The language</param>
+		/// <returns>Is the language registered?</returns>
+		public bool IsRegistered(
+			LanguageDefinition language
+		);
+
+		/// <summary>
+		/// Retrieves a registered language by one of its extensions.
+		/// </summary>
+		/// <param name="fileExtension">One of the language's extensions</param>
+		/// <returns>The language</returns>
+		public LanguageDefinition GetLanguageByExtension(
+			string fileExtension
+		);
+
+		/// <summary>
+		/// Retrieves a registered language by its grammar.
+		/// </summary>
+		/// <param name="grammar">One of the language's grammars</param>
+		/// <returns>The language</returns>
+		public LanguageDefinition GetLanguageByGrammar(
+			string grammar
+		);
+
+		/// <summary>
+		/// Unregisters the language associated with the specified GUID.
+		/// </summary>
+		/// <param name="associatedGuid">The GUID that was given at creation</param>
+		/// <returns><c>true</c> if successful</returns>
+		public bool UnregisterLanguage(
+			Guid associatedGuid
+		);
+
+	}
+
+}

WriterSharp.PluginApi.V0/Language/ILanguageManager.cs

@@ -0,0 +1,34 @@
+namespace WriterSharp.PluginApi.V0.Language
+{
+
+	/// <summary>
+	/// Represents a language supported by WriterSharp (via the plugin).
+	/// </summary>
+	public class LanguageDefinition
+	{
+
+		/// <summary>
+		/// A unique ID to give this language.
+		/// </summary>
+		public required string Id { get; set; }
+
+		/// <summary>
+		/// The file extensions that trigger this language.
+		/// </summary>
+		public string[] Extensions { get; set; } = [];
+
+		/// <summary>
+		/// The path to a TextMate grammar.
+		/// You may also pass an identifier for a default grammar if,
+		/// instead of a path, you pass a string in the following format:
+		/// <code>&lt;grammar-name&gt;</code>
+		/// Examples:
+		/// <list type="bullet"><c>path/to/grammar</c> (path)</list>
+		/// <list type="bullet"><c>grammar</c> (path)</list>
+		/// <list type="bullet"><c>&lt;grammar&gt;</c> (default grammar of name "grammar")</list>
+		/// </summary>
+		public string? TextMateGrammarPath { get; set; }
+
+	}
+
+}

WriterSharp.PluginApi.V0/Language/LanguageDefinition.cs

@@ -0,0 +1,42 @@
+namespace WriterSharp.PluginApi.V0.Theming
+{
+
+	/// <summary>
+	/// Properties for the formatting of a token.
+	/// </summary>
+	public struct TextFormatting
+	{
+
+		/// <summary>
+		/// The background color of the token.
+		/// </summary>
+		public string? BackgroundColor { get; set; }
+
+		/// <summary>
+		/// The foreground color of the token.
+		/// </summary>
+		public string TextColor { get; set; }
+
+		/// <summary>
+		/// Whether the token should be <strong>bold</strong>.
+		/// </summary>
+		public bool Bold { get; set; }
+
+		/// <summary>
+		/// Whether the token should be <i>italic</i>.
+		/// </summary>
+		public bool Italic { get; set; }
+
+		/// <summary>
+		/// Whether the token should be <s>strikethrough</s>.
+		/// </summary>
+		public bool Strikethrough { get; set; }
+
+		/// <summary>
+		/// Whether the token should be <u>underline</u>.
+		/// </summary>
+		public bool Underline { get; set; }
+
+	}
+
+}

WriterSharp.PluginApi.V0/Theming/TextFormatting.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+
+
+namespace WriterSharp.PluginApi.V0.Theming
+{
+
+	/// <summary>
+	/// Represents a WriterSharp theme.
+	/// </summary>
+	public class Theme
+	{
+
+		/// <summary>
+		/// The name of the theme.
+		/// </summary>
+		public required string Name { get; set; }
+		
+		/// <summary>
+		/// The colors of the theme (UI).
+		/// </summary>
+		public Dictionary<string, string> Colors { get; } = [];
+
+		/// <summary>
+		/// The colors of the theme (syntax highlighting).
+		/// </summary>
+		public Dictionary<string, TextFormatting> TokenColors { get; } = [];
+
+	}
+
+}