Rename CSTest to MinCTest; is more to-the-point

1 files changed, 78 insertions, 0 deletions

diff --git a/minctest.h b/minctest.h
new file mode 100644
index 0000000..260b36e
--- /dev/null
+++ b/minctest.h
@@ -0,0 +1,78 @@
+/**
+ * MinCTest - Minimalistic C unit test framework
+ * Copyright (C) 2015  Camil Staps
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <inttypes.h>
+#include <stdbool.h>
+
+typedef struct {
+    uint16_t passed; // Number of passed tests
+    uint16_t failed; // Number of failed tests
+    bool show_pass;  // Whether or not to print a message when a test passes
+} tester;
+
+/**
+ * Initialize a tester struct
+ *
+ * This allocates a tester on the heap. Don't forget to call test_destroy to
+ * free that memory.
+ *
+ * @return a struct on the heap for use in the other test_* functions
+ */
+tester* test_initialize(void);
+
+/**
+ * Show summarised data about the tester
+ *
+ * Shows a green message when all tests passed, otherwise a red message that
+ * some failed. Shows passed/failed counts as well.
+ *
+ * @param tester* a pointer to a tester from test_initialize
+ */
+void test_wrapup(tester*);
+
+/**
+ * Destroy a tester struct
+ *
+ * Essentially frees the memory that was allocated for the struct.
+ *
+ * @param tester* a pointer to a tester from test_initialize
+ */
+void test_destroy(tester*);
+
+/**
+ * Exit the program with an appropriate return value
+ *
+ * Returns -1 if one or more tests failed, 0 otherwise. Exits the program.
+ *
+ * @param tester* a pointer to a tester from test_initialize
+ * @return don't expect this to return
+ */
+void test_exit(tester*);
+
+/**
+ * Test for truth on a bool
+ *
+ * Outputs a red message for failure, and a green one for passing if 
+ * tester->show_pass is true. Adds this test to the summarised data in the 
+ * tester.
+ *
+ * @param tester* a pointer to a tester from test_initialize
+ * @param check the boolean that should be true
+ * @param test a custom message to show
+ */
+void test_true(tester* tester, bool check, const char* text);
+