gcov: add support for CMake-based projects and UI enhancement by abougouffa · Pull Request #53 · AdamNiederer/cov

abougouffa · 2022-12-31T19:50:55Z

For CMake projects, the .gcov files aren't stored beside the source file, instead, they are placed next to the generated object files (in CMake projects, it will be somewhere like path/to/build/dir/CMakeFiles/target.src/path/to/file/file.cpp.gcov)

Also, as CMake generates object files as file.cpp.o instead of file.o, gcov generates a file based on that file.cpp.gcov and not file.gcov.

I've added a function which leverages the information included in the compile_commands.json, it extracts the build directory and the build command for the file, and then constructs the path to the .gcov file which will be next to the .o file.

The second commit adds support for line highlighting with bright versions of cov-*-faces. This feature is configurable via cov-highlight-lines, I've set its initial value to nil.

Here are some examples:

cov-highlight-lines = t, cov-coverage-mode = t

cov-highlight-lines = t, cov-coverage-mode = nil

For CMake projects, the `.gcov` files aren't stored beside the source file, instead, they are placed next to the generated object files (in CMake projects, it will be somewhere like `path/to/build/dir/CMakeFiles/target.src/path/to/file/file.cpp.gcov`) Also, as CMake generates object files as `file.cpp.o` instead of `file.o`, gcov generates a file based on that `file.cpp.gcov` and not `file.gcov`. I've added a function which leverages the information included in the `compile_commands.json`, it extracts the build directory and build command for the file, and then constructs the path to the `.gcov` file which will be next to the `.o` file.

snogge · 2023-01-01T13:17:52Z

cov.el

