diff options
Diffstat (limited to 'core/script_language.h')
| -rw-r--r-- | core/script_language.h | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/core/script_language.h b/core/script_language.h new file mode 100644 index 0000000000..102d7c8436 --- /dev/null +++ b/core/script_language.h @@ -0,0 +1,251 @@ +/*************************************************************************/ +/* script_language.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* http://www.godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ +/* */ +/* 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. */ +/*************************************************************************/ +#ifndef SCRIPT_LANGUAGE_H +#define SCRIPT_LANGUAGE_H + +#include "resource.h" +#include "map.h" +/** + @author Juan Linietsky <reduzio@gmail.com> +*/ + +class ScriptLanguage; + +class ScriptServer { + enum { + + MAX_LANGUAGES=4 + }; + + static ScriptLanguage *_languages[MAX_LANGUAGES]; + static int _language_count; + static bool scripting_enabled; +public: + + static void set_scripting_enabled(bool p_enabled); + static bool is_scripting_enabled(); + static int get_language_count(); + static ScriptLanguage *get_language(int p_idx); + static void register_language(ScriptLanguage *p_language); +}; + + + +class ScriptInstance; +class PlaceHolderScriptInstance; + +class Script : public Resource { + + OBJ_TYPE( Script, Resource ); + OBJ_SAVE_TYPE( Script ); + +protected: + + void _notification( int p_what); + static void _bind_methods(); + +friend class PlaceHolderScriptInstance; + virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {} +public: + + virtual bool can_instance() const=0; + + virtual StringName get_instance_base_type() const=0; // this may not work in all scripts, will return empty if so + virtual ScriptInstance* instance_create(Object *p_this)=0; + virtual bool instance_has(const Object *p_this) const=0; + + virtual bool has_source_code() const=0; + virtual String get_source_code() const=0; + virtual void set_source_code(const String& p_code)=0; + virtual Error reload()=0; + + virtual bool is_tool() const=0; + + virtual String get_node_type() const=0; + + virtual ScriptLanguage *get_language() const=0; + + + Script() {} +}; + +class ScriptInstance { +public: + virtual bool set(const StringName& p_name, const Variant& p_value)=0; + virtual bool get(const StringName& p_name, Variant &r_ret) const=0; + virtual void get_property_list(List<PropertyInfo> *p_properties) const=0; + + virtual void get_method_list(List<MethodInfo> *p_list) const=0; + virtual bool has_method(const StringName& p_method) const=0; + virtual Variant call(const StringName& p_method,VARIANT_ARG_LIST); + virtual Variant call(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error)=0; + virtual void call_multilevel(const StringName& p_method,VARIANT_ARG_LIST); + virtual void call_multilevel(const StringName& p_method,const Variant** p_args,int p_argcount); + virtual void call_multilevel_reversed(const StringName& p_method,const Variant** p_args,int p_argcount); + virtual void notification(int p_notification)=0; + + + virtual Ref<Script> get_script() const=0; + + virtual ScriptLanguage *get_language()=0; + virtual ~ScriptInstance(); +}; + +class ScriptLanguage { +public: + + virtual String get_name() const=0; + + /* LANGUAGE FUNCTIONS */ + virtual void init()=0; + virtual String get_type() const=0; + virtual String get_extension() const=0; + virtual Error execute_file(const String& p_path) =0; + virtual void finish()=0; + + /* EDITOR FUNCTIONS */ + virtual void get_reserved_words(List<String> *p_words) const=0; + virtual void get_comment_delimiters(List<String> *p_delimiters) const=0; + virtual void get_string_delimiters(List<String> *p_delimiters) const=0; + virtual String get_template(const String& p_class_name, const String& p_base_class_name) const=0; + virtual bool validate(const String& p_script, int &r_line_error,int &r_col_error,String& r_test_error, const String& p_path="",List<String> *r_functions=NULL) const=0; + virtual Script *create_script() const=0; + virtual bool has_named_classes() const=0; + virtual int find_function(const String& p_function,const String& p_code) const=0; + virtual String make_function(const String& p_class,const String& p_name,const StringArray& p_args) const=0; + virtual Error complete_keyword(const String& p_code, int p_line, const String& p_base_path, const String& p_keyword, List<String>* r_options) { return ERR_UNAVAILABLE; } + + /* DEBUGGER FUNCTIONS */ + + virtual String debug_get_error() const=0; + virtual int debug_get_stack_level_count() const=0; + virtual int debug_get_stack_level_line(int p_level) const=0; + virtual String debug_get_stack_level_function(int p_level) const=0; + virtual String debug_get_stack_level_source(int p_level) const=0; + virtual void debug_get_stack_level_locals(int p_level,List<String> *p_locals, List<Variant> *p_values, int p_max_subitems=-1,int p_max_depth=-1)=0; + virtual void debug_get_stack_level_members(int p_level,List<String> *p_members, List<Variant> *p_values, int p_max_subitems=-1,int p_max_depth=-1)=0; + virtual void debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems=-1,int p_max_depth=-1)=0; + virtual String debug_parse_stack_level_expression(int p_level,const String& p_expression,int p_max_subitems=-1,int p_max_depth=-1)=0; + + /* LOADER FUNCTIONS */ + + virtual void get_recognized_extensions(List<String> *p_extensions) const=0; + virtual void get_public_functions(List<MethodInfo> *p_functions) const=0; + + virtual void frame(); + + virtual ~ScriptLanguage() {}; +}; + + +class PlaceHolderScriptInstance : public ScriptInstance { + + Object *owner; + List<PropertyInfo> properties; + Map<StringName,Variant> values; + ScriptLanguage *language; + Ref<Script> script; + +public: + virtual bool set(const StringName& p_name, const Variant& p_value); + virtual bool get(const StringName& p_name, Variant &r_ret) const; + virtual void get_property_list(List<PropertyInfo> *p_properties) const; + + virtual void get_method_list(List<MethodInfo> *p_list) const {} + virtual bool has_method(const StringName& p_method) const { return false; } + virtual Variant call(const StringName& p_method,VARIANT_ARG_LIST) { return Variant();} + virtual Variant call(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error) { r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD; return Variant(); } + //virtual void call_multilevel(const StringName& p_method,VARIANT_ARG_LIST) { return Variant(); } + //virtual void call_multilevel(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error) { return Variant(); } + virtual void notification(int p_notification) {} + + + virtual Ref<Script> get_script() const { return script; } + + virtual ScriptLanguage *get_language() { return language; } + + Object *get_owner() { return owner; } + + void update(const List<PropertyInfo> &p_properties,const Map<StringName,Variant>& p_values); //likely changed in editor + + PlaceHolderScriptInstance(ScriptLanguage *p_language, Ref<Script> p_script,Object *p_owner); + ~PlaceHolderScriptInstance(); + + +}; + +class ScriptDebugger { + + int lines_left; + int depth; + + static ScriptDebugger * singleton; + Map<int,Set<StringName> > breakpoints; + + ScriptLanguage *break_lang; +public: + + typedef void (*RequestSceneTreeMessageFunc)(void *); + + _FORCE_INLINE_ static ScriptDebugger * get_singleton() { return singleton; } + void set_lines_left(int p_left); + int get_lines_left() const; + + void set_depth(int p_depth); + int get_depth() const; + + String breakpoint_find_source(const String& p_source) const; + void insert_breakpoint(int p_line, const StringName& p_source); + void remove_breakpoint(int p_line, const StringName& p_source); + bool is_breakpoint(int p_line,const StringName& p_source) const; + bool is_breakpoint_line(int p_line) const; + void clear_breakpoints(); + + virtual void debug(ScriptLanguage *p_script,bool p_can_continue=true)=0; + virtual void idle_poll(); + virtual void line_poll(); + + void set_break_language(ScriptLanguage *p_lang); + ScriptLanguage* get_break_language() const; + + virtual void send_message(const String& p_message, const Array& p_args)=0; + + virtual bool is_remote() const { return false; } + virtual void request_quit() {} + + virtual void set_request_scene_tree_message_func(RequestSceneTreeMessageFunc p_func, void *p_udata) {} + + ScriptDebugger(); + virtual ~ScriptDebugger() {} + +}; + + + +#endif |