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

[massberg]

Summary

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

[hokein]

Nice! Thanks very much for making emacs integration. I'm not familiar with elisp, but it looks almost good to me. Just a few nits.

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

8 ↗

(On Diff #65504)

s/envoke/invoke

12 ↗

(On Diff #65504)

Could you add some documents describing how to setup the environment in emacs in docs/include-fixer.rst?

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

• Fixed typo
• Added documentation how to setup tools within emacs
• Removed unnecessary yes-no question

[bkramer]

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

8 ↗

(On Diff #65521)

clnag is another typo

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

-Fixed documentation

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

• Fixed typo

[massberg]

Thanks for the comments. I fixed the typos and wrote a (short) documentation.

[hokein]

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

126 ↗

(On Diff #65525)

Looks like you are using an old-version of clang-include-fixer. It won't work with latest version. The latest clang-include-fixer changes this interfaces for supporting adding qualifiers for all instances of an unidentified symbol. So please update to use the latest version.

You can refer to the change of "tool/clang-include-fixer.py" in https://reviews.llvm.org/D22567.

PS. The "-output-header" option is changed from

{
   "SymbolIdentifier": "foo",
   "Range": {"Offset":0, "Length": 3},
   "HeaderInfos": [ {"Header": "\"foo_a.h\"",
                               "QualifiedName": "a::foo"} ]
}

to

{
   "QuerySymbolInfos": [
      {"RawIdentifier": "foo",
       "Range": {"Offset": 0, "Length": 3}}
   ],
    "HeaderInfos": [ {"Header": "\"foo_a.h\"",
                               "QualifiedName": "a::foo"} ]
}

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

Now working with the newest clang-include-fixer input/output format.

[massberg]

Thanks, now supporting the new format.

[hokein]

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

32 ↗

(On Diff #65546)

You forgot to remove the private path here.

124 ↗

(On Diff #65546)

Is it a debug statement?

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

• fixed private path
• removed debug message

[massberg]

Thanks for the comments!

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

125 ↗

(On Diff #65562)

You are right, removed.

[hokein]

It looks good to me now, a few comments. Let's wait to see whether @bkramer has any further comments.

docs/include-fixer.rst

81 ↗

(On Diff #65562)

s/diretory/directory

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

23 ↗

(On Diff #65562)

I might be wrong, I think it is missing a " at the end?

51 ↗

(On Diff #65562)

code indentation.

[massberg]

Updating D22805: [clang-include-fixer] Added Emacs integration for clang-include-fixer.

• Corrected typos and code indentation.

[massberg]

Thanks for the comments!

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

24 ↗

(On Diff #65679)

The ending " is two lines below.

[bkramer]

Looks good from my side.

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

 - Add the path to :program:`clang-include-fixer` to the PATH environment variable.
 - Or set ``g:clang_include_fixer_path`` in vimrc: ``let g:clang_include_fixer_path=path/to/clang-include-fixer``
 
 You can customize the number of headers being shown by setting
 ``let g:clang_include_fixer_maximum_suggested_headers=5``
 
 See ``clang-include-fixer.py`` for more details.
 
+Integrate with Emacs
+--------------------
+To run `clang-include-fixer` on a potentially unsaved buffer in Emacs.
+Ensure that Emacs finds ``clang-include-fixer.el`` by adding the directory containing the file to the ``load-path``
+and requiring the `clang-include-fixer` in your ```.emacs``:
+
+.. code-block:: console
+
+ (add-to-list 'load-path "path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/"
+ (require 'clang-include-fixer)
+
+Within Emacs the tool can be invoked with the command ``M-x clang-include-fixer``.
+
+Make sure Emacs can find :program:`clang-include-fixer`:
+
+- Add the path to :program:`clang-include-fixer` to the PATH environment variable.
+
+See ``clang-include-fixer.el`` 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/clang-include-fixer.el

+;;; clang-include-fxier.el --- Emacs integration of the clang include fixer
+
+;; Keywords: tools, c
+;; Package-Requires: ((json "1.2"))
+
+;;; Commentary:
+
+;; This package allows to invoke the 'clang-include-fixer' within Emacs.
+;; 'clang-include-fixer' provides an automated way of adding #include
+;; directives for missing symbols in one translation unit, see
+;; <http://clang.llvm.org/extra/include-fixer.html>.
+
+;;; Code:
+
+(require 'json)
+
+(defgroup clang-include-fixer nil
+  "Include fixer."
+  :group 'tools)
+
+(defcustom clang-include-fixer-executable
+  "clang-include-fixer"
+  "Location of the `clang-include-fixer' executable.
+
+   A string containing the name or the full path of the executable."
+  :group 'clang-include-fixer
+  :type 'string
+  :risky t)
+
+(defcustom clang-include-fixer-input-format
+  "yaml"
+  "clang-include-fixer input format."
+  :group 'clang-include-fixer
+  :type 'string
+  :risky t)
+
+(defcustom clang-include-fixer-init-string
+  ""
+  "clang-include-fixer input format."
+  :group 'clang-include-fixer
+  :type 'string
+  :risky t)
+
+
+(defun clang-include-fixer-call-executable (callee
+                                            include-fixer-parameter-a
+                                            &optional include-fixer-parameter-b
+                                            &optional include-fixer-parameter-c
+                                            )
+  "Calls clang-include-fixer with parameters INCLUDE-FIXER-PARAMETER-[ABC].
+   If the call was successful the returned result is stored in a temp buffer
+   and the function CALLEE is called on this temp buffer."
+
+    (let ((temp-buffer (generate-new-buffer " *clang-include-fixer-temp*"))
+          (temp-file (make-temp-file "clang-include-fixer")))
+      (unwind-protect
+          (let (status stderr operations)
+            (if (eq include-fixer-parameter-c nil)
+                (setq status
+                      (call-process-region
+                       (point-min) (point-max) clang-include-fixer-executable
+                       nil `(,temp-buffer ,temp-file) nil
+
+                       "-stdin"
+                       include-fixer-parameter-a
+                       (buffer-file-name)
+                       ))
+              (setq status
+                    (call-process-region
+                     (point-min) (point-max) clang-include-fixer-executable
+                     nil `(,temp-buffer ,temp-file) nil
+
+                     "-stdin"
+                     include-fixer-parameter-a
+                     include-fixer-parameter-b
+                     include-fixer-parameter-c
+                     (buffer-file-name)
+                     )))
+
+            (setq stderr
+                  (with-temp-buffer
+                    (insert-file-contents temp-file)
+                    (when (> (point-max) (point-min))
+                      (insert ": "))
+                    (buffer-substring-no-properties
+                     (point-min) (line-end-position))))
+
+            (cond
+             ((stringp status)
+              (error "(clang-include-fixer killed by signal %s%s)" status
+                     stderr))
+             ((not (equal 0 status))
+              (error "(clang-include-fixer failed with code %d%s)" status
+                     stderr)))
+            (funcall callee temp-buffer))
+        (delete-file temp-file)
+        (when (buffer-name temp-buffer) (kill-buffer temp-buffer)))))
+
+
+(defun clang-include-fixer-replace_buffer (temp-buffer)
+  "Replace current buffer by content of TEMP-BUFFER"
+
+  (with-current-buffer temp-buffer
+    (setq temp-start (point-min))
+    (setq temp-end (point-max))
+    )
+  (barf-if-buffer-read-only)
+  (erase-buffer)
+  (save-excursion
+    (insert-buffer-substring temp-buffer temp-start temp-end)))
+
+
+(defun clang-include-fixer-add-header (temp-buffer)
+  "Analyse the result of include-fixer stored in TEMP_BUFFER and add a
+   missing header if there is any. If there are multiple possible headers
+   the user can select one of them to be included."
+
+  (with-current-buffer temp-buffer
+    (setq result (buffer-substring (point-min) (point-max)))
+    (setq include-fixer-context
+          (let ((json-object-type 'plist))
+            (json-read-from-string result))))
+
+  ;; The header-infos is already sorted by include-fixer.
+  (setq header-infos (plist-get include-fixer-context :HeaderInfos))
+  (setq query-symbol-infos (plist-get include-fixer-context :QuerySymbolInfos))
+
+  (if (eq 0 (length query-symbol-infos))
+      (message "The file is fine, no need to add a header.")
+
+    (setq symbol-info (elt query-symbol-infos 0))
+    (setq symbol (plist-get symbol-info :RawIdentifier))
+    (setq symbol-offset (plist-get (plist-get symbol-info :Range)
+                                   :Offset))
+
+    ;; Check the number of choices
+    (if (eq 0 (length header-infos))
+  (progn
+    (goto-char (1+ symbol-offset))
+    (message (concat "Couldn't find header for '" symbol "'.")))
+
+      (setq symbol-length (plist-get (plist-get symbol-info :Range)
+             :Length))
+      (goto-char (1+ symbol-offset))
+      (setq symbol-overlay (make-overlay (1+ symbol-offset)
+           (+ symbol-offset symbol-length +1)))
+      (overlay-put symbol-overlay 'face '(:background "green" :foreground
+                  "black"))
+
+      (message (number-to-string symbol-offset))
+      (message (number-to-string symbol-length))
+
+      (if (eq 1 (length header-infos))
+    (progn
+      (setq missing-header
+      (plist-get (elt header-infos 0) :Header))
+      (message (concat "Only one include is missing: "
+           missing-header )))
+
+  ;; Now iterate over vector and add items to list
+  (setq include-list '())
+  (setq index 0)
+  (while (< index (length header-infos))
+    (setq entry (elt header-infos index))
+    (add-to-list 'include-list  (plist-get entry :Header))
+    (setq index (1+ index))
+    )
+
+  (setq option-message (concat "Select include for '"
+             symbol
+             "' :"))
+  (setq missing-header (ido-completing-read
+                              option-message include-list)))
+
+      ;; Now select set correct header info.
+      (setq header-plist '())
+      (setq index 0)
+      (while (< index (length header-infos))
+  (setq entry (elt header-infos index))
+  (setq index (1+ index))
+  (if (eq (plist-get entry :Header) missing-header)
+      (setq header-plist entry)))
+      (setq include-fixer-context (plist-put
+           include-fixer-context
+           ':HeaderInfos (vector header-plist)))
+
+      (clang-include-fixer-call-executable
+       'clang-include-fixer-replace_buffer
+       (concat "-insert-header=" (json-encode include-fixer-context)))
+      (delete-overlay symbol-overlay))))
+
+
+(defun clang-include-fixer ()
+  "Invokes the Include Fixer to insert missing C++ headers."
+  (interactive)
+
+  (message (concat "Calling the include fixer. "
+           "This might take some seconds. Please wait."))
+
+  (clang-include-fixer-call-executable
+   'clang-include-fixer-add-header
+   (concat "-db=" clang-include-fixer-input-format)
+   (concat "-input=" clang-include-fixer-init-string)
+   "-output-headers"))
+
+(provide 'clang-include-fixer)
+;;; clang-include-fixer.el ends here