Develop (#150)

* Use _WIN32 instead of WIN32 preprocessor macro (#138)

- _WIN32 is the recommended preprocessor macro
- Substitute occurrences of WIN32 with _WIN32 using:
  git grep -lw -e 'WIN32' -- | xargs sed -i -e 's/\<WIN32\>/_WIN32/g'

* Cleanup some compiler issues on MacOS. (#141)

In file include/celero/ThreadLocal.h:
* `thread_local` is a C++ keyword so using an #ifdef check for its
  existence is not reliable. Instead, check for C++11 support to
  determine if `thread_local` is already defined. See here
  https://stackoverflow.com/questions/5047971/how-do-i-check-for-c11-support.
* Also the check `#if __STDC_VERSION__ >= 201112` is not meaningful,
  since presumably Celero is being compiled with a C++ compiler, so it
  has been removed.

In file src/Memory.cpp:
* Added include for `<cstring>` so that `strlen` and `strncmp` are
  defined for Apple environment.

Fixes #140

* Made it easier to use the Fixed baseline properly with UDMs.

* Improving the "cost of pimpl" experiment.

* #148 Added UDM to the output file

Also remove Google Test submodule.

* Create codeql-analysis.yml (#149)

* Removed requirement for GTest in Travis.ci

* #143 Added clarification to README.md on Doxygen.

* Code Cleanup

* Copyright Update 2021

Co-authored-by: Wolfgang Stöggl <c72578@yahoo.de>
Co-authored-by: jiverson002 <jiverson002@users.noreply.github.com>

Author: 3 people

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '31 20 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'cpp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitmodules

@@ -52,43 +52,43 @@ matrix:
 
     # Clang 3.9
     - os: linux
-      env: LLVM_VERSION=3.9.0 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: LLVM_VERSION=3.9.0 CMAKE_OPTIONS=""
       compiler: clang
 
     # Clang 5.0.1
     - os: linux
-      env: LLVM_VERSION=5.0.1 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: LLVM_VERSION=5.0.1 CMAKE_OPTIONS=""
       compiler: clang
 
     # Clang 7.0.0
     - os: linux
-      env: LLVM_VERSION=7.0.0 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: LLVM_VERSION=7.0.0 CMAKE_OPTIONS=""
       compiler: clang
 
     # Clang 8.0.0
     - os: linux
-      env: LLVM_VERSION=7.0.0 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: LLVM_VERSION=7.0.0 CMAKE_OPTIONS=""
       compiler: clang
 
     # GCC 6
     - os: linux
-      env: COMPILER=g++-6 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: COMPILER=g++-6 CMAKE_OPTIONS=""
       compiler: gcc
 
     # GCC 7
     - os: linux
-      env: COMPILER=g++-7 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: COMPILER=g++-7 CMAKE_OPTIONS=""
       compiler: gcc
 
     # GCC 8
     - os: linux
-      env: COMPILER=g++-8 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1"
+      env: COMPILER=g++-8 CMAKE_OPTIONS=""
       compiler: gcc
 
      # GCC 8
     - os: linux
       name: Complete Build
-      env: COMPILER=g++-8 CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1 -DCELERO_ENABLE_EXPERIMENTS=1"
+      env: COMPILER=g++-8 CMAKE_OPTIONS="-DCELERO_ENABLE_EXPERIMENTS=1"
       compiler: gcc
 
     ##########################################################################
@@ -97,7 +97,7 @@ matrix:
     # With debug mode
     - os: linux
       name: Debug Build
-      env: LLVM_VERSION=default CMAKE_OPTIONS="-DCELERO_ENABLE_TESTS=1 -DCMAKE_BUILD_TYPE=DEBUG"
+      env: LLVM_VERSION=default CMAKE_OPTIONS="-DCMAKE_BUILD_TYPE=DEBUG"
       compiler: clang
 
     # Temporarily broken within Travis.CI for CMake's update

.travis.yml

@@ -227,9 +227,8 @@ add_subdirectory(experiments)
 
 if(CELERO_ENABLE_TESTS)
 	set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
-	add_subdirectory(googletest)
 	add_subdirectory(test)
-endif()	
+endif()
 
 
 # ------------------------------------------------------------------------------

CMakeLists.txt

@@ -2,7 +2,7 @@
 
 ### C++ Benchmarking Library
 
-Copyright 2017-2019 John Farrier 
+Copyright 2017-2021 John Farrier 
 
 Apache 2.0 License
 
@@ -38,6 +38,8 @@ Celero has been successfully built on the following platforms during development
 -   XCode v10.3
 -   XCode v11.0
 
+As of v2.7, Celero requres the developer to provide GoogleTest in order to build unit tests.  We suggest using a package manager such as VCPKG or Conan to provide the latest version of the library.
+
 #### Quality Control
 
 | Tooling          | Status                                                                                                                                                                                                                                                            |
@@ -166,7 +168,7 @@ Here is an example of a simple Celero Benchmark. (Note: This is a complete, runn
 
 #include <random>
 
-#ifndef WIN32
+#ifndef _WIN32
 #include <cmath>
 #include <cstdlib>
 #endif
@@ -306,7 +308,7 @@ Celero can automatically run threaded benchmarks.  `BASELINE_T` and `BENCHMARK_T
 
 ```cpp
 BASELINE_T(groupName, baselineName, fixtureName, samples, iterations, threads);
-BASELINE_FIXED_T(groupName, baselineName, fixtureName, samples, iterations, threads, useconds);
+BASELINE_FIXED_T(groupName, baselineName, fixtureName, iterations, threads, useconds);
 
 BENCHMARK_T(groupName, benchmarkName, fixtureName, samples, iterations, threads);
 BENCHMARK_TEST_T(groupName, benchmarkName, fixtureName, samples, iterations, threads, target);
@@ -318,22 +320,24 @@ While Celero typically measures the baseline time and then executes benchmark ca
 
 ```cpp
 // No threads or test fixtures.
-BASELINE_FIXED(groupName, baselineName, samples, iterations, useconds);
+BASELINE_FIXED(groupName, baselineName, iterations, useconds);
 
 // For using test fixtures:
-BASELINE_FIXED_F(groupName, baselineName, fixtureName, samples, iterations, useconds);
+BASELINE_FIXED_F(groupName, baselineName, fixtureName, iterations, useconds);
 
 // For using threads and test fixtures.
-BASELINE_FIXED_T(groupName, baselineName, fixtureName, samples, iterations, threads, useconds);
+BASELINE_FIXED_T(groupName, baselineName, fixtureName, iterations, threads, useconds);
 ```
 
 Example:
 
 ```cpp
-BASELINE_FIXED_F(DemoTransform, FixedTime, DemoTransformFixture, 30, 10000, 100)
+BASELINE_FIXED_F(DemoTransform, FixedTime, DemoTransformFixture, 1, 100)
 { /* Nothing to do */ }
 ```
 
+It is important that if your measurements use a test fixture, that your baseline (even if fixed) should use a test fixture as well.  Features such as User-Defined Measurements (UDMs) look to the baseline class to detect if other features are present.  If the baseline does not use a test fixuture, Celero will not know that other classes do use a test fixture that offers a UDM.
+
 ### User-Defined Measurements (UDM)
 
 Celero, by default, measures the execution time of your experiments. If you want to measure anything else, say for example the number of page faults via [PAPI](http://icl.cs.utk.edu/projects/papi/wiki/PAPIC:Overview), *user-defined measurements* are for you.
@@ -461,7 +465,7 @@ sudo cpupower frequency-set --governor powersave
 
 -   Benchmarks should always be performed on Release builds.  Never measure the performance of a Debug build and make changes based on the results.  The (optimizing) compiler is your friend concerning code performance.
 -   Accuracy is tied very closely to the total number of samples and the sample sizes.  As a general rule, you should aim to execute your baseline code for about as long as your longest benchmark test.  Further, it is helpful if all of the benchmark tests take about the same order of magnitude of execution time.  (Don't compare a baseline that executed in 0.1 seconds with benchmarks that take 60 seconds and an hour, respectively.)
--   Celero has Doxygen documentation of its API.
+-   Celero has Doxygen-style documentation of its API.  (The Doxyfile is provided.  The user must generate the documentation.)
 -   Celero supports test fixtures for each baseline group.
 
 ## Celero Charts

README.md

@@ -2,7 +2,7 @@
 
 #include <random>
 
-#ifndef WIN32
+#ifndef _WIN32
 #include <cmath>
 #include <cstdlib>
 #endif

experiments/DemoSimple/DemoSimple.cpp

@@ -1,6 +1,6 @@
 #include <celero/Celero.h>
 
-#ifndef WIN32
+#ifndef _WIN32
 #include <cmath>
 #include <cstdlib>
 #endif

experiments/DemoSimpleJUnit/DemoSimpleJUnit.cpp

@@ -4,7 +4,7 @@
 #include <algorithm>
 #include <functional>
 
-#ifndef WIN32
+#ifndef _WIN32
 #include <cmath>
 #include <cstdlib>
 #endif
@@ -101,8 +101,8 @@ BASELINE_F(DemoTransform, ForLoop, DemoTransformFixture, 30, 10000)
 	}
 }
 
-// BASELINE_FIXED_F(DemoTransform, FixedTime, DemoTransformFixture, 30, 10000, 100)
-// { }
+BASELINE_FIXED_F(DemoTransform, FixedTime, DemoTransformFixture, 1, 100)
+{ }
 
 BENCHMARK_F(DemoTransform, StdTransform, DemoTransformFixture, 30, 10000)
 {