acknowledgement of confusing nature of tests

I think I have a problem.  Someone stop me.

9unit.c

@@ -1,68 +1,497 @@
 /*
 
 	9unit
-	Copyright (C) 2023  Jonathan Lamothe <jonathan@jlamothe.net>
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
 
 	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
+	it under the terms of the GNU Lesser General Public License as
-	the Free Software Foundation, either version 3 of the License, or (at
+	published by the Free Software Foundation, either version 3 of the
-	your option) any later version.
+	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.
+	Lesser General Public License for more details.
 
-	You should have received a copy of the GNU General Public License
+	You should have received a copy of the GNU Lesser General Public
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
 
 */
 
 #include <u.h>
+#include <libc.h>
 #include <stdio.h>
 
 #include "9unit.h"
 
-void
+// Internal Types
-initTestState(TestState *s)
+
+typedef struct RunTestWith RunTestWith;
+typedef struct RunTestCompare RunTestCompare;
+typedef struct ContextData ContextData;
+typedef struct TestContextWith TestContextWith;
+typedef struct TestContextCompare TestContextCompare;
+typedef struct SingleTestContextWith SingleTestContextWith;
+typedef struct SingleTestContextCompare SingleTestContextCompare;
+
+// data required by run_test_with()
+struct RunTestWith
 {
-	if (!s) return;
+	void *ptr; // the state's previous ptr value
-	s->run = 0;
+	TestResult (*test)(TestState *, void *); // the test
-	s->passed = 0;
+	void *val; // the value passed in
-	s->failed = 0;
+};
-	s->postponed = 0;
+
+// data needed by run_test_compare()
+struct RunTestCompare
+{
+	TestResult (*test)(TestState *, void *, void *);
+	void *val1;
+	void *val2;
+};
+
+struct ContextData
+{
+	const char *old_c; // previous context
+	const char *old_fc; // previous full context
+	const char *new_c; // new context
+	char *new_fc; // new full context
+};
+
+// data needed by test_context_with()
+struct TestContextWith
+{
+	void *ptr; // state's original ptr value
+	void (*test)(TestState *, void *); // the test function
+	void *val; // the value being passed in
+};
+
+// data needed by test_context_compare()
+struct TestContextCompare
+{
+	void (*test)(TestState *, void *, void *);
+	void *val1;
+	void *val2;
+};
+
+// data needed by single_test_context_with()
+struct SingleTestContextWith
+{
+	TestResult (*test)(TestState *, void *);
+	void *val;
+};
+
+// data needed by single_test_context_compare()
+struct SingleTestContextCompare
+{
+	TestResult (*test)(TestState *, void *, void *);
+	void *val1;
+	void *val2;
+};
+
+// Internal Prototypes
+
+static void init_TestState(TestState *);
+static void print_log(TestState *);
+static void clear_log(TestState *);
+static void reindex(TestState *);
+static void report(const char *);
+static void build_new_context(TestState *, ContextData *);
+static void display_context(TestState *);
+static void restore_context(TestState *, ContextData *);
+static TestResult run_test_with_test(TestState *);
+static TestResult run_test_compare_test(TestState *, void *);
+static void test_context_with_test(TestState *);
+static void test_context_compare_test(TestState *, void *);
+static void single_test_context_test(TestState *, void *);
+static void single_test_context_with_test(TestState *, void *);
+static TestResult single_test_context_compare_test(TestState *, void *);
+
+// Public Functions
+
+void
+run_tests(void (*tests)(TestState *))
+{
+	if (!tests) return;
+	TestState s;
+	memset(&s, 0, sizeof(TestState));
+	s.report = report;
+	(*tests)(&s);
+	print_log(&s);
+	print("\n\nTests run: %d\n", s.run);
+	print("Tests passed: %d\n", s.passed);
+	print("Tests failed: %d\n", s.failed);
+	print("Tests pending: %d\n", s.pending);
+	clear_log(&s);
+	if (s.failed) exits("test(s) failed");
 }
 
 void
-runTest(TestState *s, TestResult (*t)(void))
+append_test_log(TestState *s, const char *msg)
 {
-	if (!(s && t)) return;
+	if (!(s && msg)) return;
+
+	// build a new entry:
+	TestLogEntry *entry = malloc(sizeof(TestLogEntry));
+	entry->text = malloc(strlen(msg) + 1);
+	strcpy(entry->text, msg);
+	entry->next = 0;
+
+	// add it to the list:
+	if (!s->last_log)
+	{
+		if (s->first_log) // no last entry but we have a first?
+		{
+			reindex(s);
+			s->last_log->next = entry;
+		}
+		else s->first_log = entry;
+	}
+	else // there's already a last entry
+	{
+		if (!s->first_log) // no first entry but we have a last?
+			reindex(s); // do our best to fix that
+		s->last_log->next = entry;
+	}
+	s->last_log = entry;
+}
+
+void
+log_test_context(TestState *s)
+{
+	if (!s) return;
+	if (s->full_context) append_test_log(s, s->full_context);
+	else append_test_log(s, "<no context>");
+}
+
+void
+run_test(TestState *s, TestResult (*t)(TestState *))
+{
+	if (!s) return;
 	s->run++;
-	switch ((*t)())
+
+	// a null test function is a pending test
+	if (!t)
+	{
+		s->pending++;
+		return;
+	}
+
+	switch ((*t)(s))
 	{
 	case test_success:
 		s->passed++;
+		s->report(" [PASS]");
 		break;
 	case test_failure:
 		s->failed++;
+		s->report(" [FAIL]");
 		break;
-	case test_postponed:
+	case test_pending:
-		s->postponed++;
+		s->pending++;
+		s->report(" [PEND]");
 		break;
+	default:
+		exits("test returned an invalid response");
 	}
 }
 
 void
