Doc: Add sources for integrated instrumentation examples

Author: leocreuse

doc/gnatcov/integrated_instr.rst

@@ -62,6 +62,10 @@ generated compiler wrapper instead of the original compiler.
 A simple Makefile example
 =========================
 
+The sources for the following example can be found under the
+``share/examples/gnatcoverage/doc/integrated`` directory of the GNATDAS
+distribution.
+
 The following considers that the instrumentation runtime was previously
 installed with ``gnatcov setup``, and that the ``GPR_PROJECT_PATH`` variable
 contains its installed location. See :ref:`instr-rts`.
@@ -111,6 +115,12 @@ when run, that can be analyzed with ``gnatcov coverage``.
 A simple CMake example
 ======================
 
+The sources for the following example can be found under the
+``share/examples/gnatcoverage/doc/integrated`` directory of the GNATDAS
+distribution. To ensure that the Makefile provided with the example sources
+uses CMake as a build system, specify ``BUILD_SYSTEM=CMake`` on the `make`
+invocation.
+
 The following considers that the instrumentation runtime  was installed through
 the use of ``gnatcov setup``.
 
@@ -129,8 +139,8 @@ The CMakeLists.txt file to be used to compile the main.cpp file is :
 
 .. code-block:: cmake
 
+   cmake_minimum_required(VERSION 3.5)
    project(HelloWorld)
-   cmake_minimum_required(VERSION 3.0)
 
    add_executable(hello_world main.cpp)
 

tools/gnatcov/examples/doc/integrated/Makefile

@@ -0,0 +1,45 @@
+# This showcases how to use the integrated instrumentation mode with a Makefile
+# or a CMake build system. For more details see subsections "A simple Makefile
+# example" and "A simple CMake example" of section "Producing source traces
+# with integrated instrumentation".
+
+RTS_DIR = rts_install
+ARTIFACTS_DIR = gnatcov_artifacts
+
+.PHONY: setup-instr build run coverage clean
+
+# Set this variable to either Makefile or CMake to select the desired build system
+BUILD_SYSTEM ?= Makefile
+
+default: coverage
+
+# Only needs to be called once, can be re-used across multiple GNATcov workflows
+$(RTS_DIR)/share/gpr/gnatcov_rts.gpr:
+	gnatcov setup --prefix=$(RTS_DIR)
+
+setup-instr: export GPR_PROJECT_PATH := $(shell pwd)/$(RTS_DIR)/share/gpr:$(GPR_PROJECT_PATH)
+setup-instr: $(RTS_DIR)/share/gpr/gnatcov_rts.gpr
+	gnatcov setup-integration --files=hello_world/main.cpp --compilers=g++ \
+	--level=stmt --output-dir=$(ARTIFACTS_DIR)
+
+build-Makefile: export PATH:=$(shell pwd)/$(ARTIFACTS_DIR):$(PATH)
+build-Makefile: setup-instr
+	make -C hello_world test
+	cp hello_world/test .
+
+build-CMake: setup-instr
+	cmake hello_world -B cmake_build -DCMAKE_CXX_COMPILER=$(shell pwd)/$(ARTIFACTS_DIR)/g++
+	cmake --build cmake_build
+	cp cmake_build/test .
+
+run: build-$(BUILD_SYSTEM)
+	./test
+
+coverage: run
+	gnatcov coverage --sid $(ARTIFACTS_DIR)/main.cpp.sid --level=stmt \
+	--annotate=xcov *.srctrace
+	cat main.cpp.xcov
+
+clean:
+	rm -rf $(ARTIFACTS_DIR) $(RTS_DIR) main*.srctrace hello_world/main.o \
+	hello_world/test stats *.xcov  CMakeFiles CMakeCache.txt cmake_* test

tools/gnatcov/examples/doc/integrated/hello_world/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.5)
+project(HelloWorld)
+
+add_executable(test main.cpp)

tools/gnatcov/examples/doc/integrated/hello_world/Makefile

@@ -0,0 +1,8 @@
+CC=g++
+OBJ = main.o
+
+%.o: %.c
+	$(CC) -c -o $@ $<
+
+test: $(OBJ)
+	$(CC) -o $@ $^

tools/gnatcov/examples/doc/integrated/hello_world/main.cpp

@@ -0,0 +1,13 @@
+/******************************************************
+ *                    GNATcoverage                     *
+ *           Copyright (C) 2012-2025, AdaCore          *
+ ******************************************************/
+
+#include <iostream>
+
+int
+main (int argc, char **argv)
+{
+  std::cout << "Hello World" << std::endl;
+  return 0;
+}