add a QTCList type to manage the logic around QTCs

Author: ftl

core/app/app.go

@@ -75,6 +75,7 @@ type Controller struct {
 	VFO                      *vfo.VFO
 	Logbook                  *logbook.Logbook
 	QSOList                  *logbook.QSOList
+	QTCList                  *logbook.QTCList
 	Entry                    *entry.Controller
 	Workmode                 *workmode.Controller
 	Radio                    *radio.Controller
@@ -167,6 +168,7 @@ func (c *Controller) Startup() {
 
 	c.Score = score.NewCounter(c.Settings, c.dxccFinder)
 	c.QSOList = logbook.NewQSOList(c.Settings, c.Score)
+	c.QTCList = logbook.NewQTCList()
 	c.Bandmap = bandmap.NewBandmap(c.clock, c.Settings, c.QSOList, c.asyncRunner, bandmap.DefaultUpdatePeriod, c.configuration.SpotLifetime())
 	c.Clusters = cluster.NewClusters(c.configuration.SpotSources(), c.Bandmap, c.bandplan, c.dxccFinder, c.clock)
 	c.Entry = entry.NewController(
@@ -342,6 +344,7 @@ func (c *Controller) changeLogbook(filename string, store *store.FileStore, newL
 	c.Logbook = newLogbook
 	c.Logbook.SetWriter(c.store)
 	c.Logbook.Notify(logbook.QSOAddedListenerFunc(c.QSOList.Put))
+	c.Logbook.Notify(c.QTCList)
 	c.Logbook.Notify(c.Workmode)
 
 	c.VFO.SetLogbook(c.Logbook)
@@ -629,6 +632,7 @@ func (c *Controller) ExportSummary() {
 }
 
 func (c *Controller) ExportCabrillo() {
+	// TODO: export QTCs
 	result, ok := c.ExportCabrilloController.Run(c.Settings, c.Score.Result(), c.QSOList.All())
 	if !ok {
 		return
@@ -757,7 +761,9 @@ func (c *Controller) ShowSpots() {
 
 func (c *Controller) Refresh() {
 	c.QSOList.Clear()
+	c.QTCList.Clear()
 	c.QSOList.Fill(c.Logbook.AllQSOs())
+	c.QTCList.Fill(c.Logbook.AllQTCs())
 	c.Entry.Clear()
 }
 

core/logbook/qtclist.go

@@ -0,0 +1,107 @@
+package logbook
+
+import (
+	"slices"
+	"sync"
+
+	"github.com/ftl/hellocontest/core"
+)
+
+type QTCsClearedListener interface {
+	QTCsCleared()
+}
+
+type QTCList struct {
+	dataLock *sync.RWMutex
+	data     map[core.QSONumber]core.QTC
+
+	listeners []any
+}
+
+func NewQTCList() *QTCList {
+	return &QTCList{
+		dataLock: new(sync.RWMutex),
+		data:     make(map[core.QSONumber]core.QTC),
+	}
+}
+
+func (l *QTCList) Notify(listener any) {
+	l.listeners = append(l.listeners, listener)
+}
+
+func (l *QTCList) emitQTCsCleared() {
+	for _, lis := range l.listeners {
+		if listener, ok := lis.(QTCsClearedListener); ok {
+			listener.QTCsCleared()
+		}
+	}
+}
+
+func (l *QTCList) emitQTCAdded(qtc core.QTC) {
+	for _, lis := range l.listeners {
+		if listener, ok := lis.(QTCAddedListener); ok {
+			listener.QTCAdded(qtc)
+		}
+	}
+}
+
+func (l *QTCList) Clear() {
+	l.dataLock.Lock()
+	l.clear()
+	l.dataLock.Unlock()
+
+	l.emitQTCsCleared()
+}
+
+func (l *QTCList) clear() {
+	l.data = make(map[core.QSONumber]core.QTC)
+}
+
+func (l *QTCList) Fill(qtcs []core.QTC) {
+	l.dataLock.Lock()
+	if len(l.data) > 0 {
+		l.clear()
+	}
+	for _, qtc := range qtcs {
+		l.put(qtc)
+	}
+	allQTCs := l.all()
+	l.dataLock.Unlock()
+
+	l.emitQTCsCleared()
+	for _, qtc := range allQTCs {
+		l.emitQTCAdded(qtc)
+	}
+}
+
+func (l *QTCList) QTCAdded(qtc core.QTC) {
+	l.dataLock.Lock()
+	l.put(qtc)
+	l.dataLock.Unlock()
+	l.emitQTCAdded(qtc)
+}
+
+func (l *QTCList) put(qtc core.QTC) {
+	l.data[qtc.QSONumber] = qtc
+}
+
+func (l *QTCList) All() []core.QTC {
+	l.dataLock.RLock()
+	defer l.dataLock.RUnlock()
+
+	return l.all()
+}
+
+func (l *QTCList) all() []core.QTC {
+	result := make([]core.QTC, 0, len(l.data))
+	for _, qtc := range l.data {
+		result = append(result, qtc)
+	}
+
+	slices.SortStableFunc(result, core.QTCByTimestamp)
+	return result
+}
+
+func (l *QTCList) QSOAdded(qso core.QSO) {
+	// TODO: add an available QTC for the new QSO if appropriate
+}

core/logbook/qtclist_test.go

@@ -0,0 +1,51 @@
+package logbook
+
+import (
+	"testing"
+	"time"
+
+	"github.com/ftl/hellocontest/core"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestQTCList_basicSetup(t *testing.T) {
+	l := NewQTCList()
+	now := time.Now()
+	listener := new(qtcListListener)
+	l.Notify(listener)
+
+	initialQTCs := []core.QTC{
+		{Timestamp: now.Add(-4 * time.Minute), QSONumber: 1},
+		{Timestamp: now.Add(-2 * time.Minute), QSONumber: 2},
+		{Timestamp: now.Add(-1 * time.Minute), QSONumber: 3},
+	}
+	l.Fill(initialQTCs)
+	assert.Equal(t, initialQTCs, l.All())
+	assert.Equal(t, 1, listener.clearEvents)
+	assert.Equal(t, 3, listener.addedEvents)
+
+	newQTC := core.QTC{Timestamp: now, QSONumber: 4}
+	l.QTCAdded(newQTC)
+	assert.Equal(t, 4, len(l.All()))
+	assert.Equal(t, newQTC, l.All()[3])
+	assert.Equal(t, 1, listener.clearEvents)
+	assert.Equal(t, 4, listener.addedEvents)
+
+	l.Clear()
+	assert.Equal(t, 0, len(l.All()))
+	assert.Equal(t, 2, listener.clearEvents)
+	assert.Equal(t, 4, listener.addedEvents)
+}
+
+type qtcListListener struct {
+	clearEvents int
+	addedEvents int
+}
+
+func (l *qtcListListener) QTCsCleared() {
+	l.clearEvents++
+}
+
+func (l *qtcListListener) QTCAdded(core.QTC) {
+	l.addedEvents++
+}