intrusivelist.qh File Reference

#include "bits.qh"
#include "iter.qh"
#include "test.qh"

Include dependency graph for intrusivelist.qh:

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

Go to the source code of this file.

Classes
class	IntrusiveList
	limitations: NULL cannot be present elements can only be present once a maximum of IL_MAX lists can exist at one time freed entities must be removed from the list More...

Macros
#define	IL_CEIL(n)
#define	IL_CLEAR(this)
	Remove all elements.
#define	IL_DELETE(this)
	Delete the list.
#define	IL_EACH(this, cond, body)
#define	IL_EMPTY(this)
#define	IL_FIRST(this)
#define	IL_FLOOR(n)
#define	IL_LAST(this)
#define	IL_LISTS_PER_BIT   IL_CEIL(IL_MAX / (3 * 24))
#define	IL_NEW()
#define	IL_PEEK(this)
#define	IL_TEST_BUILD()

Functions
ERASEABLE bool	IL_CONTAINS (IntrusiveList this, entity it)
ERASEABLE void	IL_DTOR (entity this)
ERASEABLE void	IL_DTOR (IntrusiveList this)
ERASEABLE void	IL_ENDFRAME ()
ERASEABLE void	IL_INIT (entity this)
ERASEABLE void	IL_INIT (IntrusiveList this)
ERASEABLE entity	IL_POP (IntrusiveList this)
	Pop from tail.
ERASEABLE entity	IL_PUSH (IntrusiveList this, entity it)
	Push to tail.
ERASEABLE void	IL_REMOVE (IntrusiveList this, entity it)
	Remove any element, anywhere in the list.
void	IL_REMOVE_RAW (entity it)
	Clears any IL data from an entity (not an intrusive list).
ERASEABLE entity	IL_SHIFT (IntrusiveList this)
	Pop from head.
string	il_test_build (entity il_test, entity ent1, entity ent2, entity ent3, entity ent4, entity ent5)
ERASEABLE entity	IL_UNSHIFT (IntrusiveList this, entity it)
	Push to head.
void	ONREMOVE (entity this)
	Called when an entity is deleted with delete() / remove() or when a player disconnects.
	TEST (intrusivelist, ModificationsWhileLooping)

Variables
int	il_id
IntrusiveList	il_links [IL_MAX]
entity	il_links_flds [IL_MAX *2]
int	il_links_ptr
vector	il_listmask
vector	il_lists
const int	IL_MAX = 128
	Maximum amount of creatable lists.

Macro Definition Documentation

IL_CEIL

#define IL_CEIL

(

n

)

Value:

IL_FLOOR((n) + 0.5)

Definition at line 222 of file intrusivelist.qh.

IL_CLEAR

#define IL_CLEAR

(

this

)

Value:

    MACRO_BEGIN \
    IntrusiveList _il = this; \
    assert(_il); \
    .entity il_prev = _il.il_prevfld; \
    .entity il_next = _il.il_nextfld; \
    noref int i = 0; \
    for (entity _next, _it = _il.il_head; _it; (_it = _next, ++i)) \
    { \
        _next = _it.(il_next); \
        _it.(il_next) = _it.(il_prev) = NULL; \
    } \
    _il.il_head = _il.il_tail = NULL; \
MACRO_END

Remove all elements.

Definition at line 174 of file intrusivelist.qh.

#define IL_CLEAR(this) MACRO_BEGIN \
    IntrusiveList _il = this; \
    assert(_il); \
    .entity il_prev = _il.il_prevfld; \
    .entity il_next = _il.il_nextfld; \
    noref int i = 0; \
    for (entity _next, _it = _il.il_head; _it; (_it = _next, ++i)) \
    { \
        _next = _it.(il_next); \
        _it.(il_next) = _it.(il_prev) = NULL; \
    } \
    _il.il_head = _il.il_tail = NULL; \
MACRO_END

Referenced by _Movetype_PushMove(), CommonCommand_editmob(), crosshair_trace_plusvisibletriggers__is_wz(), FireRailgunBullet(), IL_DTOR(), il_test_build(), Invasion_CheckWinner(), and pathlib_cleanup().

IL_DELETE

#define IL_DELETE

(

this

)

Value:

    MACRO_BEGIN \
    delete(this); \
    this = NULL; \
MACRO_END

Delete the list.

