registry.qh File Reference

#include "oo.qh"

Include dependency graph for registry.qh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	_R_DEL(r)
#define	_R_GET(r, i)
#define	_R_MAP(r, max)
#define	_R_SET(r, i, e)
#define	_REGISTER_REGISTRY(id, str)
#define	EVAL_REGISTER(...)
#define	EVAL_REGISTRY_SORT(...)
#define	REGISTER(...)
	Register a new entity with a registry.
#define	REGISTER_4(registry, id, fld, inst)
#define	REGISTER_5(registry, ns, id, fld, inst)
#define	REGISTER_INIT(id)
#define	REGISTER_REGISTRY(id)
#define	REGISTRY(id, max)
	Declare a new registry.
#define	REGISTRY_BEGIN(id)
	Called before initializing a registry.
#define	REGISTRY_BEGIN_(id)
#define	REGISTRY_CHECK(id)
#define	REGISTRY_COUNT(id)
#define	REGISTRY_DEFINE_GET(id, null)
#define	REGISTRY_DEPENDS(id, dep)
	Add registry dependencies to a registry.
#define	REGISTRY_DEPENDS_(id)
#define	REGISTRY_END(id)
	Called after initializing a registry.
#define	REGISTRY_END_(id)
#define	REGISTRY_GET(id, i)
#define	REGISTRY_HASH(id)
#define	REGISTRY_MAX(id)
#define	REGISTRY_NEXT   enemy
	internal next pointer
#define	REGISTRY_PUSH(registry, fld, it)
#define	REGISTRY_RESERVE(registry, fld, id, suffix)
#define	REGISTRY_SORT(...)
#define	REGISTRY_SORT_1(id)
#define	REGISTRY_SORT_2(id, skip)

Functions
void	_regCheck (int i, int _max)
ERASEABLE ACCUMULATE void	Registry_check (string r, string sv)
void	Registry_send (string id, string hash)
ERASEABLE ACCUMULATE void	Registry_send_all ()

Variables
string	registered_id
	registered item identifier
entity	REGISTRY_NEXT

Macro Definition Documentation

_R_DEL

#define _R_DEL

(

r

)

Value:

AL_DELETE(r)

Definition at line 9 of file registry.qh.

_R_GET

#define _R_GET	(		r,
			i )

Value:

AL_gete(r, i)

Definition at line 7 of file registry.qh.

_R_MAP

#define _R_MAP	(		r,
			max )

Value:

ArrayList r; STATIC_INIT(r) { AL_NEW(r, max, NULL, e); }

Definition at line 6 of file registry.qh.

_R_SET

#define _R_SET	(		r,
			i,
			e )

Value:

AL_sete(r, i, e)

Definition at line 8 of file registry.qh.

_REGISTER_REGISTRY

#define _REGISTER_REGISTRY	(		id,
			str )

