When invoked with --calls, show call coverage

AUTHORS.txt

@@ -56,6 +56,7 @@ The following developers contributed to gcovr (ordered alphabetically):
     Mikk Leini,
     Nikolaj Schumacher,
     Oleksiy Pikalo,
+    Pablo Martín,
     Phil Clapham,
     Piotr Dziwinski,
     Reto Schneider,

CHANGELOG.rst

@@ -13,6 +13,7 @@ Breaking changes:
 New features and notable changes:
 - Accept `NAN %` which is used in GCOV 7.5.0 instead of an invalid value. (:issue:`651`)
 - New :option:`--json-base` to define a base bath used in JSON reports. (:issue:`656`)
+- New :option:`--calls` to report call coverage: function calls invoked/total (:issue:`666`)
 
 Bug fixes and small improvements:
 - Fix :option:`--html-tab-size` feature. (:issue:`650`)

doc/examples/example_html.details.css

@@ -17,6 +17,8 @@
     --takenDecision_color: green;
     --uncheckedDecision_color: darkorange;
     --notTakenDecision_color: red;
+    --invokedCall_color: green;
+    --notInvokedCall_color: red;
 }
 
 .theme-blue {
@@ -335,23 +337,24 @@ span.excludedLine
     background-color: var(--excluded_color) !important;
 }
 
-.linebranch, .linedecision, .linecount
+.linebranch, .linedecision, .linecall, .linecount
 {
     font-family: monospace;
     border-right: 1px gray solid;
     background-color: lightgray;
     text-align: right;
 }
 
-.linebranchDetails, .linedecisionDetails
+
+.linebranchDetails, .linedecisionDetails, .linecallDetails
 {
     position: relative;
 }
-.linebranchSummary, .linedecisionSummary
+.linebranchSummary, .linedecisionSummary, .linecallSummary
 {
     cursor: help;
 }
-.linebranchContents, .linedecisionContents
+.linebranchContents, .linedecisionContents, .linecallContents
 {
     font-family: sans-serif;
     font-size: small;
@@ -390,6 +393,16 @@ span.excludedLine
     color: var(--uncheckedDecision_color) !important;
 }
 
+.invokedCall
+{
+    color: var(--invokedCall_color) !important;
+}
+
+.notInvokedCall
+{
+    color: var(--notInvokedCall_color) !important;
+}
+
 .src
 {
     padding-left: 12px;

doc/examples/example_html.html

@@ -25,6 +25,8 @@
     --takenDecision_color: green;
     --uncheckedDecision_color: darkorange;
     --notTakenDecision_color: red;
+    --invokedCall_color: green;
+    --notInvokedCall_color: red;
 }
 
 .theme-blue {
@@ -343,23 +345,24 @@
     background-color: var(--excluded_color) !important;
 }
 
-.linebranch, .linedecision, .linecount
+.linebranch, .linedecision, .linecall, .linecount
 {
     font-family: monospace;
     border-right: 1px gray solid;
     background-color: lightgray;
     text-align: right;
 }
 
-.linebranchDetails, .linedecisionDetails
+
+.linebranchDetails, .linedecisionDetails, .linecallDetails
 {
     position: relative;
 }
-.linebranchSummary, .linedecisionSummary
+.linebranchSummary, .linedecisionSummary, .linecallSummary
 {
     cursor: help;
 }
-.linebranchContents, .linedecisionContents
+.linebranchContents, .linedecisionContents, .linecallContents
 {
     font-family: sans-serif;
     font-size: small;
@@ -398,6 +401,16 @@
     color: var(--uncheckedDecision_color) !important;
 }
 