Definition at line 189 of file intrusivelist.qh.

#define IL_DELETE(this) MACRO_BEGIN \
    delete(this); \
    this = NULL; \
MACRO_END

Referenced by Promise_reject(), Promise_resolve(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), and TEST().

IL_EACH

#define IL_EACH	(		this,
			cond,
			body )

Value:

    MACRO_BEGIN \
    IntrusiveList _il = this; \
    assert(_il); \
    .entity il_next = _il.il_nextfld; \
    noref int i = 0; \
    entity il_loop_item_save = this.il_loop_item; \
    this.il_loop_item = NULL; \
    for (entity _next, _it = _il.il_head; _it; _it = _next, ++i) \
    { \
        const noref entity it = _it; \
        this.il_loop_item = it; \
        _next = it.(il_next); \
        if (cond) \
            LAMBDA(body) \
        if (this.il_loop_item != it) /* current item removed? */ \
            _next = this.il_loop_item; \
        else \
            _next = it.(il_next); /* in case next item has changed */ \
    } \
    this.il_loop_item = il_loop_item_save; \
MACRO_END

Definition at line 194 of file intrusivelist.qh.

#define IL_EACH(this, cond, body) MACRO_BEGIN \
    IntrusiveList _il = this; \
    assert(_il); \
    .entity il_next = _il.il_nextfld; \
    noref int i = 0; \
    entity il_loop_item_save = this.il_loop_item; \
    this.il_loop_item = NULL; \
    for (entity _next, _it = _il.il_head; _it; _it = _next, ++i) \
    { \
        const noref entity it = _it; \
        this.il_loop_item = it; \
        _next = it.(il_next); \
        if (cond) \
            LAMBDA(body) \
        if (this.il_loop_item != it) /* current item removed? */ \
            _next = this.il_loop_item; \
        else \
            _next = it.(il_next); /* in case next item has changed */ \
    } \
    this.il_loop_item = il_loop_item_save; \
MACRO_END

