GitTools#203 Added the option to index pdb files using srctool

Srctool is used to list the raw source file information from the pdb and files not found in git or with an invalid extension are ignored.
raymondwu1 · Feb 16, 2019 · 81c1bd2 · 81c1bd2
1 parent 5fd8912
commit 81c1bd2
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 13 deletions.
diff --git a/src/GitLink/Helpers/SrcToolHelper.cs b/src/GitLink/Helpers/SrcToolHelper.cs
@@ -0,0 +1,67 @@
+// <copyright file="SrcToolHelper.cs" company="CatenaLogic">
+//   Copyright (c) 2014 - 2016 CatenaLogic. All rights reserved.
+// </copyright>
+
+namespace GitLink
+{
+    using System.Collections.Generic;
+    using System.Diagnostics;
+    using System.IO;
+    using Catel;
+    using Catel.Logging;
+    using GitTools.Git;
+
+    internal static class SrcToolHelper
+    {
+        private static readonly ILog Log = LogManager.GetCurrentClassLogger();
+
+        internal static List<string> GetSourceFiles(string srcToolFilePath, string projectPdbFile)
+        {
+            Argument.IsNotNullOrWhitespace(() => projectPdbFile);
+            List<string> sources = new List<string>();
+
+            var processStartInfo = new ProcessStartInfo(srcToolFilePath)
+            {
+                Arguments = string.Format("-r \"{0}\"", projectPdbFile),
+                CreateNoWindow = true,
+                UseShellExecute = false,
+                RedirectStandardOutput = true,
+            };
+
+            using (var process = new Process())
+            {
+                process.OutputDataReceived += (s, e) =>
+                {
+                    if (e.Data != null)
+                    {
+                        var sourceFile = e.Data.ToLower();
+
+                        if (Linker.ValidExtension(sourceFile))
+                        {
+                            var repositoryDirectory = GitDirFinder.TreeWalkForGitDir(Path.GetDirectoryName(sourceFile));
+
+                            if (repositoryDirectory != null)
+                            {
+                                sources.Add(sourceFile);
+                            }
+                        }
+                    }
+                };
+
+                process.EnableRaisingEvents = true;
+                process.StartInfo = processStartInfo;
+                process.Start();
+                process.BeginOutputReadLine();
+                process.WaitForExit();
+
+                var processExitCode = process.ExitCode;
+                if (processExitCode != 0)
+                {
+                    throw Log.ErrorAndCreateException<GitLinkException>("SrcTool exited with unexpected error code '{0}'", processExitCode);
+                }
+            }
+
+            return sources;
+        }
+    }
+}
diff --git a/src/GitLink/LinkOptions.cs b/src/GitLink/LinkOptions.cs
@@ -26,6 +26,8 @@ public struct LinkOptions
 
         public bool IndexAllDepotFiles { get; set; }
 
+        public bool IndexWithSrcTool { get; set; }
+
         public string IntermediateOutputPath { get; set; }
     }
 }
diff --git a/src/GitLink/Linker.cs b/src/GitLink/Linker.cs
@@ -30,6 +30,7 @@ public static class Linker
         private static readonly string FilenamePlaceholder = Uri.EscapeUriString("{filename}");
         private static readonly string RevisionPlaceholder = Uri.EscapeUriString("{revision}");
         private static readonly string PdbStrExePath = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "pdbstr.exe");
+        private static readonly string SrcToolExePath = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "srctool.exe");
         private static readonly string[] ExtensionsToIgnore = new string[] { ".g.cs" };
         private static IReadOnlyList<string> _sourceFilesList = null;
 
@@ -81,11 +82,18 @@ public static class Linker
             }
             else
             {
-                _sourceFilesList = GetSourceFilesFromPdb(pdbPath, !options.SkipVerify);
+                if (options.IndexWithSrcTool)
+                {
+                    _sourceFilesList = SrcToolHelper.GetSourceFiles(SrcToolExePath, pdbPath);
+                }
+                else
+                {
+                    _sourceFilesList = GetSourceFilesFromPdb(pdbPath, !options.SkipVerify);
+                }
 
                 if (!_sourceFilesList.Any())
                 {
-                    Log.Error($"No source files were found in the PDB: {pdbPath}. If your PDB is native you should use the -a option.");
+                    Log.Error($"No source files were found in the PDB: {pdbPath}. If your PDB is native you could use the -a or -t option.");
                     return false;
                 }
 
@@ -282,17 +290,7 @@ private static List<string> GetSourceFilesFromDepot(string repositoryDirectory)
             {
                 sourceFiles = from file in Directory.GetFiles(repo.Info.WorkingDirectory, "*.*", SearchOption.AllDirectories)
                               where !repo.Ignore.IsPathIgnored(file)
-                              let ext = Path.GetExtension(file)
-                              where string.Equals(ext, ".cs", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".cpp", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".c", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".cc", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".cxx", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".c++", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".h", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".hh", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".inl", StringComparison.OrdinalIgnoreCase)
-                                 || string.Equals(ext, ".hpp", StringComparison.OrdinalIgnoreCase)
+                              where ValidExtension(file)
                               select file;
             }
 
@@ -364,5 +362,21 @@ private static string ReplaceSlashes(IProvider provider, string relativePathForU
 
             return relativePathForUrl;
         }
+
+        public static Boolean ValidExtension(string sourceFile)
+        {
+            var ext = Path.GetExtension(sourceFile);
+
+            return string.Equals(ext, ".cs", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".cpp", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".c", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".cc", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".cxx", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".c++", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".h", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".hh", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".inl", StringComparison.OrdinalIgnoreCase)
+                                 || string.Equals(ext, ".hpp", StringComparison.OrdinalIgnoreCase);
+        }
     }
 }