Merge branch 'master' into 2-dev

* Make all functions static inline

* Updated email in credits

Co-authored-by: Zakary Strange <ZakaryStrange@gmail.com>

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.{c,cpp,h}]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.travis.yml

@@ -1,12 +1,23 @@
 language: cpp
+os:
+  - linux
+  - osx
 compiler:
   - clang
   - gcc
+matrix:
+  include:
+    # Windows x64 builds (MSVC)
+    - os: windows
+      script:
+        - ./test.bat travis
+
+before_install:
+  - eval "${MATRIX_EVAL}"
 install:
   - cd test
-  - make
 script:
-  - build/hmm_test_c
-  - build/hmm_test_c_no_sse
-  - build/hmm_test_cpp
-  - build/hmm_test_cpp_no_sse
+  - make c
+  - make c_no_sse
+  - make cpp
+  - make cpp_no_sse

CONTRIBUTING.md

@@ -1,8 +1,6 @@
 # Understanding the structure of Handmade Math
 
-Most of the functions in Handmade Math are very short, and are the kind of functions you want to have inlined. Because of this, most functions in Handmade Math are defined with `HINLINE`, which is defined as `static inline`.
-
-The exceptions are functions like `HMM_Rotate`, which are long enough that it doesn't make sense to inline them. These functions are defined with an `HEXTERN` prototype, and implemented in the `#ifdef HANDMADE_MATH_IMPLEMENTATION` block.
+Most of the functions in Handmade Math are very short, and all are the kind of functions you want to be easily inlined for performance. Because of this, all functions in Handmade Math are defined with `HMM_INLINE`, which is defined as `static inline`.
 
 # Quick style guide
 
@@ -14,7 +12,7 @@ The exceptions are functions like `HMM_Rotate`, which are long enough that it do
   0.5f;
   1.0f;
   3.14159f;
-  
+
   // Bad
   1.f
   .0f

README.md

