Rename c_vect -> simics_util_vect

mandolaerik · mandolaerik · commit 015229f5ce4f · 2024-10-22T17:45:13.000+02:00
On popular demand. Also, rename ECVECT -&gt; EOLDVECT
and c_vect_without_provisional -&gt; experimental_vect
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -196,11 +196,11 @@
   various operations that rely on the `register_view` interface, such as the
   `dev_util.bank_regs` function and the `write-device-reg` and `probe-address`
   CLI commands.
-- `note 6` A new provisional feature `c_vect` has been added. When `provisional
-  c_vect;` appears in the top of a DML file, DMLC will no longer print warnings
-  when the `vect` syntax is used in that file.
-- `note 6` A new compatibility feature `c_vect_without_provisional` has been
-  created. In files without a `provisional c_vect;` declaration, the `vect`
+- `note 6` A new provisional feature `simics_util_vect` has been added. When
+  `provisional simics_util_vect;` appears in the top of a DML file, DMLC will
+  no longer print warnings when the `vect` syntax is used in that file.
+- `note 6` A new compatibility feature `simics_util_vect_without_provisional` has been
+  created. In files without a `provisional simics_util_vect;` declaration, the `vect`
   syntax is only permitted when this feature is enabled. his feature will be
   disabled in Simics API versions \> 7, where all uses of `vect` instead require
   explicit `provisional` declarations.
diff --git a/T_experimental_vect_disabled.dml b/T_experimental_vect_disabled.dml
@@ -8,6 +8,6 @@ dml 1.4;
 device test;
 
 /// DMLC-FLAG --simics-api=7
-/// DMLC-FLAG --no-compat=c_vect_without_provisional
-/// ERROR ECVECT
+/// DMLC-FLAG --no-compat=experimental_vect
+/// ERROR EOLDVECT
 typedef int vect x;
diff --git a/T_experimental_vect_enabled.dml b/T_experimental_vect_enabled.dml
diff --git a/lib/1.2/dml-builtins.dml b/lib/1.2/dml-builtins.dml
@@ -5,7 +5,7 @@
 
 dml 1.2;
 
-provisional c_vect;
+provisional simics_util_vect;
 bitorder le;
 
 loggroup Register_Read;
