Convert everything to new inline scheme (#57) (#72)

* Convert everything to new inline scheme

* Add both extern and inline for some SSE vs. non-SSE functions

Some functions had nice, compact SSE implementations but bulky non-SSE
implementations, so this commit inlines just the implementations that make
sense. Also updated documentation.

* Convert HINLINE and HEXTERN to HMM_INLINE and HMM_EXTERN

.gitignore

@@ -32,3 +32,4 @@
 *.out
 *.app
 hmm_test
+hmm_test*

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "externals/googletest"]
-	path = externals/googletest
-	url = https://github.com/google/googletest.git

.travis.yml

@@ -5,4 +5,8 @@ compiler:
 install:
   - cd test
   - make
-script: ./hmm_test
+script:
+  - ./hmm_test_c
+  - ./hmm_test_c_no_sse
+  - ./hmm_test_cpp
+  - ./hmm_test_cpp_no_sse

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# 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.
+
+# Quick style guide
+
+* Put braces on a new line
+* Float literals should have digits both before and after the decimal.
+  ```cpp
+  // Good
+  0.0f;
+  0.5f;
+  1.0f;
+  3.14159f;
+  
+  // Bad
+  1.f
+  .0f
+  ```
+* Put parentheses around the returned value:
+  ```cpp
+  HINLINE float
+  HMM_MyFunction()
+  {
+      return (1.0f);
+  }
+  ```
+
+
+## Other style notes
+
+* If a new function is defined with different names for different datatypes, also add C++ overloaded versions of the functions. For example, if you have `HMM_LengthVec2(hmm_vec2)` and `HMM_LengthVec3(hmm_vec3)`, also provide `HMM_Length(hmm_vec2)` and `HMM_Length(hmm_vec3)`.
+
+  It is fine for the overloaded versions to call the C versions.
+* Only use operator overloading for analogous operators in C. That means `+` for vector addition is fine, but no using `^` for cross product or `|` for dot product.
+* Try to define functions in the same order as the prototypes.
+* Don't forget that Handmade Math uses column-major order for matrices!
+
+# Versioning
+
+We use [semantic versioning](http://semver.org/) because it's reasonable.

README.md

@@ -3,7 +3,9 @@
 
 [![Build Status](https://travis-ci.org/StrangeZak/Handmade-Math.svg?branch=master)](https://travis-ci.org/StrangeZak/Handmade-Math)
 
-Single-file cross-platform public domain game math library for C/C++
+A single-file, cross-platform, public domain game math library for C/C++.
+
+To get started, go download [the latest release](https://github.com/HandmadeMath/Handmade-Math/releases).
 
 _This library is free and will stay free, but if you would like to support development, or you are a company using HandmadeMath, please consider financial support._
 
@@ -12,6 +14,15 @@ _This library is free and will stay free, but if you would like to support devel
 
 Version         | Changes        | 
 ----------------|----------------|
+**1.5.0** | Changed internal structure for better performance and inlining. As a result, `HANDMADE_MATH_NO_INLINE` has been removed and no longer has any effect.
+**1.4.0** | Fixed bug when using C mode. SSE'd all vec4 operations. Removed zeroing for better performance.
+**1.3.0** | Removed need to `#define HANDMADE_MATH_CPP_MODE`. C++ definitions are now included automatically in C++ environments.
+**1.2.0** | Added equality functions for `HMM_Vec2`, `HMM_Vec3`, and `HMM_Vec4`, and SSE'd `HMM_MultiplyMat4` and `HMM_Transpose`.
+**1.1.5** | Added `Width` and `Height` to `HMM_Vec2`, and made it so you can supply your own `SqrtF`.
+**1.1.4** | Fixed SSE being included on platforms that don't support it, and fixed divide-by-zero errors when normalizing zero vectors.
+**1.1.3** | Fixed compile error in C mode
+**1.1.2** | Fixed invalid HMMDEF's in the function definitions
+**1.1.1** | Resolved compiler warnings on gcc and g++
 **1.1**   | Quaternions! |
 **1.0**   | Lots of testing |
 **0.7**   | Added HMM_Vec2, and HMM_Vec4 versions of  HMM_LengthSquared, HMM_Length, and HMM_Normalize.   |
@@ -33,8 +44,8 @@ _This library is free and will stay free, but if you would like to support devel
 
 **What's the license?**
 
-This library is in the public domain. You can do whatever you want with them.
+This library is in the public domain. You can do whatever you want with it.
 
 **Where can I contact you to ask questions?**
 
-You can email me at: Zak@Handmade.Network
+Feel free to make Github issues for any questions, concerns, or problems you encounter.

test/HandmadeMath.c

@@ -0,0 +1,3 @@
+#define HANDMADE_MATH_IMPLEMENTATION
+#define HANDMADE_MATH_NO_INLINE
+#include "../HandmadeMath.h"

test/HandmadeMath.cpp

@@ -1,5 +1,2 @@
-
-#define HANDMADE_MATH_IMPLEMENTATION
-#define HANDMADE_MATH_CPP_MODE
-#define HANDMADE_MATH_NO_INLINE
-#include "../HandmadeMath.h"
+#include "HandmadeMath.c"
+// C++ compilers complain when compiling a .c file...

test/HandmadeTest.h

@@ -0,0 +1,104 @@
+#ifndef HANDMADETEST_H
+#define HANDMADETEST_H
+
+#include <float.h>
+#include <stdio.h>
+
+int hmt_count_tests = 0;
+int hmt_count_failedtests = 0;
+int hmt_count_failures = 0;
+
+#define RESET "\033[0m"
+#define RED   "\033[31m"
+#define GREEN "\033[32m"
+
+#define CATEGORY_BEGIN(name) { \
+    int count_categorytests = 0; \
+    int count_categoryfailedtests = 0; \
+    int count_categoryfailures = 0; \
+    printf("\n" #name ":\n");
+#define CATEGORY_END(name) \
+    hmt_count_tests += count_categorytests; \
+    hmt_count_failedtests += count_categoryfailedtests; \
+    hmt_count_failures += count_categoryfailures; \
+    printf("%d/%d tests passed, %d failures\n", count_categorytests - count_categoryfailedtests, count_categorytests, count_categoryfailures); \
+}
+
+#define TEST_BEGIN(name) { \
+    int count_testcases = 0, count_testfailures = 0; \
+    count_categorytests++; \
+    printf("    " #name ":");
+#define TEST_END() \
+    count_categoryfailures += count_testfailures; \
+    if (count_testfailures > 0) { \
+        count_categoryfailedtests++; \
+        printf("\n      " RED "(%d/%d passed)" RESET, count_testcases - count_testfailures, count_testcases); \
+        printf("\n"); \
+    } else { \
+        printf(GREEN " [PASS] (%d/%d passed) \n" RESET, count_testcases - count_testfailures, count_testcases); \
+    } \
+}
+
+#define CASE_START() \
+    count_testcases++;
+
+#define CASE_FAIL() \
+    count_testfailures++; \
+    printf("\n      - " RED "[FAIL] (%d) " RESET, __LINE__);
+
+/*
+ * Asserts and expects
+ */
+#define EXPECT_TRUE(_actual) do { \
+    CASE_START(); \
+    if (!(_actual)) { \
+        CASE_FAIL(); \
+        printf("Expected true but got something false"); \
+    } \
+} while (0)
+
+#define EXPECT_FALSE(_actual) do { \
+    CASE_START(); \
+    if (_actual) { \
+        CASE_FAIL(); \
+        printf("Expected false but got something true"); \
+    } \
+} while (0)
+
+#define EXPECT_FLOAT_EQ(_actual, _expected) do { \
+    CASE_START(); \
+    float actual = (_actual); \
+    float diff = actual - (_expected); \
+    if (diff < -FLT_EPSILON || FLT_EPSILON < diff) { \
+        CASE_FAIL(); \
+        printf("Expected %f, got %f", (_expected), actual); \
+    } \
+} while (0)
+
+#define EXPECT_NEAR(_actual, _expected, _epsilon) do { \
+    CASE_START(); \
+    float actual = (_actual); \
+    float diff = actual - (_expected); \
+    if (diff < -(_epsilon) || (_epsilon) < diff) { \
+        CASE_FAIL(); \
+        printf("Expected %f, got %f", (_expected), actual); \
+    } \
+} while (0)
+
+#define EXPECT_LT(_actual, _expected) do { \
+    CASE_START(); \
+    if ((_actual) >= (_expected)) { \
+        CASE_FAIL(); \
+        printf("Expected %f to be less than %f", (_actual), (_expected)); \
+    } \
+} while (0)
+
+#define EXPECT_GT(_actual, _expected) do { \
+    CASE_START(); \
+    if ((_actual) <= (_expected)) { \
+        CASE_FAIL(); \
+        printf("Expected %f to be greater than %f", (_actual), (_expected)); \
+    } \
+} while (0)
+
+#endif

