Constants.hpp

Go to the documentation of this file.

/**
 * @file Constants.hpp
 * @author Lex Plateau (lexplt.dev@gmail.com)
 * @brief Constants used by ArkScript
 * @date 2020-10-27
 *
 * @copyright Copyright (c) 2020-2025
 *
 */
 
#ifndef INCLUDE_ARK_CONSTANTS_HPP_IN
#define INCLUDE_ARK_CONSTANTS_HPP_IN
 
#include <string_view>
#include <limits>
 
// clang-format off
constexpr int ARK_VERSION_MAJOR = 4;
constexpr int ARK_VERSION_MINOR = 0;
constexpr int ARK_VERSION_PATCH = 0;
// clang-format on
constexpr std::string_view ARK_VERSION { "4.0.0" };
constexpr std::string_view ARK_FULL_VERSION { "4.0.0-093c1714" };
 
#define ARK_COMPILER "AppleClang"
#define ARK_CACHE_DIRNAME "__arkscript__"
#define ARK_NO_NAME_FILE "FILE"
 
#if defined(_WIN32) || defined(_WIN64)
#    define ARK_PLATFORM_NAME "Windows"
#elif defined(__APPLE__) || defined(__MACH__)
#    define ARK_PLATFORM_NAME "Mac OSX"
#elif defined(__linux__)
#    define ARK_PLATFORM_NAME "Linux"
#elif defined(__FreeBSD__)
#    define ARK_PLATFORM_NAME "FreeBSD"
#elif defined(__unix) || defined(__unix__)
#    define ARK_PLATFORM_NAME "Unix"
#else
#    define ARK_PLATFORM_NAME "Other"
#endif
 
#include <cinttypes>
#include <cstddef>
 
#ifdef max
#    undef max
#endif
 
namespace Ark
{
    // Compiler options
    constexpr uint16_t FeatureImportSolver   = 1 << 0;
    constexpr uint16_t FeatureMacroProcessor = 1 << 1;
    constexpr uint16_t FeatureASTOptimizer   = 1 << 2;  ///< This is disabled so that embedding ArkScript does not prune nodes from the AST ; it is active in the `arkscript` executable
    constexpr uint16_t FeatureIROptimizer    = 1 << 3;
    constexpr uint16_t FeatureNameResolver   = 1 << 4;
 
    constexpr uint16_t FeatureDumpIR = 1 << 14;
    /// This feature should only be used in tests, to disable diagnostics generation and enable exceptions to be thrown
    constexpr uint16_t FeatureTestFailOnException = 1 << 15;
 
    // Default features for the VM x Compiler x Parser
    constexpr uint16_t DefaultFeatures =
        FeatureImportSolver
        | FeatureMacroProcessor
        | FeatureIROptimizer
        | FeatureNameResolver;
 
    constexpr uint16_t MaxValue16Bits = std::numeric_limits<uint16_t>::max();
 
    constexpr std::size_t MaxNestedNodes = 1024;           ///< Maximum number of nodes that can be nested while parsing code
    constexpr std::size_t MaxMacroProcessingDepth = 256;   ///< Controls the number of recursive calls to MacroProcessor::processNode
    constexpr std::size_t MaxMacroUnificationDepth = 256;  ///< Controls the number of recursive calls to MacroProcessor::unify
    constexpr std::size_t VMStackSize = 4096;
    constexpr std::size_t VMOverflowBufferSize = 256;                                          ///< Additional number of elements the stack can tolerate
    constexpr std::size_t VMStackSizeWithOverflowBuffer = VMStackSize + VMOverflowBufferSize;  ///< Exceeding VMStackSize, even if we are below VMStackSizeWithOverflowBuffer, means we stack overflowed
    constexpr std::size_t ScopeStackSize = 8192;
}
 
#endif