shell_status.h

Go to the documentation of this file.

 
#pragma once
 
#include <cinttypes>
#include <iostream>
 
namespace bs {
    constexpr std::size_t SHELL_MAX_DEPTH = 16;
 
    enum class shell_status : std::uint32_t {
        // @section shell Execution Status Codes
 
        SHELL_SUCCESS = 0,
 
        SHELL_ERROR = 1,
 
        SHELL_ERROR_SYNTAX_ERROR,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_SIMPLE_QUOTES,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_DOUBLE_QUOTES,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_BACK_QUOTES,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_PARENTHESES,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_BRACKETS,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_SQR_BRACKETS,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_SUBCOMMAND,
 
        SHELL_ERROR_SYNTAX_ERROR_UNCLOSED_VARIABLE,
 
        SHELL_ERROR_SYNTAX_ERROR_INVALID_VARIABLE_NAME,
 
        SHELL_ERROR_SYNTAX_ERROR_UNEXPECTED_TOKEN,
 
        SHELL_ERROR_SYNTAX_ERROR_UNEXPECTED_EOF,
 
        SHELL_ERROR_SYNTAX_ERROR_ARG_OUT_OF_RANGE,
 
        SHELL_ERROR_SYNTAX_ERROR_EMPTY_BLOCK,
 
        SHELL_ERROR_SYNTAX_ERROR_UNFINISHED_KEYWORD_IF,
 
        SHELL_ERROR_SYNTAX_ERROR_MISSING_KEYWORD_THEN,
 
        SHELL_ERROR_SYNTAX_ERROR_UNFINISHED_KEYWORD_LOOP,
 
        SHELL_ERROR_SYNTAX_ERROR_UNFINISHED_KEYWORD_FOR,
 
        SHELL_ERROR_SYNTAX_ERROR_MISSING_KEYWORD_IN,
 
        SHELL_ERROR_SYNTAX_ERROR_UNFINISHED_KEYWORD_WHILE,
 
        SHELL_ERROR_SYNTAX_ERROR_UNFINISHED_KEYWORD_UNTIL,
 
        SHELL_ERROR_SYNTAX_ERROR_MISSING_KEYWORD_DO,
 
        SHELL_ERROR_SYNTAX_ERROR_INVALID_FUNCTION_NAME,
 
        SHELL_ERROR_SYNTAX_ERROR_INVALID_FUNCTION_BODY,
 
        SHELL_ERROR_BAD_ENCODING,
 
        SHELL_ERROR_COMMAND_NOT_FOUND,
 
        SHELL_ERROR_MAX_DEPTH_REACHED,
 
        // @section command Command Errors
 
        // @section envvar Command getenv, getvar, setenv, setvar errors
 
        SHELL_CMD_ERROR_GETENV_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_GETENV_VARIABLE_NAME_INVALID,
 
        SHELL_CMD_ERROR_GETVAR_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_GETVAR_VARIABLE_NAME_INVALID,
 
        SHELL_CMD_ERROR_SETENV_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_SETENV_VARIABLE_NAME_INVALID,
 
        SHELL_CMD_ERROR_SETVAR_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_SETVAR_VARIABLE_NAME_INVALID,
 
        // @section seq Command seq errors
 
        SHELL_CMD_ERROR_SEQ_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_SEQ_INVALID_INT_FORMAT,
 
        SHELL_CMD_ERROR_SEQ_INT_OUT_OF_BOUNDS,
 
        SHELL_CMD_ERROR_SEQ_ITERATION_LOGIC,
 
        // @section test Command test errors
 
        SHELL_CMD_ERROR_TEST_UNCLOSED_PARENTHESIS,
 
        SHELL_CMD_ERROR_TEST_MALFORMED_EXPRESSION,
 
        SHELL_CMD_ERROR_TEST_MALFORMED_REGEX,
 
        SHELL_CMD_TEST_FALSE,
 
        // @section math Command math errors
 
        SHELL_CMD_ERROR_MATH_NOT_AN_INTEGER,
 
        SHELL_CMD_ERROR_MATH_OVERFLOW,
 
        SHELL_CMD_ERROR_MATH_UNDERFLOW,
 
        SHELL_CMD_ERROR_MATH_DIV_BY_ZERO,
 
        SHELL_CMD_ERROR_MATH_POW_0_EXP_0,
 
        SHELL_CMD_ERROR_MATH_FACTORIAL_NEGATIVE,
 
        SHELL_CMD_ERROR_MATH_MALFORMED_EXPRESSION,
 
        SHELL_CMD_ERROR_MATH_MAX_DEPTH_REACHED,
 
        SHELL_CMD_ERROR_MATH_INVALID_VARIABLE_NAME,
 
        SHELL_CMD_ERROR_MATH_SEQ_ITERATION_LOGIC,
 
        // @section fcall Command fcall errors
 
        SHELL_CMD_ERROR_FCALL_PARAM_NUMBER,
 
        SHELL_CMD_ERROR_FCALL_FUNCTION_NOT_FOUND,
 
        // @section userdef User defined
 
        SHELL_CMD_ERROR = 108,
 
    };
 
    constexpr shell_status make_user_code(const unsigned int nCode) {
        return static_cast<shell_status>(static_cast<int>(shell_status::SHELL_CMD_ERROR) + nCode);
    }
 
    constexpr bool is_syntax_error(const shell_status nStatus) {
        return nStatus >= shell_status::SHELL_ERROR_SYNTAX_ERROR
               && nStatus <= shell_status::SHELL_ERROR_MAX_DEPTH_REACHED;
    }
}