Add ParserWarnEvent (#16)

Author: markus-wa

README.md

@@ -43,7 +43,7 @@ func main() {
 		log.Fatal(err)
 	}
 
-	p := dem.NewParser(f, dem.WarnToStdErr)
+	p := dem.NewParser(f)
 
 	// Parse header
 	h, err := p.ParseHeader()

demoinfocs_test.go

@@ -36,7 +36,7 @@ func TestDemoInfoCs(t *testing.T) {
 	}
 	defer f.Close()
 
-	p := dem.NewParser(f, dem.WarnToStdErr)
+	p := dem.NewParser(f)
 
 	fmt.Println("Parsing header")
 	h, err := p.ParseHeader()
@@ -140,7 +140,7 @@ func TestUnexpectedEndOfDemo(t *testing.T) {
 	}
 	defer f.Close()
 
-	p := dem.NewParser(f, nil)
+	p := dem.NewParser(f)
 	_, err = p.ParseHeader()
 	if err != nil {
 		t.Fatal(err)
@@ -159,7 +159,7 @@ func TestCancelParseToEnd(t *testing.T) {
 	}
 	defer f.Close()
 
-	p := dem.NewParser(f, nil)
+	p := dem.NewParser(f)
 	_, err = p.ParseHeader()
 	if err != nil {
 		t.Fatal(err)
@@ -195,7 +195,7 @@ func TestConcurrent(t *testing.T) {
 		}
 		defer f.Close()
 
-		p := dem.NewParser(f, nil)
+		p := dem.NewParser(f)
 
 		_, err = p.ParseHeader()
 		if err != nil {
@@ -248,7 +248,7 @@ func TestDemoSet(t *testing.T) {
 					}
 				}()
 
-				p := dem.NewParser(f, nil)
+				p := dem.NewParser(f)
 				_, err = p.ParseHeader()
 				if err != nil {
 					t.Error(err)
@@ -274,7 +274,7 @@ func BenchmarkDemoInfoCs(b *testing.B) {
 			}
 			defer f.Close()
 
-			p := dem.NewParser(f, nil)
+			p := dem.NewParser(f)
 
 			_, err = p.ParseHeader()
 			if err != nil {
@@ -313,7 +313,7 @@ func BenchmarkInMemory(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		p := dem.NewParser(bytes.NewReader(d), nil)
+		p := dem.NewParser(bytes.NewReader(d))
 
 		_, err = p.ParseHeader()
 		if err != nil {

demopacket.go

@@ -6,6 +6,7 @@ import (
 
 	proto "github.com/gogo/protobuf/proto"
 
+	"github.com/markus-wa/demoinfocs-golang/events"
 	msg "github.com/markus-wa/demoinfocs-golang/msg"
 )
 
@@ -53,23 +54,21 @@ func (p *Parser) parsePacket() {
 			m = new(msg.CSVCMsg_UserMessage)
 
 		default:
-			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)]
-				}
+			var name string
+			if cmd < 8 || cmd >= 100 {
+				name = msg.NET_Messages_name[int32(cmd)]
+			} else {
+				name = msg.SVC_Messages_name[int32(cmd)]
+			}
 
+			if isDebug {
 				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))
-					}
-				}
+			if name == "" {
+				// Send a warning if the command is unknown
+				// This might mean our proto files are out of date
+				p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Unknown message command %q", cmd)})
 			}
 
 			// On to the next one

events/events.go

@@ -309,3 +309,9 @@ type DataTablesParsedEvent struct{}
 type StringTableCreatedEvent struct {
 	TableName string
 }
+
+// ParserWarnEvent signals that a non-fatal problem occurred during parsing.
+// This is a beta feature, it may be replaced or changed without notice.
+type ParserWarnEvent struct {
+	Message string
+}

example_test.go

@@ -18,7 +18,7 @@ func TestExample(t *testing.T) {
 	}
 	defer f.Close()
 
-	p := dem.NewParser(f, dem.WarnToStdErr)
+	p := dem.NewParser(f)
 
 	// Parse header
 	h, err := p.ParseHeader()

game_events.go

@@ -28,7 +28,7 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 	}()
 
 	if p.gameEventDescs == nil {
-		p.warn("Received GameEvent but event descriptors are missing")
+		p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: "Received GameEvent but event descriptors are missing"})
 		return
 	}
 
@@ -405,9 +405,7 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 	case "cs_match_end_restart": // Yawn
 
 	default:
-		if p.warn != nil {
-			p.warn(fmt.Sprintf("Unknown event %q", d.Name))
-		}
+		p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Unknown event %q", d.Name)})
 	}
 }
 
