Add test cases from codex

subprojects/vinumc/tests/automatics_test.c

@@ -0,0 +1,85 @@
+#include <vunit/vunit.h>
+
+#include "test_helpers.h"
+
+void test_argument_automatic(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[shout : *** [argument] ***]\n"
+					 "[shout If you drink, don't drive]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "*** If you drink, don't drive ***");
+}
+
+void test_automatic_empty_in_definition(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[a : argument was: [argument]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "");
+}
+
+void test_symbol_automatic(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[par : [symbol] said: [argument]]\n"
+					 "[par Red grapes]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "par said: Red grapes");
+}
+
+void test_count_automatic(struct vunit_test_ctx *ctx) {
+	char *out =
+		compile_program(ctx, "[item One]\n"
+				     "[item Two]\n"
+				     "[item Vinum animi speculum est [label foo]]\n"
+				     "[par The proverb in item [foo_count] in the list above is "
+				     "due to Alcuin of York (c. 735-804).]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out,
+			   "[item One] [item Two] [item Vinum animi speculum est ] "
+			   "[par The proverb in item 3 in the list above is due to "
+			   "Alcuin of York (c. 735-804).]");
+}
+
+void test_index_automatic_non_resetting(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[section\n"
+					 "[footnote [label a] first]\n"
+					 "]\n"
+					 "[section\n"
+					 "[footnote [label b] second]\n"
+					 "]\n"
+					 "[a_index] and [b_index]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out,
+			   "[section [footnote first] ] [section [footnote second] ] 1 and 2");
+}
+
+void test_content_reserved(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[echo : [content]]\n"
+					 "[echo hello]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "");
+}
+
+struct vunit_test tests[] = {
+	{ .name = "argument automatic inside a reference block",
+	  .test_func = test_argument_automatic,
+	  .todo = true,
+	  .todo_msg = "[argument] automatic not expanded in references" },
+	{ .name = "automatic variables are empty inside a definition",
+	  .test_func = test_automatic_empty_in_definition },
+	{ .name = "symbol automatic equals the block's name",
+	  .test_func = test_symbol_automatic,
+	  .todo = true,
+	  .todo_msg = "[symbol] automatic not implemented" },
+	{ .name = "count is the sequential block count in the scope",
+	  .test_func = test_count_automatic,
+	  .todo = true,
+	  .todo_msg = "[count] automatic not implemented" },
+	{ .name = "index is non-resetting across scopes",
+	  .test_func = test_index_automatic_non_resetting,
+	  .todo = true,
+	  .todo_msg = "[index] automatic not implemented" },
+	{ .name = "content is reserved and cannot recurse",
+	  .test_func = test_content_reserved,
+	  .todo = true,
+	  .todo_msg = "[content] reserved automatic not implemented" },
+	{},
+};
+
+VUNIT_TEST_SUITE(tests)

subprojects/vinumc/tests/blanks_test.c

@@ -0,0 +1,41 @@
+#include <vunit/vunit.h>
+
+#include "test_helpers.h"
+
+void test_blank_reduction_across_newline(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[ brunello : Brunello di\n"
+					 "Montalcino ]\n"
+					 "Try [brunello], a great wine from Tuscany.\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Try Brunello di Montalcino, a great wine from Tuscany.");
+}
+
+void test_leading_trailing_blanks_suppressed(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[a :   padded value   ]\n"
+					 "|[a]|\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "|padded value|");
+}
+
+void test_symbol_field_blanks_ignored(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[   wine   : Merlot]\n"
+					 "[wine]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Merlot");
+}
+
+struct vunit_test tests[] = {
+	{ .name = "Blank reduction collapses newlines into one space",
+	  .test_func = test_blank_reduction_across_newline,
+	  .todo = true,
+	  .todo_msg = "blank reduction across newlines not implemented" },
+	{ .name = "Leading and trailing blanks are suppressed",
+	  .test_func = test_leading_trailing_blanks_suppressed,
+	  .todo = true,
+	  .todo_msg = "leading/trailing blank suppression not implemented" },
+	{ .name = "Blanks around symbol field are ignored",
+	  .test_func = test_symbol_field_blanks_ignored },
+	{},
+};
+
+VUNIT_TEST_SUITE(tests)

subprojects/vinumc/tests/compounds_test.c

