2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2017-11-16 18:38:18 +01:00
|
|
|
/* gdscript_tokenizer.h */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-01-01 11:16:22 +01:00
|
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
#ifndef GDSCRIPT_TOKENIZER_H
|
|
|
|
#define GDSCRIPT_TOKENIZER_H
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2018-07-01 18:17:40 +02:00
|
|
|
#include "core/pair.h"
|
2020-04-14 05:05:21 +02:00
|
|
|
#include "core/set.h"
|
2019-02-12 13:30:56 +01:00
|
|
|
#include "core/string_name.h"
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/ustring.h"
|
|
|
|
#include "core/variant.h"
|
|
|
|
#include "core/vmap.h"
|
2017-11-16 18:38:18 +01:00
|
|
|
#include "gdscript_functions.h"
|
2014-02-25 13:31:47 +01:00
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
class GDScriptTokenizer {
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
|
|
|
enum Token {
|
|
|
|
|
|
|
|
TK_EMPTY,
|
|
|
|
TK_IDENTIFIER,
|
|
|
|
TK_CONSTANT,
|
|
|
|
TK_SELF,
|
|
|
|
TK_BUILT_IN_TYPE,
|
|
|
|
TK_BUILT_IN_FUNC,
|
|
|
|
TK_OP_IN,
|
|
|
|
TK_OP_EQUAL,
|
|
|
|
TK_OP_NOT_EQUAL,
|
|
|
|
TK_OP_LESS,
|
|
|
|
TK_OP_LESS_EQUAL,
|
|
|
|
TK_OP_GREATER,
|
|
|
|
TK_OP_GREATER_EQUAL,
|
|
|
|
TK_OP_AND,
|
|
|
|
TK_OP_OR,
|
|
|
|
TK_OP_NOT,
|
|
|
|
TK_OP_ADD,
|
|
|
|
TK_OP_SUB,
|
|
|
|
TK_OP_MUL,
|
|
|
|
TK_OP_DIV,
|
|
|
|
TK_OP_MOD,
|
|
|
|
TK_OP_SHIFT_LEFT,
|
|
|
|
TK_OP_SHIFT_RIGHT,
|
|
|
|
TK_OP_ASSIGN,
|
|
|
|
TK_OP_ASSIGN_ADD,
|
|
|
|
TK_OP_ASSIGN_SUB,
|
|
|
|
TK_OP_ASSIGN_MUL,
|
|
|
|
TK_OP_ASSIGN_DIV,
|
|
|
|
TK_OP_ASSIGN_MOD,
|
|
|
|
TK_OP_ASSIGN_SHIFT_LEFT,
|
|
|
|
TK_OP_ASSIGN_SHIFT_RIGHT,
|
|
|
|
TK_OP_ASSIGN_BIT_AND,
|
|
|
|
TK_OP_ASSIGN_BIT_OR,
|
|
|
|
TK_OP_ASSIGN_BIT_XOR,
|
|
|
|
TK_OP_BIT_AND,
|
|
|
|
TK_OP_BIT_OR,
|
|
|
|
TK_OP_BIT_XOR,
|
|
|
|
TK_OP_BIT_INVERT,
|
|
|
|
//TK_OP_PLUS_PLUS,
|
|
|
|
//TK_OP_MINUS_MINUS,
|
|
|
|
TK_CF_IF,
|
|
|
|
TK_CF_ELIF,
|
|
|
|
TK_CF_ELSE,
|
|
|
|
TK_CF_FOR,
|
|
|
|
TK_CF_WHILE,
|
|
|
|
TK_CF_BREAK,
|
|
|
|
TK_CF_CONTINUE,
|
|
|
|
TK_CF_PASS,
|
|
|
|
TK_CF_RETURN,
|
2016-09-30 21:40:31 +02:00
|
|
|
TK_CF_MATCH,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_PR_FUNCTION,
|
|
|
|
TK_PR_CLASS,
|
2018-07-16 00:29:00 +02:00
|
|
|
TK_PR_CLASS_NAME,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_PR_EXTENDS,
|
2017-05-26 19:45:39 +02:00
|
|
|
TK_PR_IS,
|
2015-12-28 23:31:52 +01:00
|
|
|
TK_PR_ONREADY,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_PR_TOOL,
|
|
|
|
TK_PR_STATIC,
|
|
|
|
TK_PR_EXPORT,
|
2014-10-28 02:54:32 +01:00
|
|
|
TK_PR_SETGET,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_PR_CONST,
|
|
|
|
TK_PR_VAR,
|
2018-05-30 04:16:51 +02:00
|
|
|
TK_PR_AS,
|
|
|
|
TK_PR_VOID,
|
2016-08-26 13:15:45 +02:00
|
|
|
TK_PR_ENUM,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_PR_PRELOAD,
|
|
|
|
TK_PR_ASSERT,
|
2014-09-15 16:33:30 +02:00
|
|
|
TK_PR_YIELD,
|
2015-06-24 18:29:23 +02:00
|
|
|
TK_PR_SIGNAL,
|
2015-12-29 16:11:21 +01:00
|
|
|
TK_PR_BREAKPOINT,
|
2016-08-19 21:48:08 +02:00
|
|
|
TK_PR_REMOTE,
|
|
|
|
TK_PR_MASTER,
|
2018-09-14 21:59:47 +02:00
|
|
|
TK_PR_PUPPET,
|
2018-05-26 10:30:36 +02:00
|
|
|
TK_PR_REMOTESYNC,
|
|
|
|
TK_PR_MASTERSYNC,
|
2018-09-14 21:59:47 +02:00
|
|
|
TK_PR_PUPPETSYNC,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_BRACKET_OPEN,
|
|
|
|
TK_BRACKET_CLOSE,
|
|
|
|
TK_CURLY_BRACKET_OPEN,
|
|
|
|
TK_CURLY_BRACKET_CLOSE,
|
|
|
|
TK_PARENTHESIS_OPEN,
|
|
|
|
TK_PARENTHESIS_CLOSE,
|
|
|
|
TK_COMMA,
|
|
|
|
TK_SEMICOLON,
|
|
|
|
TK_PERIOD,
|
|
|
|
TK_QUESTION_MARK,
|
|
|
|
TK_COLON,
|
2017-01-08 06:04:53 +01:00
|
|
|
TK_DOLLAR,
|
2018-05-30 04:16:51 +02:00
|
|
|
TK_FORWARD_ARROW,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_NEWLINE,
|
2016-01-02 21:56:45 +01:00
|
|
|
TK_CONST_PI,
|
2017-11-04 10:34:27 +01:00
|
|
|
TK_CONST_TAU,
|
2017-01-20 09:25:15 +01:00
|
|
|
TK_WILDCARD,
|
2017-02-06 23:44:22 +01:00
|
|
|
TK_CONST_INF,
|
|
|
|
TK_CONST_NAN,
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_ERROR,
|
|
|
|
TK_EOF,
|
2014-12-17 02:31:57 +01:00
|
|
|
TK_CURSOR, //used for code completion
|
2014-02-10 02:10:30 +01:00
|
|
|
TK_MAX
|
|
|
|
};
|
|
|
|
|
2014-02-25 13:31:47 +01:00
|
|
|
protected:
|
2014-11-02 15:31:01 +01:00
|
|
|
enum StringMode {
|
|
|
|
STRING_SINGLE_QUOTE,
|
|
|
|
STRING_DOUBLE_QUOTE,
|
|
|
|
STRING_MULTILINE
|
|
|
|
};
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
static const char *token_names[TK_MAX];
|
|
|
|
|
2014-02-25 13:31:47 +01:00
|
|
|
public:
|
|
|
|
static const char *get_token_name(Token p_token);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-31 19:28:34 +02:00
|
|
|
bool is_token_literal(int p_offset = 0, bool variable_safe = false) const;
|
|
|
|
StringName get_token_literal(int p_offset = 0) const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual const Variant &get_token_constant(int p_offset = 0) const = 0;
|
|
|
|
virtual Token get_token(int p_offset = 0) const = 0;
|
|
|
|
virtual StringName get_token_identifier(int p_offset = 0) const = 0;
|
2017-11-16 18:38:18 +01:00
|
|
|
virtual GDScriptFunctions::Function get_token_built_in_func(int p_offset = 0) const = 0;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual Variant::Type get_token_type(int p_offset = 0) const = 0;
|
|
|
|
virtual int get_token_line(int p_offset = 0) const = 0;
|
|
|
|
virtual int get_token_column(int p_offset = 0) const = 0;
|
|
|
|
virtual int get_token_line_indent(int p_offset = 0) const = 0;
|
2019-10-13 21:48:18 +02:00
|
|
|
virtual int get_token_line_tab_indent(int p_offset = 0) const = 0;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual String get_token_error(int p_offset = 0) const = 0;
|
|
|
|
virtual void advance(int p_amount = 1) = 0;
|
2018-07-01 18:17:40 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2020-03-17 07:33:00 +01:00
|
|
|
virtual const Vector<Pair<int, String>> &get_warning_skips() const = 0;
|
2018-07-01 18:17:40 +02:00
|
|
|
virtual const Set<String> &get_warning_global_skips() const = 0;
|
2019-02-21 20:24:29 +01:00
|
|
|
virtual bool is_ignoring_warnings() const = 0;
|
2018-07-01 18:17:40 +02:00
|
|
|
#endif // DEBUG_ENABLED
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
virtual ~GDScriptTokenizer(){};
|
2014-02-25 13:31:47 +01:00
|
|
|
};
|
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
class GDScriptTokenizerText : public GDScriptTokenizer {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
enum {
|
2017-03-05 16:44:50 +01:00
|
|
|
MAX_LOOKAHEAD = 4,
|
|
|
|
TK_RB_SIZE = MAX_LOOKAHEAD * 2 + 1
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
struct TokenData {
|
|
|
|
Token type;
|
|
|
|
StringName identifier; //for identifier types
|
|
|
|
Variant constant; //for constant types
|
|
|
|
union {
|
|
|
|
Variant::Type vtype; //for type types
|
2017-11-16 18:38:18 +01:00
|
|
|
GDScriptFunctions::Function func; //function for built in functions
|
2018-07-01 18:17:40 +02:00
|
|
|
int warning_code; //for warning skip
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
2017-03-05 16:44:50 +01:00
|
|
|
int line, col;
|
|
|
|
TokenData() {
|
|
|
|
type = TK_EMPTY;
|
|
|
|
line = col = 0;
|
|
|
|
vtype = Variant::NIL;
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
void _make_token(Token p_type);
|
2019-10-13 21:48:18 +02:00
|
|
|
void _make_newline(int p_indentation = 0, int p_tabs = 0);
|
2017-03-05 16:44:50 +01:00
|
|
|
void _make_identifier(const StringName &p_identifier);
|
2017-11-16 18:38:18 +01:00
|
|
|
void _make_built_in_func(GDScriptFunctions::Function p_func);
|
2017-03-05 16:44:50 +01:00
|
|
|
void _make_constant(const Variant &p_constant);
|
|
|
|
void _make_type(const Variant::Type &p_type);
|
|
|
|
void _make_error(const String &p_error);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
String code;
|
|
|
|
int len;
|
|
|
|
int code_pos;
|
|
|
|
const CharType *_code;
|
|
|
|
int line;
|
|
|
|
int column;
|
2017-03-05 16:44:50 +01:00
|
|
|
TokenData tk_rb[TK_RB_SIZE * 2 + 1];
|
2014-02-10 02:10:30 +01:00
|
|
|
int tk_rb_pos;
|
|
|
|
String last_error;
|
|
|
|
bool error_flag;
|
2019-07-26 20:24:34 +02:00
|
|
|
|
2018-07-01 18:17:40 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2020-03-17 07:33:00 +01:00
|
|
|
Vector<Pair<int, String>> warning_skips;
|
2018-07-01 18:17:40 +02:00
|
|
|
Set<String> warning_global_skips;
|
|
|
|
bool ignore_warnings;
|
|
|
|
#endif // DEBUG_ENABLED
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void _advance();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
|
|
|
void set_code(const String &p_code);
|
|
|
|
virtual Token get_token(int p_offset = 0) const;
|
|
|
|
virtual StringName get_token_identifier(int p_offset = 0) const;
|
2017-11-16 18:38:18 +01:00
|
|
|
virtual GDScriptFunctions::Function get_token_built_in_func(int p_offset = 0) const;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual Variant::Type get_token_type(int p_offset = 0) const;
|
|
|
|
virtual int get_token_line(int p_offset = 0) const;
|
|
|
|
virtual int get_token_column(int p_offset = 0) const;
|
|
|
|
virtual int get_token_line_indent(int p_offset = 0) const;
|
2019-10-13 21:48:18 +02:00
|
|
|
virtual int get_token_line_tab_indent(int p_offset = 0) const;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual const Variant &get_token_constant(int p_offset = 0) const;
|
|
|
|
virtual String get_token_error(int p_offset = 0) const;
|
|
|
|
virtual void advance(int p_amount = 1);
|
2018-07-01 18:17:40 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2020-03-17 07:33:00 +01:00
|
|
|
virtual const Vector<Pair<int, String>> &get_warning_skips() const { return warning_skips; }
|
2018-07-01 18:17:40 +02:00
|
|
|
virtual const Set<String> &get_warning_global_skips() const { return warning_global_skips; }
|
2019-02-21 20:24:29 +01:00
|
|
|
virtual bool is_ignoring_warnings() const { return ignore_warnings; }
|
2018-07-01 18:17:40 +02:00
|
|
|
#endif // DEBUG_ENABLED
|
2014-02-25 13:31:47 +01:00
|
|
|
};
|
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
class GDScriptTokenizerBuffer : public GDScriptTokenizer {
|
2014-02-25 13:31:47 +01:00
|
|
|
|
|
|
|
enum {
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
TOKEN_BYTE_MASK = 0x80,
|
|
|
|
TOKEN_BITS = 8,
|
|
|
|
TOKEN_MASK = (1 << TOKEN_BITS) - 1,
|
|
|
|
TOKEN_LINE_BITS = 24,
|
|
|
|
TOKEN_LINE_MASK = (1 << TOKEN_LINE_BITS) - 1,
|
2014-02-25 13:31:47 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
Vector<StringName> identifiers;
|
|
|
|
Vector<Variant> constants;
|
2017-03-05 16:44:50 +01:00
|
|
|
VMap<uint32_t, uint32_t> lines;
|
2014-02-25 13:31:47 +01:00
|
|
|
Vector<uint32_t> tokens;
|
|
|
|
Variant nil;
|
|
|
|
int token;
|
|
|
|
|
|
|
|
public:
|
2017-03-05 16:44:50 +01:00
|
|
|
Error set_code_buffer(const Vector<uint8_t> &p_buffer);
|
|
|
|
static Vector<uint8_t> parse_code_string(const String &p_code);
|
|
|
|
virtual Token get_token(int p_offset = 0) const;
|
|
|
|
virtual StringName get_token_identifier(int p_offset = 0) const;
|
2017-11-16 18:38:18 +01:00
|
|
|
virtual GDScriptFunctions::Function get_token_built_in_func(int p_offset = 0) const;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual Variant::Type get_token_type(int p_offset = 0) const;
|
|
|
|
virtual int get_token_line(int p_offset = 0) const;
|
|
|
|
virtual int get_token_column(int p_offset = 0) const;
|
|
|
|
virtual int get_token_line_indent(int p_offset = 0) const;
|
2019-10-13 21:48:18 +02:00
|
|
|
virtual int get_token_line_tab_indent(int p_offset = 0) const { return 0; }
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual const Variant &get_token_constant(int p_offset = 0) const;
|
|
|
|
virtual String get_token_error(int p_offset = 0) const;
|
|
|
|
virtual void advance(int p_amount = 1);
|
2018-07-01 18:17:40 +02:00
|
|
|
#ifdef DEBUG_ENABLED
|
2020-03-17 07:33:00 +01:00
|
|
|
virtual const Vector<Pair<int, String>> &get_warning_skips() const {
|
|
|
|
static Vector<Pair<int, String>> v;
|
2018-08-21 18:54:52 +02:00
|
|
|
return v;
|
|
|
|
}
|
|
|
|
virtual const Set<String> &get_warning_global_skips() const {
|
|
|
|
static Set<String> s;
|
|
|
|
return s;
|
|
|
|
}
|
2019-02-21 20:24:29 +01:00
|
|
|
virtual bool is_ignoring_warnings() const { return true; }
|
2018-07-01 18:17:40 +02:00
|
|
|
#endif // DEBUG_ENABLED
|
2017-11-16 18:38:18 +01:00
|
|
|
GDScriptTokenizerBuffer();
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2017-11-16 18:38:18 +01:00
|
|
|
#endif // GDSCRIPT_TOKENIZER_H
|