@@ -459,9 +457,8 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 	case msg.ECstrike15UserMessages_CS_UM_SayText:
 		st := new(msg.CCSUsrMsg_SayText)
 		err := st.Unmarshal(um.MsgData)
-		if err != nil && p.warn != nil {
-			// Just send a warning, chat messages aren't that important
-			p.warn(fmt.Sprintf("Failed to decode SayText message: %s", err.Error()))
+		if err != nil {
+			p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Failed to decode SayText message: %s", err.Error())})
 		}
 
 		p.eventDispatcher.Dispatch(events.SayTextEvent{
@@ -474,8 +471,8 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 	case msg.ECstrike15UserMessages_CS_UM_SayText2:
 		st := new(msg.CCSUsrMsg_SayText2)
 		err := st.Unmarshal(um.MsgData)
-		if err != nil && p.warn != nil {
-			p.warn(fmt.Sprintf("Failed to decode SayText2 message: %s", err.Error()))
+		if err != nil {
+			p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Failed to decode SayText2 message: %s", err.Error())})
 		}
 
 		sender := p.gameState.players[int(st.EntIdx)]
@@ -501,9 +498,7 @@ func (p *Parser) handleUserMessage(um *msg.CSVCMsg_UserMessage) {
 		case "#CSGO_Coach_Join_CT":
 
 		default:
-			if p.warn != nil {
-				p.warn(fmt.Sprintf("Skipped sending ChatMessageEvent for SayText2 with unknown MsgName %q", st.MsgName))
-			}
+			p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Skipped sending ChatMessageEvent for SayText2 with unknown MsgName %q", st.MsgName)})
 		}
 
 	default:

parser.go

@@ -1,9 +1,7 @@
 package demoinfocs
 
 import (
-	"fmt"
 	"io"
-	"os"
 	"sync"
 
 	r3 "github.com/golang/geo/r3"
@@ -44,7 +42,6 @@ type Parser struct {
 	gameEventDescs        map[int32]*msg.CSVCMsg_GameEventListDescriptorT
 	stringTables          []*msg.CSVCMsg_CreateStringTable
 	cancelChan            chan struct{}
-	warn                  WarnHandler
 	err                   error
 	errLock               sync.Mutex
 }
@@ -129,24 +126,12 @@ func (p *Parser) setError(err error) {
 	}
 }
 
-// TODO: Maybe we should use a channel instead of that WarnHandler stuff
-
-// WarnHandler is a function that handles warnings of a Parser.
-type WarnHandler func(string)
-
-// WarnToStdErr is a WarnHandler that prints all warnings to standard error output.
-func WarnToStdErr(warning string) {
-	fmt.Fprintln(os.Stderr, warning)
-}
-
 // TODO: Change the New* methods (names + parameters)
 
 // NewParser creates a new Parser on the basis of an io.Reader
 // - like os.File or bytes.Reader - that reads demo data.
-// Any warnings that don't stop the Parser from doing it's job
-// will be passed to the warnHandler if it's not nil.
-func NewParser(demostream io.Reader, warnHandler WarnHandler) *Parser {
-	return NewParserWithBufferSize(demostream, -1, warnHandler)
+func NewParser(demostream io.Reader) *Parser {
+	return NewParserWithBufferSize(demostream, -1)
 }
 
 // NewParserWithBufferSize returns a new Parser with a custom msgQueue buffer size.
@@ -155,7 +140,7 @@ func NewParser(demostream io.Reader, warnHandler WarnHandler) *Parser {
 // A negative value will make the Parser automatically decide the buffer size during ParseHeader()
 // based on the number of ticks in the demo (nubmer of ticks = buffer size).
 // See also: NewParser()
-func NewParserWithBufferSize(demostream io.Reader, msgQueueBufferSize int, warnHandler WarnHandler) *Parser {
+func NewParserWithBufferSize(demostream io.Reader, msgQueueBufferSize int) *Parser {
 	var p Parser
 	// Init parser
 	p.bitReader = bit.NewLargeBitReader(demostream)
@@ -168,7 +153,6 @@ func NewParserWithBufferSize(demostream io.Reader, msgQueueBufferSize int, warnH
 	p.triggers = make(map[int]*boundingBoxInformation)
 	p.cancelChan = make(chan struct{}, 1)
 	p.gameState = newGameState()
-	p.warn = warnHandler
 
 	// Attach proto msg handlers
 	p.msgDispatcher.RegisterHandler(p.handlePacketEntities)