Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Godot iOS Plugin System #41269

Closed
wants to merge 7 commits into from
Closed

Add Godot iOS Plugin System #41269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
52ce530
Add Godot iOS Plugin System
cagdasc Aug 3, 2020
a915947
Add signal support(only string args allwoed)
cagdasc Aug 16, 2020
93c1188
Add iphone anabled macro for all platforms
cagdasc Aug 16, 2020
98de205
Fix classdb register
cagdasc Aug 16, 2020
1380910
Add godot vars for unsafe typing
cagdasc Aug 16, 2020
bcbed17
Fix syntax err
cagdasc Aug 17, 2020
b4cc72c
Add custom variable classes and fully signal support
cagdasc Aug 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion platform/iphone/SCsub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,22 @@ iphone_lib = [
"icloud.mm",
"ios.mm",
"gl_view_gesture_recognizer.m",
"api/ios_singleton.mm",
"plugin/godot_plugin_registery.mm",
"plugin/godot_ios_plugin_helper.mm",
"plugin/godot_vars.m",
"objc_utils.mm"
]

plugin_lib = [
"plugin/godot_plugin.m",
"plugin/signal_info.m",
"plugin/godot_vars.m"
]

env_ios = env.Clone()
ios_lib = env_ios.add_library("iphone", iphone_lib)
ios_plugin_lib = env_ios.add_library("#bin/libgodot_plugin" + env["LIBSUFFIX"], plugin_lib)

# (iOS) Enable module support
env_ios.Append(CCFLAGS=["-fmodules", "-fcxx-modules"])
Expand All @@ -35,4 +47,4 @@ def combine_libs(target=None, source=None, env=None):
)


combine_command = env_ios.Command("#bin/libgodot" + env_ios["LIBSUFFIX"], [ios_lib] + env_ios["LIBS"], combine_libs)
combine_command = env_ios.Command("#bin/libgodot" + env_ios["LIBSUFFIX"], [ios_lib, ios_plugin_lib] + env_ios["LIBS"], combine_libs)
43 changes: 43 additions & 0 deletions platform/iphone/api/api.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*************************************************************************/
/* api.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 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. */
/*************************************************************************/

#include "api.h"

#include "core/engine.h"
#include "ios_singleton.h"

void register_iphone_api() {
#ifdef IPHONE_ENABLED
ClassDB::register_class<iOSSingleton>();
#endif
}

void unregister_iphone_api() {
}
37 changes: 37 additions & 0 deletions platform/iphone/api/api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*************************************************************************/
/* api.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 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 IOS_API_H
#define IOS_API_H

void register_iphone_api();
void unregister_iphone_api();

#endif // IOS_API_H
68 changes: 68 additions & 0 deletions platform/iphone/api/ios_singleton.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/*************************************************************************/
/* ios_singleton.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 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 IOS_SINGLETON_H
#define IOS_SINGLETON_H

#include "core/object.h"
#ifdef IPHONE_ENABLED
#include "objc_utils.h"
#endif
#include <core/engine.h>
#include <core/variant.h>

class iOSSingleton : public Object {

GDCLASS(iOSSingleton, Object);
#ifdef IPHONE_ENABLED
id instance;
#endif
struct MethodData {

String method_name;
String method_sel_name;
Variant::Type ret_type;
Vector<Variant::Type> argtypes;
};

Map<StringName, MethodData> method_map;

public:
void add_method(const StringName &p_name, const StringName &p_sel_name, const Vector<Variant::Type> &p_args, Variant::Type p_ret_type);
virtual Variant call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error);
void add_signal(const StringName &p_name, const Vector<Variant::Type> &p_args);
#ifdef IPHONE_ENABLED
void set_instance(id p_instance);
id get_instance() const;
#endif
iOSSingleton();
};

#endif
136 changes: 136 additions & 0 deletions platform/iphone/api/ios_singleton.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
/*************************************************************************/
/* ios_singleton.mm */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 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. */
/*************************************************************************/

#include "ios_singleton.h"

#import <Foundation/Foundation.h>

void iOSSingleton::add_method(const StringName &p_name, const StringName &p_sel_name, const Vector<Variant::Type> &p_args, Variant::Type p_ret_type) {
MethodData md;
md.method_name = p_name;
md.method_sel_name = p_sel_name;
md.argtypes = p_args;
md.ret_type = p_ret_type;
method_map[p_name] = md;
}