@@ -10,6 +10,10 @@ To get started, go download [the latest release](https://github.com/HandmadeMath
 
 Version         | Changes        |
 ----------------|----------------|
+**1.11.1** | Added HMM_PREFIX macro to a few functions that were missing it. |
+**1.11.0** | Added ability to customize or remove the default `HMM_` prefix on function names by defining a macro called `HMM_PREFIX(name)`. |
+**1.10.1** | Removed stdint.h, this doesn't exist on some really old compilers and we didn't really use it anyways. |
+**1.10.0** | Made HMM_Perspective use vertical FOV instead of horizontal FOV for consistency with other graphics APIs. |
 **1.9.0** | Added SSE versions of quaternion operations. |
 **1.8.0** | Added fast vector normalization routines that use fast inverse square roots.
 **1.7.1** | Changed operator[] to take a const ref int instead of an int.

test/HandmadeMath.c

@@ -1,3 +1,5 @@
-#define HANDMADE_MATH_IMPLEMENTATION
-#define HANDMADE_MATH_NO_INLINE
+#ifndef WITHOUT_COVERAGE
+#include "HandmadeTest.h"
+#endif
+
 #include "../HandmadeMath.h"

test/HandmadeMathDifferentPrefix.cpp

@@ -0,0 +1,12 @@
+#define HMM_PREFIX(name) WOW_##name
+
+#define HANDMADE_MATH_IMPLEMENTATION
+#define HANDMADE_MATH_NO_INLINE
+#include "../HandmadeMath.h"
+
+int main() {
+    hmm_vec4 a = WOW_Vec4(1, 2, 3, 4);
+    hmm_vec4 b = WOW_Vec4(5, 6, 7, 8);
+
+    WOW_Add(a, b);
+}

test/HandmadeTest.h

@@ -4,19 +4,46 @@
   This is Handmade Math's test framework. It is fully compatible with both C
   and C++, although it requires some compiler-specific features.
 
+  To use Handmade Test, you must #define HANDMADE_TEST_IMPLEMENTATION in
+  exactly one C or C++ file that includes the header, like this:
+
+    #define HANDMADE_TEST_IMPLEMENTATION
+    #include "HandmadeTest.h"
+
   The basic way of creating a test is using the TEST macro, which registers a
   single test to be run:
 
-     TEST(MyCategory, MyTestName) {
+    TEST(MyCategory, MyTestName) {
         // test code, including asserts/expects
-     }
+    }
 
-  The main function of your test code should then call hmt_run_all_tests and
-  return the result:
+  Handmade Test also provides macros you can use to check the coverage of
+  important parts of your code. Define a coverage case by using the COVERAGE
+  macro outside the function you wish to test, providing both a name and the
+  number of asserts you expect to see covered over the course of your test.
+  Then use the ASSERT_COVERED macro in every part of the function you wish to
+  check coverage on. For example:
 
-     int main() {
-        return hmt_run_all_tests();
-     }
+    COVERAGE(MyCoverageCase, 3)
+    void MyFunction(int a, int b) {
+        if (a > b) {
+            ASSERT_COVERED(MyCoverageCase);
+            return 10;
+        } else if (a < b) {
+            ASSERT_COVERED(MyCoverageCase);
+            return -10;
+        }
+
+        ASSERT_COVERED(MyCoverageCase);
+        return 0;
+    }
+
+  The main function of your test code should then call hmt_run_all_tests (and
+  optionally hmt_check_all_coverage) and return the result:
+
+    int main() {
+        return hmt_run_all_tests() || hmt_check_all_coverage();
+    }
 
   =============================================================================
 
@@ -40,7 +67,7 @@
 #define HMT_RED   "\033[31m"
 #define HMT_GREEN "\033[32m"
 
-#define HMT_INITIAL_ARRAY_SIZE 1024
+#define HMT_ARRAY_SIZE 1024
 
 typedef struct hmt_testresult_struct {
     int count_cases;
@@ -57,20 +84,137 @@ typedef struct hmt_test_struct {
 typedef struct hmt_category_struct {
     const char* name;
     int num_tests;
-    int tests_capacity;
     hmt_test* tests;
 } hmt_category;
 
-int hmt_num_categories = 0;
-int hmt_category_capacity = HMT_INITIAL_ARRAY_SIZE;
-hmt_category* categories = 0;
+typedef struct hmt_covercase_struct {
+    const char* name;
+    int expected_asserts;
+    int actual_asserts;
+    int* asserted_lines;
+} hmt_covercase;
+
+hmt_category _hmt_new_category(const char* name);
+hmt_test _hmt_new_test(const char* name, hmt_test_func func);
+hmt_covercase _hmt_new_covercase(const char* name, int expected);
+void _hmt_register_test(const char* category, const char* name, hmt_test_func func);
+void _hmt_register_covercase(const char* name, const char* expected_asserts);
+void _hmt_count_cover(const char* name, int line);
+
+#define _HMT_TEST_FUNCNAME(category, name) _hmt_test_ ## category ## _ ## name
+#define _HMT_TEST_FUNCNAME_INIT(category, name) _hmt_test_ ## category ## _ ## name ## _init
+#define _HMT_COVERCASE_FUNCNAME_INIT(name) _hmt_covercase_ ## name ## _init
+
+#define HMT_TEST(category, name) \
+void _HMT_TEST_FUNCNAME(category, name)(hmt_testresult* _result); \
+INITIALIZER(_HMT_TEST_FUNCNAME_INIT(category, name)) { \
+    _hmt_register_test(#category, #name, _HMT_TEST_FUNCNAME(category, name)); \
+} \
+void _HMT_TEST_FUNCNAME(category, name)(hmt_testresult* _result)
+
+#define _HMT_CASE_START() \
+    _result->count_cases++;
+
+#define _HMT_CASE_FAIL() \
+    _result->count_failures++; \
+    printf("\n      - " HMT_RED "[FAIL] (line %d) " HMT_RESET, __LINE__);
+
+#define HMT_COVERAGE(name, num_asserts) \
+INITIALIZER(_HMT_COVERCASE_FUNCNAME_INIT(name)) { \
+    _hmt_register_covercase(#name, #num_asserts); \
+} \
+
+#define HMT_ASSERT_COVERED(name) \
+{ \
+    _hmt_count_cover(#name, __LINE__); \
+} \
+
+/*
+ * Asserts and expects
+ */
+#define HMT_EXPECT_TRUE(_actual) { \
+    _HMT_CASE_START(); \
+    if (!(_actual)) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected true but got something false"); \
+    } \
+} \
+
+#define HMT_EXPECT_FALSE(_actual) { \
+    _HMT_CASE_START(); \
+    if (_actual) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected false but got something true"); \
+    } \
+} \
+
+#define HMT_EXPECT_FLOAT_EQ(_actual, _expected) { \
+    _HMT_CASE_START(); \
+    float actual = (_actual); \
+    float diff = actual - (_expected); \
+    if (diff < -FLT_EPSILON || FLT_EPSILON < diff) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected %f, got %f", (_expected), actual); \
+    } \
+} \
+
+#define HMT_EXPECT_NEAR(_actual, _expected, _epsilon) { \
+    _HMT_CASE_START(); \
+    float actual = (_actual); \
+    float diff = actual - (_expected); \
+    if (diff < -(_epsilon) || (_epsilon) < diff) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected %f, got %f", (_expected), actual); \
+    } \
+} \
+
+#define HMT_EXPECT_LT(_actual, _expected) { \
+    _HMT_CASE_START(); \
+    if ((_actual) >= (_expected)) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected %f to be less than %f", (_actual), (_expected)); \
+    } \
+} \
+
+#define HMT_EXPECT_GT(_actual, _expected) { \
+    _HMT_CASE_START(); \
+    if ((_actual) <= (_expected)) { \
+        _HMT_CASE_FAIL(); \
+        printf("Expected %f to be greater than %f", (_actual), (_expected)); \
+    } \
+} \
+
+#ifndef HMT_SAFE_MACROS
+// Friendly defines
+#define TEST(category, name) HMT_TEST(category, name)
+#define COVERAGE(name, expected_asserts) HMT_COVERAGE(name, expected_asserts)
+#define ASSERT_COVERED(name) HMT_ASSERT_COVERED(name)
+#define EXPECT_TRUE(_actual) HMT_EXPECT_TRUE(_actual)
+#define EXPECT_FALSE(_actual) HMT_EXPECT_FALSE(_actual)
+#define EXPECT_FLOAT_EQ(_actual, _expected) HMT_EXPECT_FLOAT_EQ(_actual, _expected)
+#define EXPECT_NEAR(_actual, _expected, _epsilon) HMT_EXPECT_NEAR(_actual, _expected, _epsilon)
+#define EXPECT_LT(_actual, _expected) HMT_EXPECT_LT(_actual, _expected)
+#define EXPECT_GT(_actual, _expected) HMT_EXPECT_GT(_actual, _expected)
+#endif // HMT_SAFE_MACROS
+
+#endif // HANDMADETEST_H
+
+#ifdef HANDMADE_TEST_IMPLEMENTATION
+
+#ifndef HANDMADE_TEST_IMPLEMENTATION_GUARD
+#define HANDMADE_TEST_IMPLEMENTATION_GUARD
+
+int _hmt_num_categories = 0;
+hmt_category* _hmt_categories = 0;
+
+int _hmt_num_covercases = 0;
+hmt_covercase* _hmt_covercases = 0;
 
 hmt_category _hmt_new_category(const char* name) {
     hmt_category cat = {
-        .name = name,
-        .num_tests = 0,
-        .tests_capacity = HMT_INITIAL_ARRAY_SIZE,
-        .tests = (hmt_test*) malloc(HMT_INITIAL_ARRAY_SIZE * sizeof(hmt_test))
+        name, // name
+        0, // num_tests
+        (hmt_test*) malloc(HMT_ARRAY_SIZE * sizeof(hmt_test)), // tests
     };
 
     return cat;
@@ -78,60 +222,105 @@ hmt_category _hmt_new_category(const char* name) {
 
 hmt_test _hmt_new_test(const char* name, hmt_test_func func) {
     hmt_test test = {
-        .name = name,
-        .func = func
+        name, // name
+        func, // func
     };
 
     return test;
 }
 
-int hmt_register_test(const char* category, const char* name, hmt_test_func func) {
+hmt_covercase _hmt_new_covercase(const char* name, int expected) {
+    hmt_covercase covercase = {
+        name, // name
+        expected, // expected_asserts
+        0, // actual_asserts
+        (int*) malloc(HMT_ARRAY_SIZE * sizeof(int)), // asserted_lines
+    };
+
+    return covercase;
+}
+
+void _hmt_register_test(const char* category, const char* name, hmt_test_func func) {
     // initialize categories array if not initialized
-    if (!categories) {
-        categories = (hmt_category*) malloc(hmt_category_capacity * sizeof(hmt_category));
+    if (!_hmt_categories) {
+        _hmt_categories = (hmt_category*) malloc(HMT_ARRAY_SIZE * sizeof(hmt_category));
     }
 
     // Find the matching category, if possible
     int cat_index;
-    for (cat_index = 0; cat_index < hmt_num_categories; cat_index++) {
-        if (strcmp(categories[cat_index].name, category) == 0) {
+    for (cat_index = 0; cat_index < _hmt_num_categories; cat_index++) {
+        if (strcmp(_hmt_categories[cat_index].name, category) == 0) {
             break;
         }
     }
 
-    // Expand the array of categories if necessary
-    if (cat_index >= hmt_category_capacity) {
-        // TODO: If/when we ever split HandmadeTest off into its own package,
-        // we should start with a smaller initial capacity and dynamically expand.
-    }
-
     // Add a new category if necessary
-    if (cat_index >= hmt_num_categories) {
-        categories[cat_index] = _hmt_new_category(category);
-        hmt_num_categories++;
+    if (cat_index >= _hmt_num_categories) {
+        _hmt_categories[cat_index] = _hmt_new_category(category);
+        _hmt_num_categories++;
     }
 
-    hmt_category* cat = &categories[cat_index];
+    hmt_category* cat = &_hmt_categories[cat_index];
 
     // Add the test to the category
-    if (cat->num_tests >= cat->tests_capacity) {
-        // TODO: If/when we ever split HandmadeTest off into its own package,
-        // we should start with a smaller initial capacity and dynamically expand.
-    }
     cat->tests[cat->num_tests] = _hmt_new_test(name, func);
     cat->num_tests++;
+}
+
+void _hmt_register_covercase(const char* name, const char* expected_asserts) {
+    // initialize cases array if not initialized
+    if (!_hmt_covercases) {
+        _hmt_covercases = (hmt_covercase*) malloc(HMT_ARRAY_SIZE * sizeof(hmt_covercase));
+    }
+
+    // check for existing case with that name, because the macro can run multiple
+    // times in different translation units
+    for (int i = 0; i < _hmt_num_covercases; i++) {
+        if (strcmp(_hmt_covercases[i].name, name) == 0) {
+            return;
+        }
+    }
+
+    _hmt_covercases[_hmt_num_covercases] = _hmt_new_covercase(name, atoi(expected_asserts));
+    _hmt_num_covercases++;
+}
+
+hmt_covercase* _hmt_find_covercase(const char* name) {
+    for (int i = 0; i < _hmt_num_covercases; i++) {
+        if (strcmp(_hmt_covercases[i].name, name) == 0) {
+            return &_hmt_covercases[i];
+        }
+    }
 
     return 0;
 }
 
+void _hmt_count_cover(const char* name, int line) {
+    hmt_covercase* covercase = _hmt_find_covercase(name);
+    if (covercase == 0) {
+        printf(HMT_RED "ERROR (line %d): Could not find coverage case with name \"%s\".\n" HMT_RESET, line, name);
+        return;
+    }
+
+    // see if this line has already been covered
+    for (int i = 0; i < covercase->actual_asserts; i++) {
+        if (covercase->asserted_lines[i] == line) {
+            return;
+        }
+    }
+
+    covercase->asserted_lines[covercase->actual_asserts] = line;
+    covercase->actual_asserts++;
+}
+
 int hmt_run_all_tests() {
     int count_alltests = 0;
     int count_allfailedtests = 0; // failed test cases
     int count_allfailures = 0; // failed asserts
 
-    for (int i = 0; i < hmt_num_categories; i++) {
-        hmt_category cat = categories[i];
-        int count_catfailedtests = 0; 
+    for (int i = 0; i < _hmt_num_categories; i++) {
+        hmt_category cat = _hmt_categories[i];
+        int count_catfailedtests = 0;
         int count_catfailures = 0;
 
         printf("\n%s:\n", cat.name);
@@ -142,8 +331,8 @@ int hmt_run_all_tests() {
             printf("    %s:", test.name);
 
             hmt_testresult result = {
-                .count_cases = 0,
-                .count_failures = 0
+                0, // count_cases
+                0, // count_failures
             };
             test.func(&result);
 
@@ -177,87 +366,33 @@ int hmt_run_all_tests() {
     return (count_allfailedtests > 0);
 }
 
-#define _HMT_TEST_FUNCNAME(category, name) category ## _ ## name
-#define _HMT_TEST_FUNCNAME_INIT(category, name) category ## _ ## name ## _init
+int hmt_check_all_coverage() {
+    printf("Coverage:\n");
 
-#define HMT_TEST(category, name) \
-void _HMT_TEST_FUNCNAME(category, name)(hmt_testresult* _result); \
-INITIALIZER(_HMT_TEST_FUNCNAME_INIT(category, name)) { \
-    hmt_register_test(#category, #name, _HMT_TEST_FUNCNAME(category, name)); \
-} \
-void _HMT_TEST_FUNCNAME(category, name)(hmt_testresult* _result)
+    int count_failures = 0;
 
-#define _HMT_CASE_START() \
-    _result->count_cases++;
+    for (int i = 0; i < _hmt_num_covercases; i++) {
+        hmt_covercase covercase = _hmt_covercases[i];
 
-#define _HMT_CASE_FAIL() \
-    _result->count_failures++; \
-    printf("\n      - " HMT_RED "[FAIL] (%d) " HMT_RESET, __LINE__);
+        if (covercase.expected_asserts != covercase.actual_asserts) {
+            count_failures++;
+            printf("%s: " HMT_RED "FAIL (expected %d asserts, got %d)\n" HMT_RESET, covercase.name, covercase.expected_asserts, covercase.actual_asserts);
+        }
+    }
 
-/*
- * Asserts and expects
- */
-#define HMT_EXPECT_TRUE(_actual) do { \
-    _HMT_CASE_START(); \
-    if (!(_actual)) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected true but got something false"); \
-    } \
-} while (0)
+    if (count_failures > 0) {
+        printf("\n");
+        printf(HMT_RED);
+    } else {
+        printf(HMT_GREEN);
+    }
+    printf("%d coverage cases tested, %d failures\n", _hmt_num_covercases, count_failures);
+    printf(HMT_RESET);
 
-#define HMT_EXPECT_FALSE(_actual) do { \
-    _HMT_CASE_START(); \
-    if (_actual) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected false but got something true"); \
-    } \
-} while (0)
+    printf("\n");
 
-#define HMT_EXPECT_FLOAT_EQ(_actual, _expected) do { \
-    _HMT_CASE_START(); \
-    float actual = (_actual); \
-    float diff = actual - (_expected); \
-    if (diff < -FLT_EPSILON || FLT_EPSILON < diff) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected %f, got %f", (_expected), actual); \
-    } \
-} while (0)
+    return (count_failures > 0);
+}
 
-#define HMT_EXPECT_NEAR(_actual, _expected, _epsilon) do { \
-    _HMT_CASE_START(); \
-    float actual = (_actual); \
-    float diff = actual - (_expected); \
-    if (diff < -(_epsilon) || (_epsilon) < diff) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected %f, got %f", (_expected), actual); \
-    } \
-} while (0)
-
-#define HMT_EXPECT_LT(_actual, _expected) do { \
-    _HMT_CASE_START(); \
-    if ((_actual) >= (_expected)) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected %f to be less than %f", (_actual), (_expected)); \
-    } \
-} while (0)
-
-#define HMT_EXPECT_GT(_actual, _expected) do { \
-    _HMT_CASE_START(); \
-    if ((_actual) <= (_expected)) { \
-        _HMT_CASE_FAIL(); \
-        printf("Expected %f to be greater than %f", (_actual), (_expected)); \
-    } \
-} while (0)
-
-#ifndef HMT_SAFE_MACROS
-// Friendly defines
-#define TEST(category, name) HMT_TEST(category, name)
-#define EXPECT_TRUE(_actual) HMT_EXPECT_TRUE(_actual)
-#define EXPECT_FALSE(_actual) HMT_EXPECT_FALSE(_actual)
-#define EXPECT_FLOAT_EQ(_actual, _expected) HMT_EXPECT_FLOAT_EQ(_actual, _expected)
-#define EXPECT_NEAR(_actual, _expected, _epsilon) HMT_EXPECT_NEAR(_actual, _expected, _epsilon)
-#define EXPECT_LT(_actual, _expected) HMT_EXPECT_LT(_actual, _expected)
-#define EXPECT_GT(_actual, _expected) HMT_EXPECT_GT(_actual, _expected)
-#endif // HMT_SAFE_MACROS
-
-#endif // HANDMADETEST_H
+#endif // HANDMADE_TEST_IMPLEMENTATION_GUARD
+#endif // HANDMADE_TEST_IMPLEMENTATION

test/Makefile

@@ -1,13 +1,18 @@
-BUILD_DIR=build
+BUILD_DIR=./build
 
-CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
+CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers -Wfloat-equal
 
-all: c c_no_sse cpp cpp_no_sse
+all: c c_no_sse cpp cpp_no_sse build_c_without_coverage build_cpp_without_coverage build_cpp_different_prefix
+
+build_all: build_c build_c_no_sse build_cpp build_cpp_no_sse
 
 clean:
 	rm -rf $(BUILD_DIR)
 
-c: HandmadeMath.c test_impl
+c: build_c
+	$(BUILD_DIR)/hmm_test_c
+
+build_c: HandmadeMath.c test_impl
 	@echo "\nCompiling in C mode"
 	mkdir -p $(BUILD_DIR)
 	cd $(BUILD_DIR)\
@@ -16,7 +21,10 @@ c: HandmadeMath.c test_impl
 			-lm \
 		&& $(CC) -ohmm_test_c HandmadeMath.o hmm_test.o -lm
 
-c_no_sse: HandmadeMath.c test_impl
+c_no_sse: build_c_no_sse
+	$(BUILD_DIR)/hmm_test_c_no_sse
+
+build_c_no_sse: HandmadeMath.c test_impl
 	@echo "\nCompiling in C mode (no SSE)"
 	mkdir -p $(BUILD_DIR)
 	cd $(BUILD_DIR) \
@@ -26,7 +34,10 @@ c_no_sse: HandmadeMath.c test_impl
 			-lm \
 		&& $(CC) -ohmm_test_c_no_sse HandmadeMath.o hmm_test.o -lm
 
-cpp: HandmadeMath.cpp test_impl
+cpp: build_cpp
+	$(BUILD_DIR)/hmm_test_cpp
+
+build_cpp: HandmadeMath.cpp test_impl
 	@echo "\nCompiling in C++ mode"
 	mkdir -p $(BUILD_DIR)
 	cd $(BUILD_DIR) \
@@ -34,7 +45,10 @@ cpp: HandmadeMath.cpp test_impl
 			-DHANDMADE_MATH_CPP_MODE \
 			../HandmadeMath.cpp ../hmm_test.cpp
 
-cpp_no_sse: HandmadeMath.cpp test_impl
+cpp_no_sse: build_cpp_no_sse
+	$(BUILD_DIR)/hmm_test_cpp_no_sse
+
+build_cpp_no_sse: HandmadeMath.cpp test_impl
 	@echo "\nCompiling in C++ mode (no SSE)"
 	mkdir -p $(BUILD_DIR)
 	cd $(BUILD_DIR) \
@@ -43,3 +57,29 @@ cpp_no_sse: HandmadeMath.cpp test_impl
 			../HandmadeMath.cpp ../hmm_test.cpp
 
 test_impl: hmm_test.cpp hmm_test.c
+
+build_c_without_coverage: HandmadeMath.c test_impl
+	@echo "\nCompiling in C mode"
+	mkdir -p $(BUILD_DIR)
+	cd $(BUILD_DIR)\
+		&& $(CC) $(CPPFLAGS) $(CXXFLAGS) -std=c99 \
+			-DWITHOUT_COVERAGE \
+			-c ../HandmadeMath.c ../hmm_test.c \
+			-lm \
+		&& $(CC) -ohmm_test_c HandmadeMath.o hmm_test.o -lm
+
+build_cpp_without_coverage: HandmadeMath.cpp test_impl
+	@echo "\nCompiling in C++ mode (no SSE)"
+	mkdir -p $(BUILD_DIR)
+	cd $(BUILD_DIR) \
+		&& $(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_no_sse \
+			-DHANDMADE_MATH_CPP_MODE -DWITHOUT_COVERAGE \
+			../HandmadeMath.cpp ../hmm_test.cpp
+
+build_cpp_different_prefix: HandmadeMath.cpp
+	@echo "\nCompiling C++ with different prefix"
+	mkdir -p $(BUILD_DIR)
+	cd $(BUILD_DIR) \
+		&& $(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_different_prefix \
+			-DHANDMADE_MATH_CPP_MODE -DDIFFERENT_PREFIX \
+			../HandmadeMathDifferentPrefix.cpp

test/README.md

@@ -4,8 +4,13 @@ You can compile and run the tests yourself by running:
 
 ```
 make
-build/hmm_test_c
-build/hmm_test_c_no_sse
-build/hmm_test_cpp
-build/hmm_test_cpp_no_sse
+```
+
+To run a specific test configuration, run one of:
+
+```
+make c
+make c_no_sse
+make cpp
+make cpp_no_sse
 ```

test/categories/Addition.h

@@ -37,7 +37,7 @@ TEST(Addition, Vec3)
         hmm_vec3 result = HMM_AddVec3(v3_1, v3_2);
         EXPECT_FLOAT_EQ(result.X, 5.0f);
         EXPECT_FLOAT_EQ(result.Y, 7.0f);
-        EXPECT_FLOAT_EQ(result.Z, 9.0f);    
+        EXPECT_FLOAT_EQ(result.Z, 9.0f);
     }
 #ifdef __cplusplus
     {
@@ -64,7 +64,7 @@ TEST(Addition, Vec4)
 {
     hmm_vec4 v4_1 = HMM_Vec4(1.0f, 2.0f, 3.0f, 4.0f);
     hmm_vec4 v4_2 = HMM_Vec4(5.0f, 6.0f, 7.0f, 8.0f);
-    
+
     {
         hmm_vec4 result = HMM_AddVec4(v4_1, v4_2);
         EXPECT_FLOAT_EQ(result.X, 6.0f);

test/categories/Equality.h

@@ -15,6 +15,9 @@ TEST(Equality, Vec2)
 
     EXPECT_TRUE(a == b);
     EXPECT_FALSE(a == c);
+
+    EXPECT_FALSE(a != b);
+    EXPECT_TRUE(a != c);
 #endif
 }
 
@@ -33,6 +36,9 @@ TEST(Equality, Vec3)
 
     EXPECT_TRUE(a == b);
     EXPECT_FALSE(a == c);
+
+    EXPECT_FALSE(a != b);
+    EXPECT_TRUE(a != c);
 #endif
 }
 
@@ -51,5 +57,8 @@ TEST(Equality, Vec4)
 
     EXPECT_TRUE(a == b);
     EXPECT_FALSE(a == c);
+
+    EXPECT_FALSE(a != b);
+    EXPECT_TRUE(a != c);
 #endif
 }

test/categories/Initialization.h

@@ -4,9 +4,9 @@ TEST(Initialization, Vectors)
 {
     //
     // Test vec2
-    // 
+    //
     hmm_vec2 v2 = HMM_Vec2(1.0f, 2.0f);
-    hmm_vec2 v2i = HMM_Vec2(1, 2);
+    hmm_vec2 v2i = HMM_Vec2i(1, 2);
 
     EXPECT_FLOAT_EQ(v2.X, 1.0f);
     EXPECT_FLOAT_EQ(v2.Y, 2.0f);

test/categories/Projection.h

@@ -15,21 +15,21 @@ TEST(Projection, Orthographic)
 
 TEST(Projection, Perspective)
 {
-    hmm_mat4 projection = HMM_Perspective(90.0f, 2.0f, 5.0f, 15.0f);
+    hmm_mat4 projection = HMM_Perspective(HMM_ToRadians(90.0f), 2.0f, 5.0f, 15.0f);
 
     {
         hmm_vec3 original = HMM_Vec3(5.0f, 5.0f, -15.0f);
         hmm_vec4 projected = HMM_MultiplyMat4ByVec4(projection, HMM_Vec4v(original, 1));
-        EXPECT_FLOAT_EQ(projected.X, 5.0f);
-        EXPECT_FLOAT_EQ(projected.Y, 10.0f);
+        EXPECT_FLOAT_EQ(projected.X, 2.5f);
+        EXPECT_FLOAT_EQ(projected.Y, 5.0f);
         EXPECT_FLOAT_EQ(projected.Z, 15.0f);
         EXPECT_FLOAT_EQ(projected.W, 15.0f);
     }
     {
         hmm_vec3 original = HMM_Vec3(5.0f, 5.0f, -5.0f);
         hmm_vec4 projected = HMM_MultiplyMat4ByVec4(projection, HMM_Vec4v(original, 1));
-        EXPECT_FLOAT_EQ(projected.X, 5.0f);
-        EXPECT_FLOAT_EQ(projected.Y, 10.0f);
+        EXPECT_FLOAT_EQ(projected.X, 2.5f);
+        EXPECT_FLOAT_EQ(projected.Y, 5.0f);
         EXPECT_FLOAT_EQ(projected.Z, -5.0f);
         EXPECT_FLOAT_EQ(projected.W, 5.0f);
     }

test/categories/QuaternionOps.h

@@ -76,7 +76,7 @@ TEST(QuaternionOps, Slerp)
     EXPECT_FLOAT_EQ(result.W, 0.86602540f);
 }
 
-TEST(QuaternionOps, ToMat4)
+TEST(QuaternionOps, QuatToMat4)
 {
     const float abs_error = 0.0001f;
 
@@ -105,6 +105,67 @@ TEST(QuaternionOps, ToMat4)
     EXPECT_NEAR(result.Elements[3][3], 1.0f, abs_error);
 }
 
+TEST(QuaternionOps, Mat4ToQuat)
+{
+    const float abs_error = 0.0001f;
+
+    // Rotate 90 degrees on the X axis
+    {
+        hmm_mat4 m = HMM_Rotate(HMM_ToRadians(90.0f), HMM_Vec3(1, 0, 0));
+        hmm_quaternion result = HMM_Mat4ToQuaternion(m);
+
+        float cosf = 0.707107f; // cos(90/2 degrees)
+        float sinf = 0.707107f; // sin(90/2 degrees)
+
+        EXPECT_NEAR(result.X, sinf, abs_error);
+        EXPECT_NEAR(result.Y, 0.0f, abs_error);
+        EXPECT_NEAR(result.Z, 0.0f, abs_error);
+        EXPECT_NEAR(result.W, cosf, abs_error);
+    }
+
+    // Rotate 90 degrees on the Y axis (axis not normalized, just for fun)
+    {
+        hmm_mat4 m = HMM_Rotate(HMM_ToRadians(90.0f), HMM_Vec3(0, 2, 0));
+        hmm_quaternion result = HMM_Mat4ToQuaternion(m);
+
+        float cosf = 0.707107f; // cos(90/2 degrees)
+        float sinf = 0.707107f; // sin(90/2 degrees)
+
+        EXPECT_NEAR(result.X, 0.0f, abs_error);
+        EXPECT_NEAR(result.Y, sinf, abs_error);
+        EXPECT_NEAR(result.Z, 0.0f, abs_error);
+        EXPECT_NEAR(result.W, cosf, abs_error);
+    }
+
+    // Rotate 90 degrees on the Z axis
+    {
+        hmm_mat4 m = HMM_Rotate(HMM_ToRadians(90.0f), HMM_Vec3(0, 0, 1));
+        hmm_quaternion result = HMM_Mat4ToQuaternion(m);
+
+        float cosf = 0.707107f; // cos(90/2 degrees)
+        float sinf = 0.707107f; // sin(90/2 degrees)
+
+        EXPECT_NEAR(result.X, 0.0f, abs_error);
+        EXPECT_NEAR(result.Y, 0.0f, abs_error);
+        EXPECT_NEAR(result.Z, sinf, abs_error);
+        EXPECT_NEAR(result.W, cosf, abs_error);
+    }
+
+    // Rotate 45 degrees on the X axis (this hits case 4)
+    {
+        hmm_mat4 m = HMM_Rotate(HMM_ToRadians(45.0f), HMM_Vec3(1, 0, 0));
+        hmm_quaternion result = HMM_Mat4ToQuaternion(m);
+
+        float cosf = 0.9238795325f; // cos(90/2 degrees)
+        float sinf = 0.3826834324f; // sin(90/2 degrees)
+
+        EXPECT_NEAR(result.X, sinf, abs_error);
+        EXPECT_NEAR(result.Y, 0.0f, abs_error);
+        EXPECT_NEAR(result.Z, 0.0f, abs_error);
+        EXPECT_NEAR(result.W, cosf, abs_error);
+    }
+}
+
 TEST(QuaternionOps, FromAxisAngle)
 {
     hmm_vec3 axis = HMM_Vec3(1.0f, 0.0f, 0.0f);
@@ -115,4 +176,4 @@ TEST(QuaternionOps, FromAxisAngle)
     EXPECT_FLOAT_EQ(result.Y, 0.0f);
     EXPECT_FLOAT_EQ(result.Z, 0.0f);
     EXPECT_NEAR(result.W, 0.707107f, FLT_EPSILON * 2);
-}
+}

test/categories/SSE.h

@@ -7,33 +7,33 @@ TEST(SSE, LinearCombine)
     hmm_mat4 MatrixOne = HMM_Mat4d(2.0f);
     hmm_mat4 MatrixTwo = HMM_Mat4d(4.0f);
     hmm_mat4 Result;
-    
+
     Result.Columns[0] = HMM_LinearCombineSSE(MatrixOne.Columns[0], MatrixTwo);
     Result.Columns[1] = HMM_LinearCombineSSE(MatrixOne.Columns[1], MatrixTwo);
     Result.Columns[2] = HMM_LinearCombineSSE(MatrixOne.Columns[2], MatrixTwo);
     Result.Columns[3] = HMM_LinearCombineSSE(MatrixOne.Columns[3], MatrixTwo);
-    
+
     {
         EXPECT_FLOAT_EQ(Result.Elements[0][0], 8.0f);
         EXPECT_FLOAT_EQ(Result.Elements[0][1], 0.0f);
         EXPECT_FLOAT_EQ(Result.Elements[0][2], 0.0f);
         EXPECT_FLOAT_EQ(Result.Elements[0][3], 0.0f);
-                        
+
         EXPECT_FLOAT_EQ(Result.Elements[1][0], 0.0f);
-        EXPECT_FLOAT_EQ(Result.Elements[1][1], 8.0f);                
+        EXPECT_FLOAT_EQ(Result.Elements[1][1], 8.0f);
         EXPECT_FLOAT_EQ(Result.Elements[1][2], 0.0f);
         EXPECT_FLOAT_EQ(Result.Elements[1][3], 0.0f);
-                        
+
         EXPECT_FLOAT_EQ(Result.Elements[2][0], 0.0f);
-        EXPECT_FLOAT_EQ(Result.Elements[2][1], 0.0f);                
+        EXPECT_FLOAT_EQ(Result.Elements[2][1], 0.0f);
         EXPECT_FLOAT_EQ(Result.Elements[2][2], 8.0f);
         EXPECT_FLOAT_EQ(Result.Elements[2][3], 0.0f);
 
         EXPECT_FLOAT_EQ(Result.Elements[3][0], 0.0f);
-        EXPECT_FLOAT_EQ(Result.Elements[3][1], 0.0f);                
+        EXPECT_FLOAT_EQ(Result.Elements[3][1], 0.0f);
         EXPECT_FLOAT_EQ(Result.Elements[3][2], 0.0f);
-        EXPECT_FLOAT_EQ(Result.Elements[3][3], 8.0f);                
-    }   
+        EXPECT_FLOAT_EQ(Result.Elements[3][3], 8.0f);
+    }
 }
 
 #endif

test/categories/ScalarMath.h

@@ -24,10 +24,25 @@ TEST(ScalarMath, Trigonometry)
     EXPECT_NEAR(HMM_TanF(HMM_PI32), 0.0f, trigAbsError);
     EXPECT_NEAR(HMM_TanF(-HMM_PI32 / 4), -1.0f, trigAbsError);
 
+    EXPECT_NEAR(HMM_ATanF(0.0f), 0.0f, trigAbsError);
+    EXPECT_NEAR(HMM_ATanF(HMM_PI32), 1.2626272557f, trigAbsError);
+    EXPECT_NEAR(HMM_ATanF(-HMM_PI32), -1.2626272557f, trigAbsError);
+
+    EXPECT_NEAR(HMM_ATan2F(0.0f, 1.0f), 0.0f, trigAbsError);
+    EXPECT_NEAR(HMM_ATan2F(1.0f, 1.0f), HMM_PI32 / 4.0f, trigAbsError);
+    EXPECT_NEAR(HMM_ATan2F(1.0f, 0.0f), HMM_PI32 / 2.0f, trigAbsError);
+
     // This isn't the most rigorous because we're really just sanity-
     // checking that things work by default.
 }
 
+TEST(ScalarMath, ToDegrees)
+{
+    EXPECT_FLOAT_EQ(HMM_ToDegrees(0.0f), 0.0f);
+    EXPECT_FLOAT_EQ(HMM_ToDegrees(HMM_PI32), 180.0f);
+    EXPECT_FLOAT_EQ(HMM_ToDegrees(-HMM_PI32), -180.0f);
+}
+
 TEST(ScalarMath, ToRadians)
 {
     EXPECT_FLOAT_EQ(HMM_ToRadians(0.0f), 0.0f);
@@ -35,6 +50,18 @@ TEST(ScalarMath, ToRadians)
     EXPECT_FLOAT_EQ(HMM_ToRadians(-180.0f), -HMM_PI32);
 }
 
+TEST(ScalarMath, ExpF)
+{
+    EXPECT_NEAR(HMM_ExpF(0.0f), 1.0f, 0.0001f);
+    EXPECT_NEAR(HMM_ExpF(1.0f), 2.7182818285f, 0.0001f);
+}
+
+TEST(ScalarMath, LogF)
+{
+    EXPECT_NEAR(HMM_LogF(1.0f), 0.0f, 0.0001f);
+    EXPECT_NEAR(HMM_LogF(2.7182818285f), 1.0f, 0.0001f);
+}
+
 TEST(ScalarMath, SquareRoot)
 {
     EXPECT_FLOAT_EQ(HMM_SquareRootF(16.0f), 4.0f);
@@ -48,27 +75,27 @@ TEST(ScalarMath, RSquareRootF)
 TEST(ScalarMath, Power)
 {
     EXPECT_FLOAT_EQ(HMM_Power(2.0f, 0), 1.0f);
-    EXPECT_FLOAT_EQ(HMM_Power(2.0f, 4), 16.0f);       
+    EXPECT_FLOAT_EQ(HMM_Power(2.0f, 4), 16.0f);
     EXPECT_FLOAT_EQ(HMM_Power(2.0f, -2), 0.25f);
 }
 
 TEST(ScalarMath, PowerF)
 {
-    EXPECT_FLOAT_EQ(HMM_PowerF(2.0f, 0), 1.0f);
-    EXPECT_NEAR(HMM_PowerF(2.0f, 4.1), 17.148376f, 0.0001f);
-    EXPECT_NEAR(HMM_PowerF(2.0f, -2.5), 0.176777f, 0.0001f);
+    EXPECT_FLOAT_EQ(HMM_PowerF(2.0f, 0.0f), 1.0f);
+    EXPECT_NEAR(HMM_PowerF(2.0f, 4.1f), 17.148376f, 0.0001f);
+    EXPECT_NEAR(HMM_PowerF(2.0f, -2.5f), 0.176777f, 0.0001f);
 }
 
 TEST(ScalarMath, Lerp)
 {
-    EXPECT_FLOAT_EQ(HMM_Lerp(-2.0f, 0.0f, 2.0f), -2.0f);        
-    EXPECT_FLOAT_EQ(HMM_Lerp(-2.0f, 0.5f, 2.0f), 0.0f);        
+    EXPECT_FLOAT_EQ(HMM_Lerp(-2.0f, 0.0f, 2.0f), -2.0f);
+    EXPECT_FLOAT_EQ(HMM_Lerp(-2.0f, 0.5f, 2.0f), 0.0f);
     EXPECT_FLOAT_EQ(HMM_Lerp(-2.0f, 1.0f, 2.0f), 2.0f);
 }
 
 TEST(ScalarMath, Clamp)
 {
-    EXPECT_FLOAT_EQ(HMM_Clamp(-2.0f, 0.0f, 2.0f), 0.0f);        
-    EXPECT_FLOAT_EQ(HMM_Clamp(-2.0f, -3.0f, 2.0f), -2.0f);        
+    EXPECT_FLOAT_EQ(HMM_Clamp(-2.0f, 0.0f, 2.0f), 0.0f);
+    EXPECT_FLOAT_EQ(HMM_Clamp(-2.0f, -3.0f, 2.0f), -2.0f);
     EXPECT_FLOAT_EQ(HMM_Clamp(-2.0f, 3.0f, 2.0f), 2.0f);
 }

test/categories/Transformation.h

@@ -17,21 +17,23 @@ TEST(Transformations, Rotate)
 {
     hmm_vec3 original = HMM_Vec3(1.0f, 1.0f, 1.0f);
 
-    hmm_mat4 rotateX = HMM_Rotate(90, HMM_Vec3(1, 0, 0));
+    float angle = HMM_ToRadians(90.0f);
+
+    hmm_mat4 rotateX = HMM_Rotate(angle, HMM_Vec3(1, 0, 0));
     hmm_vec4 rotatedX = HMM_MultiplyMat4ByVec4(rotateX, HMM_Vec4v(original, 1));
     EXPECT_FLOAT_EQ(rotatedX.X, 1.0f);
     EXPECT_FLOAT_EQ(rotatedX.Y, -1.0f);
     EXPECT_FLOAT_EQ(rotatedX.Z, 1.0f);
     EXPECT_FLOAT_EQ(rotatedX.W, 1.0f);
 
-    hmm_mat4 rotateY = HMM_Rotate(90, HMM_Vec3(0, 1, 0));
+    hmm_mat4 rotateY = HMM_Rotate(angle, HMM_Vec3(0, 1, 0));
     hmm_vec4 rotatedY = HMM_MultiplyMat4ByVec4(rotateY, HMM_Vec4v(original, 1));
     EXPECT_FLOAT_EQ(rotatedY.X, 1.0f);
     EXPECT_FLOAT_EQ(rotatedY.Y, 1.0f);
     EXPECT_FLOAT_EQ(rotatedY.Z, -1.0f);
     EXPECT_FLOAT_EQ(rotatedY.W, 1.0f);
 
-    hmm_mat4 rotateZ = HMM_Rotate(90, HMM_Vec3(0, 0, 1));
+    hmm_mat4 rotateZ = HMM_Rotate(angle, HMM_Vec3(0, 0, 1));
     hmm_vec4 rotatedZ = HMM_MultiplyMat4ByVec4(rotateZ, HMM_Vec4v(original, 1));
     EXPECT_FLOAT_EQ(rotatedZ.X, -1.0f);
     EXPECT_FLOAT_EQ(rotatedZ.Y, 1.0f);

test/categories/VectorOps.h

@@ -3,7 +3,7 @@
 TEST(VectorOps, LengthSquared)
 {
     hmm_vec2 v2 = HMM_Vec2(1.0f, -2.0f);
-    hmm_vec3 v3 = HMM_Vec3(1.0f, -2.0f, 3.0f); 
+    hmm_vec3 v3 = HMM_Vec3(1.0f, -2.0f, 3.0f);
     hmm_vec4 v4 = HMM_Vec4(1.0f, -2.0f, 3.0f, 1.0f);
 
     EXPECT_FLOAT_EQ(HMM_LengthSquaredVec2(v2), 5.0f);
@@ -37,7 +37,7 @@ TEST(VectorOps, Length)
 TEST(VectorOps, Normalize)
 {
     hmm_vec2 v2 = HMM_Vec2(1.0f, -2.0f);
-    hmm_vec3 v3 = HMM_Vec3(1.0f, -2.0f, 3.0f); 
+    hmm_vec3 v3 = HMM_Vec3(1.0f, -2.0f, 3.0f);
     hmm_vec4 v4 = HMM_Vec4(1.0f, -2.0f, 3.0f, -1.0f);
 
     {

test/hmm_test.c

@@ -1,7 +1,9 @@
-#include "HandmadeTest.h"
 #include "hmm_test.h"
 
 int main()
 {
-    return hmt_run_all_tests();
+    int tests_failed = hmt_run_all_tests();
+    int coverage_failed = hmt_check_all_coverage();
+
+    return tests_failed || coverage_failed;
 }

test/hmm_test.h

@@ -1,6 +1,9 @@
 #include <float.h>
 
+#define HANDMADE_TEST_IMPLEMENTATION
 #include "HandmadeTest.h"
+
+#undef COVERAGE // Make sure we don't double-define initializers from the header part
 #include "../HandmadeMath.h"
 
 #include "categories/ScalarMath.h"

test/test.bat

@@ -0,0 +1,27 @@
+@echo off
+
+if "%1%"=="travis" (
+    call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\Tools\VsDevCmd.bat" -host_arch=amd64 -arch=amd64
+) else (
+    where /q cl
+    if ERRORLEVEL 1 (
+        for /f "delims=" %%a in ('"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -find VC\Auxiliary\Build\vcvarsall.bat') do (%%a x64)
+    )
+)
+
+if not exist "build" mkdir build
+pushd build
+
+cl /Fehmm_test_c.exe ..\HandmadeMath.c ..\hmm_test.c || popd && exit /B
+hmm_test_c
+
+cl /Fehmm_test_c_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.c ..\hmm_test.c || popd && exit /B
+hmm_test_c_no_sse
+
+cl /Fehmm_test_cpp.exe ..\HandmadeMath.cpp ..\hmm_test.cpp || popd && exit /B
+hmm_test_cpp
+
+cl /Fehmm_test_cpp_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.cpp ..\hmm_test.cpp || popd && exit /B
+hmm_test_cpp_no_sse
+
+popd