Merge branch 'dev/cmd/get/opts'

nickolasburr · Jan 13, 2018 · 76c971d · 76c971d
2 parents 25622f5 + c12a1e8
commit 76c971d
Show file tree

Hide file tree

Showing 5 changed files with 172 additions and 77 deletions.
diff --git a/include/argv.h b/include/argv.h
@@ -12,9 +12,13 @@
 #include "utils.h"
 
 /**
- * Commands
+ * ASCII character codes.
  */
+#define ASCII_PERCENT 37
 
+/**
+ * Commands
+ */
 #define NUM_CMDS 6
 
 /**
@@ -31,6 +35,9 @@
  * Command options
  */
 
+/**
+ * Number of 'sbctl ls' options.
+ */
 #define NUM_LS_OPTS 5
 
 /**
@@ -43,9 +50,19 @@
 #define MASK_CMD_LIST_OPT_USB  ((0xFF << 0x4))
 
 /**
- * ASCII character codes.
+ * Number of 'sbctl get' options.
  */
-#define ASCII_PERCENT 37
+#define NUM_GET_OPTS 1
+
+/**
+ * Hex masks for 'sbctl get' options.
+ */
+#define MASK_CMD_GET_OPT_HELP ((0xFE << 0x0))
+
+/**
+ * Example usage for 'sbctl get'.
+ */
+#define EXAMPLE_USAGE_CMD_GET "sbctl get %1"
 
 typedef struct {
 	char *value;
@@ -63,6 +80,7 @@ typedef struct {
 } Command_T;
 
 static Command_T commands[NUM_CMDS];
+static Option_T get_opts[NUM_GET_OPTS];
 static Option_T ls_opts[NUM_LS_OPTS];
 
 int ARGV_get_command_bitmask(const char *);

diff --git a/include/format.h b/include/format.h
@@ -7,11 +7,11 @@
 #ifndef SBCTL_FORMAT_H
 #define SBCTL_FORMAT_H
 
+#define COLUMN_LINE "---"
 #define LIST_HEADER "-------------------------------------------------------------------------------------------------------------------------------------------\n" \
                     "| ### | Spec | Mode | Type | Bus | Address | Port | Power [mA] | Speed [Mbps] | Serial Number | Device ID  | Vendor | Product Description |\n" \
                     "-------------------------------------------------------------------------------------------------------------------------------------------\n"
 #define LIST_FOOTER "-------------------------------------------------------------------------------------------------------------------------------------------\n"
 #define NOT_SPECIFIED "Not Specified"
 
-
 #endif /* SBCTL_FORMAT_H */
diff --git a/include/thun.h b/include/thun.h
@@ -10,6 +10,11 @@
 #include "common.h"
 #include "serial.h"
 
+#define THUN_MODE_NAME "thun"
+#define THUN_PORT_TYPE "port"
+#define THUN_BRID_TYPE "bridge"
+#define THUN_SWIT_TYPE "switch"
+
 #define THUN_V1 0x1
 #define THUN_V2 0x2
 #define THUN_V3 0x3

diff --git a/src/argv.c b/src/argv.c
@@ -85,7 +85,19 @@ static Option_T ls_opts[] = {
 };
 
 /**
- * Initialize command->options[index] structs.
+ * sbctl get options.
+ */
+static Option_T get_opts[] = {
+	{
+		"--help",
+		"-h",
+		"Show usage information.",
+		MASK_CMD_GET_OPT_HELP,
+	},
+};
+
+/**
+ * Initialize command->options pointer array.
  */
 void ARGV_init (void) {
 	int index;
@@ -99,11 +111,15 @@ void ARGV_init (void) {
 			 * sbctl ls
 			 */
 			case MASK_CMD_LIST:
-				/**
-				 * Make command->options point to ls_opts array.
-				 */
 				command->options = &ls_opts;
 
+				break;
+			/**
+			 * sbctl get
+			 */
+			case MASK_CMD_GET:
+				command->options = &get_opts;
+
 				break;
 			default:
 				break;
@@ -152,9 +168,19 @@ int ARGV_get_option_bitmask (const char *cmd, const char *value) {
 			 * Length of command->options array.
 			 */
 			switch (ARGV_get_command_bitmask(cmd)) {
+				/**
+				 * sbctl ls
+				 */
 				case MASK_CMD_LIST:
 					length = (sizeof(ls_opts) / sizeof(ls_opts[0]));
 
+					break;
+				/**
+				 * sbctl get
+				 */
+				case MASK_CMD_GET:
+					length = (sizeof(get_opts) / sizeof(get_opts[0]));
+
 					break;
 				default:
 					length = 0;
@@ -185,9 +211,19 @@ int ARGV_get_option_bitmask (const char *cmd, const char *value) {
 			 * Length of command->options array, based on command.
 			 */
 			switch (ARGV_get_command_bitmask(cmd)) {
+				/**
+				 * sbctl ls
+				 */
 				case MASK_CMD_LIST:
 					length = (sizeof(ls_opts) / sizeof(ls_opts[0]));
 
+					break;
+				/**
+				 * sbctl get
+				 */
+				case MASK_CMD_GET:
+					length = (sizeof(get_opts) / sizeof(get_opts[0]));
+
 					break;
 				default:
 					length = 0;
@@ -218,19 +254,32 @@ int ARGV_get_option_bitmask (const char *cmd, const char *value) {
  * Print command-specific usage information.
  */
 void ARGV_command_usage (const char *cmd) {
-	int index, length;
+	int index, length, bitmask;
 	char value[40];
 	Option_T *cmd_opts = NULL;
 	Option_T *option = NULL;
 
+	bitmask = ARGV_get_command_bitmask(cmd);
+
 	fprintf(stdout, "Usage: sbctl %s [OPTIONS]\n\n", cmd);
 	fprintf(stdout, "Options:\n\n");
 
-	switch (ARGV_get_command_bitmask(cmd)) {
+	switch (bitmask) {
+		/**
+		 * sbctl ls
+		 */
 		case MASK_CMD_LIST:
 			cmd_opts = (Option_T *) &ls_opts;
 			length = (sizeof(ls_opts) / sizeof(ls_opts[0]));
 
+			break;
+		/**
+		 * sbctl get
+		 */
+		case MASK_CMD_GET:
+			cmd_opts = (Option_T *) &get_opts;
+			length = (sizeof(get_opts) / sizeof(get_opts[0]));
+
 			break;
 		default:
 			return;
@@ -257,6 +306,22 @@ void ARGV_command_usage (const char *cmd) {
 		fprintf(stdout, "%4s%-s%s: %-24s\n", "", value, option->alias, option->desc);
 	}
 
+	/**
+	 * Example usage details.
+	 */
+	switch (bitmask) {
+		/**
+		 * sbctl get
+		 */
+		case MASK_CMD_GET:
+			fprintf(stdout, "\nExamples:\n\n");
+			fprintf(stdout, "%4s%-s\n", "", EXAMPLE_USAGE_CMD_GET);
+
+			break;
+		default:
+			break;
+	}
+
 	return;
 }