Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines.
[simgrid.git] / include / xbt / string.hpp
index 9840855..83e2820 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2015-2021. 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,22 +6,41 @@
 #ifndef SIMGRID_XBT_STRING_HPP
 #define SIMGRID_XBT_STRING_HPP
 
-#include <simgrid_config.h>
+#include <simgrid/config.h>
 
-#if HAVE_MC
+#include <cstdarg>
+#include <cstdlib>
+#include <string>
 
-#include <stdexcept>
+#if SIMGRID_HAVE_MC
+
+#include <algorithm>
 #include <cstddef>
-#include <cstdlib>
 #include <cstring>
-#include <string>
 #include <iterator>
+#include <stdexcept>
 
 #include <xbt/sysdep.h>
 
+#endif
+
 namespace simgrid {
 namespace xbt {
 
+/** 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);
+
+#if SIMGRID_HAVE_MC
+
 /** POD structure representation of a string
  */
 struct string_data {
@@ -30,9 +48,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,98 +66,93 @@ struct string_data {
  *  * the [C++11-conforming implementation](https://gcc.gnu.org/gcc-5/changes.html)
  *    does not use refcouting/COW but has a small string optimization.
  */
-XBT_PUBLIC_CLASS string : private string_data {
-  static const char NUL;
-public:
+class XBT_PUBLIC string {
+  static char NUL;
+  string_data str;
 
+public:
   // Types
-  typedef std::size_t size_type;
-  typedef std::ptrdiff_t difference_type;
-  typedef char& reference;
-  typedef const char& const_reference;
-  typedef char* pointer;
-  typedef const char* const_pointer;
-  typedef char* iterator;
-  typedef const char* const_iterator;
+  using size_type       = std::size_t;
+  using reference       = char&;
+  using const_reference = const char&;
+  using iterator        = char*;
+  using const_iterator  = const char*;
 
   // Dtor
   ~string()
   {
-    if (string_data::data != &NUL)
-      std::free(string_data::data);
+    if (str.data != &NUL)
+      delete[] str.data;
   }
 
   // Ctors
   string(const char* s, size_t size)
   {
     if (size == 0) {
-      string_data::len = 0;
-      string_data::data = const_cast<char*>(&NUL);
+      str.len  = 0;
+      str.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[string_data::len] = '\0';
+      str.len  = size;
+      str.data = new char[str.len + 1];
+      std::copy_n(s, str.len, str.data);
+      str.data[str.len] = '\0';
     }
   }
-  string() : string (nullptr, 0) {}
-  string(const char* s)
-    : string(s, s == nullptr ? 0 : strlen(s))
-  {}
+  string() : string(&NUL, 0) {}
+  explicit string(const char* s) : string(s, strlen(s)) {}
   string(string const& s) : string(s.c_str(), s.size()) {}
-  string(string&& s)
+  string(string&& s) noexcept : str(s.str)
   {
-    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.str.len  = 0;
+    s.str.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;
-      string_data::data = nullptr;
-    } else {
-      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[string_data::len] = '\0';
+    if (str.data != &NUL) {
+      delete[] str.data;
+      str.data = nullptr;
+      str.len  = 0;
+    }
+    if (size != 0) {
+      str.len  = size;
+      str.data = new char[str.len + 1];
+      std::copy_n(s, str.len, str.data);
+      str.data[str.len] = '\0';
     }
   }
 
   // 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());
+    if (this != &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;
   }
 
   // Capacity
-  size_t size() const   { return len; }
-  size_t length() const { return len; }
-  bool empty() const    { return len != 0; }
-  void shrink_to_fit() {}
-
-  // Alement access
-  char* data()              { return string_data::data; }
-  const char* data()  const { return string_data::data; }
-  char* c_str()             { return string_data::data; }
-  const char* c_str() const { return string_data::data; };
+  size_t size() const { return str.len; }
+  size_t length() const { return str.len; }
+  bool empty() const { return str.len != 0; }
+  void shrink_to_fit() { /* Being there, but doing nothing */}
+
+  // Element access
+  char* data() { return str.data; }
+  const char* data() const { return str.data; }
+  char* c_str() { return str.data; }
+  const char* c_str() const { return str.data; };
   reference at(size_type i)
   {
     if (i >= size())
@@ -161,10 +174,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.str; }
+  operator std::string() const { return std::string(this->c_str(), this->size()); }
 
   // Iterators
   iterator begin()               { return data(); }
@@ -178,75 +189,91 @@ public:
   // Operations
   void clear()
   {
-    string_data::len = 0;
-    string_data::data = (char*) &NUL;
+    str.len  = 0;
+    str.data = &NUL;
   }
 
-  // Compare
-  int compare(string const& that) const
+  size_t copy(char* s, size_t len, size_t pos = 0) 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;
+    if (pos > str.len)
+      throw std::out_of_range(string_printf("xbt::string::copy with pos > size() (%zu > %zu)", pos, str.len));
+    size_t count = std::min(len, str.len - pos);
+    std::copy_n(str.data + pos, count, s);
+    return count;
+  }
+
+  bool equals(const char* data, std::size_t len) const
+  {
+    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;
   }
 };
 
@@ -281,21 +308,12 @@ bool operator>=(std::string const& a, string const& b)
   return b <= a;
 }
 
-}
-}
-
 #else
 
-#include <string>
-
-namespace simgrid {
-namespace xbt {
-
 typedef std::string string;
 
+#endif
 }
 }
 
 #endif
-
-#endif