Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Correctly sort config entries for --help.
[simgrid.git] / src / xbt / config.cpp
index 49fe4a8..02512d8 100644 (file)
@@ -1,10 +1,11 @@
-/* Copyright (c) 2004-2014,2016. The SimGrid Team. All rights reserved.     */
+/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <stdio.h>
+#include <cstdio>
 
+#include <algorithm>
 #include <cerrno>
 #include <cstring>
 #include <climits>
@@ -14,6 +15,7 @@
 #include <string>
 #include <typeinfo>
 #include <type_traits>
+#include <vector>
 
 #include <xbt/ex.hpp>
 #include <xbt/config.h>
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_cfg, xbt, "configuration support");
 
 XBT_EXPORT_NO_IMPORT(xbt_cfg_t) simgrid_config = nullptr;
+extern "C" {
+  XBT_PUBLIC(void) sg_config_finalize();
+}
 
 namespace simgrid {
 namespace config {
 
-missing_key_error::~missing_key_error() {}
+missing_key_error::~missing_key_error() = default;
 
 class Config;
 
@@ -148,7 +153,7 @@ public:
   ConfigurationElement(const char* key, const char* desc, xbt_cfg_cb_t cb)
     : key(key ? key : ""), desc(desc ? desc : ""), old_callback(cb) {}
 
-  virtual ~ConfigurationElement();
+  virtual ~ConfigurationElement()=default;
 
   virtual std::string getStringValue() = 0;
   virtual void setStringValue(const char* value) = 0;
@@ -174,8 +179,6 @@ public:
   std::string const& getDescription() const { return desc; }
 };
 
-ConfigurationElement::~ConfigurationElement() {}
-
 // **** TypedConfigurationElement<T> ****
 
 // TODO, could we use boost::any with some Type* reference?
@@ -198,7 +201,7 @@ public:
     : ConfigurationElement(key, desc), content(std::move(value)),
       callback(std::move(callback))
   {}
-  ~TypedConfigurationElement() override;
+  ~TypedConfigurationElement()=default;
 
   std::string getStringValue() override;
   const char* getTypeName() override;
@@ -252,10 +255,6 @@ const char* TypedConfigurationElement<T>::getTypeName() // override
   return ConfigType<T>::type_name;
 }
 
-template<class T>
-TypedConfigurationElement<T>::~TypedConfigurationElement()
-{}
-
 } // end of anonymous namespace
 
 // **** Config ****
@@ -387,16 +386,15 @@ void Config::dump(const char *name, const char *indent)
 void Config::showAliases()
 {
   xbt_dict_cursor_t dict_cursor;
-  unsigned int dynar_cursor;
   xbt_dictelm_t dictel;
   char *name;
-  xbt_dynar_t names = xbt_dynar_new(sizeof(char *), nullptr);
+  std::vector<char*> names;
 
   xbt_dict_foreach(this->aliases, dict_cursor, name, dictel)
-    xbt_dynar_push(names, &name);
-  xbt_dynar_sort_strings(names);
+    names.push_back(name);
+  std::sort(begin(names), end(names), [](char* a, char* b) { return strcmp(a, b) < 0; });
 
-  xbt_dynar_foreach(names, dynar_cursor, name)
+  for (auto name : names)
     printf("   %s: %s\n", name, (*this)[name].getDescription().c_str());
 }
 
