1/**************************************************************************/
2/* gdscript_lambda_callable.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef GDSCRIPT_LAMBDA_CALLABLE_H
32#define GDSCRIPT_LAMBDA_CALLABLE_H
33
34#include "core/object/ref_counted.h"
35#include "core/templates/vector.h"
36#include "core/variant/callable.h"
37#include "core/variant/variant.h"
38
39class GDScript;
40class GDScriptFunction;
41class GDScriptInstance;
42
43class GDScriptLambdaCallable : public CallableCustom {
44 GDScriptFunction *function = nullptr;
45 Ref<GDScript> script;
46 uint32_t h;
47
48 Vector<Variant> captures;
49
50 static bool compare_equal(const CallableCustom *p_a, const CallableCustom *p_b);
51 static bool compare_less(const CallableCustom *p_a, const CallableCustom *p_b);
52
53public:
54 uint32_t hash() const override;
55 String get_as_text() const override;
56 CompareEqualFunc get_compare_equal_func() const override;
57 CompareLessFunc get_compare_less_func() const override;
58 ObjectID get_object() const override;
59 StringName get_method() const override;
60 void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const override;
61
62 GDScriptLambdaCallable(Ref<GDScript> p_script, GDScriptFunction *p_function, const Vector<Variant> &p_captures);
63 virtual ~GDScriptLambdaCallable() = default;
64};
65
66// Lambda callable that references a particular object, so it can use `self` in the body.
67class GDScriptLambdaSelfCallable : public CallableCustom {
68 GDScriptFunction *function = nullptr;
69 Ref<RefCounted> reference; // For objects that are RefCounted, keep a reference.
70 Object *object = nullptr; // For non RefCounted objects, use a direct pointer.
71 uint32_t h;
72
73 Vector<Variant> captures;
74
75 static bool compare_equal(const CallableCustom *p_a, const CallableCustom *p_b);
76 static bool compare_less(const CallableCustom *p_a, const CallableCustom *p_b);
77
78public:
79 uint32_t hash() const override;
80 String get_as_text() const override;
81 CompareEqualFunc get_compare_equal_func() const override;
82 CompareLessFunc get_compare_less_func() const override;
83 ObjectID get_object() const override;
84 void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const override;
85
86 GDScriptLambdaSelfCallable(Ref<RefCounted> p_self, GDScriptFunction *p_function, const Vector<Variant> &p_captures);
87 GDScriptLambdaSelfCallable(Object *p_self, GDScriptFunction *p_function, const Vector<Variant> &p_captures);
88 virtual ~GDScriptLambdaSelfCallable() = default;
89};
90
91#endif // GDSCRIPT_LAMBDA_CALLABLE_H
92