@@ -0,0 +1,103 @@
+#include <vunit/vunit.h>
+
+#include "test_helpers.h"
+
+void test_flat_compound_projection(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx,
+				    "[author:\n"
+				    "[name: Wine Maker]\n"
+				    "[email: vinum@example.com]\n"
+				    "]\n"
+				    "Our friend [author_name] can be reached at [author_email].\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Our friend Wine Maker can be reached at vinum@example.com.");
+}
+
+void test_nested_compound_projection(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(
+		ctx, "[author:\n"
+		     "[name:Wine Maker]\n"
+		     "[email: vinum@example.com]\n"
+		     "[company :\n"
+		     "[name : The Amazing Vineyards]\n"
+		     "[site : www.example.com]\n"
+		     "]\n"
+		     "]\n"
+		     "Contact [author_name] through [author_email], or make an appointment at "
+		     "[author_company_name] by visiting [author_company_site].\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out,
+			   "Contact Wine Maker through vinum@example.com, or make an "
+			   "appointment at The Amazing Vineyards by visiting www.example.com.");
+}
+
+void test_qualified_names_equivalence(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[author_name : Wine Maker]\n"
+					 "[author_email : vinum@example.com]\n"
+					 "[author_company_name : The Amazing Vineyards]\n"
+					 "[author_company_site : www.example.com]\n"
+					 "[author_name] at [author_company_name]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Wine Maker at The Amazing Vineyards");
+}
+
+void test_extend_compound_later(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[wine_body   : full]\n"
+					 "[wine_finish : long]\n"
+					 "[wine_ballance : harmonious]\n"
+					 "[wine_body] [wine_finish] [wine_ballance]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "full long harmonious");
+}
+
+void test_unnamed_fields_auto_index(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[grape:\n"
+					 "[: Cabernet Franc]\n"
+					 "[: Pinot Noir]\n"
+					 "[: Sauvignon Blanc]\n"
+					 "]\n"
+					 "[grape_1] / [grape_2] / [grape_3]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Cabernet Franc / Pinot Noir / Sauvignon Blanc");
+}
+
+void test_compound_projects_outer_text(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[wine: cabernet\n"
+					 "[body : full]\n"
+					 "sauvignon\n"
+					 "[finish : long]\n"
+					 "]\n"
+					 "[wine] // [wine_body] // [wine_finish]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "cabernet sauvignon // full // long");
+}
+
+struct vunit_test tests[] = {
+	{ .name = "Flat compound projects fields",
+	  .test_func = test_flat_compound_projection,
+	  .todo = true,
+	  .todo_msg = "compound projection (foo_bar) not implemented" },
+	{ .name = "Nested compound projects with underscore path",
+	  .test_func = test_nested_compound_projection,
+	  .todo = true,
+	  .todo_msg = "nested compound projection not implemented" },
+	{ .name = "Qualified-name form is equivalent to compound form",
+	  .test_func = test_qualified_names_equivalence,
+	  .todo = true,
+	  .todo_msg = "qualified-name form not implemented" },
+	{ .name = "Extending a compound via qualified name",
+	  .test_func = test_extend_compound_later,
+	  .todo = true,
+	  .todo_msg = "compound extension via qualified name not implemented" },
+	{ .name = "Unnamed inner fields get sequential integer keys",
+	  .test_func = test_unnamed_fields_auto_index,
+	  .todo = true,
+	  .todo_msg = "auto-indexed unnamed compound fields not implemented" },
+	{ .name = "Outer compound symbol projects non-block content",
+	  .test_func = test_compound_projects_outer_text,
+	  .todo = true,
+	  .todo_msg = "outer compound projection of free text not implemented" },
+	{},
+};
+
+VUNIT_TEST_SUITE(tests)

subprojects/vinumc/tests/control_structures_test.c

@@ -0,0 +1,54 @@
+#include <vunit/vunit.h>
+
+#include "test_helpers.h"
+
+void test_if_truthy(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[if 1 [then: A] [else: B]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "A");
+}
+
+void test_if_empty_is_false(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[empty :]\n"
+					 "[if [empty] [then: A] [else: B]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "B");
+}
+
+void test_if_zero_is_false(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[if 0 [then: A] [else: B]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "B");
+}
+
+void test_if_with_user_predicate(struct vunit_test_ctx *ctx) {
+	// Stand-in for the Codex's [is_workday] example: use a user-defined flag
+	// so the test is deterministic and stays independent from VSL.
+	char *out = compile_program(
+		ctx, "[workday : 1]\n"
+		     "Order your ticket [if [workday] [then: today] [else: by Monday]]!\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Order your ticket today!");
+}
+
+struct vunit_test tests[] = {
+	{ .name = "if with truthy expression picks then",
+	  .test_func = test_if_truthy,
+	  .todo = true,
+	  .todo_msg = "[if ...] control structure not implemented" },
+	{ .name = "if with empty expression picks else",
+	  .test_func = test_if_empty_is_false,
+	  .todo = true,
+	  .todo_msg = "[if ...] control structure not implemented" },
+	{ .name = "if with 0 picks else",
+	  .test_func = test_if_zero_is_false,
+	  .todo = true,
+	  .todo_msg = "[if ...] control structure not implemented" },
+	{ .name = "if branching on a user-defined predicate",
+	  .test_func = test_if_with_user_predicate,
+	  .todo = true,
+	  .todo_msg = "[if ...] control structure not implemented" },
+	{},
+};
+
+VUNIT_TEST_SUITE(tests)

subprojects/vinumc/tests/deferral_test.c

@@ -0,0 +1,89 @@
+#include <vunit/vunit.h>
+
+#include "test_helpers.h"
+
+// Deferral is a core language concept, but the Codex illustrates it with VSL
+// author functions like [first] and [count]. These tests stand in for them
+// with user-defined functions so only the language semantics are under test.
+
+void test_nested_author_functions(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[winegrape : Vitis vinifera]\n"
+					 "[echo : [argument]]\n"
+					 "[echo [winegrape]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Vitis vinifera");
+}
+
+void test_editor_function_preserved_through_vinification(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[defer foreign]\n"
+					 "[winegrape : [foreign Vitis vinifera]]\n"
+					 "[winegrape] originates from the Near East\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "[foreign Vitis vinifera] originates from the Near East");
+}
+
+void test_scope_lifting_preserves_wrapper(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(
+		ctx, "[defer foreign]\n"
+		     "[winegrape : [foreign Vitis vinifera]]\n"
+		     "[echo : [argument]]\n"
+		     "Other species of [echo [winegrape]] are mainly used for breeding.\n");
+
+	VUNIT_ASSERT_STREQ(
+		ctx, out,
+		"Other species of [foreign Vitis vinifera] are mainly used for breeding.");
+}
+
+void test_discard_policy_drops_editor_wrapper(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[defer foreign]\n"
+					 "[strip : [policy : discard][argument]]\n"
+					 "[strip [foreign a priori] [foreign in locus]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "a priori in locus");
+}
+
+void test_user_function_preserves_nested_editor(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[defer foreign]\n"
+					 "[my : [argument]]\n"
+					 "[my [foreign Vitis vinifera]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "[foreign Vitis vinifera]");
+}
+
+void test_policy_discard_declaration(struct vunit_test_ctx *ctx) {
+	char *out = compile_program(ctx, "[defer foreign]\n"
+					 "[plain : [policy : discard][argument]]\n"
+					 "[plain [foreign Vitis vinifera]]\n");
+
+	VUNIT_ASSERT_STREQ(ctx, out, "Vitis vinifera");
+}
+
+struct vunit_test tests[] = {
+	{ .name = "Plain nested user functions use applicative order",
+	  .test_func = test_nested_author_functions,
+	  .todo = true,
+	  .todo_msg = "[argument] expansion in nested user functions not implemented" },
+	{ .name = "Editor function is preserved across vinification",
+	  .test_func = test_editor_function_preserved_through_vinification,
+	  .todo = true,
+	  .todo_msg = "[defer ...] editor function preservation not implemented" },
+	{ .name = "Scope lifting preserves the editor wrapper",
+	  .test_func = test_scope_lifting_preserves_wrapper,
+	  .todo = true,
+	  .todo_msg = "[defer ...] scope lifting not implemented" },
+	{ .name = "[policy : discard] drops deferred editor wrappers from the argument",
+	  .test_func = test_discard_policy_drops_editor_wrapper,
+	  .todo = true,
+	  .todo_msg = "[policy : discard] not implemented" },
+	{ .name = "User-defined functions default to preserve policy",
+	  .test_func = test_user_function_preserves_nested_editor,
+	  .todo = true,
+	  .todo_msg = "default preserve policy for user functions not implemented" },
+	{ .name = "[policy : discard] explicitly set inside a user function",
+	  .test_func = test_policy_discard_declaration,
+	  .todo = true,
+	  .todo_msg = "[policy : discard] inside user function not implemented" },
+	{},
+};
+
+VUNIT_TEST_SUITE(tests)