include/xbt/string.hpp

   1 /* Copyright (c) 2015-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_XBT_STRING_HPP
   7 #define SIMGRID_XBT_STRING_HPP
   8
   9 #include <simgrid/config.h>
  10
  11 #include <cstdarg>
  12 #include <cstdlib>
  13 #include <string>
  14
  15 #if SIMGRID_HAVE_MC
  16
  17 #include <algorithm>
  18 #include <cstddef>
  19 #include <cstring>
  20 #include <iterator>
  21 #include <stdexcept>
  22
  23 #include <xbt/sysdep.h>
  24
  25 #endif
  26
  27 namespace simgrid {
  28 namespace xbt {
  29
  30 #if SIMGRID_HAVE_MC
  31
  32 /** POD structure representation of a string
  33  */
  34 struct string_data {
  35   char* data;
  36   std::size_t len;
  37 };
  38
  39 /** A std::string-like with well-known representation
  40  *
  41  *  HACK, this is a (incomplete) replacement for `std::string`.
  42  *  It has a fixed POD representation (`simgrid::xbt::string_data`)
  43  *  which can be used to easily read the string content from another
  44  *  process.
  45  *
  46  *  The internal representation of a `std::string` is private.
  47  *  We could add some code to read this for a given implementation.
  48  *  However, even if we focus on GNU libstdc++ with Itanium ABI
  49  *  GNU libstdc++ currently has two different ABIs
  50  *
  51  *  * the pre-C++11 is a pointer to a ref-counted
  52  *    string-representation (with support for COW);
  53  *
  54  *  * the [C++11-conforming implementation](https://gcc.gnu.org/gcc-5/changes.html)
  55  *    does not use refcouting/COW but has a small string optimization.
  56  */
  57 class XBT_PUBLIC string {
  58   static char NUL;
  59   string_data str;
  60
  61 public:
  62   // Types
  63   typedef std::size_t size_type;
  64   typedef char& reference;
  65   typedef const char& const_reference;
  66   typedef char* iterator;
  67   typedef const char* const_iterator;
  68
  69   // Dtor
  70   ~string()
  71   {
  72     if (str.data != &NUL)
  73       delete[] str.data;
  74   }
  75
  76   // Ctors
  77   string(const char* s, size_t size)
  78   {
  79     if (size == 0) {
  80       str.len  = 0;
  81       str.data = &NUL;
  82     } else {
  83       str.len  = size;
  84       str.data = new char[str.len + 1];
  85       std::copy_n(s, str.len, str.data);
  86       str.data[str.len] = '\0';
  87     }
  88   }
  89   string() : string(&NUL, 0) {}
  90   explicit string(const char* s) : string(s, strlen(s)) {}
  91   string(string const& s) : string(s.c_str(), s.size()) {}
  92   string(string&& s)
  93   {
  94     str.len    = s.str.len;
  95     str.data   = s.str.data;
  96     s.str.len  = 0;
  97     s.str.data = &NUL;
  98   }
  99   explicit string(std::string const& s) : string(s.c_str(), s.size()) {}
 100
 101   // Assign
 102   void assign(const char* s, size_t size)
 103   {
 104     if (str.data != &NUL) {
 105       delete[] str.data;
 106       str.data = nullptr;
 107       str.len  = 0;
 108     }
 109     if (size != 0) {
 110       str.len  = size;
 111       str.data = new char[str.len + 1];
 112       std::copy_n(s, str.len, str.data);
 113       str.data[str.len] = '\0';
 114     }
 115   }
 116
 117   // Copy
 118   string& operator=(const char* s)
 119   {
 120     assign(s, std::strlen(s));
 121     return *this;
 122   }
 123   string& operator=(string const& s)
 124   {
 125     if (this != &s)
 126       assign(s.c_str(), s.size());
 127     return *this;
 128   }
 129   string& operator=(std::string const& s)
 130   {
 131     assign(s.c_str(), s.size());
 132     return *this;
 133   }
 134
 135   // Capacity
 136   size_t size() const { return str.len; }
 137   size_t length() const { return str.len; }
 138   bool empty() const { return str.len != 0; }
 139   void shrink_to_fit() { /* Being there, but doing nothing */}
 140
 141   // Element access
 142   char* data() { return str.data; }
 143   const char* data() const { return str.data; }
 144   char* c_str() { return str.data; }
 145   const char* c_str() const { return str.data; };
 146   reference at(size_type i)
 147   {
 148     if (i >= size())
 149       throw std::out_of_range("Out of range");
 150     return data()[i];
 151   }
 152   const_reference at(size_type i) const
 153   {
 154     if (i >= size())
 155       throw std::out_of_range("Out of range");
 156     return data()[i];
 157   }
 158   reference operator[](size_type i)
 159   {
 160     return data()[i];
 161   }
 162   const_reference operator[](size_type i) const
 163   {
 164     return data()[i];
 165   }
 166   // Conversion
 167   static string_data& to_string_data(string& s) { return s.str; }
 168   operator std::string() const { return std::string(this->c_str(), this->size()); }
 169
 170   // Iterators
 171   iterator begin()               { return data(); }
 172   iterator end()                 { return data() + size(); }
 173   const_iterator begin() const   { return data(); }
 174   const_iterator end() const     { return data() + size(); }
 175   const_iterator cbegin() const  { return data(); }
 176   const_iterator cend() const    { return data() + size(); }
 177   // (Missing, reverse iterators)
 178
 179   // Operations
 180   void clear()
 181   {
 182     str.len  = 0;
 183     str.data = &NUL;
 184   }
 185
 186   bool equals(const char* data, std::size_t len) const
 187   {
 188     return this->size() == len
 189       && std::memcmp(this->c_str(), data, len) == 0;
 190   }
 191
 192   bool operator==(string const& that) const
 193   {
 194     return this->equals(that.c_str(), that.size());
 195   }
 196   bool operator==(std::string const& that) const
 197   {
 198     return this->equals(that.c_str(), that.size());
 199   }
 200   bool operator==(const char* that) const
 201   {
 202     return this->equals(that, std::strlen(that));
 203   }
 204
 205   template<class X>
 206   bool operator!=(X const& that) const
 207   {
 208     return not (*this == that);
 209   }
 210
 211   // Compare:
 212   int compare(const char* data, std::size_t len) const
 213   {
 214     size_t n = std::min(this->size(), len);
 215     int res = memcmp(this->c_str(), data, n);
 216     if (res != 0)
 217       return res;
 218     else if (this->size() == len)
 219       return 0;
 220     else if (this->size() < len)
 221       return -1;
 222     else
 223       return 1;
 224   }
 225   int compare(string const& that) const
 226   {
 227     return this->compare(that.c_str(), that.size());
 228   }
 229   int compare(std::string const& that) const
 230   {
 231     return this->compare(that.c_str(), that.size());
 232   }
 233   int compare(const char* that) const
 234   {
 235     return this->compare(that, std::strlen(that));
 236   }
 237
 238   // Define < <= >= > in term of compare():
 239   template<class X>
 240   bool operator<(X const& that) const
 241   {
 242     return this->compare(that) < 0;
 243   }
 244   template<class X>
 245   bool operator<=(X const& that) const
 246   {
 247     return this->compare(that) <= 0;
 248   }
 249   template<class X>
 250   bool operator>(X const& that) const
 251   {
 252     return this->compare(that) > 0;
 253   }
 254   template<class X>
 255   bool operator>=(X const& that) const
 256   {
 257     return this->compare(that) >= 0;
 258   }
 259 };
 260
 261 inline
 262 bool operator==(std::string const& a, string const& b)
 263 {
 264   return b == a;
 265 }
 266 inline
 267 bool operator!=(std::string const& a, string const& b)
 268 {
 269   return b != a;
 270 }
 271 inline
 272 bool operator<(std::string const& a, string const& b)
 273 {
 274   return b > a;
 275 }
 276 inline
 277 bool operator<=(std::string const& a, string const& b)
 278 {
 279   return b >= a;
 280 }
 281 inline
 282 bool operator>(std::string const& a, string const& b)
 283 {
 284   return b < a;
 285 }
 286 inline
 287 bool operator>=(std::string const& a, string const& b)
 288 {
 289   return b <= a;
 290 }
 291
 292 #else
 293
 294 typedef std::string string;
 295
 296 #endif
 297
 298 /** Create a C++ string from a C-style format
 299  *
 300  * @ingroup XBT_str
 301 */
 302 XBT_PUBLIC std::string string_printf(const char* fmt, ...);
 303
 304 /** Create a C++ string from a C-style format
 305  *
 306  * @ingroup XBT_str
 307 */
 308 XBT_PUBLIC std::string string_vprintf(const char* fmt, va_list ap);
 309 }
 310 }
 311
 312 #endif