Add linked Html function outline (#515)

Co-authored-by: Lukas Atkinson <opensource@LukasAtkinson.de>
gcovr · Dec 29, 2021 · dd0dc02 · dd0dc02
1 parent 493095b
commit dd0dc02
Show file tree

Hide file tree

Showing 539 changed files with 15,753 additions and 693 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -15,6 +15,7 @@ Improvements and new features:
 - Don't use a temporary directory for running gcov (:issue:`525`)
 - Fix junctions on windows for Python 3.8 (:issue:`535`)
 - Can create reproducible reports with the :option:`--timestamp` option (:issue:`546`)
+- Add "Goto function" in html details. (:issue:`515`)
 
 Documentation:
 

diff --git a/doc/examples/example_html.details.css b/doc/examples/example_html.details.css
@@ -372,6 +372,31 @@ pre
     margin-bottom: 0;
 }
 
+.listOfFunctions td, .listOfFunctions th {
+    padding: 0 10px;
+}
+.listOfFunctions th
+{
+    text-align: center;
+    color: white;
+    background-color: SteelBlue;
+}
+.listOfFunctions tr > td {
+    background: aliceblue;
+}
+.listOfFunctions tr:nth-child(even) > td {
+    background: LightSteelBlue
+}
+.listOfFunctions tr:hover > td
+{
+    background-color: #ddd;
+}
+.listOfFunctions tr > td > a
+{
+    text-decoration: none;
+    color: inherit;
+}
+
 .source-line
 {
     height : 15px;

diff --git a/doc/examples/example_html.details.example.cpp.9597a7a3397b8e3a48116e2a3afb4154.html b/doc/examples/example_html.details.example.cpp.9597a7a3397b8e3a48116e2a3afb4154.html
@@ -62,6 +62,39 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l3">foo(int)</a>
+      </td>
+      <td>
+        <a href="#l3">3</a>
+      </td>
+      <td>
+        <a href="#l3"> called 1 time</a>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l15">main</a>
+      </td>
+      <td>
+        <a href="#l15">15</a>
+      </td>
+      <td>
+        <a href="#l15"> called 1 time</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>

diff --git a/doc/examples/example_html.html b/doc/examples/example_html.html
@@ -380,6 +380,31 @@
     margin-bottom: 0;
 }
 
+.listOfFunctions td, .listOfFunctions th {
+    padding: 0 10px;
+}
+.listOfFunctions th
+{
+    text-align: center;
+    color: white;
+    background-color: SteelBlue;
+}
+.listOfFunctions tr > td {
+    background: aliceblue;
+}
+.listOfFunctions tr:nth-child(even) > td {
+    background: LightSteelBlue
+}
+.listOfFunctions tr:hover > td
+{
+    background-color: #ddd;
+}
+.listOfFunctions tr > td > a
+{
+    text-decoration: none;
+    color: inherit;
+}
+
 .source-line
 {
     height : 15px;

diff --git a/doc/images/screenshot-html-details.example.cpp.png b/doc/images/screenshot-html-details.example.cpp.png
diff --git a/gcovr/templates/source_page.html b/gcovr/templates/source_page.html
@@ -36,7 +36,7 @@
       <th scope="row">Functions:</th>
       <td>{{functions.exec}}</td>
       <td>{{functions.total}}</td>
-      <td class="{{info.functions.class}}">{{functions.coverage}}%</td>
+      <td class="{{functions.class}}">{{functions.coverage}}%</td>
     </tr>
     <tr>
       <th scope="row">Branches:</th>
@@ -49,6 +49,36 @@
 {% endblock %}
 
 {% block content %}
+{% if function_list %}
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+{% for entry in function_list %}
+    <tr>
+      <td>
+        <a href="#l{{ entry['line'] }}">{{ entry["name"] }}</a>
+      </td>
+      <td>
+        <a href="#l{{ entry['line'] }}">{{ entry["line"] }}</a>
+      </td>
+      <td>
+        <a href="#l{{ entry['line'] }}">
+        {%- if entry["count"] == 0 %} not called
+        {%- else %} called {{ entry["count"] }} time{% if entry["count"] > 1 %}s{% endif %}
+        {%- endif -%}
+        </a>
+      </td>
+    </tr>
+{% endfor %}
+  </table>
+</details>
+<hr/>
+{% endif -%}
 <div class="file-source">
   <table>
     <tr>

diff --git a/gcovr/templates/style.details.css b/gcovr/templates/style.details.css
@@ -82,6 +82,31 @@ pre
     margin-bottom: 0;
 }
 
