not much done today

Author: MF366-Coding

WriterSharp.PluginApi.V0/IPluginContext.cs

@@ -1,4 +1,6 @@
 using WriterSharp.PluginApi.V0.Language;
+using WriterSharp.PluginApi.V0.Theming;
+using WriterSharp.PluginApi.V0.Utils;
 
 
 namespace WriterSharp.PluginApi.V0
@@ -10,15 +12,25 @@ namespace WriterSharp.PluginApi.V0
 	public interface IPluginContext
 	{
 
-		// todo: code logger and file service interfaces
-		ILogger Logger { get; set; }
+		/// <summary>
+		/// The global logger for WriterSharp.
+		/// </summary>
+		ILogger Log { get; set; }
 
-		IFileService FileService { get; set; }
+		/// <summary>
+		/// The file service for WriterSharp.
+		/// </summary>
+		IFileService Files { get; set; }
 
 		/// <summary>
 		/// The global WriterSharp language manager.
 		/// </summary>
-		ILanguageManager LanguageManager { get; set; }
+		ILanguageManager Languages { get; set; }
+
+		/// <summary>
+		/// The global WriterSharp theme and flavor manager.
+		/// </summary>
+		IThemingManager Themes { get; set; }
 
 	}
 

WriterSharp.PluginApi.V0/Language/ILanguageManager.cs

@@ -15,7 +15,7 @@ public interface ILanguageManager
 		/// </summary>
 		/// <param name="language">The language</param>
 		/// <returns>A GUID that can be used to unregister this language later on</returns>
