usdUtils: Fix shownIf param name fixup bug

Puts a temporary workaround in place to avoid fixing up param names inside
`shownIf` expressions multiple times, yielding doubled-up (or more) "input"
namespaces.

Once SdfBooleanExpression has been wrapped to Python, we should make
UpdateSchemaWithSdrNode() use it directly.

(Internal change: 2385379)

Author: agb63

pxr/usd/usdUtils/testenv/testUsdUtilsUpdateSchemaWithSdrNode/baseline/resultUIHints.usda

@@ -16,7 +16,7 @@ class "TestUIHintsAPI" (
     }
 )
 {
-    reorder properties = ["inputs:allowedTokens", "inputs:allowedTokensAndValueLabels", "inputs:arrayDynamic", "inputs:arraySizeAndTuples", "inputs:arraySizeTuplesMismatch", "inputs:arrayStatic", "inputs:arrayTuples", "inputs:convertedShownIf", "inputs:displayGroup", "inputs:displayName", "inputs:floatArrayTupleConversion2", "inputs:floatArrayTupleConversion3", "inputs:floatArrayTupleConversion4", "inputs:hardAndSoftLimits", "inputs:hardClobberSoftLimits", "inputs:hardDemoteToSoftLimits", "inputs:hardLimitsBasic", "inputs:help", "inputs:hidden", "inputs:inClosedGroup", "inputs:inOpenGroup", "inputs:inOpenNestedGroup", "inputs:inShownIfGroup", "inputs:intArrayTupleConversion2", "inputs:intArrayTupleConversion3", "inputs:intArrayTupleConversion4", "inputs:shownIf", "inputs:softCantClobberHardLimits", "inputs:softLimitsBasic", "inputs:softPromoteToHardLimits", "inputs:sparseSpecificationLimits", "inputs:valueLabels"]
+    reorder properties = ["inputs:allowedTokens", "inputs:allowedTokensAndValueLabels", "inputs:arrayDynamic", "inputs:arraySizeAndTuples", "inputs:arraySizeTuplesMismatch", "inputs:arrayStatic", "inputs:arrayTuples", "inputs:convertedShownIf", "inputs:displayGroup", "inputs:displayName", "inputs:floatArrayTupleConversion2", "inputs:floatArrayTupleConversion3", "inputs:floatArrayTupleConversion4", "inputs:hardAndSoftLimits", "inputs:hardClobberSoftLimits", "inputs:hardDemoteToSoftLimits", "inputs:hardLimitsBasic", "inputs:help", "inputs:hidden", "inputs:inClosedGroup", "inputs:inOpenGroup", "inputs:inOpenNestedGroup", "inputs:inShownIfGroup", "inputs:intArrayTupleConversion2", "inputs:intArrayTupleConversion3", "inputs:intArrayTupleConversion4", "inputs:shownIf", "inputs:shownIfParamNameSubStrings", "inputs:softCantClobberHardLimits", "inputs:softLimitsBasic", "inputs:softPromoteToHardLimits", "inputs:some_param", "inputs:some_param_also", "inputs:sparseSpecificationLimits", "inputs:valueLabels"]
     token inputs:allowedTokens = "foo" (
         allowedTokens = ["foo", "bar", "baz"]
     )
@@ -148,6 +148,11 @@ class "TestUIHintsAPI" (
             string shownIf = "inputs:hidden >= 1"
         }
     )