Referenced by _Movetype_PushMove(), antilag_restore_all(), antilag_takeback_all(), assault_new_round(), assault_objective_use(), assault_roundstart_use(), assault_setenemytoobjective(), bot_serverframe(), botframe_autowaypoints_createwp(), botframe_autowaypoints_fix_from(), botframe_deleteuselesswaypoints(), botframe_updatedangerousobjects(), checkpoint_passed(), client_hasweapon(), ClientConnect(), ClientDisconnect(), ClientKill_TeamChange(), CommonCommand_editmob(), conveyor_think(), counter_reset(), counter_use(), CreatureFrame_All(), crosshair_trace_plusvisibletriggers__is_wz(), crosshair_trace_waypoints(), CSQC_UpdateView(), ctf_CheckStalemate(), ctf_DelayedInit(), ctf_FlagThink(), ctf_Handle_Capture(), ctf_RemovePlayer(), cvar_settemp(), Domination_count_controlpoints(), dompoint_captured(), EndFrame(), findnearest(), Fire_ApplyDamage(), FireImoBeam(), FireRailgunBullet(), func_breakable_behave_destroyed(), func_ladder_think(), havocbot_ai(), havocbot_chooseenemy(), havocbot_ctf_calculate_middlepoint(), havocbot_ctf_find_enemy_flag(), havocbot_ctf_find_flag(), havocbot_ctf_is_basewaypoint(), havocbot_goalrating_ast_targets(), havocbot_goalrating_ball(), havocbot_goalrating_controlpoints(), havocbot_goalrating_ctf_droppedflags(), havocbot_goalrating_ctf_enemyflag(), havocbot_goalrating_ctf_ourbase(), havocbot_goalrating_items(), havocbot_goalrating_ons_controlpoints_attack(), havocbot_goalrating_ons_generator_attack(), havocbot_goalrating_tkaball(), havocbot_goalrating_waypoints(), havocbot_moveto(), havocbot_movetogoal(), havocbot_role_cts(), havocbot_role_race(), havocbot_select_an_item_of_group(), HUD_Ammo(), HUD_Radar(), Invasion_CheckWinner(), invasion_GetWaveEntity(), invasion_PickSpawn(), Item_FindTeam(), Item_ItemsTime_UpdateTime(), Item_Touch(), ka_RemoveBalls(), Kill_Notification(), LimitedChildrenRubble(), Monster_FindTarget(), MoveToRandomLocationWithinBounds(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), nade_boom(), nade_touch(), navigation_checkladders(), navigation_findnearestwaypoint_withdist_except(), navigation_get_really_close_waypoint(), navigation_markroutes(), navigation_markroutes_inverted(), navigation_markroutes_nearestwaypoints(), navigation_routerating(), navigation_unstuck(), NET_HANDLE(), onslaught_updatelinks(), pathlib_cleanup(), pathlib_nodeatpoint(), pathlib_waypointpath(), Physics_Frame(), Promise_reject(), Promise_resolve(), PutPlayerInServer(), race_GetFractionalLapCount(), RandomItems_GetRandomInstagibItemClassName(), RandomItems_GetRandomOverkillItemClassName(), raptor_flare_think(), raptor_frame(), sandbox_Database_Save(), sandbox_ObjectAttach_Remove(), sandbox_ObjectPort_Save(), Scoreboard_ItemStats_Draw(), Scoreboard_ItemStats_WouldDraw(), SelectObservePoint(), SelectSpawnPoint(), setItemGroupCount(), spawner_use(), spiderbot_exit(), spiderbot_guide_release(), StartFrame(), swamp_think(), target_give_use(), target_items_use(), target_music_kill(), TargetMusic_RestoreGame(), Teleport_Find(), TEST(), tka_RemoveBalls(), trigger_push_velocity_think(), trigger_race_checkpoint_verify(), turret_hk_missile_think(), turret_targettrigger_touch(), turrets_manager_think(), UncustomizeEntitiesRun(), vehicles_clearreturn(), W_MineLayer_Count(), W_MineLayer_PlacedMines(), W_Seeker_Attack(), W_Seeker_Tagged_Info(), WarpZone_Find(), WarpZone_MakeAllOther(), WarpZone_MakeAllSolid(), WarpZone_StartFrame(), waypoint_addlink_for_custom_jumppad(), waypoint_get(), waypoint_get_type_name(), waypoint_load_links(), waypoint_remove(), waypoint_save_hardwiredlinks(), waypoint_save_links(), waypoint_saveall(), waypoint_schedulerelinkall(), waypoint_showlinks_to(), waypoint_spawn(), waypoint_spawn_fromeditor(), waypoint_spawnforitem_force(), waypoint_think(), waypoint_unreachable(), waypoint_updatecost_foralllinks(), weapon_prepareattack_checkammo(), Weapon_whereis(), WinningCondition_Invasion(), and WinningCondition_RanOutOfSpawns().

IL_EMPTY

#define IL_EMPTY

(

this

)

Value:

(this.il_head == NULL)

Definition at line 50 of file intrusivelist.qh.

Referenced by draw_ClearClip(), ka_Handler_CheckBall(), and tka_Handler_CheckBall().

IL_FIRST

#define IL_FIRST

(

this

)

Value:

(this.il_head)

Definition at line 52 of file intrusivelist.qh.

Referenced by SelectSpawnPoint().

IL_FLOOR

#define IL_FLOOR

(

n

)

Value:

((n) | 0)

Definition at line 221 of file intrusivelist.qh.

Referenced by IL_INIT().

IL_LAST

#define IL_LAST

(

this

)

Value:

(this.il_tail)

Definition at line 53 of file intrusivelist.qh.

IL_LISTS_PER_BIT

#define IL_LISTS_PER_BIT   IL_CEIL(IL_MAX / (3 * 24))

Definition at line 224 of file intrusivelist.qh.

Referenced by IL_INIT().

IL_NEW

#define IL_NEW

(

)

Value:

NEW(IntrusiveList)

Definition at line 48 of file intrusivelist.qh.

Referenced by _Promise_handle(), dom_Initialize(), g_spawn_queue_spawn(), ons_Initialize(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), spawnfunc(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), target_checkpoint_setup(), TEST(), and W_Electro_Attack_Orb().

IL_PEEK

#define IL_PEEK

(

this

)

Value:

(this.il_tail)

Definition at line 54 of file intrusivelist.qh.

Referenced by _draw_SetClip(), and draw_ClearClip().

IL_TEST_BUILD

#define IL_TEST_BUILD

(

)

Value:

s = il_test_build(il_test, ent1, ent2, ent3, ent4, ent5)

