generate: Generator compiles

This is a stupid fucking restriction

design/branched-generated-encoder.md

@@ -0,0 +1,128 @@
+# Branched Generated Decoder
+
+Pasted here because Tebitea is down
+
+## The problem
+
+TAPE is designed so that the decoder can gloss over data it does not understand.
+Technically the protocol allows for this, but I completely forgot to implement
+this in the generated decoder, oops. This would be trivial if TAPE messages were
+still flat tables, but they aren't, because those aren't useful enough. So,
+let's analyze the problem.
+
+## When it happens
+
+There are two reasons something might not match up with the expected data:
+
+The first and most obvious is unrecognized keys. If the key is not in the set of
+recognized keys for a KTV, it should leave the corresponding struct field blank.
+Once #6 has been implemented, throw an error if the data was not optional.
+
+The second is wrong types. If we are expecting KTV and get SBA, we should leave
+the data as empty. The aforementioned concern about #6 also applies here. We
+don't need to worry about special cases at the structure root, because it would
+be technically possible to make the structure root an option, so it really is
+just a normal value. Until #6, we will leave that blank too.
+
+## Preliminary ideas
+
+The first is going to be pretty simple. All we need to do is have a skimmer
+function that skims over TAPE data very, and then call that on the KTV value
+each time we run into a mystery key. It should only return an error if the
+structure of the data is malformed in such a way that it cannot continue to the
+next one. This should be stored in the tape package alongside the dynamic
+decoding functions, because they will essentially function the same way and
+could probably share lots of code.
+
+The second is a bit more complicated because of the existence of KTV and OTA
+because they are aggregate types. Go types work a bit differently, as if you
+have an array of an array of an array of ints, that information is represented
+in one place, whereas TAPE doesn't really do that. All of that information is
+sort of buried within the data structure, so we don't know what we will be
+decoding before we actually do it. Whenever we encounter a type we don't expect,
+we would need to abort decoding of the entire data structure, and then skim over
+whatever detritus is left, which would literally be in a half-decoded state. The
+fact that the code is generated flat and thus cannot use return or defer
+statements contributes to the complexity of this problem. We need to go up, but
+we can't. There is no up, only forward.
+
+Of course, the dynamic decoder does not have this problem in the first place
+because it doesn't expect anything, and constructs the destination to fit
+whatever it sees in the TAPE structure as it is decoding it. KTVs are completely
+dynamic because they are implemented as maps, so the only time it needs to
+completely comprehend a type is with OTAs. There is a function called typeOf
+that gets the type of the current tag and returns it as a reflect.Type, which
+necessitates recursion and peeking at OTAs and their elements.
+
+We could try to do the same thing in the generated decoder, comparing the
+determined type against the expected type to try to figure out whether we should
+decode an array or a table, etc. This is immediately problematic as it requires
+memory to be allocated, both for the peek buffer and the resulting tree of type
+information. If we end up with some crazy way to keep track of the types, that's
+only one half of the allocation problem and we would still be spending extra
+cycles going over all of that twice.
+
+## Performance constraints
+
+The generated decoder is supposed to blaze through data, and it can't do that if
+it does all the singing and dancing that the dynamic decoder does. It's time for
+some performance constraints:
+
+- No allocations, except as required to build the destination for the data
+- No redundant work
+- So, no freaking peeking
+- It should take well under 500 lines of generated code to decode one message of
+reasonable size (i.e. be careful not to bloat the binary)
+
+I'm not really going to do my usual thing here of making a slow version and
+speeding it up over time based on evidence and experimentation because these
+constraints inform the design so much it would be impossible to continue without
+them. I am 99% confident that these constraints will allow for an acceptable
+baseline of performance (for generated code) and we can still profile and
+micro-optimize later. This is good enough for me.
+Heavy solution
+
+There is a solution that might work very well which involves completely redoing
+the generated decoding code. We could create a function for every source type to
+destination type mapping that exists in protocol, and then compose them all
+together. The decoding methods for each message or type would be wrappers around
+the correct function for their root TAPE -> Go type mapping. The main benefit of
+this is it would make this problem a lot more manageable because the interface
+points between the data would be represented by function boundaries. This would
+allow the use of return and defer statements, and would allow more code sharing,
+producing a smaller binary. Go would probably inline these where needed.
+
+Would this work? Probably. More investigation is required to make sure. I want
+to stop re-writing things I don't need to. On the other hand, it is just the
+decoder.
+
+## Light solution
+
+TODO: find a solution that satisfies the performance constraints, keeps the same
+identical interface, and works off the same code. I am convinced this is doable,
+and it might even allow us to extract more data from an unexpected structure.
+However, continuing this way might introduce unmanageable complexity. It is
+already a little unmanageable and I am just one pony (kind of).
+
+## Implementation
+
+Heavy solution is going to work here, applied to only the points of
+`Generator.generateDecodeValue` where it decodes an aggregate data structure.
+That way, only minimal amounts of code need to be redone.
+
+Whenever a branch needs to happen, a call shall be generated, a deferred
+implementation request shall be added to a special FIFO queue within the
+generator. After generating data structures and their root decoding functions,
+the generator shall pick away at this queue until no requests remain. The
+generator shall accept new items during this process, so that recursion is
+possible. This is all to ensure it is only ever writing one function at a time
+
+The functions shall take a pointer to a type that accepts any type like (~) the
+destination's base type. We should also probably just call
+`Generator.generateDecodeValue` directly on user defined types this way, keeping
+their public `Decode` methods just for convenience.
+
+The tape package shall contain a skimming function that takes a decoder and a
+tag, and recursively consumes the decoder given the context of the tag. This
+shall be utilized by the decoder functions to skip over values if their tags
+or keys do not match up with what is expected.

