source: mainline/kernel/generic/src/lib/str.c@ 1d2f85e

/*
 * Copyright (c) 2001-2004 Jakub Jermar
 * Copyright (c) 2005 Martin Decky
 * Copyright (c) 2008 Jiri Svoboda
 * Copyright (c) 2011 Martin Sucha
 * Copyright (c) 2011 Oleg Romanenko
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup kernel_generic
 * @{
 */

/**
 * @file
 * @brief String functions.
 *
 * Strings and characters use the Universal Character Set (UCS). The standard
 * strings, called just strings are encoded in UTF-8. Wide strings (encoded
 * in UTF-32) are supported to a limited degree. A single code point is
 * represented as wchar_t.@n
 *
 * Overview of the terminology:@n
 *
 *  Term                  Meaning
 *  --------------------  ----------------------------------------------------
 *  byte                  8 bits stored in uint8_t (unsigned 8 bit integer)
 *
 *  character             UTF-32 encoded Unicode code point, stored in wchar_t
 *                        (signed 32 bit integer), code points 0 .. 1114111
 *                        are valid
 *
 *  ASCII character       7 bit encoded ASCII character, stored in char
 *                        (usually signed 8 bit integer), code points 0 .. 127
 *                        are valid
 *
 *  string                UTF-8 encoded NULL-terminated Unicode string, char *
 *
 *  wide string           UTF-32 encoded NULL-terminated Unicode string,
 *                        wchar_t *
 *
 *  [wide] string size    number of BYTES in a [wide] string (excluding
 *                        the NULL-terminator), size_t
 *
 *  [wide] string length  number of CODE POINTS in a [wide] string (excluding
 *                        the NULL-terminator), size_t
 *
 *  [wide] string width   number of display cells on a monospace display taken
 *                        by a [wide] string, size_t
 *
 *
 * Overview of string metrics:@n
 *
 *  Metric  Abbrev.  Type     Meaning
 *  ------  ------   ------   -------------------------------------------------
 *  size    n        size_t   number of BYTES in a string (excluding the
 *                            NULL-terminator)
 *
 *  length  l        size_t   number of CODE POINTS in a string (excluding the
 *                            null terminator)
 *
 *  width  w         size_t   number of display cells on a monospace display
 *                            taken by a string
 *
 *
 * Function naming prefixes:@n
 *
 *  chr_    operate on code points
 *  ascii_  operate on ASCII characters
 *  str_    operate on strings
 *  wstr_   operate on wide strings
 *
 *  [w]str_[n|l|w]  operate on a prefix limited by size, length
 *                  or width
 *
 *
 * A specific character inside a [wide] string can be referred to by:@n
 *
 *  pointer (char *, wchar_t *)
 *  byte offset (size_t)
 *  code point index (size_t)
 *
 */

#include <str.h>

#include <assert.h>
#include <errno.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>

#include <align.h>
#include <macros.h>

/** Check the condition if wchar_t is signed */
#ifdef __WCHAR_UNSIGNED__
#define WCHAR_SIGNED_CHECK(cond)  (true)
#else
#define WCHAR_SIGNED_CHECK(cond)  (cond)
#endif

/** Byte mask consisting of lowest @n bits (out of 8) */
#define LO_MASK_8(n)  ((uint8_t) ((1 << (n)) - 1))

/** Byte mask consisting of lowest @n bits (out of 32) */
#define LO_MASK_32(n)  ((uint32_t) ((1 << (n)) - 1))

/** Byte mask consisting of highest @n bits (out of 8) */
#define HI_MASK_8(n)  (~LO_MASK_8(8 - (n)))

/** Number of data bits in a UTF-8 continuation byte */
#define CONT_BITS  6

/** Decode a single code point from an UTF-8 encoded string.
 *
 * Decode a single code point from a string of size @a size. Decoding starts
 * at @a offset and this offset is moved to the beginning of the next
 * code point. In case of decoding error, offset generally advances at least
 * by one. However, offset is never moved beyond size.
 *
 * @param str    String (not necessarily NULL-terminated).
 * @param offset Byte offset in string where to start decoding.
 * @param size   Size of the string (in bytes).
 *
 * @return Value of decoded code point, U_SPECIAL on decoding error or
 *         NULL if attempt to decode beyond @a size.
 *
 */