Definition at line 320 of file intrusivelist.qh.

Referenced by TEST().

Function Documentation

IL_CONTAINS()

ERASEABLE bool IL_CONTAINS	(	IntrusiveList	this,
		entity	it )

Definition at line 57 of file intrusivelist.qh.

{
    assert(this, return false);
    return (it.(this.il_nextfld) || this.il_head == it || this.il_tail == it);
}

References assert, and entity().

Referenced by ctf_Handle_Pickup(), ctf_RespawnFlag(), IL_PUSH(), IL_UNSHIFT(), kh_Key_Attach(), kh_Key_Detach(), ONREMOVE(), ons_GeneratorReset(), set_movetype(), spawnfunc(), and W_Electro_Orb_Stick().

IL_DTOR() [1/2]

ERASEABLE void IL_DTOR

(

entity

this

)

References entity(), and ERASEABLE.

Referenced by IntrusiveList::~IntrusiveList().

IL_DTOR() [2/2]

ERASEABLE void IL_DTOR

(

IntrusiveList

this

)

Definition at line 264 of file intrusivelist.qh.

{
    IL_CLEAR(this);
    il_links[this.il_id] = NULL;
}

References IL_CLEAR, il_id, il_links, and NULL.

IL_ENDFRAME()

ERASEABLE void IL_ENDFRAME

(

)

Definition at line 271 of file intrusivelist.qh.

{
#if 0
    // incompatible with CSQC, remove() clears entities
    for (int i = 0; i < IL_MAX; ++i)
    {
        IntrusiveList list = il_links[i];
        if (list)
        {
            .entity nextfld = list.il_nextfld;
            for (entity next, it = list.il_head; it; it = next)
            {
                next = it.(nextfld);
                if (wasfreed(it))
                    IL_REMOVE(list, it);
            }
        }
    }
#endif
}

References entity(), il_links, IL_MAX, IntrusiveList::il_nextfld, IL_REMOVE(), and next.

Referenced by CSQC_UpdateView(), EndFrame(), and m_draw().

IL_INIT() [1/2]

ERASEABLE void IL_INIT

(

entity

this

)

References entity(), and ERASEABLE.

Referenced by IntrusiveList::IntrusiveList().

IL_INIT() [2/2]

ERASEABLE void IL_INIT

(

IntrusiveList

this

)

Definition at line 227 of file intrusivelist.qh.

{
    .entity nextfld, prevfld;
    for (int i = il_links_ptr; i < il_links_ptr + IL_MAX; ++i)
    {
        int id = i;
        if (id >= IL_MAX)
            id -= IL_MAX;
 
        if (!il_links[id])
        {
            il_links[id] = this;
            int flds_idx = id * 2;
            nextfld = il_links_flds[flds_idx + 0];
            prevfld = il_links_flds[flds_idx + 1];
            this.il_id = id;
            int bit = IL_FLOOR(id / IL_LISTS_PER_BIT);
            if (bit < 1 * 24)
                this.il_listmask = '1 0 0' * BIT(bit - (0 * 24));
            else if (bit < 2 * 24)
                this.il_listmask = '0 1 0' * BIT(bit - (1 * 24));
            else if (bit < 3 * 24)
                this.il_listmask = '0 0 1' * BIT(bit - (2 * 24));
            else
                assert(false);
            il_links_ptr = id + 1;
            if (il_links_ptr >= IL_MAX)
                il_links_ptr -= IL_MAX;
            this.il_nextfld = nextfld;
            this.il_prevfld = prevfld;
            return;
        }
    }
    LOG_WARN("IntrusiveList overflow");
}

References assert, BIT, IL_FLOOR, il_id, il_links, il_links_flds, il_links_ptr, il_listmask, IL_LISTS_PER_BIT, IL_MAX, and LOG_WARN.

IL_POP()

ERASEABLE entity IL_POP

(

IntrusiveList

this

)

Pop from tail.

Definition at line 105 of file intrusivelist.qh.

{
    assert(this, return NULL);
    .entity il_next = this.il_nextfld;
    .entity il_prev = this.il_prevfld;
 
    if (!this.il_tail)
        return NULL;
    entity it = this.il_tail;
    entity prev = it.(il_prev);
    if (prev)
        (this.il_tail = prev).(il_next) = NULL;
    else
        this.il_head = this.il_tail = NULL;
    if (this.il_loop_item == it)
        this.il_loop_item = NULL;
    it.(il_prev) = NULL;
    return it;
}

