summaryrefslogtreecommitdiff
path: root/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-05-04 20:35:08 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-05-04 20:35:08 -0400
commitc1342bd4cd6b75b24d11275bdd73ebf893f916ea (patch)
tree3c647582d242cbb6abc71ae7bbbbd14c63ce6558 /src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs
parent42bf82d870ab744f13197ad781b7529a959861e1 (diff)
downloadSMAPI-c1342bd4cd6b75b24d11275bdd73ebf893f916ea.tar.gz
SMAPI-c1342bd4cd6b75b24d11275bdd73ebf893f916ea.tar.bz2
SMAPI-c1342bd4cd6b75b24d11275bdd73ebf893f916ea.zip
disable case-insensitive paths by default pending performance rework
Diffstat (limited to 'src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs')
-rw-r--r--src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs b/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs
new file mode 100644
index 00000000..678e1383
--- /dev/null
+++ b/src/SMAPI.Toolkit/Utilities/PathLookups/IFilePathLookup.cs
@@ -0,0 +1,20 @@
+namespace StardewModdingAPI.Toolkit.Utilities.PathLookups
+{
+ /// <summary>An API for relative path lookups within a root directory.</summary>
+ internal interface IFilePathLookup
+ {
+ /// <summary>Get the actual path for a given relative file path.</summary>
+ /// <param name="relativePath">The relative path.</param>
+ /// <remarks>Returns the resolved path in file path format, else the normalized <paramref name="relativePath"/>.</remarks>
+ string GetFilePath(string relativePath);
+
+ /// <summary>Get the actual path for a given asset name.</summary>
+ /// <param name="relativePath">The relative path.</param>
+ /// <remarks>Returns the resolved path in asset name format, else the normalized <paramref name="relativePath"/>.</remarks>
+ string GetAssetName(string relativePath);
+
+ /// <summary>Add a relative path that was just created by a SMAPI API.</summary>
+ /// <param name="relativePath">The relative path. This must already be normalized in asset name or file path format.</param>
+ void Add(string relativePath);
+ }
+}