wchar_t str_decode(const char *str, size_t *offset, size_t size)
{
        if (*offset + 1 > size)
                return 0;

        /* First byte read from string */
        uint8_t b0 = (uint8_t) str[(*offset)++];

        /* Determine code length */

        unsigned int b0_bits;  /* Data bits in first byte */
        unsigned int cbytes;   /* Number of continuation bytes */

        if ((b0 & 0x80) == 0) {
                /* 0xxxxxxx (Plain ASCII) */
                b0_bits = 7;
                cbytes = 0;
        } else if ((b0 & 0xe0) == 0xc0) {
                /* 110xxxxx 10xxxxxx */
                b0_bits = 5;
                cbytes = 1;
        } else if ((b0 & 0xf0) == 0xe0) {
                /* 1110xxxx 10xxxxxx 10xxxxxx */
                b0_bits = 4;
                cbytes = 2;
        } else if ((b0 & 0xf8) == 0xf0) {
                /* 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */
                b0_bits = 3;
                cbytes = 3;
        } else {
                /* 10xxxxxx -- unexpected continuation byte */
                return U_SPECIAL;
        }

        if (*offset + cbytes > size)
                return U_SPECIAL;

        wchar_t ch = b0 & LO_MASK_8(b0_bits);

        /* Decode continuation bytes */
        while (cbytes > 0) {
                uint8_t b = (uint8_t) str[(*offset)++];

                /* Must be 10xxxxxx */
                if ((b & 0xc0) != 0x80)
                        return U_SPECIAL;

                /* Shift data bits to ch */
                ch = (ch << CONT_BITS) | (wchar_t) (b & LO_MASK_8(CONT_BITS));
                cbytes--;
        }

        return ch;
}

/** Encode a single code point to a UTF-8 string representation.
 *
 * Encode a single code point to a UTF-8 string representation and store
 * it into a buffer at @a offset. Encoding starts at @a offset and this offset
 * is moved to the position where the next code point can be written to.
 *
 * @param ch     Input code point.
 * @param str    Output buffer.
 * @param offset Byte offset where to start writing.
 * @param size   Size of the output buffer (in bytes).
 *
 * @return EOK if the code point was encoded successfully, EOVERFLOW if there
 *         was not enough space in the output buffer or EINVAL if the code point
 *         code was invalid.
 */
errno_t chr_encode(const wchar_t ch, char *str, size_t *offset, size_t size)
{
        if (*offset >= size)
                return EOVERFLOW;

        if (!chr_check(ch))
                return EINVAL;

        /*
         * Unsigned version of ch (bit operations should only be done
         * on unsigned types).
         */
        uint32_t cc = (uint32_t) ch;

        /* Determine how many continuation bytes are needed */

        unsigned int b0_bits;  /* Data bits in first byte */
        unsigned int cbytes;   /* Number of continuation bytes */

        if ((cc & ~LO_MASK_32(7)) == 0) {
                b0_bits = 7;
                cbytes = 0;
        } else if ((cc & ~LO_MASK_32(11)) == 0) {
                b0_bits = 5;
                cbytes = 1;
        } else if ((cc & ~LO_MASK_32(16)) == 0) {
                b0_bits = 4;
                cbytes = 2;
        } else if ((cc & ~LO_MASK_32(21)) == 0) {
                b0_bits = 3;
                cbytes = 3;
        } else {
                /* Codes longer than 21 bits are not supported */
                return EINVAL;
        }

        /* Check for available space in buffer */
        if (*offset + cbytes >= size)
                return EOVERFLOW;

        /* Encode continuation bytes */
        unsigned int i;
        for (i = cbytes; i > 0; i--) {
                str[*offset + i] = 0x80 | (cc & LO_MASK_32(CONT_BITS));
                cc = cc >> CONT_BITS;
        }

        /* Encode first byte */
        str[*offset] = (cc & LO_MASK_32(b0_bits)) | HI_MASK_8(8 - b0_bits - 1);

        /* Advance offset */
        *offset += cbytes + 1;

        return EOK;
}

/** Get size of string.
 *
 * Get the number of bytes which are used by the string @a str (excluding the
 * NULL-terminator).
 *
 * @param str String to consider.
 *
 * @return Number of bytes used by the string
 *
 */
size_t str_bytes(const char *str)
{
        size_t size = 0;

        while (*str++ != 0)
                size++;

        return size;
}

/** Get size of wide string.
 *
 * Get the number of bytes which are used by the wide string @a str (excluding the
 * NULL-terminator).
 *
 * @param str Wide string to consider.
 *
 * @return Number of bytes used by the wide string
 *
 */
