1

/* $Id$ */

     2

     3

#ifndef SIGNS_H

     4

#define SIGNS_H

     5

     6

#include "pool.h"

     7

     8

typedef struct Sign {

     9

	StringID     str;

    10

	ViewportSign sign;

    11

	int32        x;

    12

	int32        y;

    13

	byte         z;

    14

	PlayerID     owner; // placed by this player. Anyone can delete them though. OWNER_NONE for gray signs from old games.

    15

    16

	SignID       index;

    17

} Sign;

    18

    19

extern MemoryPool _sign_pool;

    20

    21

/**

    22

 * Get the pointer to the sign with index 'index'

    23

 */

    24

static inline Sign *GetSign(SignID index)

    25

{

    26

	return (Sign *)GetItemFromPool(&_sign_pool, index);

    27

}

    28

    29

/**

    30

 * Get the current size of the SignPool

    31

 */

    32

static inline uint16 GetSignPoolSize(void)

    33

{

    34

	return _sign_pool.total_items;

    35

}

    36

    37

static inline SignID GetSignArraySize(void)

    38

{

    39

	/* TODO - This isn't the real content of the function, but

    40

	 *  with the new pool-system this will be replaced with one that

    41

	 *  _really_ returns the highest index + 1. Now it just returns

    42

	 *  the next safe value we are sure about everything is below.

    43

	 */

    44

	return GetSignPoolSize();

    45

}

    46

    47

/**

    48

 * Check if a Sign really exists.

    49

 */

    50

static inline bool IsValidSign(const Sign *si)

    51

{

    52

	return si->str != STR_NULL;

    53

}

    54

    55

static inline bool IsValidSignID(uint index)

    56

{

    57

	return index < GetSignPoolSize() && IsValidSign(GetSign(index));

    58

}

    59

    60

void DestroySign(Sign *si);

    61

    62

static inline void DeleteSign(Sign *si)

    63

{

    64

	DestroySign(si);

    65

	si->str = STR_NULL;

    66

}

    67

    68

#define FOR_ALL_SIGNS_FROM(ss, start) for (ss = GetSign(start); ss != NULL; ss = (ss->index + 1 < GetSignPoolSize()) ? GetSign(ss->index + 1) : NULL) if (IsValidSign(ss))

    69

#define FOR_ALL_SIGNS(ss) FOR_ALL_SIGNS_FROM(ss, 0)

    70

    71

VARDEF bool _sign_sort_dirty;

    72

    73

void UpdateAllSignVirtCoords(void);

    74

void PlaceProc_Sign(TileIndex tile);

    75

    76

/* misc.c */

    77

void ShowRenameSignWindow(const Sign *si);

    78

    79

#endif /* SIGNS_H */