Variant iOSSingleton::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
#ifdef IPHONE_ENABLED
Map<StringName, MethodData>::Element *E = method_map.find(p_method);

// Check the method we're looking for is in the iOSSingleton map and that
// the arguments match.
bool call_error = !E || E->get().argtypes.size() != p_argcount;
if (!call_error) {
for (int i = 0; i < p_argcount; i++) {

if (!Variant::can_convert(p_args[i]->get_type(), E->get().argtypes[i])) {
call_error = true;
break;
}
}
}

if (call_error) {
// The method is not in this map, defaulting to the regular instance calls.
return Object::call(p_method, p_args, p_argcount, r_error);
}

ERR_FAIL_COND_V(!instance, Variant());

r_error.error = Variant::CallError::CALL_OK;

NSString *method_sel_name = [[[NSString alloc] initWithUTF8String:E->get().method_sel_name.utf8().get_data()] autorelease];
SEL method_selector = NSSelectorFromString(method_sel_name);

NSMethodSignature *method_signature = [instance methodSignatureForSelector:method_selector];
NSInvocation *method_invocation = [NSInvocation invocationWithMethodSignature:method_signature];

[method_invocation setTarget:instance];
[method_invocation setSelector:method_selector];

id *v = NULL;

if (p_argcount) {

v = (id *)alloca(sizeof(id) * p_argcount);
}

for (int i = 0; i < p_argcount; i++) {

id vr = _variant_to_id(E->get().argtypes[i], p_args[i]);
v[i] = vr;

[method_invocation setArgument:&vr atIndex:(i + 2)];
}
[method_invocation retainArguments];
[method_invocation invoke];

Variant::Type ret_type = E->get().ret_type;
if (ret_type == Variant::NIL) {
return Variant::NIL;
} else {
id ret = _create_objc_object(ret_type);
if (ret == nil)
return Variant::NIL;
[method_invocation getReturnValue:&ret];
return _id_to_variant(ret, ret_type);
}
#else
return Object::call(p_method, p_args, p_argcount, r_error);
#endif
}

void iOSSingleton::add_signal(const StringName &p_name, const Vector<Variant::Type> &p_args) {
if (p_args.size() == 0)
ADD_SIGNAL(MethodInfo(p_name));
else if (p_args.size() == 1)
ADD_SIGNAL(MethodInfo(p_name, PropertyInfo(p_args[0], "arg1")));
else if (p_args.size() == 2)
ADD_SIGNAL(MethodInfo(p_name, PropertyInfo(p_args[0], "arg1"), PropertyInfo(p_args[1], "arg2")));
else if (p_args.size() == 3)
ADD_SIGNAL(MethodInfo(p_name, PropertyInfo(p_args[0], "arg1"), PropertyInfo(p_args[1], "arg2"), PropertyInfo(p_args[2], "arg3")));
else if (p_args.size() == 4)
ADD_SIGNAL(MethodInfo(p_name, PropertyInfo(p_args[0], "arg1"), PropertyInfo(p_args[1], "arg2"), PropertyInfo(p_args[2], "arg3"), PropertyInfo(p_args[3], "arg4")));
else if (p_args.size() == 5)
ADD_SIGNAL(MethodInfo(p_name, PropertyInfo(p_args[0], "arg1"), PropertyInfo(p_args[1], "arg2"), PropertyInfo(p_args[2], "arg3"), PropertyInfo(p_args[3], "arg4"), PropertyInfo(p_args[4], "arg5")));
}

#ifdef IPHONE_ENABLED
void iOSSingleton::set_instance(id p_instance) {
this->instance = p_instance;
}

id iOSSingleton::get_instance() const {
return this->instance;
}
#endif

iOSSingleton::iOSSingleton(){};
53 changes: 53 additions & 0 deletions platform/iphone/objc_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*************************************************************************/
/* jni_utils.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2020 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 OBJC_UTILS_H
#define OBJC_UTILS_H

#include <core/engine.h>
#include <core/variant.h>
#ifdef IPHONE_ENABLED
#include <objc/runtime.h>

id _variant_to_id(Variant::Type p_type, const Variant *p_arg, bool empty_obj = false);

Variant _id_to_variant(id p_objc_type, Variant::Type p_type);

id _create_objc_object(Variant::Type p_type);

Variant::Type get_objc_type(const String &p_type);

Variant get_objc_class_type(const String &p_name, id obj);

Variant::Type get_objc_to_variant(const String &p_type);

#endif

#endif // OBJC_UTILS_H
Loading