size_t wstr_bytes(const wchar_t *str)
{
        return (wstr_code_points(str) * sizeof(wchar_t));
}

/** Get size of string with code point count limit.
 *
 * Get the number of bytes which are used by up to @a max_len first
 * code points in the string @a str. If @a max_len is greater than
 * the number of code points in @a str, the entire string is measured
 * (excluding the NULL-terminator).
 *
 * @param str     String to consider.
 * @param max_len Maximum number of code points to measure.
 *
 * @return Number of bytes used by the code points.
 *
 */
size_t str_lbytes(const char *str, size_t max_len)
{
        size_t len = 0;
        size_t offset = 0;

        while (len < max_len) {
                if (str_decode(str, &offset, STR_NO_LIMIT) == 0)
                        break;

                len++;
        }

        return offset;
}

/** Get size of wide string with length limit.
 *
 * Get the number of bytes which are used by up to @a max_len first
 * code points in the wide string @a str. If @a max_len is greater than
 * the length of @a str, the entire wide string is measured (excluding the
 * NULL-terminator).
 *
 * @param str     Wide string to consider.
 * @param max_len Maximum number of code points to measure.
 *
 * @return Number of bytes used by the code points.
 *
 */
size_t wstr_lbytes(const wchar_t *str, size_t max_len)
{
        return (wstr_ncode_points(str, max_len * sizeof(wchar_t)) * sizeof(wchar_t));
}

/** Get number of unicode code points in a UTF-8 encoded string.
 *
 * @param str NULL-terminated UTF-8 string.
 *
 * @return Number of code points in the string.
 *
 */
size_t str_code_points(const char *str)
{
        size_t len = 0;
        size_t offset = 0;

        while (str_decode(str, &offset, STR_NO_LIMIT) != 0)
                len++;

        return len;
}

/** Get number of code points in a wide string.
 *
 * @param str NULL-terminated wide string.
 *
 * @return Number of code points in @a str.
 *
 */
size_t wstr_code_points(const wchar_t *wstr)
{
        size_t len = 0;

        while (*wstr++ != 0)
                len++;

        return len;
}

/** Get number of code points in a string with size limit.
 *
 * @param str  NULL-terminated string.
 * @param size Maximum number of bytes to consider.
 *
 * @return Number of code points in string.
 *
 */
size_t str_ncode_points(const char *str, size_t size)
{
        size_t len = 0;
        size_t offset = 0;

        while (str_decode(str, &offset, size) != 0)
                len++;

        return len;
}

/** Get number of code points in a string with size limit.
 *
 * @param str  NULL-terminated string.
 * @param size Maximum number of bytes to consider.
 *
 * @return Number of code points in string.
 *
 */
size_t wstr_ncode_points(const wchar_t *str, size_t size)
{
        size_t len = 0;
        size_t limit = ALIGN_DOWN(size, sizeof(wchar_t));
        size_t offset = 0;

        while ((offset < limit) && (*str++ != 0)) {
                len++;
                offset += sizeof(wchar_t);
        }

        return len;
}

/** Check whether code point is plain ASCII.
 *
 * @return True if code point is plain ASCII.
 *
 */
bool ascii_check(wchar_t ch)
{
        if (WCHAR_SIGNED_CHECK(ch >= 0) && (ch <= 127))
                return true;

        return false;
}

/** Check whether code point is valid
 *
 * @return True if code point is a valid Unicode code point.
 *
 */
bool chr_check(wchar_t ch)
{
        if (WCHAR_SIGNED_CHECK(ch >= 0) && (ch <= 1114111))
                return true;

        return false;
}

/** Compare two NULL terminated strings.
 *
 * Do a char-by-char comparison of two NULL-terminated strings.
 * The strings are considered equal iff their length is equal
 * and both strings consist of the same sequence of code points.
 *
 * A string S1 is less than another string S2 if it has a code point with
 * lower value at the first code point position where the strings differ.
 * If the strings differ in length, the shorter one is treated as if
 * padded by code points with a value of zero.
 *
 * @param s1 First string to compare.
 * @param s2 Second string to compare.
 *
 * @return 0 if the strings are equal, -1 if the first is less than the second,
 *         1 if the second is less than the first.
 *
 */
