cd2ede593a
1401fb85 Fix `a label can only be part of a statement` warning (#61) 5f650a18 CMake: Enable `CMAKE_MSVC_RUNTIME_LIBRARY` (MSVC) 6c958cfe Fix no-libc build on "other" platforms (#58) 59819206 Bump version to v1.4.0 4bc563f6 Fix build-system to better work with vcpkg (#56) 4a8b5e2a CMake: rename target `doc` -> `ZycoreDoc` a754e112 Bump version to 1.3.0 3e95307d Add support for ppc(64) and riscv64 (#52) 8f39333a build: only enable CXX if needed 7bd75696 build: add doc target 7c33e13e Fix `ZYAN_TRUE`/`ZYAN_FALSE` signedness a0feec7f Fix warning `C4668` bdbd3ff4 Bump version to v1.2 60b6ef1c Fix for dynamic libraries too 310f362c Adding ARCHIVE DESTINATION to fix CMake error b01063b8 Improved logic for enabling LTO c58d7fb5 Don't enable C11 for MSVC ee784564 Switch minimum C standard supported to C11 5c341bf1 Implement an initial set of cross-compiler atomic operations b4949ccc Minor fixes 9a305f6a Add CI workflow dd2211a0 Get rid of CMake export headers f0fb3f78 Fix `ZYAN_VECTOR_FOREACH_MUTABLE` macro 3f263290 format: handle encoding on wasm 95d7fb6c format: handle hex encoding on wasm 0d37fc54 defines: add wasm/wasi detection 8983325b build: use -pthread when possible 3de49d41 build: use system GTest when available 8d46cb58 test: make tests runnable with ctest 636bb299 Remove `float`s from the project (kernel mode compatibility) (#36) e2b37b10 Assert to ensure sane growth factors 94185407 Added limits for integer types 767719d9 build(cmake): export and install zyan_* functions (#33) 6c93d9a3 build(cmake): add version and soversion to the library fc2798d4 build(cmake): fix PUBLIC include dir of installed lib 22ce9c2d Add `ZYAN_FORCE_ASSERTS` CMake option 9a301424 Remove disabling source files in no-libc mode in CMake 3be54fca Thread.c: add missing SDK prototypes for old versions of Windows d7fc85fd Exclude API/Memory.c and API/Process.c from compilation in no-libc mode 8da0001a Add back #ifdef guards to "API" headers/sources for no-libc mode f6a48866 Fix cmake config files (#27) 4f3746fa Merge pull request #26 from Tsn0w/master a9bb54ad Replace fallthrough attribute to __fallthrough__ 99a74acb Add `ZYDIS_NOINLINE` macro git-subtree-dir: externals/zycore git-subtree-split: 1401fb85ac313f6605ec795c52bf99ea3f292a69
285 lines
12 KiB
C
285 lines
12 KiB
C
/***************************************************************************************************
|
|
|
|
Zyan Core Library (Zycore-C)
|
|
|
|
Original Author : Florian Bernd
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
|
|
***************************************************************************************************/
|
|
|
|
/**
|
|
* @file
|
|
* Provides helper functions for performant number to string conversion.
|
|
*/
|
|
|
|
#ifndef ZYCORE_FORMAT_H
|
|
#define ZYCORE_FORMAT_H
|
|
|
|
#include <Zycore/Status.h>
|
|
#include <Zycore/String.h>
|
|
#include <Zycore/Types.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* ============================================================================================== */
|
|
/* Exported functions */
|
|
/* ============================================================================================== */
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
/* Helpers */
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Get the absolute value of a 64 bit int.
|
|
*
|
|
* @param x The value to process.
|
|
* @return The absolute, unsigned value.
|
|
*
|
|
* This gracefully deals with the special case of `x` being `INT_MAX`.
|
|
*/
|
|
ZYAN_INLINE ZyanU64 ZyanAbsI64(ZyanI64 x)
|
|
{
|
|
// INT_MIN special case. Can't use the value directly because GCC thinks
|
|
// it's too big for an INT64 literal, however is perfectly happy to accept
|
|
// this expression. This is also hit INT64_MIN is defined in `stdint.h`.
|
|
if (x == (-0x7fffffffffffffff - 1))
|
|
{
|
|
return 0x8000000000000000u;
|
|
}
|
|
|
|
return (ZyanU64)(x < 0 ? -x : x);
|
|
}
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
/* Insertion */
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Inserts formatted text in the destination string at the given `index`.
|
|
*
|
|
* @param string The destination string.
|
|
* @param index The insert index.
|
|
* @param format The format string.
|
|
* @param ... The format arguments.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYAN_PRINTF_ATTR(3, 4)
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringInsertFormat(ZyanString* string, ZyanUSize index,
|
|
const char* format, ...);
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Formats the given unsigned ordinal `value` to its decimal text-representation and
|
|
* inserts it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param index The insert index.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringInsertDecU(ZyanString* string, ZyanUSize index, ZyanU64 value,
|
|
ZyanU8 padding_length);
|
|
|
|
/**
|
|
* Formats the given signed ordinal `value` to its decimal text-representation and
|
|
* inserts it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param index The insert index.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param force_sign Set `ZYAN_TRUE`, to force printing of the `+` sign for positive numbers.
|
|
* @param prefix The string to use as prefix or `ZYAN_NULL`, if not needed.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringInsertDecS(ZyanString* string, ZyanUSize index, ZyanI64 value,
|
|
ZyanU8 padding_length, ZyanBool force_sign, const ZyanString* prefix);
|
|
|
|
/**
|
|
* Formats the given unsigned ordinal `value` to its hexadecimal text-representation and
|
|
* inserts it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param index The insert index.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param uppercase Set `ZYAN_TRUE` to use uppercase letters ('A'-'F') instead of lowercase
|
|
* ones ('a'-'f').
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringInsertHexU(ZyanString* string, ZyanUSize index, ZyanU64 value,
|
|
ZyanU8 padding_length, ZyanBool uppercase);
|
|
|
|
/**
|
|
* Formats the given signed ordinal `value` to its hexadecimal text-representation and
|
|
* inserts it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param index The insert index.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param uppercase Set `ZYAN_TRUE` to use uppercase letters ('A'-'F') instead of lowercase
|
|
* ones ('a'-'f').
|
|
* @param force_sign Set `ZYAN_TRUE`, to force printing of the `+` sign for positive numbers.
|
|
* @param prefix The string to use as prefix or `ZYAN_NULL`, if not needed.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringInsertHexS(ZyanString* string, ZyanUSize index, ZyanI64 value,
|
|
ZyanU8 padding_length, ZyanBool uppercase, ZyanBool force_sign, const ZyanString* prefix);
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
/* Appending */
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
#ifndef ZYAN_NO_LIBC
|
|
|
|
/**
|
|
* Appends formatted text to the destination string.
|
|
*
|
|
* @param string The destination string.
|
|
* @param format The format string.
|
|
* @param ... The format arguments.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYAN_PRINTF_ATTR(2, 3)
|
|
ZYCORE_EXPORT ZYAN_REQUIRES_LIBC ZyanStatus ZyanStringAppendFormat(
|
|
ZyanString* string, const char* format, ...);
|
|
|
|
#endif // ZYAN_NO_LIBC
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
/**
|
|
* Formats the given unsigned ordinal `value` to its decimal text-representation and
|
|
* appends it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringAppendDecU(ZyanString* string, ZyanU64 value,
|
|
ZyanU8 padding_length);
|
|
|
|
/**
|
|
* Formats the given signed ordinal `value` to its decimal text-representation and
|
|
* appends it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param force_sign Set `ZYAN_TRUE`, to force printing of the `+` sign for positive numbers.
|
|
* @param prefix The string to use as prefix or `ZYAN_NULL`, if not needed.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringAppendDecS(ZyanString* string, ZyanI64 value,
|
|
ZyanU8 padding_length, ZyanBool force_sign, const ZyanStringView* prefix);
|
|
|
|
/**
|
|
* Formats the given unsigned ordinal `value` to its hexadecimal text-representation and
|
|
* appends it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param uppercase Set `ZYAN_TRUE` to use uppercase letters ('A'-'F') instead of lowercase
|
|
* ones ('a'-'f').
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringAppendHexU(ZyanString* string, ZyanU64 value,
|
|
ZyanU8 padding_length, ZyanBool uppercase);
|
|
|
|
/**
|
|
* Formats the given signed ordinal `value` to its hexadecimal text-representation and
|
|
* appends it to the `string`.
|
|
*
|
|
* @param string A pointer to the `ZyanString` instance.
|
|
* @param value The value.
|
|
* @param padding_length Padds the converted value with leading zeros, if the number of chars is
|
|
* less than the `padding_length`.
|
|
* @param uppercase Set `ZYAN_TRUE` to use uppercase letters ('A'-'F') instead of lowercase
|
|
* ones ('a'-'f').
|
|
* @param force_sign Set `ZYAN_TRUE`, to force printing of the `+` sign for positive numbers.
|
|
* @param prefix The string to use as prefix or `ZYAN_NULL`, if not needed.
|
|
*
|
|
* @return A zyan status code.
|
|
*
|
|
* This function will fail, if the `ZYAN_STRING_IS_IMMUTABLE` flag is set for the specified
|
|
* `ZyanString` instance.
|
|
*/
|
|
ZYCORE_EXPORT ZyanStatus ZyanStringAppendHexS(ZyanString* string, ZyanI64 value,
|
|
ZyanU8 padding_length, ZyanBool uppercase, ZyanBool force_sign, const ZyanStringView* prefix);
|
|
|
|
/* ---------------------------------------------------------------------------------------------- */
|
|
|
|
/* ============================================================================================== */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // ZYCORE_FORMAT_H
|