-		public Guid RegisterLanguage(
+		public Guid Register(
 			LanguageDefinition language
 		);
 
@@ -24,7 +24,7 @@ LanguageDefinition language
 		/// </summary>
 		/// <param name="id">The language ID</param>
 		/// <returns>The language</returns>
-		public LanguageDefinition GetLanguage(
+		public LanguageDefinition Get(
 			string id
 		);
 
@@ -51,7 +51,7 @@ LanguageDefinition language
 		/// </summary>
 		/// <param name="fileExtension">One of the language's extensions</param>
 		/// <returns>The language</returns>
-		public LanguageDefinition GetLanguageByExtension(
+		public LanguageDefinition GetByExtension(
 			string fileExtension
 		);
 
@@ -60,7 +60,7 @@ string fileExtension
 		/// </summary>
 		/// <param name="grammar">One of the language's grammars</param>
 		/// <returns>The language</returns>
-		public LanguageDefinition GetLanguageByGrammar(
+		public LanguageDefinition GetByGrammar(
 			string grammar
 		);
 
@@ -69,7 +69,7 @@ string grammar
 		/// </summary>
 		/// <param name="associatedGuid">The GUID that was given at creation</param>
 		/// <returns><c>true</c> if successful</returns>
-		public bool UnregisterLanguage(
+		public bool Unregister(
 			Guid associatedGuid
 		);
 

WriterSharp.PluginApi.V0/Theming/IThemingManager.cs

@@ -0,0 +1,53 @@
+using System.IO;
+using System.Text.Json.Nodes;
+
+
+namespace WriterSharp.PluginApi.V0.Theming
+{
+
+	/// <summary>
+	/// Blueprint for theme managers.
+	/// </summary>
+	public interface IThemingManager
+	{
+
+		/// <summary>
+		/// Registers a theme.
+		/// </summary>
+		/// <param name="theme">The theme to register.</param>
+		void Register(Theme theme);
+
+		/// <summary>
+		/// Sets a flavor from a theme.
+		/// </summary>
+		/// <param name="theme">The theme whose flavor to set.</param>
+		void SetFlavor(Theme theme);
+
+		/// <summary>
+		/// Sets a flavor from a theme file.
+		/// </summary>
+		/// <param name="themeFile">The file of the theme.</param>
+		void SetFlavor(FileInfo themeFile);
+
+		/// <summary>
+		/// Sets an editor theme from a theme.
+		/// </summary>
+		/// <param name="theme">The theme whose editor theme to set.</param>
+		void SetTheme(Theme theme);
+
+		/// <summary>
+		/// Sets an editor theme from a theme file.
+		/// </summary>
+		/// <param name="themeFile">The file of the theme.</param>
+		void SetTheme(FileInfo themeFile);
+
+		/// <summary>
+		/// Converts a theme to JSON format.
+		/// </summary>
+		/// <param name="theme">The theme to convert.</param>
+		/// <returns>The root JSON node</returns>
+		JsonObject ToJson(Theme theme);
+
+	}
+
+}

WriterSharp.PluginApi.V0/Theming/Theme.cs

@@ -16,12 +16,12 @@ public class Theme
 		public required string Name { get; set; }
 
 		/// <summary>
-		/// The colors of the theme (UI).
+		/// The flavor (colors of the UI theme).
 		/// </summary>
-		public Dictionary<string, string> Colors { get; } = [];
+		public Dictionary<string, string> Flavor { get; } = [];
 
 		/// <summary>
-		/// The colors of the theme (syntax highlighting).
+		/// The actual theme itself (colors of the editor).
 		/// </summary>
 		public Dictionary<string, TextFormatting> TokenColors { get; } = [];
 

WriterSharp.PluginApi.V0/Utils/AsyncMessageSeverity.cs

@@ -0,0 +1,37 @@
+namespace WriterSharp.PluginApi.V0.Utils
+{
+
+	/// <summary>
+	/// The severity of the async message.
+	/// </summary>
+	public enum AsyncMessageSeverity : byte
+	{
+
+		/// <summary>
+		/// A neutral message.
+		/// </summary>
+		NeutralMessage,
+
+		/// <summary>
+		/// An info message.
+		/// </summary>
+		Info,
+
+		/// <summary>
+		/// A success message.
+		/// </summary>
+		Success,
+
+		/// <summary>
+		/// A warning message.
+		/// </summary>
+		Warning,
+
+		/// <summary>
+		/// An error message.
+		/// </summary>
+		Error
+
+	}
+
+}

WriterSharp.PluginApi.V0/Utils/IFileService.cs

@@ -0,0 +1,59 @@
+using System.IO;
+
+
+namespace WriterSharp.PluginApi.V0.Utils
+{
+
+	/// <summary>
+	/// Blueprint for file services.
+	/// </summary>
+	public interface IFileService
+	{
+
+		/// <summary>
+		/// <c>true</c> if the current file is saved.
+		/// </summary>
+		bool IsCurrentOpenSaved { get; }
+
+		/// <summary>
+		/// Gets the current open file.
+		/// Might fail if the current open file doesn't exist on disk
+		/// yet.
+		/// </summary>
+		/// <exception cref="FileNotFoundException" />
+		/// <returns>The file if one exists</returns>
+		FileInfo GetCurrentOpen();
+
+		/// <summary>
+		/// Tries to get the current open file.
+		/// </summary>
+		/// <param name="file">The file that's currently open or null if it doesn't exist on disk yet</param>
+		/// <returns><c>true</c> if the current file exists on disk</returns>
+		bool TryGetCurrentOpen(out FileInfo? file);
+
+		/// <summary>
+		/// Opens a file.
+		/// </summary>
+		/// <param name="file">The file to open.</param>
+		void Open(FileInfo file);
+
+		/// <summary>
+		/// Saves the current file as another.
+		/// </summary>
+		/// <param name="newFile">The output file</param>
+		void SaveAs(FileInfo newFile);
+
+		/// <summary>
+		/// Saves and closes the current file.
+		/// </summary>
+		void Close();
+
+		/// <summary>
+		/// Closes the current file.
+		/// </summary>
+		/// <param name="force">If <c>true</c>, will <strong>NOT</strong> save before closing.</param>
+		void Close(bool force);
+
+	}
+
+}

WriterSharp.PluginApi.V0/Utils/ILogger.cs

@@ -0,0 +1,42 @@
+namespace WriterSharp.PluginApi.V0.Utils
+{
+
+	/// <summary>
+	/// Blueprint for loggers.
+	/// </summary>
+	public interface ILogger
+	{
+
+		/// <summary>
+		/// Logs an info message.
+		/// </summary>
+		/// <param name="message">The message to log.</param>
+		void Info(string message);
+
+		/// <summary>
+		/// Logs a warning message.
+		/// </summary>
+		/// <param name="message">The message to log.</param>
+		void Warning(string message);
+
+		/// <summary>
+		/// Logs an error message.
+		/// </summary>
+		/// <param name="message">The message to log.</param>
+		void Error(string message);
+
+		/// <summary>
+		/// Logs a success message.
+		/// </summary>
+		/// <param name="message">The message to log.</param>
+		void Success(string message);
+
+		/// <summary>
+		/// Logs a neutral message.
+		/// </summary>
+		/// <param name="message">The message to log.</param>
+		void Message(string message);
+
+	}
+
+}

WriterSharp.Tests/UnitTest1.cs

@@ -0,0 +1,15 @@
+namespace WriterSharp.Tests
+{
+
+	public class UnitTest_Testing
+	{
+
+		[Fact]
+		public void ObjectEqualsToSelf() => Assert.Equal(1, 1.0);
+
+		[Fact]
+		public void ObjectNotEqualsToSelf() => Assert.NotEqual(1, 1.001);
+
+	}
+
+}