also uh CancellationTokens nice

Author: MF366-Coding

WriterSharp.PluginApi/FileSystem/IFileSystem.cs

@@ -1,5 +1,7 @@
 using System;
 using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
 
 
 namespace WriterSharp.PluginApi.FileSystem
@@ -12,28 +14,26 @@ namespace WriterSharp.PluginApi.FileSystem
 	public interface IFileSystem
 	{
 
-		#region Reading
-
 		/// <summary>
 		/// Reads all text from a file.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <returns>The contents of the file</returns>
-		public string ReadAllText(string filepath);
+		public Task<string> ReadAllTextAsync(string filepath, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Reads all text from a file, as a list of lines.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <returns>The contents of the file</returns>
-		public string[] ReadAllLines(string filepath);
+		public Task<string[]> ReadAllLinesAsync(string filepath, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Reads the very first line of a file.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <returns>The first line of the file</returns>
-		public string ReadLine(string filepath);
+		public Task<string> ReadLineAsync(string filepath, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Reads a specific amount of characters from a file buffer.
@@ -42,49 +42,37 @@ public interface IFileSystem
 		/// <param name="amount">The amount of characters to read</param>
 		/// <param name="offset">The index from which to start reading the characters</param>
 		/// <returns>A span of characters</returns>
-		public Span<char> ReadCharacters(string filepath, ulong amount, long offset = 0);
-
-		#endregion
-
-		#region Writing
+		public Task<nint> ReadCharactersAsync(string filepath, ulong amount, long offset = 0, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Writes text to a file, creating it if necessary. If the file exists,
 		/// it will be overwritten.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <param name="data">The text to write</param>
-		public void WriteAllText(string filepath, string data);
+		public Task WriteAllTextAsync(string filepath, string data, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Writes lines of text to a file, creating it if necessary.
 		/// If the file exists, it will be overwritten.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <param name="data">The lines of text to write</param>
-		public void WriteAllLines(string filepath, string[] data);
-
-		#endregion
-
-		#region Appending
+		public Task WriteAllLinesAsync(string filepath, string[] data, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Appends all the text to the end of a file.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <param name="data">The text to append</param>
-		public void AppendAllText(string filepath, string data);
+		public Task AppendAllTextAsync(string filepath, string data, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Appends all the specified lines of text to the end of a file.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
 		/// <param name="data">The lines to append</param>
-		public void AppendAllLines(string filepath, string[] data);
-
-		#endregion
-
-		#region Sharding Toolkit
+		public Task AppendAllLinesAsync(string filepath, string[] data, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Checks if a file is in use by another plugin.
@@ -95,21 +83,17 @@ public interface IFileSystem
 		/// <returns><c>true</c> if in use by another plugin</returns>
 		public bool InUse(string filepath);
 
-		#endregion
-
-		#region Locking
-
 		/// <summary>
 		/// Locks a file, to prevent it from being accessed by other plugins.
 		/// </summary>
 		/// <param name="filepath">The path to the file to lock</param>
-		public void Lock(string filepath);
+		public Task LockAsync(string filepath, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Unlocks a previously locked file.
 		/// </summary>
 		/// <param name="filepath">The path to the file</param>
-		public void Unlock(string filepath);
+		public Task UnlockAsync(string filepath, CancellationToken cancellationToken = default);
 
 		/// <summary>
 		/// Checks if a file is locked.
@@ -134,23 +118,23 @@ public interface IFileSystem
 		/// <returns><c>true</c> if it can be locked</returns>
 		public bool IsLockable(string filepath);
 
-		#endregion
-
-		#region Stream
-
-		/// <inheritdoc cref="File.OpenRead(String)" />
-		public FileStream OpenRead(string filepath);
-
-		/// <inheritdoc cref="File.OpenWrite(String)" />
-		public FileStream OpenWrite(string filepath);
+		/// <inheritdoc cref="System.IO.File.OpenRead(String)" />
+		public Task<FileStream> OpenReadAsync(string filepath, CancellationToken cancellationToken = default);
 
-		/// <inheritdoc cref="File.OpenText(String)" />
-		public FileStream OpenText(string filepath);
+		/// <inheritdoc cref="System.IO.File.OpenWrite(String)" />
+		public Task<FileStream> OpenWriteAsync(string filepath, CancellationToken cancellationToken = default);
 
-		/// <inheritdoc cref="File.Open(String, FileMode, FileAccess, FileShare)" />
-		public FileStream Open(string filepath, FileMode mode, FileAccess access, FileShare share);
+		/// <inheritdoc cref="System.IO.File.OpenText(String)" />
+		public Task<FileStream> OpenTextAsync(string filepath, CancellationToken cancellationToken = default);
 
-		#endregion
+		/// <inheritdoc cref="System.IO.File.Open(String, FileMode, FileAccess, FileShare)" />
+		public Task<FileStream> OpenAsync(
+			string filepath,
+			FileMode mode,
+			FileAccess access,
+			FileShare share,
+			CancellationToken cancellationToken = default
+		);
 
 	}
 

WriterSharp.PluginApi/IPluginContext.cs

@@ -1,4 +1,8 @@
-namespace WriterSharp.PluginApi
+using WriterSharp.PluginApi.FileSystem;
+using WriterSharp.PluginApi.Settings;
+
+
+namespace WriterSharp.PluginApi
 {
 
 	/// <summary>

WriterSharp.PluginApi/Settings/ISettingsManager.cs

@@ -0,0 +1,101 @@
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+
+namespace WriterSharp.PluginApi.Settings
+{
+
+	/// <summary>
+	/// Manages WriterSharp's plugin's settings globally.
+	/// This does not mean plugins can't have their own individual
+	/// settings files, but it's recommended to use this structure of plugin design.
+	/// </summary>
+	public interface ISettingsManager
+	{
+
+		/// <summary>
+		/// Checks if the settings file is in use by another plugin.
+		/// </summary>
+		/// <returns><c>true</c> if in use</returns>
+		public bool InUse();
+
+		/// <summary>
+		/// Gets the plugin's section.
+		/// </summary>
+		/// <param name="cancellationToken">A cancellation token to stop WriterSharp from getting the section</param>
+		/// <returns>The section, as a dictionary</returns>
+		/// <remarks>Useful if you're going to be editing the settings a lot.</remarks>
+		public Task<Dictionary<string, string>> GetSectionAsync(CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Update's the plugin's section.
+		/// </summary>
+		/// <param name="section">The new version of the section</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public void UpdateSectionAsync(Dictionary<string, string> section, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Retrieves a value from the plugin's section given a key. If the key is missing, an exception is thrown.
+		/// </summary>
+		/// <param name="key">The key that matches the value</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		/// <returns>A string or <c>null</c> if the value was <c>nil</c>.</returns>
+		public Task<string?> GetValueAsync(string key, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="key">The key's name</param>
+		/// <param name="value">The value</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(string key, string value, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="key">The key's name</param>
+		/// <param name="value">The value. It is converted to string</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(string key, int value, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="key">The key's name</param>
+		/// <param name="value">The value. It is converted to string</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(string key, bool value, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="key">The key's name</param>
+		/// <param name="value">The value</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(string key, object? value, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="pair">A key-value pair containing a key string and a value string</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(KeyValuePair<string, string?> pair, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="pair">A key-value pair containing a key string and a value integer</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(KeyValuePair<string, int> pair, CancellationToken cancellationToken = default);
+
+		/// <summary>
+		/// Sets an existing key to match a value or adds a new one if necessary.
+		/// </summary>
+		/// <param name="pair">A key-value pair containing a key string and a value boolean</param>
+		/// <param name="cancellationToken">A cancellation token</param>
+		public Task SetValueAsync(KeyValuePair<string, bool> pair, CancellationToken cancellationToken = default);
+
+	}
+
+}

WriterSharp.PluginApi/WriterSharp.PluginApi.csproj

@@ -28,4 +28,8 @@
 		<DebugType>none</DebugType>
 	</PropertyGroup>
 
+	<ItemGroup>
+	  <PackageReference Include="ini-parser" Version="2.5.2" />
+	</ItemGroup>
+
 </Project>