[clang-format-vs] Fix sort include main include: Use current path for the '-assume-filename'

[jeanphilippeD]

Summary

clang-format sort include use the source file name to determine the "main include" that will be the 1st include (category 0).
Because the clang-format visual studio extension does not pass the file name and use the standard input, sort include cannot find a "main include":

Testing fix on llvm\tools\clang\lib\Format\Format.cpp:
Original file:
#include "clang/Format/Format.h"
...
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Lexer.h"

Without fix, selecting the includes and running visual studio clang-format:
...
#include "clang/Basic/SourceManager.h"
#include "clang/Format/Format.h"
#include "clang/Lex/Lexer.h"

With fix, selecting the includes and running visual studio clang-format:
#include "clang/Format/Format.h"
...
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Lexer.h"

Test 2 with main header not at the start:
Original file:
...
#include "clang/Format/Format.h"
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Lexer.h"

Without fix, selecting the includes and running visual studio clang-format:
...
#include "clang/Basic/SourceManager.h"
#include "clang/Format/Format.h"
#include "clang/Lex/Lexer.h"

With fix, selecting the includes and running visual studio clang-format:
#include "clang/Format/Format.h"
...
#include "clang/Basic/SourceManager.h"
#include "clang/Lex/Lexer.h"

Caveat: My setup is not ideal for test (Visual studio 2015 only), and I am not familiar with visual studio extension development, but I think the changes are straight forward enough.
I've tested this fix building it and running it on Visual Studio 2015, but I do not think there would be any compatibility issue since I am using API that are already used in the GetDocumentParent function.

[jeanphilippeD]

Ping,

Hi Daniel,

Sorry, should I have put someone else as reviewer, I see the previous committers for this file where Manuel Klimek, Hans Wennborg and Marek Kurdej.
Should have i added any or all of them.

I thought it made sense to put you originally since you updated the code for sort include in clang-format.

Kind Regards,
Jean-Philippe.

[klimek]

lg

[jeanphilippeD]

Hi Manuel,

Thank you very much for the review.
I do not have commit access, would you be able to commit this patch for me.

Kind Regards,
Jean-Philippe

[djasper]

Submitted as r260378.

tools/clang-format-vs/ClangFormat/ClangFormatPackage.cs

public sealed class ClangFormatPackage : Package
             int start = view.Selection.Start.Position.GetContainingLine().Start.Position;
             int end = view.Selection.End.Position.GetContainingLine().End.Position;
             int length = end - start;
             // clang-format doesn't support formatting a range that starts at the end
             // of the file.
             if (start >= text.Length && text.Length > 0)
                 start = text.Length - 1;
             string path = GetDocumentParent(view);
+            string filePath = GetDocumentPath(view);
             try
             {
-                var root = XElement.Parse(RunClangFormat(text, start, length, path));
+                var root = XElement.Parse(RunClangFormat(text, start, length, path, filePath));
                 var edit = view.TextBuffer.CreateEdit();
                 foreach (XElement replacement in root.Descendants("replacement"))
                 {
                     var span = new Span(
                         int.Parse(replacement.Attribute("offset").Value),
                         int.Parse(replacement.Attribute("length").Value));
                     edit.Replace(span, replacement.Value);
                 }
public sealed class ClangFormatPackage : Package
             }
         }
 
         /// <summary>
         /// Runs the given text through clang-format and returns the replacements as XML.
         /// 
         /// Formats the text range starting at offset of the given length.
         /// </summary>
-        private string RunClangFormat(string text, int offset, int length, string path)
+        private string RunClangFormat(string text, int offset, int length, string path, string filePath)
         {
             string vsixPath = Path.GetDirectoryName(
                 typeof(ClangFormatPackage).Assembly.Location);
 
             System.Diagnostics.Process process = new System.Diagnostics.Process();
             process.StartInfo.UseShellExecute = false;
             process.StartInfo.FileName = vsixPath + "\\clang-format.exe";
             // Poor man's escaping - this will not work when quotes are already escaped
             // in the input (but we don't need more).
             string style = GetStyle().Replace("\"", "\\\"");
             string fallbackStyle = GetFallbackStyle().Replace("\"", "\\\"");
             process.StartInfo.Arguments = " -offset " + offset +
                                           " -length " + length +
                                           " -output-replacements-xml " +
                                           " -style \"" + style + "\"" +
                                           " -fallback-style \"" + fallbackStyle + "\"";
             if (GetSortIncludes())
               process.StartInfo.Arguments += " -sort-includes ";
             string assumeFilename = GetAssumeFilename();
+            if (string.IsNullOrEmpty(assumeFilename))
+                assumeFilename = filePath;
             if (!string.IsNullOrEmpty(assumeFilename))
               process.StartInfo.Arguments += " -assume-filename \"" + assumeFilename + "\"";
             process.StartInfo.CreateNoWindow = true;
             process.StartInfo.RedirectStandardInput = true;
             process.StartInfo.RedirectStandardOutput = true;
             process.StartInfo.RedirectStandardError = true;
             if (path != null)
                 process.StartInfo.WorkingDirectory = path;
public sealed class ClangFormatPackage : Package
         {
             ITextDocument document;
             if (view.TextBuffer.Properties.TryGetProperty(typeof(ITextDocument), out document))
             {
                 return Directory.GetParent(document.FilePath).ToString();
             }
             return null;
         }
+
+        private string GetDocumentPath(IWpfTextView view)
+        {
+            ITextDocument document;
+            if (view.TextBuffer.Properties.TryGetProperty(typeof(ITextDocument), out document))
+            {
+                return document.FilePath;
+            }
+            return null;
+        }
     }
 }