Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Kill old $Id$ command dating from CVS
[simgrid.git] / src / xbt / config.c
index 20875fa..f8f3840 100644 (file)
@@ -1,5 +1,3 @@
-/* $Id$ */
-
 /* config - Dictionnary where the type of each variable is provided.            */
 
 /* This is useful to build named structs, like option or property sets.     */
@@ -34,6 +32,7 @@ typedef struct {
   /* Allowed type of the variable */
   e_xbt_cfgelm_type_t type;
   int min, max;
+  int isdefault:1;
 
   /* Callbacks */
   xbt_cfg_cb_t cb_set;
@@ -86,8 +85,9 @@ void xbt_cfg_cpy(xbt_cfg_t tocopy, xbt_cfg_t * whereto)
   xbt_assert0(tocopy, "cannot copy NULL config");
 
   xbt_dict_foreach((xbt_dict_t) tocopy, cursor, name, variable) {
-    xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL, variable->min,
-                     variable->max, variable->cb_set, variable->cb_rm);
+    xbt_cfg_register(whereto, name, variable->desc, variable->type, NULL,
+                     variable->min, variable->max, variable->cb_set,
+                     variable->cb_rm);
   }
 }
 
@@ -200,18 +200,19 @@ void xbt_cfgelm_free(void *data)
  */
 
 void