generate/generate.go

@@ -6,6 +6,7 @@ import "maps"
 import "math"
 import "slices"
 import "strings"
+import "encoding/hex"
 import "git.tebibyte.media/sashakoshka/hopp/tape"
 
 const imports =
@@ -33,6 +34,19 @@ type Message interface {
 	// Method returns the method code of the message.
 	Method() uint16
 }
+
+// canAssign determines if data from the given source tag can be assigned to
+// a Go type represented by destination. It is designed to receive destination
+// values from [generate.Generator.generateCanAssign]. The eventual Go type and
+// the destination tag must come from the same (or hash-equivalent) PDL type.
+func canAssign(destination, source tape.Tag) bool {
+	if destination.Is(source) { return true }
+	if (destination == tape.SBA || destination == tape.LBA) &&
+		(source == tape.SBA || source == tape.LBA) {
+		return true
+	}
+	return false
+}
 `
 
 // Generator converts protocols into Go code.
@@ -46,6 +60,14 @@ type Generator struct {
 	nestingLevel int
 	temporaryVar int
 	protocol     *Protocol
+
+	decodeBranchRequestQueue []decodeBranchRequest
+}
+
+type decodeBranchRequest struct {
+	hash [16]byte
+	typ  Type
+	name string
 }
 
 func (this *Generator) Generate(protocol *Protocol) (n int, err error) {
@@ -79,6 +101,14 @@ func (this *Generator) Generate(protocol *Protocol) (n int, err error) {
 		n += nn; if err != nil { return n, err }
 	}
 
+	// request queue
+	for {
+		hash, typ, name, ok := this.pullDecodeBranchRequest()
+		if !ok { break }
+		nn, err := this.generateDecodeBranch(hash, typ, name)
+		n += nn; if err != nil { return n, err }
+	}
+
 	return n, nil
 }
 
@@ -146,7 +176,25 @@ func (this *Generator) generateTypedef(name string, typ Type) (n int, err error)
 	this.push()
 		nn, err = this.iprintf("var nn int\n")
 		n += nn; if err != nil { return n, err }
-		nn, err = this.generateDecodeValue(typ, "this", "tag")
+
+		nn, err = this.iprintf("if !(")
+		n += nn; if err != nil { return n, err }
+		nn, err = this.generateCanAssign(typ, "tag")
+		n += nn; if err != nil { return n, err }
+		nn, err = this.printf(") {\n")
+		n += nn; if err != nil { return n, err }
+		this.push()
+			nn, err = this.iprintf("nn, err = tape.Skim(decoder, tag)\n")
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("return n, nil\n")
+			n += nn; if err != nil { return n, err }
+		this.pop()
+		nn, err = this.iprintf("}\n")
+		n += nn; if err != nil { return n, err }
+		
+		nn, err = this.generateDecodeValue(typ, name, "this", "tag")
 		n += nn; if err != nil { return n, err }
 		nn, err = this.iprintf("return n, nil\n")
 		n += nn; if err != nil { return n, err }
@@ -217,7 +265,25 @@ func (this *Generator) generateMessage(method uint16, message Message) (n int, e
 		n += nn; if err != nil { return n, err }
 		nn, err = this.generateErrorCheck()
 		n += nn; if err != nil { return n, err }
-		nn, err = this.generateDecodeValue(message.Type, "this", "tag")
+
+		nn, err = this.iprintf("if !(")
+		n += nn; if err != nil { return n, err }
+		nn, err = this.generateCanAssign(message.Type, "tag")
+		n += nn; if err != nil { return n, err }
+		nn, err = this.printf(") {\n")
+		n += nn; if err != nil { return n, err }
+		this.push()
+			nn, err = this.iprintf("nn, err = tape.Skim(decoder, tag)\n")
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("return n, nil\n")
+			n += nn; if err != nil { return n, err }
+		this.pop()
+		nn, err = this.iprintf("}\n")
+		n += nn; if err != nil { return n, err }
+		
+		nn, err = this.generateDecodeValue(message.Type, this.resolveMessageName(message.Name), "this", "tag")
 		n += nn; if err != nil { return n, err }
 		nn, err = this.iprintf("return n, nil\n")
 		n += nn; if err != nil { return n, err }
@@ -272,8 +338,8 @@ func (this *Generator) generateEncodeValue(typ Type, valueSource, tagSource stri
 		n += nn; if err != nil { return n, err }
 		this.push()
 			nn, err = this.iprintf(
-				"nn, err = encoder.WriteUintN(uint64(%s.CN()), len(%s))\n",
-				tagSource, valueSource)
+				"nn, err = encoder.WriteUintN(uint64(len(%s)), %s.CN())\n",
+				valueSource, tagSource)
 			n += nn; if err != nil { return n, err }
 			nn, err = this.generateErrorCheck()
 			n += nn; if err != nil { return n, err }
@@ -288,8 +354,8 @@ func (this *Generator) generateEncodeValue(typ Type, valueSource, tagSource stri
 	case TypeArray:
 		// OTA: <length: UN> <elementTag: tape.Tag> <values>*
 		nn, err := this.iprintf(
-			"nn, err = encoder.WriteUintN(uint64(%s.CN()), len(%s))\n",
-			tagSource, valueSource)
+			"nn, err = encoder.WriteUintN(uint64(len(%s)), %s.CN())\n",
+			valueSource, tagSource)
 		n += nn; if err != nil { return n, err }
 		nn, err = this.generateErrorCheck()
 		n += nn; if err != nil { return n, err }
@@ -325,6 +391,10 @@ func (this *Generator) generateEncodeValue(typ Type, valueSource, tagSource stri
 			n += nn; if err != nil { return n, err }
 			nn, err = this.iprintf("if itemTag.Is(tape.SBA) { itemTag += 1 << 5 }\n")
 			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("nn, err = encoder.WriteTag(itemTag)\n")
+			n += nn; if err != nil { return n, err }
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
 			nn, err = this.iprintf("for _, item := range %s {\n", valueSource)
 			n += nn; if err != nil { return n, err }
 			this.push()
@@ -347,8 +417,8 @@ func (this *Generator) generateEncodeValue(typ Type, valueSource, tagSource stri
 	case TypeTableDefined:
 		// KTV: <length: UN> (<key: U16> <tag: Tag> <value>)*
 		nn, err := this.iprintf(
-			"nn, err = encoder.WriteUintN(uint64(%s.CN()), %d)\n",
-			tagSource, len(typ.Fields))
+			"nn, err = encoder.WriteUintN(%d, %s.CN())\n",
+			len(typ.Fields), tagSource)
 		n += nn; if err != nil { return n, err }
 		nn, err = this.generateErrorCheck()
 		n += nn; if err != nil { return n, err }
@@ -402,13 +472,18 @@ func (this *Generator) generateEncodeValue(typ Type, valueSource, tagSource stri
 //   - n int
 //   - err error
 //   - nn int
-func (this *Generator) generateDecodeValue(typ Type, valueSource, tagSource string) (n int, err error) {
+//
+// The typeName paramterer is handled in the way described in the documentation
+// for [Generator.generateDecodeBranch].
+func (this *Generator) generateDecodeValue(typ Type, typeName, valueSource, tagSource string) (n int, err error) {
 	switch typ := typ.(type) {
 	case TypeInt:
 		// SI: (none)
 		// LI: <value: IntN>
 		if typ.Bits <= 5 {
-			// SI stores the value in the tag, so we write nothing here
+			// SI stores the value in the tag
+			nn, err := this.iprintf("*%s = uint8(%s.CN())\n", valueSource, tagSource)
+			n += nn; if err != nil { return n, err }
 			break
 		}
 		prefix := "ReadUint"
@@ -421,7 +496,7 @@ func (this *Generator) generateDecodeValue(typ Type, valueSource, tagSource stri
 		n += nn; if err != nil { return n, err }
 	case TypeFloat:
 		// FP: <value: FloatN>
-		nn, err := this.iprintf("%s, nn, err = decoder.ReadFloat%d(%s)\n", valueSource, typ.Bits)
+		nn, err := this.iprintf("*%s, nn, err = decoder.ReadFloat%d()\n", valueSource, typ.Bits)
 		n += nn; if err != nil { return n, err }
 		nn, err = this.generateErrorCheck()
 		n += nn; if err != nil { return n, err }
@@ -466,37 +541,7 @@ func (this *Generator) generateDecodeValue(typ Type, valueSource, tagSource stri
 		}
 	case TypeArray:
 		// OTA: <length: UN> <elementTag: tape.Tag> <values>*
-		lengthVar := this.newTemporaryVar("length")
-		nn, err := this.iprintf("var %s uint64\n", lengthVar)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf(
-			"%s, nn, err = decoder.ReadUintN(int(%s.CN()))\n",
-			lengthVar, tagSource)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.generateErrorCheck()
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf("*%s = make(", valueSource)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.generateType(typ)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.printf(", int(%s))\n", lengthVar)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf("var itemTag tape.Tag\n")
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf("itemTag, nn, err = decoder.ReadTag()\n")
-		n += nn; if err != nil { return n, err }
-		nn, err = this.generateErrorCheck()
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf("for index := range %s {\n", lengthVar)
-		n += nn; if err != nil { return n, err }
-		this.push()
-			nn, err = this.generateDecodeValue(
-				typ.Element,
-				fmt.Sprintf("(&(*%s)[index])", valueSource),
-				"itemTag")
-			n += nn; if err != nil { return n, err }
-		this.pop()
-		nn, err = this.iprintf("}\n")
+		nn, err := this.generateDecodeBranchCall(typ, typeName, valueSource, tagSource)
 		n += nn; if err != nil { return n, err }
 	case TypeTable:
 		// KTV: <length: UN> (<key: U16> <tag: Tag> <value>)*
@@ -508,50 +553,7 @@ func (this *Generator) generateDecodeValue(typ Type, valueSource, tagSource stri
 		n += nn; if err != nil { return n, err }
 	case TypeTableDefined:
 		// KTV: <length: UN> (<key: U16> <tag: Tag> <value>)*
-		lengthVar := this.newTemporaryVar("length")
-		nn, err := this.iprintf("var %s uint64\n", lengthVar)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf(
-			"%s, nn, err = decoder.ReadUintN(int(%s.CN()))\n",
-			lengthVar, tagSource)
-		n += nn; if err != nil { return n, err }
-		nn, err = this.generateErrorCheck()
-		n += nn; if err != nil { return n, err }
-		nn, err = this.iprintf("for _ = range %s {\n", lengthVar)
-		n += nn; if err != nil { return n, err }
-		this.push()
-			nn, err = this.iprintf("var key uint16\n")
-			n += nn; if err != nil { return n, err }
-			nn, err = this.iprintf("key, nn, err = decoder.ReadUint16()\n")
-			n += nn; if err != nil { return n, err }
-			nn, err = this.generateErrorCheck()
-			n += nn; if err != nil { return n, err }
-			nn, err = this.iprintf("var itemTag tape.Tag\n")
-			n += nn; if err != nil { return n, err }
-			nn, err = this.iprintf("itemTag, nn, err = decoder.ReadTag()\n")
-			n += nn; if err != nil { return n, err }
-			nn, err = this.generateErrorCheck()
-			n += nn; if err != nil { return n, err }
-			nn, err = this.iprintf("switch key {\n")
-			n += nn; if err != nil { return n, err }
-			keys := slices.Collect(maps.Keys(typ.Fields))
-			slices.Sort(keys)
-			for _, key := range keys {
-				field := typ.Fields[key]
-				nn, err = this.iprintf("case 0x%04X:\n", key)
-				n += nn; if err != nil { return n, err }
-				this.push()
-					nn, err = this.generateDecodeValue(
-						field.Type,
-						fmt.Sprintf("(&%s.%s)", valueSource, field.Name),
-						"itemTag")
-					n += nn; if err != nil { return n, err }
-				this.pop()
-			}
-			nn, err = this.iprintf("}\n")
-			n += nn; if err != nil { return n, err }
-		this.pop()
-		nn, err = this.iprintf("}\n")
+		nn, err := this.generateDecodeBranchCall(typ, typeName, valueSource, tagSource)
 		n += nn; if err != nil { return n, err }
 	case TypeNamed:
 		// WHATEVER: [WHATEVER]
@@ -566,6 +568,263 @@ func (this *Generator) generateDecodeValue(typ Type, valueSource, tagSource stri
 	return n, nil
 }
 
+// generateDecodeBranchCall generates code to call an aggregate decoder function,
+// for a specified type. The definition of the function is deferred so no
+// duplicates are created. The function overwrites memory pointed to by the
+// variable (or parenthetical statement) specified by valueSource, and the value
+// will be encoded according to the tag stored in the variable (or parenthetical
+// statement) specified by tagSource. the code generated is a BLOCK and expects
+// these variables to be defined:
+//
+//   - decoder *tape.Decoder
+//   - n int
+//   - err error
+//   - nn int
+//
+// The typeName paramterer is handled in the way described in the documentation
+// for [Generator.generateDecodeBranch].
+func (this *Generator) generateDecodeBranchCall(typ Type, typeName, valueSource, tagSource string) (n int, err error) {
+	hash := HashType(typ)
+	nn, err := this.iprintf(
+		"nn, err = %s(%s, decoder, %s)\n",
+		this.decodeBranchName(hash, typeName), valueSource, tagSource)
+	n += nn; if err != nil { return n, err }
+	nn, err = this.generateErrorCheck()
+	n += nn; if err != nil { return n, err }
+	this.pushDecodeBranchRequest(hash, typ, typeName)
+	return n, nil
+}
+
+// generateDecodeBranch generates an aggregate decoder function definition for a
+// specified type. It assumes that hash == HashType(typ). If typeName is not
+// empty, it will be used as the type in the argument list instead of the result
+// of [Generator.generateType].
+func (this *Generator) generateDecodeBranch(hash [16]byte, typ Type, typeName string) (n int, err error) {
+	nn, err := this.iprintf("\nfunc %s(this *", this.decodeBranchName(hash, typeName))
+	n += nn; if err != nil { return n, err }
+	if typeName == "" {
+		nn, err = this.generateType(typ)
+		n += nn; if err != nil { return n, err }
+	} else {
+		nn, err = this.print(typeName)
+		n += nn; if err != nil { return n, err }	
+	}
+	nn, err = this.printf(", decoder *tape.Decoder, tag tape.Tag) (n int, err error) {\n")
+	n += nn; if err != nil { return n, err }
+	this.push()
+	
+		nn, err = this.iprintf("var nn int\n")
+		n += nn; if err != nil { return n, err }
+		
+		switch typ := typ.(type) {
+		case TypeArray:
+			// OTA: <length: UN> <elementTag: tape.Tag> <values>*
+			// read header
+			lengthVar := this.newTemporaryVar("length")
+			nn, err := this.iprintf("var %s uint64\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("%s, nn, err = decoder.ReadUintN(int(tag.CN()))\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
+			n += nn; if err != nil { return n, err }
+			elementTagVar := this.newTemporaryVar("elementTag")
+			nn, err = this.iprintf("var %s tape.Tag\n", elementTagVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("%s, nn, err = decoder.ReadTag()\n", elementTagVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
+			n += nn; if err != nil { return n, err }
+
+			// abort macro
+			abort := func() (n int, err error) {
+				// skim entire array
+				nn, err = this.iprintf("for _ = range %s {\n", lengthVar)
+				n += nn; if err != nil { return n, err }
+				this.push()
+					nn, err = this.iprintf("nn, err = tape.Skim(decoder, %s)\n", elementTagVar)
+					n += nn; if err != nil { return n, err }
+					nn, err = this.generateErrorCheck()
+					n += nn; if err != nil { return n, err }
+				this.pop()
+				nn, err = this.iprintf("}\n")
+				n += nn; if err != nil { return n, err }
+				nn, err = this.iprintf("return n, nil\n")
+				n += nn; if err != nil { return n, err }
+				return n, nil
+			}
+	
+			// validate header
+			// TODO: here, validate that length is less than the
+			// max, whatever that is configured to be. the reason we
+			// want to read it here is that we would have to skip
+			// the tag anyway so why not.
+			nn, err = this.iprintf("if !(")
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateCanAssign(typ.Element, elementTagVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.printf(") {\n")
+			n += nn; if err != nil { return n, err }
+			this.push()
+				nn, err = abort()
+				n += nn; if err != nil { return n, err }
+			this.pop()
+			nn, err = this.iprintf("}\n")
+			n += nn; if err != nil { return n, err }
+
+			// decode payloads
+			nn, err = this.iprintf("*this = make(")
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateType(typ)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.printf(", %s)\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("for index := range int(%s) {\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			this.push()
+				nn, err = this.generateDecodeValue(typ.Element, "", "(&(*this)[index])", elementTagVar)
+				n += nn; if err != nil { return n, err }
+			this.pop()
+			nn, err = this.iprintf("}\n")
+			n += nn; if err != nil { return n, err }
+		case TypeTableDefined:
+			// KTV: <length: UN> (<key: U16> <tag: Tag> <value>)*
+			// read header
+			lengthVar := this.newTemporaryVar("length")
+			nn, err := this.iprintf("var %s uint64\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.iprintf("%s, nn, err = decoder.ReadUintN(int(tag.CN()))\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			nn, err = this.generateErrorCheck()
+			n += nn; if err != nil { return n, err }
+			
+			// validate header
+			// TODO: here, validate that length is less than the
+			// max, whatever that is configured to be. if not, stop
+			// ALL decoding. skimming huge big ass data could cause
+			// problems
+
+			// read fields
+			nn, err = this.iprintf("for _ = range int(%s) {\n", lengthVar)
+			n += nn; if err != nil { return n, err }
+			this.push()
+				// read field header
+				fieldKeyVar := this.newTemporaryVar("fieldKey")
+				nn, err = this.iprintf("var %s uint16\n", fieldKeyVar)
+				n += nn; if err != nil { return n, err }
+				nn, err = this.iprintf("%s, nn, err = decoder.ReadUint16()\n", fieldKeyVar)
+				n += nn; if err != nil { return n, err }
+				nn, err = this.generateErrorCheck()
+				n += nn; if err != nil { return n, err }
+				fieldTagVar := this.newTemporaryVar("fieldTag")
+				nn, err = this.iprintf("var %s tape.Tag\n", fieldTagVar)
+				n += nn; if err != nil { return n, err }
+				nn, err = this.iprintf("%s, nn, err = decoder.ReadTag()\n", fieldTagVar)
+				n += nn; if err != nil { return n, err }
+				nn, err = this.generateErrorCheck()
+				n += nn; if err != nil { return n, err }
+
+				// abort field macro
+				abortField := func() (n int, err error) {
+					nn, err = this.iprintf("tape.Skim(decoder, %s)\n", fieldTagVar)
+					n += nn; if err != nil { return n, err }
+					nn, err = this.iprintf("continue\n")
+					n += nn; if err != nil { return n, err }
+					return n, nil
+				}
+
+				// switch on tag
+				nn, err = this.iprintf("switch %s {\n", fieldKeyVar)
+				n += nn; if err != nil { return n, err }
+				for _, key := range slices.Sorted(maps.Keys(typ.Fields)) {
+					field := typ.Fields[key]
+					nn, err = this.iprintf("case 0x%04X:\n", key)
+					n += nn; if err != nil { return n, err }
+					this.push()
+
+					// validate field header
+					nn, err = this.iprintf("if !(")
+					n += nn; if err != nil { return n, err }
+					nn, err = this.generateCanAssign(field.Type, fieldTagVar)
+					n += nn; if err != nil { return n, err }
+					nn, err = this.printf(") {\n")
+					n += nn; if err != nil { return n, err }
+					this.push()
+						nn, err = abortField()
+						n += nn; if err != nil { return n, err }
+					this.pop()
+					nn, err = this.iprintf("}\n")
+					n += nn; if err != nil { return n, err }
+
+					// decode payload
+					nn, err = this.generateDecodeValue(
+						field.Type, "",
+						fmt.Sprintf("(&(this.%s))", field.Name), fieldTagVar)
+					n += nn; if err != nil { return n, err }
+					this.pop()
+				}					
+				nn, err = this.iprintf("default:\n")
+				n += nn; if err != nil { return n, err }
+				this.push()
+					abortField()
+				this.pop()
+				nn, err = this.iprintf("}\n")
+				n += nn; if err != nil { return n, err }
+			this.pop()
+			nn, err = this.iprintf("}\n")
+			n += nn; if err != nil { return n, err }
+			
+			// TODO once options are implemented, have a set of
+			// bools for each non-optional field, and check here
+			// that they are all true. a counter will not work
+			// because if someone specifies a non-optional field
+			// twice, they can neglect to specify another
+			// non-optional field and we won't even know because the
+			// count will still be even. we shouldn't use a map
+			// either because its an allocation and its way more
+			// memory than just, like 5 bools (on the stack no less)
+		default: return n, fmt.Errorf("unexpected type: %T", typ)
+		}
+
+		nn, err = this.iprintf("return n, nil\n")
+		
+	this.pop()
+	nn, err = this.iprintf("}\n")
+	n += nn; if err != nil { return n, err }
+	return n, nil
+}
+
+func (this *Generator) decodeBranchName(hash [16]byte, name string) string {
+	if name == "" {
+		return fmt.Sprintf("decodeBranch_%s", hex.EncodeToString(hash[:]))
+	} else {
+		return fmt.Sprintf("decodeBranch_%s_%s", hex.EncodeToString(hash[:]), name)
+	}
+}
+
+// pushDecodeBranchRequest pushes a new branch decode function request to the
+// back of the queue, if it is not already in the queue.
+func (this *Generator) pushDecodeBranchRequest(hash [16]byte, typ Type, name string) {
+	for _, item := range this.decodeBranchRequestQueue {
+		if item.hash == hash && item.name == name { return }
+	}
+	this.decodeBranchRequestQueue = append(this.decodeBranchRequestQueue, decodeBranchRequest {
+		hash: hash,
+		typ:  typ,
+		name: name,
+	})
+}
+
+// pullDecodeBranchRequest pulls a branch decode function request from the front
+// of the queue.
+func (this *Generator) pullDecodeBranchRequest() (hash [16]byte, typ Type, name string, ok bool) {
+	if len(this.decodeBranchRequestQueue) < 1 {
+		return [16]byte { }, nil, "", false
+	}
+	request := this.decodeBranchRequestQueue[0]
+	this.decodeBranchRequestQueue = this.decodeBranchRequestQueue[1:]
+	return request.hash, request.typ, request.name, true
+}
+
 func (this *Generator) generateErrorCheck() (n int, err error) {
 	return this.iprintf("n += nn; if err != nil { return n, err }\n")
 }
@@ -576,7 +835,7 @@ func (this *Generator) generateTag(typ Type, source string) (n int, err error) {
 	switch typ := typ.(type) {
 	case TypeInt:
 		if typ.Bits <= 5 {
-			nn, err := this.printf("tape.SI")
+			nn, err := this.printf("tape.SI.WithCN(int(%s))", source)
 			n += nn; if err != nil { return n, err }
 		} else {
 			nn, err := this.printf("tape.LI.WithCN(%d)", bitsToCN(typ.Bits))
@@ -660,6 +919,11 @@ func (this *Generator) generateType(typ Type) (n int, err error) {
 		if err := this.validateIntBitSize(typ.Bits); err != nil {
 			return n, err
 		}
+		if typ.Bits <= 5 {
+			nn, err := this.printf("uint8")
+			n += nn; if err != nil { return n, err }
+			break
+		}
 		if typ.Signed {
 			nn, err := this.printf("int%d", typ.Bits)
 			n += nn; if err != nil { return n, err }
@@ -723,9 +987,22 @@ func (this *Generator) generateTypeTableDefined(typ TypeTableDefined) (n int, er
 	return n, nil
 }
 
+// generateCanAssign generates an expression which checks if the tag specified
+// by tagSource can be assigned to a Go destination generated from typ. The
+// generated code is INLINE.
+func (this *Generator) generateCanAssign(typ Type, tagSource string) (n int, err error) {
+	nn, err := this.printf("canAssign(")
+	n += nn; if err != nil { return n, err }
+	nn, err = this.generateTN(typ)
+	n += nn; if err != nil { return n, err }
+	nn, err = this.printf(", %s)", tagSource)
+	n += nn; if err != nil { return n, err }
+	return n, nil
+}
+
 func (this *Generator) validateIntBitSize(size int) error {
 	switch size {
-	case 8, 16, 32, 64: return nil
+	case 5, 8, 16, 32, 64: return nil
 	default: return fmt.Errorf("integers of size %d are unsupported on this platform", size)
 	}
 }

generate/generate_test.go

@@ -214,6 +214,22 @@ func TestGenerateRun(test *testing.T) {
 			},
 		},
 	}
+	protocol.Messages[0x0002] = Message {
+		Name: "Pulse",
+		Type: TypeTableDefined {
+			Fields: map[uint16] Field {
+				0x0000: Field { Name: "Index",  Type: TypeInt { Bits: 5 } },
+				0x0001: Field { Name: "Offset", Type: TypeInt { Bits: 16, Signed: true }},
+				0x0002: Field { Name: "X",      Type: TypeFloat { Bits: 16 }},
+				0x0003: Field { Name: "Y",      Type: TypeFloat { Bits: 32 }},
+				0x0004: Field { Name: "Z",      Type: TypeFloat { Bits: 64 }},
+			},
+		},
+	}
+	protocol.Messages[0x0003] = Message {
+		Name: "NestedArray",
+		Type: TypeArray { Element: TypeArray { Element: TypeInt { Bits: 8 } } },
+	}
 	protocol.Types["User"] = TypeTableDefined {
 		Fields: map[uint16] Field {
 			0x0000: Field { Name: "Name",      Type: TypeString { } },
@@ -225,12 +241,87 @@ func TestGenerateRun(test *testing.T) {
 		// imports
 	`, `
 		// test case
+		log.Println("MessageConnect")
 		messageConnect := MessageConnect {
 			Name: "rarity",
 			Password: "gems",
 		}
 		testEncode(
 			&messageConnect,
-			0x0) // TODO
+			tu.S(0xC1, 0x02).AddVar(
+				[]byte { 0x00, 0x00, 0x66, 'r', 'a', 'r', 'i', 't', 'y' },
+				[]byte { 0x00, 0x01, 0x64, 'g', 'e', 'm', 's' },
+				))
+		log.Println("MessageUserList")
+		messageUserList := MessageUserList {
+			Users: []User {
+				User {
+					Name: "rarity",
+					Bio: "asdjads",
+					Followers: 0x324,
+				},
+				User {
+					Name: "deez nuts",
+					Bio: "logy",
+					Followers: 0x8000,
+				},
+				User {
+					Name: "creekflow",
+					Bio: "im creekflow",
+					Followers: 0x3894,
+				},
+			},
+		}
+		testEncode(
+			&messageUserList,
+			tu.S(0xC1, 0x01, 0x00, 0x00,
+				0xA1, 0x03, 0xC1,
+					).Add(0x03).AddVar(
+						[]byte { 0x00, 0x00, 0x66, 'r', 'a', 'r', 'i', 't', 'y' },
+						[]byte { 0x00, 0x01, 0x67, 'a', 's', 'd', 'j', 'a', 'd', 's' },
+						[]byte { 0x00, 0x02, 0x23, 0x00, 0x00, 0x03, 0x24 },
+					).Add(0x03).AddVar(
+						[]byte { 0x00, 0x00, 0x69, 'd', 'e', 'e', 'z', ' ', 'n', 'u', 't', 's' },
+						[]byte { 0x00, 0x01, 0x64, 'l', 'o', 'g', 'y' },
+						[]byte { 0x00, 0x02, 0x23, 0x00, 0x00, 0x80, 0x00 },
+					).Add(0x03).AddVar(
+						[]byte { 0x00, 0x00, 0x69, 'c', 'r', 'e', 'e', 'k', 'f', 'l', 'o', 'w' },
+						[]byte { 0x00, 0x01, 0x6C, 'i', 'm', ' ', 'c', 'r', 'e', 'e', 'k', 'f',
+							'l', 'o', 'w' },
+						[]byte { 0x00, 0x02, 0x23, 0x00, 0x00, 0x38, 0x94 },
+				))
+		log.Println("MessagePulse")
+		messagePulse := MessagePulse {
+			Index: 9,
+			Offset: -0x3521,
+			X: 45.389,
+			Y: 294.1,
+			Z: 384729384.234892034,
+		}
+		testEncode(
+			&messagePulse,
+			tu.S(0xC1, 0x05).AddVar(
+				[]byte { 0x00, 0x00, 0x09 },
+				[]byte { 0x00, 0x01, 0x21, 0xCA, 0xDF },
+				[]byte { 0x00, 0x02, 0x41, 0x51, 0xAC },
+				[]byte { 0x00, 0x03, 0x43, 0x43, 0x93, 0x0C, 0xCD },
+				[]byte { 0x00, 0x04, 0x47, 0x41, 0xB6, 0xEE, 0x81, 0x28, 0x3C, 0x21, 0xE2 },
+				))
+		log.Println("MessageNestedArray")
+		uint8s := func(n int) []uint8 {
+			array := make([]uint8, n)
+			for index := range array {
+				array[index] = uint8(index + 1) | 0xF0
+			}
+			return array
+		}
+		messageNestedArray := MessageNestedArray {
+			uint8s(6),
+			uint8s(35),
+		}
+		testEncode(
+			&messageNestedArray,
+			tu.S(0xA1, // TODO
+				))
 	`)
 }

