consoleutils.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_CONSOLEUTILS_H
#define QSC_CONSOLEUTILS_H
 
#include "common.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_CONSOLE_MAX_LINE 128ULL

typedef enum
{
    white = 0x00U,     
    blue = 0x01U,       
    green = 0x02U,     
    red = 0x03U          
} qsc_console_font_color;

typedef enum
{
    regular = 0x00U,    
    bold = 0x01U,       
    italic = 0x02U,     
    bolditalic = 0x03U  
} qsc_console_font_style;

QSC_EXPORT_API void qsc_consoleutils_colored_message(const char* message, qsc_console_font_color color);

QSC_EXPORT_API char qsc_consoleutils_get_char(void);

QSC_EXPORT_API size_t qsc_consoleutils_get_formatted_line(char* line, size_t maxlen);

QSC_EXPORT_API size_t qsc_consoleutils_get_line(char* line, size_t maxlen);

QSC_EXPORT_API size_t qsc_consoleutils_get_quoted_string(char* output, const char* input, size_t maxlen);

QSC_EXPORT_API char qsc_consoleutils_get_wait(void);

QSC_EXPORT_API void qsc_consoleutils_hex_to_bin(const char* hexstr, uint8_t* output, size_t length);

QSC_EXPORT_API bool qsc_consoleutils_line_contains(const char* line, const char* token);

QSC_EXPORT_API bool qsc_consoleutils_line_equals(const char* line1, const char* line2);

QSC_EXPORT_API size_t qsc_consoleutils_masked_password(char* output, size_t otplen);

QSC_EXPORT_API bool qsc_consoleutils_message_confirm(const char* message);

QSC_EXPORT_API void qsc_consoleutils_print_array(const uint8_t* input, size_t inplen, size_t linelen);

QSC_EXPORT_API void qsc_consoleutils_print_hex(const uint8_t* input, size_t inplen, size_t linelen);

QSC_EXPORT_API void qsc_consoleutils_print_formatted(const char* input, size_t inplen);

QSC_EXPORT_API void qsc_consoleutils_print_formatted_line(const char* input, size_t inplen);

QSC_EXPORT_API void qsc_consoleutils_print_safe(const char* input);

QSC_EXPORT_API void qsc_consoleutils_print_line(const char* input);

QSC_EXPORT_API void qsc_consoleutils_print_uint(uint32_t digit);

QSC_EXPORT_API void qsc_consoleutils_print_ulong(uint64_t digit);

QSC_EXPORT_API void qsc_consoleutils_print_double(double digit);

QSC_EXPORT_API void qsc_consoleutils_print_concatenated_line(const char** input, size_t count);

QSC_EXPORT_API void qsc_consoleutils_progress_counter(int32_t seconds);

QSC_EXPORT_API void qsc_consoleutils_send_enter(void);

QSC_EXPORT_API void qsc_consoleutils_set_window_buffer(size_t width, size_t height);

QSC_EXPORT_API void qsc_consoleutils_set_window_clear(void);

QSC_EXPORT_API void qsc_consoleutils_set_window_prompt(const char* prompt);

QSC_EXPORT_API void qsc_consoleutils_set_window_size(size_t width, size_t height);

QSC_EXPORT_API void qsc_consoleutils_set_window_title(const char* title);

QSC_EXPORT_API void qsc_consoleutils_set_virtual_terminal(void);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif