Change in libosmocore[master]: vty/command: print attribute flags in the output of 'list'

[Vadim Yanitskiy]

Vadim Yanitskiy has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmocore/+/20464 )


Change subject: vty/command: print attribute flags in the output of 'list'
......................................................................

vty/command: print attribute flags in the output of 'list'

Here is an example:

  OsmoAPP(config-foo)# list
    ...  help
    ...  list
    ...  show running-config
    ...  exit
    ..F  lib-command foo (one|two|three)
    ZB.  lib-command bar [zoo]
    .bf  app-command foo-bar
    z..  app-command zoo .TEXT
    ...  app-command nope

A dot indicates that the associated attribute is not set.

Note that there is no strict relation between rows and index values
of the attributes.  In the example above there could be one or more
hidden flag rows corresponding to attributes that are not assigned
to any of the commands within 'config-foo' node.

If neither of the commands belonging to the current node (where
'list' command is executed) has attributes, the output would
not contain empty dot-rows.

Global attributes (such as CMD_ATTR_IMMEDIATE) are not yet displayed
because we still have not agreed on what kind of symbols to assign
them.  This will be implemented later.

Change-Id: I71cef3ec0fab44c7e11fc353b8bc42268a4ee8f0
Related: SYS#4937
---
M src/vty/command.c
1 file changed, 72 insertions(+), 1 deletion(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/64/20464/1

diff --git a/src/vty/command.c b/src/vty/command.c
index e82c43b..eeca39b 100644
--- a/src/vty/command.c
+++ b/src/vty/command.c
@@ -3035,11 +3035,81 @@
 	return CMD_SUCCESS;
 }
 
+/* Compose flag bit-mask for all commands within the given node */
+static unsigned int node_flag_mask(const struct cmd_node *cnode)
+{
+	unsigned int flag_mask = 0x00;
+	unsigned int f, i;
+
+	for (f = 0; f < VTY_CMD_USR_ATTR_NUM; f++) {
+		for (i = 0; i < vector_active(cnode->cmd_vector); i++) {
+			const struct cmd_element *cmd;
+			char flag_letter;
+
+			if ((cmd = vector_slot(cnode->cmd_vector, i)) == NULL)
+				continue;
+			if (cmd->attr & (CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN))
+				continue;
+			if (~cmd->usrattr & (1 << f))
+				continue;
+
+			if (cmd->attr & CMD_ATTR_LIB_COMMAND)
+				flag_letter = cmd_lib_attr_letters[f];
+			else
+				flag_letter = host.app_info->usr_attr_letters[f];
+
+			if (flag_letter == '\0')
+				continue;
+
+			flag_mask |= (1 << f);
+			break;
+		}
+	}
+
+	return flag_mask;
+}
+
+/* Compose flag char-mask for the given command (e.g. '.F.OB..') */
+static const char *cmd_flag_mask(const struct cmd_element *cmd,
+				 unsigned int flag_mask)
+{
+	static char char_mask[VTY_CMD_USR_ATTR_NUM + 1];
+	char *ptr = &char_mask[0];
+	char flag_letter;
+	unsigned int f;
+
+	for (f = 0; f < VTY_CMD_USR_ATTR_NUM; f++) {
+		if (~flag_mask & (1 << f))
+			continue;
+		if (~cmd->usrattr & (1 << f)) {
+			*(ptr++) = '.';
+			continue;
+		}
+
+		if (cmd->attr & CMD_ATTR_LIB_COMMAND)
+			flag_letter = cmd_lib_attr_letters[f];
+		else
+			flag_letter = host.app_info->usr_attr_letters[f];
+
+		*(ptr++) = flag_letter ? flag_letter : '.';
+	}
+
+	if (ptr > &char_mask[0]) {
+		*(ptr++) = ' ';
+		*(ptr++) = ' ';
+	}
+
+	*ptr = '\0';
+
+	return char_mask;
+}
+
 /* Help display function for all node. */
 gDEFUN(config_list, config_list_cmd, "list", "Print command list\n")
 {
 	unsigned int i;
 	struct cmd_node *cnode = vector_slot(cmdvec, vty->node);
+	unsigned int flag_mask = node_flag_mask(cnode);
 	struct cmd_element *cmd;
 
 	for (i = 0; i < vector_active(cnode->cmd_vector); i++) {
@@ -3047,7 +3117,8 @@
 			continue;
 		if (cmd->attr & (CMD_ATTR_DEPRECATED | CMD_ATTR_HIDDEN))
 			continue;
-		vty_out(vty, "  %s%s", cmd->string, VTY_NEWLINE);
+		vty_out(vty, "  %s%s%s", cmd_flag_mask(cmd, flag_mask),
+			cmd->string, VTY_NEWLINE);
 	}
 
 	return CMD_SUCCESS;

-- 
To view, visit https://gerrit.osmocom.org/c/libosmocore/+/20464
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: I71cef3ec0fab44c7e11fc353b8bc42268a4ee8f0
Gerrit-Change-Number: 20464
Gerrit-PatchSet: 1
Gerrit-Owner: Vadim Yanitskiy <vyanitskiy at sysmocom.de>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20201006/23785079/attachment.htm>