Remote-Promise system

addons/promise/$PBOPREFIX$

@@ -0,0 +1 @@
+x\cba\addons\promise

addons/promise/CfgFunctions.hpp

@@ -0,0 +1,11 @@
+class CfgFunctions {
+    class CBA {
+        class Network {
+            PATHTO_FNC(promise_create);
+            PATHTO_FNC(promise_callback);
+            PATHTO_FNC(promise_done);
+            PATHTO_FNC(promise_receiver);
+            PATHTO_FNC(promise_init);
+        };
+    };
+};

addons/promise/config.cpp

@@ -0,0 +1,17 @@
+#include "script_component.hpp"
+
+class CfgPatches {
+    class ADDON {
+        author = "$STR_CBA_Author";
+        name = CSTRING(component);
+        url = "$STR_CBA_URL";
+        units[] = {};
+        weapons[] = {};
+        requiredVersion = REQUIRED_VERSION;
+        requiredAddons[] = {};
+        version = VERSION;
+        authors[] = {"X39"};
+    };
+};
+
+#include "CfgFunctions.hpp"

addons/promise/fnc_callback.sqf

@@ -0,0 +1,29 @@
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_promise_callback
+
+Description:
+    Method that gets called when the receiver is done.
+    Will in the end execute the promise-code locally.
+
+    WARNING! Not intended to be called by client-code!
+
+Parameters:
+    _id - The Promise-ID of the now finished promise.
+    _data  - The result data of the now finished promise.
+
+Returns:
+    Nothing
+
+Example:
+    Nothing
+
+Author:
+    X39
+---------------------------------------------------------------------------- */
+#include "script_component.hpp"
+
+params ["_id", "_data"];
+private _request = GVAR(requests) select _id;
+GVAR(requests) set [_id, 0];
+[_request select 0, _data] call (_request select 1);
+nil

addons/promise/fnc_create.sqf

@@ -0,0 +1,51 @@
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_promise_create
+
+Description:
+    Creates and executes a new Promise.
+
+Parameters:
+    _objects - Object or array of objects that perform Say <OBJECT, ARRAY>
+    _params  - [sound, maxTitlesDistance,speed] or "sound" <ARRAY, STRING>
+
+    _rcv - remoteExecCall target.
+    _mthd - either string (methodname) or code to execute on target.
+    _mthdArgs - custom arguments to pass to the target.
+    _args - args to pass to the callback (see next param)
+    _cb - callback for the promise (executed on current machine).
+          Will receive an array, with index 0 being what is passed include
+          _args and index 1 being whatever is returned by the target invokation
+          [_args, _mthdResult]
+
+Returns:
+    Identifier that allows to check if a promise is yet done.
+    See CBA_fnc_promise_done.
+
+Example:
+    (begin example)
+        [
+            random_player, "random_method", [],
+            [_someLocalVariable], {
+                params ["_args", "_result"];
+                _args params  ["_someLocalVariable"];
+                diag_log _result;
+                diag_log _someLocalVariable;
+            }
+        ] call CBA_fnc_promise_create;
+    (end)
+
+Author:
+    X39
+---------------------------------------------------------------------------- */
+#include "script_component.hpp"
+params ["_rcv", "_mthd", "_mthdArgs", "_args", "_cb"];
+private _stamp = diag_tickTime;
+private _index = 0;
+isNil {
+    _index = GVAR(requests) find 0;
+    if (_index == -1) then
+    { _index = GVAR(requests) pushBack [_args, _cb, _stamp]; }
+    else { GVAR(requests) set [_index, [_args, _cb, _stamp]]; }
+};
+[_index, _mthd, _mthdArgs] remoteExec [QGVAR(requests), _rcv, false];
+[_index, _stamp]

addons/promise/fnc_done.sqf

@@ -0,0 +1,24 @@
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_promise_done
+
+Description:
+    Checks if a given promise was processed yet.
+
+Parameters:
+    _promiseHandle - Handle returned by CBA_fnc_promise_create
+
+Returns:
+    Boolean, true if it is done yet, false if it is not.
+
+Example:
+    (begin example)
+        _promiseHandle call CBA_fnc_promise_done;
+    (end)
+
+Author:
+    X39
+---------------------------------------------------------------------------- */
+#include "script_component.hpp"
+params ["_index", "_stamp"];
+private _promise = GVAR(requests) select 0;
+if (_promise isEqualTo 0) { true } else { _promise select 2 != _stamp }

addons/promise/fnc_init.sqf

@@ -0,0 +1,28 @@
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_promise_init
+
+Description:
+    Initializes the required variabels for the promise system.
+
+Parameters:
+    Nothing
+
+Returns:
+    Nothing
+
+Example:
+    (begin example)
+        [] call CBA_fnc_promise_init;
+    (end)
+
+Author:
+    X39
+---------------------------------------------------------------------------- */
+#include "script_component.hpp"
+isNil {
+    if isNil QGVAR(requests) then {
+        GVAR(requests) = [];
+    };
+};
+
+nil

addons/promise/fnc_receiver.sqf

@@ -0,0 +1,32 @@
+/* ----------------------------------------------------------------------------
+Function: CBA_fnc_promise_receiver
+
+Description:
+    Method that gets called when a sender has a request.
+
+    WARNING! Not intended to be called by client-code!
+
+Parameters:
+    _id - the promise ID, local to the sender.
+    _mthd - The method to execute, either string (var name) or code.
+    _args - Arguments to pass to the method.
+
+Returns:
+    Nothing
+
+Example:
+    Nothing
+
+Author:
+    X39
+---------------------------------------------------------------------------- */
+#include "script_component.hpp"
+
+params ["_id", "_mthd", "_args"];
+private _res = if (_mthd isEqualType "") then {
+    _args call (missionNamespace getVariable _mthd);
+} else {
+    _args call _mthd;
+};
+[_id, _res] remoteExec [QGVAR(requests), remoteExecutedOwner, false];
+nil

addons/promise/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Marco Silipo (X39)
+
+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.

addons/promise/script_component.hpp

@@ -0,0 +1,4 @@
+#define COMPONENT promise
+#include "\x\cba\addons\main\script_mod.hpp"
+
+#include "\x\cba\addons\main\script_macros.hpp"