+.invokedCall
+{
+    color: var(--invokedCall_color) !important;
+}
+
+.notInvokedCall
+{
+    color: var(--notInvokedCall_color) !important;
+}
+
 .src
 {
     padding-left: 12px;

gcovr/configuration.py

@@ -763,6 +763,13 @@ def merge_options_and_set_defaults(
         help="Report the decision coverage. For HTML and JSON report.",
         action="store_true",
     ),
+    GcovrConfigOption(
+        "show_calls",
+        ["--calls"],
+        group="output_options",
+        help="Report the calls coverage. For HTML report.",
+        action="store_true",
+    ),
     GcovrConfigOption(
         "sort_uncovered",
         ["-u", "--sort-uncovered"],

gcovr/coverage.py

@@ -72,6 +72,27 @@ def is_covered(self) -> bool:
         return self.count > 0
 
 
+class CallCoverage:
+    r"""Represent coverage information about a call.
+
+    Args:
+        covered (bool):
+            Whether the call was performed.
+    """
+
+    __slots__ = "covered"
+
+    def __init__(
+        self,
+        covered: bool,
+    ) -> None:
+        self.covered = covered
+
+    @property
+    def is_covered(self) -> bool:
+        return self.covered
+
+
 class DecisionCoverageUncheckable:
     r"""Represent coverage information about a decision."""
 
@@ -156,6 +177,7 @@ class LineCoverage:
         "branches",
         "decision",
         "functions",
+        "calls",
     )
 
     def __init__(
@@ -170,6 +192,7 @@ def __init__(
         self.excluded: bool = excluded
         self.branches: Dict[int, BranchCoverage] = {}
         self.decision: Optional[DecisionCoverage] = None
+        self.calls: Dict[int, CallCoverage] = {}
 
     @property
     def is_excluded(self) -> bool:
@@ -272,6 +295,19 @@ def decision_coverage(self) -> DecisionCoverageStat:
 
         return stat
 
+    def call_coverage(self) -> CoverageStat:
+        covered = 0
+        total = 0
+
+        for line in self.lines.values():
+            if len(line.calls) > 0:
+                for call in line.calls.values():
+                    total += 1
+                    if call.is_covered:
+                        covered += 1
+
+        return CoverageStat(covered, total)
+
 
 CovData = Dict[str, FileCoverage]
 
@@ -282,6 +318,7 @@ class SummarizedStats:
     branch: CoverageStat
     function: CoverageStat
     decision: DecisionCoverageStat
+    call: CoverageStat
 
     @staticmethod
     def new_empty() -> SummarizedStats:
@@ -290,6 +327,7 @@ def new_empty() -> SummarizedStats:
             branch=CoverageStat.new_empty(),
             function=CoverageStat.new_empty(),
             decision=DecisionCoverageStat.new_empty(),
+            call=CoverageStat.new_empty(),
         )
 
     @staticmethod
@@ -306,13 +344,15 @@ def from_file(filecov: FileCoverage) -> SummarizedStats:
             branch=filecov.branch_coverage(),
             function=filecov.function_coverage(),
             decision=filecov.decision_coverage(),
+            call=filecov.call_coverage(),
         )
 
     def __iadd__(self, other: SummarizedStats) -> SummarizedStats:
         self.line += other.line
         self.branch += other.branch
         self.function += other.function
         self.decision += other.decision
+        self.call += other.call
         return self
 
 

gcovr/gcov.py

@@ -153,6 +153,8 @@ def process_gcov_data(
         parser_flags |= ParserFlags.RESPECT_EXCLUSION_MARKERS
     if options.show_decision:
         parser_flags |= ParserFlags.PARSE_DECISIONS
+    if options.show_calls:
+        parser_flags |= ParserFlags.PARSE_CALLS
 
     coverage = parse_coverage(
         lines,

gcovr/gcov_parser.py

@@ -52,13 +52,14 @@
     NoReturn,
 )
 
-from .coverage import BranchCoverage, FileCoverage, FunctionCoverage
+from .coverage import BranchCoverage, FileCoverage, FunctionCoverage, CallCoverage
 from .decision_analysis import DecisionParser
 from .merging import (
     MergeOptions,
     get_or_create_line_coverage,
     insert_branch_coverage,
     insert_function_coverage,
+    insert_call_coverage,
 )
 
 
@@ -295,6 +296,9 @@ class ParserFlags(enum.Flag):
     PARSE_DECISIONS = enum.auto()
     """Whether decision coverage shall be generated."""
 
+    PARSE_CALLS = enum.auto()
+    """Whether call coverage shall be generated."""
+
 
 _LineWithError = Tuple[str, Exception]
 
@@ -504,7 +508,23 @@ def _gather_coverage_from_line(
         return state
 
     # ignore unused line types, such as specialization sections
-    elif isinstance(line, (_CallLine, _UnconditionalLine, _BlockLine)):
+    elif isinstance(line, _CallLine):
+        callno, returned = line
+        line_cov = coverage.lines[state.lineno]  # must already exist
+
+
+        if context.flags & ParserFlags.PARSE_CALLS:
+            insert_call_coverage(
+                line_cov,
+                callno,
+                CallCoverage(
+                    covered=(returned > 0),
+                ),
+            )
+
+        return state
+
+    elif isinstance(line, (_UnconditionalLine, _BlockLine)):
         return state
 
     else:

gcovr/merging.py

@@ -60,6 +60,7 @@
     FileCoverage,
     FunctionCoverage,
     LineCoverage,
+    CallCoverage,
 )
 
 
@@ -233,6 +234,7 @@ def merge_line(
     left.excluded |= right.excluded
     left.branches = _merge_dict(left.branches, right.branches, merge_branch, options)
     left.decision = merge_decision(left.decision, right.decision, options)
+    left.calls = _merge_dict(left.calls, right.calls, merge_call, options)
 
     return left
 
@@ -305,6 +307,30 @@ def merge_branch(
     return left
 
 
+def insert_call_coverage(
+    target: LineCoverage,
+    call_id: int,
+    call: CallCoverage,
+    options: MergeOptions = DEFAULT_MERGE_OPTIONS,
+) -> CallCoverage:
+    """Insert BranchCoverage into LineCoverage."""
+    return _insert_coverage_item(target.calls, call_id, call, merge_call, options)
+
+
+def merge_call(
+    left: CallCoverage,
+    right: CallCoverage,
+    options: MergeOptions = DEFAULT_MERGE_OPTIONS,
+) -> BranchCoverage:
+    """
+    Merge CallCoverage information.
+
+    Do not use 'left' or 'right' objects afterwards!
+    """
+    left.covered |= right.covered
+    return left
+
+
 def insert_decision_coverage(
     target: LineCoverage,
     decision: Optional[DecisionCoverage],

gcovr/templates/root_page.html

@@ -94,7 +94,15 @@
       <td>{{info.decisions.total}}</td>
       <td class="{{info.decisions.class}}">{{info.decisions.coverage}}%</td>
     </tr>
-  {% endif %}
+    {% endif %}
+    {% if SHOW_CALL %}
+    <tr>
+      <th scope="row">Calls:</th>
+      <td>{{info.calls.exec}}</td>
+      <td>{{info.calls.total}}</td>
+      <td class="{{info.calls.class}}">{{info.calls.coverage}}%</td>
+    </tr>
+    {% endif %}
   </table>
 </div>
 {% endblock %}
@@ -111,6 +119,12 @@
   <colgroup span="3"/>
   <colgroup span="2"/>
   <colgroup span="2"/>
+  {% if SHOW_DECISION %}
+  <colgroup span="2"/>
+  {% endif %}
+  {% if SHOW_CALL %}
+  <colgroup span="2"/>
+  {% endif %}
 
   <tr>
     <th scope="col">File</th>
@@ -120,6 +134,9 @@
     {% if SHOW_DECISION %}
     <th scope="colgroup" colspan=2>Decisions</th>
     {% endif %}
+    {% if SHOW_CALL %}
+    <th scope="colgroup" colspan=2>Calls</th>
+    {% endif %}
   </tr>
 
   {% for row in info.files %}
@@ -145,6 +162,10 @@
     <td class="CoverValue decision-coverage {{row.decisions.class}}">{{row.decisions.coverage}}%</td>
     <td class="CoverValue decision-coverage {{row.decisions.class}}">{{row.decisions.exec}} / {{row.decisions.total}}</td>
     {% endif %}
+    {% if SHOW_CALL %}
+    <td class="CoverValue branch-coverage {{row.branches.class}}">{{row.calls.coverage}}%</td>
+    <td class="CoverValue branch-coverage {{row.branches.class}}">{{row.calls.exec}} / {{row.calls.total}}</td>
+    {% endif %}
   </tr>
 
   {% endfor %}