Completion-related fixes for clang-include-fixer.el

[tmarek]

Summary

1. Quitting inside a process sentinel is not allowed, but the sentinel invokes completion, where the user is free to hit C-g. By wrapping the call in with-local-quit, the process sentinel invocation can finish without triggering an error
2. Invoke completing-read instead of ido-completing-read, since this may interfere with user customizations to completing-read-function. The user should use something like ido-ubiquitous if ido completion is wanted
3. Compare the string returned from completion with string=, since it may be a copy of the original string in the collection

[klimek]

lg

[klimek]

Thanks. Landed in r295818

tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.el

(let ((context (clang-include-fixer--parse-json stdout)))
     (let-alist context
       (cond
        ((null .QuerySymbolInfos)
         (message "The file is fine, no need to add a header."))
        ((null .HeaderInfos)
         (message "Couldn't find header for '%s'"
                  (let-alist (car .QuerySymbolInfos) .RawIdentifier)))
        (t
+        ;; Users may C-g in prompts, make sure the process sentinel
+        ;; behaves correctly.
+        (with-local-quit
           ;; Replace the HeaderInfos list by a single header selected by
           ;; the user.
           (clang-include-fixer--select-header context)
           ;; Call clang-include-fixer again to insert the selected header.
           (clang-include-fixer--start
            (let ((old-tick (buffer-chars-modified-tick)))
              (lambda (stdout)
                (when (/= old-tick (buffer-chars-modified-tick))
                  ;; Replacing the buffer now would undo the user’s changes.
                  (user-error (concat "The buffer has been changed "
                                      "before the header could be inserted")))
                (clang-include-fixer--replace-buffer stdout)
                (let-alist context
                  (let-alist (car .HeaderInfos)
                    (run-hook-with-args 'clang-include-fixer-add-include-hook
                                        (substring .Header 1 -1)
                                        (string= (substring .Header 0 1) "<"))))))
            (format "-insert-header=%s"
-                 (clang-include-fixer--encode-json context)))))))
+                   (clang-include-fixer--encode-json context))))))))
   nil)
 
 (defun clang-include-fixer--select-header (context)
   "Prompt the user for a header if necessary.
 CONTEXT must be a clang-include-fixer context object in
 association list format.  If it contains more than one HeaderInfo
 element, prompt the user to select one of the headers.  CONTEXT
 is modified to include only the selected element."
(let ((symbol (clang-include-fixer--symbol-name .QuerySymbolInfos))
           (overlays (mapcar #'clang-include-fixer--highlight .QuerySymbolInfos)))
       (unwind-protect
           (save-excursion
             ;; While prompting, go to the closest overlay so that the user sees
             ;; some context.
             (goto-char (clang-include-fixer--closest-overlay overlays))
             (cl-flet ((header (info) (let-alist info .Header)))
               ;; The header-infos is already sorted by include-fixer.
-              (let* ((header (ido-completing-read
+              (let* ((header (completing-read
                               (clang-include-fixer--format-message
                                "Select include for '%s': " symbol)
                               (mapcar #'header .HeaderInfos)
                               nil :require-match nil
                               'clang-include-fixer--history))
-                     (info (cl-find header .HeaderInfos :key #'header)))
+                     (info (cl-find header .HeaderInfos :key #'header :test #'string=)))
                 (cl-assert info)
                 (setcar .HeaderInfos info)
                 (setcdr .HeaderInfos nil))))
         (mapc #'delete-overlay overlays)))))
 
 (defun clang-include-fixer--symbol-name (symbol-infos)
   "Return the unique symbol name in SYMBOL-INFOS.
 Raise a signal if the symbol name is not unique."