-runTests(void (*tests)(TestState *))
+run_test_with(
+	TestState *s, // the state
+	TestResult (*test)(TestState *, void *), // the test
+	void *val // the value being passed in
+)
 {
-	if(!tests) return;
+	if (!s) return;
-	TestState s;
+	if (!test)
-	initTestState(&s);
+	{
-	(*tests)(&s);
+		run_test(s, 0);
-	printf("Tests run: %d\n", s.run);
+		return;
-	printf("Tests passed: %d\n", s.passed);
+	}
-	printf("Tests failed: %d\n", s.failed);
+	RunTestWith d;
-	printf("Tests postponed: %d\n", s.postponed);
+	d.ptr = s->ptr;
+	d.test = test;
+	d.val = val;
+	s->ptr = &d;
+	run_test(s, run_test_with_test);
+}
+
+void
+run_test_compare(
+	TestState *s,
+	TestResult (*test)(TestState *, void *, void *),
+	void *val1,
+	void *val2
+)
+{
+	RunTestCompare d;
+	d.test = test;
+	d.val1 = val1;
+	d.val2 = val2;
+	run_test_with(s, run_test_compare_test, &d);
+}
+
+void
+test_context(
+	TestState *s,
+	const char *label,
+	void (*test)(TestState *)
+)
+{
+	if (!(s && test)) return;
+	if (label)
+	{
+		ContextData cd;
+		cd.new_c = label;
+		build_new_context(s, &cd);
+		display_context(s);
+		(*test)(s);
+		restore_context(s, &cd);
+	}
+	else (*test)(s);
+}
+
+void
+test_context_with(
+	TestState *s,
+	const char *context,
+	void (*test)(TestState *, void *),
+	void *val
+)
+{
+	if (!s) return;
+	TestContextWith d;
+	d.ptr = s->ptr;
+	d.test = test;
+	d.val = val;
+	s->ptr = &d;
+	test_context(s, context, test_context_with_test);
+}
+
+void
+test_context_compare(
+	TestState *s,
+	const char *context,
+	void (*test)(TestState *, void *, void *),
+	void *val1,
+	void *val2
+)
+{
+	TestContextCompare d;
+	d.test = test;
+	d.val1 = val1;
+	d.val2 = val2;
+	test_context_with(
+		s,
+		context,
+		test_context_compare_test,
+		&d
+	);
+}
+
+void
+single_test_context(
+	TestState *s,
+	const char *context,
+	TestResult (*test)(TestState *)
+)
+{
+	test_context_with(s, context, single_test_context_test, test);
+}
+
+void
+single_test_context_with(
+	TestState *s,
+	const char *context,
+	TestResult (*test)(TestState *, void *),
+	void *val
+)
+{
+	SingleTestContextWith d;
+	d.test = test;
+	d.val = val;
+	test_context_with(
+		s,
+		context,
+		single_test_context_with_test,
+		&d
+	);
+}
+
+void
+single_test_context_compare(
+	TestState *s,
+	const char *context,
+	TestResult (*test)(TestState *s, void *, void *),
+	void *val1,
+	void *val2
+)
+{
+	SingleTestContextCompare d;
+	d.test = test;
+	d.val1 = val1;
+	d.val2 = val2;
+	single_test_context_with(
+		s,
+		context,
+		single_test_context_compare_test,
+		&d
+	);
+}
+
+// Internal Functions
+
+static void
+print_log(TestState *s)
+{
+	if (!s) return;
+	TestLogEntry *e = s->first_log;
+	while(e)
+	{
+		if(e->text) print("\n%s", e->text);
+		else print("(empty message)\n");
+		e = e->next;
+	}
+}
+
+static void
+clear_log(TestState *s)
+{
+	if (!s) return;
+	if(s->last_log && !s->first_log) reindex(s); // fix if broken
+	TestLogEntry *e = s->first_log, *next;
+	s->first_log = 0;
+	s->last_log = 0;
+	while (e)
+	{
+		next = e->next;
+		free(e->text);
+		free(e);
+		e = next;
+	}
+}
+
+static void
+reindex(TestState *s)
+{
+	if (!s) return;
+	if (s->first_log)
+	{
+		TestLogEntry *e = s->first_log;
+		while (e)
+		{
+			s->last_log = e;
+			e = e->next;
+		}
+	}
+	else if (s->last_log) // we have a last log but no first?
+	{
+		s->first_log = s->last_log;
+		log_test_context(s);
+		append_test_log(s, "potential memory leak in test log");
+	}
+}
+
+static void
+report(const char *str)
+{
+	print("%s", str);
+}
+
+static void
+build_new_context(TestState *s, ContextData *cd)
+{
+	cd->old_c = s->context;
+	cd->old_fc = s->full_context;
+	if (s->full_context)
+	{
+		cd->new_fc = malloc(strlen(cd->old_fc) + strlen(cd->new_c) + 3);
+		sprintf(cd->new_fc, "%s: %s", cd->old_fc, cd->new_c);
+	}
+	else
+	{
+		cd->new_fc = malloc(strlen(cd->new_c) + 1);
+		strcpy(cd->new_fc, cd->new_c);
+	}
+	s->context = cd->new_c;
+	s->full_context = cd->new_fc;
+	s->depth++;
+}
+
+static void
+display_context(TestState *s)
+{
+	s->report("\n");
+	for (int i = 1; i < s->depth; i++)
+		s->report("\t");
+	s->report(s->context);
+}
+
+static void
+restore_context(TestState *s, ContextData *cd)
+{
+	s->context = cd->old_c;
+	s->full_context = cd->old_fc;
+	s->depth--;
+	free(cd->new_fc);
+}
+
+static TestResult
+run_test_with_test(TestState *s)
+{
+	RunTestWith *d = s->ptr;
+	s->ptr = d->ptr;
+	return (*d->test)(s, d->val);
+}
+
+static TestResult
+run_test_compare_test(
+	TestState *s,
+	void *ptr
+)
+{
+	RunTestCompare *d = ptr;
+	return (*d->test)(s, d->val1, d->val2);
+}
+
+static void
+test_context_with_test(TestState *s)
+{
+	TestContextWith *d = s->ptr;
+	s->ptr = d->ptr;
+	(*d->test)(s, d->val);
+}
+
+static void
+test_context_compare_test(
+	TestState *s,
+	void *ptr
+)
+{
+	TestContextCompare *d = ptr;
+	(*d->test)(s, d->val1, d->val2);
+}
+
+static void
+single_test_context_test(TestState *s, void *test)
+{
+	run_test(s, test);
+}
+
+static void
+single_test_context_with_test(TestState *s, void *ptr)
+{
+	SingleTestContextWith *d = ptr;
+	run_test_with(s, d->test, d->val);
+}
+
+static TestResult
+single_test_context_compare_test(TestState *s, void *ptr)
+{
+	SingleTestContextCompare *d = ptr;
+	return (*d->test)(s, d->val1, d->val2);
 }
 
 //jl

9unit.h

@@ -1,54 +1,175 @@
 /*
 
 	9unit
-	Copyright (C) 2023  Jonathan Lamothe <jonathan@jlamothe.net>
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
 
 	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
+	it under the terms of the GNU Lesser General Public License as
-	the Free Software Foundation, either version 3 of the License, or (at
+	published by the Free Software Foundation, either version 3 of the
-	your option) any later version.
+	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.
+	Lesser General Public License for more details.
 
-	You should have received a copy of the GNU General Public License
+	You should have received a copy of the GNU Lesser General Public
-	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
 
 */
 
-// Tracks information about the tests being run.
+// Types & Structs
-typedef struct TestState
+
-{
+// The following structures will typically be maintained by the
-	int run; // number of tests run
+// testing framework.  You shouldn't need to concern yourself with
-	int passed; // number of successful tests
+// them.
-	int failed; // number of failed tests
-	int postponed; // number of postponed tests
-} TestState;
 
 // Possible results of running a single test
 typedef enum TestResult
 {
-	test_success,
+	test_success, // the test succeeded
-	test_failure,
+	test_failure, // the test failed
-	test_postponed
+	test_pending // the test is pending
 } TestResult;
 
-// Initializes a TestState value
+typedef struct TestState TestState;
-extern void initTestState(TestState *);
+typedef struct TestLogEntry TestLogEntry;
+
+// Tracks information about the tests being run.
+struct TestState
+{
+	int run; // number of tests run
+	int passed; // number of successful tests
+	int failed; // number of failed tests
+	int pending; // number of pending tests
+	TestLogEntry *first_log; // the first log entry
+	TestLogEntry *last_log; //the last log entry
+	void *ptr; // used for passing data between tests
+	const char *context; // immediate context of current test
+	const char *full_context; // full context of current test
+	int depth; // how many tests "deep" are we?
+	void (*report)(const char *); // prints a string immediately
+};
+
+// Defines a log entry in a TestState struct
+struct TestLogEntry
+{
+	char *text; // the entry text
+	TestLogEntry *next; // points to the next entry
+};
+
+// Functions
+
+// Creates an initial TestState, passes it to the supplied function,
+// and displays the resulting log and summary
+extern void run_tests(void (*)(TestState *));
+
+// Adds an entry to the log that is displayed after the tests have
+// completed
+extern void append_test_log(
+	TestState *, // the current state
+	const char * // the message to append
+);
+
+// notes the current full context in the log
+extern void log_test_context(TestState *);
 
 // Runs a single test
