Add TypeID (#1)

* update readme and add coverage to tests target

* default initialize TypeID values

* include ostream for windows

* test gcc with disabled optimizations

* another test

* try with gcc-9

* use gcc-9 for install test too

* add test notes to readme

Author: TheLartians

.github/workflows/install.yml

@@ -20,7 +20,7 @@ jobs:
         rm -rf build
 
     - name: configure
-      run: CC=gcc-8 CXX=g++-8 cmake -Htest -Bbuild -DTEST_INSTALLED_VERSION=1
+      run: CC=gcc-9 CXX=g++-9 cmake -Htest -Bbuild -DTEST_INSTALLED_VERSION=1
 
     - name: build
       run: cmake --build build --config Debug -j4

.github/workflows/ubuntu.yml

@@ -15,7 +15,7 @@ jobs:
     - uses: actions/checkout@v1
 
     - name: configure
-      run: CC=gcc-8 CXX=g++-8 cmake -Htest -Bbuild -DENABLE_TEST_COVERAGE=1
+      run: CC=gcc-9 CXX=g++-9 cmake -Htest -Bbuild -DENABLE_TEST_COVERAGE=1
 
     - name: build
       run: cmake --build build --config Debug -j4

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
 
 # Note: update this to your new project's name and version
 project(StaticTypeInfo 
-  VERSION 1.0
+  VERSION 1.1
   LANGUAGES CXX
 )
 

README.md

@@ -11,8 +11,8 @@ A simple C++17 compile-time type info library.
 
 ## API
 
-The header-only library exposes two `constexpr` functions: `constexpr string_view getTypeName<T>()` and `constexpr TypeIndex getTypeIndex<T>()`.
-The TypeIndex may be used as a key in any hash-based container.`
+The header-only library exposes two main `constexpr` functions: `constexpr TypeName getTypeName<T>()` and `constexpr TypeIndex getTypeIndex<T>()`.
+The TypeIndex may be used as a key in any hash-based container.
 
 ```cpp
 #include <iostream>
@@ -29,6 +29,11 @@ void example() {
   constexpr auto intIdx = getTypeIndex<int>();
   constexpr auto floatIdx = getTypeIndex<float>();
   static_assert(intIdx != floatIdx);
+
+  // combine both in a single type
+  constexpr auto typeID = getTypeID<int>();
+  static_assert(typeID.name == "int");
+  static_assert(typeID.index == getTypeIndex<int>());
 }
 ```
 
@@ -37,14 +42,18 @@ void example() {
 The type name is extracted from the macro `__PRETTY_FUNCTION__` (clang/gcc) or `__FUNCSIG__` (on MSVC) inside a probe function and converted to a `string_view` using the `constexpr` constructor.
 The type index is a 64 bit fnv1a hash of the type name.
 
-## How integrate
+## Compatibility
+
+The library has been tested with AppleClang 11, Visual Studio 16 2019, and gcc-9.
+
+## How to integrate
 
 Use [CPM.cmake](https://github.com/TheLartians/CPM.cmake) to easily add the headers to your CMake project.
 
 ```cmake
 CPMAddPackage(
   NAME StaticTypeInfo
-  VERSION 1.0
+  VERSION 1.1
   GIT_REPOSITORY https://github.com/TheLartians/StaticTypeInfo
 )
 

include/static_type_info.h

@@ -1,4 +1,5 @@
 #pragma once
 
+#include <static_type_info/type_id.h>
 #include <static_type_info/type_index.h>
 #include <static_type_info/type_name.h>

include/static_type_info/type_id.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include <static_type_info/type_index.h>
+#include <static_type_info/type_name.h>
+
+namespace static_type_info {
+
+  struct TypeID {
+    TypeName name = TypeName();
+    TypeIndex index = TypeIndex();
+  };
+
+  template <class T> constexpr TypeID getTypeID() {
+    return TypeID{getTypeName<T>(), getTypeIndex<T>()};
+  }
+
+}  // namespace static_type_info

test/CMakeLists.txt

@@ -65,6 +65,6 @@ doctest_discover_tests(StaticTypeIndexTests)
 # ---- code coverage ----
 
 if (ENABLE_TEST_COVERAGE)
-  target_compile_options(StaticTypeInfo INTERFACE -O0 -g -fprofile-arcs -ftest-coverage --coverage)
-  target_link_options(StaticTypeInfo INTERFACE "--coverage")
+  target_compile_options(StaticTypeIndexTests PUBLIC -O0 -g -fprofile-arcs -ftest-coverage --coverage)
+  target_link_options(StaticTypeIndexTests PUBLIC "--coverage")
 endif()

test/source/example.cpp

@@ -15,6 +15,11 @@ void example() {
   constexpr auto intIdx = getTypeIndex<int>();
   constexpr auto floatIdx = getTypeIndex<float>();
   static_assert(intIdx != floatIdx);
+
+  // combine both in a single type
+  constexpr auto typeID = getTypeID<int>();
+  static_assert(typeID.name == "int");
+  static_assert(typeID.index == intIdx);
 }
 // clang-format on
 

test/source/type_id.cpp

@@ -0,0 +1,13 @@
+#include <doctest/doctest.h>
+#include <static_type_info/type_id.h>
+
+#include <ostream>
+
+TEST_CASE_TEMPLATE("TypeID", T, int, float, double) {
+  using namespace static_type_info;
+  constexpr auto typeID = getTypeID<T>();
+  static_assert(typeID.name == getTypeName<T>());
+  static_assert(typeID.index == getTypeIndex<T>());
+  CHECK(typeID.name == getTypeName<T>());
+  CHECK(typeID.index == getTypeIndex<T>());
+}