-xbt_cfg_register(xbt_cfg_t *cfg,
-                 const char *name, const char *desc, e_xbt_cfgelm_type_t type, void *default_value,
-                 int min, int max, xbt_cfg_cb_t cb_set, xbt_cfg_cb_t cb_rm)
+xbt_cfg_register(xbt_cfg_t * cfg,
+                 const char *name, const char *desc, e_xbt_cfgelm_type_t type,
+                 void *default_value, int min, int max, xbt_cfg_cb_t cb_set,
+                 xbt_cfg_cb_t cb_rm)
 {
   xbt_cfgelm_t res;
 
-  if (*cfg==NULL)
-        *cfg=xbt_cfg_new();
+  if (*cfg == NULL)
+    *cfg = xbt_cfg_new();
   xbt_assert4(type >= xbt_cfgelm_int && type <= xbt_cfgelm_peer,
               "type of %s not valid (%d should be between %d and %d)",
               name, type, xbt_cfgelm_int, xbt_cfgelm_peer);
-  res = xbt_dict_get_or_null((xbt_dict_t) *cfg, name);
+  res = xbt_dict_get_or_null((xbt_dict_t) * cfg, name);
 
   if (res) {
     WARN1("Config elem %s registered twice.", name);
@@ -228,37 +229,38 @@ xbt_cfg_register(xbt_cfg_t *cfg,
   res->max = max;
   res->cb_set = cb_set;
   res->cb_rm = cb_rm;
+  res->isdefault = 1;
 
   switch (type) {
   case xbt_cfgelm_int:
     res->content = xbt_dynar_new(sizeof(int), NULL);
     if (default_value)
-       xbt_dynar_push(res->content,default_value);
+      xbt_dynar_push(res->content, default_value);
     break;
 
   case xbt_cfgelm_double:
     res->content = xbt_dynar_new(sizeof(double), NULL);
     if (default_value)
-       xbt_dynar_push(res->content,default_value);
+      xbt_dynar_push(res->content, default_value);
     break;
 
   case xbt_cfgelm_string:
     res->content = xbt_dynar_new(sizeof(char *), xbt_free_ref);
     if (default_value)
-       xbt_dynar_push(res->content,default_value);
+      xbt_dynar_push(res->content, default_value);
     break;
 
   case xbt_cfgelm_peer:
     res->content = xbt_dynar_new(sizeof(xbt_peer_t), xbt_peer_free_voidp);
     if (default_value)
-       xbt_dynar_push(res->content,default_value);
+      xbt_dynar_push(res->content, default_value);
     break;
 
   default:
     ERROR1("%d is an invalide type code", type);
   }
 
-  xbt_dict_set((xbt_dict_t) *cfg, name, res, &xbt_cfgelm_free);
+  xbt_dict_set((xbt_dict_t) * cfg, name, res, &xbt_cfgelm_free);
 }
 
 /** @brief Unregister an element from a config set.
@@ -289,7 +291,7 @@ void xbt_cfg_unregister(xbt_cfg_t cfg, const char *name)
  * @fixme: this does not allow to set the description
  */
 
-void xbt_cfg_register_str(xbt_cfg_t *cfg, const char *entry)
+void xbt_cfg_register_str(xbt_cfg_t * cfg, const char *entry)
 {
   char *entrycpy = xbt_strdup(entry);
   char *tok;
@@ -331,61 +333,67 @@ void xbt_cfg_register_str(xbt_cfg_t *cfg, const char *entry)
 }
 
 /** @brief Displays the declared options and their description */
-void xbt_cfg_help(xbt_cfg_t cfg) {
-       xbt_dict_cursor_t cursor;
-       xbt_cfgelm_t variable;
-       char *name;
-
-         int i;
-         int size;
-
-       xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
-               printf("   %s: %s\n",name,variable->desc);
-               printf("       Type: %s; ", xbt_cfgelm_type_name[variable->type]);
-               if (variable->min != 1 || variable->max != 1)
-                       printf("Arrity: min:%d to max:%d; ",variable->min,variable->max);
-               printf("Current value: ");
-               size = xbt_dynar_length(variable->content);
-
-           switch (variable->type) {
-                 int ival;
-                 char *sval;
-                 double dval;
-                 xbt_peer_t hval;
-
-           case xbt_cfgelm_int:
-             for (i = 0; i < size; i++) {
-               ival = xbt_dynar_get_as(variable->content, i, int);
-               printf("%s%d\n", (i==0?"":"              "),ival);
-             }
-             break;
-
-           case xbt_cfgelm_double:
-             for (i = 0; i < size; i++) {
-               dval = xbt_dynar_get_as(variable->content, i, double);
-               printf("%s%f\n", (i==0?"":"              "),dval);
-             }
-             break;
-
-           case xbt_cfgelm_string:
-             for (i = 0; i < size; i++) {
-               sval = xbt_dynar_get_as(variable->content, i, char *);
-               printf("%s'%s'\n", (i==0?"":"              "),sval);
-             }
-             break;
-
-           case xbt_cfgelm_peer:
-             for (i = 0; i < size; i++) {
-               hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
-               printf("%s%s:%d\n", (i==0?"":"              "),hval->name, hval->port);
-             }
-             break;
-
-           default:
-             printf("Invalid type!!\n");
-           }
-
-       }
+void xbt_cfg_help(xbt_cfg_t cfg)
+{
+  xbt_dict_cursor_t cursor;
+  xbt_cfgelm_t variable;
+  char *name;
+
+  int i;
+  int size;
+
+  xbt_dict_foreach((xbt_dict_t) cfg, cursor, name, variable) {
+    printf("   %s: %s\n", name, variable->desc);
+    printf("       Type: %s; ", xbt_cfgelm_type_name[variable->type]);
+    if (variable->min != 1 || variable->max != 1) {
+      if (variable->min == 0 && variable->max == 0)
+        printf("Arity: no bound; ");
+      else
+        printf("Arity: min:%d to max:%d; ", variable->min, variable->max);
+    }
+    printf("Current value: ");
+    size = xbt_dynar_length(variable->content);
+
+    switch (variable->type) {
+      int ival;
+      char *sval;
+      double dval;
+      xbt_peer_t hval;
+
+    case xbt_cfgelm_int:
+      for (i = 0; i < size; i++) {
+        ival = xbt_dynar_get_as(variable->content, i, int);
+        printf("%s%d\n", (i == 0 ? "" : "              "), ival);
+      }
+      break;
+
+    case xbt_cfgelm_double:
+      for (i = 0; i < size; i++) {
+        dval = xbt_dynar_get_as(variable->content, i, double);
+        printf("%s%f\n", (i == 0 ? "" : "              "), dval);
+      }
+      break;
+
+    case xbt_cfgelm_string:
+      for (i = 0; i < size; i++) {
+        sval = xbt_dynar_get_as(variable->content, i, char *);
+        printf("%s'%s'\n", (i == 0 ? "" : "              "), sval);
+      }
+      break;
+
+    case xbt_cfgelm_peer:
+      for (i = 0; i < size; i++) {
+        hval = xbt_dynar_get_as(variable->content, i, xbt_peer_t);
+        printf("%s%s:%d\n", (i == 0 ? "" : "              "), hval->name,
+               hval->port);
+      }
+      break;
+
+    default:
+      printf("Invalid type!!\n");
+    }
+
+  }
 }
 
 /** @brief Check that each variable have the right amount of values */
@@ -426,7 +434,7 @@ static xbt_cfgelm_t xbt_cfgelm_get(xbt_cfg_t cfg,
 
   res = xbt_dict_get_or_null((xbt_dict_t) cfg, name);
   if (!res) {
-         xbt_cfg_help(cfg);
+    xbt_cfg_help(cfg);
     THROW1(not_found_error, 0,
            "No registered variable '%s' in this config set", name);
   }
@@ -631,7 +639,7 @@ void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options)
       if (e.category == not_found_error) {
         xbt_ex_free(e);
         THROW1(not_found_error, 0,
-               "No registrated variable corresponding to '%s'.", name);
+               "No registered variable corresponding to '%s'.", name);
       }
       RETHROW;
     }
@@ -702,6 +710,60 @@ void xbt_cfg_set_parse(xbt_cfg_t cfg, const char *options)
 
 }
 
