Spline Parser Rule Consistency

erslavin · pixar-oss · commit d2f309cb30c7 · 2025-03-14T14:39:15.000-07:00
- Modified SplinePostShaping rule to make sure: - there is a TokenSeparator (at least a space with allowance for cpp multi line comments with padding) between KeywordPost and SplineInterpMode (To avoid things like postcurve) - Make sure to have internal padding between SplineInterpMode and SplineTangen (to avoid things like curve(1,2)) - Aligned comments above rules to better represent rule intent - Added additional tests for incorrect spline parsing rules + additional tests to justify some correct parsing rules. Closes PixarAnimationStudios#3562 (Internal change: 2360314)
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.py b/pxr/usd/sdf/testenv/testSdfParsing.py
@@ -47,6 +47,9 @@ def test_Basic(self):
         # This will mean that your new test runs first and you can spot
         # failures much quicker.
         testFiles = '''
+        225_multiline_with_SplineKnotParamList.sdf
+        224_spline_post_shaping_with_comment.sdf
+        223_bad_spline_post_shaping_spacing.sdf
         222_dict_key_control_characters.sdf
         221_bad_spline_type.sdf
         220_splines.sdf
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.testenv/223_bad_spline_post_shaping_spacing.sdf b/pxr/usd/sdf/testenv/testSdfParsing.testenv/223_bad_spline_post_shaping_spacing.sdf
@@ -0,0 +1,18 @@
+#sdf 1.4.32
+
+def Xform "Prim2"
+{
+    custom double myAttr = 17.12
+    double myAttr.spline = {
+        bezier,
+        pre: linear,
+        post: sloped(0.57),
+        loop: (15, 25, 0, 2, 11.7),
+        7: 5.5 & 7.21; post held,
+        15: 8.18; post curve (2.49, 1.17); { string comment = "climb!" },
+
+        # the post shaping statement below has a curve interpolation mode
+        # that does not have a space between the mode and the left paren
+        20: 14.72; pre (3.77, -1.4); post curve(1.1, -1.4),
+    }
+}
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.testenv/224_spline_post_shaping_with_comment.sdf b/pxr/usd/sdf/testenv/testSdfParsing.testenv/224_spline_post_shaping_with_comment.sdf
@@ -0,0 +1,18 @@
+#sdf 1.4.32
+
+def Xform "Prim2"
+{
+    custom double myAttr = 17.12
+    double myAttr.spline = {
+        bezier,
+        pre: linear,
+        post: sloped(0.57),
+        loop: (15, 25, 0, 2, 11.7),
+        7: 5.5 & 7.21; post held,
+        15: 8.18; post curve (2.49, 1.17); { string comment = "climb!" },
+
+        # the post shaping statement below has a curve interpolation mode
+        # that does not have a space between the mode and the left paren
+        20: 14.72; pre (3.77, -1.4); post curve/*comment should be treated as a whitepace*/(1.1, -1.4),
+    }
+}
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.testenv/225_multiline_with_SplineKnotParamList.sdf b/pxr/usd/sdf/testenv/testSdfParsing.testenv/225_multiline_with_SplineKnotParamList.sdf
@@ -0,0 +1,16 @@
+#sdf 1.4.32
+
+def Xform "Prim2"
+{
+    custom double myAttr = 17.12
+    double myAttr.spline = {
+        bezier,
+        pre: linear,
+        post: sloped(0.57),
+        loop: (15, 25, 0, 2, 11.7),
+        7: 5.5 & 7.21; post held,
+        # try multiline padding with SplineKnotParamList
+        15: 8.18; post curve (2.49, 1.17); 
+            { string comment = "climb!" },
+    }
+}
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.testenv/baseline/224_spline_post_shaping_with_comment.sdf b/pxr/usd/sdf/testenv/testSdfParsing.testenv/baseline/224_spline_post_shaping_with_comment.sdf
@@ -0,0 +1,16 @@
+#sdf 1.4.32
+
+def Xform "Prim2"
+{
+    custom double myAttr = 17.12
+    double myAttr.spline = {
+        bezier,
+        pre: linear,
+        post: sloped(0.57),
+        loop: (15, 25, 0, 2, 11.7),
+        7: 5.5 & 7.21; pre (0, 0); post held,
+        15: 8.18; post curve (2.49, 1.17); { string comment = "climb!" },
+        20: 14.72; pre (3.77, -1.4); post curve (1.1, -1.4),
+    }
+}
+
diff --git a/pxr/usd/sdf/testenv/testSdfParsing.testenv/baseline/225_multiline_with_SplineKnotParamList.sdf b/pxr/usd/sdf/testenv/testSdfParsing.testenv/baseline/225_multiline_with_SplineKnotParamList.sdf
@@ -0,0 +1,14 @@
+#sdf 1.4.32
+
+def Xform "Prim2"
+{
+    custom double myAttr = 17.12
+    double myAttr.spline = {
+        pre: linear,
+        post: sloped(0.57),
+        loop: (15, 25, 0, 2, 11.7),
+        7: 5.5 & 7.21; pre (0, 0); post held,
+        15: 8.18; post curve (2.49, 1.17); { string comment = "climb!" },
+    }
+}
+
diff --git a/pxr/usd/sdf/textFileFormatParser.h b/pxr/usd/sdf/textFileFormatParser.h
@@ -693,10 +693,10 @@ struct SplineCurveTypeItem : PEGTL_NS::sor<
     KeywordBezier> {};
 
 struct SlopeValue : Number {};
-// SplineExtrapolationType = NONE / HELD / LINEAR / 
-// SLOPED '(' (TokenSeparator)? SloveValue (TokenSeparator)? ')' / 
-// LOOP TokenSeparator REPEAT / LOOP TokenSeparator RESET / 
-// LOOP TokenSeparator OSCILLATE
+// SplineExtrapolationType = NONE / HELD / LINEAR /
+// SLOPED (InlinePadding)* '(' (InlinePadding)* SlopeValue (InlinePadding)* ')' /
+// LOOP TokenSeparator REPEAT / LOOP TokenSeparator RESET / LOOP
+// TokenSeparator OSCILLATE
 struct SplineExtrapolationType : PEGTL_NS::sor<
     KeywordNone_LC,
     KeywordHeld,
@@ -710,14 +710,14 @@ struct SplineExtrapolationType : PEGTL_NS::sor<
     PEGTL_NS::seq<KeywordLoop, TokenSeparator, KeywordOscillate>> {};
 
 // SplinePreExtrapItem = pre (TokenSeparator)? Colon (TokenSeparator)? 
-// SplineExtrapolation
+// SplineExtrapolationType
 struct SplinePreExtrapItem : PEGTL_NS::seq<
     KeywordPre,
     PEGTL_NS::pad<Colon, InlinePadding>,
     SplineExtrapolationType> {};
 
 // SplinePostExtrapItem = post (TokenSeparator)? Colon (TokenSeparator)? 
-// SplineExtrapolation
+// SplineExtrapolationType
 struct SplinePostExtrapItem : PEGTL_NS::seq<
     KeywordPost,
     PEGTL_NS::pad<Colon, InlinePadding>,
@@ -789,16 +789,17 @@ struct SplineInterpMode : PEGTL_NS::sor<
 
 // SplinePreTan = pre TokenSeparator SplineTangent
 struct SplinePreTan : PEGTL_NS::seq<
-    KeywordPre, 
+    KeywordPre,
     TokenSeparator,
     SplineTangent> {};
 
 // SplinePostShaping = post (TokenSeparator)? SplineInterpMode (TokenSeparator)?
 // (SplineTangent)?
 struct SplinePostShaping : PEGTL_NS::seq<
     KeywordPost,
-    PEGTL_NS::pad<SplineInterpMode, InlinePadding>,
-    PEGTL_NS::opt<SplineTangent>> {};
+    TokenSeparator,
+    SplineInterpMode,
+    PEGTL_NS::opt<InlinePadding, SplineTangent>> {};
 
 // SplineKnotParam = SplinePreTan / SplinePostShaping / DictionaryValue
 struct SplineKnotParam : PEGTL_NS::sor<
@@ -815,7 +816,7 @@ struct SplineKnotParamList : PEGTL_NS::opt<
         PEGTL_NS::seq<
             PEGTL_NS::pad<
                 StatementSequenceOf<SplineKnotParam>, InlinePadding>,
-            PEGTL_NS::not_at<StatementSeparator>>>> {};
+            PEGTL_NS::not_at<SplineKnotParamSeparator>>>> {};
 
 struct SplineKnotValue : Number {};
 struct SplineKnotPreValue : Number {};
@@ -826,8 +827,8 @@ struct SplineKnotValueWithoutPreValue : PEGTL_NS::seq<
     SplineKnotValue,
     PEGTL_NS::pad<PEGTL_NS::not_at<SplineKnotPreValueSeparator>, 
         InlinePadding>> {};
-// SplineKnotValueWithPreValue = SplineKnotPreValue (TokenSeparator)? 
-// SplineKnotPreValueSeparator SplineKnotValue
+// SplineKnotValueWithPreValue = SplineKnotPreValue InlinePadding 
+// SplineKnotPreValueSeparator InlinePadding SplineKnotValue
 struct SplineKnotValueWithPreValue : PEGTL_NS::seq<
     SplineKnotPreValue,
     PEGTL_NS::pad<SplineKnotPreValueSeparator, InlinePadding>,
@@ -857,7 +858,7 @@ struct SplineItem : PEGTL_NS::sor<
     SplineLoopItem,
     SplineKnotItem> {};
 
-// SplineValue = { (TokenSeparator)? (SplineItem (TokenSeparator)?)* }
+// SplineValue = { (MultilinePadding)? (SplineItem (MultilinePadding)?)* }
 struct SplineValue : PEGTL_NS::if_must<
     LeftBrace,
     PEGTL_NS::pad<ListOf<SplineItem>, MultilinePadding>,
