tokens.h

Go to the documentation of this file.

#ifndef __TOKENS_H
#define __TOKENS_H

#include <iosfwd>

#include "../clib/rawtypes.h"
#include "../clib/stlutil.h"

namespace Pol
{
namespace Bscript
{
enum BTokenType : u8
{
  TYP_TERMINATOR = 0x00,
  TYP_OPERAND = 0x01,
  TYP_OPERATOR = 0x02,  // BINARY implied
  TYP_UNARY_OPERATOR = 0x03,
  TYP_LEFTPAREN = 0x04,
  TYP_RIGHTPAREN = 0x05,
  TYP_LEFTBRACKET = 0x06,
  TYP_RIGHTBRACKET = 0x07,

  TYP_TESTMAX = TYP_RIGHTBRACKET,

  TYP_RESERVED = 0x08,

  TYP_LABEL = 0x09,  // a GOTO/GOSUB label

  TYP_FUNC = 0x10,    // func returning something
  TYP_METHOD = 0x1a,  // object method

  TYP_USERFUNC = 0x1b,

  TYP_SEPARATOR = 0x1c,
  TYP_DELIMITER = 0x1d,

  TYP_CONTROL = 0x1e,

  TYP_LEFTBRACE = 0x1f,
  TYP_RIGHTBRACE = 0x20,

  TYP_NUMTYPES = 0x21,
  TYP_FUNCREF = 0x22,
};

inline std::ostream& operator<<( std::ostream& out, const BTokenType& tok )
{
  return out << static_cast<int>( tok );
}

enum BTokenId : u16
{
  // --- LOWER SPACE 0x00-0xFF: TOKENS OUTPUTTED TO THE BYTECODE ---
  TOK_LONG = 0x00,
  TOK_DOUBLE = 0x01,
  TOK_STRING = 0x02,  //  "string literal"

  TOK_IDENT = 0x03,  // variable identifier, i.e. A, AB, A$ */

  TOK_ADD = 0x04,
  TOK_SUBTRACT = 0x05,
  TOK_MULT = 0x06,
  TOK_DIV = 0x07,

  TOK_ASSIGN = 0x08,
  INS_ASSIGN_CONSUME = 0x09,

  TOK_PLUSEQUAL = 0x0a,
  TOK_MINUSEQUAL = 0x0b,
  TOK_TIMESEQUAL = 0x0c,
  TOK_DIVIDEEQUAL = 0x0d,
  TOK_MODULUSEQUAL = 0x0e,
  TOK_INSERTINTO = 0x0f,

  // comparison operators
  TOK_LESSTHAN = 0x10,
  TOK_LESSEQ = 0x11,
  TOK_GRTHAN = 0x12,
  TOK_GREQ = 0x13,

  TOK_AND = 0x14,
  TOK_OR = 0x15,

  // equalite/inequality operators */
  TOK_EQUAL = 0x16,
  TOK_NEQ = 0x17,

  // unary operators
  TOK_UNPLUS = 0x18,
  TOK_UNMINUS = 0x19,
  TOK_LOG_NOT = 0x1a,
  TOK_BITWISE_NOT = 0x1b,

  TOK_CONSUMER = 0x1c,

  TOK_ARRAY_SUBSCRIPT = 0x1d,

  TOK_ADDMEMBER = 0x1e,
  TOK_DELMEMBER = 0x1f,
  TOK_CHKMEMBER = 0x20,

  CTRL_STATEMENTBEGIN = 0x21,
  CTRL_PROGEND = 0x22,
  CTRL_MAKELOCAL = 0x23,
  CTRL_JSR_USERFUNC = 0x24,
  INS_POP_PARAM = 0x25,
  CTRL_LEAVE_BLOCK = 0x26,  // offset is number of variables to remove

  RSV_JMPIFFALSE = 0x27,
  RSV_JMPIFTRUE = 0x28,

  RSV_GOTO = 0x29,
  RSV_RETURN = 0x2a,
  RSV_EXIT = 0x2b,

  RSV_LOCAL = 0x2c,
  RSV_GLOBAL = 0x2d,
  RSV_VAR = 0x2e,

  RSV_FUNCTION = 0x2f,

  INS_DECLARE_ARRAY = 0x30,

  TOK_FUNC = 0x31,
  TOK_USERFUNC = 0x32,
  TOK_ERROR = 0x33,
  TOK_IN = 0x34,
  TOK_LOCALVAR = 0x35,
  TOK_GLOBALVAR = 0x36,
  INS_INITFOREACH = 0x37,
  INS_STEPFOREACH = 0x38,
  INS_CASEJMP = 0x39,
  INS_GET_ARG = 0x3a,
  TOK_ARRAY = 0x3b,

  INS_CALL_METHOD = 0x3c,

