IgrOS-Kernel 0.1.34.545
Simple C++20 Kernel for i386/x86_64
Loading...
Searching...
No Matches
igros::klib Namespace Reference

Freestanding kernel library: printing, math, alignment, flags, strings. More...

Namespaces

namespace  anonymous_namespace{kPrint.cpp}
 Format implementation details.

Classes

class  kAlign
 Kernel alignment handling (ALIGN in bytes, power of two; 0 - natural alignment of pointed type). More...
class  kFlags
 Bit flags of enum type. More...
struct  divmod_t
 Combined division & modulo result. More...
class  kVersion
 Kernel version class. More...

Concepts

concept  kalignable
 Alignable value: unsigned integer (address) or pointer.
concept  kdivisible
 Integers of the same signedness (mixed ones convert signed to unsigned silently).

Typedefs

template<kalignable T>
using kalign_int_t = std::conditional_t<std::is_pointer_v<T>, igros_usize_t, T>
 Integer type for alignment arithmetic (pointers as addresses, integers as is: 64-bit on i386 too).

Enumerations

enum class  radix_t : igros_byte_t { BIN = 0x02_u8 , OCT = 0x08_u8 , DEC = 0x0A_u8 , HEX = 0x10_u8 }
 Integer representation types. More...

Functions

template<class T, std::same_as< T >... Args>
constexpr auto make_kflags (const Args... flags) noexcept -> kFlags< T >
 Flags creation helper function from set flags.
constexpr auto kudivmod64 (const igros_quad_t dividend, const igros_quad_t divisor) noexcept -> divmod_t< igros_quad_t >
 64-bit unsigned division for 32-bit CPU (no 64-bit "/" and "%" without libgcc __udivdi3/__umoddi3)
template<std::integral T, std::integral D>
requires kdivisible<T, D>
constexpr auto kdivmod (const T dividend, const D divisor) noexcept -> divmod_t< T >
 Divide integer by integer of the same signedness.
auto kvsnprintf (char *const buffer, const igros_usize_t size, const char *const format, std::va_list list) noexcept -> igros_usize_t
 Kernel vsnprintf function (returns written length without terminator).
auto ksnprintf (char *const buffer, const igros_usize_t size, const char *const format,...) noexcept -> igros_usize_t
 Kernel snprintf function (returns written length without terminator).
void kprintf (const char *const format,...) noexcept
 Kernel printf function (arguments are checked against format at compile time).
template<std::unsigned_integral U>
constexpr auto kdigits (const std::span< char > buffer, U value, const radix_t radix, const bool upper=false) noexcept -> std::string_view
 Digits of unsigned value written to the end of buffer (no sign, no terminator).
constexpr auto kstrview (const char *const src) noexcept -> std::string_view
 View of null-terminated string (null pointer is empty string).

Detailed Description

Freestanding kernel library: printing, math, alignment, flags, strings.

IgrOS Kernel Library namespace.

Typedef Documentation

◆ kalign_int_t

template<kalignable T>
using igros::klib::kalign_int_t = std::conditional_t<std::is_pointer_v<T>, igros_usize_t, T>

Integer type for alignment arithmetic (pointers as addresses, integers as is: 64-bit on i386 too).

Template Parameters
TAlignable type

Definition at line 36 of file kAlign.hpp.

Enumeration Type Documentation

◆ radix_t

enum class igros::klib::radix_t : igros_byte_t
nodiscardstrong

Integer representation types.

Enumerator
BIN 

(Base 2) Binary integer format

OCT 

(Base 8) Oct integer format

DEC 

(Base 10) Decimal integer format

HEX 

(Base 16) Hexidemical integer format

Definition at line 35 of file kPrint.hpp.

Function Documentation

◆ kdigits()

template<std::unsigned_integral U>
auto igros::klib::kdigits ( const std::span< char > buffer,
U value,
const radix_t radix,
const bool upper = false )->std::string_view
nodiscardconstexprnoexcept

Digits of unsigned value written to the end of buffer (no sign, no terminator).

Buffer must fit all digits (std::numeric_limits<U>::digits for binary)

Template Parameters
UUnsigned integer type
Parameters
bufferOutput buffer (digits end at its end)
valueValue
radixRadix
upperUppercase hexadecimal digits
Returns
View of written digits (inside buffer)

Definition at line 54 of file kPrint.hpp.

◆ kdivmod()

template<std::integral T, std::integral D>
requires kdivisible<T, D>
auto igros::klib::kdivmod ( const T dividend,
const D divisor )->divmod_t< T >
nodiscardconstexprnoexcept

Divide integer by integer of the same signedness.

Returns quotient (truncated towards zero) and remainder (sign of dividend), like C++ "/" and "%" Divisor must not be zero (traps like native division, except software 64-bit division on i386)

Template Parameters
TDividend type
DDivisor type (same signedness)
Parameters
dividendDividend
divisorDivisor (not zero)
Returns
Quotient and remainder

Definition at line 115 of file kMath.hpp.

◆ kprintf()

void igros::klib::kprintf ( const char *const format,
... )
noexcept

Kernel printf function (arguments are checked against format at compile time).

Parameters
formatprintf-like format (line feed is added)
...Arguments

Definition at line 358 of file kPrint.cpp.

◆ ksnprintf()

auto igros::klib::ksnprintf ( char *const buffer,
const igros_usize_t size,
const char *const format,
... )->igros_usize_t
noexcept

Kernel snprintf function (returns written length without terminator).

Parameters
bufferOutput buffer
sizeBuffer size (output is clipped and always terminated)
formatprintf-like format
...Arguments
Returns
Written length without terminator

Definition at line 344 of file kPrint.cpp.

◆ kstrview()

auto igros::klib::kstrview ( const char *const src) ->std::string_view
nodiscardconstexprnoexcept

View of null-terminated string (null pointer is empty string).

Parameters
srcNull-terminated string or nullptr
Returns
View of string (empty for nullptr)

Definition at line 28 of file kString.hpp.

◆ kudivmod64()

auto igros::klib::kudivmod64 ( const igros_quad_t dividend,
const igros_quad_t divisor )->divmod_t< igros_quad_t >
nodiscardconstexprnoexcept

64-bit unsigned division for 32-bit CPU (no 64-bit "/" and "%" without libgcc __udivdi3/__umoddi3)

Division by zero returns {0, dividend}

Parameters
dividendDividend
divisorDivisor
Returns
Quotient and remainder

Definition at line 56 of file kMath.hpp.

◆ kvsnprintf()

auto igros::klib::kvsnprintf ( char *const buffer,
const igros_usize_t size,
const char *const format,
std::va_list list )->igros_usize_t
noexcept

Kernel vsnprintf function (returns written length without terminator).

Parameters
bufferOutput buffer
sizeBuffer size (output is clipped and always terminated)
formatprintf-like format
listArguments
Returns
Written length without terminator

Definition at line 255 of file kPrint.cpp.

◆ make_kflags()

template<class T, std::same_as< T >... Args>
auto igros::klib::make_kflags ( const Args... flags) ->kFlags< T >
nodiscardconstexprnoexcept

Flags creation helper function from set flags.

Template Parameters
TFlags enum type
ArgsSet flags types (same enum type)
Parameters
flagsSet flags
Returns
Flags with given flags set

Definition at line 94 of file kFlags.hpp.