int str_cmp(const char *s1, const char *s2)
{
        wchar_t c1 = 0;
        wchar_t c2 = 0;

        size_t off1 = 0;
        size_t off2 = 0;

        while (true) {
                c1 = str_decode(s1, &off1, STR_NO_LIMIT);
                c2 = str_decode(s2, &off2, STR_NO_LIMIT);

                if (c1 < c2)
                        return -1;

                if (c1 > c2)
                        return 1;

                if (c1 == 0 || c2 == 0)
                        break;
        }

        return 0;
}

/** Compare two NULL terminated strings with length limit.
 *
 * Do a char-by-char comparison of two NULL-terminated strings.
 * The strings are considered equal iff
 * min(str_code_points(s1), max_len) == min(str_code_points(s2), max_len)
 * and both strings consist of the same sequence of code points,
 * up to max_len code points.
 *
 * A string S1 is less than another string S2 if it has a code point with
 * lower value at the first code point position where the strings differ.
 * If the strings differ in length, the shorter one is treated as if
 * padded by code points with a value of zero. Only the first max_len
 * code points are considered.
 *
 * @param s1      First string to compare.
 * @param s2      Second string to compare.
 * @param max_len Maximum number of code points to consider.
 *
 * @return 0 if the strings are equal, -1 if the first is less than the second,
 *         1 if the second is less than the first.
 *
 */
int str_lcmp(const char *s1, const char *s2, size_t max_len)
{
        wchar_t c1 = 0;
        wchar_t c2 = 0;

        size_t off1 = 0;
        size_t off2 = 0;

        size_t len = 0;

        while (true) {
                if (len >= max_len)
                        break;

                c1 = str_decode(s1, &off1, STR_NO_LIMIT);
                c2 = str_decode(s2, &off2, STR_NO_LIMIT);

                if (c1 < c2)
                        return -1;

                if (c1 > c2)
                        return 1;

                if (c1 == 0 || c2 == 0)
                        break;

                ++len;
        }

        return 0;

}

/** Copy string.
 *
 * Copy source string @a src to destination buffer @a dest.
 * No more than @a size bytes are written. If the size of the output buffer
 * is at least one byte, the output string will always be well-formed, i.e.
 * null-terminated and containing only complete code points.
 *
 * @param dest  Destination buffer.
 * @param count Size of the destination buffer (must be > 0).
 * @param src   Source string.
 *
 */
void str_cpy(char *dest, size_t size, const char *src)
{
        /* There must be space for a null terminator in the buffer. */
        assert(size > 0);
        assert(src != NULL);

        size_t src_off = 0;
        size_t dest_off = 0;

        wchar_t ch;
        while ((ch = str_decode(src, &src_off, STR_NO_LIMIT)) != 0) {
                if (chr_encode(ch, dest, &dest_off, size - 1) != EOK)
                        break;
        }

        dest[dest_off] = '\0';
}

/** Copy size-limited substring.
 *
 * Copy prefix of string @a src of max. size @a size to destination buffer
 * @a dest. No more than @a size bytes are written. The output string will
 * always be well-formed, i.e. null-terminated and containing only complete
 * code points.
 *
 * No more than @a n bytes are read from the input string, so it does not
 * have to be null-terminated.
 *
 * @param dest  Destination buffer.
 * @param count Size of the destination buffer (must be > 0).
 * @param src   Source string.
 * @param n     Maximum number of bytes to read from @a src.
 *
 */
void str_ncpy(char *dest, size_t size, const char *src, size_t n)
{
        /* There must be space for a null terminator in the buffer. */
        assert(size > 0);

        size_t src_off = 0;
        size_t dest_off = 0;

        wchar_t ch;
        while ((ch = str_decode(src, &src_off, n)) != 0) {
                if (chr_encode(ch, dest, &dest_off, size - 1) != EOK)
                        break;
        }

        dest[dest_off] = '\0';
}

/** Convert wide string to string.
 *
 * Convert wide string @a src to string. The output is written to the buffer
 * specified by @a dest and @a size. @a size must be non-zero and the string
 * written will always be well-formed.
 *
 * @param dest  Destination buffer.
 * @param size  Size of the destination buffer.
 * @param src   Source wide string.
 */
void wstr_to_str(char *dest, size_t size, const wchar_t *src)
{
        wchar_t ch;
        size_t src_idx;
        size_t dest_off;

        /* There must be space for a null terminator in the buffer. */
        assert(size > 0);

        src_idx = 0;
        dest_off = 0;

        while ((ch = src[src_idx++]) != 0) {
                if (chr_encode(ch, dest, &dest_off, size - 1) != EOK)
                        break;
        }

        dest[dest_off] = '\0';
}

