Repeat bullseye coordinates in DECLARE response if player didn't spec…

…ify format

pkg/brevity/declare.go

@@ -48,6 +48,9 @@ type DeclareRequest struct {
 	Sour bool
 	// IsBRAA indicates if the contact is provided using Bullseye (false) or BRAA (true).
 	IsBRAA bool
+	// IsAmbiguous indicates if the requestor did not explicitly state if they
+	// were providing Bullseye or BRAA coordinates.
+	IsAmbiguous bool
 	// Bullseye of the contact, if provided using Bullseye.
 	Bullseye Bullseye
 	// Bearing of the contact, if provided using BRAA.
@@ -89,6 +92,9 @@ type DeclareResponse struct {
 	// because the friendly aircraft did not provide coordinates for the
 	// contact.
 	Sour bool
+	// If readback is not nil, the controller should read back the coordinate
+	// in the response.
+	Readback *Bullseye
 	// Declaration of the contact.
 	Declaration Declaration
 	// Group that was identified, if a specific one was identifiable.

pkg/composer/declare.go

@@ -17,16 +17,23 @@ func (c *Composer) ComposeDeclareResponse(response brevity.DeclareResponse) Natu
 		}
 	}
 
+	var reply NaturalLanguageResponse
+
+	reply.WriteBoth(c.composeCallsigns(response.Callsign) + ", ")
+
+	if response.Readback != nil {
+		bullseye := c.composeBullseye(*response.Readback)
+		reply.WriteResponse(bullseye)
+		reply.WriteBoth(", ")
+	}
+
 	if slices.Contains([]brevity.Declaration{brevity.Furball, brevity.Unable, brevity.Clean}, response.Declaration) {
-		reply := fmt.Sprintf("%s, %s.", c.composeCallsigns(response.Callsign), response.Declaration)
-		return NaturalLanguageResponse{
-			Subtitle: reply,
-			Speech:   reply,
-		}
+		reply.WriteBoth(" " + string(response.Declaration))
+		return reply
 	}
+
 	info := c.composeCoreInformationFormat(response.Group)
-	return NaturalLanguageResponse{
-		Subtitle: fmt.Sprintf("%s, %s", c.composeCallsigns(response.Callsign), info.Subtitle),
-		Speech:   fmt.Sprintf("%s, %s", c.composeCallsigns(response.Callsign), info.Speech),
-	}
+	reply.WriteResponse(info)
+
+	return reply
 }

pkg/controller/declare.go

@@ -116,6 +116,10 @@ func (c *Controller) HandleDeclare(ctx context.Context, request *brevity.Declare
 		}
 	}
 
+	if request.IsAmbiguous {
+		response.Readback = &request.Bullseye
+	}
+
 	logger.Debug().Any("declaration", response.Declaration).Msg("responding to DECLARE request")
 	c.calls <- NewCall(ctx, response)
 }

pkg/parser/declare.go

