[rtems-central commit] validation: Add comment to action condition states
Sebastian Huber
sebh at rtems.org
Mon Mar 1 09:01:33 UTC 2021
Module: rtems-central
Branch: master
Commit: 595f00ffca8ffc1f17e79c661c91456043f55d3f
Changeset: http://git.rtems.org/rtems-central/commit/?id=595f00ffca8ffc1f17e79c661c91456043f55d3f
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Mon Mar 1 09:56:07 2021 +0100
validation: Add comment to action condition states
---
rtemsspec/content.py | 13 +++++
rtemsspec/interface.py | 19 ++-----
rtemsspec/tests/test_validation.py | 103 +++++++++++++++++++++++++++++++++++++
rtemsspec/validation.py | 14 ++++-
4 files changed, 132 insertions(+), 17 deletions(-)
diff --git a/rtemsspec/content.py b/rtemsspec/content.py
index 954d459..c509d4a 100644
--- a/rtemsspec/content.py
+++ b/rtemsspec/content.py
@@ -1029,6 +1029,19 @@ def get_value_hash(ctx: ItemGetValueContext) -> Any:
return f"#{ctx.value[ctx.key]}"
+def get_value_params(ctx: ItemGetValueContext) -> Any:
+ """ Gets a value formatted as a parameter. """
+ return f"``{ctx.value[ctx.key]}``"
+
+
+def get_value_plural(ctx: ItemGetValueContext) -> Any:
+ """ Gets a value as a glossary term plural. """
+ try:
+ return ctx.value[ctx.key]
+ except KeyError:
+ return f"{ctx.value['term']}s"
+
+
class ExpressionMapper:
""" Maps symbols and operations to form a C expression. """
diff --git a/rtemsspec/interface.py b/rtemsspec/interface.py
index daf2fb4..5f17ab9 100644
--- a/rtemsspec/interface.py
+++ b/rtemsspec/interface.py
@@ -30,7 +30,7 @@ from typing import Any, Callable, Dict, Iterator, List, Optional, Union, Set
from rtemsspec.content import CContent, CInclude, enabled_by_to_exp, \
ExpressionMapper, get_value_double_colon, get_value_doxygen_function, \
- get_value_doxygen_group, get_value_hash
+ get_value_doxygen_group, get_value_hash, get_value_params, get_value_plural
from rtemsspec.items import Item, ItemCache, ItemGetValueContext, \
ItemGetValueMap, ItemMapper
@@ -59,23 +59,12 @@ def _get_value_forward_declaration(ctx: ItemGetValueContext) -> Any:
return _forward_declaration(ctx.item)
-def _get_value_params(ctx: ItemGetValueContext) -> Any:
- return f"``{ctx.value[ctx.key]}``"
-
-
-def _get_value_plural(ctx: ItemGetValueContext) -> Any:
- try:
- return ctx.value[ctx.key]
- except KeyError:
- return f"{ctx.value['term']}s"
-
-
class _InterfaceMapper(ItemMapper):
def __init__(self, node: "Node"):
super().__init__(node.item)
self._node = node
self._code_or_doc = "doc"
- self.add_get_value("glossary/term/doc:/plural", _get_value_plural)
+ self.add_get_value("glossary/term/doc:/plural", get_value_plural)
self.add_get_value("interface/forward-declaration/code:/name",
_get_value_forward_declaration)
self.add_get_value("interface/forward-declaration/doc:/name",
@@ -83,7 +72,7 @@ class _InterfaceMapper(ItemMapper):
self.add_get_value("interface/function/doc:/name",
get_value_doxygen_function)
self.add_get_value("interface/function/doc:/params/name",
- _get_value_params)
+ get_value_params)
self.add_get_value("interface/enumerator/doc:/name",
get_value_double_colon)
self.add_get_value("interface/typedef/doc:/name",
@@ -95,7 +84,7 @@ class _InterfaceMapper(ItemMapper):
self.add_get_value("interface/macro/doc:/name",
get_value_doxygen_function)
self.add_get_value("interface/macro/doc:/params/name",
- _get_value_params)
+ get_value_params)
self.add_get_value("interface/variable/doc:/name", get_value_hash)
for opt in ["feature-enable", "feature", "initializer", "integer"]:
name = f"interface/appl-config-option/{opt}/doc:/name"
diff --git a/rtemsspec/tests/test_validation.py b/rtemsspec/tests/test_validation.py
index 001f8ab..bac281d 100644
--- a/rtemsspec/tests/test_validation.py
+++ b/rtemsspec/tests/test_validation.py
@@ -318,16 +318,27 @@ static void Directive_Pre_Name_Prepare(
switch ( state ) {
case Directive_Pre_Name_Invalid: {
+ /*
+ * The name parameter shall not equal to a name of an active Classic API
+ * task object and not equal to RTEMS_SELF.
+ */
ctx->name = 1;
break;
}
case Directive_Pre_Name_Self: {
+ /*
+ * The name parameter shall be RTEMS_SELF.
+ */
ctx->name = RTEMS_SELF;
break;
}
case Directive_Pre_Name_Valid: {
+ /*
+ * The name parameter shall equal to a name of an active Classic API task
+ * object.
+ */
ctx->name = rtems_build_name( 'T', 'A', 'S', 'K' );
break;
}
@@ -346,31 +357,49 @@ static void Directive_Pre_Node_Prepare(
{
switch ( state ) {
case Directive_Pre_Node_Local: {
+ /*
+ * The node parameter shall be the local node number.
+ */
ctx->node = 1;
break;
}
case Directive_Pre_Node_Remote: {
+ /*
+ * The node parameter shall be a remote node number.
+ */
ctx->node = 2;
break;
}
case Directive_Pre_Node_Invalid: {
+ /*
+ * The node parameter shall be an invalid node number.
+ */
ctx->node = 256;
break;
}
case Directive_Pre_Node_SearchAll: {
+ /*
+ * The node parameter shall be RTEMS_SEARCH_ALL_NODES.
+ */
ctx->node = RTEMS_SEARCH_ALL_NODES;
break;
}
case Directive_Pre_Node_SearchOther: {
+ /*
+ * The node parameter shall be RTEMS_SEARCH_OTHER_NODES.
+ */
ctx->node = RTEMS_SEARCH_OTHER_NODES;
break;
}
case Directive_Pre_Node_SearchLocal: {
+ /*
+ * The node parameter shall be RTEMS_SEARCH_LOCAL_NODE.
+ */
ctx->node = RTEMS_SEARCH_LOCAL_NODE;
break;
}
@@ -387,11 +416,17 @@ static void Directive_Pre_Id_Prepare(
{
switch ( state ) {
case Directive_Pre_Id_NullPtr: {
+ /*
+ * The id parameter shall be NULL.
+ */
ctx->id = NULL;
break;
}
case Directive_Pre_Id_Valid: {
+ /*
+ * The id parameter shall point to an object identifier.
+ */
ctx->id_value = 0xffffffff;
ctx->id = &ctx->id_value;
break;
@@ -409,26 +444,41 @@ static void Directive_Post_Status_Check(
{
switch ( state ) {
case Directive_Post_Status_Ok: {
+ /*
+ * The status shall be RTEMS_SUCCESSFUL.
+ */
T_rsc(ctx->status, RTEMS_SUCCESSFUL);
break;
}
case Directive_Post_Status_InvAddr: {
+ /*
+ * The status shall be RTEMS_INVALID_ADDRESS.
+ */
T_rsc(ctx->status, RTEMS_INVALID_ADDRESS);
break;
}
case Directive_Post_Status_InvName: {
+ /*
+ * The status shall be RTEMS_INVALID_NAME.
+ */
T_rsc(ctx->status, RTEMS_INVALID_NAME);
break;
}
case Directive_Post_Status_InvNode: {
+ /*
+ * The status shall be RTEMS_INVALID_NODE.
+ */
T_rsc(ctx->status, RTEMS_INVALID_NODE);
break;
}
case Directive_Post_Status_InvId: {
+ /*
+ * The status shall be RTEMS_INVALID_ID.
+ */
T_rsc(ctx->status, RTEMS_INVALID_ID);
break;
}
@@ -445,29 +495,55 @@ static void Directive_Post_Id_Check(
{
switch ( state ) {
case Directive_Post_Id_Nop: {
+ /*
+ * The value of the object identifier referenced by the id parameter shall
+ * be the value before the call to rtems_task_ident().
+ */
T_eq_ptr(ctx->id, &ctx->id_value);
T_eq_u32(ctx->id_value, 0xffffffff);
break;
}
case Directive_Post_Id_NullPtr: {
+ /*
+ * The id parameter shall be NULL.
+ */
T_null(ctx->id)
break;
}
case Directive_Post_Id_Self: {
+ /*
+ * The value of the object identifier referenced by the id parameter shall
+ * be the identifier of the executing thread.
+ */
T_eq_ptr(ctx->id, &ctx->id_value);
T_eq_u32(ctx->id_value, rtems_task_self());
break;
}
case Directive_Post_Id_LocalTask: {
+ /*
+ * The value of the object identifier referenced by the id parameter shall
+ * be the identifier of a local task with a name equal to the name
+ * parameter. If more than one local task with such a name exists, then it
+ * shall be the identifier of the task with the lowest object index.
+ */
T_eq_ptr(ctx->id, &ctx->id_value);
T_eq_u32(ctx->id_value, ctx->id_local_task);
break;
}
case Directive_Post_Id_RemoteTask: {
+ /*
+ * The value of the object identifier referenced by the id parameter shall
+ * be the identifier of a remote task on a eligible node defined by the node
+ * parameter with a name equal to the name parameter. If more than one task
+ * with such a name exists on the same node, then it shall be the identifier
+ * of the task with the lowest object index. If more than one task with
+ * such a name exists on different eligible nodes, then it shall be the
+ * identifier of the task with the lowest node index.
+ */
T_eq_ptr(ctx->id, &ctx->id_value);
T_eq_u32(ctx->id_value, ctx->id_remote_task);
break;
@@ -1934,11 +2010,17 @@ static void Action2_Pre_A_Prepare( Action2_Context *ctx, Action2_Pre_A state )
switch ( state ) {
case Action2_Pre_A_X: {
+ /*
+ * Pre A X.
+ */
/* Pre A X */
break;
}
case Action2_Pre_A_Y: {
+ /*
+ * Pre A Y.
+ */
/* Pre A Y */
break;
}
@@ -1956,16 +2038,25 @@ static void Action2_Pre_B_Prepare( Action2_Context *ctx, Action2_Pre_B state )
switch ( state ) {
case Action2_Pre_B_X: {
+ /*
+ * Pre B X.
+ */
/* Pre B X */
break;
}
case Action2_Pre_B_Y: {
+ /*
+ * Pre B Y.
+ */
/* Pre B Y */
break;
}
case Action2_Pre_B_Z: {
+ /*
+ * Pre B Z.
+ */
/* Pre B Z */
break;
}
@@ -1983,11 +2074,17 @@ static void Action2_Post_A_Check( Action2_Context *ctx, Action2_Post_A state )
switch ( state ) {
case Action2_Post_A_X: {
+ /*
+ * Post A X.
+ */
/* Post A X */
break;
}
case Action2_Post_A_Y: {
+ /*
+ * Post A Y.
+ */
/* Post A Y */
break;
}
@@ -2005,11 +2102,17 @@ static void Action2_Post_B_Check( Action2_Context *ctx, Action2_Post_B state )
switch ( state ) {
case Action2_Post_B_X: {
+ /*
+ * Post B X.
+ */
/* Post B X */
break;
}
case Action2_Post_B_Y: {
+ /*
+ * Post B Y.
+ */
/* Post B Y */
break;
}
diff --git a/rtemsspec/validation.py b/rtemsspec/validation.py
index 1f4c9c2..0eb49fe 100644
--- a/rtemsspec/validation.py
+++ b/rtemsspec/validation.py
@@ -33,7 +33,8 @@ import re
from typing import Any, Dict, List, NamedTuple, Optional, Tuple
from rtemsspec.content import CContent, CInclude, enabled_by_to_exp, \
- ExpressionMapper, GenericContent, to_camel_case
+ ExpressionMapper, GenericContent, get_value_params, \
+ get_value_doxygen_group, get_value_doxygen_function, to_camel_case
from rtemsspec.items import Item, ItemCache, ItemGetValueContext, ItemMapper
ItemMap = Dict[str, Item]
@@ -49,6 +50,12 @@ class _Mapper(ItemMapper):
def __init__(self, item: Item):
super().__init__(item)
self._step = 0
+ self.add_get_value("interface/function:/name",
+ get_value_doxygen_function)
+ self.add_get_value("interface/function:/params/name", get_value_params)
+ self.add_get_value("interface/group:/name", get_value_doxygen_group)
+ self.add_get_value("interface/macro:/name", get_value_doxygen_function)
+ self.add_get_value("interface/macro:/params/name", get_value_params)
self.add_get_value("requirement/functional/action:/test-run",
_get_test_run)
self.add_get_value("test-case:/test-run", _get_test_run)
@@ -800,7 +807,10 @@ class _ActionRequirementTestItem(_TestItem):
for state_index, state in enumerate(condition["states"]):
content.add(f"case {enum[state_index + 1]}: {{")
with content.indent():
- content.add(
+ with content.comment_block():
+ content.append(
+ self.substitute_text(state["text"]))
+ content.append(
self.substitute_code(state["test-code"]))
content.append("break;")
content.add("}")
More information about the vc
mailing list