Merge pull request libgit2#917 from jeffhostetler/jeffhostetler/git_trace_reference2

nulltoken · nulltoken · commit 78e57ebc01fe · 2015-01-20T15:25:10.000+01:00
Prevent the git_trace callback from being garbage collected
diff --git a/LibGit2Sharp/Core/Proxy.cs b/LibGit2Sharp/Core/Proxy.cs
@@ -2959,6 +2959,18 @@ public static GitObjectType git_tag_target_type(GitObjectSafeHandle tag)
 
         #region git_trace_
 
+        /// <summary>
+        /// Install/Enable logging inside of LibGit2 to send messages back to LibGit2Sharp.
+        ///
+        /// Since the given callback will be passed into and retained by C code,
+        /// it is very important that you pass an actual delegate here (and don't
+        /// let the compiler create/cast a temporary one for you).  Furthermore, you
+        /// must hold a reference to this delegate until you turn off logging.
+        ///
+        /// This callback is unlike other callbacks because logging persists in the
+        /// process until disabled; in contrast, most callbacks are only defined for
+        /// the duration of the down-call.
+        /// </summary>
         public static void git_trace_set(LogLevel level, NativeMethods.git_trace_cb callback)
         {
             using (ThreadAffinity())
diff --git a/LibGit2Sharp/GlobalSettings.cs b/LibGit2Sharp/GlobalSettings.cs
@@ -97,7 +97,7 @@ public static LogConfiguration LogConfiguration
                 }
                 else
                 {
-                    Proxy.git_trace_set(value.Level, value.GitTraceHandler);
+                    Proxy.git_trace_set(value.Level, value.GitTraceCallback);
 
                     Log.Write(LogLevel.Info, "Logging enabled at level {0}", value.Level);
                 }
diff --git a/LibGit2Sharp/LogConfiguration.cs b/LibGit2Sharp/LogConfiguration.cs
@@ -27,6 +27,9 @@ public LogConfiguration(LogLevel level, LogHandler handler)
 
             Level = level;
             Handler = handler;
+
+            // Explicitly create (and hold a reference to) a callback-delegate to wrap GitTraceHandler().
+            GitTraceCallback = GitTraceHandler;
         }
 
         private LogConfiguration()
@@ -35,8 +38,14 @@ private LogConfiguration()
 
         internal LogLevel Level { get; private set; }
         internal LogHandler Handler { get; private set; }
+        internal NativeMethods.git_trace_cb GitTraceCallback { get; private set; }
 
-        internal void GitTraceHandler(LogLevel level, IntPtr msg)
+        /// <summary>
+        /// This private method will be called from LibGit2 (from C code via
+        /// the GitTraceCallback delegate) to route LibGit2 log messages to
+        /// the same LogHandler as LibGit2Sharp messages.
+        /// </summary>
+        private void GitTraceHandler(LogLevel level, IntPtr msg)
         {
             string message = LaxUtf8Marshaler.FromNative(msg);
             Handler(level, message);

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public static LogConfiguration LogConfiguration`
`97`	`97`	`}`
`98`	`98`	`else`
`99`	`99`	`{`
`100`		`- Proxy.git_trace_set(value.Level, value.GitTraceHandler);`
	`100`	`+ Proxy.git_trace_set(value.Level, value.GitTraceCallback);`
`101`	`101`
`102`	`102`	`Log.Write(LogLevel.Info, "Logging enabled at level {0}", value.Level);`
`103`	`103`	`}`