tgbotxx 1.2.9.5
Telegram Bot C++ Library
Loading...
Searching...
No Matches
Macros
Object.hpp File Reference
#include <type_traits>
#include <cstdint>
#include <ctime>
#include <iostream>
#include <memory>
#include <nlohmann/json.hpp>
#include <sstream>
#include <string>
#include <tgbotxx/Exception.hpp>
#include <tgbotxx/utils/Ptr.hpp>
#include <vector>

Go to the source code of this file.

Macros

#define TGBOTXX_CAT_IMPL(a, b)   a##b
 Available objects: https://core.telegram.org/bots/api#available-types.
 
#define TGBOTXX_CAT(a, b)   TGBOTXX_CAT_IMPL(a, b)
 
#define VAR(x)   TGBOTXX_CAT(x, __LINE__)
 Avoid expanded variable names collisions.
 
#define OBJECT_SERIALIZE_FIELD(json, json_field, field)
 Serialize.
 
#define OBJECT_SERIALIZE_FIELD_PTR(json, json_field, field)
 
#define OBJECT_SERIALIZE_FIELD_PTR_ARRAY(json, json_field, array_field)
 
#define OBJECT_SERIALIZE_FIELD_PTR_ARRAY_ARRAY(json, json_field, array_array_field)
 
#define OBJECT_SERIALIZE_FIELD_ENUM(json, enum_name, json_field, field)
 
#define OBJECT_DESERIALIZE_FIELD(json, json_field, field, default_value, optional)
 Deserialize.
 
#define OBJECT_DESERIALIZE_FIELD_PTR(json, json_field, field, optional)
 
#define OBJECT_DESERIALIZE_FIELD_PTR_ARRAY(json, json_field, array_field, optional)
 
#define OBJECT_DESERIALIZE_FIELD_PTR_ARRAY_ARRAY(json, json_field, array_array_field, optional)
 
#define OBJECT_DESERIALIZE_FIELD_ENUM(json, enum_name, json_field, field, default_value, optional)
 

Macro Definition Documentation

◆ OBJECT_DESERIALIZE_FIELD

#define OBJECT_DESERIALIZE_FIELD (   json,
  json_field,
  field,
  default_value,
  optional 
)
Value:
do { \
if (json.contains(json_field)) { \
try { \
using T = std::remove_reference_t<std::remove_const_t<decltype(field)>>; \
field = json[json_field].get<T>(); \
} catch (const std::exception& e) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Failed to deserialize \"" \
<< json_field << "\" from json object: " << json.dump(2) << "\nReason: " << e.what(); \
throw Exception(err.str()); \
} catch (...) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Failed to deserialize \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
} else { \
if (not(optional)) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Missing required field \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
field = default_value; \
} \
} while (false)

Deserialize.

Definition at line 64 of file Object.hpp.

◆ OBJECT_DESERIALIZE_FIELD_ENUM

#define OBJECT_DESERIALIZE_FIELD_ENUM (   json,
  enum_name,
  json_field,
  field,
  default_value,
  optional 
)
Value:
do { \
static_assert(std::is_enum_v<decltype(field)>, "OBJECT_DESERIALIZE_FIELD_ENUM: 'field' must be an enum"); \
static_assert(!std::is_const_v<decltype(field)>, "OBJECT_DESERIALIZE_FIELD_ENUM: 'field' must not be const"); \
if (json.contains(json_field)) { \
try { \
if (auto opt = TGBOTXX_CAT(StringTo, enum_name)(json[json_field])) \
field = *opt; \
else \
throw Exception("Could not convert string \"" + json[json_field].get<std::string>() + "\" to enum"); \
} catch (const std::exception& e) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Failed to deserialize \"" \
<< json_field << "\" from json object: " << json.dump(2) << "\nReason: " << e.what(); \
throw Exception(err.str()); \
} catch (...) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Failed to deserialize \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
} else { \
if (not(optional)) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Missing required field \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
field = static_cast<enum_name>(default_value); \
} \
} while (false)
TGBOTXX_CAT
#define TGBOTXX_CAT(a, b)
Definition Object.hpp:21

Definition at line 165 of file Object.hpp.

◆ OBJECT_DESERIALIZE_FIELD_PTR

#define OBJECT_DESERIALIZE_FIELD_PTR (   json,
  json_field,
  field,
  optional 
)
Value:
do { \
static_assert(!std::is_const_v<decltype(field)>, "OBJECT_DESERIALIZE_FIELD_PTR: 'field' must not be const"); \
static_assert(std::is_same_v<decltype(optional), bool>, "OBJECT_DESERIALIZE_FIELD_PTR: 'optional' must be boolean"); \
if (json.contains(json_field) and json[json_field].is_object() and not json[json_field].empty()) { \
using T = std::remove_reference_t<decltype(field)>; \
using E = T::element_type; \
field = makePtr<E>(json[json_field]); \
} else { \
if (not(optional)) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Missing required field \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
field = nullptr; \
} \
} while (false)

Definition at line 92 of file Object.hpp.

◆ OBJECT_DESERIALIZE_FIELD_PTR_ARRAY