  TOK_DICTIONARY = 0x3d,
  TOK_STACK = 0x3e,
  INS_INITFOR = 0x3f,
  INS_NEXTFOR = 0x40,
  TOK_REFTO = 0x41,
  INS_POP_PARAM_BYREF = 0x42,
  TOK_MODULUS = 0x43,

  TOK_BSLEFT = 0x44,
  TOK_BSRIGHT = 0x45,
  TOK_BITAND = 0x46,
  TOK_BITOR = 0x47,
  TOK_BITXOR = 0x48,

  TOK_STRUCT = 0x49,
  INS_SUBSCRIPT_ASSIGN = 0x4a,
  INS_SUBSCRIPT_ASSIGN_CONSUME = 0x4b,
  INS_MULTISUBSCRIPT = 0x4c,
  INS_MULTISUBSCRIPT_ASSIGN = 0x4d,
  INS_ASSIGN_LOCALVAR = 0x4e,
  INS_ASSIGN_GLOBALVAR = 0x4f,

  INS_GET_MEMBER = 0x50,
  INS_SET_MEMBER = 0x51,
  INS_SET_MEMBER_CONSUME = 0x52,

  INS_ADDMEMBER2 = 0x53,
  INS_ADDMEMBER_ASSIGN = 0x54,
  INS_UNINIT = 0x55,
  INS_DICTIONARY_ADDMEMBER = 0x56,

  INS_GET_MEMBER_ID = 0x57,
  INS_SET_MEMBER_ID = 0x58,
  INS_SET_MEMBER_ID_CONSUME = 0x59,
  INS_CALL_METHOD_ID = 0x5a,

  TOK_EQUAL1 = 0x5b,

  INS_SET_MEMBER_ID_CONSUME_PLUSEQUAL = 0x5c,
  INS_SET_MEMBER_ID_CONSUME_MINUSEQUAL = 0x5d,
  INS_SET_MEMBER_ID_CONSUME_TIMESEQUAL = 0x5e,
  INS_SET_MEMBER_ID_CONSUME_DIVIDEEQUAL = 0x5f,
  INS_SET_MEMBER_ID_CONSUME_MODULUSEQUAL = 0x60,

  TOK_FUNCREF = 0x61,

  // --- UPPER SPACE 0x0100-0xFFFF: TOKENS THAT AREN'T PART OF EMITTED CODE ---
  //
  // these can be safely renumbered any time, but must start from 0x100

  TOK_SEMICOLON = 0x100,
  TOK_COMMA,
  TOK_LPAREN,
  TOK_RPAREN,
  TOK_TERM,  // terminator, ';', etc.
  TOK_LBRACKET,
  TOK_RBRACKET,
  TOK_LBRACE,
  TOK_RBRACE,

  RSV_FOREACH,
  RSV_ENDFOREACH,  // RSV_IN: use TOK_IN

  RSV_DECLARE,
  RSV_FUTURE,
  RSV_BREAK,
  RSV_CONTINUE,
  RSV_USE_MODULE,
  RSV_INCLUDE_FILE,

  RSV_FOR,
  RSV_NEXT,
  RSV_TO,
  RSV_STEP,
  RSV_THEN,
  RSV_ST_IF,
  RSV_ELSE,
  RSV_ELSEIF,
  RSV_ENDIF,
  RSV_GOSUB,
  RSV_BEGIN,
  RSV_ENDB,
  RSV_DO,
  RSV_WHILE,
  RSV_OPTION_BRACKETED,

  CTRL_LABEL,  // LABEL:
  CTRL_NOTHING,
  RSV_CONST,
  RSV_ENDWHILE,
  RSV_REPEAT,
  RSV_UNTIL,
  RSV_ENDFOR,
  RSV_ENDFUNCTION,

  RSV_SWITCH,
  RSV_CASE,
  RSV_DEFAULT,
  RSV_ENDSWITCH,

  RSV_COLON,
  RSV_PROGRAM,
  RSV_ENDPROGRAM,
  RSV_ENUM,
  RSV_ENDENUM,
  RSV_EXPORTED,
  TOK_MEMBER,
  TOK_DICTKEY,
  RSV_DOWHILE,

  TOK_UNUSED,
};

inline std::ostream& operator<<( std::ostream& out, const BTokenId& tok )
{
  return out << static_cast<int>( tok );
}

enum ESCRIPT_CASE_TYPES : u8
{
  CASE_TYPE_LONG = 255,
  CASE_TYPE_DEFAULT = 254,
  CASE_STRING_MAXLEN = 253
};
}

namespace Clib
{
template <>
std::string tostring( const Bscript::BTokenType& v );
template <>
std::string tostring( const Bscript::BTokenId& v );
}
}
#endif