44d62a9f4b
* Allows calling into native extensions directly with a pointer * Makes it easier to implement some APIs more efficiently * Appears with a "*" in the documentation for the argument. * Implementing the pointer handling is entirely up to the implementation, although the extension API provides some hint. * AudioStream has been implemented as an example, allowing to create NativeExtension based AudioStreams.
131 lines
5.7 KiB
C++
131 lines
5.7 KiB
C++
/*************************************************************************/
|
|
/* native_ptr.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 NATIVE_PTR_H
|
|
#define NATIVE_PTR_H
|
|
|
|
#include "core/math/audio_frame.h"
|
|
#include "core/variant/method_ptrcall.h"
|
|
#include "core/variant/type_info.h"
|
|
|
|
template <class T>
|
|
struct GDNativeConstPtr {
|
|
const T *data = nullptr;
|
|
GDNativeConstPtr(const T *p_assign) { data = p_assign; }
|
|
static const char *get_name() { return "const void"; }
|
|
operator const T *() const { return data; }
|
|
operator Variant() const { return uint64_t(data); }
|
|
};
|
|
|
|
template <class T>
|
|
struct GDNativePtr {
|
|
T *data = nullptr;
|
|
GDNativePtr(T *p_assign) { data = p_assign; }
|
|
static const char *get_name() { return "void"; }
|
|
operator T *() const { return data; }
|
|
operator Variant() const { return uint64_t(data); }
|
|
};
|
|
|
|
#define GDVIRTUAL_NATIVE_PTR(m_type) \
|
|
template <> \
|
|
struct GDNativeConstPtr<m_type> { \
|
|
const m_type *data = nullptr; \
|
|
GDNativeConstPtr(const m_type *p_assign) { data = p_assign; } \
|
|
static const char *get_name() { return "const " #m_type; } \
|
|
operator const m_type *() const { return data; } \
|
|
operator Variant() const { return uint64_t(data); } \
|
|
}; \
|
|
template <> \
|
|
struct GDNativePtr<m_type> { \
|
|
m_type *data = nullptr; \
|
|
GDNativePtr(m_type *p_assign) { data = p_assign; } \
|
|
static const char *get_name() { return #m_type; } \
|
|
operator m_type *() const { return data; } \
|
|
operator Variant() const { return uint64_t(data); } \
|
|
};
|
|
|
|
template <class T>
|
|
struct GetTypeInfo<GDNativeConstPtr<T>> {
|
|
static const Variant::Type VARIANT_TYPE = Variant::NIL;
|
|
static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
|
|
static inline PropertyInfo get_class_info() {
|
|
return PropertyInfo(Variant::INT, String(), PROPERTY_HINT_INT_IS_POINTER, GDNativeConstPtr<T>::get_name());
|
|
}
|
|
};
|
|
|
|
template <class T>
|
|
struct GetTypeInfo<GDNativePtr<T>> {
|
|
static const Variant::Type VARIANT_TYPE = Variant::NIL;
|
|
static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
|
|
static inline PropertyInfo get_class_info() {
|
|
return PropertyInfo(Variant::INT, String(), PROPERTY_HINT_INT_IS_POINTER, GDNativePtr<T>::get_name());
|
|
}
|
|
};
|
|
|
|
template <class T>
|
|
struct PtrToArg<GDNativeConstPtr<T>> {
|
|
_FORCE_INLINE_ static GDNativeConstPtr<T> convert(const void *p_ptr) {
|
|
return GDNativeConstPtr<T>(reinterpret_cast<const T *>(p_ptr));
|
|
}
|
|
typedef const T *EncodeT;
|
|
_FORCE_INLINE_ static void encode(GDNativeConstPtr<T> p_val, void *p_ptr) {
|
|
*((const T **)p_ptr) = p_val.data;
|
|
}
|
|
};
|
|
template <class T>
|
|
struct PtrToArg<GDNativePtr<T>> {
|
|
_FORCE_INLINE_ static GDNativePtr<T> convert(const void *p_ptr) {
|
|
return GDNativePtr<T>(reinterpret_cast<const T *>(p_ptr));
|
|
}
|
|
typedef T *EncodeT;
|
|
_FORCE_INLINE_ static void encode(GDNativePtr<T> p_val, void *p_ptr) {
|
|
*((T **)p_ptr) = p_val.data;
|
|
}
|
|
};
|
|
|
|
GDVIRTUAL_NATIVE_PTR(AudioFrame)
|
|
GDVIRTUAL_NATIVE_PTR(bool)
|
|
GDVIRTUAL_NATIVE_PTR(char)
|
|
GDVIRTUAL_NATIVE_PTR(char16_t)
|
|
GDVIRTUAL_NATIVE_PTR(char32_t)
|
|
GDVIRTUAL_NATIVE_PTR(wchar_t)
|
|
GDVIRTUAL_NATIVE_PTR(uint8_t)
|
|
GDVIRTUAL_NATIVE_PTR(int8_t)
|
|
GDVIRTUAL_NATIVE_PTR(uint16_t)
|
|
GDVIRTUAL_NATIVE_PTR(int16_t)
|
|
GDVIRTUAL_NATIVE_PTR(uint32_t)
|
|
GDVIRTUAL_NATIVE_PTR(int32_t)
|
|
GDVIRTUAL_NATIVE_PTR(int64_t)
|
|
GDVIRTUAL_NATIVE_PTR(uint64_t)
|
|
GDVIRTUAL_NATIVE_PTR(float)
|
|
GDVIRTUAL_NATIVE_PTR(double)
|
|
|
|
#endif // NATIVE_PTR_H
|