From 9ffb4809753415f54d3f64153422dc8ed02ba645 Mon Sep 17 00:00:00 2001
From: Cole Faust <colefaust@google.com>
Date: Wed, 22 May 2024 14:28:49 -0700
Subject: [PATCH] Add proptools.PrintfIntoConfigurable

This will be used by soong config value variables to support their
usage on configurable properties.

Bug: 323382414
Test: m nothing --no-skip-soong-tests
Change-Id: I20b8ef29e81512548ecdc056533700a30fa7815a
---
 proptools/configurable.go | 62 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/proptools/configurable.go b/proptools/configurable.go
index 452289d..a26e16a 100644
--- a/proptools/configurable.go
+++ b/proptools/configurable.go
@@ -554,6 +554,7 @@ type configurableReflection interface {
 	configuredType() reflect.Type
 	clone() any
 	isEmpty() bool
+	printfInto(value string) error
 }
 
 // Same as configurableReflection, but since initialize needs to take a pointer
@@ -624,6 +625,60 @@ func (c *configurableInner[T]) setAppend(append *configurableInner[T], replace b
 	}
 }
 
+func (c Configurable[T]) printfInto(value string) error {
+	return c.inner.printfInto(value)
+}
+
+func (c *configurableInner[T]) printfInto(value string) error {
+	for c != nil {
+		if err := c.single.printfInto(value); err != nil {
+			return err
+		}
+		c = c.next
+	}
+	return nil
+}
+
+func (c *singleConfigurable[T]) printfInto(value string) error {
+	for _, c := range c.cases {
+		if c.value == nil {
+			continue
+		}
+		switch v := any(c.value).(type) {
+		case *string:
+			if err := printfIntoString(v, value); err != nil {
+				return err
+			}
+		case *[]string:
+			for i := range *v {
+				if err := printfIntoString(&((*v)[i]), value); err != nil {
+					return err
+				}
+			}
+		}
+	}
+	return nil
+}
+
+func printfIntoString(s *string, configValue string) error {
+	count := strings.Count(*s, "%")
+	if count == 0 {
+		return nil
+	}
+
+	if count > 1 {
+		return fmt.Errorf("list/value variable properties only support a single '%%'")
+	}
+
+	if !strings.Contains(*s, "%s") {
+		return fmt.Errorf("unsupported %% in value variable property")
+	}
+
+	*s = fmt.Sprintf(*s, configValue)
+
+	return nil
+}
+
 func (c Configurable[T]) clone() any {
 	return Configurable[T]{
 		propertyName: c.propertyName,
@@ -731,3 +786,10 @@ func copyAndDereferenceConfiguredValue[T ConfigurableElements](t *T) T {
 		return *t
 	}
 }
+
+// PrintfIntoConfigurable replaces %s occurrences in strings in Configurable properties
+// with the provided string value. It's intention is to support soong config value variables
+// on Configurable properties.
+func PrintfIntoConfigurable(c any, value string) error {
+	return c.(configurableReflection).printfInto(value)
+}