tkrzw_lib_common.h File Reference

Common library features. More...

#include <limits>
#include <iostream>
#include <map>
#include <memory>
#include <set>
#include <stdexcept>
#include <string>
#include <string_view>
#include <unordered_map>
#include <utility>
#include <vector>
#include <cinttypes>
#include <cstdlib>
#include <cstring>

Classes
class	tkrzw::Status
	Status of operations. More...
class	tkrzw::StatusException
	Exception to convey the status of operations. More...

Namespaces
namespace	tkrzw
	Common namespace of Tkrzw.

Functions
void *	tkrzw::xmalloc (size_t size)
	Allocates a region on memory.
void *	tkrzw::xcalloc (size_t nmemb, size_t size)
	Allocates a nullified region on memory.
void *	tkrzw::xrealloc (void *ptr, size_t size)
	Re-allocates a region on memory.
void *	tkrzw::xreallocappend (void *ptr, size_t size)
	Re-allocates a region on memory for appending operations.
void	tkrzw::xfree (void *ptr)
	Frees a region on memory.
void *	tkrzw::xmallocaligned (size_t alignment, size_t size)
	Allocates an aligned region on memory.
void	tkrzw::xfreealigned (void *ptr)
	Frees an aligned region on memory.
void *	tkrzw::xmemcpybigendian (void *dest, const void *src, size_t width)
	Copies memory area by normalizing the byte order into the big endian.
template<typename SET>
bool	tkrzw::CheckSet (SET set, const typename SET::key_type &elem)
	Checks whether a set has an element.
template<typename MAP>
bool	tkrzw::CheckMap (MAP map, const typename MAP::key_type &key)
	Checks whether a map has a key.
template<typename MAP>
MAP::value_type::second_type	tkrzw::SearchMap (MAP map, const typename MAP::key_type &key, const typename MAP::value_type::second_type &default_value)
	Searches a map and get the value of a record.
int64_t	tkrzw::GetProcessID ()
	Gets the current processs ID.
std::map< std::string, std::string >	tkrzw::GetSystemInfo ()
	Gets system information of the environment.
int64_t	tkrzw::GetMemoryCapacity ()
	Gets the memory capacity of the platform.
int64_t	tkrzw::GetMemoryUsage ()
	Gets the current memory usage of the process.
bool	tkrzw::operator== (const Status::Code &lhs, const Status &rhs)
	Checks whether a status code is equal to another status object.
bool	tkrzw::operator!= (const Status::Code &lhs, const Status &rhs)
	Checks whether a status code is not equal to another status object.
std::string	tkrzw::ToString (const Status &status)
	Converts a status into a string.
std::ostream &	tkrzw::operator<< (std::ostream &os, const Status &status)
	Outputs a status string into an output stream.
Status	tkrzw::GetErrnoStatus (const char *call_name, int32_t sys_err_num)
	Gets a status according to a system error number of a system call.

Variables
constexpr int8_t	tkrzw::INT8MIN = std::numeric_limits<int8_t>::min()
	Disable macros to avoid possible name confliction.
constexpr int8_t	tkrzw::INT8MAX = std::numeric_limits<int8_t>::max()
	The maximum value of int8_t.
constexpr uint8_t	tkrzw::UINT8MAX = std::numeric_limits<uint8_t>::max()
	The maximum value of uint8_t.
constexpr int16_t	tkrzw::INT16MIN = std::numeric_limits<int16_t>::min()
	The minimum value of int16_t.
constexpr int16_t	tkrzw::INT16MAX = std::numeric_limits<int16_t>::max()
	The maximum value of int16_t.
constexpr uint16_t	tkrzw::UINT16MAX = std::numeric_limits<uint16_t>::max()
	The maximum value of uint16_t.
constexpr int32_t	tkrzw::INT32MIN = std::numeric_limits<int32_t>::min()
	The minimum value of int32_t.
constexpr int32_t	tkrzw::INT32MAX = std::numeric_limits<int32_t>::max()
	The maximum value of int32_t.
constexpr uint32_t	tkrzw::UINT32MAX = std::numeric_limits<uint32_t>::max()
	The maximum value of uint32_t.
constexpr int64_t	tkrzw::INT64MIN = std::numeric_limits<int64_t>::min()
	The minimum value of int64_t.
constexpr int64_t	tkrzw::INT64MAX = std::numeric_limits<int64_t>::max()
	The maximum value of int64_t.
constexpr uint64_t	tkrzw::UINT64MAX = std::numeric_limits<uint64_t>::max()
	The maximum value of uint64_t.
constexpr size_t	tkrzw::SIZEMAX = std::numeric_limits<size_t>::max()
	The maximum value of size_t.
constexpr float	tkrzw::FLOATMIN = std::numeric_limits<float>::min()
	The minimum value of float.
constexpr float	tkrzw::FLOATMAX = std::numeric_limits<float>::max()
	The maximum value of float.
constexpr double	tkrzw::DOUBLEMIN = std::numeric_limits<double>::min()
	The minimum value of double.
constexpr double	tkrzw::DOUBLEMAX = std::numeric_limits<double>::max()
	The maximum value of double.
constexpr double	tkrzw::DOUBLENAN = std::numeric_limits<double>::quiet_NaN()
	The quiet Not-a-Number value of double.
constexpr double	tkrzw::DOUBLEINF = std::numeric_limits<double>::infinity()
	The positive infinity value of double.
constexpr int32_t	tkrzw::NUM_BUFFER_SIZE = 32
	The buffer size for a numeric string expression.
constexpr int64_t	tkrzw::MAX_MEMORY_SIZE = (1LL << 40)
	The maximum memory size.
const int32_t	tkrzw::PAGE_SIZE
	The size of a memory page on the OS.
const char *const	tkrzw::PACKAGE_VERSION
	The string expression of the package version.
const char *const	tkrzw::LIBRARY_VERSION
	The string expression of the library version.
const char *const	tkrzw::OS_NAME
	The recognized OS name.
const bool	tkrzw::IS_POSIX
	True if the OS is conforming to POSIX.
const bool	tkrzw::IS_BIG_ENDIAN
	True if the byte order is big endian.

Detailed Description

Common library features.