TweakPlug : Support {source} token when replacing strings

GafferHQ · Apr 29, 2024 · 3696120 · 3696120
1 parent 2749e14
commit 3696120
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 1 deletion.
diff --git a/Changes.md b/Changes.md
@@ -10,7 +10,9 @@ Improvements
   - Added support for `uv.tangent` and `uv.tangent_sign` primitive variables to assist in rendering with normal maps (#5269).
 - AttributeQuery, PrimitiveVariableQuery, ContextQuery, OptionQuery, ShaderQuery : Added support for querying arrays of length 1 as their equivalent scalar types.
 - CodeWidget : Added <kbd>Ctrl</kbd>+<kbd>L</kbd> shortcut for selecting all text on the current line.
-- AttributeTweaks, CameraTweaks, ShaderTweaks, OptionTweaks, PrimitiveVariableTweaks : Added tooltips documenting the tweak modes.
+- AttributeTweaks, CameraTweaks, ShaderTweaks, OptionTweaks, PrimitiveVariableTweaks :
+  - Added support for a `{source}` token which is substituted with the original value when tweaking a string in `Replace` mode.
+  - Added tooltips documenting the tweak modes.
 
 Fixes
 -----

diff --git a/include/Gaffer/TweakPlug.h b/include/Gaffer/TweakPlug.h
@@ -148,6 +148,8 @@ class GAFFER_API TweakPlug : public Gaffer::ValuePlug
 			const std::string &tweakName
 		) const;
 
+		void applyReplaceTweak( const IECore::Data *sourceData, IECore::Data *tweakData ) const;
+
 		static const char *modeToString( Gaffer::TweakPlug::Mode mode );
 
 };

diff --git a/include/Gaffer/TweakPlug.inl b/include/Gaffer/TweakPlug.inl
@@ -149,6 +149,10 @@ bool TweakPlug::applyTweak(
 	{
 		applyListTweak( currentValue, newData.get(), newData.get(), mode, name );
 	}
+	else if( mode == TweakPlug::Replace )
+	{
+		applyReplaceTweak( currentValue, newData.get() );
+	}
 
 	if( mode != Gaffer::TweakPlug::CreateIfMissing )
 	{

diff --git a/python/GafferTest/TweakPlugTest.py b/python/GafferTest/TweakPlugTest.py
@@ -451,5 +451,35 @@ def testStringListOperations( self ) :
 			self.assertTrue( plug.applyTweak( data ) )
 			self.assertEqual( data["v"], IECore.StringData( result ) )
 
+	def testStringSubstitutions( self ) :
+
+		for source, tweakMode, tweakValue, result in [
+			# Create modes don't support substitutions.
+			( None, Gaffer.TweakPlug.Mode.Create, "{source}", "{source}" ),
+			( None, Gaffer.TweakPlug.Mode.CreateIfMissing, "{source}", "{source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Create, "{source}", "{source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.CreateIfMissing, "{source}", "a" ),
+			# Neither do list modes.
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.ListAppend, "{source}", "a {source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.ListPrepend, "{source}", "{source} a" ),
+			# Replace mode does support substitutions.
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}", "a" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "prefix{source}", "prefixa" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}suffix", "asuffix" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source} {source}", "a a" ),
+			# And works with InternedStringData too.
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}", "a" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "prefix{source}", "prefixa" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}suffix", "asuffix" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source} {source}", "a a" ),
+		] :
+			with self.subTest( source = source, tweakMode = tweakMode, tweakValue = tweakValue ) :
+				plug = Gaffer.TweakPlug( "v", tweakValue, tweakMode )
+				data = IECore.CompoundData( { "v" : source } )
+				self.assertTrue( plug.applyTweak( data ) )
+				if source is not None :
+					self.assertIs( type( data["v"] ), type( source ) )
+				self.assertEqual( data["v"].value, result )
+
 if __name__ == "__main__":
 	unittest.main()
diff --git a/python/GafferUI/TweakPlugValueWidget.py b/python/GafferUI/TweakPlugValueWidget.py
@@ -221,6 +221,9 @@ def __validModes( plug ) :
 	"""
 	Replaces an existing {property}. Errors if the {property} doesn't exist,
 	unless `ignoreMissing` is set, in which case the tweak is skipped.
+
+	When replacing a string {property}, the new value may contain a `{{source}}`
+	token, which will be substituted with the original value.
 	""",
 	Gaffer.TweakPlug.Mode.Add :
 	"""

diff --git a/src/Gaffer/TweakPlug.cpp b/src/Gaffer/TweakPlug.cpp
@@ -46,6 +46,7 @@
 #include "IECore/TypeTraits.h"
 
 #include "boost/algorithm/string/join.hpp"
+#include "boost/algorithm/string/replace.hpp"
 
 #include "fmt/format.h"
 
@@ -412,6 +413,21 @@ void TweakPlug::applyListTweak(
 	);
 }
 
+void TweakPlug::applyReplaceTweak( const IECore::Data *sourceData, IECore::Data *tweakData ) const
+{
+	if( auto stringData = IECore::runTimeCast<IECore::StringData>( tweakData ) )
+	{
+		boost::replace_all( stringData->writable(), "{source}", static_cast<const IECore::StringData *>( sourceData )->readable() );
+	}
+	else if( auto internedStringData = IECore::runTimeCast<IECore::InternedStringData>( tweakData ) )
+	{
+		internedStringData->writable() = boost::replace_all_copy(
+			internedStringData->readable().string(),
+			"{source}", static_cast<const IECore::InternedStringData *>( sourceData )->readable().string()
+		);
+	}
+}
+
 const char *TweakPlug::modeToString( Gaffer::TweakPlug::Mode mode )
 {
 	switch( mode )