#define OBJECT_DESERIALIZE_FIELD_PTR_ARRAY (   json,
  json_field,
  array_field,
  optional 
)
Value:
do { \
static_assert(!std::is_const_v<decltype(array_field)>, "OBJECT_DESERIALIZE_FIELD_PTR_ARRAY: 'field' must not be const"); \
static_assert(std::is_same_v<decltype(optional), bool>, "OBJECT_DESERIALIZE_FIELD_PTR_ARRAY: 'optional' must be boolean"); \
if ((json.contains(json_field)) and (json[json_field].is_array())) { \
using T = std::remove_reference_t<std::remove_const_t<decltype(array_field)::value_type>>; \
using E = T::element_type; \
array_field.clear(); \
array_field.reserve(json[json_field].size()); \
for (const nl::json& obj: json[json_field]) { \
array_field.emplace_back(new E(obj)); \
} \
} else { \
if (not(optional)) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Missing required field \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
array_field.clear(); \
} \
} while (false)

Definition at line 111 of file Object.hpp.

◆ OBJECT_DESERIALIZE_FIELD_PTR_ARRAY_ARRAY

#define OBJECT_DESERIALIZE_FIELD_PTR_ARRAY_ARRAY (   json,
  json_field,
  array_array_field,
  optional 
)
Value:
do { \
static_assert(!std::is_const_v<decltype(array_array_field)>, "OBJECT_DESERIALIZE_FIELD_PTR_ARRAY_ARRAY: 'field' must not be const"); \
static_assert(std::is_same_v<decltype(optional), bool>, "OBJECT_DESERIALIZE_FIELD_PTR_ARRAY_ARRAY: 'optional' must be boolean"); \
if ((json.contains(json_field)) and (json[json_field].is_array())) { \
using ArrayArray = decltype(array_array_field); \
using Array = ArrayArray::value_type; /* e.g vector<vector<int> <- > */ \
using T = ArrayArray::value_type::value_type; /* e.g vector<vector<int>> <- */ \
using E = T::element_type; \
array_array_field.clear(); \
array_array_field.reserve(json[json_field].size()); \
for (const nl::json& array: json[json_field]) { \
Array arr; \
arr.reserve(array.size()); \
for (const nl::json& obj: array) { \
arr.emplace_back(new E(obj)); \
} \
array_array_field.emplace_back(std::move(arr)); \
} \
} else { \
if (not(optional)) { \
std::ostringstream err{}; \
err << __FILE__ << ':' << __LINE__ << ": " << __FUNCTION__ << ": Missing required field \"" \
<< json_field << "\" from json object: " << json.dump(2); \
throw Exception(err.str()); \
} \
array_array_field.clear(); \
} \
} while (false)

Definition at line 135 of file Object.hpp.

◆ OBJECT_SERIALIZE_FIELD

#define OBJECT_SERIALIZE_FIELD (   json,
  json_field,
  field 
)
Value:
do { \
json[json_field] = field; \
} while (false)

Serialize.

Definition at line 27 of file Object.hpp.

◆ OBJECT_SERIALIZE_FIELD_ENUM

#define OBJECT_SERIALIZE_FIELD_ENUM (   json,
  enum_name,
  json_field,
  field 
)
Value:
do { \
json[json_field] = TGBOTXX_CAT(enum_name, ToString)(field); \
} while (false)

Definition at line 58 of file Object.hpp.

◆ OBJECT_SERIALIZE_FIELD_PTR

#define OBJECT_SERIALIZE_FIELD_PTR (   json,
  json_field,
  field 
)
Value:
do { \
if (field) { \
json[json_field] = (field)->toJson(); \
} \
} while (false)

Definition at line 32 of file Object.hpp.

◆ OBJECT_SERIALIZE_FIELD_PTR_ARRAY

#define OBJECT_SERIALIZE_FIELD_PTR_ARRAY (   json,
  json_field,
  array_field 
)
Value:
do { \
auto arr = json[json_field] = nl::json::array(); \
for (const auto& e: array_field) \
arr.emplace_back(e->toJson()); \
} while (false)

Definition at line 39 of file Object.hpp.

◆ OBJECT_SERIALIZE_FIELD_PTR_ARRAY_ARRAY

#define OBJECT_SERIALIZE_FIELD_PTR_ARRAY_ARRAY (   json,
  json_field,
  array_array_field 
)
Value:
do { \
auto& root_arr = json[json_field] = nl::json::array(); \
for (const auto& array: array_array_field) { \
nl::json arr = nl::json::array(); \
for (const auto& e: array) { \
arr.emplace_back(e->toJson()); \
} \
root_arr.emplace_back(arr); \
} \
} while (false)

Definition at line 46 of file Object.hpp.

◆ TGBOTXX_CAT

#define TGBOTXX_CAT (   a,
  b 
)    TGBOTXX_CAT_IMPL(a, b)

Definition at line 21 of file Object.hpp.

◆ TGBOTXX_CAT_IMPL

#define TGBOTXX_CAT_IMPL (   a,
  b 
)    a##b

Available objects: https://core.telegram.org/bots/api#available-types.

Helper macros to de/serialize objects Concatenate tokens

Definition at line 20 of file Object.hpp.

◆ VAR

#define VAR (   x)    TGBOTXX_CAT(x, __LINE__)

Avoid expanded variable names collisions.

Definition at line 24 of file Object.hpp.