Make string marshaling either lax or strict

Author: nulltoken

LibGit2Sharp/BranchCollection.cs

@@ -91,7 +91,7 @@ private Branch BuildFromReferenceName(string canonicalName)
         /// <returns>An <see cref="IEnumerator{T}"/> object that can be used to iterate through the collection.</returns>
         public virtual IEnumerator<Branch> GetEnumerator()
         {
-            return Proxy.git_branch_foreach(repo.Handle, GitBranchType.GIT_BRANCH_LOCAL | GitBranchType.GIT_BRANCH_REMOTE, branchToCanoncialName)
+            return Proxy.git_branch_foreach(repo.Handle, GitBranchType.GIT_BRANCH_LOCAL | GitBranchType.GIT_BRANCH_REMOTE, BranchToCanoncialName)
                 .Select(n => this[n])
                 .GetEnumerator();
         }
@@ -203,9 +203,9 @@ private static bool LooksLikeABranchName(string referenceName)
                 referenceName.LooksLikeRemoteTrackingBranch();
         }
 
-        private static string branchToCanoncialName(IntPtr namePtr, GitBranchType branchType)
+        private static string BranchToCanoncialName(IntPtr namePtr, GitBranchType branchType)
         {
-            string shortName = Utf8Marshaler.FromNative(namePtr);
+            string shortName = LaxUtf8Marshaler.FromNative(namePtr);
 
             switch (branchType)
             {

LibGit2Sharp/CheckoutCallbacks.cs

@@ -86,9 +86,9 @@ private void OnGitCheckoutProgress(IntPtr str, UIntPtr completedSteps, UIntPtr t
             if (onCheckoutProgress != null)
             {
                 // Convert null strings into empty strings.
-                string path = (str != IntPtr.Zero) ? Utf8Marshaler.FromNative(str) : string.Empty;
+                FilePath path = (str != IntPtr.Zero) ? LaxFilePathMarshaler.FromNative(str) : FilePath.Empty;
 
-                onCheckoutProgress(path, (int)completedSteps, (int)totalSteps);
+                onCheckoutProgress(path.Native, (int)completedSteps, (int)totalSteps);
             }
         }
 
@@ -103,9 +103,9 @@ private int OnGitCheckoutNotify(
             int result = 0;
             if (this.onCheckoutNotify != null)
             {
-                string path = (pathPtr != IntPtr.Zero) ?
-                    ((FilePath)Utf8Marshaler.FromNative(pathPtr)).Native : string.Empty;
-                result = onCheckoutNotify(path, why) ? 0 : 1;
+                FilePath path = (pathPtr != IntPtr.Zero) ?
+                    LaxFilePathMarshaler.FromNative(pathPtr) : FilePath.Empty;
+                result = onCheckoutNotify(path.Native, why) ? 0 : 1;
             }
 
             return result;

LibGit2Sharp/Configuration.cs

@@ -282,8 +282,8 @@ private IEnumerable<ConfigurationEntry<string>> BuildConfigEntries()
             {
                 var entry = (GitConfigEntry)Marshal.PtrToStructure(entryPtr, typeof(GitConfigEntry));
 
-                return new ConfigurationEntry<string>(Utf8Marshaler.FromNative(entry.namePtr),
-                                                      Utf8Marshaler.FromNative(entry.valuePtr),
+                return new ConfigurationEntry<string>(LaxUtf8Marshaler.FromNative(entry.namePtr),
+                                                      LaxUtf8Marshaler.FromNative(entry.valuePtr),
                                                       (ConfigurationLevel)entry.level);
             });
         }

LibGit2Sharp/ContentChanges.cs

@@ -39,15 +39,15 @@ private int FileCallback(GitDiffDelta delta, float progress, IntPtr payload)
 
         private int HunkCallback(GitDiffDelta delta, GitDiffRange range, IntPtr header, UIntPtr headerlen, IntPtr payload)
         {
-            string decodedContent = Utf8Marshaler.FromNative(header, (int)headerlen);
+            string decodedContent = LaxUtf8Marshaler.FromNative(header, (int)headerlen);
 
             AppendToPatch(decodedContent);
             return 0;
         }
 
         private int LineCallback(GitDiffDelta delta, GitDiffRange range, GitDiffLineOrigin lineorigin, IntPtr content, UIntPtr contentlen, IntPtr payload)
         {
-            string decodedContent = Utf8Marshaler.FromNative(content, (int)contentlen);
+            string decodedContent = LaxUtf8Marshaler.FromNative(content, (int)contentlen);
 
             string prefix;
 

LibGit2Sharp/Core/Ensure.cs

@@ -96,7 +96,7 @@ private static void HandleError(int result)
             }
             else
             {
-                errorMessage = Utf8Marshaler.FromNative(error.Message);
+                errorMessage = LaxUtf8Marshaler.FromNative(error.Message);
             }
 
             Func<string, GitErrorCode, GitErrorCategory, LibGit2SharpException> exceptionBuilder;

LibGit2Sharp/Core/FilePathMarshaler.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Text;
 
 namespace LibGit2Sharp.Core
 {
@@ -11,13 +12,13 @@ namespace LibGit2Sharp.Core
     /// Use this marshaler for return values, for example:
     /// [return: MarshalAs(UnmanagedType.CustomMarshaler,
     ///                    MarshalCookie = UniqueId.UniqueIdentifier,
-    ///                    MarshalTypeRef = typeof(FilePathNoCleanupMarshaler))]
+    ///                    MarshalTypeRef = typeof(LaxFilePathNoCleanupMarshaler))]
     /// </summary>
-    internal class FilePathNoCleanupMarshaler : FilePathMarshaler
+    internal class LaxFilePathNoCleanupMarshaler : LaxFilePathMarshaler
     {
-        private static readonly FilePathNoCleanupMarshaler staticInstance = new FilePathNoCleanupMarshaler();
+        private static readonly LaxFilePathNoCleanupMarshaler staticInstance = new LaxFilePathNoCleanupMarshaler();
 
-        public static new ICustomMarshaler GetInstance(String cookie)
+        public new static ICustomMarshaler GetInstance(String cookie)
         {
             return staticInstance;
         }
@@ -43,11 +44,11 @@ public override void CleanUpNativeData(IntPtr pNativeData)
     /// internal static extern int git_index_open(out IndexSafeHandle index,
     ///     [MarshalAs(UnmanagedType.CustomMarshaler,
     ///                MarshalCookie = UniqueId.UniqueIdentifier,
-    ///                MarshalTypeRef = typeof(FilePathMarshaler))] FilePath indexpath);
+    ///                MarshalTypeRef = typeof(StrictFilePathMarshaler))] FilePath indexpath);
     /// </summary>
-    internal class FilePathMarshaler : Utf8Marshaler
+    internal class StrictFilePathMarshaler : StrictUtf8Marshaler
     {
-        private static readonly FilePathMarshaler staticInstance = new FilePathMarshaler();
+        private static readonly StrictFilePathMarshaler staticInstance = new StrictFilePathMarshaler();
 
         public new static ICustomMarshaler GetInstance(String cookie)
         {
@@ -74,9 +75,10 @@ public override IntPtr MarshalManagedToNative(Object managedObj)
             return FromManaged(filePath);
         }
 
-        public override Object MarshalNativeToManaged(IntPtr pNativeData)
+        public override object MarshalNativeToManaged(IntPtr pNativeData)
         {
-            return (FilePath)FromNative(pNativeData);
+            throw new InvalidOperationException(
+                string.Format("{0} cannot be used to retrieve data from libgit2.", GetType().Name));
         }
 
         #endregion
@@ -88,7 +90,52 @@ public static IntPtr FromManaged(FilePath filePath)
                 return IntPtr.Zero;
             }
 
-            return Utf8Marshaler.FromManaged(filePath.Posix);
+            return StrictUtf8Marshaler.FromManaged(filePath.Posix);
+        }
+    }
+
+    /// <summary>
+    /// This marshaler is to be used for capturing a UTF-8 string allocated by libgit2 and
+    /// converting it to a managed FilePath instance. The marshaler will free the native pointer
+    /// after conversion.
+    /// </summary>
+    internal class LaxFilePathMarshaler : EncodingMarshaler
+    {
+        private static readonly LaxFilePathMarshaler staticInstance = new LaxFilePathMarshaler();
+
+        private static readonly Encoding encoding = new UTF8Encoding(true, false);
+
+        public LaxFilePathMarshaler() : base(encoding)
+        { }
+
+        #region ICustomMarshaler
+
+        public override IntPtr MarshalManagedToNative(object managedObj)
+        {
+            throw new InvalidOperationException(
+                string.Format("{0} cannot be used to pass data to libgit2.", GetType().Name));
+        }
+
+        public override Object MarshalNativeToManaged(IntPtr pNativeData)
+        {
+            return FromNative(pNativeData);
+        }
+
+        #endregion
+
+        public static ICustomMarshaler GetInstance(String cookie)
+        {
+            return staticInstance;
+        }
+
+        public static FilePath FromNative(IntPtr pNativeData)
+        {
+            return FromNative(encoding, pNativeData);
+        }
+
+        public static FilePath FromBuffer(byte[] buffer)
+        {
+            return FromBuffer(encoding, buffer);
         }
     }
 }

LibGit2Sharp/Core/GitRepositoryInitOptions.cs

@@ -28,7 +28,7 @@ public static GitRepositoryInitOptions BuildFrom(FilePath workdirPath, bool isBa
             {
                 Debug.Assert(!isBare);
 
-                opts.WorkDirPath = FilePathMarshaler.FromManaged(workdirPath);
+                opts.WorkDirPath = StrictFilePathMarshaler.FromManaged(workdirPath);
             }
 
             if (isBare)

LibGit2Sharp/Core/GitStrArrayIn.cs

@@ -20,7 +20,7 @@ public static GitStrArrayIn BuildFrom(FilePath[] paths)
             for (int i = 0; i < nbOfPaths; i++)
             {
                 var s = paths[i].Posix;
-                pathPtrs[i] = FilePathMarshaler.FromManaged(s);
+                pathPtrs[i] = StrictFilePathMarshaler.FromManaged(s);
             }
 
             int dim = IntPtr.Size * nbOfPaths;