libpqxx  7.0.6
strconv.hxx
1 /* String conversion definitions.
2  *
3  * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/stringconv instead.
4  *
5  * Copyright (c) 2000-2020, Jeroen T. Vermeulen.
6  *
7  * See COPYING for copyright license. If you did not receive a file called
8  * COPYING with this source code, please notify the distributor of this
9  * mistake, or contact the author.
10  */
11 #ifndef PQXX_H_STRINGCONV
12 #define PQXX_H_STRINGCONV
13 
14 #include "pqxx/compiler-public.hxx"
15 
16 #include <algorithm>
17 #include <cstring>
18 #include <limits>
19 #include <sstream>
20 #include <stdexcept>
21 #include <typeinfo>
22 
23 #if __has_include(<charconv>)
24 # include <charconv>
25 #endif
26 
27 #include "pqxx/except.hxx"
28 #include "pqxx/util.hxx"
29 #include "pqxx/zview.hxx"
30 
31 
32 namespace pqxx::internal
33 {
35 PQXX_LIBEXPORT std::string demangle_type_name(char const[]);
36 } // namespace pqxx::internal
37 
38 
39 namespace pqxx
40 {
65 
67 
75 template<typename TYPE>
76 std::string const type_name{internal::demangle_type_name(typeid(TYPE).name())};
77 
78 
80 
86 template<typename TYPE, typename ENABLE = void> struct nullness
87 {
89  static bool has_null;
90 
92  static bool is_null(TYPE const &value);
93 
95 
100  [[nodiscard]] static TYPE null();
101 };
102 
103 
105 template<typename TYPE> struct no_null
106 {
107  static constexpr bool has_null = false;
108  [[nodiscard]] static constexpr bool is_null(TYPE const &) noexcept
109  {
110  return false;
111  }
112 };
113 
114 
116 
119 template<typename TYPE> struct string_traits
120 {
122 
139  [[nodiscard]] static inline zview
140  to_buf(char *begin, char *end, TYPE const &value);
141 
143 
150  static inline char *into_buf(char *begin, char *end, TYPE const &value);
151 
153 
156  [[nodiscard]] static inline TYPE from_string(std::string_view text);
157 
159 
163  [[nodiscard]] static inline size_t size_buffer(TYPE const &value);
164 };
165 
166 
168 template<typename ENUM>
169 struct nullness<ENUM, std::enable_if_t<std::is_enum_v<ENUM>>> : no_null<ENUM>
170 {};
171 } // namespace pqxx
172 
173 
174 namespace pqxx::internal
175 {
177 
186 template<typename ENUM> struct enum_traits
187 {
188  using impl_type = std::underlying_type_t<ENUM>;
190 
191  [[nodiscard]] static constexpr zview
192  to_buf(char *begin, char *end, ENUM const &value)
193  {
194  return impl_traits::to_buf(begin, end, static_cast<impl_type>(value));
195  }
196 
197  static constexpr char *into_buf(char *begin, char *end, ENUM const &value)
198  {
199  return impl_traits::into_buf(begin, end, static_cast<impl_type>(value));
200  }
201 
202  [[nodiscard]] static ENUM from_string(std::string_view text)
203  {
204  return static_cast<ENUM>(impl_traits::from_string(text));
205  }
206 
207  [[nodiscard]] static size_t size_buffer(ENUM const &value)
208  {
209  return impl_traits::size_buffer(static_cast<impl_type>(value));
210  }
211 };
212 } // namespace pqxx::internal
213 
214 
216 
227 #define PQXX_DECLARE_ENUM_CONVERSION(ENUM) \
228  template<> struct string_traits<ENUM> : pqxx::internal::enum_traits<ENUM> \
229  {}; \
230  template<> std::string const type_name<ENUM> { #ENUM }
231 
232 
233 namespace pqxx
234 {
236 
248 template<typename T>[[nodiscard]] inline T from_string(std::string_view text)
249 {
250  return string_traits<T>::from_string(text);
251 }
252 
253 
255 
262 template<typename T> inline void from_string(std::string_view text, T &value)
263 {
264  value = from_string<T>(text);
265 }
266 
267 
269 
274 template<typename TYPE> inline std::string to_string(TYPE const &value);
275 
276 
278 
281 template<typename TYPE>
282 inline void into_string(TYPE const &value, std::string &out);
283 
284 
286 template<typename TYPE>[[nodiscard]] inline bool is_null(TYPE const &value)
287 {
288  if constexpr (nullness<TYPE>::has_null)
289  {
290  return nullness<TYPE>::is_null(value);
291  }
292  else
293  {
294  ignore_unused(value);
295  return false;
296  }
297 }
298 
299 
301 
307 template<typename T> inline constexpr bool is_sql_array{false};
308 
309 
311 template<typename T> inline constexpr char array_separator{','};
313 } // namespace pqxx
314 
315 
316 #include "pqxx/internal/conversions.hxx"
317 #endif
pqxx::ignore_unused
void ignore_unused(T &&)
Suppress compiler warning about an unused item.
Definition: util.hxx:44
pqxx::is_null
bool is_null(TYPE const &value)
Is value null?
Definition: strconv.hxx:286
pqxx::internal::demangle_type_name
std::string demangle_type_name(char const[])
Attempt to demangle std::type_info::name() to something human-readable.
Definition: strconv.cxx:223
pqxx::no_null
Nullness traits describing a type which does not have a null value.
Definition: strconv.hxx:105
pqxx::conversion_error
Value conversion failed, e.g. when converting "Hello" to int.
Definition: except.hxx:178
pqxx::internal::to_string_float
std::string to_string_float(T value)
Floating-point implementations for pqxx::to_string().
Definition: strconv.cxx:604
pqxx::nullness::is_null
static bool is_null(TYPE const &value)
Is value a null?
pqxx::internal::enum_traits::size_buffer
static size_t size_buffer(ENUM const &value)
Definition: strconv.hxx:207
pqxx
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:25
pqxx::to_string
std::string to_string(field const &value)
Convert a field to a string.
Definition: result.cxx:478
pqxx::internal::enc_group
encoding_group enc_group(int libpq_enc_id)
Definition: encodings.cxx:585
pqxx::internal::state_buffer_overrun
std::string state_buffer_overrun(int have_bytes, int need_bytes)
Definition: strconv.cxx:247
pqxx::internal::throw_null_conversion
void throw_null_conversion(std::string const &type)
Definition: strconv.cxx:241
pqxx::internal::enum_traits::to_buf
static constexpr zview to_buf(char *begin, char *end, ENUM const &value)
Definition: strconv.hxx:192
pqxx::internal
Private namespace for libpqxx's internal use; do not access.
Definition: connection.hxx:59
pqxx::cursor_base::difference_type
result_difference_type difference_type
Definition: cursor.hxx:44
pqxx::result
Result set containing data returned by a query or command.
Definition: result.hxx:70
pqxx::string_traits::to_buf
static zview to_buf(char *begin, char *end, TYPE const &value)
Return a string_view representing value, plus terminating zero.
pqxx::into_string
void into_string(TYPE const &value, std::string &out)
Convert a value to a readable string that PostgreSQL will understand.
pqxx::no_null::is_null
static constexpr bool is_null(TYPE const &) noexcept
Definition: strconv.hxx:108
pqxx::zview
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:32
pqxx::array_separator
constexpr char array_separator
Element separator between SQL array elements of this type.
Definition: strconv.hxx:311
pqxx::internal::to_dumb_stringstream
std::string to_dumb_stringstream(dumb_stringstream< F > &s, F value)
Definition: strconv.cxx:595
pqxx::from_string
T from_string(field const &value)
Convert a field's string contents to another type.
Definition: field.hxx:357
pqxx::type_name
const std::string type_name
A human-readable name for a type, used in error messages and such.
Definition: strconv.hxx:76
pqxx::internal::enum_traits::into_buf
static constexpr char * into_buf(char *begin, char *end, ENUM const &value)
Definition: strconv.hxx:197
pqxx::is_sql_array
constexpr bool is_sql_array
Does this type translate to an SQL array?
Definition: strconv.hxx:307
pqxx::nullness
Traits describing a type's "null value," if any.
Definition: strconv.hxx:86
pqxx::internal::enum_traits::from_string
static ENUM from_string(std::string_view text)
Definition: strconv.hxx:202
pqxx::no_null::has_null
static constexpr bool has_null
Definition: strconv.hxx:107
pqxx::internal::enum_traits
Helper class for defining enum conversions.
Definition: strconv.hxx:186
pqxx::internal::enum_traits::impl_type
std::underlying_type_t< ENUM > impl_type
Definition: strconv.hxx:188
pqxx::string_traits
Traits class for use in string conversions.
Definition: strconv.hxx:119
pqxx::conversion_overrun
Could not convert value to string: not enough buffer space.
Definition: except.hxx:185
pqxx::string_traits::size_buffer
static size_t size_buffer(TYPE const &value)
Estimate how much buffer space is needed to represent value.
pqxx::string_traits::from_string
static TYPE from_string(std::string_view text)
Parse a string representation of a TYPE value.
Definition: strconv.cxx:682
pqxx::string_traits::into_buf
static char * into_buf(char *begin, char *end, TYPE const &value)
Write value's string representation into buffer at begin.
pqxx::nullness::has_null
static bool has_null
Does this type have a null value?
Definition: strconv.hxx:89