@@ -15,7 +15,8 @@ func parseDeclare(callsign string, scanner *bufio.Scanner) (*brevity.DeclareRequ
 	var bullseye *brevity.Bullseye
 	var bearing bearings.Bearing
 	var _range unit.Length
-	var IsBRAA bool
+	var isBRAA bool
+	isAmbiguous := true
 	for {
 		if scanner.Text() == "" {
 			ok := scanner.Scan()
@@ -50,6 +51,7 @@ func parseDeclare(callsign string, scanner *bufio.Scanner) (*brevity.DeclareRequ
 		for _, word := range bullseyeWords {
 			if isSimilar(scanner.Text(), word) {
 				log.Debug().Str("text", scanner.Text()).Msg("found bullseye token")
+				isAmbiguous = false
 				bullseye = parseBullseye(scanner)
 				if bullseye == nil {
 					return nil, false
@@ -66,6 +68,7 @@ func parseDeclare(callsign string, scanner *bufio.Scanner) (*brevity.DeclareRequ
 		for _, word := range braaWords {
 			if isSimilar(scanner.Text(), word) {
 				log.Debug().Str("text", scanner.Text()).Msg("found braa token")
+				isAmbiguous = false
 				scanner.Scan()
 				b, extra, ok := parseBearing(scanner)
 				if !ok {
@@ -78,12 +81,12 @@ func parseDeclare(callsign string, scanner *bufio.Scanner) (*brevity.DeclareRequ
 					return nil, false
 				}
 				_range = r
-				IsBRAA = true
+				isBRAA = true
 				break
 			}
 		}
 
-		if IsBRAA {
+		if isBRAA {
 			log.Debug().Float64("bearing", bearing.Degrees()).Float64("range", _range.NauticalMiles()).Msg("parsed bearing and range")
 			foundCoordinate = true
 			break
@@ -102,23 +105,25 @@ func parseDeclare(callsign string, scanner *bufio.Scanner) (*brevity.DeclareRequ
 	track := parseTrack(scanner)
 	log.Debug().Stringer("track", track).Msg("parsed track")
 
-	if IsBRAA {
+	if isBRAA {
 		return &brevity.DeclareRequest{
-			Callsign: callsign,
-			Bearing:  bearing,
-			Range:    _range,
-			Altitude: altitude,
-			Track:    track,
-			IsBRAA:   true,
+			Callsign:    callsign,
+			Bearing:     bearing,
+			Range:       _range,
+			Altitude:    altitude,
+			Track:       track,
+			IsBRAA:      true,
+			IsAmbiguous: false,
 		}, true
 	}
 	if bullseye == nil {
 		return nil, false
 	}
 	return &brevity.DeclareRequest{
-		Callsign: callsign,
-		Bullseye: *bullseye,
-		Altitude: altitude,
-		Track:    track,
+		Callsign:    callsign,
+		Bullseye:    *bullseye,
+		Altitude:    altitude,
+		Track:       track,
+		IsAmbiguous: isAmbiguous,
 	}, true
 }

pkg/parser/declare_test.go

@@ -21,8 +21,9 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(75*unit.Degree),
 					26*unit.NauticalMile,
 				),
-				Altitude: 2000 * unit.Foot,
-				Track:    brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Altitude:    2000 * unit.Foot,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -33,8 +34,9 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(75*unit.Degree),
 					26*unit.NauticalMile,
 				),
-				Altitude: 0,
-				Track:    brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Altitude:    0,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -45,8 +47,9 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(75*unit.Degree),
 					26*unit.NauticalMile,
 				),
-				Altitude: 2000 * unit.Foot,
-				Track:    brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Altitude:    2000 * unit.Foot,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -69,8 +72,9 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(75*unit.Degree),
 					26*unit.NauticalMile,
 				),
-				Altitude: 2000 * unit.Foot,
-				Track:    brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Altitude:    2000 * unit.Foot,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -129,8 +133,9 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(52*unit.Degree),
 					77*unit.NauticalMile,
 				),
-				Altitude: 2000 * unit.Foot,
-				Track:    brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Altitude:    2000 * unit.Foot,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -180,8 +185,9 @@ func TestParserDeclare(t *testing.T) {
 		{
 			text: "anyface, Eagle 12, declare",
 			expected: &brevity.DeclareRequest{
-				Callsign: "eagle 1 2",
-				Sour:     true,
+				Callsign:    "eagle 1 2",
+				Sour:        true,
+				IsAmbiguous: true,
 			},
 		},
 		{
@@ -202,7 +208,8 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(177*unit.Degree),
 					29*unit.NauticalMile,
 				),
-				Track: brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -268,7 +275,8 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(176*unit.Degree),
 					31*unit.NauticalMile,
 				),
-				Track: brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -279,7 +287,8 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(177*unit.Degree),
 					29*unit.NauticalMile,
 				),
-				Track: brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 		{
@@ -290,7 +299,8 @@ func TestParserDeclare(t *testing.T) {
 					bearings.NewMagneticBearing(255*unit.Degree),
 					45*unit.NauticalMile,
 				),
-				Track: brevity.UnknownDirection,
+				IsAmbiguous: true,
+				Track:       brevity.UnknownDirection,
 			},
 		},
 	}