1/**************************************************************************/
2/* gdscript_utility_functions.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_UTILITY_FUNCTIONS_H
32#define GDSCRIPT_UTILITY_FUNCTIONS_H
33
34#include "core/string/string_name.h"
35#include "core/variant/variant.h"
36
37template <typename T>
38class TypedArray;
39
40class GDScriptUtilityFunctions {
41public:
42 typedef void (*FunctionPtr)(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error);
43
44 static FunctionPtr get_function(const StringName &p_function);
45 static bool has_function_return_value(const StringName &p_function);
46 static Variant::Type get_function_return_type(const StringName &p_function);
47 static StringName get_function_return_class(const StringName &p_function);
48 static Variant::Type get_function_argument_type(const StringName &p_function, int p_arg);
49 static int get_function_argument_count(const StringName &p_function, int p_arg);
50 static bool is_function_vararg(const StringName &p_function);
51 static bool is_function_constant(const StringName &p_function);
52
53 static bool function_exists(const StringName &p_function);
54 static void get_function_list(List<StringName> *r_functions);
55 static MethodInfo get_function_info(const StringName &p_function);
56
57 static void register_functions();
58 static void unregister_functions();
59};
60
61#endif // GDSCRIPT_UTILITY_FUNCTIONS_H
62