-extern void runTest(
+extern void run_test(
 	TestState *, // the TestState data
-	TestResult (*)(void) // the test to run
+	TestResult (*)(TestState *) // the test to run
 );
 
-// Runs multiple tests
+// Runs a single test with an arbitrary input
-extern void runTests(
+extern void run_test_with(
-    // function that runs the tests and updates the provided TestState
+	TestState *, // the state
-	void (*)(TestState *)
+	TestResult (*)(TestState *, void *), // the test
+	void * // the value to pass in
 );
 
+// Runs a single test passing in two values to be compared
+extern void run_test_compare(
+	TestState *, // the current state
+
+	// the test to be run
+	TestResult (*test)(
+		TestState *, // the current state
+		void *, // the first value
+		void * // the second value
+	),
+
+	void *, // the first value
+	void * // the second value
+);
+
+// Gives additional context for a test
+extern void test_context(
+	TestState *, // the current state
+	const char *, // a description of the context
+	void (*)(TestState *) // the actual test
+);
+
+// Runs a test with a context and an additional input
+extern void test_context_with(
+	TestState *, // the current state
+	const char *, // a description of the context
+	void (*)(TestState *, void *), // the test function
+	void * // the value being passed in
+);
+
+// Passes two values into a test context
+void test_context_compare(
+	TestState *, // the current state
+	const char *, // the context label
+
+	// test function
+	void (*)(
+		TestState *, // the current state
+		void *, // the first value
+		void * // the second value
+	),
+
+	void *, // the first value
+	void * // the second value
+);
+
+// Runs a single test with a context label
+extern void single_test_context(
+	TestState *, // the current state
+	const char *, // a description of the context
+	TestResult (*)(TestState *) // the actual test
+);
+
+// Runs a single test with a context and input
+extern void single_test_context_with(
+	TestState *, // the state
+	const char *, // the context
+
+	// the test
+	TestResult (*)(
+		TestState *, // the state
+		void * // the value being passed
+	),
+
+	void * // the value being passed
+);
+
+// Runs a single test with a context, passing it two values to be
+// compared
+extern void single_test_context_compare(
+	TestState *, // the state
+	const char *, // the context
+
+	// the test function
+	TestResult (*)(
+		TestState *, // the state
+		void *, // the first value
+		void * // the second value
+	),
+
+	void *, // the first value
+	void * // the second value
+);
 
 //jl

LICENSE

@@ -1,232 +1,165 @@
-GNU GENERAL PUBLIC LICENSE
+                   GNU LESSER GENERAL PUBLIC LICENSE
-Version 3, 29 June 2007
+                       Version 3, 29 June 2007
 
-Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
 
-Preamble
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
 
-The GNU General Public License is a free, copyleft license for software and other kinds of works.
+  0. Additional Definitions.
 
-The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
 
-When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
+  "The Library" refers to a covered work governed by this License,
-
+other than an Application or a Combined Work as defined below.
-To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
+
-
+  An "Application" is any work that makes use of an interface provided
-For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
+by the Library, but which is not otherwise based on the Library.
-
+Defining a subclass of a class defined by the Library is deemed a mode
-Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
+of using an interface provided by the Library.
-
+
-For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
+  A "Combined Work" is a work produced by combining or linking an
-
+Application with the Library.  The particular version of the Library
-Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
+with which the Combined Work was made is also called the "Linked
-
+Version".
-Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
+
-
+  The "Minimal Corresponding Source" for a Combined Work means the
-The precise terms and conditions for copying, distribution and modification follow.
+Corresponding Source for the Combined Work, excluding any source code
-
+for portions of the Combined Work that, considered in isolation, are
-TERMS AND CONDITIONS
+based on the Application, and not on the Linked Version.
-
+
-0. Definitions.
+  The "Corresponding Application Code" for a Combined Work means the
-
+object code and/or source code for the Application, including any data
-“This License” refers to version 3 of the GNU General Public License.
+and utility programs needed for reproducing the Combined Work from the
-
+Application, but excluding the System Libraries of the Combined Work.
-“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
+
-
+  1. Exception to Section 3 of the GNU GPL.
-“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
+
-
+  You may convey a covered work under sections 3 and 4 of this License
-To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
+without being bound by section 3 of the GNU GPL.
-
+
-A “covered work” means either the unmodified Program or a work based on the Program.
+  2. Conveying Modified Versions.
-
+
-To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
+  If you modify a copy of the Library, and, in your modifications, a
-
+facility refers to a function or data to be supplied by an Application
-To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
+that uses the facility (other than as an argument passed when the
-
+facility is invoked), then you may convey a copy of the modified
-An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
+version:
-
+
-1. Source Code.
+   a) under this License, provided that you make a good faith effort to
-The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
+   ensure that, in the event an Application does not supply the
-
+   function or data, the facility still operates, and performs
-A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
+   whatever part of its purpose remains meaningful, or
-
+
-The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
+   b) under the GNU GPL, with none of the additional permissions of
-
+   this License applicable to that copy.
-The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
+
-
+  3. Object Code Incorporating Material from Library Header Files.
-The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
+
-
+  The object code form of an Application may incorporate material from
-The Corresponding Source for a work in source code form is that same work.
+a header file that is part of the Library.  You may convey such object
-
+code under terms of your choice, provided that, if the incorporated
-2. Basic Permissions.
+material is not limited to numerical parameters, data structure
-All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
+layouts and accessors, or small macros, inline functions and templates
-
+(ten or fewer lines in length), you do both of the following:
-You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
+
-
+   a) Give prominent notice with each copy of the object code that the
-Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
+   Library is used in it and that the Library and its use are
-
+   covered by this License.
-3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
-No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
+   b) Accompany the object code with a copy of the GNU GPL and this license
-
+   document.
-When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
+
-
+  4. Combined Works.
-4. Conveying Verbatim Copies.
+
-You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
+  You may convey a Combined Work under terms of your choice that,
-
+taken together, effectively do not restrict modification of the
-You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
+portions of the Library contained in the Combined Work and reverse
-
+engineering for debugging such modifications, if you also do each of
-5. Conveying Modified Source Versions.
+the following:
-You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
+
-
+   a) Give prominent notice with each copy of the Combined Work that
-     a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
+   the Library is used in it and that the Library and its use are
-
+   covered by this License.
-     b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
+
-
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-     c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
+   document.
-
+
-     d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
+   c) For a Combined Work that displays copyright notices during
-
+   execution, include the copyright notice for the Library among
-A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
+   these notices, as well as a reference directing the user to the
-
+   copies of the GNU GPL and this license document.
-6. Conveying Non-Source Forms.
+
-You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
+   d) Do one of the following:
-
+
-     a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
+       0) Convey the Minimal Corresponding Source under the terms of this
-
+       License, and the Corresponding Application Code in a form
-     b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
+       suitable for, and under terms that permit, the user to
-
+       recombine or relink the Application with a modified version of
-     c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
+       the Linked Version to produce a modified Combined Work, in the
-
+       manner specified by section 6 of the GNU GPL for conveying
-     d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
+       Corresponding Source.
-
+
-     e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
+       1) Use a suitable shared library mechanism for linking with the
-
+       Library.  A suitable mechanism is one that (a) uses at run time
-A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
+       a copy of the Library already present on the user's computer
-
+       system, and (b) will operate properly with a modified version
-A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
+       of the Library that is interface-compatible with the Linked
-
+       Version.
-“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
+
-
+   e) Provide Installation Information, but only if you would otherwise
-If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
+   be required to provide such information under section 6 of the
-
+   GNU GPL, and only to the extent that such information is
-The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
+   necessary to install and execute a modified version of the
-
+   Combined Work produced by recombining or relinking the
-Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
+   Application with a modified version of the Linked Version. (If
-
+   you use option 4d0, the Installation Information must accompany
-7. Additional Terms.
+   the Minimal Corresponding Source and Corresponding Application
-“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
+   Code. If you use option 4d1, you must provide the Installation
-
+   Information in the manner specified by section 6 of the GNU GPL
-When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
+   for conveying Corresponding Source.)
-
+
-Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
+  5. Combined Libraries.
-
+
-     a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
+  You may place library facilities that are a work based on the
-
+Library side by side in a single library together with other library
-     b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
+facilities that are not Applications and are not covered by this
-
+License, and convey such a combined library under terms of your
-     c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
+choice, if you do both of the following:
-
+
-     d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
+   a) Accompany the combined library with a copy of the same work based
-
+   on the Library, uncombined with any other library facilities,
-     e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
+   conveyed under the terms of this License.
-
+
-     f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
+   b) Give prominent notice with the combined library that part of it
-
+   is a work based on the Library, and explaining where to find the
-All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
+   accompanying uncombined form of the same work.
-
+
-If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
+  6. Revised Versions of the GNU Lesser General Public License.
-
+
-Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
+  The Free Software Foundation may publish revised and/or new versions
-
+of the GNU Lesser General Public License from time to time. Such new
-8. Termination.
+versions will be similar in spirit to the present version, but may
-You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
+differ in detail to address new problems or concerns.
-
+
-However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
+  Each version is given a distinguishing version number. If the
-
+Library as you received it specifies that a certain numbered version
-Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
+of the GNU Lesser General Public License "or any later version"
-
+applies to it, you have the option of following the terms and
-Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
+conditions either of that published version or of any later version
-
+published by the Free Software Foundation. If the Library as you
-9. Acceptance Not Required for Having Copies.
+received it does not specify a version number of the GNU Lesser
-You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
+General Public License, you may choose any version of the GNU Lesser
-
+General Public License ever published by the Free Software Foundation.
-10. Automatic Licensing of Downstream Recipients.
+
-Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
+  If the Library as you received it specifies that a proxy can decide
-
+whether future versions of the GNU Lesser General Public License shall
-An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
+apply, that proxy's public statement of acceptance of any version is
-
+permanent authorization for you to choose that version for the
-You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
+Library.
-
-11. Patents.
-A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
-
-A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
-
-Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
-
-In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
-
-If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
-
-If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
-
-A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
-
-Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
-
-12. No Surrender of Others' Freedom.
-If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
-
-13. Use with the GNU Affero General Public License.
-Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
-
-14. Revised Versions of this License.
-The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
-
-If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
-
-Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
-
-15. Disclaimer of Warranty.
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-16. Limitation of Liability.
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
-17. Interpretation of Sections 15 and 16.
-If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
-
-END OF TERMS AND CONDITIONS
-
-How to Apply These Terms to Your New Programs
-
-If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
-
-     9unit
-     Copyright (C) 2023  9p
-
-     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/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
-
-     9unit  Copyright (C) 2023  9p
-     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-     This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
-
-You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>.
-
-The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

