src/signs_base.h
author convert-repo
Mon, 07 Apr 2008 16:21:55 +0000
changeset 10076 dfd70e42c4ae
parent 9286 d446bf9f4a68
child 10447 a73b8ec66203
permissions -rw-r--r--
update tags
2186
461a2aff3486 (svn r2701) Insert Id tags into all source files
tron
parents: 2116
diff changeset
     1
/* $Id$ */
461a2aff3486 (svn r2701) Insert Id tags into all source files
tron
parents: 2116
diff changeset
     2
9286
d446bf9f4a68 (svn r12501) -Codechange: split signs.h.
rubidium
parents: 9268
diff changeset
     3
/** @file signs_base.h Base class for signs. */
6916
e87d54a598ea (svn r9556) -Documentation: doxygen and comment-style changes. 'R', 'S'.. The end of the preliminary work is near
belugas
parents: 6574
diff changeset
     4
9286
d446bf9f4a68 (svn r12501) -Codechange: split signs.h.
rubidium
parents: 9268
diff changeset
     5
#ifndef SIGNS_BASE_H
d446bf9f4a68 (svn r12501) -Codechange: split signs.h.
rubidium
parents: 9268
diff changeset
     6
#define SIGNS_BASE_H
988
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
     7
9286
d446bf9f4a68 (svn r12501) -Codechange: split signs.h.
rubidium
parents: 9268
diff changeset
     8
#include "signs_type.h"
5216
d581e4db95b6 (svn r7331) - Codechange: Rename all memory pool macro's and types to "old pool", so the new pool implementation can be committed alongside it.
matthijs
parents: 4979
diff changeset
     9
#include "oldpool.h"
1283
b9569cc0644f (svn r1787) -Add: Dynamic signs (euh.. yeah, this means you can built 64k signs)
truelight
parents: 1165
diff changeset
    10
7880
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    11
DECLARE_OLD_POOL(Sign, Sign, 2, 16000)
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    12
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    13
struct Sign : PoolItem<Sign, SignID, &_Sign_pool> {
8754
5dae65402806 (svn r11822) -Codechange: Replaced fixed size custom name array. Names are now attached to their object directly and there is
peter1138
parents: 7992
diff changeset
    14
	char *name;
988
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    15
	ViewportSign sign;
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    16
	int32        x;
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    17
	int32        y;
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    18
	byte         z;
5838
9c3129cb019b (svn r8038) -Merge: the cpp branch. Effort of KUDr, Celestar, glx, Smoovius, stillunknown and pv2b.
rubidium
parents: 5726
diff changeset
    19
	PlayerByte   owner; // placed by this player. Anyone can delete them though. OWNER_NONE for gray signs from old games.
988
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    20
7880
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    21
	/**
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    22
	 * Creates a new sign
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    23
	 */
8754
5dae65402806 (svn r11822) -Codechange: Replaced fixed size custom name array. Names are now attached to their object directly and there is
peter1138
parents: 7992
diff changeset
    24
	Sign(PlayerID owner = INVALID_PLAYER);
7880
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    25
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    26
	/** Destroy the sign */
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    27
	~Sign();
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    28
8754
5dae65402806 (svn r11822) -Codechange: Replaced fixed size custom name array. Names are now attached to their object directly and there is
peter1138
parents: 7992
diff changeset
    29
	inline bool IsValid() const { return this->owner != INVALID_PLAYER; }
6574
e1d1a12faaf7 (svn r9051) -Codechange: typedef [enum|struct] Y {} X; -> [enum|struct] X {};
rubidium
parents: 6573
diff changeset
    30
};
988
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    31
6573
7624f942237f (svn r9050) -Codechange: Foo(void) -> Foo()
rubidium
parents: 6002
diff changeset
    32
