alicorn 0.1.0

Rust embedding of the Alicorn compiler
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
-- SPDX-License-Identifier: Apache-2.0
-- SPDX-FileCopyrightText: 2025 Fundament Software SPC <https://fundament.software>

local traits = require "traits"
local pretty_printer = require "pretty-printer"

---@class (exact) Deriver
---@field record fun(t: RecordType, info: RecordDeriveInfo, override_pretty: fun(RecordType, PrettyPrint, ...), ...)
---@field enum fun(t: EnumType, info: EnumDeriveInfo, override_pretty: { [string]: fun(EnumType, PrettyPrint, ...) }, ...)

---@class (exact) RecordDeriveInfo
---@field kind string
---@field params string[]
---@field params_types Type[]

---@class (exact) UnitDeriveInfo
---@field kind string

---@class EnumDeriveInfoVariantKindContainer
local EnumDeriveInfoVariantKind = --[[@enum EnumDeriveInfoVariantKind]]
	{
		Record = "Record",
		Unit = "Unit",
	}

---@class (exact) EnumDeriveInfoVariant
---@field type EnumDeriveInfoVariantKind
---@field info RecordDeriveInfo | UnitDeriveInfo

---@class (exact) EnumDeriveInfo
---@field name string
---@field variants { [integer]: string, [string]: EnumDeriveInfoVariant }

local derive_print = function(...) end -- can make this call print(...) if you want to debug

local memo_meta = { __mode = "k" }
local function make_memo_table()
	return setmetatable({}, memo_meta)
end
local eq_memoizer = { memo = make_memo_table() }
function eq_memoizer:check(a, b)
	local memoa = self.memo[a]
	if memoa then
		return memoa[b]
	end
end
function eq_memoizer:set(a, b)
	if not self.memo[a] then
		self.memo[a] = make_memo_table()
	end
	self.memo[a][b] = true
end

---@type Deriver
local eq = {
	record = function(t, info)
		local kind = info.kind
		local params = info.params

		local checks = {}
		for i, param in ipairs(params) do
			checks[i] = string.format("left._record[%q] == right._record[%q]", param, param)
		end
		local all_checks = table.concat(checks, " and ")

		local chunk = [[
local eq_memoizer = ...
return function(left, right)
	if getmetatable(left) ~= getmetatable(right) then
		return false
	end
	if eq_memoizer:check(left, right) then
		return true
	end
	if %s then
		eq_memoizer:set(left, right)
		return true
	end
	return false
end]]
		chunk = chunk:format(all_checks)

		derive_print("derive eq: record chunk: " .. kind)
		derive_print("###")
		derive_print(chunk)
		derive_print("###")

		local compiled, message = load(chunk, "derive-eq_record", "t")
		if not compiled then
			error(message)
		end
		local eq_fn = compiled(eq_memoizer)
		t.__eq = eq_fn
	end,
	enum = function(t, info)
		local name = info.name
		local variants = info.variants

		local variants_checks = {}
		for n, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local vdata = variants[vname]
			local vtype = vdata.type
			local vinfo = vdata.info
			local all_checks
			if vtype == EnumDeriveInfoVariantKind.Record then
				local vparams = vinfo.params
				local checks = {}
				for i, param in ipairs(vparams) do
					checks[i] = string.format("left._record[%q] == right._record[%q]", param, param)
				end
				all_checks = table.concat(checks, " and ")
			elseif vtype == EnumDeriveInfoVariantKind.Unit then
				all_checks = "true"
			else
				error("unknown variant type: " .. vtype)
			end
			variants_checks[n] = string.format("[%q] = function(left, right) return %s end", vkind, all_checks)
		end
		local all_variants_checks = "	" .. table.concat(variants_checks, ",\n	") .. "\n"

		local chunk = [[
local eq_memoizer = ...
local all_variants_checks = {
%s
}
return function(left, right)
	if getmetatable(left) ~= getmetatable(right) then
		return false
	end
	if eq_memoizer:check(left, right) then
		return true
	end
	if left.kind == right.kind and all_variants_checks[left.kind](left, right) then
		eq_memoizer:set(left, right)
		return true
	end
	return false
end]]
		chunk = chunk:format(all_variants_checks)

		derive_print("derive eq: enum chunk: " .. name)
		derive_print("###")
		derive_print(chunk)
		derive_print("###")

		local compiled, message = load(chunk, "derive-eq_enum", "t")
		if not compiled then
			error(message)
		end
		local eq_fn = compiled(eq_memoizer)
		t.__eq = eq_fn
	end,
}