+    int inputs:shownIfParamNameSubStrings = 1 (
+        uiHints = {
+            string shownIf = "inputs:some_param >= inputs:some_param_also"
+        }
+    )
     int inputs:softCantClobberHardLimits = 1 (
         limits = {
             dictionary hard = {
@@ -176,6 +181,8 @@ class "TestUIHintsAPI" (
             }
         }
     )
+    int inputs:some_param = 1
+    int inputs:some_param_also = 1
     int inputs:sparseSpecificationLimits = 1 (
         limits = {
             dictionary hard = {

pxr/usd/usdUtils/testenv/testUsdUtilsUpdateSchemaWithSdrNode/testUIHints.usda

@@ -225,4 +225,16 @@ def Shader "TestUIHintsAPI" (
             token shownIf = "hidden >= 1"
         }
     )
+
+    # Regression test case (USD-11606) - if a shownIf expression references a
+    # param name that has another param name as a substring, the "inputs"
+    # namespace would get prepended multiple times (for example here,
+    # "inputs:inputs:some_param_also")
+    int inputs:some_param = 1
+    int inputs:some_param_also = 1
+    int inputs:shownIfParamNameSubStrings = 1 (
+        sdrMetadata = {
+            token shownIf = "some_param >= some_param_also"
+        }
+    )
 }

pxr/usd/usdUtils/updateSchemaWithSdrNode.py

@@ -788,16 +788,17 @@ def _recordAttrInfo(attrName, sdrProp):
     for attr in attrsWithShownIf:
         attrHints = UsdUI.AttributeHints(attr)
         if attrHints:
-            expr = attrHints.GetShownIf()
-            for sourceName, finalName in attrRenames.items():
-                expr = expr.replace(sourceName, finalName)
-            attrHints.SetShownIf(expr)
+            # XXX: Should be using Sdf.BooleanExpression.RenameVariables()
+            # directly here, but it hasn't been wrapped yet
+            attrHints.SetShownIf(
+                UsdUtils._BooleanExpressionRenameVariables(
+                    attrHints.GetShownIf(), attrRenames))
 
     pagesShownIf = sdrNode.GetPagesShownIf()
     for page, expr in pagesShownIf.items():
-        for sourceName, finalName in attrRenames.items():
-            expr = expr.replace(sourceName, finalName)
-        pagesShownIf[page] = expr
+        # XXX: Ditto above
+        pagesShownIf[page] = \
+            UsdUtils._BooleanExpressionRenameVariables(expr, attrRenames)
 
     if pagesShownIf:
         primHints.SetDisplayGroupsShownIf(pagesShownIf)

pxr/usd/usdUtils/wrapPipeline.cpp

@@ -10,15 +10,39 @@
 
 #include "pxr/usd/usdUtils/pipeline.h"
 
+#include "pxr/usd/sdf/booleanExpression.h"
 #include "pxr/usd/usd/prim.h"
 
 #include "pxr/base/tf/pyResultConversions.h"
+#include "pxr/base/vt/dictionary.h"
+#include "pxr/base/vt/value.h"
 #include "pxr/external/boost/python/return_by_value.hpp"
 
 PXR_NAMESPACE_USING_DIRECTIVE
 
 using namespace pxr_boost::python;
 
+// XXX: Temporary workaround for use by UpdateSchemaWithSdrNode(). Once
+// SdfBooleanExpression is wrapped to Python we can do away with this.
+static std::string
+_BooleanExpressionRenameVariables(
+    const std::string& expr,
+    const VtDictionary& renames)
+{
+    auto transform = [&](const TfToken& name) {
+        const auto it = renames.find(name);
+        if (it == renames.end() || !it->second.IsHolding<std::string>()) {
+            return name;
+        }
+        else {
+            return TfToken(it->second.UncheckedGet<std::string>());
+        }
+    };
+
+    const SdfBooleanExpression expression(expr);
+    return expression.RenameVariables(transform).GetText();
+}
+
 void wrapPipeline()
 {
     def("GetAlphaAttributeNameForColor", UsdUtilsGetAlphaAttributeNameForColor, arg("colorAttrName"));
@@ -42,4 +66,7 @@ void wrapPipeline()
         "GetPrimaryCameraName",
         UsdUtilsGetPrimaryCameraName,
         arg("forceDefault")=false);
+
+    def("_BooleanExpressionRenameVariables",
+        &_BooleanExpressionRenameVariables);
 }