static inline SignID GetMaxSignIndex()
4354
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    33
{
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    34
	/* TODO - This isn't the real content of the function, but
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    35
	 *  with the new pool-system this will be replaced with one that
5247
c3eece01af11 (svn r7372) - CodeChange: Rename all GetXXXArraySize() functions to GetNumXXX() and add GetMaxXXXIndex() functions. This prepares for the new pool interface.
matthijs
parents: 5216
diff changeset
    36
	 *  _really_ returns the highest index. Now it just returns
4354
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    37
	 *  the next safe value we are sure about everything is below.
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    38
	 */
5247
c3eece01af11 (svn r7372) - CodeChange: Rename all GetXXXArraySize() functions to GetNumXXX() and add GetMaxXXXIndex() functions. This prepares for the new pool interface.
matthijs
parents: 5216
diff changeset
    39
	return GetSignPoolSize() - 1;
c3eece01af11 (svn r7372) - CodeChange: Rename all GetXXXArraySize() functions to GetNumXXX() and add GetMaxXXXIndex() functions. This prepares for the new pool interface.
matthijs
parents: 5216
diff changeset
    40
}
c3eece01af11 (svn r7372) - CodeChange: Rename all GetXXXArraySize() functions to GetNumXXX() and add GetMaxXXXIndex() functions. This prepares for the new pool interface.
matthijs
parents: 5216
diff changeset
    41
6573
7624f942237f (svn r9050) -Codechange: Foo(void) -> Foo()
rubidium
parents: 6002
diff changeset
    42
static inline uint GetNumSigns()
5247
c3eece01af11 (svn r7372) - CodeChange: Rename all GetXXXArraySize() functions to GetNumXXX() and add GetMaxXXXIndex() functions. This prepares for the new pool interface.
matthijs
parents: 5216
diff changeset
    43
{
7791
b279d235997a (svn r10643) -Merge (from NoAI): properly counting the amount of signs instead of using the size of the sign pool.
rubidium
parents: 7623
diff changeset
    44
	extern uint _total_signs;
b279d235997a (svn r10643) -Merge (from NoAI): properly counting the amount of signs instead of using the size of the sign pool.
rubidium
parents: 7623
diff changeset
    45
	return _total_signs;
4354
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    46
}
684ab9249dae (svn r6055) -Codechange: added GetXXXArraySize, which returns HighestID + 1 (or, will do that).
truelight
parents: 4353
diff changeset
    47
4352
8ddb01bc6075 (svn r6053) -Codechange: renamed all IsXXXIndex to IsValidXXXID
truelight
parents: 4349
diff changeset
    48
static inline bool IsValidSignID(uint index)
8ddb01bc6075 (svn r6053) -Codechange: renamed all IsXXXIndex to IsValidXXXID
truelight
parents: 4349
diff changeset
    49
{
7880
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    50
	return index < GetSignPoolSize() && GetSign(index)->IsValid();
4352
8ddb01bc6075 (svn r6053) -Codechange: renamed all IsXXXIndex to IsValidXXXID
truelight
parents: 4349
diff changeset
    51
}
8ddb01bc6075 (svn r6053) -Codechange: renamed all IsXXXIndex to IsValidXXXID
truelight
parents: 4349
diff changeset
    52
7880
f485e21889fd (svn r10753) -Codechange: make the sign struct use the pool item class as super class.
rubidium
parents: 7791
diff changeset
    53
#define FOR_ALL_SIGNS_FROM(ss, start) for (ss = GetSign(start); ss != NULL; ss = (ss->index + 1U < GetSignPoolSize()) ? GetSign(ss->index + 1U) : NULL) if (ss->IsValid())
1283
b9569cc0644f (svn r1787) -Add: Dynamic signs (euh.. yeah, this means you can built 64k signs)
truelight
parents: 1165
diff changeset
    54
#define FOR_ALL_SIGNS(ss) FOR_ALL_SIGNS_FROM(ss, 0)
988
2482369a61ff (svn r1486) -Codechange: moved all 'signs' stuff to signs.c/h and prepared it for
truelight
parents:
diff changeset
    55
9286
d446bf9f4a68 (svn r12501) -Codechange: split signs.h.
rubidium
parents: 9268
diff changeset
    56
#endif /* SIGNS_BASE_H */