+.listOfFunctions td, .listOfFunctions th {
+    padding: 0 10px;
+}
+.listOfFunctions th
+{
+    text-align: center;
+    color: white;
+    background-color: SteelBlue;
+}
+.listOfFunctions tr > td {
+    background: aliceblue;
+}
+.listOfFunctions tr:nth-child(even) > td {
+    background: LightSteelBlue
+}
+.listOfFunctions tr:hover > td
+{
+    background-color: #ddd;
+}
+.listOfFunctions tr > td > a
+{
+    text-decoration: none;
+    color: inherit;
+}
+
 .source-line
 {
     height : 15px;

diff --git a/...s/add_coverages/reference/clang-10/coverage.bar.cpp.e7a3224e852d4c9e084f9127df0315df.html b/...s/add_coverages/reference/clang-10/coverage.bar.cpp.e7a3224e852d4c9e084f9127df0315df.html
@@ -26,7 +26,7 @@ <h1>GCC Code Coverage Report</h1>
     </tr>
     <tr>
       <th scope="row">Date:</th>
-      <td>2021-09-06 13:58:23</td>
+      <td>2021-09-21 19:21:54</td>
     </tr>
   </table>
 </div>
@@ -62,6 +62,28 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l1">_Z3barv</a>
+      </td>
+      <td>
+        <a href="#l1">1</a>
+      </td>
+      <td>
+        <a href="#l1"> called 1 time</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>

diff --git a/...s/add_coverages/reference/clang-10/coverage.foo.cpp.da858f18e0c3a73a7b98ff456723b9ae.html b/...s/add_coverages/reference/clang-10/coverage.foo.cpp.da858f18e0c3a73a7b98ff456723b9ae.html
@@ -26,7 +26,7 @@ <h1>GCC Code Coverage Report</h1>
     </tr>
     <tr>
       <th scope="row">Date:</th>
-      <td>2021-09-06 13:58:23</td>
+      <td>2021-09-21 19:21:54</td>
     </tr>
   </table>
 </div>
@@ -62,6 +62,28 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l1">_Z3foov</a>
+      </td>
+      <td>
+        <a href="#l1">1</a>
+      </td>
+      <td>
+        <a href="#l1"> called 1 time</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>

diff --git a/.../add_coverages/reference/clang-10/coverage.main.cpp.118fcbaaba162ba17933c7893247df3a.html b/.../add_coverages/reference/clang-10/coverage.main.cpp.118fcbaaba162ba17933c7893247df3a.html
@@ -26,7 +26,7 @@ <h1>GCC Code Coverage Report</h1>
     </tr>
     <tr>
       <th scope="row">Date:</th>
-      <td>2021-09-06 13:58:23</td>
+      <td>2021-09-21 19:21:54</td>
     </tr>
   </table>
 </div>
@@ -62,6 +62,28 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l10">main</a>
+      </td>
+      <td>
+        <a href="#l10">10</a>
+      </td>
+      <td>
+        <a href="#l10"> called 2 times</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>

diff --git a/...ests/add_coverages/reference/gcc-5/coverage.bar.cpp.e7a3224e852d4c9e084f9127df0315df.html b/...ests/add_coverages/reference/gcc-5/coverage.bar.cpp.e7a3224e852d4c9e084f9127df0315df.html
@@ -26,7 +26,7 @@ <h1>GCC Code Coverage Report</h1>
     </tr>
     <tr>
       <th scope="row">Date:</th>
-      <td>2021-07-19 19:32:09</td>
+      <td>2021-09-21 19:04:30</td>
     </tr>
   </table>
 </div>
@@ -62,6 +62,28 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l1">bar()</a>
+      </td>
+      <td>
+        <a href="#l1">1</a>
+      </td>
+      <td>
+        <a href="#l1"> called 1 time</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>

diff --git a/...ests/add_coverages/reference/gcc-5/coverage.foo.cpp.da858f18e0c3a73a7b98ff456723b9ae.html b/...ests/add_coverages/reference/gcc-5/coverage.foo.cpp.da858f18e0c3a73a7b98ff456723b9ae.html
@@ -26,7 +26,7 @@ <h1>GCC Code Coverage Report</h1>
     </tr>
     <tr>
       <th scope="row">Date:</th>
-      <td>2021-07-19 19:32:09</td>
+      <td>2021-09-21 19:04:30</td>
     </tr>
   </table>
 </div>
@@ -62,6 +62,28 @@ <h1>GCC Code Coverage Report</h1>
 
     <hr/>
 
+<details>
+  <summary>List of functions</summary>
+  <table class="listOfFunctions">
+    <tr>
+      <th>Function</th>
+      <th>Line</th>
+      <th>Call count</th>
+    </tr>
+    <tr>
+      <td>
+        <a href="#l1">foo()</a>
+      </td>
+      <td>
+        <a href="#l1">1</a>
+      </td>
+      <td>
+        <a href="#l1"> called 1 time</a>
+      </td>
+    </tr>
+  </table>
+</details>
+<hr/>
 <div class="file-source">
   <table>
     <tr>