From 0c94dccee1874645992d3dc192f8cc1671d98f35 Mon Sep 17 00:00:00 2001 From: TimePath Date: Wed, 19 Aug 2015 10:04:12 +1000 Subject: [PATCH] Move mutator system to common --- mod/server/main.qc | 1 + qcsrc/common/mutators/base.qh | 234 +++++++++++++++++++ qcsrc/common/mutators/events.qh | 22 ++ qcsrc/server/miscfunctions.qh | 3 +- qcsrc/server/mutators/base.qc | 125 ---------- qcsrc/server/mutators/{base.qh => events.qh} | 95 +------- qcsrc/server/mutators/mutator.qh | 2 +- qcsrc/server/mutators/mutators_include.qc | 2 +- qcsrc/server/mutators/mutators_include.qh | 2 +- qcsrc/server/sys-post.qh | 1 + 10 files changed, 265 insertions(+), 222 deletions(-) create mode 100644 qcsrc/common/mutators/base.qh create mode 100644 qcsrc/common/mutators/events.qh delete mode 100644 qcsrc/server/mutators/base.qc rename qcsrc/server/mutators/{base.qh => events.qh} (82%) diff --git a/mod/server/main.qc b/mod/server/main.qc index 1342b7b4a..f6c94ca65 100644 --- a/mod/server/main.qc +++ b/mod/server/main.qc @@ -10,6 +10,7 @@ MUTATOR_HOOKFUNCTION(mod_BuildMutatorsPrettyString) return false; } +MUTATOR_DECLARATION(mutator_mod); MUTATOR_DEFINITION(mutator_mod) { MUTATOR_HOOK(BuildMutatorsString, mod_BuildMutatorsString, CBC_ORDER_ANY); diff --git a/qcsrc/common/mutators/base.qh b/qcsrc/common/mutators/base.qh new file mode 100644 index 000000000..dfd73a7ed --- /dev/null +++ b/qcsrc/common/mutators/base.qh @@ -0,0 +1,234 @@ +#ifndef MUTATORS_BASE_H +#define MUTATORS_BASE_H + +const int CBC_ORDER_FIRST = 1; +const int CBC_ORDER_LAST = 2; +const int CBC_ORDER_EXCLUSIVE = 3; +const int CBC_ORDER_ANY = 4; + +bool CallbackChain_ReturnValue; // read-only field of the current return value + +/** + * Callbacks may be added to zero or more callback chains. + */ +CLASS(Callback, Object) + /** + * a callback function is like this: + * bool mycallback() + * { + * do something + * return false; + * } + */ + ATTRIB(Callback, cbc_func, bool(), func_null) + CONSTRUCTOR(Callback, bool() func) { + CONSTRUCT(Callback); + this.cbc_func = func; + return this; + } +ENDCLASS(Callback) + +/** + * Callback chains contain zero or more callbacks. + */ +CLASS(CallbackChain, Object) + CLASS(CallbackNode, Object) + ATTRIB(CallbackNode, cbc, Callback, NULL) + ATTRIB(CallbackNode, cbc_next, CallbackNode, NULL) + ATTRIB(CallbackNode, cbc_order, int, 0) + CONSTRUCTOR(CallbackNode, Callback it, int order) { + CONSTRUCT(CallbackNode); + this.cbc = it; + this.cbc_order = order; + return this; + } + ENDCLASS(CallbackNode) + + ATTRIB(CallbackChain, cbc_next, CallbackNode, NULL) + ATTRIB(CallbackChain, cbc_order, int, 0) + CONSTRUCTOR(CallbackChain, string name) { + CONSTRUCT(CallbackChain); + this.netname = name; + return this; + } + + bool CallbackChain_Add(CallbackChain this, Callback cb, int order) + { + if (order & CBC_ORDER_FIRST) { + if (order & CBC_ORDER_LAST) + if (this.cbc_order & CBC_ORDER_ANY) + return false; + if (this.cbc_order & CBC_ORDER_FIRST) + return false; + } else if (order & CBC_ORDER_LAST) { + if (this.cbc_order & CBC_ORDER_LAST) + return false; + } + entity node = NEW(CallbackNode, cb, order); + if (order & CBC_ORDER_FIRST) { + node.cbc_next = this.cbc_next; + this.cbc_next = node; + } else if (order & CBC_ORDER_LAST) { + CallbackNode prev = NULL, it = this.cbc_next; + while (it) { prev = it, it = it.cbc_next; } + if (prev) prev.cbc_next = node; + else this.cbc_next = node; + } else { + // by default we execute last, but before a possible CBC_ORDER_LAST callback + CallbackNode prev = NULL, it = this.cbc_next; + while (it && !(it.cbc_order & CBC_ORDER_LAST)) { prev = it, it = it.cbc_next; } + node.cbc_next = it; + if (prev) prev.cbc_next = node; + else this.cbc_next = node; + } + this.cbc_order |= (order | CBC_ORDER_ANY); + return true; + } + int CallbackChain_Remove(CallbackChain this, Callback cb) + { + int n = 0, order = 0; + for (Callback prev = NULL, it = this.cbc_next; it; prev = it, it = it.cbc_next) { + if (it.cbc == cb) { + // remove it from the chain + Callback next = it.cbc_next; + if (prev) prev.cbc_next = next; + else this.cbc_next = next; + ++n; + } + // it is now something we want to keep + order |= (it.cbc_order & CBC_ORDER_ANY); + } + this.cbc_order = order; + return n; + } + bool CallbackChain_Call(CallbackChain this) + { + bool r = false; + for (Callback it = this.cbc_next; it; it = it.cbc_next) { + CallbackChain_ReturnValue = r; + r |= it.cbc.cbc_func(); + } + return r; // callbacks return an error status, so 0 is default return value + } +ENDCLASS(CallbackChain) + +#define _MUTATOR_HANDLE_NOP(type, id) +#define _MUTATOR_HANDLE_PARAMS(type, id) , type in_##id +#define _MUTATOR_HANDLE_PREPARE(type, id) id = in_##id; +#define _MUTATOR_HANDLE_PUSHTMP(type, id) type tmp_##id = id; +#define _MUTATOR_HANDLE_PUSHOUT(type, id) type out_##id = id; +#define _MUTATOR_HANDLE_POPTMP(type, id) id = tmp_##id; +#define _MUTATOR_HANDLE_POPOUT(type, id) id = out_##id; + +#define _MUTATOR_HOOKABLE(id, ...) CallbackChain HOOK_##id; bool __Mutator_Send_##id(__VA_ARGS__) +#define MUTATOR_HOOKABLE(id, params) \ + _MUTATOR_HOOKABLE(id, int params(_MUTATOR_HANDLE_PARAMS, _MUTATOR_HANDLE_NOP)) { \ + params(_MUTATOR_HANDLE_PUSHTMP, _MUTATOR_HANDLE_NOP) \ + params(_MUTATOR_HANDLE_PREPARE, _MUTATOR_HANDLE_NOP) \ + bool ret = CallbackChain_Call(HOOK_##id); \ + params(_MUTATOR_HANDLE_NOP, _MUTATOR_HANDLE_PUSHOUT) \ + params(_MUTATOR_HANDLE_POPTMP, _MUTATOR_HANDLE_NOP) \ + params(_MUTATOR_HANDLE_NOP, _MUTATOR_HANDLE_POPOUT) \ + return ret; \ + } \ + STATIC_INIT(HOOK_##id) { HOOK_##id = NEW(CallbackChain, #id); } +#define MUTATOR_CALLHOOK(id, ...) APPLY(__Mutator_Send_##id, 0, ##__VA_ARGS__) + +enum { + MUTATOR_REMOVING, + MUTATOR_ADDING, + MUTATOR_ROLLING_BACK +}; + +typedef bool(int) mutatorfunc_t; + +CLASS(Mutator, Object) + ATTRIB(Mutator, mutatorname, string, string_null) + ATTRIB(Mutator, mutatorfunc, mutatorfunc_t, func_null) + CONSTRUCTOR(Mutator, string name, mutatorfunc_t func) { + CONSTRUCT(Mutator); + this.mutatorname = name; + this.mutatorfunc = func; + return this; + } +ENDCLASS(Mutator) + +const int MAX_MUTATORS = 15; +Mutator loaded_mutators[MAX_MUTATORS]; + +bool Mutator_Add(Mutator mut) +{ + int j = -1; + for (int i = 0; i < MAX_MUTATORS; ++i) { + if (loaded_mutators[i] == mut) + return true; // already added + if (!(loaded_mutators[i])) + j = i; + } + if (j < 0) { + backtrace("WARNING: too many mutators, cannot add any more\n"); + return false; + } + loaded_mutators[j] = mut; + mutatorfunc_t func = mut.mutatorfunc; + if (!func(MUTATOR_ADDING)) { + // good + return true; + } + backtrace("WARNING: when adding mutator: adding failed, rolling back\n"); + if (func(MUTATOR_ROLLING_BACK)) { + // baaaaad + error("WARNING: when adding mutator: rolling back failed"); + } + return false; +} + +void Mutator_Remove(Mutator mut) +{ + int i; + for (i = 0; i < MAX_MUTATORS; ++i) + if (loaded_mutators[i] == mut) + break; + if (i >= MAX_MUTATORS) { + backtrace("WARNING: removing not-added mutator\n"); + return; + } + loaded_mutators[i] = NULL; + mutatorfunc_t func = mut.mutatorfunc; + if (func(MUTATOR_REMOVING)) { + // baaaaad + error("Mutator_Remove: removing mutator failed"); + } +} + +#define MUTATOR_DECLARATION(name) \ + Mutator MUTATOR_##name +#define MUTATOR_DEFINITION(name) \ + bool MUTATORFUNCTION_##name(int mode); \ + STATIC_INIT(MUTATOR_##name) { MUTATOR_##name = NEW(Mutator, #name, MUTATORFUNCTION_##name); } \ + bool MUTATORFUNCTION_##name(int mode) +#define MUTATOR_ONADD if (mode == MUTATOR_ADDING) +#define MUTATOR_ONREMOVE if (mode == MUTATOR_REMOVING) +#define MUTATOR_ONROLLBACK_OR_REMOVE if (mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK) +#define MUTATOR_ADD(name) Mutator_Add(MUTATOR_##name) +#define MUTATOR_REMOVE(name) Mutator_Remove(MUTATOR_##name) +#define MUTATOR_RETURNVALUE CallbackChain_ReturnValue +#define MUTATOR_HOOKFUNCTION(name) \ + bool HOOKFUNCTION_##name(); \ + Callback CALLBACK_##name; STATIC_INIT(CALLBACK_##name) { CALLBACK_##name = NEW(Callback, HOOKFUNCTION_##name); } \ + bool HOOKFUNCTION_##name() +#define MUTATOR_HOOK(cb, func, order) do { \ + MUTATOR_ONADD { \ + if (!CallbackChain_Add(HOOK_##cb, CALLBACK_##func, order)) { \ + print("HOOK FAILED: ", #cb, ":", #func, "\n"); \ + return true; \ + } \ + } \ + MUTATOR_ONROLLBACK_OR_REMOVE { \ + CallbackChain_Remove(HOOK_##cb, CALLBACK_##func); \ + } \ +} while (0) + +#include "events.qh" + +#endif diff --git a/qcsrc/common/mutators/events.qh b/qcsrc/common/mutators/events.qh new file mode 100644 index 000000000..e193d5f8a --- /dev/null +++ b/qcsrc/common/mutators/events.qh @@ -0,0 +1,22 @@ +#ifndef COMMON_MUTATORS_EVENTS_H +#define COMMON_MUTATORS_EVENTS_H + +#define EV_NO_ARGS(i, o) + +string ret_string; + +/** appends ":mutatorname" to ret_string for logging */ +#define EV_BuildMutatorsString(i, o) \ + /**/ i(string, ret_string) \ + /**/ o(string, ret_string) \ + /**/ +MUTATOR_HOOKABLE(BuildMutatorsString, EV_BuildMutatorsString); + +/** appends ", Mutator name" to ret_string for display */ +#define EV_BuildMutatorsPrettyString(i, o) \ + /**/ i(string, ret_string) \ + /**/ o(string, ret_string) \ + /**/ +MUTATOR_HOOKABLE(BuildMutatorsPrettyString, EV_BuildMutatorsPrettyString); + +#endif diff --git a/qcsrc/server/miscfunctions.qh b/qcsrc/server/miscfunctions.qh index 12dbe3a2c..860eadcaa 100644 --- a/qcsrc/server/miscfunctions.qh +++ b/qcsrc/server/miscfunctions.qh @@ -3,7 +3,7 @@ #include "t_items.qh" -#include "mutators/base.qh" +#include "mutators/events.qh" #include "mutators/gamemode_race.qh" #include "../common/constants.qh" @@ -75,7 +75,6 @@ vector shotorg_adjust(vector vecs, float y_is_right, float visual); float DistributeEvenly_amount; float DistributeEvenly_totalweight; -var void remove(entity e); void objerror(string s); void droptofloor(); void() spawnfunc_info_player_deathmatch; // needed for the other spawnpoints diff --git a/qcsrc/server/mutators/base.qc b/qcsrc/server/mutators/base.qc deleted file mode 100644 index 2f78ec182..000000000 --- a/qcsrc/server/mutators/base.qc +++ /dev/null @@ -1,125 +0,0 @@ -#include "base.qh" -#include "../_all.qh" - -.bool() cbc_func; -.entity cbc_next; -.int cbc_order; - -entity CallbackChain_New(string name) -{ - entity e = spawn(); - e.classname = "callbackchain"; - e.netname = name; - return e; -} - -bool CallbackChain_Add(entity cb, bool() func, int order) -{ - if (order & CBC_ORDER_FIRST) { - if (order & CBC_ORDER_LAST) - if (cb.cbc_order & CBC_ORDER_ANY) - return false; - if (cb.cbc_order & CBC_ORDER_FIRST) - return false; - } else if (order & CBC_ORDER_LAST) { - if (cb.cbc_order & CBC_ORDER_LAST) - return false; - } - entity thiscb = spawn(); - thiscb.classname = "callback"; - thiscb.cbc_func = func; - thiscb.cbc_order = order; - if (order & CBC_ORDER_FIRST) { - thiscb.cbc_next = cb.cbc_next; - cb.cbc_next = thiscb; - } else if (order & CBC_ORDER_LAST) { - entity e = cb; - while (e.cbc_next) e = e.cbc_next; - e.cbc_next = thiscb; - } else { - // by default we execute last, but before a possible CBC_ORDER_LAST callback - entity e = cb; - // we must make sure that we insert BEFORE an CBC_ORDER_LAST mutator! - while (e.cbc_next && !(e.cbc_next.cbc_order & CBC_ORDER_LAST)) e = e.cbc_next; - thiscb.cbc_next = e.cbc_next; - e.cbc_next = thiscb; - } - cb.cbc_order |= (order | CBC_ORDER_ANY); - return true; -} - -int CallbackChain_Remove(entity cb, bool() func) -{ - int n = 0, order = 0; - for (entity e = cb; e.cbc_next; e = e.cbc_next) { - while (e.cbc_next.cbc_func == func) { - // remove e.cbc_next from the chain - entity e2 = e.cbc_next.cbc_next; - remove(e.cbc_next); - e.cbc_next = e2; - ++n; - } - // e.cbc_next is now something we want to keep - order |= (e.cbc_next.cbc_order & CBC_ORDER_ANY); - } - cb.cbc_order = order; - return n; -} - -bool CallbackChain_Call(entity cb) -{ - bool r = false; - for (entity e = cb; e.cbc_next; e = e.cbc_next) { - CallbackChain_ReturnValue = r; - r |= e.cbc_next.cbc_func(); - } - return r; // callbacks return an error status, so 0 is default return value -} - -const int MAX_MUTATORS = 15; -string loaded_mutators[MAX_MUTATORS]; -bool Mutator_Add(mutatorfunc_t func, string name) -{ - int j = -1; - for (int i = 0; i < MAX_MUTATORS; ++i) { - if (name == loaded_mutators[i]) - return true; // already added - if (!(loaded_mutators[i])) - j = i; - } - if (j < 0) { - backtrace("WARNING: too many mutators, cannot add any more\n"); - return false; - } - loaded_mutators[j] = name; - - if (!func(MUTATOR_ADDING)) { - // good - return true; - } - - backtrace("WARNING: when adding mutator: adding failed, rolling back\n"); - - if (func(MUTATOR_ROLLING_BACK)) { - // baaaaad - error("WARNING: when adding mutator: rolling back failed"); - } - return false; -} -void Mutator_Remove(mutatorfunc_t func, string name) -{ - int i; - for (i = 0; i < MAX_MUTATORS; ++i) - if (name == loaded_mutators[i]) - break; - if (i >= MAX_MUTATORS) { - backtrace("WARNING: removing not-added mutator\n"); - return; - } - loaded_mutators[i] = string_null; - - if (func(MUTATOR_REMOVING) != 0) { - // baaaaad - error("Mutator_Remove: removing mutator failed"); - } -} diff --git a/qcsrc/server/mutators/base.qh b/qcsrc/server/mutators/events.qh similarity index 82% rename from qcsrc/server/mutators/base.qh rename to qcsrc/server/mutators/events.qh index c12050caf..52be590ba 100644 --- a/qcsrc/server/mutators/base.qh +++ b/qcsrc/server/mutators/events.qh @@ -1,83 +1,9 @@ -#ifndef MUTATORS_BASE_H -#define MUTATORS_BASE_H -const int CBC_ORDER_FIRST = 1; -const int CBC_ORDER_LAST = 2; -const int CBC_ORDER_EXCLUSIVE = 3; -const int CBC_ORDER_ANY = 4; - -bool CallbackChain_ReturnValue; // read-only field of the current return value - -entity CallbackChain_New(string name); -bool CallbackChain_Add(entity cb, bool() func, int order); -int CallbackChain_Remove(entity cb, bool() func); -// a callback function is like this: -// bool mycallback(entity me) -// { -// do something -// return false; -// } -bool CallbackChain_Call(entity cb); - -enum { - MUTATOR_REMOVING, - MUTATOR_ADDING, - MUTATOR_ROLLING_BACK -}; -typedef bool(int) mutatorfunc_t; -bool Mutator_Add(mutatorfunc_t func, string name); -void Mutator_Remove(mutatorfunc_t func, string name); // calls error() on fail - -#define MUTATOR_ADD(name) Mutator_Add(MUTATOR_##name, #name) -#define MUTATOR_REMOVE(name) Mutator_Remove(MUTATOR_##name, #name) -#define MUTATOR_DEFINITION(name) bool MUTATOR_##name(int mode) -#define MUTATOR_DECLARATION(name) bool MUTATOR_##name(int mode) -#define MUTATOR_HOOKFUNCTION(name) bool HOOKFUNCTION_##name() -#define MUTATOR_HOOK(cb, func, order) do { \ - MUTATOR_ONADD { \ - if (!HOOK_##cb) HOOK_##cb = CallbackChain_New(#cb); \ - if (!CallbackChain_Add(HOOK_##cb, HOOKFUNCTION_##func, order)) { \ - print("HOOK FAILED: ", #func, "\n"); \ - return true; \ - } \ - } \ - MUTATOR_ONROLLBACK_OR_REMOVE { \ - if (HOOK_##cb) CallbackChain_Remove(HOOK_##cb, HOOKFUNCTION_##func); \ - } \ -} while(0) -#define MUTATOR_ONADD if (mode == MUTATOR_ADDING) -#define MUTATOR_ONREMOVE if (mode == MUTATOR_REMOVING) -#define MUTATOR_ONROLLBACK_OR_REMOVE if (mode == MUTATOR_REMOVING || mode == MUTATOR_ROLLING_BACK) - -#define _MUTATOR_HOOKABLE(id, ...) entity HOOK_##id; bool __Mutator_Send_##id(__VA_ARGS__) -#define MUTATOR_CALLHOOK(id, ...) APPLY(__Mutator_Send_##id, 0, ##__VA_ARGS__) - -#define MUTATOR_RETURNVALUE CallbackChain_ReturnValue - -#define HANDLE_NOP(type, id) -#define HANDLE_PARAMS(type, id) , type in_##id -#define HANDLE_PREPARE(type, id) id = in_##id; -#define HANDLE_PUSHTMP(type, id) type tmp_##id = id; -#define HANDLE_PUSHOUT(type, id) type out_##id = id; -#define HANDLE_POPTMP(type, id) id = tmp_##id; -#define HANDLE_POPOUT(type, id) id = out_##id; - -#define MUTATOR_HOOKABLE(id, params) \ - _MUTATOR_HOOKABLE(id, int params(HANDLE_PARAMS, HANDLE_NOP)) { \ - params(HANDLE_PUSHTMP, HANDLE_NOP) \ - params(HANDLE_PREPARE, HANDLE_NOP) \ - bool ret = CallbackChain_Call(HOOK_##id); \ - params(HANDLE_NOP, HANDLE_PUSHOUT) \ - params(HANDLE_POPTMP, HANDLE_NOP) \ - params(HANDLE_NOP, HANDLE_POPOUT) \ - return ret; \ - } - +#ifndef SERVER_MUTATORS_EVENTS_H +#define SERVER_MUTATORS_EVENTS_H +#include "../../common/mutators/base.qh" // register all possible hooks here -// some parameters are commented to avoid duplicate declarations - -#define EV_NO_ARGS(i, o) /** called when a player becomes observer, after shared setup */ #define EV_MakePlayerObserver(i, o) \ @@ -190,21 +116,6 @@ MUTATOR_HOOKABLE(WeaponSpeedFactor, EV_WeaponSpeedFactor); /** adjusts {warmup_}start_{items,weapons,ammo_{cells,plasma,rockets,nails,shells,fuel}} */ MUTATOR_HOOKABLE(SetStartItems, EV_NO_ARGS); -/** appends ":mutatorname" to ret_string for logging */ -#define EV_BuildMutatorsString(i, o) \ - /**/ i(string, ret_string) \ - /**/ o(string, ret_string) \ - /**/ -string ret_string; -MUTATOR_HOOKABLE(BuildMutatorsString, EV_BuildMutatorsString); - -/** appends ", Mutator name" to ret_string for display */ -#define EV_BuildMutatorsPrettyString(i, o) \ - /**/ i(string, ret_string) \ - /**/ o(string, ret_string) \ - /**/ -MUTATOR_HOOKABLE(BuildMutatorsPrettyString, EV_BuildMutatorsPrettyString); - /** called every frame. customizes the waypoint for spectators */ #define EV_CustomizeWaypoint(i, o) \ /** waypoint */ i(entity, self) \ diff --git a/qcsrc/server/mutators/mutator.qh b/qcsrc/server/mutators/mutator.qh index 36bf631bb..f23f42a89 100644 --- a/qcsrc/server/mutators/mutator.qh +++ b/qcsrc/server/mutators/mutator.qh @@ -1,7 +1,7 @@ #ifndef MUTATOR_H #define MUTATOR_H -#include "base.qh" +#include "../../common/mutators/base.qh" #include "mutator_nades.qh" #include "../cl_client.qh" diff --git a/qcsrc/server/mutators/mutators_include.qc b/qcsrc/server/mutators/mutators_include.qc index e139865ab..d0fe0a60a 100644 --- a/qcsrc/server/mutators/mutators_include.qc +++ b/qcsrc/server/mutators/mutators_include.qc @@ -79,7 +79,7 @@ #include "../vehicles/all.qh" #endif -#include "base.qc" +#include "../../common/mutators/base.qh" #include "gamemode_assault.qc" #include "gamemode_ca.qc" #include "gamemode_ctf.qc" diff --git a/qcsrc/server/mutators/mutators_include.qh b/qcsrc/server/mutators/mutators_include.qh index da723d927..44e51828b 100644 --- a/qcsrc/server/mutators/mutators_include.qh +++ b/qcsrc/server/mutators/mutators_include.qh @@ -1,7 +1,7 @@ #ifndef MUTATORS_INCLUDE_H #define MUTATORS_INCLUDE_H -#include "base.qh" +#include "../../common/mutators/base.qh" #include "mutators.qh" #include "gamemode_assault.qh" #include "gamemode_ca.qh" diff --git a/qcsrc/server/sys-post.qh b/qcsrc/server/sys-post.qh index 3143699f2..5b8dfd498 100644 --- a/qcsrc/server/sys-post.qh +++ b/qcsrc/server/sys-post.qh @@ -12,6 +12,7 @@ var float(string name) cvar; var string(string name) cvar_string; var void(string name, string value) cvar_set; +var void remove(entity e); #pragma noref 0 -- 2.39.2