[clang-include-fixer] Added Vim integration for clang-include-fixer.

[ioeric]

Summary

[clang-include-fixer] Added Vim integration for clang-include-fixer.

[bkramer]

include-fixer/tool/ClangIncludeFixer.cpp

51 ↗

(On Diff #57474)

This isn't really specific to vim, we should name it differently. '-stdin' maybe? Then document what it really does.

include-fixer/tool/clang-include-fixer.py

38 ↗

(On Diff #57474)

yaml is the default, maybe we shouldn't specify it here? Or leave the user a way to configure it.

49 ↗

(On Diff #57474)

This always inserts at the top. Can we emit the position where to insert from the tool and put it there?

[hokein]

include-fixer/tool/ClangIncludeFixer.cpp

51 ↗

(On Diff #57474)

I think we can make the include-fixer accept stdin input by default if there is no command-line file path. In this case, there is no need to add a command-line option here.

include-fixer/tool/clang-include-fixer.py

50 ↗

(On Diff #57474)

Add if __name__ == '__main__':.

[ioeric]

• Changed VimMode to STDINMode, and made clang-include-fixer return insertion line number in this mode.
• Added -db, -input options into Vim integration.

include-fixer/tool/ClangIncludeFixer.cpp

51 ↗

(On Diff #57474)

We can't get the compile options for the code if we only accept <stdin> input (without the corresponding file path).

[bkramer]

I expect the insertion code in the python part to cause trouble in the future again but I guess this is fine for now.

Can you add a section to include-fixer.rst on how to set this up?

[ioeric]

• Added docs for Vim integration into include-fixer.rst.

[bkramer]

lg

clang-tools-extra/trunk/docs/include-fixer.rst

.. code-block:: console
   $ path/to/llvm/source/tools/clang/tools/extra/include-fixer/find-all-symbols/tool/run-find-all-symbols.py
     ... wait as clang indexes the code base ...
   $ ln -s $PWD/find_all_symbols_db.yaml path/to/llvm/source/ # Link database into the source tree.
   $ ln -s $PWD/compile_commands.json path/to/llvm/source/ # Also link compilation database if it's not there already.
   $ cd path/to/llvm/source
   $ clang-include-fixer -db=yaml path/to/file/with/missing/include.cpp
     Added #include "foo.h"
 
+Integrate with Vim
+-------------------
+To run `clang-include-fixer` on a potentially unsaved buffer in Vim. Add the
+following key binding to your ``.vimrc``:
+
+.. code-block:: console
+
+  map ,cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
+
+This enables `clang-include-fixer` for NORMAL and VISUAL mode. Change ``,cf`` to
+another binding if you need clang-include-fixer on a different key.
+
+See ``clang-include-fixer.py`` for more details.
+
 How it Works
 ============
 
 To get the most information out of clang at parse time,
 :program:`clang-include-fixer` runs in tandem with the parse and receives
 callbacks from Clang's semantic analysis. In particular it reuses the existing
 support for typo corrections. Whenever Clang tries to correct a potential typo
 it emits a callback to the include fixer which then looks for a corresponding

clang-tools-extra/trunk/include-fixer/tool/ClangIncludeFixer.cpp

 cl::opt<bool>
     MinimizeIncludePaths("minimize-paths",
                          cl::desc("Whether to minimize added include paths"),
                          cl::init(true), cl::cat(IncludeFixerCategory));
 
 cl::opt<bool> Quiet("q", cl::desc("Reduce terminal output"), cl::init(false),
                     cl::cat(IncludeFixerCategory));
 
+cl::opt<bool>
+    STDINMode("stdin",
+              cl::desc("Override source file's content (in the overlaying\n"
+                       "virtual file system) with input from <stdin> and run\n"
+                       "the tool on the new content with the compilation\n"
+                       "options of the source file. This mode is currently\n"
+                       "used for editor integration."),
+              cl::init(false), cl::cat(IncludeFixerCategory));
+
 int includeFixerMain(int argc, const char **argv) {
   tooling::CommonOptionsParser options(argc, argv, IncludeFixerCategory);
   tooling::ClangTool tool(options.getCompilations(),
                           options.getSourcePathList());
 
+  // In STDINMode, we override the file content with the <stdin> input.
+  // Since `tool.mapVirtualFile` takes `StringRef`, we define `Code` outside of
+  // the if-block so that `Code` is not released after the if-block.
+  std::unique_ptr<llvm::MemoryBuffer> Code;
+  if (STDINMode) {
+    assert(options.getSourcePathList().size() == 1 &&
+           "Expect exactly one file path in STDINMode.");
+    llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> CodeOrErr =
+        MemoryBuffer::getSTDIN();
+    if (std::error_code EC = CodeOrErr.getError()) {
+      errs() << EC.message() << "\n";
+      return 1;
+    }
+    Code = std::move(CodeOrErr.get());
+    if (Code->getBufferSize() == 0)
+      return 0;  // Skip empty files.
+
+    tool.mapVirtualFile(options.getSourcePathList().front(), Code->getBuffer());
+  }
+
   // Set up data source.
   auto SymbolIndexMgr = llvm::make_unique<include_fixer::SymbolIndexManager>();
   switch (DatabaseFormat) {
   case fixed: {
     // Parse input and fill the database with it.
     // <symbol>=<header><, header...>
     // Multiple symbols can be given, separated by semicolons.
     std::map<std::string, std::vector<std::string>> SymbolsMap;
int includeFixerMain(int argc, const char **argv) {
 
   // Set up a new source manager for applying the resulting replacements.
   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions);
   DiagnosticsEngine Diagnostics(new DiagnosticIDs, &*DiagOpts);
   TextDiagnosticPrinter DiagnosticPrinter(outs(), &*DiagOpts);
   SourceManager SM(Diagnostics, tool.getFiles());
   Diagnostics.setClient(&DiagnosticPrinter, false);
 
+  if (STDINMode) {
+    for (const tooling::Replacement &Replacement : Replacements) {
+      FileID ID = SM.getMainFileID();
+      unsigned LineNum = SM.getLineNumber(ID, Replacement.getOffset());
+      llvm::outs() << LineNum << "," << Replacement.getReplacementText();
+    }
+    return 0;
+  }
+
   // Write replacements to disk.
   Rewriter Rewrites(SM, LangOptions());
   tooling::applyAllReplacements(Replacements, Rewrites);
   return Rewrites.overwriteChangedFiles();
 }
 
 } // namespace
 
 int main(int argc, const char **argv) {
   return includeFixerMain(argc, argv);
 }

clang-tools-extra/trunk/include-fixer/tool/clang-include-fixer.py

+# This file is a minimal clang-include-fixer vim-integration. To install:
+# - Change 'binary' if clang-include-fixer is not on the path (see below).
+# - Add to your .vimrc:
+#
+#   map ,cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
+#
+# This enables clang-include-fixer for NORMAL and VISUAL mode. Change ",cf" to
+# another binding if you need clang-include-fixer on a different key.
+#
+# To set up clang-include-fixer, see http://clang.llvm.org/extra/include-fixer.html
+#
+# With this integration you can press the bound key and clang-include-fixer will
+# be run on the current buffer.
+#
+# It operates on the current, potentially unsaved buffer and does not create
+# or save any files. To revert a fix, just undo.
+
+import argparse
+import subprocess
+import sys
+import vim
+
+# set g:clang_include_fixer_path to the path to clang-include-fixer if it is not
+# on the path.
+# Change this to the full path if clang-include-fixer is not on the path.
+binary = 'clang-include-fixer'
+if vim.eval('exists("g:clang_include_fixer_path")') == "1":
+  binary = vim.eval('g:clang_include_fixer_path')
+
+def main():
+  parser = argparse.ArgumentParser(
+      description='Vim integration for clang-include-fixer')
+  parser.add_argument('-db', default='yaml',
+                      help='clang-include-fixer input format.')
+  parser.add_argument('-input', default='',
+                      help='String to initialize the database.')
+  args = parser.parse_args()
+
+  # Get the current text.
+  buf = vim.current.buffer
+  text = '\n'.join(buf)
+
+  # Call clang-include-fixer.
+  command = [binary, "-stdin", "-db="+args.db, "-input="+args.input,
+             vim.current.buffer.name]
+  p = subprocess.Popen(command,
+                       stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+                       stdin=subprocess.PIPE)
+  stdout, stderr = p.communicate(input=text)
+
+  # If successful, replace buffer contents.
+  if stderr:
+    print stderr
+
+  if stdout:
+    lines = stdout.splitlines()
+    for line in lines:
+      line_num, text = line.split(",")
+      # clang-include-fixer provides 1-based line number
+      line_num = int(line_num) - 1
+      print 'Inserting "{0}" at line {1}'.format(text, line_num)
+      vim.current.buffer[line_num:line_num] = [text]
+
+if __name__ == '__main__':
+  main()