Differences

This shows you the differences between two versions of the page.

--- soc:fredrikhultin [2006/07/11 23:09]
noname
+++ soc:fredrikhultin [2006/07/12 00:24] (current)
noname
@@ Line 7: / Line 7: @@
 ===== Design =====
 ==== User interface ====
@@ Line 12: / Line 13: @@
 <file>
+Welcome to Etherboot
 ?>help
@@ Line 80: / Line 83: @@
   /* Name and describe the list set */
   cmdl_param_list_set_name(ipv4, "ipv4");
-  cmdl_param_list_set_descr(ipv4, "Set the IP adress and netmask (IPv4)");
+  cmdl_param_list_set_desc(ipv4, "Set the IP adress and netmask (IPv4)");
   /* Add the parameters with name, type and example value */
@@ Line 94: / Line 97: @@
   /* Name and describe the list set */
   cmdl_param_list_set_name(ipv6, "ipv6");
-  cmdl_param_list_set_descr(ipv6, "Set the IP adress (IPv6)");
+  cmdl_param_list_set_desc(ipv6, "Set the IP adress (IPv6)");
   cmdl_param_list_set_add(ipv6, "ip", CMDL_IPV6, "2001:0db8::1428:57ab");
@@ Line 106: / Line 109: @@
   /* Name and describe the list set */
   cmdl_param_list_set_name(view, "view");
-  cmdl_param_list_set_descr(view, "View the IP/netmask");
+  cmdl_param_list_set_desc(view, "View the IP/netmask");
   /* (No parameters = view) */
@@ Line 116: / Line 119: @@
   /* Add the three list sets to the parameter list */
-  cmdl_param_list_add(ipv4);
+  cmdl_param_list_add(param_list, ipv4);
-  cmdl_param_list_add(ipv6);
+  cmdl_param_list_add(param_list, ipv6);
-  cmdl_param_list_add(view);
+  cmdl_param_list_add(param_list, view);
   /* Return the parameter list to the command line */
@@ Line 167: / Line 170: @@
 }
 </code>
+Observe that the output of "help ip" is generated from this implementation.
 ==== Structures ====
@@ Line 198: / Line 203: @@
 <code c>
 typedef struct {
-  int num_sets;
+  int num_sets; // The number of sets in the list
-  cmdl_param_list_set* param_list_set;
+  cmdl_param_list_set** param_list_set; // An array of list set pointers
 } cmdl_param_list;
 </code>
@@ Line 210: / Line 215: @@
 <code c>
 typedef struct {
-  char* name;
+  char* name;  // Name of the list set (used for identification)
-  char* desc;
+  char* desc;  // Description of the list set (used for the automated help)
-  int num_params;
+  int num_params;   // The number of parameters
-  cmdl_param_desc param;
+  cmdl_param_desc** param; // An array of parameter description pointers
 } cmdl_param_list_set;
 </code>
@@ Line 223: / Line 228: @@
 <code c>
 typedef struct {
-  int type;
+  int type; // Parameter type
-  char* name;
+  char* name; // Parameter name
-  char* example;
+  char* example; // Example of possible value
 } cmdl_param_desc;
 </code>
@@ Line 237: / Line 242: @@
 enum{
   CMDL_INT=0,
-  CMDL_FLOAT,
+  CMDL_FP,
   CMDL_STR,
   CMDL_IPV4,
@@ Line 244: / Line 249: @@
 </code>
+=== cmdl_params ===
+Contains one named parameter set
+<code c>
+typedef struct{
+  char* set_name; // Name of the set
+  int num_params; // The number of parameters the set contains
+  cmdl_param** param; // An array of param pointers
+}cmdl_params;
+</code>
+=== cmdl_param ===
+Container class for parameter values. Only one parameter type is valid per parameter.
+<code c>
+typedef struct{
+  int valid_type; // Defines the param type (which pointer is valid)
+  // Pointers to available types
+  int* integer;
+  double* fp;
+  char* str;
+  cmdl_ipv4* ipv4;
+  cmdl_ipv6* ipv6;
+  // ...
+}cmdl_param;
+// with supporting structures like
+typedef struct{
+  unsigned char octet[4];
+}cmdl_ipv4;
+typedef struct{
+  unsigned short int part[
+];
+}cmdl_ipv6;
+// ...etc
+</code>
+==== Functions ====
+Functions for the command implementation interface
+=== cmdl_param_list_set_create ===
+Allocates a new list set and returns it.
+<code>
+cmdl_param_list_set* cmdl_param_list_set_create();
+</code>
+=== cmdl_param_list_set_name ===
+Names a given list set with a given name.
+<code>
+void cmdl_param_list_set_name(cmdl_param_list_set* list_set, char* name);
+</code>
+=== cmdl_param_list_set_desc ===
+Adds a description to a given list set.
+<code>
+void cmdl_param_list_set_desc(cmdl_param_list_set* list_set, char* desc);
+</code>
+=== cmdl_param_list_set_add ===
+Adds a parameter description to a given list set.
+<code>
+void cmdl_param_list_set_add(cmdl_param_list_set* list_set, char* name, int type, char* example);
+</code>
+=== cmdl_param_list_create ===
+Allocates and returns a parameter new parameter list.
+<code>
+cmdl_param_list* cmdl_param_list_create();
+</code>
+=== cmdl_param_list_add ===
+Adds a parameter list set to a given parameter list.
+<code>
+void cmdl_param_list_add(cmdl_param_list* param_list, cmdl_param
+</code>
+=== cmdl_printf ===
+Prints formated text to a given command line.
+<code>
+int cmdl_printf(cmd_line* cmd, const char *format, ...);
+</code>
+=== cmdl_param_get_TYPE ===
+Returns the given parameter from a cmdl_params as TYPE.
+Rturns NULL if the parameter isn't a TYPE.
+<code>
+int *cmdl_param_get_int(cmdl_params* params, int param_num);
+cmdl_ipv4 *cmdl_param_get_ipv4(cmdl_params* params, int param_num);
+...
+</code>
+==== Concerns ====
+Perhaps this implementation would be a bit over the top. I got an email from Michael last week and he suggested, without reading this, that I should use ordinary C-style command structures (int argc, char** argv). That might not be as grandiose, and it would be harder to generate standardized automated help output, but it'd be much easier to implement. With some nice parse helper functions available to the command implementations, then perhaps it wouldn't be so bad. Hmm...
 ===== Status =====
 The command line is working and accepts input from the user, which it parses and then, at the moment, disregards.

Trace:

Differences

Navigation

Search

Toolbox

QR Code