test/Makefile

@@ -1,81 +1,37 @@
-# A sample Makefile for building Google Test and using it in user
-# tests.  Please tweak it to suit your environment and project.  You
-# may want to move it to your project's root directory.
-#
-# SYNOPSIS:
-#
-#   make [all]  - makes everything.
-#   make TARGET - makes the given target.
-#   make clean  - removes all files generated by make.
+ROOT_DIR=..
 
-# Please tweak the following variable definitions as needed by your
-# project, except GTEST_HEADERS, which you can use in your own targets
-# but shouldn't modify.
+CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
 
-# Points to the root of Google Test, relative to where this file is.
-# Remember to tweak this if you move this file.
-GTEST_DIR = ../externals/googletest/googletest
+all: c c_no_sse cpp cpp_no_sse
 
-# Where to find user code.
-USER_DIR = ..
+clean:
+	rm -f hmm_test_c hmm_test_cpp hmm_test_c_no_sse hmm_test_cpp_no_sse *.o
 
-# Flags passed to the preprocessor.
-# Set Google Test's header directory as a system directory, such that
-# the compiler doesn't generate warnings in Google Test headers.
-CPPFLAGS += -isystem $(GTEST_DIR)/include
+c: $(ROOT_DIR)/test/HandmadeMath.c test_impl
+	@echo "\nCompiling in C mode"
+	$(CC) $(CPPFLAGS) $(CXXFLAGS) -std=c99 \
+		-c $(ROOT_DIR)/test/HandmadeMath.c $(ROOT_DIR)/test/hmm_test.c \
+		-lm
+	$(CC) -ohmm_test_c HandmadeMath.o hmm_test.o -lm
 