@@ -223,7 +223,7 @@ template device {
     parameter _compat_dml12_goto auto;
     parameter _compat_dml12_misc auto;
     parameter _compat_dml12_int auto;
-    parameter _compat_c_vect_without_provisional auto;
+    parameter _compat_experimental_vect auto;
     parameter _compat_warning_statement auto;
 
     // automatic parameters
diff --git a/lib/1.4/dml-builtins.dml b/lib/1.4/dml-builtins.dml
@@ -5,7 +5,7 @@
 
 dml 1.4;
 
-provisional c_vect;
+provisional simics_util_vect;
 bitorder le;
 
 loggroup Register_Read;
@@ -625,7 +625,7 @@ template device {
     param _compat_dml12_goto auto;
     param _compat_dml12_misc auto;
     param _compat_dml12_int auto;
-    param _compat_c_vect_without_provisional auto;
+    param _compat_experimental_vect auto;
     param _compat_warning_statement auto;
 
     // automatic parameters
diff --git a/py/dml/compat.py b/py/dml/compat.py
@@ -377,20 +377,20 @@ class dml12_int(CompatFeature):
 
 
 @feature
-class c_vect_without_provisional(CompatFeature):
-    '''<a id="c_vect_without_provisional"/> This compat feature
+class experimental_vect(CompatFeature):
+    '''<a id="experimental_vect"/> This compat feature
     controls how DMLC reacts to uses of the `vect` syntax in files
-    where the [`c_vect` provisional feature](provisional-auto.html#c_vect)
+    where the [`simics_util_vect` provisional feature](provisional-auto.html#simics_util_vect)
     is not enabled.
 
-    When the `c_vect_without_provisional` compatibility feature is
+    When the `experimental_vect` compatibility feature is
     enabled, such uses are permitted, and give a `WEXPERIMENTAL`
     warning in DML 1.4 (but no warning in DML 1.2). When
-    `c_vect_without_provisional` is disabled, DMLC forbids the `vect`
+    `experimental_vect` is disabled, DMLC forbids the `vect`
     syntax.
 
     '''
-    short = "Permit vect syntax without 'provisional c_vect'"
+    short = "Permit vect syntax without 'provisional simics_util_vect'"
     last_api_version = api_7
 
 
diff --git a/py/dml/dmlparse.py b/py/dml/dmlparse.py
@@ -1331,15 +1331,15 @@ def cdecl2_ptr(t):
 @prod
 def cdecl2_vect(t):
     'cdecl2 : VECT cdecl2'
-    if provisional.c_vect not in t.parser.file_info.provisional:
-        if compat.c_vect_without_provisional in dml.globals.enabled_compat:
+    if provisional.simics_util_vect not in t.parser.file_info.provisional:
+        if compat.experimental_vect in dml.globals.enabled_compat:
             vsite = site(t)
             if vsite.dml_version() != (1, 2):
                 # defensively suppress warning in 1.2, for
                 # compatibility
                 report(WEXPERIMENTAL(site(t), 'vect types'))
         else:
-            report(ECVECT(site(t)))
+            report(EOLDVECT(site(t)))
     t[0] = ['vect'] + t[2]
 
 @prod_dml12
diff --git a/py/dml/messages.py b/py/dml/messages.py
@@ -1892,10 +1892,10 @@ def log(self):
             + self.other_type.describe())
 
 
-class ECVECT(DMLError):
-    """`vect` types are only permitted if the [`c_vect` provisional
-    feature](provisional-auto.html#c_vect) is enabled."""
-    fmt = "declaration of vect type without c_vect provisional"
+class EOLDVECT(DMLError):
+    """`vect` types are only permitted if the [`simics_util_vect` provisional
+    feature](provisional-auto.html#simics_util_vect) is enabled."""
+    fmt = "declaration of vect type without simics_util_vect provisional"
 
 #
 # WARNINGS (keep these as few as possible)
diff --git a/py/dml/provisional.py b/py/dml/provisional.py
@@ -75,14 +75,14 @@ class explicit_param_decls(ProvisionalFeature):
 
 
 @feature
-class c_vect(ProvisionalFeature):
-    '''<a id="c_vect"/>
+class simics_util_vect(ProvisionalFeature):
+    '''<a id="simics_util_vect"/>
     This feature enables the `vect` type, based on the
     `VECT` macro from the Simics C API (`simics/util/vect.h`).
 
     This is a simple wrapping that behaves inconsistently in many
     ways, and we plan to eventually introduce a cleaner mechanism for
-    vectors; the `c_vect` is supported as an interim solution until we
+    vectors; the `simics_util_vect` is supported as an interim solution until we
     have that in place.
 
     The syntax is `BASETYPE vect`, e.g. `typedef int vect int_vect_t;`
@@ -128,12 +128,12 @@ class c_vect(ProvisionalFeature):
       }
       ```
 
-    Enabling the `c_vect` feature in a file only affects
+    Enabling the `simics_util_vect` feature in a file only affects
     the `vect` declarations in that file.
 
-    When the `c_vect` feature is disabled, usage of `vect` is an
-    error unless the [`c_vect_without_provisional` compatibility
-    feature](deprecations-auto.html#c_vect_without_provisional) is enabled.
+    When the `simics_util_vect` feature is disabled, usage of `vect` is an
+    error unless the [`experimental_vect` compatibility
+    feature](deprecations-auto.html#experimental_vect) is enabled.
     '''
     short = "Allow vect syntax based on the VECT macro"
     stable = True
diff --git a/test/1.2/errors/T_EIDENT.dml b/test/1.2/errors/T_EIDENT.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.2/errors/T_EOLDVECT.dml b/test/1.2/errors/T_EOLDVECT.dml
@@ -14,6 +14,6 @@ device test;
 // No complaint, even though the c_vect provisional is not enabled.
 // This gives a warning in DML 1.4, see
 // 1.4/legacy/c_vect_without_provisional_enabled,
-// and an ECVECT with c_vect_without_provisional disabled,
+// and an EOLDVECT with c_vect_without_provisional disabled,
 // see 1.4/legacy/c_vect_without_provisional_disabled.
 typedef int vect int_vect_t;
diff --git a/test/1.2/errors/T_ETREC.dml b/test/1.2/errors/T_ETREC.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 import "testing.dml";
diff --git a/test/1.2/errors/T_strict.dml b/test/1.2/errors/T_strict.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 /* <add id="dml changes strict"/> */
 
diff --git a/test/1.2/internal/T_vect.dml b/test/1.2/internal/T_vect.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.2/internal/T_vect_select.dml b/test/1.2/internal/T_vect_select.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.2/statements/T_if_ambiguity.dml b/test/1.2/statements/T_if_ambiguity.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.2;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.4/errors/T_ECAST.dml b/test/1.4/errors/T_ECAST.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.4;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.4/errors/T_EEXTERNINCOMP.dml b/test/1.4/errors/T_EEXTERNINCOMP.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.4;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.4/errors/T_ESERIALIZE.dml b/test/1.4/errors/T_ESERIALIZE.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.4;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.4/errors/T_EVOID.dml b/test/1.4/errors/T_EVOID.dml
@@ -3,7 +3,7 @@
   SPDX-License-Identifier: MPL-2.0
 */
 dml 1.4;
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
diff --git a/test/1.4/provisional/T_simics_util_vect.dml b/test/1.4/provisional/T_simics_util_vect.dml
@@ -5,14 +5,14 @@
 
 dml 1.4;
 
-provisional c_vect;
+provisional simics_util_vect;
 
 device test;
 
 /// COMPILE-ONLY
 
-// Error reporting tested by 1.4/legacy/c_vect_without_provisional_*.dml
+// Error reporting tested by 1.4/legacy/experimental_vect_*.dml
 
-/// DMLC-FLAG --no-compat=c_vect_without_provisional
+/// DMLC-FLAG --no-compat=experimental_vect
 // no warning
 typedef int vect x;