References assert, entity(), NULL, and prev.

Referenced by TEST().

IL_PUSH()

ERASEABLE entity IL_PUSH	(	IntrusiveList	this,
		entity	it )

Push to tail.

Definition at line 65 of file intrusivelist.qh.

{
    assert(this, return NULL);
    assert(it, return NULL);
    .entity il_next = this.il_nextfld;
    .entity il_prev = this.il_prevfld;
    assert(!IL_CONTAINS(this, it), return NULL);
 
    entity tail = it.(il_prev) = this.il_tail;
    if (tail)
        tail.(il_next) = it;
    else
        this.il_head = it;
    this.il_tail = it;
    it.il_lists |= this.il_listmask;
    return it;
}

References assert, entity(), IL_CONTAINS(), il_listmask, and NULL.

Referenced by DamageText::DamageText(), DebugText3d::DebugText3d(), __spawnfunc_defer(), __spawnfunc_spawn(), _draw_SetClip(), _Movetype_PushMove(), _Promise_handle(), buff_Init(), conveyor_think(), CopyBody(), counter_use(), cpicon_construct(), crosshair_trace_plusvisibletriggers__is_wz(), ctf_FlagSetup(), ctf_Handle_Drop(), ctf_Handle_Pickup(), cvar_settemp(), dom_controlpoint_setup(), electro_orb_setup(), Ent_WaypointSprite(), fd_secret_use(), FireGrapplingHook(), FireImoBeam(), FireRailgunBullet(), freezetag_Unfreeze(), func_breakable_behave_restore(), func_breakable_setup(), func_ladder_think(), generator_construct(), il_test_build(), ka_DropEvent(), ka_SpawnBalls(), kh_Key_Detach(), ListNewChildRubble(), LocalCommand_debugmodel(), M_Golem_Attack_Lightning(), M_Mage_Attack_Spike(), M_Spider_Attack_Web(), monster_changeteam(), Monster_Spawn(), Monster_Spawn_Setup(), nade_darkness_boom(), nade_ice_boom(), nade_napalm_ball(), nade_napalm_boom(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), NET_HANDLE(), ons_CaptureShield_Spawn(), ons_ControlPoint_Icon_Spawn(), ons_generator_ray_spawn(), ons_GeneratorReset(), ons_GeneratorSetup(), onslaught_updatelinks(), orb_setup(), pathlib_mknode(), PutPlayerInServer(), RaptorCBShellfragToss(), REGISTER_MUTATOR(), REGISTER_MUTATOR(), relocate_spawnpoint(), ReplaceOldListedChildRubble(), sandbox_ObjectSpawn(), Send_Notification(), set_movetype(), SetCustomizer(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), spawnfunc(), StartItem(), STATIC_INIT(), STATIC_INIT(), STATIC_INIT(), SV_OnEntityPreSpawnFunction(), swamp_think(), target_checkpoint_setup(), TEST(), tka_SpawnBalls(), toss_nade(), TossGib(), turret_construct(), turret_initialize(), turret_projectile(), vehicle_initialize(), vehicles_projectile(), vehicles_setreturn(), vehicles_spawn(), W_Arc_Attack_Bolt(), W_Arc_Beam(), W_Blaster_Attack(), W_Crylink_Attack(), W_Crylink_Attack2(), W_Devastator_Attack(), W_Electro_Attack_Bolt(), W_Electro_Attack_Orb(), W_Electro_Orb_Stick(), W_Fireball_Attack1(), W_Fireball_Attack2(), W_Hagar_Attack(), W_Hagar_Attack2(), W_Hagar_Attack2_Load_Release(), W_HLAC_Attack(), W_HLAC_Attack2(), W_Hook_Attack2(), W_MineLayer_Attack(), W_MineLayer_Stick(), W_Mortar_Attack(), W_Mortar_Attack2(), W_Nexball_Attack2(), W_OverkillRocketPropelledChainsaw_Attack(), W_Porto_Attack(), W_Porto_Fail(), W_RocketMinsta_Attack(), W_Seeker_Fire_Flac(), W_Seeker_Fire_Missile(), W_Seeker_Fire_Tag(), W_Seeker_Tag_Touch(), walker_fire_rocket(), and waypoint_spawn().

