Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Declare as XBT_PUBLIC.
[simgrid.git] / include / xbt / string.hpp
index 86a0c98..1916178 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2015-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. */
@@ -7,21 +6,29 @@
 #ifndef SIMGRID_XBT_STRING_HPP
 #define SIMGRID_XBT_STRING_HPP
 
-#include "src/internal_config.h"
-#if HAVE_MC
+#include <simgrid_config.h>
 
-#include <stdexcept>
-#include <cstddef>
+#include <cstdarg>
 #include <cstdlib>
-#include <cstring>
 #include <string>
+
+#if SIMGRID_HAVE_MC
+
+#include <algorithm>
+#include <cstddef>
+#include <cstring>
 #include <iterator>
+#include <stdexcept>
 
 #include <xbt/sysdep.h>
 
+#endif
+
 namespace simgrid {
 namespace xbt {
 
+#if SIMGRID_HAVE_MC
+
 /** POD structure representation of a string
  */
 struct string_data {
@@ -29,9 +36,9 @@ struct string_data {
   std::size_t len;
 };
 
-/** A std::string with well-known representation
+/** A std::string-like with well-known representation
  *
- *  This is a (incomplete) drop-in replacement for `std::string`.
+ *  HACK, this is a (incomplete) replacement for `std::string`.
  *  It has a fixed POD representation (`simgrid::xbt::string_data`)
  *  which can be used to easily read the string content from another
  *  process.
@@ -48,9 +55,9 @@ struct string_data {
  *    does not use refcouting/COW but has a small string optimization.
  */
 XBT_PUBLIC_CLASS string : private string_data {
-  static const char NUL;
-public:
+  static char NUL;
 
+public:
   // Types
   typedef std::size_t size_type;
   typedef std::ptrdiff_t difference_type;
@@ -65,7 +72,7 @@ public:
   ~string()
   {
     if (string_data::data != &NUL)
-      std::free(string_data::data);
+      delete[] string_data::data;
   }
 
   // Ctors
@@ -73,40 +80,38 @@ public:
   {
     if (size == 0) {
       string_data::len = 0;
-      string_data::data = const_cast<char*>(&NUL);
+      string_data::data = &NUL;
     } else {
       string_data::len = size;
-      string_data::data = static_cast<char*>(std::malloc(string_data::len + 1));
-      memcpy(string_data::data, s, string_data::len);
+      string_data::data = new char[string_data::len + 1];
+      std::copy_n(s, string_data::len, string_data::data);
       string_data::data[string_data::len] = '\0';
     }
   }
-  string() : string (nullptr, 0) {}
-  string(const char* s)
-    : string(s, s == nullptr ? 0 : strlen(s))
-  {}
+  string() : string(&NUL, 0) {}
+  string(const char* s) : string(s, strlen(s)) {}
   string(string const& s) : string(s.c_str(), s.size()) {}
   string(string&& s)
   {
     string_data::len = s.string_data::len;
     string_data::data = s.string_data::data;
     s.string_data::len = 0;
-    s.string_data::data = const_cast<char*>(&NUL);
+    s.string_data::data = &NUL;
   }
-  string(std::string const& s) : string(s.c_str(), s.size()) {}
+  explicit string(std::string const& s) : string(s.c_str(), s.size()) {}
 
   // Assign
   void assign(const char* s, size_t size)
   {
-    if (string_data::data != &NUL)
-      std::free(string_data::data);
-    if (size == 0) {
-      string_data::len = 0;
+    if (string_data::data != &NUL) {
+      delete[] string_data::data;
       string_data::data = nullptr;
-    } else {
+      string_data::len = 0;
+    }
+    if (size != 0) {
       string_data::len = size;
-      string_data::data = (char*) std::malloc(string_data::len + 1);
-      memcpy(string_data::data, s, string_data::len);
+      string_data::data = new char[string_data::len + 1];
+      std::copy_n(s, string_data::len, string_data::data);
       string_data::data[string_data::len] = '\0';
     }
   }
@@ -114,15 +119,15 @@ public:
   // Copy
   string& operator=(const char* s)
   {
-    assign(s, s == nullptr ? 0 : std::strlen(s));
+    assign(s, std::strlen(s));
     return *this;
   }
-  string& operator=(string& s)
+  string& operator=(string const& s)
   {
     assign(s.c_str(), s.size());
     return *this;
   }
-  string& operator=(std::string& s)
+  string& operator=(std::string const& s)
   {
     assign(s.c_str(), s.size());
     return *this;
@@ -132,7 +137,7 @@ public:
   size_t size() const   { return len; }
   size_t length() const { return len; }
   bool empty() const    { return len != 0; }
-  void shrink_to_fit() {}
+  void shrink_to_fit() { /* Being there, but doing nothing */}
 
   // Alement access
   char* data()              { return string_data::data; }
@@ -160,10 +165,8 @@ public:
     return data()[i];
   }
   // Conversion
-  operator std::string() const
-  {
-    return std::string(this->c_str(), this->size());
-  }
+  static string_data& to_string_data(string& s) { return s; }
+  operator std::string() const { return std::string(this->c_str(), this->size()); }
 
   // Iterators
   iterator begin()               { return data(); }
@@ -178,74 +181,81 @@ public:
   void clear()
   {
     string_data::len = 0;
-    string_data::data = (char*) &NUL;
+    string_data::data = &NUL;
   }
 
-  // Compare
-  int compare(string const& that) const
+  bool equals(const char* data, std::size_t len) const
   {
-    size_t n = std::min(this->size(), that.size());
-    int res = memcmp(this->c_str(), that.c_str(), n);
-    if (res != 0)
-      return res;
-    else if (this->size() == that.size())
-      return 0;
-    else if (this->size() < that.size())
-      return -1;
-    else
-      return 1;
+    return this->size() == len
+      && std::memcmp(this->c_str(), data, len) == 0;
   }
+
   bool operator==(string const& that) const
   {
-    return this->size() == that.size()
-      && std::memcmp(this->c_str(), that.c_str(), this->size()) == 0;
+    return this->equals(that.c_str(), that.size());
   }
-  bool operator!=(string const& that) const
+  bool operator==(std::string const& that) const
   {
-    return !(*this == that);
+    return this->equals(that.c_str(), that.size());
   }
-  bool operator<(string const& that) const
+  bool operator==(const char* that) const
   {
-    return compare(that) < 0;
+    return this->equals(that, std::strlen(that));
   }
-  bool operator<=(string const& that) const
+
+  template<class X>
+  bool operator!=(X const& that) const
   {
-    return compare(that) <= 0;
+    return not (*this == that);
   }
-  bool operator>(string const& that) const
+
+  // Compare:
+  int compare(const char* data, std::size_t len) const
   {
-    return compare(that) > 0;
+    size_t n = std::min(this->size(), len);
+    int res = memcmp(this->c_str(), data, n);
+    if (res != 0)
+      return res;
+    else if (this->size() == len)
+      return 0;
+    else if (this->size() < len)
+      return -1;
+    else
+      return 1;
   }
-  bool operator>=(string const& that) const
+  int compare(string const& that) const
   {
-    return compare(that) >= 0;
+    return this->compare(that.c_str(), that.size());
   }
-
-  // Compare with std::string
-  bool operator==(std::string const& that) const
+  int compare(std::string const& that) const
   {
-    return this->size() == that.size()
-      && std::memcmp(this->c_str(), that.c_str(), this->size()) == 0;
+    return this->compare(that.c_str(), that.size());
   }
-  bool operator!=(std::string const& that) const
+  int compare(const char* that) const
   {
-    return !(*this == that);
+    return this->compare(that, std::strlen(that));
   }
-  bool operator<(std::string const& that) const
+
+  // Define < <= >= > in term of compare():
+  template<class X>
+  bool operator<(X const& that) const
   {
-    return compare(that) < 0;
+    return this->compare(that) < 0;
   }
-  bool operator<=(std::string const& that) const
+  template<class X>
+  bool operator<=(X const& that) const
   {
-    return compare(that) <= 0;
+    return this->compare(that) <= 0;
   }
-  bool operator>(std::string const& that) const
+  template<class X>
+  bool operator>(X const& that) const
   {
-    return compare(that) > 0;
+    return this->compare(that) > 0;
   }
-  bool operator>=(std::string const& that) const
+  template<class X>
+  bool operator>=(X const& that) const
   {
-    return compare(that) >= 0;
+    return this->compare(that) >= 0;
   }
 };
 
@@ -280,21 +290,24 @@ bool operator>=(std::string const& a, string const& b)
   return b <= a;
 }
 
-}
-}
-
 #else
 
-#include <string>
+typedef std::string string;
 
-namespace simgrid {
-namespace xbt {
+#endif
 
-typedef std::string string;
+/** Create a C++ string from a C-style format
+ *
+ * @ingroup XBT_str
+*/
+XBT_PUBLIC(std::string) string_printf(const char* fmt, ...);
 
+/** Create a C++ string from a C-style format
+ *
+ * @ingroup XBT_str
+*/
+XBT_PUBLIC(std::string) string_vprintf(const char* fmt, va_list ap);
 }
 }
 
 #endif
-
-#endif