[include-fixer] Move cursor to #include line in vim after inserting a missing header.

[hokein]

Summary

A small improvement: Don't print newline character at the end of message, so that users don't have to
type ENTER manually after running the python script.

[bkramer]

I'm not entirely sure if jumping cursors are a good user interface. It will completely throw the user out of context, which is exactly what we want to avoid with include-fixer.

[klimek]

+1 to not throwing users around by default. Can we make it configurable if folks want it?

[hokein]

Add an option to make move-cursor configurable.

[hokein]

+Daniel who suggests this feature ;)

[djasper]

FWIW, I think I'd like this behavior as it shows me what is actually being done. I can undo/redo to double-check or C-O to get back to where I was. Of course making it configurable seems like the right thing to do.

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

102 ↗

(On Diff #64004)

Seems seems very hacky. Can't you extract it out of the diff sequence above?

[hokein]

Avoid a hacky way to get #include line number.

[bkramer]

lgtm now

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

maximum_suggested_headers = max(
       vim.eval('g:clang_include_fixer_maximum_suggested_headers'))
 
 increment_num = 5
 if vim.eval('exists("g:clang_include_fixer_increment_num")') == "1":
   increment_num = max(
       1,
       vim.eval('g:clang_include_fixer_increment_num'))
 
+jump_to_include = False
+if vim.eval('exists("g:clang_include_fixer_jump_to_include")') == "1":
+  jump_to_include = vim.eval('g:clang_include_fixer_jump_to_include') != "0"
+
 
 def GetUserSelection(message, headers, maximum_suggested_headers):
   eval_message = message + '\n'
   for idx, header in enumerate(headers[0:maximum_suggested_headers]):
     eval_message += "({0}). {1}\n".format(idx + 1, header)
   eval_message += "Enter (q) to quit;"
   if maximum_suggested_headers < len(headers):
     eval_message += " (m) to show {0} more candidates.".format(
p = subprocess.Popen(command,
                        stdin=subprocess.PIPE)
   return p.communicate(input=text)
 
 
 def InsertHeaderToVimBuffer(header, text):
   command = [binary, "-stdin", "-insert-header=" + json.dumps(header),
              vim.current.buffer.name]
   stdout, stderr = execute(command, text)
+  if stderr:
+    raise Exception(stderr)
   if stdout:
     lines = stdout.splitlines()
     sequence = difflib.SequenceMatcher(None, vim.current.buffer, lines)
+    line_num = None
     for op in reversed(sequence.get_opcodes()):
-      if op[0] is not 'equal':
+      if op[0] != 'equal':
         vim.current.buffer[op[1]:op[2]] = lines[op[3]:op[4]]
+      if op[0] == 'insert':
+        # line_num in vim is 1-based.
+        line_num = op[1] + 1
+
+    if jump_to_include and line_num:
+      vim.current.window.cursor = (line_num, 0)
 
 
 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='',
def main():
   seen = set()
   for header_info in header_infos:
     header = header_info["Header"]
     if header not in seen:
       seen.add(header)
       unique_headers.append(header)
 
   if not symbol:
-    print "The file is fine, no need to add a header.\n"
+    print "The file is fine, no need to add a header."
     return
 
   if not unique_headers:
-    print "Couldn't find a header for {0}.\n".format(symbol)
+    print "Couldn't find a header for {0}.".format(symbol)
     return
 
+  try:
     # If there is only one suggested header, insert it directly.
     if len(unique_headers) == 1 or maximum_suggested_headers == 1:
       InsertHeaderToVimBuffer({"SymbolIdentifier": symbol,
                                "Range": include_fixer_context["Range"],
                                "HeaderInfos": header_infos}, text)
-    print "Added #include {0} for {1}.\n".format(unique_headers[0], symbol)
+      print "Added #include {0} for {1}.".format(unique_headers[0], symbol)
       return
 
-  try:
     selected = GetUserSelection("choose a header file for {0}.".format(symbol),
                                 unique_headers, maximum_suggested_headers)
     selected_header_infos = [
       header for header in header_infos if header["Header"] == selected]
 
     # Insert a selected header.
     InsertHeaderToVimBuffer({"SymbolIdentifier": symbol,
                              "Range": include_fixer_context["Range"],
                              "HeaderInfos": selected_header_infos}, text)
-    print "Added #include {0} for {1}.\n".format(selected, symbol)
+    print "Added #include {0} for {1}.".format(selected, symbol)
   except Exception as error:
     print >> sys.stderr, error.message
   return
 
 
 if __name__ == '__main__':
   main()