+/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
+ *
+ * This is useful to change the default value of a variable while allowing
+ * users to override it with command line arguments
+ */
+void xbt_cfg_setdefault_int(xbt_cfg_t cfg, const char *name, int val) {
+  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_int);
+
+  if (variable->isdefault)
+    xbt_cfg_set_int(cfg, name,val);
+  else
+    DEBUG2("Do not override configuration variable '%s' with value '%d' because it was already set.",name,val);
+}
+/** @brief Set an integer value to \a name within \a cfg if it wasn't changed yet
+ *
+ * This is useful to change the default value of a variable while allowing
+ * users to override it with command line arguments
+ */
+void xbt_cfg_setdefault_double(xbt_cfg_t cfg, const char *name, double val) {
+  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_double);
+
+  if (variable->isdefault)
+    xbt_cfg_set_double(cfg, name, val);
+  else
+    DEBUG2("Do not override configuration variable '%s' with value '%lf' because it was already set.",name,val);
+}
+/** @brief Set a string value to \a name within \a cfg if it wasn't changed yet
+ *
+ * This is useful to change the default value of a variable while allowing
+ * users to override it with command line arguments
+ */
+void xbt_cfg_setdefault_string(xbt_cfg_t cfg, const char *name, const char* val) {
+  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_string);
+
+  if (variable->isdefault)
+    xbt_cfg_set_string(cfg, name,val);
+  else
+    DEBUG2("Do not override configuration variable '%s' with value '%s' because it was already set.",name,val);
+}
+/** @brief Set a peer value to \a name within \a cfg if it wasn't changed yet
+ *
+ * This is useful to change the default value of a variable while allowing
+ * users to override it with command line arguments
+ */
+void xbt_cfg_setdefault_peer(xbt_cfg_t cfg, const char *name, const char* host, int port) {
+  xbt_cfgelm_t variable = xbt_cfgelm_get(cfg, name, xbt_cfgelm_peer);
+
+  if (variable->isdefault)
+    xbt_cfg_set_peer(cfg, name, host, port);
+  else
+    DEBUG3("Do not override configuration variable '%s' with value '%s:%d' because it was already set.",
+        name,host,port);
+}
+
 /** @brief Set or add an integer value to \a name within \a cfg
  *
  * \arg cfg the config set
@@ -733,6 +795,7 @@ void xbt_cfg_set_int(xbt_cfg_t cfg, const char *name, int val)
 
   if (variable->cb_set)
     (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+  variable->isdefault = 0;
 }
 
 /** @brief Set or add a double value to \a name within \a cfg
@@ -765,6 +828,7 @@ void xbt_cfg_set_double(xbt_cfg_t cfg, const char *name, double val)
 
   if (variable->cb_set)
     (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+  variable->isdefault = 0;
 }
 
 /** @brief Set or add a string value to \a name within \a cfg
@@ -808,6 +872,7 @@ void xbt_cfg_set_string(xbt_cfg_t cfg, const char *name, const char *val)
 
   if (variable->cb_set)
     (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+  variable->isdefault = 0;
 }
 
 /** @brief Set or add an peer value to \a name within \a cfg
@@ -846,6 +911,7 @@ xbt_cfg_set_peer(xbt_cfg_t cfg, const char *name, const char *peer, int port)
 
   if (variable->cb_set)
     (*variable->cb_set) (name, xbt_dynar_length(variable->content) - 1);
+  variable->isdefault = 0;
 }
 
 /* ---- [ Removing ] ---- */
@@ -1102,7 +1168,7 @@ double xbt_cfg_get_double(xbt_cfg_t cfg, const char *name)
  *
  * Returns the first value from the config set under the given name.
  * If there is more than one value, it will issue a warning. Consider using
- * xbt_cfg_get_dynar() instead.
+ * xbt_cfg_get_dynar() instead. Returns NULL if there is no value.
  *
  * \warning the returned value is the actual content of the config set
  */
@@ -1115,6 +1181,8 @@ char *xbt_cfg_get_string(xbt_cfg_t cfg, const char *name)
     WARN2
       ("You asked for the first value of the config element '%s', but there is %lu values\n",
        name, xbt_dynar_length(variable->content));
+  } else if (xbt_dynar_length(variable->content) == 0) {
+    return NULL;
   }
 
   return xbt_dynar_get_as(variable->content, 0, char *);
@@ -1233,7 +1301,7 @@ static xbt_cfg_t make_set()
 {
   xbt_cfg_t set = NULL;
 
-  xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg),xbt_log_priority_critical);
+  xbt_log_threshold_set(&_XBT_LOGV(xbt_cfg), xbt_log_priority_critical);
   xbt_cfg_register_str(&set, "speed:1_to_2_int");
   xbt_cfg_register_str(&set, "peername:1_to_1_string");
   xbt_cfg_register_str(&set, "user:1_to_10_string");