IL_REMOVE()

ERASEABLE void IL_REMOVE	(	IntrusiveList	this,
		entity	it )

Remove any element, anywhere in the list.

Definition at line 149 of file intrusivelist.qh.

{
    assert(this, return);
    .entity il_next = this.il_nextfld;
    .entity il_prev = this.il_prevfld;
    //assert(!IL_CONTAINS(this, it), return);
    entity next = it.(il_next);
    entity prev = it.(il_prev);
    entity ohead = this.il_head;
    entity otail = this.il_tail;
    if (next)
        next.(il_prev) = prev;
    else
        this.il_tail = prev;
    if (prev)
        prev.(il_next) = next;
    else
        this.il_head = next;
    LOG_DEBUGF("remove %i (%i :: %i), head: %i -> %i, tail: %i -> %i", it, it.(il_prev), it.(il_next), ohead, this.il_head, otail, this.il_tail);
    if (this.il_loop_item == it)
        this.il_loop_item = it.(il_next);
    it.(il_next) = it.(il_prev) = NULL;
}

References assert, entity(), LOG_DEBUGF, next, NULL, and prev.

Referenced by ctf_Handle_Pickup(), ctf_RespawnFlag(), DamageText::DamageText_draw2d(), draw_ClearClip(), dumpnode(), freezetag_Freeze(), func_breakable_behave_destroyed(), IL_ENDFRAME(), invasion_SpawnChosenMonster(), ka_TouchEvent(), kh_Key_Attach(), MUTATOR_HOOKFUNCTION(), NET_HANDLE(), ONREMOVE(), ons_generator_ray_draw(), onslaught_updatelinks(), PlayerCorpseDamage(), PutObserverInServer(), PutPlayerInServer(), race_SendTime(), ReplaceOldListedChildRubble(), and TEST().

IL_REMOVE_RAW()

void IL_REMOVE_RAW

(

entity

it

)

Clears any IL data from an entity (not an intrusive list).

it should be used only in very particular cases such as after a copyentity call

Definition at line 294 of file intrusivelist.qh.

{
    if (it.il_lists)
    {
        it.il_lists = '0 0 0';
        for (int i = 0; i < IL_MAX * 2; ++i)
            it.il_links_flds[i] = nil;
    }
}

References entity(), and IL_MAX.

Referenced by copyentity_qc().

IL_SHIFT()

ERASEABLE entity IL_SHIFT

(

IntrusiveList

this

)

Pop from head.

Definition at line 127 of file intrusivelist.qh.

{
    assert(this, return NULL);
    .entity il_next = this.il_nextfld;
    .entity il_prev = this.il_prevfld;
 
    if (!this.il_head)
        return NULL;
    entity it = this.il_head;
    entity next = it.(il_next);
    if (next)
        (this.il_head = next).(il_prev) = NULL;
    else
        this.il_head = this.il_tail = NULL;
    if (this.il_loop_item == it)
        this.il_loop_item = it.(il_next);
    it.(il_next) = NULL;
    return it;
}

References assert, entity(), next, and NULL.

Referenced by TEST().

il_test_build()

string il_test_build	(	entity	il_test,
		entity	ent1,
		entity	ent2,
		entity	ent3,
		entity	ent4,
		entity	ent5 )

Definition at line 322 of file intrusivelist.qh.

{
    IL_CLEAR(il_test);
    IL_PUSH(il_test, ent1);
    IL_PUSH(il_test, ent2);
    IL_PUSH(il_test, ent3);
    IL_PUSH(il_test, ent4);
    IL_PUSH(il_test, ent5);
    return "";
}

References entity(), IL_CLEAR, and IL_PUSH().

IL_UNSHIFT()

ERASEABLE entity IL_UNSHIFT	(	IntrusiveList	this,
		entity	it )

Push to head.

Definition at line 85 of file intrusivelist.qh.

{
    assert(this, return NULL);
    assert(it, return NULL);
    .entity il_next = this.il_nextfld;
    .entity il_prev = this.il_prevfld;
    assert(!IL_CONTAINS(this, it), return NULL);
 
    entity head = it.(il_next) = this.il_head;
    if (head)
        head.(il_prev) = it;
    else
        this.il_tail = it;
    this.il_head = it;
    it.il_lists |= this.il_listmask;
    return it;
}

