Added debugging build tag

Author: markus-wa

README.md

@@ -85,6 +85,15 @@ pushd test/cs-demos && git lfs pull && popd
 go test
 ```
 
+### Debugging
+
+You can use the build tag `debugdemoinfocs` (i.e. `go test -tags debugdemoinfocs -v`) to print out debugging information - such as game events or unhandled demo-messages - during the parsing process.<br>
+Side-note: The tag isn't called `debug` to avoid naming conflicts with other libs (and underscores in tags don't work, apparently).
+
+To change the default debugging behavior Go's `ldflags` paramter can be used. Example for additionally printing out the ingame-tick-numbers: `-ldflags '-X github.com/markus-wa/demoinfocs-golang.debugIngameTicks=YES'`
+
+Check out `debug_on.go` for any other settings that can be changed.
+
 ### Generating protobuf code
 
 Should you need to re-generate the protobuf generated code in the `msg` package, you will need the following tools:
@@ -93,7 +102,7 @@ Should you need to re-generate the protobuf generated code in the `msg` package,
 
 - And `protoc-gen-gogofaster` from [gogoprotobuf](https://github.com/gogo/protobuf) to generate code for go.
 
-		go get -u github.com/gogo/protobuf/protoc-gen-gogofaster
+	go get -u github.com/gogo/protobuf/protoc-gen-gogofaster
 
 Make sure both are inside your `PATH` variable.
 

debug_off.go

@@ -0,0 +1,23 @@
+//+build !debugdemoinfocs
+
+// This file is just a bunch of NOPs for the release build, see debug_on.go for debugging stuff
+
+package demoinfocs
+
+import (
+	msg "github.com/markus-wa/demoinfocs-golang/msg"
+)
+
+const isDebug = false
+
+func debugGameEvent(descriptor *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
+	// NOP
+}
+
+func debugUnhandledMessage(cmd int, name string) {
+	// NOP
+}
+
+func debugIngameTick(tickNr int) {
+	// NOP
+}

debug_on.go

@@ -0,0 +1,62 @@
+//+build debugdemoinfocs
+
+// Functions to print out debug information if the build tag is enabled
+
+package demoinfocs
+
+import (
+	"fmt"
+
+	msg "github.com/markus-wa/demoinfocs-golang/msg"
+)
+
+const isDebug = true
+
+const (
+	yes = "YES"
+	no  = "NO"
+)
+
+// Can be overridden via -ldflags '-X github.com/markus-wa/demoinfocs-golang.debugIngameTicks=YES'
+// Oh and btw we cant use bools for this, Go says 'cannot use -X with non-string symbol'
+var debugGameEvents = yes
+var debugUnhandledMessages = yes
+var debugIngameTicks = no
+
+func debugGameEvent(d *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
+	if debugGameEvents == yes {
+		// Map only the relevant data for each type
+		data := make(map[string]interface{})
+		for k, v := range mapGameEventData(d, ge) {
+			switch v.Type {
+			case 1:
+				data[k] = v.ValString
+			case 2:
+				data[k] = v.ValFloat
+			case 3:
+				data[k] = v.ValLong
+			case 4:
+				data[k] = v.ValShort
+			case 5:
+				data[k] = v.ValByte
+			case 6:
+				data[k] = v.ValBool
+			case 7:
+				data[k] = v.ValUint64
+			}
+		}
+		fmt.Println("GameEvent:", d.Name, "Data:", data)
+	}
+}
+
+func debugUnhandledMessage(cmd int, name string) {
+	if debugUnhandledMessages == yes {
+		fmt.Printf("UnhandledMessage: id=%d name=%s\n", cmd, name)
+	}
+}
+
+func debugIngameTick(tickNr int) {
+	if debugIngameTicks == yes {
+		fmt.Printf("IngameTick=%d\n", tickNr)
+	}
+}

demopacket.go

@@ -53,17 +53,22 @@ func (p *Parser) parsePacket() {
 			m = new(msg.CSVCMsg_UserMessage)
 
 		default:
-			if p.warn != nil {
+			if p.warn != nil || isDebug {
 				var name string
 				if cmd < 8 || cmd >= 100 {
 					name = msg.NET_Messages_name[int32(cmd)]
 				} else {
 					name = msg.SVC_Messages_name[int32(cmd)]
 				}
-				if name == "" {
-					// Send a warning if the command is unknown
-					// This might mean our proto files are out of date
-					p.warn(fmt.Sprintf("Unknown message command %q", cmd))
+
+				debugUnhandledMessage(cmd, name)
+
+				if p.warn != nil {
+					if name == "" {
+						// Send a warning if the command is unknown
+						// This might mean our proto files are out of date
+						p.warn(fmt.Sprintf("Unknown message command %q", cmd))
+					}
 				}
 			}
 

packet_handlers.go

@@ -88,9 +88,9 @@ func (p *Parser) handleGameEventList(gel *msg.CSVCMsg_GameEventList) {
 		p.setError(recoverFromUnexpectedEOF(recover()))
 	}()
 
-	p.gehDescriptors = make(map[int32]*msg.CSVCMsg_GameEventListDescriptorT)
+	p.gameEventDescs = make(map[int32]*msg.CSVCMsg_GameEventListDescriptorT)
 	for _, d := range gel.GetDescriptors() {
-		p.gehDescriptors[d.GetEventid()] = d
+		p.gameEventDescs[d.GetEventid()] = d
 	}
 }
 
@@ -99,12 +99,14 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 		p.setError(recoverFromUnexpectedEOF(recover()))
 	}()
 
-	if p.gehDescriptors == nil {
+	if p.gameEventDescs == nil {
 		p.warn("Received GameEvent but event descriptors are missing")
 		return
 	}
 
-	d := p.gehDescriptors[ge.Eventid]
+	d := p.gameEventDescs[ge.Eventid]
+
+	debugGameEvent(d, ge)
 
 	// Ignore events before players are connected to speed things up
 	if len(p.connectedPlayers) == 0 && d.Name != "player_connect" {
@@ -726,4 +728,5 @@ type ingameTickNumber int
 
 func (p *Parser) handleIngameTickNumber(n ingameTickNumber) {
 	p.ingameTick = int(n)
+	debugIngameTick(p.ingameTick)
 }

parser.go

@@ -46,7 +46,7 @@ type Parser struct {
 	triggers              map[int]*boundingBoxInformation
 	instanceBaselines     map[int][]byte
 	preprocessedBaselines map[int]map[int]st.PropValue
-	gehDescriptors        map[int32]*msg.CSVCMsg_GameEventListDescriptorT
+	gameEventDescs        map[int32]*msg.CSVCMsg_GameEventListDescriptorT
 	stringTables          []*msg.CSVCMsg_CreateStringTable
 	cancelChan            chan struct{}
 	warn                  WarnHandler