+  (when-let* ((root (project-root (project-current)))
+              (compile-commands (expand-file-name "compile_commands.json" root)))
+    (when (file-exists-p compile-commands)
+      (when-let* ((file-cmd (cl-find-if


when-let* was introduced in Emacs 26 (as far as I can tell). cov.el supports Emacs 24.4 onward. Please use other means to do this.

Thanks for the feedback, I fixed this!

snogge · 2023-01-01T13:19:02Z

cov.el

+    (when (file-exists-p compile-commands)
+      (when-let* ((file-cmd (cl-find-if
+                             (lambda (entry)
+                               (equal (file-truename (alist-get 'file entry))


alist-getwas introduced in Emacs 25.1, cov.el supports from Emacs 24.4 onward.

Thanks for the feedback, I fixed this!

snogge

This comment is about the cmake-gcov commit.

I know very little about CMake and compile_commands.json, but the solution seems fragile.

I think compile_commands.json is optional for CMake?
Other systems also use compile_commands.json, and this might confuse cov.el in those cases. Or possible work better. I'm not sure.

There are no tests included in this commit, which I think is a must. It would be great if you could supply a test project like in test/lcov so we can see what the actual files look like. Also check if any of the docs in the README.md files needs to be updated.

Using something like compile_commands.json to locate the output files for build systems that splits source and object directories seems like a good thing. Is there no other information in the file that we can use?

I think this could be handled by correct values in cov-coverage-file-paths and possibly some other variable, but I can appreciate that this would probably require manual setup in every checkout of the project and that is not the most user friendly way of doing things.

snogge · 2023-01-01T13:35:05Z

cov.el

+                  (command (alist-get 'command file-cmd))
+                  (directory (alist-get 'directory file-cmd)))
+        (let* ((obj-file (when (string-match
+                                (concat "-o \\(?1:.*" (regexp-quote (concat file-name ".o")) "\\)")


This match looks fragile to me. What if there is no space between -o and the file name for instance?

Well spotted, I've changed it to " -o *"..., while accepting matches "file.cpp.o" and "file.o" for a "file.cpp". This is more generic than assuming object files will have the "file.cpp.o" format (which is correct for CMake, but not necessary valid for other build tools).

snogge · 2023-01-01T13:39:56Z

I think it would have made more sense to submit these as two separate PRs, but please do not close this PR if you decide to split it.

snogge · 2023-01-01T14:34:05Z

cov.el

  :type 'symbol)

+(defcustom cov-highlight-lines nil
+  "Hightlight lines."


Considering this is a customization option I think it should have much better documentation.

That's right!, I was a bit too exited to test the new overlays!

snogge

The highlight-line change needs tests and documentation.

abougouffa · 2023-01-01T16:48:27Z

Hello @snogge ,

Thank you for the reviews, I've fixed some of your spotted issues, mainly for the CMake+gcov stuff. I will try to fix documentation and tests issues later when I have some free time.

I will leave this PR for CMake+gcov stuff. So reverted the highlighting commit, I will open a separate PR for that.

This reverts commit 44c2f0b.

abougouffa · 2023-01-01T18:08:35Z

To respond to your comments, for the compile_commands.json file, it is indeed an optional output of CMake (can be enabled by passing -DCMAKE_EXPORT_COMPILE_COMMANDS=ON to cmake when configuring the project).

The file is generally generated in the build directory, so when configuring a CMake project with a command like this:

cmake -S . -B build/debug -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

The compile_commands.json will be generated under build/debug/compile_commands.json; however, the common workflow with CMake projects is to symlink this file in the project's root directory. This enables LSP servers to find the right build options for the project (enabled compiler features, system libraries, include paths, ...).

So I think it is Ok to assume the file is in the root directory, but if it is not, the cov--locate-gcov-cmake returns nil, so we can test other rules.

I've added a last check in the function to assure the generated .gcov file actually exists. This will help to avoid shadowing other functions in cov-coverage-file-paths with files that doesn't exist.

I will try later to add a toy example for a CMake based project to test the code, as well as mentioning this in the README file.

snogge · 2023-01-09T22:10:54Z

cov.el

+          (let* ((case-fold-search nil)
+                 (obj-file (when (string-match
+                                  (concat
+                                   " -o[ ]*\\(?1:.*"


I think you want \\s-* instead of [ ]*

snogge · 2023-01-09T22:12:50Z

cov.el

-	;; The buffer is _not_ automatically widened. It is possible to
-	;; read just a portion of the buffer by narrowing it first.
-	(let ((line-re (rx line-start
-					   ;; note the group numbers are in reverse order
-					   ;; in the first alternative
-					   (or (seq (* blank) (group-n 2 (+ (in digit ?#))) ?:
-								(* blank) (group-n 1 (+ digit)) ?:)
-						   (seq "lcount:" (group-n 1 (+ digit)) ?, (group-n 2 (+ digit))))))
-		  ;; Derive the name of the covered file from the filename of
-		  ;; the coverage file.
-		  (filename (file-name-sans-extension (f-filename cov-coverage-file))))
+    ;; The buffer is _not_ automatically widened. It is possible to
+    ;; read just a portion of the buffer by narrowing it first.
+    (let ((line-re (rx line-start
+                       ;; note the group numbers are in reverse order
+                       ;; in the first alternative
+                       (or (seq (* blank) (group-n 2 (+ (in digit ?#))) ?:
+                                (* blank) (group-n 1 (+ digit)) ?:)
+                           (seq "lcount:" (group-n 1 (+ digit)) ?, (group-n 2 (+ digit))))))
+          ;; Derive the name of the covered file from the filename of
+          ;; the coverage file.
+          (filename (file-name-sans-extension (f-filename cov-coverage-file))))


Please avoid whitespace only changes.

snogge · 2023-01-09T22:13:09Z

cov.el

-	  (save-excursion
-		(save-match-data
-		  (goto-char (point-min))
-		  (list (cons filename
-					  (cl-loop
-					   while (re-search-forward line-re nil t)
-					   collect (list (string-to-number (match-string 1))
-									 (string-to-number (match-string 2)))))))))))
+      (save-excursion
+        (save-match-data
+          (goto-char (point-min))
+          (list (cons filename
+                      (cl-loop
+                       while (re-search-forward line-re nil t)
+                       collect (list (string-to-number (match-string 1))
+                                     (string-to-number (match-string 2)))))))))))


Please avoid whitespace only changes.

abougouffa added 2 commits December 31, 2022 20:49

Add an option to highlight line background

44c2f0b

abougouffa changed the title ~~gcov: add support for CMake-based projects~~ gcov: add support for CMake-based projects and UI enhancement Dec 31, 2022

snogge reviewed Jan 1, 2023

View reviewed changes

abougouffa force-pushed the feat/gcov-cmake branch 2 times, most recently from a1fed23 to b3447f9 Compare January 1, 2023 16:25

Ensure compatibility with Emacs 24.4+, better match for object files

f9b4c7b

abougouffa force-pushed the feat/gcov-cmake branch from b3447f9 to f9b4c7b Compare January 1, 2023 16:47

Revert "Add an option to highlight line background"

933e3d1

This reverts commit 44c2f0b.

snogge reviewed Jan 9, 2023

View reviewed changes

Conversation

abougouffa commented Dec 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snogge left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abougouffa Jan 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snogge commented Jan 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snogge left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abougouffa commented Jan 1, 2023

Uh oh!

abougouffa commented Jan 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abougouffa commented Dec 31, 2022 •

edited

Loading

snogge left a comment •

edited

Loading

abougouffa Jan 1, 2023 •

edited

Loading

snogge left a comment •

edited

Loading