generate/misc_test.go

@@ -34,26 +34,26 @@ func testGenerateRun(test *testing.T, protocol *Protocol, imports string, testCa
 	imports = `
 		import "log"
 		import "bytes"
-		import "slices"
 		import "git.tebibyte.media/sashakoshka/hopp/tape"
 		import tu "git.tebibyte.media/sashakoshka/hopp/internal/testutil"
 		` + imports
 	setup := `log.Println("*** BEGIN TEST CASE OUTPUT ***")`
 	teardown := `log.Println("--- END TEST CASE OUTPUT ---")`
 	static := `
-		func testEncode(message Message, correct ...byte) {
+		func testEncode(message Message, correct tu.Snake) {
 			buffer := bytes.Buffer { }
 			encoder := tape.NewEncoder(&buffer)
 			n, err := message.Encode(encoder)
 			if err != nil { log.Fatalf("at %d: %v\n", n, err) }
+			encoder.Flush()
 			got := buffer.Bytes()
-			log.Println("got:    ", tu.HexBytes(got))
-			log.Println("correct:", tu.HexBytes(correct))
+			log.Printf("got:     [%s]", tu.HexBytes(got))
+			log.Println("correct:", correct)
 			if n != len(got) {
 				log.Fatalf("n incorrect: %d != %d\n", n, len(got))
 			}
-			if !slices.Equal(got, correct) {
-				log.Fatalln("not equal")
+			if ok, n := correct.Check(got); !ok {
+				log.Fatalln("not equal at", n)
 			}
 		}
 		`

generate/protocol.go

@@ -1,5 +1,10 @@
 package generate
 
+import "fmt"
+import "maps"
+import "slices"
+import "crypto/md5"
+
 type Protocol struct {
 	Messages map[uint16] Message
 	Types    map[string] Type
@@ -11,7 +16,7 @@ type Message struct {
 }
 
 type Type interface {
-	
+	fmt.Stringer
 }
 
 type TypeInt struct {
@@ -19,29 +24,84 @@ type TypeInt struct {
 	Signed bool
 }
 
+func (typ TypeInt) String() string {
+	output := ""
+	if typ.Signed {
+		output += "I"
+	} else {
+		output += "U"
+	}
+	output += fmt.Sprint(typ.Bits)
+	return output
+}
+
 type TypeFloat struct {
 	Bits int
 }
 
+func (typ TypeFloat) String() string {
+	return fmt.Sprintf("F%d", typ.Bits)
+}
+
 type TypeString struct { }
 
+func (TypeString) String() string {
+	return "String"
+}
+
 type TypeBuffer struct { }
 
+func (TypeBuffer) String() string {
+	return "Buffer"
+}
+
 type TypeArray struct {
 	Element Type
 }
 
+func (typ TypeArray) String() string {
+	return fmt.Sprintf("[]%v", typ.Element)
+}
+
 type TypeTable struct { }
 
+func (TypeTable) String() string {
+	return "Table"
+}
+
 type TypeTableDefined struct {
 	Fields map[uint16] Field
 }
 
+func (typ TypeTableDefined) String() string {
+	output := "{"
+	for _, key := range slices.Sorted(maps.Keys(typ.Fields)) {
+		output += fmt.Sprintf("%04X %v", key, typ.Fields[key])
+	}
+	output += "}"
+	return output
+}
+
 type Field struct {
 	Name string
 	Type Type
 }
 
+func (field Field) String() string {
+	return fmt.Sprintf("%s %v", field.Name, field.Type)
+}
+
 type TypeNamed struct {
 	Name string
 }
+
+func (typ TypeNamed) String() string {
+	return typ.Name
+}
+
+func HashType(typ Type) [16]byte {
+	// TODO: if we ever want to make the compiler more efficient, this would
+	// be a good place to start, complex string concatenation in a hot path
+	// (sorta)
+	return md5.Sum([]byte(typ.String()))
+}

tape/decode.go

@@ -112,6 +112,13 @@ func (this *Decoder) ReadUintN(bytes int) (value uint64, n int, err error) {
 	return value, n, nil
 }
 
+// ReadFloat16 decodes a 16-bit floating point value from the input reader.
+func (this *Decoder) ReadFloat16() (value float32, n int, err error) {
+	bits, nn, err := this.ReadUint16()
+	n += nn; if err != nil { return 0, n, err }
+	return math.Float32frombits(f16bitsToF32bits(bits)), n, nil
+}
+
 // ReadFloat32 decldes a 32-bit floating point value from the input reader.
 func (this *Decoder) ReadFloat32() (value float32, n int, err error) {
 	bits, nn, err := this.ReadUint32()
@@ -132,3 +139,54 @@ func (this *Decoder) ReadTag() (value Tag, n int, err error) {
 	n += nn; if err != nil { return 0, n, err }
 	return Tag(uncasted), n, nil
 }
+
+// f16bitsToF32bits returns uint32 (float32 bits) converted from specified uint16.
+// Taken from https://github.com/x448/float16/blob/v0.8.4/float16
+//
+// MIT License
+// 
+// Copyright (c) 2019 Montgomery Edwards⁴⁴⁸ and Faye Amacker
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+func f16bitsToF32bits(in uint16) uint32 {
+	// All 65536 conversions with this were confirmed to be correct
+	// by Montgomery Edwards⁴⁴⁸ (github.com/x448).
+	
+	sign := uint32(in&0x8000) << 16 // sign for 32-bit
+	exp := uint32(in&0x7c00) >> 10  // exponenent for 16-bit
+	coef := uint32(in&0x03ff) << 13 // significand for 32-bit
+
+	if exp == 0x1f {
+		if coef == 0 {
+			// infinity
+			return sign | 0x7f800000 | coef
+		}
+		// NaN
+		return sign | 0x7fc00000 | coef
+	}
+
+	if exp == 0 {
+		if coef == 0 {
+			// zero
+			return sign
+		}
+
+		// normalize subnormal numbers
+		exp++
+		for coef&0x7f800000 == 0 {
+			coef <<= 1
+			exp--
+		}
+		coef &= 0x007fffff
+	}
+
+	return sign | ((exp + (0x7f - 0xf)) << 23) | coef
+}

tape/encode.go

@@ -102,6 +102,11 @@ func (this *Encoder) WriteUintN(value uint64, bytes int) (n int, err error) {
 	return n, nil
 }
 
+// WriteFloat16 encodes a 16-bit floating point value to the output writer.
+func (this *Encoder) WriteFloat16(value float32) (n int, err error) {
+	return this.WriteUint16(f32bitsToF16bits(math.Float32bits(value)))
+}
+
 // WriteFloat32 encodes a 32-bit floating point value to the output writer.
 func (this *Encoder) WriteFloat32(value float32) (n int, err error) {
 	return this.WriteUint32(math.Float32bits(value))
@@ -116,3 +121,69 @@ func (this *Encoder) WriteFloat64(value float64) (n int, err error) {
 func (this *Encoder) WriteTag(value Tag) (n int, err error) {
 	return this.WriteUint8(uint8(value))
 }
+
+// f32bitsToF16bits returns uint16 (Float16 bits) converted from the specified float32.
+// Conversion rounds to nearest integer with ties to even.
+// Taken from https://github.com/x448/float16/blob/v0.8.4/float16
+//
+// MIT License
+// 
+// Copyright (c) 2019 Montgomery Edwards⁴⁴⁸ and Faye Amacker
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+func f32bitsToF16bits(u32 uint32) uint16 {
+	// Translated from Rust to Go by Montgomery Edwards⁴⁴⁸ (github.com/x448).
+	// All 4294967296 conversions with this were confirmed to be correct by x448.
+	// Original Rust implementation is by Kathryn Long (github.com/starkat99) with MIT license.
+
+	sign := u32 & 0x80000000
+	exp := u32 & 0x7f800000
+	coef := u32 & 0x007fffff
+
+	if exp == 0x7f800000 {
+		// NaN or Infinity
+		nanBit := uint32(0)
+		if coef != 0 {
+			nanBit = uint32(0x0200)
+		}
+		return uint16((sign >> 16) | uint32(0x7c00) | nanBit | (coef >> 13))
+	}
+
+	halfSign := sign >> 16
+
+	unbiasedExp := int32(exp>>23) - 127
+	halfExp := unbiasedExp + 15
+
+	if halfExp >= 0x1f {
+		return uint16(halfSign | uint32(0x7c00))
+	}
+
+	if halfExp <= 0 {
+		if 14-halfExp > 24 {
+			return uint16(halfSign)
+		}
+		coef := coef | uint32(0x00800000)
+		halfCoef := coef >> uint32(14-halfExp)
+		roundBit := uint32(1) << uint32(13-halfExp)
+		if (coef&roundBit) != 0 && (coef&(3*roundBit-1)) != 0 {
+			halfCoef++
+		}
+		return uint16(halfSign | halfCoef)
+	}
+
+	uHalfExp := uint32(halfExp) << 10
+	halfCoef := coef >> 13
+	roundBit := uint32(0x00001000)
+	if (coef&roundBit) != 0 && (coef&(3*roundBit-1)) != 0 {
+		return uint16((halfSign | uHalfExp | halfCoef) + 1)
+	}
+	return uint16(halfSign | uHalfExp | halfCoef)
+}