Code cleanup & doc

* Fixed some protobuf generation problems
* Partially cleaned up tests
* General cleanup
* Comments

Former-commit-id: bc512872a22b0d9d042017726aa795e8744b4ea5

Author: markus-wa

.gitattributes

@@ -0,0 +1,5 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Linux shell scripts
+*.sh text eol=lf

bin/README.md

@@ -0,0 +1,9 @@
+# Protobuf code generation
+
+The scripts in this folder generate the code for the game messages with the help of [gogoprotobuf](https://github.com/gogo/protobuf)
+
+## Requirements
+
+	go get github.com/gogo/protobuf/proto
+	go get github.com/gogo/protobuf/protoc-gen-gogofaster
+	go get github.com/gogo/protobuf/gogoproto

bin/gen_protobuf.cmd

@@ -1,4 +1,6 @@
-cd %GOPATH%/src
-set MSG_PATH=github.com/markus-wa/demoinfocs-golang/msg
-protoc -I=%MSG_PATH%/proto --gogofaster_out=Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:%MSG_PATH% %MSG_PATH%/proto/*.proto
+@REM Generate protobuf code
+cd %GOPATH%/src
+set MSG_PATH=github.com/markus-wa/demoinfocs-golang/msg
+set PROTOC_ARGS=Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor
+protoc -I=%MSG_PATH%/proto --gogofaster_out=%PROTOC_ARGS%:%MSG_PATH% %MSG_PATH%/proto/*.proto
 cmd.exe

bin/gen_protobuf.sh

@@ -1,5 +1,6 @@
-#!/bin/sh
-cd $GOPATH
-msg_path=github.com/markus-wa/demoinfocs-golang/msg
-protoc_args=Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor:
-protoc -I=%${msg_path}/proto --gogofaster_out=${protoc_args}${msg_path} ${msg_path}/proto/*.proto
+#!/bin/sh
+# Generate protobuf code
+cd $GOPATH/src
+msg_path=github.com/markus-wa/demoinfocs-golang/msg
+protoc_args=Mgoogle/protobuf/descriptor.proto=github.com/gogo/protobuf/protoc-gen-gogo/descriptor
+protoc -I=${msg_path}/proto --gogofaster_out=${protoc_args}:${msg_path} ${msg_path}/proto/*.proto

bitstream/bitreader.go

@@ -217,7 +217,7 @@ func (r *bitReader) ReadVarInt32() uint32 {
 	var res uint32 = 0
 	var b uint32 = 0x80
 
-	// do while hack
+	// TODO: This seems strange (Maybe check statshelix implementation)
 	for count := uint(0); b&0x80 != 0; count++ {
 		if count == kMaxVarint32Bytes {
 			return res
@@ -304,7 +304,7 @@ func (r *bitReader) Close() {
 
 var bitReaderPool sync.Pool = sync.Pool{
 	New: func() interface{} {
-		return &bitReader{}
+		return new(bitReader)
 	},
 }
 

common/common.go

@@ -159,6 +159,8 @@ func MapEquipment(originalString string) EquipmentElement {
 		case "revolver":
 			wep = EE_Revolver
 
+		case "sensorgrenade": // Only used in 'Co-op Strike' mode
+
 		case "scar17": //These crash the game when given via give wep_[mp5navy|...], and cannot be purchased ingame.
 		case "sg550": //yet the server-classes are networked, so we need to resolve them.
 		case "mp5navy":

common/constants.go

@@ -58,7 +58,8 @@ const (
 )
 
 const (
-	Team_Spectators Team = iota + 1
+	Team_Unassigned Team = iota
+	Team_Spectators
 	Team_Terrorists
 	Team_CounterTerrorists
 )

common/structs.go

@@ -7,6 +7,20 @@ import (
 	"github.com/markus-wa/demoinfocs-golang/st"
 )
 
+type DemoHeader struct {
+	Filestamp       string
+	Protocol        int
+	NetworkProtocol int
+	ServerName      string
+	ClientName      string
+	MapName         string
+	GameDirectory   string
+	PlaybackTime    float32
+	PlaybackTicks   int
+	PlaybackFrames  int
+	SignonLength    int
+}
+
 type PlayerInfo struct {
 	Version     int64
 	XUID        int64

constants.go

@@ -4,31 +4,31 @@ import (
 	"github.com/markus-wa/demoinfocs-golang/common"
 )
 
-type DemoCommand byte
+type demoCommand byte
 
 const (
 	maxEntities = (1 << common.MaxEditctBits)
-	MaxPlayers  = 64
-	MaxWeapons  = 64
+	maxPlayers  = 64
+	maxWeapons  = 64
 )
 
 const (
-	DC_Signon DemoCommand = iota + 1
-	DC_Packet
-	DC_Synctick
-	DC_ConsoleCommand
-	DC_UserCommand
-	DC_DataTables
-	DC_Stop
-	DC_CustomData
-	DC_StringTables
-	DC_LastCommand  = DC_StringTables
-	DC_FirstCommand = DC_Signon
+	dc_Signon demoCommand = iota + 1
+	dc_Packet
+	dc_Synctick
+	dc_ConsoleCommand
+	dc_UserCommand
+	dc_DataTables
+	dc_Stop
+	dc_CustomData
+	dc_StringTables
+	dc_LastCommand  = dc_StringTables
+	dc_FirstCommand = dc_Signon
 )
 
 const (
-	FDEMO_NORMAL = iota + 1
-	FDEMO_USE_ORIGIN2
-	FDEMO_USE_ANGLES2
-	FDEMO_NOINTERP
+	fdemo_Normal = iota + 1
+	fdemo_UseOrigin2
+	fdemo_UseAngles2
+	fdemo_NoInterp
 )

demoinfocs_test.go

@@ -6,29 +6,11 @@ import (
 	"github.com/markus-wa/demoinfocs-golang/events"
 	"os"
 	"reflect"
-	"runtime"
 	"testing"
 	"time"
 )
 
-var cancel bool = false
-var tsc *dem.TeamState
-var tix int = 0
-var oldScore int
-
-func handleTickDone(events.TickDoneEvent) {
-	tix++
-	if tix > 100 {
-		//cancel = true
-	}
-	if tsc != nil && oldScore != tsc.Score() {
-		fmt.Println(tsc.Score())
-		oldScore = tsc.Score()
-	}
-
-}
-
-func handle(interface{}) {}
+const demPath = "test/demo.dem"
 
 func handleDetails(e interface{}) {
 	n := reflect.TypeOf(e).Name()
@@ -37,72 +19,83 @@ func handleDetails(e interface{}) {
 	}
 }
 
-var started bool = false
-
-func handleStart(events.MatchStartedEvent) {
-	started = true
-}
-func handleKill(events.PlayerKilledEvent) {
-	if started {
-		//k := e.(events.PlayerKilledEvent)
-		//fmt.Println(k.Killer, "&", k.Assister, "killed", k.Victim)
-		//fmt.Println(*k.Killer, "&", k.Assister, "killed", *k.Victim)
-	}
-}
-
 func TestDemoInfoCs(t *testing.T) {
-	var demPath string
-	if runtime.GOOS == "windows" {
-		demPath = "C:\\Dev\\demo.dem"
-	} else {
-		demPath = "/home/markus/Downloads/demo.dem"
-	}
 	f, _ := os.Open(demPath)
 	defer f.Close()
 
 	p := dem.NewParser(f)
+
+	fmt.Println("Parsing header")
 	p.ParseHeader()
 
-	fmt.Println("go")
-	if true {
-		p.EventDispatcher().RegisterHandler(handleTickDone)
-		p.EventDispatcher().RegisterHandler(handle)
-		//p.EventDispatcher().RegisterHandler(reflect.TypeOf((*interface{})(nil)).Elem(), handleDetails)
-		//p.EventDispatcher().RegisterHandler(reflect.TypeOf((*events.BombEventIf)(nil)).Elem(), handleDetails)
-		//p.EventDispatcher().RegisterHandler(reflect.TypeOf((*events.NadeEventIf)(nil)).Elem(), handleDetails)
-		//p.EventDispatcher().RegisterHandler(reflect.TypeOf((*events.PlayerJumpEvent)(nil)).Elem(), handleDetails)
-		//p.EventDispatcher().RegisterHandler(reflect.TypeOf((*events.PlayerDisconnectEvent)(nil)).Elem(), handleDetails)
-		p.EventDispatcher().RegisterHandler(handleKill)
-		p.EventDispatcher().RegisterHandler(handleStart)
-	}
-	tsc = p.TState()
+	fmt.Println("Registering handlers")
+	var tState *dem.TeamState
+	var oldScore int
+	p.RegisterEventHandler(func(events.TickDoneEvent) {
+		if tState != nil && oldScore != tState.Score() {
+			fmt.Println("T-side score: ", tState.Score())
+			oldScore = tState.Score()
+		}
+	})
+	tState = p.TState()
+
 	ts := time.Now()
+	cancel := false
+	go func() {
+		timer := time.NewTimer(time.Second * 8)
+		<-timer.C
+		cancel = true
+		timer = time.NewTimer(time.Second * 2)
+		<-timer.C
+		t.Fatal("Parsing timeout")
+	}()
+
+	fmt.Println("Parsing to end")
 	p.ParseToEnd(&cancel)
-	duration := time.Since(ts)
-	fmt.Println("took", duration.Nanoseconds()/1000/1000, "ms")
+
+	fmt.Println("Took", time.Since(ts).Nanoseconds()/1000/1000, "ms")
+}
+
+func TestCancelParseToEnd(t *testing.T) {
+	runTest(func(p *dem.Parser) {
+		p.ParseHeader()
+		var tix int = 0
+		var cancel bool
+		p.RegisterEventHandler(func(events.TickDoneEvent) {
+			tix++
+			if tix == 100 {
+				cancel = true
+			} else if tix > 100 {
+				t.Fatal("Parsing continued after cancellation")
+			}
+		})
+		defer func() { recover() }()
+		p.ParseToEnd(&cancel)
+	})
+}
+
+func runTest(test func(*dem.Parser)) {
+	f, _ := os.Open(demPath)
+	defer f.Close()
+
+	test(dem.NewParser(f))
 }
 
 func BenchmarkDemoInfoCs(b *testing.B) {
 	fmt.Println("Parsing sample demo", b.N, "times")
-	var demPath string
-	if runtime.GOOS == "windows" {
-		demPath = "C:\\Dev\\demo.dem"
-	} else {
-		demPath = "/home/markus/Downloads/demo.dem"
-	}
 	for i := 0; i < b.N; i++ {
-		runDemoInfoCsBenchmark(demPath)
+		runDemoInfoCsBenchmark()
 	}
 }
 
-func runDemoInfoCsBenchmark(path string) {
-	f, _ := os.Open(path)
+func runDemoInfoCsBenchmark() {
+	f, _ := os.Open(demPath)
 	defer f.Close()
 
 	p := dem.NewParser(f)
 	p.ParseHeader()
+
 	ts := time.Now()
 	p.ParseToEnd(nil)
-	duration := time.Since(ts)
-	fmt.Println("took", duration.Nanoseconds()/1000/1000, "ms")
+	fmt.Println("Took", time.Since(ts).Nanoseconds()/1000/1000, "ms")
 }

demopacket.go

@@ -8,13 +8,13 @@ import (
 
 var packetEntitiesPool sync.Pool = sync.Pool{
 	New: func() interface{} {
-		return &msg.CSVCMsg_PacketEntities{}
+		return new(msg.CSVCMsg_PacketEntities)
 	},
 }
 
 var gameEventPool sync.Pool = sync.Pool{
 	New: func() interface{} {
-		return &msg.CSVCMsg_GameEvent{}
+		return new(msg.CSVCMsg_GameEvent)
 	},
 }
 
@@ -41,23 +41,23 @@ func (p *Parser) parsePacket() {
 			defer packetEntitiesPool.Put(m)
 
 		case int(msg.SVC_Messages_svc_GameEventList):
-			m = &msg.CSVCMsg_GameEventList{}
+			m = new(msg.CSVCMsg_GameEventList)
 
 		case int(msg.SVC_Messages_svc_GameEvent):
 			m = gameEventPool.Get().(*msg.CSVCMsg_GameEvent)
 			defer gameEventPool.Put(m)
 
 		case int(msg.SVC_Messages_svc_CreateStringTable):
-			m = &msg.CSVCMsg_CreateStringTable{}
+			m = new(msg.CSVCMsg_CreateStringTable)
 
 		case int(msg.SVC_Messages_svc_UpdateStringTable):
-			m = &msg.CSVCMsg_UpdateStringTable{}
+			m = new(msg.CSVCMsg_UpdateStringTable)
 
 		case int(msg.NET_Messages_net_Tick):
-			m = &msg.CNETMsg_Tick{}
+			m = new(msg.CNETMsg_Tick)
 
 		case int(msg.SVC_Messages_svc_UserMessage):
-			m = &msg.CSVCMsg_UserMessage{}
+			m = new(msg.CSVCMsg_UserMessage)
 
 		default:
 			// We don't care about anything else for now

events/events.go

@@ -6,7 +6,9 @@ import (
 )
 
 // Header parsed
-type HeaderParsedEvent struct{}
+type HeaderParsedEvent struct {
+	Header common.DemoHeader
+}
 
 // Tick done
 type TickDoneEvent struct{}