nx_metadata_sdk  1.0
Metadata SDK
utils.h
Go to the documentation of this file.
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #pragma once
4 
12 #include <cstddef>
13 #include <cstring>
14 #include <cstdio>
15 #include <cstdlib>
16 #include <string>
17 #include <sstream>
18 #include <vector>
19 
20 #if defined(QT_CORE_LIB)
21  // To be supported in toString().
22  #include <QtCore/QByteArray>
23  #include <QtCore/QString>
24  #include <QtCore/QUrl>
25 #endif
26 
27 #if !defined(NX_KIT_API)
28  #define NX_KIT_API /*empty*/
29 #endif
30 
31 namespace nx {
32 namespace kit {
33 namespace utils {
34 
35 //-------------------------------------------------------------------------------------------------
36 // Strings.
37 
38 inline bool isAsciiPrintable(int c)
39 {
40  return c >= 32 && c <= 126;
41 }
42 
47 NX_KIT_API std::string baseName(std::string path);
48 
52 NX_KIT_API std::string getProcessName();
53 
59 template<typename T>
60 std::string toString(T value);
61 
65 template<typename... Args>
66 std::string format(const std::string& formatStr, Args... args)
67 {
68  const int size = snprintf(nullptr, 0, formatStr.c_str(), args...) + /*space for \0*/ 1;
69  if (size <= 0)
70  return formatStr; //< No better way to handle out-of-memory-like errors.
71  std::string result(size, '\0');
72  snprintf(&result[0], size, formatStr.c_str(), args...);
73  result.resize(size - /*terminating \0*/ 1);
74  return result;
75 }
76 
77 NX_KIT_API bool fromString(const std::string& s, int* value);
78 NX_KIT_API bool fromString(const std::string& s, double* value);
79 NX_KIT_API bool fromString(const std::string& s, float* value);
80 
81 void NX_KIT_API stringReplaceAllChars(std::string* s, char sample, char replacement);
82 void NX_KIT_API stringInsertAfterEach(std::string* s, char sample, const char* insertion);
83 
84 //-------------------------------------------------------------------------------------------------
85 // OS support.
86 
91 NX_KIT_API const std::vector<std::string>& getProcessCmdLineArgs();
92 
93 //-------------------------------------------------------------------------------------------------
94 // Aligned allocation.
95 
100 inline size_t alignUp(size_t value, size_t alignment)
101 {
102  if (alignment == 0)
103  return value;
104  const size_t remainder = value % alignment;
105  if (remainder == 0)
106  return value;
107  return value + alignment - remainder;
108 }
109 
111 inline uint8_t* misalignedPtr(void* data)
112 {
113  return (uint8_t*) (17 + alignUp((uintptr_t) data, 32));
114 }
115 
124 template<class MallocFunc>
125 void* mallocAligned(size_t size, size_t alignment, MallocFunc mallocFunc)
126 {
127  if (alignment == 0)
128  return nullptr;
129  const auto ptr = (char*) mallocFunc(size + alignment + sizeof(alignment));
130  if (!ptr) //< allocation error
131  return ptr;
132 
133  char* const alignedPtr = ptr + sizeof(alignment); //< Leaving place to save misalignment.
134  const size_t misalignment = alignment - (uintptr_t) alignedPtr % alignment;
135  memcpy(ptr + misalignment, &misalignment, sizeof(misalignment)); //< Save misalignment.
136  return alignedPtr + misalignment;
137 }
138 
140 inline void* mallocAligned(size_t size, size_t alignment)
141 {
142  // NOTE: Lambda is used to suppress a warning that some ::malloc() implementations are using
143  // deprecated exception specification.
144  return mallocAligned<>(size, alignment, [](size_t size) { return ::malloc(size); });
145 }
146 
154 template<class FreeFunc>
155 void freeAligned(void* ptr, FreeFunc freeFunc)
156 {
157  if (!ptr)
158  return freeFunc(ptr);
159 
160  ptr = (char*) ptr - sizeof(size_t);
161  size_t misalignment = 0;
162  memcpy(&misalignment, ptr, sizeof(misalignment)); //< Retrieve saved misalignment.
163  ptr = (char*) ptr - misalignment;
164 
165  freeFunc(ptr);
166 }
167 
169 inline void freeAligned(void* ptr)
170 {
171  // NOTE: Lambda is used to suppress a warning that some ::free() implementations are using
172  // deprecated exception specification.
173  return freeAligned<>(ptr, [](void* ptr) { return ::free(ptr); });
174 }
175 
176 //-------------------------------------------------------------------------------------------------
177 // Implementation.
178 
179 // The order of overloads below is important - it defines which will be chosen by inline functions.
180 NX_KIT_API std::string toString(bool b);
181 NX_KIT_API std::string toString(const void* ptr);
182 inline std::string toString(void* ptr) { return toString(const_cast<const void*>(ptr)); }
183 inline std::string toString(std::nullptr_t ptr) { return toString((const void*) ptr); }
184 inline std::string toString(uint8_t i) { return toString((int) i); } //< Avoid matching as char.
185 inline std::string toString(int8_t i) { return toString((int) i); } //< Avoid matching as char.
186 NX_KIT_API std::string toString(char c);
187 NX_KIT_API std::string toString(const char* s);
188 inline std::string toString(char* s) { return toString(const_cast<const char*>(s)); }
189 inline std::string toString(const std::string& s) { return toString(s.c_str()); }
190 NX_KIT_API std::string toString(wchar_t c);
191 NX_KIT_API std::string toString(const wchar_t* w);
192 inline std::string toString(wchar_t* w) { return toString(const_cast<const wchar_t*>(w)); }
193 inline std::string toString(const std::wstring& w) { return toString(w.c_str()); }
194 
195 // For unknown types, use their operator<<().
196 template<typename T>
197 std::string toString(T value)
198 {
199  std::ostringstream outputString;
200  outputString << value;
201  return outputString.str();
202 }
203 
204 #if defined(QT_CORE_LIB)
205 
206 static inline std::string toString(QByteArray b) //< By value to avoid calling the template impl.
207 {
208  return toString(b.toStdString());
209 }
210 
211 static inline std::string toString(QString s) //< By value to avoid calling the template impl.
212 {
213  return toString(s.toUtf8().constData());
214 }
215 
216 static inline std::string toString(QUrl u) //< By value to avoid calling the template impl.
217 {
218  return toString(u.toEncoded().toStdString());
219 }
220 
221 #endif // defined(QT_CORE_LIB)
222 
223 template<typename P>
224 std::string toString(P* ptr)
225 {
226  return toString((const void*) ptr);
227 }
228 
229 } // namespace utils
230 } // namespace kit
231 } // namespace nx
std::string format(const std::string &formatStr, Args... args)
Definition: utils.h:66
size_t alignUp(size_t value, size_t alignment)
Definition: utils.h:100
void * mallocAligned(size_t size, size_t alignment, MallocFunc mallocFunc)
Definition: utils.h:125
Definition: apple_utils.h:6
void freeAligned(void *ptr, FreeFunc freeFunc)
Definition: utils.h:155
uint8_t * misalignedPtr(void *data)
Definition: utils.h:111