Add option to debug server-classes

Author: markus-wa

README.md

@@ -151,7 +151,7 @@ go test
 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'`
+To change the default debugging behavior Go's `ldflags` paramter can be used. Example for additionally printing out all server-classes with their properties: `-ldflags '-X github.com/markus-wa/demoinfocs-golang.debugServerClasses=YES'`
 
 Check out `debug_on.go` for any other settings that can be changed.
 

debug_off.go

@@ -6,6 +6,7 @@ package demoinfocs
 
 import (
 	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
 const isDebug = false
@@ -25,3 +26,7 @@ func debugIngameTick(tickNr int) {
 func debugDemoCommand(cmd demoCommand) {
 	// NOP
 }
+
+func debugAllServerClasses(classes st.ServerClasses) {
+	// NOP
+}

debug_on.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 
 	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
 const isDebug = true
@@ -23,6 +24,7 @@ var debugGameEvents = yes
 var debugUnhandledMessages = yes
 var debugIngameTicks = no
 var debugDemoCommands = yes
+var debugServerClasses = no
 
 func debugGameEvent(d *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
 	if debugGameEvents == yes {
@@ -92,3 +94,12 @@ func debugDemoCommand(cmd demoCommand) {
 		fmt.Println("Demo-Command:", cmd)
 	}
 }
+
+func debugAllServerClasses(classes st.ServerClasses) {
+	if debugServerClasses == yes {
+		for _, sc := range classes {
+			fmt.Println(sc)
+			fmt.Println()
+		}
+	}
+}

parsing.go

@@ -198,6 +198,8 @@ func (p *Parser) parseFrame() bool {
 		p.stParser.ParsePacket(p.bitReader)
 		p.bitReader.EndChunk()
 
+		debugAllServerClasses(p.ServerClasses())
+
 		p.mapEquipment()
 		p.bindEntities()
 

sendtables/sendtables.go

@@ -3,6 +3,8 @@ package sendtables
 
 import (
 	"bytes"
+	"fmt"
+	"strings"
 
 	bit "github.com/markus-wa/demoinfocs-golang/bitread"
 )
@@ -47,6 +49,13 @@ type ServerClass struct {
 	preprocessedBaseline map[int]PropertyValue // Preprocessed baseline
 }
 
+// Stores meta information about a property of an Entity.
+type flattenedPropEntry struct {
+	prop             *sendTableProperty
+	arrayElementProp *sendTableProperty
+	name             string
+}
+
 // ID returns the server-class's ID.
 func (sc *ServerClass) ID() int {
 	return sc.id
@@ -131,12 +140,26 @@ func (sc *ServerClass) OnEntityCreated(handler EntityCreatedHandler) {
 	sc.createdHandlers = append(sc.createdHandlers, handler)
 }
 
-// Stores meta information about a property of an Entity.
-type flattenedPropEntry struct {
-	prop             *sendTableProperty
-	arrayElementProp *sendTableProperty
-	name             string
-}
-
 // EntityCreatedHandler is the interface for handlers that are interested in EntityCreatedEvents.
 type EntityCreatedHandler func(*Entity)
+
+var serverClassStringFormat = `ServerClass: id=%d name=%s
+	dataTableId=%d
+	dataTableName=%s
+	baseClasses:
+		%s
+	props:
+		%s`
+
+func (sc *ServerClass) String() string {
+	baseClasses := make([]string, len(sc.baseClasses))
+	for i, bc := range sc.baseClasses {
+		baseClasses[i] = bc.name
+	}
+
+	props := make([]string, len(sc.flattenedProps))
+	for i, fProp := range sc.flattenedProps {
+		props[i] = fProp.name
+	}
+	return fmt.Sprintf(serverClassStringFormat, sc.id, sc.name, sc.dataTableID, sc.dataTableName, strings.Join(baseClasses, "\n\t\t"), strings.Join(props, "\n\t\t"))
+}