README.md

@@ -1,16 +1,314 @@
 # 9unit
 Copyright (C) 2023  Jonathan Lamothe <jonathan@jlamothe.net>
 
-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 free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser 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.
+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
+Lesser 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/>.
+You should have received a copy of the GNU Lesser General Public
-
+License along with this program.  If not, see
-## WARNING
+<http://www.gnu.org/licenses/>.
-
-This library is experimental and should be considered subject to change at any time.
 
 ## Summary
 
-A simple C testing framework for Plan9
+A simple unit testing framework for C programs in Plan9
+
+This provides the library file `9unit.a` and the header `9unit.h`.
+The header is relatively well commented and can provide a fairly
+comprehensive breakdown of the API.  This document will however
+provide a basic overview below.
+
+This library is used to test itself, consequently the `test` directory
+contains a relitively decent real-world (if somewhat confusing)
+example of how it can be used.
+
+## `TestState`
+
+The entire testing framework is centred around the `TestState` data
+structure.  As its name would imply, it contains the current state of
+the tests in progress, however it should almost never be necessary to
+interact with it directly.  With the exception of `run_tests()`
+(described below), all functions provided by the library will take
+take a pointer to the current `TestState` value as their first
+argument.
+
+## `run_tests()`
+
+This will typically be the first function called.  It creates an
+initial `TestState` value, runs the tests, and displays a test log and
+summary at the end.  If any of the tests fail, it will cause the test
+process to exit with a status of `"test(s) failed"`.  Its prototype
+follows:
+
+```C
+void run_tests(void (*)(TestState *));
+```
+
+Its only argument is a pointer to a function which is then
+responsible for actually running the tests.  A pointer to the newly
+created `TestState` value will be passed to this function.
+
+## Simple Tests
+
+The simplest form of test can be represented by a function resembling
+the follwoing:
+
+```C
+TestResult my_test(TestState *s)
+{
+	// test code goes here...
+}
+```
+
+This function should return a `TestResult` value representing (perhaps
+unsurprisingly) the result of the test.  The options are as follows:
+
+- `test_success`: the test was completed successfully
+- `test_failure`: the test failed
+- `test_pending`: the test is pending, and should be ignored for now
+
+Tests of this type can be run by passing a pointer to them to the
+`run_test()` function which has the following prototype:
+
+```C
+void run_test(
+	TestState *,
+	TestResult (*)(TestState *)
+)
+```
+
+This function will call the provided test function, and update the
+provided `TestState` to reflect the result.  Thus, the above
+hypothetical test could by run as follows:
+
+```C
+void
+tests(TestState *s)
+{
+	run_test(s, my_test);
+}
+
+void
+main()
+{
+	run_tests(tests);
+	exits(0);
+}
+```
+
+Passing a null `TestState` pointer will cause nothing to happen.  This
+is true of all functions in this library.  (This behaviour might be
+reconsidered later, so don't count on it.) Passing a null function
+pointer to `run_test()` is interpreted as a pending test.
+
+## Passing Values to Tests
+
+Since C supports neither lambdas nor closures, this would leave one
+with little choice but to come up with a unique name for each
+individual test function.  This, while possible, would definitely be
+rather inconvenient.  To combat this shortcoming, it is helpful to be
+able to pass data into a generic test function so that it can be
+reused multiple times.
+
+### The `ptr` Value
+
+The `TestState` struct has a value called `ptr` which is a `void`
+pointer that can be set prior to calling `run_test()` (or any other
+function, really).  This value can then be referenced by the test
+function, giving you the ability to essentially pass in (or out) *any*
+type of data you may need.  While not ideal, it's *a* solution.
+
+The library does not perform any kind of validation or automatic
+memory management on the `ptr` value (this is C after all), so the
+responsibility for this falls to the programmer implementing the
+tests.
+
+### Convenience Functions
+
+As the test suite becomes more and more complex, managing a single
+`ptr` value can become increasingly burdensome.  For this reason,
+there are a few convenience functions that provide an alternate
+mechanism for passing data into a function without altering the `ptr`
+value.  (They actually do alter it internally, but they restore the
+original value before passing the state on.) Two such functions are:
+`run_test_with()`, and `run_test_compare()`.
+
+`run_test_with()` has the following prototype:
+
+```C
+void run_test_with(
+	TestState *,
+	TestResult (*)(TestState *, void *),
+	void *
+);
+```
+
+The first argument points to the current test state.  The second
+points to a test function much like the simple test function described
+above, but that takes a void pointer as a second argument.  Finally,
+the third argument is the pointer that gets passed into the test
+function.
+
+`run_test_compare()` is similar, but it allows *two* pointers to be
+passed into the test function.  This is useful for comparing the
+actual output of a function to an expected value, for instance.
+
+The prototype for `run_test_compare()` follows:
+
+```C
+void run_test_compare(
+	TestState *,
+	TestResult (*)(TestState *, void *, void *),
+	void *,
+	void *
+);
+```
+
+The pointers will be passed into the test function in the same order
+they are passed into `run_test_compare()`.
+
+## Test Contexts
+
+It is useful to document what your tests are doing.  This can be
+achieved using contexts.  Contexts are essentially labelled
+collections of related tests.  Contexts can be nested to create
+hierarchies.  This is useful both for organization purposes as well as
+creating reusable test code.  There are several functions written for
+managing these contexts.  Each of these functions takes as its first
+two arguments: a pointer to the current `TestState`, and a pointer to
+a string describing the context it defines.  If the pointer to the
+string is null, the tests are run as a part of the existing context.
+
+### `test_context()`
+
+```C
+void test_context(
+	TestState *,
+	const char *,
+	void (*)(TestState *)
+);
+```
+
+This function takes a pointer to the current `TestState`, a string
+describing the context, and a function pointer that is used the same
+way as the one passed to `run_tests()`.  This function will be called
+and its tests will be run within the newly defined context.  Nothing
+prevents this function from being called again in a different context.
+
+### `test_context_with()`
+
+```C
+void test_context_with(
+	TestState *,
+	const char *,
+	void (*)(TestState *, void *),
+	void *
+);
+```
+
+This funciton works similarly to `test_context()`, but allows for the
+passing of a `void` pointer into the test function in much the same
+way as the `run_test_with()` function.  Its arguments are (in order),
+a pointer to the current state, the context description, a pointer to
+the test function, and the pointer to be passed into that function.
+
+### `test_context_compare()`
+
+```C
+void test_context_compare(
+	TestState *,
+	const char *,
+	void (*)(TestState *, void *, void *),
+	void *,
+	void *
+);
+```
+
+This funciton allows the passing to two `void` pointers into a context
+in a manner similar to `run_test_compare()`.
+
+### `single_test_context()`
+
+```C
+void single_test_context(
+	TestState *,
+	const char *,
+	TestState (*)(TestState *)
+);
+```
+
+This function applies the context label to a *single* test.  The
+function passed in is expected to operate in the same way as the one
+passed to `run_test()`.
+
+### `single_test_context_with()`
+
+```C
+void single_test_context_with(
+	TestState *,
+	const char *,
+	TestState (*)(TestState *, void *),
+	void *
+);
+```
+
+This is similar to `single_test_context()` but allows a `void` pointer
+to be passed as in `run_test_with()`.
+
+### `single_test_context_compare()`
+
+```C
+void single_test_context_compare(
+	TestState *,
+	const char *,
+	TestResult (*)(TestState *, void *, void *),
+	void *,
+	void *
+);
+```
+
+I assume you get the idea at this point.
+
+## Logging
+
+When `run_tests()` finishes running the tests, it displays a log and
+summary.  The summary is simply a tally of the number of tests run,
+passed, failed, and pending.  While this is useful (and probably all
+you need to know when all the tests pass) it is likely desirable to
+have more detail when something goes wrong.  To facilitate this, tests
+can append to the test log, which is automatically displayed just
+before the summary.  There are two functions for doing this.
+
+### `append_test_log()`
+
+```C
+void append_test_log(
+	TestState *,
+	const char *
+);
+```
+
+This appends an arbitrary string to the end of the test log.  The
+contents of the string are copied into the log, so the value pointed
+to by the second argument does not need to persist in memory beyond
+the end of the call to the function.  Log entries are expected to be
+single lines.  No trailing newline should be present (but the trailing
+NUL character should (obviously)).
+
+### `log_test_context()`
+
+```C
+void log_test_context(TestState *);
+```
+
+This function appends an entry to the log indicating the test's
+current *full* context.  If no context is defined, the log entry will
+be `"<no context>"`.  If the test is inside of a context labeled
+`"foo"` which is inside of another context labeled `"bar"`, the
+resulting log entry will read `"bar: foo"`.

mkfile

@@ -1,21 +1,32 @@
 # 9unit
-# Copyright (C) 2023  Jonathan Lamothe <jonathan@jlamothe.net>
+# Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
 #
 # 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
+# it under the terms of the GNU Lesser General Public License as
-# the Free Software Foundation, either version 3 of the License, or (at
+# published by the Free Software Foundation, either version 3 of the
-# your option) any later version.
+# 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.
+# Lesser General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU Lesser General Public
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
 
 </$objtype/mkfile
 
+cleantest:V:
+	cd test && mk $MKFLAGS clean
+
+nuketest:V:
+	cd test && mk $MKFLAGS nuke
+
+clean:V: cleantest
+
+nuke:V: nuketest
+
 LIB=9unit.a
 OFILES=9unit.$O
 HFILES=9unit.h

test/append-test-log.c

@@ -0,0 +1,287 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "append-test-log.h"
+
+// Local Types
+
+typedef struct LogData LogData;
+
+struct LogData
+{
+	TestState state;
+	TestLogEntry first, second;
+};
+
+// Local Prototypes
+
+static void append_to_empty(TestState *);
+static void append_to_existing(TestState *);
+static void missing_last(TestState *);
+static void missing_first(TestState *);
+static void null_message(TestState *);
+static TestResult null_state(TestState *);
+static void chk_empty_first(TestState *, void *);
+static void chk_first(TestState *, void *);
+static void chk_second(TestState *, void *);
+static void chk_last(TestState *, void *);
+static void mf_chk_first(TestState *, void *);
+static void mf_chk_second(TestState *, void *);
+static void mf_chk_third(TestState*, void *);
+static void mk_log_data(LogData *);
+static void clean_entry(TestLogEntry *);
+
+static void chk_ptr_chg(
+	TestState *,
+	const char *,
+	const void *,
+	const void *
+);
+
+static void chk_ptr_chg_test(TestState *, void *, void *);
+
+// Public Functions
+
+void
+test_append_test_log(TestState *s)
+{
+	test_context(s, "append to empty", append_to_empty);
+	test_context(s, "append to existing", append_to_existing);
+	test_context(s, "missing last_log", missing_last);
+	test_context(s, "missing first_log", missing_first);
+	test_context(s, "null message", null_message);
+	single_test_context(s, "null state", null_state);
+}
+
+// Local Functions
+
+static void
+append_to_empty(TestState *s)
+{
+	TestState test;
+	mk_sample_state(&test);
+	append_test_log(&test, "foo");
+
+	// first_log
+	test_context_with(
+		s,
+		"first_log",
+		chk_empty_first,
+		&test
+	);
+
+	// last_log
+	chk_ptr_eq(s, "last_log", test.last_log, test.first_log);
+}
+
+static void
+append_to_existing(TestState *s)
+{
+	LogData ld;
+	mk_log_data(&ld);
+	append_test_log(&ld.state, "baz");
+	test_context_with(s, "first_log", chk_first, &ld);
+	test_context_with(s, "second log", chk_second, &ld);
+	test_context_with(s, "last_log", chk_last, &ld);
+}
+
+static void
+missing_last(TestState *s)
+{
+	LogData ld;
+	mk_log_data(&ld);
+	ld.state.last_log = 0;
+	append_test_log(&ld.state, "baz");
+	test_context_with(s, "first_log", chk_first, &ld);
+	test_context_with(s, "second log", chk_second, &ld);
+	test_context_with(s, "last_log", chk_last, &ld);
+}
+
+static void
+missing_first(TestState *s)
+{
+	LogData ld;
+	mk_log_data(&ld);
+	ld.state.first_log = 0;
+	append_test_log(&ld.state, "baz");
+	test_context_with(s, "first_log", mf_chk_first, &ld);
+	test_context_with(s, "last_log", chk_last, &ld);
+	TestLogEntry
+		*context = ld.second.next,
+		*warning = context->next;
+	clean_entry(context);
+	clean_entry(warning);
+}
+
+static void
+null_message(TestState *s)
+{
+	LogData ld;
+	mk_log_data(&ld);
+	append_test_log(&ld.state, 0);
+	chk_ptr_eq(s, "first_log", ld.state.first_log, &ld.first);
+	chk_ptr_eq(s, "last_log", ld.state.last_log, &ld.second);
+}
+
+static TestResult
+null_state(TestState *)
+{
+	// ensure it doesn't crash
+	append_test_log(0, "foo");
+	return test_success;
+}
+
+static void
+chk_empty_first(TestState *s, void *ptr)
+{
+	TestState *test = ptr;
+	chk_str_eq(s, "text", test->first_log->text, "foo");
+	chk_ptr_eq(s, "next", test->first_log->next, 0);
+}
+
+static void
+chk_first(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+
+	// first_log
+	chk_ptr_eq(
+		s,
+		0,
+		ld->state.first_log,
+		&ld->first
+	);
+
+	// next
+	chk_ptr_eq(
+		s,
+		"next",
+		ld->state.first_log->next,
+		&ld->second
+	);
+}
+
+static void
+chk_second(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+	chk_ptr_eq(
+		s,
+		"next",
+		ld->second.next,
+		ld->state.last_log
+	);
+}
+
+static void
+chk_last(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+	chk_ptr_chg(s, 0, ld->state.last_log, &ld->second);
+	chk_str_eq(s, "text", ld->state.last_log->text, "baz");
+	chk_ptr_eq(s, "next", ld->state.last_log->next, 0);
+	clean_entry(ld->state.last_log);
+}
+
+static void
+mf_chk_first(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+	chk_ptr_eq(s, 0, ld->state.first_log, &ld->second);
+	test_context_with(s, "next", mf_chk_second, ptr);
+}
+
+static void
+mf_chk_second(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+	TestLogEntry *e = ld->second.next;
+	chk_str_eq(s, "text", e->text, "<no context>");
+	test_context_with(s, "next", mf_chk_third, ptr);
+}
+
+static void
+mf_chk_third(TestState *s, void *ptr)
+{
+	LogData *ld = ptr;
+	TestLogEntry *e = ld->second.next->next;
+	chk_str_eq(
+		s,
+		"text",
+		e->text,
+		"potential memory leak in test log"
+	);
+	chk_ptr_eq(s, "next", e->next, ld->state.last_log);
+}
+
+static void
+mk_log_data(LogData *ld)
+{
+	mk_sample_state(&ld->state);
+	ld->state.first_log = &ld->first;
+	ld->state.last_log = &ld->second;
+	ld->first.text = "foo";
+	ld->first.next = &ld->second;
+	ld->second.text = "bar";
+	ld->second.next = 0;
+}
+
+static void
+chk_ptr_chg(
+	TestState *s,
+	const char *context,
+	const void *actual,
+	const void *prohibited
+)
+{
+	test_context_compare(
+		s,
+		context,
+		chk_ptr_chg_test,
+		actual,
+		prohibited
+	);
+}
+
+static void
+chk_ptr_chg_test(
+	TestState *s,
+	void *actual,
+	void *prohibited
+)
+{
+	chk_ptr_ne(s, "has changed", actual, prohibited);
+	chk_ptr_ne(s, "not null", actual, 0);
+}
+
+static void
+clean_entry(TestLogEntry *e)
+{
+	free(e->text);
+	free(e);
+}
+
+//jl

test/append-test-log.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+extern void test_append_test_log(TestState *);
+
+//jl

test/initial-state.c

@@ -0,0 +1,48 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "initial-state.h"
+
+// Public Functions
+
+void
+test_initial_state(TestState *s, void *ptr)
+{
+	TestState *scpy = ptr;
+	chk_int_eq(s, "run", scpy->run, 0);
+	chk_int_eq(s, "passsed", scpy->passed, 0);
+	chk_int_eq(s, "failed", scpy->failed, 0);
+ 	chk_int_eq(s, "pending", scpy->pending, 0);
+	chk_ptr_eq(s, "first_log", scpy->first_log, 0);
+	chk_ptr_eq(s, "last_log", scpy->last_log, 0);
+	chk_ptr_eq(s, "ptr", scpy->ptr, 0);
+	chk_ptr_eq(s, "context", scpy->context, 0);
+	chk_ptr_eq(s, "full_context", scpy->full_context, 0);
+	chk_int_eq(s, "depth", scpy->depth, 0);
+	chk_ptr_ne(s, "report()", scpy->report, 0);
+}
+
+//jl

test/initial-state.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+void test_initial_state(TestState *, void *);
+
+//jl

test/mkfile

@@ -0,0 +1,44 @@
+# 9unit
+# Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
+
+</$objtype/mkfile
+
+HFILES=\
+	../9unit.h\
+	util.h\
+	initial-state.h\
+	run-test.h\
+	run-test-with.h\
+	run-test-compare.h\
+	append-test-log.h\
+	test-context.h
+
+OFILES=\
+	util.$O\
+	initial-state.$O\
+	run-test.$O\
+	run-test-with.$O\
+	run-test-compare.$O\
+	append-test-log.$O\
+	test-context.$O
+
+LIB=../9unit.a
+TEST=tests
+
+</sys/src/cmd/mktest
+
+#jl

test/run-test-compare.c

@@ -0,0 +1,87 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "run-test-compare.h"
+
+// Internal Prototypes
+
+static TestResult
+test_run_test_compare_test(TestState *, void *, void *);
+
+// Public Functions
+
+void
+test_run_test_compare(TestState *s)
+{
+	TestState actual, expected;
+
+	// build initial state
+	mk_sample_state(&actual);
+	void
+		*pass_in1 = malloc(1),
+		*pass_in2 = malloc(1),
+		*passed_in[2];
+	for (int i = 0; i < 2; i++)
+		passed_in[i] = 0;
+	actual.ptr = passed_in;
+
+	// run it and see what was passed
+	run_test_compare(
+		&actual,
+		test_run_test_compare_test,
+		pass_in1,
+		pass_in2
+	);
+	chk_ptr_eq(s, "first value passed", passed_in[0], pass_in1);
+	chk_ptr_eq(s, "second value passed", passed_in[1], pass_in2);
+
+	// ensure the state was updated correctly
+	mk_sample_state(&expected);
+	expected.passed = 2;
+	expected.run = 7;
+	expected.ptr = &passed_in;
+	chk_TestState_eq(s, "resulting state", &actual, &expected);
+
+	free(pass_in1);
+	free(pass_in2);
+}
+
+// Internal Functions
+
+static TestResult
+test_run_test_compare_test(
+	TestState *s,
+	void *ptr1,
+	void *ptr2
+)
+{
+	void **passed_in = s->ptr;
+	passed_in[0] = ptr1;
+	passed_in[1] = ptr2;
+	return test_success;
+}
+
+//jl

test/run-test-compare.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+extern void test_run_test_compare(TestState *);
+
+//jl

test/run-test-with.c

@@ -0,0 +1,71 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "run-test-with.h"
+
+// Internal Prototypes
+
+static TestResult test_run_test_with_test(TestState *, void *);
+
+// Public Functions
+
+void
+test_run_test_with(TestState *s)
+{
+	TestState actual, expected;
+
+	// build initial state
+	mk_sample_state(&actual);
+	void
+		*pass_in = malloc(0),
+		*passed_in = 0;
+	actual.ptr = &passed_in;
+
+	// run it and see what was passed
+	run_test_with(&actual, test_run_test_with_test, pass_in);
+	chk_ptr_eq(s, "value passed", passed_in, pass_in);
+
+	// ensure the state was updated correctly
+	mk_sample_state(&expected);
+	expected.passed = 2;
+	expected.run = 7;
+	expected.ptr = &passed_in;
+	chk_TestState_eq(s, "resulting state", &actual, &expected);
+
+	free(pass_in);
+}
+
+// Internal Functions
+
+static TestResult
+test_run_test_with_test(TestState *s, void *ptr)
+{
+	void **passed_in = s->ptr;
+	*passed_in = ptr;
+	return test_success;
+}
+
+//jl

test/run-test-with.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+extern void test_run_test_with(TestState *);
+
+//jl

test/run-test.c

@@ -0,0 +1,148 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "run-test.h"
+
+// Internal Prototypes
+
+static void test_pass(TestState *);
+static void test_fail(TestState *);
+static void test_pend(TestState *);
+static TestResult null_state(TestState *);
+static void null_test(TestState *);
+static TestResult always_passes(TestState *);
+static TestResult always_fails(TestState *);
+static TestResult always_pends(TestState *);
+
+// Public Functions
+
+void
+test_run_test(TestState *s)
+{
+	test_context(s, "passing", test_pass);
+	test_context(s, "failing", test_fail);
+	test_context(s, "pending", test_pend);
+	single_test_context(s, "null state", null_state);
+	test_context(s, "null test", null_test);
+}
+
+// Internal Functions
+
+static void
+test_pass(TestState *s)
+{
+	TestState actual, expected;
+
+	// actual result
+	mk_sample_state(&actual);
+	run_test(&actual, always_passes);
+
+	// expected result
+	mk_sample_state(&expected);
+	expected.passed = 2;
+	expected.run = 7;
+
+	chk_TestState_eq(s, 0, &actual, &expected);
+}
+
+static void
+test_fail(TestState *s)
+{
+	TestState actual, expected;
+
+	// actual result
+	mk_sample_state(&actual);
+	run_test(&actual, always_fails);
+
+	// expected result
+	mk_sample_state(&expected);
+	expected.failed = 3;
+	expected.run = 7;
+
+	chk_TestState_eq(s, 0, &actual, &expected);
+}
+
+static void
+test_pend(TestState *s)
+{
+	TestState actual, expected;
+
+	// actual result
+	mk_sample_state(&actual);
+	run_test(&actual, always_pends);
+
+	// expected result
+	mk_sample_state(&expected);
+	expected.pending = 4;
+	expected.run = 7;
+
+	chk_TestState_eq(s, 0, &actual, &expected);
+}
+
+static TestResult
+null_state(TestState *)
+{
+	// make sure it doesn't crash
+	run_test(0, always_passes);
+	return test_success;
+}
+
+static void
+null_test(TestState *s)
+{
+	TestState actual, expected;
+
+	// actual value
+	mk_sample_state(&actual);
+	run_test(&actual, 0);
+
+	// expected value
+	mk_sample_state(&expected);
+	expected.pending = 4;
+	expected.run = 7;
+
+	chk_TestState_eq(s, 0, &actual, &expected);
+}
+
+static TestResult
+always_passes(TestState *)
+{
+	return test_success;
+}
+
+static TestResult
+always_fails(TestState *)
+{
+	return test_failure;
+}
+
+static TestResult
+always_pends(TestState *)
+{
+	return test_pending;
+}
+
+//jl

test/run-test.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+extern void test_run_test(TestState *s);
+
+//jl

test/test-context.c

@@ -0,0 +1,235 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "util.h"
+#include "test-context.h"
+
+// Internal Types
+
+typedef struct ContextData ContextData;
+
+struct ContextData
+{
+	TestState state;
+	const char *initial_context;
+	const char *initial_full_context;
+	int initial_depth;
+	const char *new_context;
+	const char *expected_sub_full_context;
+	int expected_sub_depth;
+	const char *sub_context;
+	const char *sub_full_context;
+	int sub_depth;
+};
+
+// Internal Prototypes
+
+static void no_prior_context(TestState *);
+static void prior_context(TestState *);
+static void test_context_common(TestState *, ContextData *);
+static void init_ContextData(ContextData *);
+static void get_context(TestState *);
+static void check_results(TestState *, ContextData *);
+static void clean_up(ContextData *);
+
+// Public Functions
+
+void
+test_test_context(TestState *s)
+{
+	test_context(s, "no prior context", no_prior_context);
+	test_context(s, "prior context", prior_context);
+}
+
+// Internal Functions
+
+static void
+no_prior_context(TestState *s)
+{
+	ContextData cd;
+
+	// set initial state
+	cd.new_context = "my test";
+	cd.initial_context = 0;
+	cd.initial_full_context = 0;
+	cd.initial_depth = 0;
+
+	// set expectations
+	cd.expected_sub_full_context = "my test";
+	cd.expected_sub_depth = 1;
+
+	test_context_common(s, &cd);
+}
+
+static void
+prior_context(TestState *s)
+{
+	ContextData cd;
+
+	// set initial state
+	cd.new_context = "my other test";
+	cd.initial_context = "bar";
+	cd.initial_full_context = "foo: bar";
+	cd.initial_depth = 2;
+
+	// set expectations
+	cd.expected_sub_full_context = "foo: bar: my other test";
+	cd.expected_sub_depth = 3;
+
+	test_context_common(s, &cd);
+}
+
+static void
+test_context_common(
+	TestState *s,
+	ContextData *cd
+)
+{
+	init_ContextData(cd);
+	test_context(&cd->state, cd->new_context, get_context);
+	check_results(s, cd);
+	clean_up(cd);
+}
+
+static void
+init_ContextData(ContextData *cd)
+{
+	mk_sample_state(&cd->state);
+	cd->state.ptr = cd;
+
+	// initial context
+	if (cd->initial_context)
+	{
+		cd->state.context =
+			malloc(strlen(cd->initial_context) + 1);
+		strcpy(cd->state.context, cd->initial_context);
+	}
+
+	// initial full_context
+	if (cd->initial_full_context)
+	{
+		cd->state.full_context =
+			malloc(strlen(cd->initial_full_context) + 1);
+		strcpy(
+			cd->state.full_context,
+			cd->initial_full_context
+		);
+	}
+
+	cd->state.depth = cd->initial_depth;
+}
+
+static void
+get_context(TestState *s)
+{
+	ContextData *cd = s->ptr;
+
+	// get the context
+	if (s->context)
+	{
+		char *c = malloc(strlen(s->context) + 1);
+		strcpy(c, s->context);
+		cd->sub_context = c;
+	}
+	else cd->sub_context = 0;
+
+	// get the full context
+	if (s->full_context)
+	{
+		char *fc = malloc(strlen(s->full_context) + 1);
+		strcpy(fc, s->full_context);
+		cd->sub_full_context = fc;
+	}
+	else cd->sub_full_context = 0;
+
+	// get the depth
+	cd->sub_depth = s->depth;
+}
+
+static void
+check_results(
+	TestState *s,
+	ContextData *cd
+)
+{
+	// sub context
+	chk_str_eq(
+		s,
+		"sub context",
+		cd->sub_context,
+		cd->new_context
+	);
+
+	// sub full_context
+	chk_str_eq(
+		s,
+		"sub full_context",
+		cd->sub_full_context,
+		cd->expected_sub_full_context
+	);
+
+	// sub depth
+	chk_int_eq(
+		s,
+		"sub depth",
+		cd->sub_depth,
+		cd->expected_sub_depth
+	);
+	
+	// final context
+	chk_str_eq(
+		s,
+		"final context",
+		cd->state.context,
+		cd->initial_context
+	);
+
+	// final full_context
+	chk_str_eq(
+		s,
+		"final full_context",
+		cd->state.full_context,
+		cd->initial_full_context
+	);
+
+	// final depth
+	chk_int_eq(
+		s,
+		"final depth",
+		cd->state.depth,
+		cd->initial_depth
+	);
+}
+
+static void
+clean_up(ContextData *cd)
+{
+	free(cd->state.context);
+	free(cd->state.full_context);
+	free(cd->sub_context);
+	free(cd->sub_full_context);
+}
+
+//jl

test/test-context.h

@@ -0,0 +1,24 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+extern void test_test_context(TestState *);
+
+//jl

test/tests.c

@@ -0,0 +1,65 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+
+#include "../9unit.h"
+#include "initial-state.h"
+#include "run-test.h"
+#include "run-test-with.h"
+#include "run-test-compare.h"
+#include "append-test-log.h"
+#include "test-context.h"
+
+// Internal Prototypes
+
+static void tests(TestState *);
+
+// Public Functions
+
+void
+main()
+{
+	run_tests(tests);
+	exits(0);
+}
+
+// Internal Functions
+
+static void
+tests(TestState *s)
+{
+	if (!s) exits("ERROR: no TestState");
+
+	// Make a copy of the initial TestState
+	TestState scpy;
+	memcpy(&scpy, s, sizeof(TestState));
+
+	test_context_with(s, "initial state", test_initial_state, &scpy);
+	test_context(s, "run_test()", test_run_test);
+	test_context(s, "run_test_with()", test_run_test_with);
+	test_context(s, "run_test_compare()", test_run_test_compare);
+	test_context(s, "append_test_log()", test_append_test_log);
+	test_context(s, "test_context()", test_test_context);
+}
+
+//jl

test/util.c

@@ -0,0 +1,285 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#include <u.h>
+#include <libc.h>
+#include <stdio.h>
+
+#include "../9unit.h"
+#include "util.h"
+
+// Internal Prototypes
+
+static void chk_TestState_eq_test(TestState *, void *, void *);
+static TestResult chk_int_eq_test(TestState *, void *, void *);
+static TestResult chk_ptr_eq_test(TestState *, void *, void *);
+static TestResult chk_ptr_ne_test(TestState *, void *, void *);
+static TestResult chk_str_eq_test(TestState *, void *, void *);
+
+// discard report data
+static void report(const char *);
+
+// Public Functions
+
+void
+mk_sample_state(TestState *s)
+{
+	memset(s, 0, sizeof(TestState));
+	s->passed = 1;
+	s->failed = 2;
+	s->pending = 3;
+	s->run = 6;
+	s->report = report;
+}
+
+void
+chk_TestState_eq(
+	TestState *s,
+	const char *context,
+	const TestState *actual,
+	const TestState *expected
+)
+{
+	test_context_compare(
+		s,
+		context,
+		chk_TestState_eq_test,
+		actual,
+		expected
+	);
+}
+
+void
+chk_int_eq(
+	TestState *s,
+	const char *context,
+	int actual,
+	int expected
+)
+{
+	single_test_context_compare(
+		s,
+		context,
+		chk_int_eq_test,
+		&actual,
+		&expected
+	);
+}
+
+void
+chk_ptr_eq(
+	TestState *s,
+	const char *context,
+	const void *actual,
+	const void *expected
+)
+{
+	single_test_context_compare(
+		s,
+		context,
+		chk_ptr_eq_test,
+		actual,
+		expected
+	);
+}
+
+void
+chk_ptr_ne(
+	TestState *s,
+	const char *context,
+	const void *actual,
+	const void *prohibited
+)
+{
+	single_test_context_compare(
+		s,
+		context,
+		chk_ptr_ne_test,
+		actual,
+		prohibited
+	);
+}
+
+void
+chk_str_eq(
+	TestState *s,
+	const char *context,
+	const char *actual,
+	const char *expected
+)
+{
+	single_test_context_compare(
+		s,
+		context,
+		chk_str_eq_test,
+		actual,
+		expected
+	);
+}
+
+// Local Functions
+
+static void
+chk_TestState_eq_test(
+	TestState *s,
+	void *aptr,
+	void *eptr
+)
+{
+	if (!eptr)
+	{
+		chk_ptr_eq(s, "is null", aptr, 0);
+		return;
+	}
+
+	TestState
+		*actual = aptr,
+		*expected = eptr;
+
+	chk_int_eq(s, "run", actual->run, expected->run);
+	chk_int_eq(s, "passed", actual->passed, expected->passed);
+	chk_int_eq(s, "failed", actual->failed, expected->failed);
+	chk_int_eq(s, "pending", actual->pending, expected->pending);
+	chk_ptr_eq(s, "first_log", actual->first_log, expected->first_log);
+	chk_ptr_eq(s, "last_log", actual->last_log, expected->last_log);
+	chk_ptr_eq(s, "ptr", actual->ptr, expected->ptr);
+	chk_str_eq(s, "context", actual->context, expected->context);
+	chk_str_eq(s, "full_context", actual->full_context, expected->full_context);
+	chk_int_eq(s, "depth", actual->depth, expected->depth);
+	chk_ptr_eq(s, "report()", actual->report, expected->report);
+}
+
+static TestResult
+chk_int_eq_test(
+	TestState *s,
+	void *aptr,
+	void *eptr
+)
+{
+	int
+		*actual = aptr,
+		*expected = eptr;
+
+	if (*actual == *expected)
+		return test_success;
+
+	// log the error
+	char str[STR_BUF_SIZE];
+	log_test_context(s);
+	append_test_log(s, "ERROR:");
+	snprintf(str, STR_BUF_SIZE, "\texpected: %d", *expected);
+	append_test_log(s, str);
+	snprintf(str, STR_BUF_SIZE, "\tactual: %d", *actual);
+	append_test_log(s, str);
+
+	return test_failure;
+}
+
+static TestResult
+chk_ptr_eq_test(
+	TestState *s,
+	void *actual,
+	void *expected
+)
+{
+	if (actual == expected)
+		return test_success;
+
+	// log the error
+	char str[STR_BUF_SIZE];
+	log_test_context(s);
+	append_test_log(s, "ERROR:");
+	snprintf(str, STR_BUF_SIZE, "\texpected: 0x%x", expected);
+	append_test_log(s, str);
+	snprintf(str, STR_BUF_SIZE, "\tactual: 0x%x", actual);
+	append_test_log(s, str);
+
+	return test_failure;
+}
+
+static TestResult
+chk_ptr_ne_test(
+	TestState *s,
+	void *actual,
+	void *prohibited
+)
+{
+	if (actual != prohibited)
+		return test_success;
+
+	// log the error
+	char str[STR_BUF_SIZE];
+	log_test_context(s);
+	snprintf(
+		str,
+		STR_BUF_SIZE,
+		"ERROR: prohibited value: 0x%x",
+		actual
+	);
+	append_test_log(s, str);
+
+	return test_failure;
+}
+
+static TestResult
+chk_str_eq_test(
+	TestState *s,
+	void *aptr,
+	void *eptr
+)
+{
+	if (!eptr)
+	{
+		if (!aptr) return test_success;
+		char str[STR_BUF_SIZE];
+		log_test_context(s);
+		append_test_log(s, "ERROR:");
+		append_test_log(s, "\texpected: 0x0");
+		snprintf(str, STR_BUF_SIZE, "\tactual: 0x%x", aptr);
+		append_test_log(s, str);
+		return test_failure;
+	}
+
+	const char
+		*actual = aptr,
+		*expected = eptr;
+
+	if (!strcmp(actual, expected)) return;
+
+	// log the error
+	char str[STR_BUF_SIZE];
+	log_test_context(s);
+	append_test_log(s, "ERROR:");
+	snprintf(str, STR_BUF_SIZE, "\texpected: %s", expected);
+	append_test_log(s, str);
+	snprintf(str, STR_BUF_SIZE, "\tactual: %s", actual);
+	append_test_log(s, str);
+
+	return test_failure;
+}
+
+static void
+report(const char *)
+{
+	return;
+}
+
+//jl

test/util.h

@@ -0,0 +1,67 @@
+/*
+
+	9unit
+	Copyright (C) Jonathan Lamothe <jonathan@jlamothe.net>
+
+	This program is free software: you can redistribute it and/or modify
+	it under the terms of the GNU Lesser 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
+	Lesser General Public License for more details.
+
+	You should have received a copy of the GNU Lesser General Public
+	License along with this program.  If not, see
+	<http://www.gnu.org/licenses/>.
+
+*/
+
+#define STR_BUF_SIZE 256 // maximum string buffer size
+
+// initializes a sample TestState value
+void mk_sample_state(TestState *);
+
+// ensures two TestState values are equal
+extern void chk_TestState_eq(
+	TestState *, // the state we are *actually* updating ;)
+	const char *, // the context
+	const TestState *, // actual state
+	const TestState * // expected state
+);
+
+// ensure two integers are equal
+extern void chk_int_eq(
+	TestState *, // the test state
+	const char *, // the context
+	int, // the actual value
+	int // the expected value
+);
+
+// ensure two pointers are equal
+extern void chk_ptr_eq(
+	TestState *, // the test state
+	const char *, // the context
+	void *, // the actual value
+	void * // the expected value
+);
+
+// ensure two pointers are not equal
+extern void chk_ptr_ne(
+	TestState *, // the test state
+	const char *, // the context
+	void *, // the actual value
+	void * // the prohibited value
+);
+
+// ensure two strings are equal
+extern void chk_str_eq(
+	TestState *, // the test state
+	const char *, // the context
+	const char *, // the actual value
+	const char * // the expected value
+);
+
+//jl