---@type Deriver
local is = {
	record = function()
		error("can't derive :is() for a record type")
	end,
	enum = function(t, info)
		local idx = t.methods or {}
		t.methods = idx
		local name = info.name
		local variants = info.variants

		for _, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local chunk = string.format("return function(self) return self.kind == %q end", vkind)

			derive_print("derive is: enum chunk: " .. vkind)
			derive_print("###")
			derive_print(chunk)
			derive_print("###")

			local compiled, message = load(chunk, "derive-is_enum", "t")
			if not compiled then
				error(message)
			end
			idx["is_" .. vname] = compiled()
		end
	end,
}

---@type Deriver
local unwrap = {
	record = function(t, info)
		local idx = t.methods or {}
		t.methods = idx
		local kind = info.kind
		local params = info.params

		local returns = {}
		for i, param in ipairs(params) do
			returns[i] = string.format("self._record[%q]", param)
		end
		local all_returns = table.concat(returns, ", ")

		local chunk = string.format("return function(self) return %s end", all_returns)

		derive_print("derive unwrap: record chunk: " .. kind)
		derive_print("###")
		derive_print(chunk)
		derive_print("###")

		local compiled, message = load(chunk, "derive-unwrap_record", "t")
		if not compiled then
			error(message)
		end
		idx["unwrap_" .. kind] = compiled()
	end,
	enum = function(t, info)
		local idx = t.methods or {}
		t.methods = idx
		local name = info.name
		local variants = info.variants

		for _, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local vdata = variants[vname]
			local vtype = vdata.type
			local vinfo = vdata.info
			local all_returns
			if vtype == EnumDeriveInfoVariantKind.Record then
				local vparams = vinfo.params
				local returns = {}
				for i, param in ipairs(vparams) do
					returns[i] = string.format("self._record[%q]", param)
				end
				all_returns = table.concat(returns, ", ")
			elseif vtype == EnumDeriveInfoVariantKind.Unit then
				all_returns = ""
			else
				error("unknown variant type: " .. vtype)
			end

			local chunk = [[
return function(self)
	if self.kind == %q then
		return %s
	else
		error("unwrap failed: unwrapping for a %s but found a " .. tostring(self))
	end
end]]
			chunk = chunk:format(vkind, all_returns, vkind)

			derive_print("derive unwrap: enum chunk: " .. vkind)
			derive_print("###")
			derive_print(chunk)
			derive_print("###")

			local compiled, message = load(chunk, "derive-unwrap_enum", "t")
			if not compiled then
				error(message)
			end
			idx["unwrap_" .. vname] = compiled()
		end
	end,
}

---@type Deriver
local as = {
	record = function()
		error("can't derive :as() for a record type")
	end,
	enum = function(t, info)
		local idx = t.methods or {}
		t.methods = idx
		local name = info.name
		local variants = info.variants

		for _, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local vdata = variants[vname]
			local vtype = vdata.type
			local vinfo = vdata.info
			local all_returns
			if vtype == EnumDeriveInfoVariantKind.Record then
				local vparams = vinfo.params
				local returns = { "true" }
				for i, param in ipairs(vparams) do
					returns[i + 1] = string.format("self._record[%q]", param)
				end
				all_returns = table.concat(returns, ", ")
			elseif vtype == EnumDeriveInfoVariantKind.Unit then
				all_returns = "true"
			else
				error("unknown variant type: " .. vtype)
			end

			local chunk = [[
return function(self)
	if self.kind == %q then
		return %s
	else
		return false
	end
end]]
			chunk = chunk:format(vkind, all_returns)

			derive_print("derive as: enum chunk: " .. vkind)
			derive_print("###")
			derive_print(chunk)
			derive_print("###")

			local compiled, message = load(chunk, "derive-as_enum", "t")
			if not compiled then
				error(message)
			end
			idx["as_" .. vname] = compiled()
		end
	end,
}