/** Find first occurence of code point in string.
 *
 * @param str String to search.
 * @param ch  code point to look for.
 *
 * @return Pointer to code point in @a str or NULL if not found.
 */
char *str_chr(const char *str, wchar_t ch)
{
        wchar_t acc;
        size_t off = 0;
        size_t last = 0;

        while ((acc = str_decode(str, &off, STR_NO_LIMIT)) != 0) {
                if (acc == ch)
                        return (char *) (str + last);
                last = off;
        }

        return NULL;
}

/** Insert a code point into a wide string.
 *
 * Insert a code point into a wide string at position
 * @a pos. The code points after the position are shifted.
 *
 * @param str     String to insert to.
 * @param ch      Code point to insert.
 * @param pos     Code point index where to insert.
 * @param max_pos Number of code points that fit in the buffer.
 *
 * @return True if the insertion was sucessful, false if the position
 *         is out of bounds.
 *
 */
bool wstr_linsert(wchar_t *str, wchar_t ch, size_t pos, size_t max_pos)
{
        size_t len = wstr_code_points(str);

        if ((pos > len) || (pos + 1 > max_pos))
                return false;

        size_t i;
        for (i = len; i + 1 > pos; i--)
                str[i + 1] = str[i];

        str[pos] = ch;

        return true;
}

/** Remove a code point from a wide string.
 *
 * Remove a code point from a wide string at position
 * @a pos. The code points after the position are shifted.
 *
 * @param str String to remove from.
 * @param pos Code point index to remove.
 *
 * @return True if the removal was sucessful, false if the position
 *         is out of bounds.
 *
 */
bool wstr_remove(wchar_t *str, size_t pos)
{
        size_t len = wstr_code_points(str);

        if (pos >= len)
                return false;

        size_t i;
        for (i = pos + 1; i <= len; i++)
                str[i - 1] = str[i];

        return true;
}

/** Duplicate string.
 *
 * Allocate a new string and copy the contents of the source string into it.
 * The duplicate string is allocated as if by malloc().
 *
 * If successful, the duplicate string is always a well-formed
 * null-terminated UTF-8 string, but it can differ from the source
 * string on the byte level.
 *
 * @param src Source string.
 *
 * @return Duplicate string, or NULL if allocation failed.
 *
 */
char *str_dup(const char *src)
{
        size_t size = str_bytes(src) + 1;
        char *dest = malloc(size);
        if (!dest)
                return NULL;

        str_cpy(dest, size, src);
        return dest;
}

/** Duplicate string with size limit.
 *
 * Allocate a new string and copy up to @max_size bytes from the source
 * string into it. The duplicate string is allocated as if by malloc().
 * No more than @max_size + 1 bytes is allocated, but if the size
 * occupied by the source string is smaller than @max_size + 1,
 * less is allocated.
 *
 * If successful, the duplicate string is always a well-formed
 * null-terminated UTF-8 string, but it can differ from the source
 * string on the byte level.
 *
 * @param src Source string.
 * @param n   Maximum number of bytes to duplicate.
 *
 * @return Duplicate string.
 *
 */
char *str_ndup(const char *src, size_t n)
{
        size_t size = str_bytes(src);
        if (size > n)
                size = n;

        char *dest = malloc(size + 1);
        if (!dest)
                return NULL;

        str_ncpy(dest, size + 1, src, size);
        return dest;
}

/** Convert string to uint64_t (internal variant).
 *
 * @param nptr   Pointer to string.
 * @param endptr Pointer to the first invalid character is stored here.
 * @param base   Zero or number between 2 and 36 inclusive.
 * @param neg    Indication of unary minus is stored here.
 * @apram result Result of the conversion.
 *
 * @return EOK if conversion was successful.
 *
 */