-# Flags passed to the C++ compiler.
-CXXFLAGS += -g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
+c_no_sse: $(ROOT_DIR)/test/HandmadeMath.c test_impl
+	@echo "\nCompiling in C mode (no SSE)"
+	$(CC) $(CPPFLAGS) $(CXXFLAGS) -std=c99 \
+	    -DHANDMADE_MATH_NO_SSE \
+	    -c $(ROOT_DIR)/test/HandmadeMath.c $(ROOT_DIR)/test/hmm_test.c \
+	    -lm
+	$(CC) -ohmm_test_c_no_sse HandmadeMath.o hmm_test.o -lm
 
-# All tests produced by this Makefile.  Remember to add new tests you
-# created to the list.
-TESTS = hmm_test
+cpp: $(ROOT_DIR)/test/HandmadeMath.cpp test_impl
+	@echo "\nCompiling in C++ mode"
+	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp \
+		-DHANDMADE_MATH_CPP_MODE \
+		$(ROOT_DIR)/test/HandmadeMath.cpp $(ROOT_DIR)/test/hmm_test.cpp
 
-# All Google Test headers.  Usually you shouldn't change this
-# definition.
-GTEST_HEADERS = $(GTEST_DIR)/include/gtest/*.h \
-                $(GTEST_DIR)/include/gtest/internal/*.h
+cpp_no_sse: $(ROOT_DIR)/test/HandmadeMath.cpp test_impl
+	@echo "\nCompiling in C++ mode (no SSE)"
+	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_no_sse \
+		-DHANDMADE_MATH_CPP_MODE -DHANDMADE_MATH_NO_SSE \
+		$(ROOT_DIR)/test/HandmadeMath.cpp $(ROOT_DIR)/test/hmm_test.cpp
 
-# House-keeping build targets.
-
-all : $(TESTS)
-
-clean :
-	rm -f $(TESTS) gtest.a gtest_main.a *.o
-
-# Builds gtest.a and gtest_main.a.
-
-# Usually you shouldn't tweak such internal variables, indicated by a
-# trailing _.
-GTEST_SRCS_ = $(GTEST_DIR)/src/*.cc $(GTEST_DIR)/src/*.h $(GTEST_HEADERS)
-
-# For simplicity and to avoid depending on Google Test's
-# implementation details, the dependencies specified below are
-# conservative and not optimized.  This is fine as Google Test
-# compiles fast and for ordinary users its source rarely changes.
-gtest-all.o : $(GTEST_SRCS_)
-	$(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
-            $(GTEST_DIR)/src/gtest-all.cc
-
-gtest_main.o : $(GTEST_SRCS_)
-	$(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
-            $(GTEST_DIR)/src/gtest_main.cc
-
-gtest.a : gtest-all.o
-	$(AR) $(ARFLAGS) $@ $^
-
-gtest_main.a : gtest-all.o gtest_main.o
-	$(AR) $(ARFLAGS) $@ $^
-
-# Builds a sample test.  A test should link with either gtest.a or
-# gtest_main.a, depending on whether it defines its own main()
-# function.
-
-HandmadeMath.o : $(USER_DIR)/test/HandmadeMath.cpp $(USER_DIR)/HandmadeMath.h $(GTEST_HEADERS)
-	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/test/HandmadeMath.cpp
-
-hmm_test.o : $(USER_DIR)/test/hmm_test.cpp $(GTEST_HEADERS)
-	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/test/hmm_test.cpp
-
-hmm_test : HandmadeMath.o hmm_test.o gtest_main.a
-	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -lpthread $^ -o $@
+test_impl: $(ROOT_DIR)/test/hmm_test.cpp $(ROOT_DIR)/test/hmm_test.c

test/README.md

@@ -0,0 +1,11 @@
+# Testing
+
+You can compile and run the tests yourself by running:
+
+```
+make
+./hmm_test_c
+./hmm_test_c_no_sse
+./hmm_test_cpp
+./hmm_test_cpp_no_sse
+```