---@param info RecordDeriveInfo
---@return fun(self: Type, pp: PrettyPrint, ...)
local function record_pretty_printable_trait(info)
	local kind = info.kind
	local params = info.params

	---@type string[]
	local fields = {}
	for i, param in ipairs(params) do
		fields[i] = string.format("{ %q, self._record[%q] }", param, param)
	end
	local all_fields = "		" .. table.concat(fields, ",\n		") .. "\n"

	local chunk = [[
return function(self, pp, ...)
    local fields = {
%s
	}
    -- fields[#fields + 1] = (self["{ID}"] ~= nil) and { "{ID}", self["{ID}"] } or nil
    fields[#fields + 1] = (self["{TRACE}"] ~= nil) and { "{TRACE}", self["{TRACE}"] } or nil
	pp:record(%q, fields, ...)
end]]
	chunk = chunk:format(all_fields, kind)

	derive_print("derive pretty_printable_trait chunk: " .. kind)
	derive_print("###")
	derive_print(chunk)
	derive_print("###")

	local compiled, message = load(chunk, "derive-pretty_printable_trait", "t")
	if not compiled then
		print(chunk)
		error(message)
	end
	return compiled()
end

---@type Deriver
local pretty_print = {
	record = function(t, info, override_pretty)
		local pretty_printable_print = record_pretty_printable_trait(info)
		local pretty_print = override_pretty or pretty_printable_print
		local default_print = pretty_printable_print

		traits.pretty_print:implement_on(t, { pretty_print = pretty_print, default_print = default_print })

		-- must be added here, instead of earlier in terms-gen, otherwise a type that doesn't derive
		-- pretty_print will cause pretty_print to call __tostring and loop until stack overflow
		t.__tostring = pretty_printer.pretty_print
	end,
	enum = function(t, info, override_pretty)
		local name = info.name
		local variants = info.variants

		local variant_pretty_printers = {}
		local variant_default_printers = {}
		for _, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local vdata = variants[vname]
			local vtype = vdata.type
			local vinfo = vdata.info
			local override_pretty_v = override_pretty and override_pretty[vname]
			local variant_pretty_printable_print
			if vtype == EnumDeriveInfoVariantKind.Record then
				---@cast vinfo RecordDeriveInfo
				variant_pretty_printable_print = record_pretty_printable_trait(vinfo)
			elseif vtype == EnumDeriveInfoVariantKind.Unit then
				variant_pretty_printable_print = function(self, pp)
					pp:unit(self.kind)
				end
			else
				error("unknown variant type: " .. vtype)
			end
			variant_pretty_printers[vkind] = override_pretty_v or variant_pretty_printable_print
			variant_default_printers[vkind] = variant_pretty_printable_print
		end

		local function pretty_print(self, pp, ...)
			return variant_pretty_printers[self.kind](self, pp, ...)
		end
		local function default_print(self, pp, ...)
			return variant_default_printers[self.kind](self, pp, ...)
		end

		traits.pretty_print:implement_on(t, { pretty_print = pretty_print, default_print = default_print })

		-- must be added here, instead of earlier in terms-gen, otherwise a type that
		-- doesn't derive pretty_print will cause pretty_print to loop __tostring forever
		t.__tostring = pretty_printer.pretty_print
	end,
}

---@type Deriver
local diff = {
	record = function(t, info)
		local params = info.params
		local params_types = info.params_types

		local function diff_fn(left, right)
			print("diffing param kind: " .. left.kind)
			local rt = getmetatable(right)
			if t ~= rt then
				print("unequal types!")
				print(t)
				print(rt)
				print("stopping diff")
				return
			end
			if left.kind ~= right.kind then
				print("unequal kinds!")
				print(left.kind)
				print(right.kind)
				print("stopping diff")
				return
			end
			local n = 0
			local diff_params = {}
			local diff_params_types = {}
			for i, param in ipairs(params) do
				if left._record[param] ~= right._record[param] then
					n = n + 1
					diff_params[n] = param
					diff_params_types[n] = param_types[i]
				end
			end
			if n == 0 then
				print("no difference")
				print("stopping diff")
				return
			elseif n == 1 then
				local d = diff_params[1]
				local dt = diff_params_types[1]
				print("difference in param: " .. d)
				local diff_impl = traits.diff:get(dt)
				if diff_impl then
					-- tail call
					return diff_impl.diff(left._record[d], right._record[d])
				else
					print("stopping diff (missing diff impl)")
					print("type:", dt)
					return
				end
			else
				print("difference in multiple params:")
				for i = 1, n do
					print(diff_params[i])
				end
				print("stopping diff")
				return
			end
		end

		traits.diff:implement_on(t, { diff = diff_fn })
	end,
	enum = function(t, info)
		local name = info.name
		local variants = info.variants

		---@type (fun(left, right))[]
		local variants_checks = {}
		for _, vname in ipairs(variants) do
			local vkind = name .. "." .. vname
			local vdata = variants[vname]
			local vtype = vdata.type
			local vinfo = vdata.info
			---@type fun(left, right)
			local vcheck
			if vtype == EnumDeriveInfoVariantKind.Record then
				---@cast vinfo RecordDeriveInfo
				function vcheck(left, right)
					local vparams = vinfo.params
					local vparams_types = vinfo.params_types
					local n = 0
					local diff_params = {}
					local diff_params_types = {}
					for i, param in ipairs(vparams) do
						if left._record[param] ~= right._record[param] then
							n = n + 1
							diff_params[n] = param
							diff_params_types[n] = vparams_types[i]
						end
					end
					if n == 0 then
						print("no difference")
						print("stopping diff")
						return
					elseif n == 1 then
						local d = diff_params[1]
						local dt = diff_params_types[1]
						print("difference in param: " .. d)
						local diff_impl = traits.diff:get(dt)
						if diff_impl then
							-- tail call
							return diff_impl.diff(left._record[d], right._record[d])
						else
							print("stopping diff (missing diff impl)")
							print("type:", dt)
							return
						end
					else
						print("difference in multiple params:")
						for i = 1, n do
							print(diff_params[i])
						end
						print("stopping diff")
						return
					end
				end
			elseif vtype == EnumDeriveInfoVariantKind.Unit then
				function vcheck(_left, _right)
					print("no difference")
					print("stopping diff")
				end
			else
				error("unknown variant type: " .. vtype)
			end
			variants_checks[vkind] = vcheck
		end

		local function diff_fn(left, right)
			print("diffing enum kind: " .. left.kind)
			local rt = getmetatable(right)
			if t ~= rt then
				print("unequal types!")
				print(t)
				print(rt)
				print("stopping diff")
				return
			end
			if left.kind ~= right.kind then
				print("unequal kinds!")
				print(left.kind)
				print(right.kind)
				print("stopping diff")
				return
			end
			variants_checks[left.kind](left, right)
		end

		traits.diff:implement_on(t, { diff = diff_fn })
	end,
}

---@type Deriver
local freeze = {
	-- freezing a record value or enum value does nothing because these
	-- values are already intended to be immutable
	-- however, their current implementation doesn't lend itself easily to
	-- actually preventing modification of existing fields
	-- (this is fixable)
	record = function(t, info)
		local function freeze_fn(t, val)
			return val
		end

		traits.freeze:implement_on(t, { freeze = freeze_fn })
	end,
	enum = function(t, info)
		local function freeze_fn(t, val)
			return val
		end

		traits.freeze:implement_on(t, { freeze = freeze_fn })
	end,
}

-- build_record_function = (trait, info) -> function that implements the trait method
-- specializations - optional specialized implementations for particular variants
local function trait_method(trait, method, build_record_function, specializations)
	specializations = specializations or {}
	return {
		record = function(t, info)
			trait:implement_on(t, {
				[method] = build_record_function(trait, t, info),
			})
		end,
		enum = function(t, info)
			local name = info.name
			local variants = info.variants

			local variant_impls = {}
			for _, vname in ipairs(variants) do
				local vkind = name .. "." .. vname
				local vdata = variants[vname]
				local vtype = vdata.type
				local vinfo = vdata.info
				if specializations[vname] then
					variant_impls[vkind] = specializations[vname]
				elseif vtype == EnumDeriveInfoVariantKind.Record then
					variant_impls[vkind] = build_record_function(trait, t, vinfo)
				elseif vtype == EnumDeriveInfoVariantKind.Unit then
					variant_impls[vkind] = function(self, other)
						return self == other
					end
				else
					error("unknown variant type: " .. vtype)
				end
			end

			local chunk = [[
local variant_impls = ...
return function(self, other)
	return variant_impls[self.kind](self, other)
end]]

			derive_print("derive trait_method: enum chunk: " .. name)
			derive_print("###")
			derive_print(chunk)
			derive_print("###")

			local compiled, message = load(chunk, "derive-trait_method_enum", "t")
			if not compiled then
				error(message)
			end
			trait:implement_on(t, {
				[method] = compiled(variant_impls),
			})
		end,
	}
end

-- local typed = terms.inferrable_term.typed(terms.flex_value.number_type, gen.declare_array(gen.builtin_integer)(), terms.typed_term.literal(terms.flex_value.number(1)))
-- p(typed)
-- p(getmetatable(typed))
-- p(terms.inferrable_term == getmetatable(typed))

return {
	EnumDeriveInfoVariantKind = EnumDeriveInfoVariantKind,
	eq = eq,
	is = is,
	unwrap = unwrap,
	as = as,
	pretty_print = pretty_print,
	diff = diff,
	freeze = freeze,
	trait_method = trait_method,
}