static errno_t str_uint(const char *nptr, char **endptr, unsigned int base,
    bool *neg, uint64_t *result)
{
        assert(endptr != NULL);
        assert(neg != NULL);
        assert(result != NULL);

        *neg = false;
        const char *str = nptr;

        /* Ignore leading whitespace */
        while (isspace(*str))
                str++;

        if (*str == '-') {
                *neg = true;
                str++;
        } else if (*str == '+')
                str++;

        if (base == 0) {
                /* Decode base if not specified */
                base = 10;

                if (*str == '0') {
                        base = 8;
                        str++;

                        switch (*str) {
                        case 'b':
                        case 'B':
                                base = 2;
                                str++;
                                break;
                        case 'o':
                        case 'O':
                                base = 8;
                                str++;
                                break;
                        case 'd':
                        case 'D':
                        case 't':
                        case 'T':
                                base = 10;
                                str++;
                                break;
                        case 'x':
                        case 'X':
                                base = 16;
                                str++;
                                break;
                        default:
                                str--;
                        }
                }
        } else {
                /* Check base range */
                if ((base < 2) || (base > 36)) {
                        *endptr = (char *) str;
                        return EINVAL;
                }
        }

        *result = 0;
        const char *startstr = str;

        while (*str != 0) {
                unsigned int digit;

                if ((*str >= 'a') && (*str <= 'z'))
                        digit = *str - 'a' + 10;
                else if ((*str >= 'A') && (*str <= 'Z'))
                        digit = *str - 'A' + 10;
                else if ((*str >= '0') && (*str <= '9'))
                        digit = *str - '0';
                else
                        break;

                if (digit >= base)
                        break;

                uint64_t prev = *result;
                *result = (*result) * base + digit;

                if (*result < prev) {
                        /* Overflow */
                        *endptr = (char *) str;
                        return EOVERFLOW;
                }

                str++;
        }

        if (str == startstr) {
                /*
                 * No digits were decoded => first invalid character is
                 * the first character of the string.
                 */
                str = nptr;
        }

        *endptr = (char *) str;

        if (str == nptr)
                return EINVAL;

        return EOK;
}

/** Convert string to uint64_t.
 *
 * @param nptr   Pointer to string.
 * @param endptr If not NULL, pointer to the first invalid character
 *               is stored here.
 * @param base   Zero or number between 2 and 36 inclusive.
 * @param strict Do not allow any trailing characters.
 * @param result Result of the conversion.
 *
 * @return EOK if conversion was successful.
 *
 */
errno_t str_uint64_t(const char *nptr, char **endptr, unsigned int base,
    bool strict, uint64_t *result)
{
        assert(result != NULL);

        bool neg;
        char *lendptr;
        errno_t ret = str_uint(nptr, &lendptr, base, &neg, result);

        if (endptr != NULL)
                *endptr = (char *) lendptr;

        if (ret != EOK)
                return ret;

        /* Do not allow negative values */
        if (neg)
                return EINVAL;

        /*
         * Check whether we are at the end of
         * the string in strict mode
         */
        if ((strict) && (*lendptr != 0))
                return EINVAL;

        return EOK;
}

void order_suffix(const uint64_t val, uint64_t *rv, char *suffix)
{
        if (val > UINT64_C(10000000000000000000)) {
                *rv = val / UINT64_C(1000000000000000000);
                *suffix = 'Z';
        } else if (val > UINT64_C(1000000000000000000)) {
                *rv = val / UINT64_C(1000000000000000);
                *suffix = 'E';
        } else if (val > UINT64_C(1000000000000000)) {
                *rv = val / UINT64_C(1000000000000);
                *suffix = 'T';
        } else if (val > UINT64_C(1000000000000)) {
                *rv = val / UINT64_C(1000000000);
                *suffix = 'G';
        } else if (val > UINT64_C(1000000000)) {
                *rv = val / UINT64_C(1000000);
                *suffix = 'M';
        } else if (val > UINT64_C(1000000)) {
                *rv = val / UINT64_C(1000);
                *suffix = 'k';
        } else {
                *rv = val;
                *suffix = ' ';
        }
}

void bin_order_suffix(const uint64_t val, uint64_t *rv, const char **suffix,
    bool fixed)
{
        if (val > UINT64_C(1152921504606846976)) {
                *rv = val / UINT64_C(1125899906842624);
                *suffix = "EiB";
        } else if (val > UINT64_C(1125899906842624)) {
                *rv = val / UINT64_C(1099511627776);
                *suffix = "TiB";
        } else if (val > UINT64_C(1099511627776)) {
                *rv = val / UINT64_C(1073741824);
                *suffix = "GiB";
        } else if (val > UINT64_C(1073741824)) {
                *rv = val / UINT64_C(1048576);
                *suffix = "MiB";
        } else if (val > UINT64_C(1048576)) {
                *rv = val / UINT64_C(1024);
                *suffix = "KiB";
        } else {
                *rv = val;
                if (fixed)
                        *suffix = "B  ";
                else
                        *suffix = "B";
        }
}

/** @}
 */