hxconsole.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
 
#if HX_USE_CONSOLE
#if !(HX_USE_MACROS_WITH_MODULE)
 
#include <limits.h>
#include "hxutility.h"
 
HX_NS_BEGIN_
 
// Include internals
#include "detail/hxconsole_detail.hpp"

void hxconsole_deregister(const char* id_) hxattr_nonnull(1);

bool hxconsole_exec_line(const char* command_) hxattr_nonnull(1);

bool hxconsole_help(void);
 
#if HX_USE_FILE_IO
class hxfile;
bool hxconsole_exec_file(hxfile& file_);

bool hxconsole_exec_filename(const char* filename_) hxattr_nonnull(1);
#endif // HX_USE_FILE_IO
 
HX_NS_END_
#endif // !HX_USE_MACROS_WITH_MODULE

#define hxconsole_command(x_) static HX_NS_PREFIX_ hxdetail_::hxconsole_constructor_ \
    hxg_console_symbol_##x_(HX_NS_PREFIX_ hxdetail_::hxconsole_command_factory_(&(x_)), #x_)

#define hxconsole_command_named(x_, name_) static HX_NS_PREFIX_ hxdetail_::hxconsole_constructor_ \
    hxg_console_symbol_##name_(HX_NS_PREFIX_ hxdetail_::hxconsole_command_factory_(&(x_)), #name_)

#define hxconsole_variable(x_) static HX_NS_PREFIX_ hxdetail_::hxconsole_constructor_ \
    hxg_console_symbol_##x_(HX_NS_PREFIX_ hxdetail_::hxconsole_variable_factory_(&(x_)), #x_)

#define hxconsole_variable_named(x_, name_) static HX_NS_PREFIX_ hxdetail_::hxconsole_constructor_ \
    hxg_console_symbol_##name_(HX_NS_PREFIX_ hxdetail_::hxconsole_variable_factory_(&(x_)), #name_)
 
#else // !HX_USE_CONSOLE
 
// Avoid complaints about stray ; at global scope.
#define hxconsole_command(x_) static_assert(true, "")
#define hxconsole_command_named(x_, name_) static_assert(true, "")
#define hxconsole_variable(x_) static_assert(true, "")
#define hxconsole_variable_named(x_, name_) static_assert(true, "")
 
#endif // !HX_USE_CONSOLE