iceoryx_hoofs/cxx/helplets.hpp🔗
Namespaces🔗
| Name |
|---|
| iox building block to easily create free function for logging in a library context |
| iox::cxx |
| iox::cxx::internal |
Classes🔗
| Name | |
|---|---|
| class | iox::cxx::string string implementation with some adjustments in the API, because we are not allowed to throw exceptions or use heap. |
| struct | iox::cxx::not_null |
| struct | iox::cxx::greater_or_equal |
| struct | iox::cxx::range |
| struct | iox::cxx::BestFittingType get the best fitting unsigned integer type for a given value at compile time |
Defines🔗
| Name | |
|---|---|
| IOX_BUILDER_PARAMETER(type, name, defaultValue) Macro which generates a setter method useful for a builder pattern. |
Macro Documentation🔗
define IOX_BUILDER_PARAMETER🔗
#define IOX_BUILDER_PARAMETER(
type,
name,
defaultValue
)
public: \
decltype(auto) name(type const& value)&& \
{ \
m_##name = value; \
return std::move(*this); \
} \
\
decltype(auto) name(type&& value)&& \
{ \
m_##name = std::move(value); \
return std::move(*this); \
} \
\
private: \
type m_##name{defaultValue};
Macro which generates a setter method useful for a builder pattern.
Parameters:
- type the data type of the parameter
- name the name of the parameter
- defaultValue the default value of the parameter
class MyBuilder {
IOX_BUILDER_PARAMETER(TypeA, NameB, ValueC)
// START generates the following code
public:
decltype(auto) NameB(TypeA const& value) &&
{
m_NameB = value;
return std::move(*this);
}
decltype(auto) NameB(TypeA&& value) &&
{
m_NameB = std::move(value);
return std::move(*this);
}
private:
TypeA m_NameB = ValueC;
// END
};
Source code🔗
// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2021 - 2022 by Apex.AI Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_HOOFS_CXX_HELPLETS_HPP
#define IOX_HOOFS_CXX_HELPLETS_HPP
#include "iceoryx_hoofs/cxx/string.hpp"
#include "iceoryx_hoofs/cxx/type_traits.hpp"
#include <cassert>
#include <cstdint>
#include <cstring>
#include <iostream>
#include <limits>
#include <type_traits>
#include "iceoryx_hoofs/platform/platform_correction.hpp"
#include "iceoryx_hoofs/platform/platform_settings.hpp"
namespace iox
{
namespace cxx
{
template <uint64_t Capacity>
class string;
struct TruncateToCapacity_t;
namespace internal
{
template <bool GreaterUint8, bool GreaterUint16, bool GreaterUint32>
struct BestFittingTypeImpl
{
using Type_t = uint64_t;
};
template <>
struct BestFittingTypeImpl<false, false, false>
{
using Type_t = uint8_t;
};
template <>
struct BestFittingTypeImpl<true, false, false>
{
using Type_t = uint16_t;
};
template <>
struct BestFittingTypeImpl<true, true, false>
{
using Type_t = uint32_t;
};
constexpr char ASCII_A = 'a';
constexpr char ASCII_Z = 'z';
constexpr char ASCII_CAPITAL_A = 'A';
constexpr char ASCII_CAPITAL_Z = 'Z';
constexpr char ASCII_0 = '0';
constexpr char ASCII_9 = '9';
constexpr char ASCII_MINUS = '-';
constexpr char ASCII_DOT = '.';
constexpr char ASCII_COLON = ':';
constexpr char ASCII_UNDERSCORE = '_';
} // namespace internal
template <typename T, typename = typename std::enable_if<std::is_pointer<T>::value, void>::type>
struct not_null
{
public:
not_null(T t) noexcept
: value(t)
{
Expects(t != nullptr);
}
constexpr operator T() const noexcept
{
return value;
}
private:
T value;
};
template <typename T, T Minimum>
struct greater_or_equal
{
public:
greater_or_equal(T t) noexcept
: value(t)
{
Expects(t >= Minimum);
}
constexpr operator T() const noexcept
{
return value;
}
private:
T value;
};
template <typename T, T Minimum, T Maximum>
struct range
{
public:
range(T t) noexcept
: value(t)
{
Expects(t >= Minimum && t <= Maximum);
}
constexpr operator T() const noexcept
{
return value;
}
private:
T value;
};
template <typename T>
T align(const T value, const T alignment) noexcept
{
T remainder = value % alignment;
return value + ((remainder == 0u) ? 0u : alignment - remainder);
}
void* alignedAlloc(const uint64_t alignment, const uint64_t size) noexcept;
void alignedFree(void* const memory) noexcept;
template <size_t s = 0>
constexpr size_t maxAlignment() noexcept
{
return s;
}
template <typename T, typename... Args>
constexpr size_t maxAlignment() noexcept
{
return alignof(T) > maxAlignment<Args...>() ? alignof(T) : maxAlignment<Args...>();
}
template <size_t s = 0>
constexpr size_t maxSize() noexcept
{
return s;
}
template <typename T, typename... Args>
constexpr size_t maxSize() noexcept
{
return sizeof(T) > maxSize<Args...>() ? sizeof(T) : maxSize<Args...>();
}
template <typename T, typename Enumeration>
const char* convertEnumToString(T port, const Enumeration source) noexcept
{
return port[static_cast<size_t>(source)];
}
template <typename enum_type>
auto enumTypeAsUnderlyingType(enum_type const value) noexcept -> typename std::underlying_type<enum_type>::type
{
return static_cast<typename std::underlying_type<enum_type>::type>(value);
}
template <typename Container, typename Functor>
void forEach(Container& c, const Functor& f) noexcept
{
for (auto& element : c)
{
f(element);
}
}
template <uint64_t SizeValue>
static constexpr uint64_t strlen2(char const (&/*notInterested*/)[SizeValue]) noexcept
{
return SizeValue - 1;
}
template <uint64_t Value>
struct BestFittingType
{
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wtype-limits"
using Type_t = typename internal::BestFittingTypeImpl<(Value > std::numeric_limits<uint8_t>::max()),
(Value > std::numeric_limits<uint16_t>::max()),
(Value > std::numeric_limits<uint32_t>::max())>::Type_t;
#pragma GCC diagnostic pop
};
template <uint64_t Value>
using BestFittingType_t = typename BestFittingType<Value>::Type_t;
constexpr bool isCompiledOn32BitSystem() noexcept
{
return INTPTR_MAX == INT32_MAX;
}
template <typename T>
constexpr bool isPowerOfTwo(const T n) noexcept
{
static_assert(std::is_unsigned<T>::value && !std::is_same<T, bool>::value, "Only unsigned integer are allowed!");
return n && ((n & (n - 1U)) == 0U);
}
template <uint64_t StringCapacity>
bool isValidFileName(const string<StringCapacity>& name) noexcept;
template <uint64_t StringCapacity>
bool isValidFilePath(const string<StringCapacity>& name) noexcept;
template <typename F, typename T>
constexpr T from(const F value) noexcept;
template <typename T, typename F>
constexpr T into(const F value) noexcept;
#define IOX_BUILDER_PARAMETER(type, name, defaultValue) \
public: \
decltype(auto) name(type const& value)&& \
{ \
m_##name = value; \
return std::move(*this); \
} \
\
decltype(auto) name(type&& value)&& \
{ \
m_##name = std::move(value); \
return std::move(*this); \
} \
\
private: \
type m_##name{defaultValue};
} // namespace cxx
} // namespace iox
#include "iceoryx_hoofs/internal/cxx/helplets.inl"
#endif // IOX_HOOFS_CXX_HELPLETS_HPP
Updated on 18 December 2023 at 13:02:34 CET