core: make structs private, only expose interfaces

Author: markus-wa

README.md

@@ -224,7 +224,7 @@ Check out `debug_on.go` for any other settings that can be changed.
 
 ### Generating interfaces
 
-We generate interfaces such as `IGameState` from structs to make it easier to keep docs in synch over structs and interfaces.
+We generate interfaces such as `GameState` from structs to make it easier to keep docs in synch over structs and interfaces.
 For this we use [@vburenin](https://github.com/vburenin)'s [`ifacemaker`](https://github.com/vburenin/ifacemaker) tool.
 
 You can download the latest version [here](https://github.com/vburenin/ifacemaker/releases).

examples/mocking/README.md

@@ -1,6 +1,6 @@
 # Mocking the parser
 
-This example shows you how to use the provided [`fake` package](https://godoc.org/github.com/markus-wa/demoinfocs-golang/fake) to mock `demoinfocs.IParser` and other parts of the library.
+This example shows you how to use the provided [`fake` package](https://godoc.org/github.com/markus-wa/demoinfocs-golang/fake) to mock `demoinfocs.Parser` and other parts of the library.
 That way you will be able to write useful unit tests for your application.
 
 ## System under test
@@ -13,14 +13,14 @@ import (
 	events "github.com/markus-wa/demoinfocs-golang/v2/events"
 )
 
-func collectKills(parser dem.IParser) (kills []events.Kill, err error) {
+func collectKills(parser dem.Parser) (kills []events.Kill, err error) {
     ...
 }
 ```
 
 We deliberately ignore the implementation so we don't make assumptions about the code since it might change in the future.
 
-As you can see `collectKills` takes an `IParser` as input and returns a slice of `events.Kill` and potentially an error.
+As you can see `collectKills` takes an `Parser` as input and returns a slice of `events.Kill` and potentially an error.
 
 ## Positive test case
 

examples/mocking/collect_kills.go

@@ -5,7 +5,7 @@ import (
 	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
 )
 
-func collectKills(parser demoinfocs.IParser) (kills []events.Kill, err error) {
+func collectKills(parser demoinfocs.Parser) (kills []events.Kill, err error) {
 	parser.RegisterEventHandler(func(kill events.Kill) {
 		kills = append(kills, kill)
 	})

pkg/demoinfocs/datatables.go

@@ -23,7 +23,7 @@ const (
 	maxWeapons                   = 64
 )
 
-func (p *Parser) mapEquipment() {
+func (p *parser) mapEquipment() {
 	for _, sc := range p.stParser.ServerClasses() {
 		switch sc.Name() {
 		case "CC4":
@@ -69,7 +69,7 @@ func (p *Parser) mapEquipment() {
 }
 
 // Bind the attributes of the various entities to our structs on the parser
-func (p *Parser) bindEntities() {
+func (p *parser) bindEntities() {
 	p.bindTeamStates()
 	p.bindBombSites()
 	p.bindPlayers()
@@ -78,7 +78,7 @@ func (p *Parser) bindEntities() {
 	p.bindGameRules()
 }
 
-func (p *Parser) bindBomb() {
+func (p *parser) bindBomb() {
 	bomb := &p.gameState.bomb
 
 	// Track bomb when it is dropped on the ground or being held by a player
@@ -115,7 +115,7 @@ func (p *Parser) bindBomb() {
 	})
 }
 
-func (p *Parser) bindTeamStates() {
+func (p *parser) bindTeamStates() {
 	p.stParser.ServerClasses().FindByName("CCSTeam").OnEntityCreated(func(entity *st.Entity) {
 		team := entity.PropertyValueMust("m_szTeamname").StringVal
 
@@ -154,7 +154,7 @@ func (p *Parser) bindTeamStates() {
 	})
 }
 
-func (p *Parser) bindBombSites() {
+func (p *parser) bindBombSites() {
 	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(playerResource *st.Entity) {
 		playerResource.BindProperty("m_bombsiteCenterA", &p.bombsiteA.center, st.ValTypeVector)
 		playerResource.BindProperty("m_bombsiteCenterB", &p.bombsiteB.center, st.ValTypeVector)
@@ -169,7 +169,7 @@ func (p *Parser) bindBombSites() {
 	})
 }
 
-func (p *Parser) bindPlayers() {
+func (p *parser) bindPlayers() {
 	p.stParser.ServerClasses().FindByName("CCSPlayer").OnEntityCreated(func(player *st.Entity) {
 		p.bindNewPlayer(player)
 	})
@@ -179,7 +179,7 @@ func (p *Parser) bindPlayers() {
 	})
 }
 
-func (p *Parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, player *common.Player) {
+func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, player *common.Player) {
 	player = p.gameState.playersByEntityID[entityID]
 
 	if player == nil {
@@ -215,7 +215,7 @@ func (p *Parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, pl
 	return isNew, player
 }
 
-func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
+func (p *parser) bindNewPlayer(playerEntity st.IEntity) {
 	entityID := playerEntity.ID()
 	rp := p.rawPlayers[entityID-1]
 
@@ -289,7 +289,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 	}
 }
 
-func (p *Parser) bindPlayerWeapons(playerEntity st.IEntity, pl *common.Player) {
+func (p *parser) bindPlayerWeapons(playerEntity st.IEntity, pl *common.Player) {
 	// Some demos have an additional prefix for player weapons weapon
 	var wepPrefix string
 	if playerEntity.Property(playerWeaponPrefix+"000") != nil {
@@ -339,7 +339,7 @@ func (p *Parser) bindPlayerWeapons(playerEntity st.IEntity, pl *common.Player) {
 	}
 }
 
-func (p *Parser) bindWeapons() {
+func (p *parser) bindWeapons() {
 	for _, sc := range p.stParser.ServerClasses() {
 		for _, bc := range sc.BaseClasses() {
 			switch bc.Name() {
@@ -358,9 +358,9 @@ func (p *Parser) bindWeapons() {
 	p.stParser.ServerClasses().FindByName("CInferno").OnEntityCreated(p.bindNewInferno)
 }
 
-// bindGrenadeProjectiles keeps track of the location of live grenades (Parser.gameState.grenadeProjectiles), actively thrown by players.
+// bindGrenadeProjectiles keeps track of the location of live grenades (parser.gameState.grenadeProjectiles), actively thrown by players.
 // It does NOT track the location of grenades lying on the ground, i.e. that were dropped by dead players.
-func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
+func (p *parser) bindGrenadeProjectiles(entity *st.Entity) {
 	entityID := entity.ID()
 
 	proj := common.NewGrenadeProjectile()
@@ -369,7 +369,7 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 
 	var wep common.EquipmentType
 	entity.OnCreateFinished(func() {
-		// copy the weapon so it doesn't get overwritten by a new entity in Parser.weapons
+		// copy the weapon so it doesn't get overwritten by a new entity in parser.weapons
 		wepCopy := *(getPlayerWeapon(proj.Thrower, wep))
 		proj.WeaponInstance = &wepCopy
 
@@ -421,7 +421,7 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 }
 
 // Separate function because we also use it in round_officially_ended (issue #42)
-func (p *Parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
+func (p *parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
 	// If the grenade projectile entity is destroyed AFTER round_officially_ended
 	// we already executed this code when we received that event.
 	if _, exists := p.gameState.grenadeProjectiles[proj.Entity.ID()]; !exists {
@@ -448,7 +448,7 @@ func (p *Parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
 	}
 }
 
-func (p *Parser) bindWeapon(entity *st.Entity, wepType common.EquipmentType) {
+func (p *parser) bindWeapon(entity *st.Entity, wepType common.EquipmentType) {
 	entityID := entity.ID()
 
 	eq, eqExists := p.gameState.weapons[entityID]
@@ -502,7 +502,7 @@ func (p *Parser) bindWeapon(entity *st.Entity, wepType common.EquipmentType) {
 	}
 }
 
-func (p *Parser) bindNewInferno(entity *st.Entity) {
+func (p *parser) bindNewInferno(entity *st.Entity) {
 	inf := common.NewInferno(p.demoInfoProvider, entity)
 	p.gameState.infernos[entity.ID()] = inf
 
@@ -518,7 +518,7 @@ func (p *Parser) bindNewInferno(entity *st.Entity) {
 }
 
 // Separate function because we also use it in round_officially_ended (issue #42)
-func (p *Parser) infernoExpired(inf *common.Inferno) {
+func (p *parser) infernoExpired(inf *common.Inferno) {
 	// If the inferno entity is destroyed AFTER round_officially_ended
 	// we already executed this code when we received that event.
 	if _, exists := p.gameState.infernos[inf.Entity.ID()]; !exists {
@@ -534,7 +534,7 @@ func (p *Parser) infernoExpired(inf *common.Inferno) {
 	p.gameEventHandler.deleteThrownGrenade(inf.Thrower(), common.EqIncendiary)
 }
 
-func (p *Parser) bindGameRules() {
+func (p *parser) bindGameRules() {
 	grPrefix := func(s string) string {
 		return fmt.Sprintf("%s.%s", gameRulesPrefix, s)
 	}

pkg/demoinfocs/datatables_test.go

@@ -115,8 +115,8 @@ func testPlayerSpotted(t *testing.T, propName string) {
 	assert.Equal(t, expected, actual)
 }
 
-func newParser() *Parser {
-	p := NewParser(new(DevNullReader))
+func newParser() *parser {
+	p := NewParser(new(DevNullReader)).(*parser)
 	p.header = &common.DemoHeader{}
 
 	return p

pkg/demoinfocs/doc.go

@@ -2,7 +2,7 @@
 Package demoinfocs provides a demo parser for the game Counter-Strike: Global Offensive.
 It is based on the official demoinfogo tool by Valve as well as Stats Helix's demoinfo.
 
-A good entry point to using the library is the Parser type.
+A good entry point to using the library is the parser interface.
 
 Demo events are documented in the events package.
 */

pkg/demoinfocs/fake/game_state.go

@@ -8,84 +8,84 @@ import (
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 )
 
-var _ demoinfocs.IGameState = new(GameState)
+var _ demoinfocs.GameState = new(GameState)
 
-// GameState is a mock for of demoinfocs.IGameState.
+// GameState is a mock for of demoinfocs.GameState.
 type GameState struct {
 	mock.Mock
 }
 
-// IngameTick is a mock-implementation of IGameState.IngameTick().
+// IngameTick is a mock-implementation of GameState.IngameTick().
 func (gs *GameState) IngameTick() int {
 	return gs.Called().Int(0)
 }
 
-// TeamCounterTerrorists is a mock-implementation of IGameState.TeamCounterTerrorists().
+// TeamCounterTerrorists is a mock-implementation of GameState.TeamCounterTerrorists().
 func (gs *GameState) TeamCounterTerrorists() *common.TeamState {
 	return gs.Called().Get(0).(*common.TeamState)
 }
 
-// TeamTerrorists is a mock-implementation of IGameState.TeamTerrorists().
+// TeamTerrorists is a mock-implementation of GameState.TeamTerrorists().
 func (gs *GameState) TeamTerrorists() *common.TeamState {
 	return gs.Called().Get(0).(*common.TeamState)
 }
 
-// Team is a mock-implementation of IGameState.Team().
+// Team is a mock-implementation of GameState.Team().
 func (gs *GameState) Team(team common.Team) *common.TeamState {
 	return gs.Called().Get(0).(*common.TeamState)
 }
 
-// Participants is a mock-implementation of IGameState.Participants().
-func (gs *GameState) Participants() demoinfocs.IParticipants {
-	return gs.Called().Get(0).(demoinfocs.IParticipants)
+// Participants is a mock-implementation of GameState.Participants().
+func (gs *GameState) Participants() demoinfocs.Participants {
+	return gs.Called().Get(0).(demoinfocs.Participants)
 }
 
-// GrenadeProjectiles is a mock-implementation of IGameState.GrenadeProjectiles().
+// GrenadeProjectiles is a mock-implementation of GameState.GrenadeProjectiles().
 func (gs *GameState) GrenadeProjectiles() map[int]*common.GrenadeProjectile {
 	return gs.Called().Get(0).(map[int]*common.GrenadeProjectile)
 }
 
-// Infernos is a mock-implementation of IGameState.Infernos().
+// Infernos is a mock-implementation of GameState.Infernos().
 func (gs *GameState) Infernos() map[int]*common.Inferno {
 	return gs.Called().Get(0).(map[int]*common.Inferno)
 }
 
-// Weapons is a mock-implementation of IGameState.Weapons().
+// Weapons is a mock-implementation of GameState.Weapons().
 func (gs *GameState) Weapons() map[int]*common.Equipment {
 	return gs.Called().Get(0).(map[int]*common.Equipment)
 }
 
-// Entities is a mock-implementation of IGameState.Entities().
+// Entities is a mock-implementation of GameState.Entities().
 func (gs *GameState) Entities() map[int]*st.Entity {
 	return gs.Called().Get(0).(map[int]*st.Entity)
 }
 
-// Bomb is a mock-implementation of IGameState.Bomb().
+// Bomb is a mock-implementation of GameState.Bomb().
 func (gs *GameState) Bomb() *common.Bomb {
 	return gs.Called().Get(0).(*common.Bomb)
 }
 
-// TotalRoundsPlayed is a mock-implementation of IGameState.TotalRoundsPlayed().
+// TotalRoundsPlayed is a mock-implementation of GameState.TotalRoundsPlayed().
 func (gs *GameState) TotalRoundsPlayed() int {
 	return gs.Called().Int(0)
 }
 
-// GamePhase is a mock-implementation of IGameState.GamePhase().
+// GamePhase is a mock-implementation of GameState.GamePhase().
 func (gs *GameState) GamePhase() common.GamePhase {
 	return gs.Called().Get(0).(common.GamePhase)
 }
 
-// IsWarmupPeriod is a mock-implementation of IGameState.IsWarmupPeriod().
+// IsWarmupPeriod is a mock-implementation of GameState.IsWarmupPeriod().
 func (gs *GameState) IsWarmupPeriod() bool {
 	return gs.Called().Bool(0)
 }
 
-// IsMatchStarted is a mock-implementation of IGameState.IsMatchStarted().
+// IsMatchStarted is a mock-implementation of GameState.IsMatchStarted().
 func (gs *GameState) IsMatchStarted() bool {
 	return gs.Called().Bool(0)
 }
 
-// ConVars is a mock-implementation of IGameState.ConVars().
+// ConVars is a mock-implementation of GameState.ConVars().
 func (gs *GameState) ConVars() map[string]string {
 	return gs.Called().Get(0).(map[string]string)
 }