Value:

    ACCUMULATE_FUNCTION(__static_init_1, Register##id) \
    CLASS(id##Registry, Object) \
        ATTRIB(id##Registry, m_name, string, str); \
        ATTRIB(id##Registry, REGISTRY_NEXT, entity, id##_first); \
        METHOD(id##Registry, m_reload, void()); \
    ENDCLASS(id##Registry) \
    REGISTER(Registries, REGISTRY, id, m_id, NEW(id##Registry)); \
    METHOD(id##Registry, m_reload, void()) { \
        id##_state = 0; \
        Register##id(); \
    }

Definition at line 216 of file registry.qh.

#define _REGISTER_REGISTRY(id, str) \
    ACCUMULATE_FUNCTION(__static_init_1, Register##id) \
    CLASS(id##Registry, Object) \
        ATTRIB(id##Registry, m_name, string, str); \
        ATTRIB(id##Registry, REGISTRY_NEXT, entity, id##_first); \
        METHOD(id##Registry, m_reload, void()); \
    ENDCLASS(id##Registry) \
    REGISTER(Registries, REGISTRY, id, m_id, NEW(id##Registry)); \
    METHOD(id##Registry, m_reload, void()) { \
        id##_state = 0; \
        Register##id(); \
    }

EVAL_REGISTER

#define EVAL_REGISTER

(

...

)

Value:

__VA_ARGS__

Definition at line 88 of file registry.qh.

EVAL_REGISTRY_SORT

#define EVAL_REGISTRY_SORT

(

...

)

Value:

__VA_ARGS__

Definition at line 129 of file registry.qh.

REGISTER

#define REGISTER

(

...

)

Value:

EVAL_REGISTER(OVERLOAD_(REGISTER, __VA_ARGS__))

Register a new entity with a registry.

Must be followed by a semicolon or a function body with a this parameter. Wrapper macros may perform actions after user initialization like so: #define REGISTER_FOO(id) \ REGISTER(Foos, FOO, id, m_id, NEW(Foo)) { \ print("Registering foo #", this.m_id + 1, "\n"); \ } \ REGISTER_INIT(FOO, id)

Parameters

registry	The registry to add each entity to.
ns	Short for namespace, prefix for each global (ns##_##id)
id	The identifier of the current entity being registered
fld	The field to store the locally unique unique entity id
inst	An expression to create a new instance, invoked for every registration

Definition at line 87 of file registry.qh.

Referenced by REGISTER().

REGISTER_4

#define REGISTER_4	(		registry,
			id,
			fld,
			inst )

Value:

    entity id; \
    REGISTER_INIT(id) {} \
    void Register_##id() \
    { \
        entity this = id; \
        if (this == NULL) { \
            _regCheck(registry##_COUNT, registry##_MAX); \
            this = id = inst; \
            this.registered_id = #id; \
            REGISTRY_PUSH(registry, fld, this); \
        } \
        Register_##id##_init(this); \
    } \
    ACCUMULATE_FUNCTION(_Register##registry, Register_##id) \
    REGISTER_INIT(id)

Definition at line 90 of file registry.qh.

#define REGISTER_4(registry, id, fld, inst) \
    entity id; \
    REGISTER_INIT(id) {} \
    void Register_##id() \
    { \
        entity this = id; \
        if (this == NULL) { \
            _regCheck(registry##_COUNT, registry##_MAX); \
            this = id = inst; \
            this.registered_id = #id; \
            REGISTRY_PUSH(registry, fld, this); \
        } \
        Register_##id##_init(this); \
    } \
    ACCUMULATE_FUNCTION(_Register##registry, Register_##id) \
    REGISTER_INIT(id)

REGISTER_5

#define REGISTER_5	(		registry,
			ns,
			id,
			fld,
			inst )

Value:

REGISTER_4(registry, ns##_##id, fld, inst)

Definition at line 89 of file registry.qh.

REGISTER_INIT

#define REGISTER_INIT

(

id

)

Value:

ACCUMULATE void Register_##id##_init(entity this)

Definition at line 122 of file registry.qh.

REGISTER_REGISTRY

#define REGISTER_REGISTRY

(

id

)

Value:

_REGISTER_REGISTRY(id, #id)

Definition at line 229 of file registry.qh.

Referenced by stopsound().

REGISTRY

#define REGISTRY	(		id,
			max )

Value:

    void Register##id(); \
    ACCUMULATE void REGISTRY_DEPENDS_(id) {} \
    REGISTRY_BEGIN(id) {} \
    REGISTRY_END(id) {} \
    void _Register##id() {} \
    int id##_state = 0; \
    void Register##id() { if (id##_state) return; id##_state = 1; REGISTRY_DEPENDS_(id); REGISTRY_BEGIN_(id); _Register##id(); id##_state = 2; REGISTRY_END_(id); } \
    const int id##_MAX = max; \
    int id##_COUNT; \
    noref entity id##_first, id##_last; \
    _R_MAP(_##id, id##_MAX); \
    SHUTDOWN(id) { _R_DEL(_##id); } \

Declare a new registry.

Don't forget to call REGISTER_REGISTRY and REGISTRY_DEFINE_GET: REGISTER_REGISTRY(Foos) REGISTRY_DEFINE_GET(Foos, null_ent)

Definition at line 26 of file registry.qh.

#define REGISTRY(id, max) \
    void Register##id(); \
    ACCUMULATE void REGISTRY_DEPENDS_(id) {} \
    REGISTRY_BEGIN(id) {} \
    REGISTRY_END(id) {} \
    void _Register##id() {} \
    int id##_state = 0; \
    void Register##id() { if (id##_state) return; id##_state = 1; REGISTRY_DEPENDS_(id); REGISTRY_BEGIN_(id); _Register##id(); id##_state = 2; REGISTRY_END_(id); } \
    const int id##_MAX = max; \
    int id##_COUNT; \
    noref entity id##_first, id##_last; \
    _R_MAP(_##id, id##_MAX); \
    SHUTDOWN(id) { _R_DEL(_##id); } \
 

REGISTRY_BEGIN

#define REGISTRY_BEGIN

(

id

)

Value:

ACCUMULATE void REGISTRY_BEGIN_(id) { noref void() f = Register##id; } void REGISTRY_BEGIN_(id)

Called before initializing a registry.

Definition at line 50 of file registry.qh.

REGISTRY_BEGIN_

#define REGISTRY_BEGIN_

(

id

)

Value:

Register##id##_First()

Definition at line 51 of file registry.qh.

REGISTRY_CHECK

#define REGISTRY_CHECK

(

id

)

Definition at line 175 of file registry.qh.

#define REGISTRY_CHECK(id) \
    string REGISTRY_HASH(id); \
    STATIC_INIT(Registry_check_##id) \
    { \
        /* Note: SHA256 isn't always available, use MD4 instead */ \
        string s = "", group = ""; \
        int str_len = 0, digests_len = 0, group_idx = 0; \
        FOREACH(id, true, { \
            group = strcat(group, ":", it.registered_id); \
            if (++group_idx < 50) /* this is to reduce strlen calls */ \
                continue; \
            int group_len = strlen(group); \
            if (str_len + 1 + group_len >= VM_TEMPSTRING_MAXSIZE) \
            { \
                /* keep previous digests and replace current string with its digest */ \
                s = strcat(substring(s, 0, digests_len), ":", digest_hex("MD4", s)); \
                digests_len = str_len = strlen(s); \
            } \
            s = strcat(s, group); \
            str_len += group_len; \
            group = ""; \
            group_idx = 0; \
        }); \
        s = strcat(s, group); \
        s = substring(s, 1, -1); /* remove initial ":" */ \
        string h = REGISTRY_HASH(id) = strzone(digest_hex("MD4", s)); \
        LOG_DEBUGF(#id ": %s\n[%s]", h, s); \
    } \
    void Registry_check(string r, string sv) /* called by CSQC */ \
    { \
        if (r == #id) \
        { \
            string cl = REGISTRY_HASH(id); \
            if (cl != sv) \
            { \
                LOG_FATALF("client/server mismatch (%s).\nCL: %s\nSV: %s", r, cl, sv); \
            } \
        } \
    } \
    void Registry_send_all() { Registry_send(#id, REGISTRY_HASH(id)); } /* called by SVQC */ \
 

REGISTRY_COUNT

#define REGISTRY_COUNT

(

id

)

Value:

id##_COUNT

Definition at line 18 of file registry.qh.

Referenced by Dump_Turret_Settings(), havocbot_chooseweapon(), HUD_Configure_Frame(), HUD_Main(), HUD_Panel_Check_Mouse_Pos(), HUD_Panel_CheckMove(), HUD_Panel_CheckResize(), HUD_Panel_ExportCfg(), HUD_Panel_FirstInDrawQ(), HUD_Panel_Highlight(), HUD_Panel_InputEvent(), HUD_Weapons(), NET_HANDLE(), Net_Write_Effect(), SettingSource::reload(), reset_tab_panels(), Scoreboard_AccuracyStats_Draw(), Scoreboard_ItemStats_Draw(), STATIC_INIT(), and STATIC_INIT().

REGISTRY_DEFINE_GET

#define REGISTRY_DEFINE_GET	(		id,
			null )

Value:

    entity id##_from(int i) { if (i >= 0 && i < id##_COUNT) { entity e = _R_GET(_##id, i); if (e) return e; } return null; }

Definition at line 40 of file registry.qh.

#define REGISTRY_DEFINE_GET(id, null) \
    entity id##_from(int i) { if (i >= 0 && i < id##_COUNT) { entity e = _R_GET(_##id, i); if (e) return e; } return null; }

Referenced by REGISTER(), REGISTER_MONSTER(), REGISTER_RADARICON(), REGISTER_TURRET(), REGISTER_VEHICLE(), REGISTER_WEAPON(), and STATIC_INIT().

REGISTRY_DEPENDS

#define REGISTRY_DEPENDS	(		id,
			dep )

Value:

void Register##dep(); void REGISTRY_DEPENDS_(id) { Register##dep(); }

Add registry dependencies to a registry.

Definition at line 46 of file registry.qh.

REGISTRY_DEPENDS_

#define REGISTRY_DEPENDS_

(

id

)

Value:

Register##id##_Depends()

Definition at line 47 of file registry.qh.

REGISTRY_END

#define REGISTRY_END

(

id

)

Value:

ACCUMULATE void REGISTRY_END_(id) { noref void() f = Register##id; } void REGISTRY_END_(id)

Called after initializing a registry.

Definition at line 54 of file registry.qh.

REGISTRY_END_

#define REGISTRY_END_

(

id

)

Value:

Register##id##_Done()

Definition at line 55 of file registry.qh.

REGISTRY_GET

#define REGISTRY_GET	(		id,
			i )

Value:

id##_from(i)

Definition at line 43 of file registry.qh.

Referenced by bot_cmd_select_weapon(), BUFF_NAME(), bumble_raygun_draw(), CL_Weapon_GetShotOrg(), Deathtype_Name(), DrawAmmoNades(), fixPriorityList(), Get_Notif_Ent(), SettingSource::getEntry(), SettingSource::getEntryTooltip(), GiveWeapon(), havocbot_chooseweapon(), HUD_Configure_Frame(), HUD_Crosshair_Vehicle(), HUD_Main(), HUD_Notify(), HUD_Panel_Check_Mouse_Pos(), HUD_Panel_CheckMove(), HUD_Panel_CheckResize(), HUD_Panel_ExportCfg(), HUD_Panel_Highlight(), HUD_Panel_InputEvent(), HUD_Radar(), HUD_Vehicle(), Inventory_Write(), Item_GiveTo(), Item_RespawnCountdown(), MDL_GIB_ROBO_RANDOM(), MDL_NUM(), Monster_Dead_Think(), MUTATOR_HOOKFUNCTION(), nade_boom(), nade_burn_spawn(), nade_customize(), nade_pickup(), nade_prime(), nade_spawn(), Nades_GetType(), Net_ClientCommand(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NIX_CanChooseWeapon(), NIX_GiveCurrentWeapon(), notif_arg_item_wepammo(), Obituary_SpecialDeath(), Projectile_DrawTrail(), ServerList_TypeSort_Click(), SND_BRASS_RANDOM(), SND_CASINGS_RANDOM(), SND_FLACEXP_RANDOM(), SND_GIB_SPLAT_RANDOM(), SND_GRENADE_BOUNCE_RANDOM(), SND_HAGEXP_RANDOM(), SND_NEXWHOOSH_RANDOM(), SND_RIC_RANDOM(), SND_SEEKEREXP_RANDOM(), SND_TAGEXP_RANDOM(), spritelookupblinkvalue(), spritelookupcolor(), spritelookupicon(), spritelookuptext(), StartItem(), STATIC_INIT(), StatusEffects_Write(), View_EventChase(), W_CycleWeapon(), W_DropEvent(), W_FixWeaponOrder_BuildImpulseList_cmp(), W_GetCycleWeapon(), W_GiveWeapon(), W_IsWeaponThrowable(), W_LastWeapon(), W_NameWeaponOrder_MapFunc(), W_NextWeaponOnImpulse(), W_ThrowNewWeapon(), XonoticKeyBinder_resizeNotify(), XonoticMutatorsDialog_fill(), XonoticWeaponsList_drawListBoxItem(), XonoticWeaponsList_resizeNotify(), and XonoticWeaponsList_toString().

REGISTRY_HASH

#define REGISTRY_HASH

(

id

)

Value:

Registry_hash_##id

Definition at line 162 of file registry.qh.

REGISTRY_MAX

#define REGISTRY_MAX

(

id

)

Value:

id##_MAX

Definition at line 17 of file registry.qh.

Referenced by _GametypeFlags_FromGametype(), _WepSet_FromWeapon(), accuracy_reset(), HUD_ItemsTime(), HUD_Weapons(), Item_ItemsTime_ResetTimes(), Item_ItemsTime_ResetTimesForPlayer(), Item_ItemsTime_SetTime(), Item_ItemsTime_SetTimesForPlayer(), ReadWepSet(), STATIC_INIT(), STATIC_INIT(), and WriteWepSet().

REGISTRY_NEXT

#define REGISTRY_NEXT   enemy

internal next pointer

Definition at line 125 of file registry.qh.

REGISTRY_PUSH

#define REGISTRY_PUSH	(		registry,
			fld,
			it )

Value:

    MACRO_BEGIN \
    it.fld = registry##_COUNT; \
    _R_SET(_##registry, registry##_COUNT, it); \
    ++registry##_COUNT; \
    if (!registry##_first) registry##_first = it; \
    if (registry##_last)   registry##_last.REGISTRY_NEXT = it; \
    registry##_last = it; \
MACRO_END

Definition at line 107 of file registry.qh.

#define REGISTRY_PUSH(registry, fld, it) MACRO_BEGIN \
    it.fld = registry##_COUNT; \
    _R_SET(_##registry, registry##_COUNT, it); \
    ++registry##_COUNT; \
    if (!registry##_first) registry##_first = it; \
    if (registry##_last)   registry##_last.REGISTRY_NEXT = it; \
    registry##_last = it; \
MACRO_END

REGISTRY_RESERVE

#define REGISTRY_RESERVE	(		registry,
			fld,
			id,
			suffix )

Value:

    MACRO_BEGIN \
    entity e = new_pure(registry_reserved); \
    e.registered_id = #id "/" #suffix; \
    REGISTRY_PUSH(registry, fld, e); \
MACRO_END

Definition at line 116 of file registry.qh.

#define REGISTRY_RESERVE(registry, fld, id, suffix) MACRO_BEGIN \
    entity e = new_pure(registry_reserved); \
    e.registered_id = #id "/" #suffix; \
    REGISTRY_PUSH(registry, fld, e); \
MACRO_END

REGISTRY_SORT

#define REGISTRY_SORT

(

...

)

Value:

EVAL_REGISTRY_SORT(OVERLOAD(REGISTRY_SORT, __VA_ARGS__))

Definition at line 128 of file registry.qh.

REGISTRY_SORT_1

#define REGISTRY_SORT_1

(

id

)

Value:

REGISTRY_SORT_2(id, 0)

Definition at line 130 of file registry.qh.

REGISTRY_SORT_2

#define REGISTRY_SORT_2	(		id,
			skip )

Value:

    void _REGISTRY_SWAP_##id(int i, int j, entity pass) \
    { \
        i += skip; j += skip; \
        \
        entity a = _R_GET(_##id, i), b = _R_GET(_##id, j); \
        _R_SET(_##id, i, b); \
        _R_SET(_##id, j, a); \
        \
        entity a_next = a.REGISTRY_NEXT, b_next = b.REGISTRY_NEXT; \
        a.REGISTRY_NEXT = b_next; \
        b.REGISTRY_NEXT = a_next; \
        \
        if (i == 0) id##_first = b; \
        else _R_GET(_##id, i - 1).REGISTRY_NEXT = b; \
        \
        if (j == 0) id##_first = a; \
        else _R_GET(_##id, j - 1).REGISTRY_NEXT = a; \
    } \
    int _REGISTRY_CMP_##id(int i, int j, entity pass) \
    { \
        i += skip; j += skip; \
        string a = _R_GET(_##id, i).registered_id; \
        string b = _R_GET(_##id, j).registered_id; \
        return strcmp(a, b); \
    } \
    STATIC_INIT(Registry_sort_##id) \
    { \
        heapsort(id##_COUNT - (skip), _REGISTRY_SWAP_##id, _REGISTRY_CMP_##id, NULL); \
    }

Definition at line 131 of file registry.qh.

#define REGISTRY_SORT_2(id, skip) \
    void _REGISTRY_SWAP_##id(int i, int j, entity pass) \
    { \
        i += skip; j += skip; \
        \
        entity a = _R_GET(_##id, i), b = _R_GET(_##id, j); \
        _R_SET(_##id, i, b); \
        _R_SET(_##id, j, a); \
        \
        entity a_next = a.REGISTRY_NEXT, b_next = b.REGISTRY_NEXT; \
        a.REGISTRY_NEXT = b_next; \
        b.REGISTRY_NEXT = a_next; \
        \
        if (i == 0) id##_first = b; \
        else _R_GET(_##id, i - 1).REGISTRY_NEXT = b; \
        \
        if (j == 0) id##_first = a; \
        else _R_GET(_##id, j - 1).REGISTRY_NEXT = a; \
    } \
    int _REGISTRY_CMP_##id(int i, int j, entity pass) \
    { \
        i += skip; j += skip; \
        string a = _R_GET(_##id, i).registered_id; \
        string b = _R_GET(_##id, j).registered_id; \
        return strcmp(a, b); \
    } \
    STATIC_INIT(Registry_sort_##id) \
    { \
        heapsort(id##_COUNT - (skip), _REGISTRY_SWAP_##id, _REGISTRY_CMP_##id, NULL); \
    }

Function Documentation

_regCheck()

void _regCheck	(	int	i,
		int	_max )

Definition at line 62 of file registry.qh.

{
    // this is inside a function to avoid expanding it on compilation everytime
    // (this very long line would be repeated literally thousands times!)
    if (i >= _max)
        LOG_FATALF("Registry capacity exceeded (%d)", _max);
}

References LOG_FATALF.

Registry_check()

ERASEABLE ACCUMULATE void Registry_check	(	string	r,
		string	sv )

Definition at line 165 of file registry.qh.

{ }

References ACCUMULATE.

Referenced by NET_HANDLE().

Registry_send()

void Registry_send	(	string	id,
		string	hash )

Definition at line 20 of file registry_net.qh.

{
    int channel = MSG_ONE;
    WriteHeader(channel, registry);
    WriteString(channel, id);
    WriteString(channel, hash);
}

References MSG_ONE, WriteHeader, and WriteString().

Registry_send_all()

ERASEABLE ACCUMULATE void Registry_send_all

(

)

Definition at line 167 of file registry.qh.

{ }

References ACCUMULATE.

Referenced by ClientInit_SendEntity().

Variable Documentation

registered_id

string registered_id

registered item identifier

Definition at line 60 of file registry.qh.

Referenced by Animation::LOG_DEBUGF(), and Mutator_SendEntity().

REGISTRY_NEXT

entity REGISTRY_NEXT

Definition at line 126 of file registry.qh.