UDIF: Universal Digital Identification Framework 1.0.0.0a (A1)
A quantum-secure cryptographic identification
menu.h
Go to the documentation of this file.
1/* 2025 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE: This software and all accompanying materials are the exclusive
5 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
6 * The intellectual and technical concepts contained within this implementation
7 * are proprietary to QRCS and its authorized licensors and are protected under
8 * applicable U.S. and international copyright, patent, and trade secret laws.
9 *
10 * CRYPTOGRAPHIC STANDAARS:
11 * - This software includes implementations of cryptographic algorithms such as
12 * SHA3, AES, and others. These algorithms are public domain or standardized
13 * by organizations such as NIST and are NOT the property of QRCS.
14 * - However, all source code, optimizations, and implementations in this library
15 * are original works of QRCS and are protected under this license.
16 *
17 * RESTRICTIONS:
18 * - Redistribution, modification, or unauthorized distribution of this software,
19 * in whole or in part, is strictly prohibited.
20 * - This software is provided for non-commercial, educational, and research
21 * purposes only. Commercial use in any form is expressly forbidden.
22 * - Licensing and authorized distribution are solely at the discretion of QRCS.
23 * - Any use of this software implies acceptance of these restrictions.
24 *
25 * DISCLAIMER:
26 * This software is provided "as is," without warranty of any kind, express or
27 * implied, including but not limited to warranties of merchantability or fitness
28 * for a particular purpose. QRCS disclaims all liability for any direct, indirect,
29 * incidental, or consequential damages resulting from the use or misuse of this software.
30 *
31 * FULL LICENSE:
32 * This software is subject to the **Quantum Resistant Cryptographic Solutions
33 * Proprietary License (QRCS-PL)**. The complete license terms are included
34 * in the LICENSE.txt file distributed with this software.
35 *
36 * Written by: John G. Underhill
37 * Contact: contact@qrcscorp.ca
38 */
39
40#ifndef UDIF_MENU_H
41#define UDIF_MENU_H
42
43#include "udifcommon.h"
44#include "commands.h"
45
78
88UDIF_EXPORT_API const char* udif_menu_get_prompt(udif_console_modes mode);
89
101UDIF_EXPORT_API void udif_menu_print_error(udif_protocol_errors error, udif_console_modes mode, const char* host);
102
113UDIF_EXPORT_API void udif_menu_print_message(const char* message, udif_console_modes mode, const char* host);
114
126UDIF_EXPORT_API bool udif_menu_print_message_confirm(const char* message, udif_console_modes mode, const char* host);
127
138UDIF_EXPORT_API void udif_menu_print_predefined_message(udif_application_messages msgnum, udif_console_modes mode, const char* host);
139
151UDIF_EXPORT_API bool udif_menu_print_predefined_message_confirm(udif_application_messages msgnum, udif_console_modes mode, const char* host);
152
162UDIF_EXPORT_API void udif_menu_print_prompt(udif_console_modes mode, const char* host);
163
174UDIF_EXPORT_API void udif_menu_print_prompt_text(const char* message, udif_console_modes mode, const char* host);
175
186UDIF_EXPORT_API void udif_menu_print_predefined_text(udif_application_messages msgnum, udif_console_modes mode, const char* host);
187
196UDIF_EXPORT_API void udif_menu_print_text(const char* message);
197
205UDIF_EXPORT_API void udif_menu_print_text_line(const char* message);
206
212UDIF_EXPORT_API void udif_menu_print_prompt_empty(void);
213
214#endif
The UDIF command enumerations.
udif_console_modes
The ARS console modes.
Definition commands.h:331
udif_application_messages
The ARS application messages.
Definition commands.h:73
UDIF_EXPORT_API const char * udif_menu_get_prompt(udif_console_modes mode)
Returns the console prompt string.
Definition menu.c:9
UDIF_EXPORT_API void udif_menu_print_predefined_text(udif_application_messages msgnum, udif_console_modes mode, const char *host)
Print a predefined message with no line terminator.
Definition menu.c:152
UDIF_EXPORT_API void udif_menu_print_text(const char *message)
Print a text string to the console without a newline.
Definition menu.c:89
UDIF_EXPORT_API void udif_menu_print_prompt(udif_console_modes mode, const char *host)
Print the application prompt.
Definition menu.c:163
UDIF_EXPORT_API void udif_menu_print_error(udif_protocol_errors error, udif_console_modes mode, const char *host)
Print an error message to the console.
Definition menu.c:14
UDIF_EXPORT_API void udif_menu_print_prompt_text(const char *message, udif_console_modes mode, const char *host)
Print a prompt and text with no line terminator.
Definition menu.c:73
UDIF_EXPORT_API bool udif_menu_print_message_confirm(const char *message, udif_console_modes mode, const char *host)
Print a message to the console and wait for confirmation.
Definition menu.c:48
UDIF_EXPORT_API void udif_menu_print_text_line(const char *message)
Print a text string to the console with a newline.
Definition menu.c:102
UDIF_EXPORT_API void udif_menu_print_predefined_message(udif_application_messages msgnum, udif_console_modes mode, const char *host)
Print a predefined message to the console.
Definition menu.c:141
UDIF_EXPORT_API bool udif_menu_print_predefined_message_confirm(udif_application_messages msgnum, udif_console_modes mode, const char *host)
Print a predefined message to the console and wait for confirmation.
Definition menu.c:115
UDIF_EXPORT_API void udif_menu_print_message(const char *message, udif_console_modes mode, const char *host)
Print a message to the console.
Definition menu.c:32
UDIF_EXPORT_API void udif_menu_print_prompt_empty(void)
Print the application prompt on an empty line.
Definition menu.c:176
udif_protocol_errors
The UDIF protocol error values.
Definition udif.h:1392