@@ -404,22 +402,20 @@ void Config::showAliases()
 void Config::help()
 {
   xbt_dict_cursor_t dict_cursor;
-  unsigned int dynar_cursor;
   simgrid::config::ConfigurationElement* variable;
   char *name;
-  xbt_dynar_t names = xbt_dynar_new(sizeof(char *), nullptr);
+  std::vector<char*> names;
 
   xbt_dict_foreach(this->options, dict_cursor, name, variable)
-    xbt_dynar_push(names, &name);
-  xbt_dynar_sort_strings(names);
+    names.push_back(name);
+  std::sort(begin(names), end(names), [](char* a, char* b) { return strcmp(a, b) < 0; });
 
-  xbt_dynar_foreach(names, dynar_cursor, name) {
+  for (auto name : names) {
     variable = (simgrid::config::ConfigurationElement*) xbt_dict_get(this->options, name);
     printf("   %s: %s\n", name, variable->getDescription().c_str());
     printf("       Type: %s; ", variable->getTypeName());
     printf("Current value: %s\n", variable->getStringValue().c_str());
   }
-  xbt_dynar_free(&names);
 }
 
 // ***** getConfig *****
@@ -448,8 +444,10 @@ template<class T>
 XBT_PUBLIC(void) declareFlag(const char* name, const char* description,
   T value, std::function<void(const T&)> callback)
 {
-  if (simgrid_config == nullptr)
+  if (simgrid_config == nullptr) {
     simgrid_config = xbt_cfg_new();
+    atexit(sg_config_finalize);
+  }
   simgrid_config->registerOption<T>(
     name, description, std::move(value), std::move(callback));
 }
@@ -488,30 +486,38 @@ void xbt_cfg_register_double(const char *name, double default_value,
 
 void xbt_cfg_register_int(const char *name, int default_value,xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr)
+  if (simgrid_config == nullptr) {
     simgrid_config = xbt_cfg_new();
+    atexit(&sg_config_finalize);
+  }
   simgrid_config->registerOption<int>(name, desc, default_value, cb_set);
 }
 
 void xbt_cfg_register_string(const char *name, const char *default_value, xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr)
+  if (simgrid_config == nullptr) {
     simgrid_config = xbt_cfg_new();
+    atexit(sg_config_finalize);
+  }
   simgrid_config->registerOption<std::string>(name, desc,
     default_value ? default_value : "", cb_set);
 }
 
 void xbt_cfg_register_boolean(const char *name, const char*default_value,xbt_cfg_cb_t cb_set, const char *desc)
 {
-  if (simgrid_config == nullptr)
+  if (simgrid_config == nullptr) {
     simgrid_config = xbt_cfg_new();
+    atexit(sg_config_finalize);
+  }
   simgrid_config->registerOption<bool>(name, desc, simgrid::config::parseBool(default_value), cb_set);
 }
 
 void xbt_cfg_register_alias(const char *realname, const char *aliasname)
 {
-  if (simgrid_config == nullptr)
+  if (simgrid_config == nullptr) {
     simgrid_config = xbt_cfg_new();
+    atexit(sg_config_finalize);
+  }
   simgrid_config->alias(realname, aliasname);
 }
 
@@ -530,7 +536,7 @@ void xbt_cfg_help()    { simgrid_config->help(); }
  */
 void xbt_cfg_set_parse(const char *options)
 {
-  if (!options || !strlen(options)) {   /* nothing to do */
+  if (not options || not strlen(options)) { /* nothing to do */
     return;
   }
   char *optionlist_cpy = xbt_strdup(options);
@@ -538,7 +544,7 @@ void xbt_cfg_set_parse(const char *options)
   XBT_DEBUG("List to parse and set:'%s'", options);
   char *option = optionlist_cpy;
   while (1) {                   /* breaks in the code */
-    if (!option)
+    if (not option)
       break;
     char *name = option;
     int len = strlen(name);
@@ -567,7 +573,7 @@ void xbt_cfg_set_parse(const char *options)
 
     if (name[0] == ' ' || name[0] == '\n' || name[0] == '\t')
       continue;
-    if (!strlen(name))
+    if (not strlen(name))
       break;
 
     char *val = strchr(name, ':');
@@ -575,7 +581,7 @@ void xbt_cfg_set_parse(const char *options)
     /* don't free(optionlist_cpy) if the assert fails, 'name' points inside it */
     *(val++) = '\0';
 
-    if (strncmp(name, "contexts/", strlen("contexts/")) && strncmp(name, "path", strlen("path")))
+    if (strncmp(name, "path", strlen("path")))
       XBT_INFO("Configuration change: Set '%s' to '%s'", name, val);
 
     try {
@@ -592,6 +598,7 @@ void xbt_cfg_set_parse(const char *options)
   free(optionlist_cpy);
   return;
 
+  /* Do not THROWF from a C++ exception catching context, or some cleanups will be missing */
 on_missing_key:
   free(optionlist_cpy);
   THROWF(not_found_error, 0, "Could not set variables %s", options);
@@ -599,7 +606,6 @@ on_missing_key:
 on_exception:
   free(optionlist_cpy);
   THROWF(unknown_error, 0, "Could not set variables %s", options);
-  return;
 }
 
 // Horrible mess to translate C++ exceptions to C exceptions:
@@ -898,7 +904,7 @@ XBT_TEST_UNIT("c++flags", test_config_cxx_flags, "C++ flags")
   xbt_test_assert(string_flag == "bar", "Check string flag");
   xbt_test_assert(double_flag == 8.0, "Check double flag");
   xbt_test_assert(bool_flag1, "Check bool1 flag");
-  xbt_test_assert(!bool_flag2, "Check bool2 flag");
+  xbt_test_assert(not bool_flag2, "Check bool2 flag");
 
   xbt_cfg_free(&simgrid_config);
   simgrid_config = temp;