[include-fixer] try to make vim header selection more friendly.

[ioeric]

Summary

use 'input()' to get user's input so that we can support more options.

[hokein]

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

53 ↗

(On Diff #59707)

We can handle the , a, q cases after res=vim.eval(to_eval) instead of handling them in exception block. They don't look like errors in my opinion.

132 ↗

(On Diff #59707)

For error message, it might be better to print to stderr print >> sys.stderr, error.message?

[ioeric]

• Addressed reviewer's comments.

[bkramer]

Nice! Can we somehow make the user not press enter after putting in the number? getchar() maybe?

[ioeric]

• fixed a bug with index.

[ioeric]

As per our offline discussion, getchar() does not work with options with more than 2 digits (e.g. index number > 9). I'll keep it as it is now until we come up with a better solution.

[bkramer]

lg then.

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

 
 maximum_suggested_headers=3
 if vim.eval('exists("g:clang_include_fixer_maximum_suggested_headers")') == "1":
   maximum_suggested_headers = max(
       1,
       vim.eval('g:clang_include_fixer_maximum_suggested_headers'))
 
 
-def ShowDialog(message, choices, default_choice_index=0):
-  to_eval = "confirm('{0}', '{1}', '{2}')".format(message,
-                                                  choices.strip(),
-                                                  default_choice_index)
-  return int(vim.eval(to_eval));
-
+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 += " (a) to show all candidates.";
+  eval_message += "\nSelect (default 1): "
+  res = vim.eval("input('{0}')".format(eval_message))
+  if res == '':
+    # choose the top ranked header by default
+    idx = 1
+  elif res == 'q':
+    raise Exception('   Insertion cancelled...')
+  elif res == 'a' and maximum_suggested_headers < len(headers):
+    return GetUserSelection(message, headers, len(headers))
+  else:
+    try:
+      idx = int(res)
+      if idx <= 0 or idx > len(headers):
+        raise Exception()
+    except Exception:
+        raise Exception('   ERROR: Invalid option "{0}"...Abort!'.format(res))
+  return headers[idx-1]
 
 def execute(command, text):
   p = subprocess.Popen(command,
                        stdout=subprocess.PIPE, stderr=subprocess.PIPE,
                        stdin=subprocess.PIPE)
   return p.communicate(input=text)
 
 
if stderr:
     return
 
   include_fixer_context = json.loads(stdout)
   symbol = include_fixer_context["SymbolIdentifier"]
   headers = include_fixer_context["Headers"]
 
   if not symbol:
     print "The file is fine, no need to add a header.\n"
-    return;
+    return
 
   if not headers:
     print "Couldn't find a header for {0}.\n".format(symbol)
     return
 
   # The first line is the symbol name.
   # If there is only one suggested header, insert it directly.
   if len(headers) == 1 or maximum_suggested_headers == 1:
     InsertHeaderToVimBuffer({"SymbolIdentifier": symbol,
                              "Headers":[headers[0]]}, text)
     print "Added #include {0} for {1}.\n".format(headers[0], symbol)
     return
 
-  choices_message = ""
-  index = 1;
-  for header in headers[0:maximum_suggested_headers]:
-    choices_message += "&{0} {1}\n".format(index, header)
-    index += 1
-
-  select = ShowDialog("choose a header file for {0}.".format(symbol),
-                      choices_message)
+  try:
+    selected = GetUserSelection("choose a header file for {0}.".format(symbol),
+                                headers, maximum_suggested_headers)
     # Insert a selected header.
     InsertHeaderToVimBuffer({"SymbolIdentifier": symbol,
-                           "Headers":[headers[select-1]]}, text)
-  print "Added #include {0} for {1}.\n".format(headers[select-1], symbol)
-  return;
+                             "Headers":[selected]}, text)
+    print "Added #include {0} for {1}.\n".format(selected, symbol)
+  except Exception as error:
+    print >> sys.stderr, error.message
+  return
 
 
 if __name__ == '__main__':
   main()