References assert, entity(), IL_CONTAINS(), il_listmask, and NULL.

ONREMOVE()

void ONREMOVE

(

entity

this

)

Called when an entity is deleted with delete() / remove() or when a player disconnects.

Definition at line 306 of file intrusivelist.qh.

{
    // remove 'this' from any intrusive lists it is on
    vector lists = this.il_lists;
    if (lists)
        for (int i = 0; i < IL_MAX; ++i)
        {
            IntrusiveList list = il_links[i];
            if ((lists & list.il_listmask) && IL_CONTAINS(list, this))
                IL_REMOVE(list, this);
        }
}

References entity(), IL_CONTAINS(), il_links, il_lists, IL_MAX, IL_REMOVE(), and vector.

TEST()

TEST	(	intrusivelist	,
		ModificationsWhileLooping	)

Definition at line 333 of file intrusivelist.qh.

{
    IntrusiveList il_test = IL_NEW();
    entity ent1 = new(1), ent2 = new(2), ent3 = new(3), ent4 = new(4), ent5 = new(5);
    string s;
 
    IL_TEST_BUILD();
    IL_EACH(il_test, true,
    {
        s = strcat(s, it.classname);
        if (it == ent2)  IL_REMOVE(il_test, ent3);
        if (it == ent4)  IL_PUSH(il_test, ent3);
    });
    EXPECT_TRUE(s == "12453");
 
    IL_TEST_BUILD();
    IL_EACH(il_test, true,
    {
        s = strcat(s, it.classname);
        if (it == ent2)  IL_REMOVE(il_test, ent2);
        if (it == ent3)  IL_REMOVE(il_test, ent3);
        if (it == ent3)  IL_REMOVE(il_test, ent4);
        if (it == ent5)  IL_POP(il_test);
    });
    EXPECT_TRUE(s == "1235");
 
    IL_TEST_BUILD();
    IL_REMOVE(il_test, ent5);
    IL_EACH(il_test, true,
    {
        s = strcat(s, it.classname);
        if (it == ent1) IL_SHIFT(il_test);
        if (it == ent4) IL_POP(il_test);
    });
    EXPECT_TRUE(s == "1234");
 
    IL_TEST_BUILD();
    IL_EACH(il_test, true,
    {
        s = strcat(s, it.classname);
        if (it == ent2)
            IL_EACH(il_test, true,
            {
                s = strcat(s, it.classname);
                if (it == ent3)
                    IL_EACH(il_test, true, s = strcat(s, it.classname));
                if (it == ent4)
                    break;
            });
    });
    EXPECT_TRUE(s == "12123123454345");
 
    IL_DELETE(il_test);
    delete(ent1); delete(ent2); delete(ent3); delete(ent4); delete(ent5);
 
    SUCCEED();
}

References entity(), EXPECT_TRUE, IL_DELETE, IL_EACH, IL_NEW, IL_POP(), IL_PUSH(), IL_REMOVE(), IL_SHIFT(), IL_TEST_BUILD, strcat(), and SUCCEED.

Variable Documentation

il_id

int il_id

Definition at line 216 of file intrusivelist.qh.

Referenced by IL_DTOR(), and IL_INIT().

il_links

IntrusiveList il_links[IL_MAX]

Definition at line 217 of file intrusivelist.qh.

Referenced by IL_DTOR(), IL_ENDFRAME(), IL_INIT(), and ONREMOVE().

il_links_flds

entity il_links_flds[IL_MAX *2]

Definition at line 218 of file intrusivelist.qh.

Referenced by IL_INIT().

il_links_ptr

int il_links_ptr

Definition at line 219 of file intrusivelist.qh.

Referenced by IL_INIT().

il_listmask

vector il_listmask

Definition at line 46 of file intrusivelist.qh.

Referenced by IL_INIT(), IL_PUSH(), and IL_UNSHIFT().

il_lists

vector il_lists

Definition at line 44 of file intrusivelist.qh.

Referenced by ONREMOVE().

IL_MAX

const int IL_MAX = 128

Maximum amount of creatable lists.

Lists can be given endless amount of entities, only restricted by engine limitations.

Definition at line 11 of file intrusivelist.qh.

Referenced by IL_ENDFRAME(), IL_INIT(), IL_REMOVE_RAW(), and ONREMOVE().