1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_XBT_STRING_HPP
7 #define SIMGRID_XBT_STRING_HPP
9 #include <simgrid_config.h>
23 #include <xbt/sysdep.h>
32 /** POD structure representation of a string
39 /** A std::string-like with well-known representation
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
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
51 * * the pre-C++11 is a pointer to a ref-counted
52 * string-representation (with support for COW);
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.
57 XBT_PUBLIC_CLASS string : private string_data {
58 static const char NUL;
61 typedef std::size_t size_type;
62 typedef std::ptrdiff_t difference_type;
63 typedef char& reference;
64 typedef const char& const_reference;
65 typedef char* pointer;
66 typedef const char* const_pointer;
67 typedef char* iterator;
68 typedef const char* const_iterator;
73 if (string_data::data != &NUL)
74 delete[] string_data::data;
78 string(const char* s, size_t size)
82 string_data::data = const_cast<char*>(&NUL);
84 string_data::len = size;
85 string_data::data = new char[string_data::len + 1];
86 std::copy_n(s, string_data::len, string_data::data);
87 string_data::data[string_data::len] = '\0';
90 string() : string (const_cast<char*>(&NUL), 0) {}
91 string(const char* s) : string(s, strlen(s)) {}
92 string(string const& s) : string(s.c_str(), s.size()) {}
95 string_data::len = s.string_data::len;
96 string_data::data = s.string_data::data;
97 s.string_data::len = 0;
98 s.string_data::data = const_cast<char*>(&NUL);
100 string(std::string const& s) : string(s.c_str(), s.size()) {}
103 void assign(const char* s, size_t size)
105 if (string_data::data != &NUL) {
106 delete[] string_data::data;
107 string_data::data = nullptr;
108 string_data::len = 0;
111 string_data::len = size;
112 string_data::data = new char[string_data::len + 1];
113 std::copy_n(s, string_data::len, string_data::data);
114 string_data::data[string_data::len] = '\0';
119 string& operator=(const char* s)
121 assign(s, std::strlen(s));
124 string& operator=(string const& s)
126 assign(s.c_str(), s.size());
129 string& operator=(std::string const& s)
131 assign(s.c_str(), s.size());
136 size_t size() const { return len; }
137 size_t length() const { return len; }
138 bool empty() const { return len != 0; }
139 void shrink_to_fit() { /* Being there, but doing nothing */}
142 char* data() { return string_data::data; }
143 const char* data() const { return string_data::data; }
144 char* c_str() { return string_data::data; }
145 const char* c_str() const { return string_data::data; };
146 reference at(size_type i)
149 throw std::out_of_range("Out of range");
152 const_reference at(size_type i) const
155 throw std::out_of_range("Out of range");
158 reference operator[](size_type i)
162 const_reference operator[](size_type i) const
167 static string_data& to_string_data(string& s) { return s; }
168 operator std::string() const { return std::string(this->c_str(), this->size()); }
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)
182 string_data::len = 0;
183 string_data::data = const_cast<char*>(&NUL);
186 bool equals(const char* data, std::size_t len) const
188 return this->size() == len
189 && std::memcmp(this->c_str(), data, len) == 0;
192 bool operator==(string const& that) const
194 return this->equals(that.c_str(), that.size());
196 bool operator==(std::string const& that) const
198 return this->equals(that.c_str(), that.size());
200 bool operator==(const char* that) const
202 return this->equals(that, std::strlen(that));
206 bool operator!=(X const& that) const
208 return not (*this == that);
212 int compare(const char* data, std::size_t len) const
214 size_t n = std::min(this->size(), len);
215 int res = memcmp(this->c_str(), data, n);
218 else if (this->size() == len)
220 else if (this->size() < len)
225 int compare(string const& that) const
227 return this->compare(that.c_str(), that.size());
229 int compare(std::string const& that) const
231 return this->compare(that.c_str(), that.size());
233 int compare(const char* that) const
235 return this->compare(that, std::strlen(that));
238 // Define < <= >= > in term of compare():
240 bool operator<(X const& that) const
242 return this->compare(that) < 0;
245 bool operator<=(X const& that) const
247 return this->compare(that) <= 0;
250 bool operator>(X const& that) const
252 return this->compare(that) > 0;
255 bool operator>=(X const& that) const
257 return this->compare(that) >= 0;
262 bool operator==(std::string const& a, string const& b)
267 bool operator!=(std::string const& a, string const& b)
272 bool operator<(std::string const& a, string const& b)
277 bool operator<=(std::string const& a, string const& b)
282 bool operator>(std::string const& a, string const& b)
287 bool operator>=(std::string const& a, string const& b)
294 typedef std::string string;
298 /** Create a C++ string from a C-style format
302 std::string string_printf(const char *fmt, ...);
304 /** Create a C++ string from a C-style format
308 std::string string_vprintf(const char *fmt, va_list ap);