stringutils.h

Go to the documentation of this file.

/* 2025 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE: This software and all accompanying materials are the exclusive 
 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
 * The intellectual and technical concepts contained within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_STRINGUTILS_H
#define QSC_STRINGUTILS_H
 
#include "common.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_STRINGUTILS_TOKEN_NOT_FOUND -1LL

#define QSC_STRINGUTILS_HEX_EXTENSION_SIZE 2ULL

#define QSC_STRINGUTILS_HEX_BYTE_SIZE 2ULL

QSC_EXPORT_API size_t qsc_stringutils_formatting_count(const char* dest, size_t dstlen);

QSC_EXPORT_API size_t qsc_stringutils_formatting_filter(const char* source, size_t srclen, char* dest);

QSC_EXPORT_API size_t qsc_stringutils_add_line_breaks(char* dest, size_t dstlen, size_t linelen, const char* source, size_t srclen);

QSC_EXPORT_API size_t qsc_stringutils_remove_line_breaks(char* dest, size_t dstlen, const char* source, size_t srclen);

QSC_EXPORT_API void qsc_stringutils_clear_string(char* source);

QSC_EXPORT_API void qsc_stringutils_clear_substring(char* dest, size_t length);

QSC_EXPORT_API bool qsc_stringutils_compare_strings(const char* str1, const char* str2, size_t length);

QSC_EXPORT_API size_t qsc_stringutils_concat_strings(char* dest, size_t dstlen, const char* source);

QSC_EXPORT_API size_t qsc_stringutils_concat_and_copy(char* dest, size_t dstlen, const char* str1, const char* str2);

QSC_EXPORT_API size_t qsc_stringutils_copy_substring(char* dest, size_t dstlen, const char* source, size_t srclen);

QSC_EXPORT_API size_t qsc_stringutils_copy_string(char* dest, size_t dstlen, const char* source);

QSC_EXPORT_API int64_t qsc_stringutils_find_char(const char* source, const char token);

QSC_EXPORT_API int64_t qsc_stringutils_find_string(const char* source, const char* token);

QSC_EXPORT_API void qsc_stringutils_byte_to_hex(char* hex, uint8_t input);

QSC_EXPORT_API uint8_t qsc_stringutils_hex_to_byte(const char* hex);

QSC_EXPORT_API int64_t qsc_stringutils_insert_string(char* dest, size_t dstlen, const char* source, size_t offset);

QSC_EXPORT_API bool qsc_stringutils_is_empty(const char* source);

QSC_EXPORT_API bool qsc_stringutils_is_hex(const char* source, size_t srclen);

QSC_EXPORT_API bool qsc_stringutils_is_numeric(const char* source, size_t srclen);

QSC_EXPORT_API char* qsc_stringutils_register_string(char** source, size_t count);

QSC_EXPORT_API size_t qsc_stringutils_remove_null_chars(char* source, size_t srclen);

QSC_EXPORT_API int64_t qsc_stringutils_reverse_find_string(const char* source, const char* token, size_t start);

QSC_EXPORT_API const char* qsc_stringutils_reverse_sub_string(const char* source, const char* token);

bool qsc_stringutils_string_compare(const char* str1, const char* str2, size_t length);

QSC_EXPORT_API int32_t qsc_stringutils_string_comparison(const char* source, const char* token);

QSC_EXPORT_API bool qsc_stringutils_string_contains(const char* source, const char* token);

QSC_EXPORT_API bool qsc_stringutils_strings_equal(const char* str1, const char* str2);

QSC_EXPORT_API char** qsc_stringutils_split_string(char* source, const char* delim, size_t* count);

QSC_EXPORT_API void qsc_stringutils_split_strings(char* dest1, char* dest2, size_t destlen, const char* source, const char* token);

QSC_EXPORT_API char* qsc_stringutils_sub_string(const char* source, const char* token);

QSC_EXPORT_API int32_t qsc_stringutils_string_to_int(const char* source);

QSC_EXPORT_API size_t qsc_stringutils_string_size(const char* source);

QSC_EXPORT_API void qsc_stringutils_int_to_string(int32_t num, char* dest, size_t dstlen);

QSC_EXPORT_API void qsc_stringutils_uint32_to_string(uint32_t num, char* dest, size_t destlen);

QSC_EXPORT_API void qsc_stringutils_int64_to_string(int64_t num, char* dest, size_t dstlen);

QSC_EXPORT_API void qsc_stringutils_uint64_to_string(uint64_t num, char* dest, size_t dstlen);

QSC_EXPORT_API void qsc_stringutils_to_lowercase(char* source);

QSC_EXPORT_API void qsc_stringutils_to_uppercase(char* source);

QSC_EXPORT_API void qsc_stringutils_trim_newline(char* source);

QSC_EXPORT_API void qsc_stringutils_trim_spaces(char* source);

QSC_EXPORT_API size_t qsc_stringutils_whitespace_count(const char* source, size_t srclen);

QSC_EXPORT_API size_t qsc_stringutils_whitespace_filter(const char* source, size_t srclen, char* dest);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif