consoleutils.h

Go to the documentation of this file.

/* 2020-2026 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 herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef QSC_CONSOLEUTILS_H
#define QSC_CONSOLEUTILS_H
 
#include "qsccommon.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_CONSOLE_MAX_LINE 128ULL
 

#define QSC_CONSOLE_STRING_NOT_FOUND -1L

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