1

/* $Id$ */

     2

     3

/** @file blitter.hpp */

     4

     5

#ifndef BLITTER_HPP

     6

#define BLITTER_HPP

     7

     8

#include "../spriteloader/spriteloader.hpp"

     9

#include "../spritecache.h"

    10

#include <string>

    11

#include <map>

    12

    13

enum BlitterMode {

    14

	BM_NORMAL,

    15

	BM_COLOUR_REMAP,

    16

	BM_TRANSPARENT,

    17

};

    18

    19

/**

    20

 * How all blitters should look like. Extend this class to make your own.

    21

 */

    22

class Blitter {

    23

public:

    24

	struct BlitterParams {

    25

		const void *sprite;      ///< Pointer to the sprite how ever the encoder stored it

    26

		const byte *remap;       ///< XXX -- Temporary storage for remap array

    27

    28

		int skip_left, skip_top; ///< How much pixels of the source to skip on the left and top (based on zoom of dst)

    29

		int width, height;       ///< The width and height in pixels that needs to be drawn to dst

    30

		int sprite_width;        ///< Real width of the sprite

    31

		int sprite_height;       ///< Real height of the sprite

    32

		int left, top;           ///< The offset in the 'dst' in pixels to start drawing

    33

    34

		void *dst;               ///< Destination buffer

    35

		int pitch;               ///< The pitch of the destination buffer

    36

	};

    37

    38

	/**

    39

	 * Get the screen depth this blitter works for.

    40

	 *  This is either: 8, 16, 24 or 32.

    41

	 */

    42

	virtual uint8 GetScreenDepth() = 0;

    43

    44

	/**

    45

	 * Draw an image to the screen, given an amount of params defined above.

    46

	 */

    47

	virtual void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) = 0;

    48

    49

	/**

    50

	 * Convert a sprite from the loader to our own format.

    51

	 */

    52

	virtual Sprite *Encode(SpriteLoader::Sprite *sprite) = 0;

    53

    54

	virtual ~Blitter() { }

    55

};

    56

    57

/**

    58

 * The base factory, keeping track of all blitters.

    59

 */

    60

class BlitterFactoryBase {

    61

private:

    62

	char *name;

    63

	typedef std::map<std::string, BlitterFactoryBase *> Blitters;

    64

    65

	static Blitters &GetBlitters()

    66

	{

    67

		static Blitters &s_blitters = *new Blitters();

    68

		return s_blitters;

    69

	}

    70

    71

	static Blitter **GetActiveBlitter()

    72

	{

    73

		static Blitter *s_blitter = NULL;

    74

		return &s_blitter;

    75

	}

    76

    77

protected:

    78

	/**

    79

	 * Register a blitter internally, based on his name.

    80

	 * @param name the name of the blitter.

    81

	 * @note an assert() will be trigger if 2 blitters with the same name try to register.

    82

	 */

    83

	void RegisterBlitter(const char *name)

    84

	{

    85

		/* Don't register nameless Blitters */

    86

		if (name == NULL) return;

    87

    88

		this->name = strdup(name);

    89

		std::pair<Blitters::iterator, bool> P = GetBlitters().insert(Blitters::value_type(name, this));

    90

		assert(P.second);

    91

	}

    92

    93

public:

    94

	BlitterFactoryBase() :

    95

		name(NULL)

    96

	{}

    97

    98

	virtual ~BlitterFactoryBase() { if (this->name != NULL) GetBlitters().erase(this->name); free(this->name); }

    99

   100

	/**

   101

	 * Find the requested blitter and return his class.

   102

	 * @param name the blitter to select.

   103

	 * @post Sets the blitter so GetCurrentBlitter() returns it too.

   104

	 */

   105

	static Blitter *SelectBlitter(const char *name)

   106

	{

   107

		if (GetBlitters().size() == 0) return NULL;

   108

   109

		Blitters::iterator it = GetBlitters().begin();

   110

		for (; it != GetBlitters().end(); it++) {

   111

			BlitterFactoryBase *b = (*it).second;

   112

			if (strcasecmp(name, b->name) == 0) {

   113

				Blitter *newb = b->CreateInstance();

   114

				*GetActiveBlitter() = newb;

   115

				return newb;

   116

			}

   117

		}

   118

		return NULL;

   119

	}

   120

   121

	/**

   122

	 * Get the current active blitter (always set by calling SelectBlitter).

   123

	 */

   124

	static Blitter *GetCurrentBlitter()

   125

	{

   126

		return *GetActiveBlitter();

   127

	}

   128

   129

   130

	static char *GetBlittersInfo(char *p, const char *last)

   131

	{

   132

		p += snprintf(p, last - p, "List of blitters:\n");

   133

		Blitters::iterator it = GetBlitters().begin();

   134

		for (; it != GetBlitters().end(); it++) {

   135

			BlitterFactoryBase *b = (*it).second;

   136

			p += snprintf(p, last - p, "%18s: %s\n", b->name, b->GetDescription());

   137

		}

   138

		p += snprintf(p, last - p, "\n");

   139

   140

		return p;

   141

	}

   142

   143

	/**

   144

	 * Get a nice description of the blitter-class.

   145

	 */

   146

	virtual const char *GetDescription() = 0;

   147

   148

	/**

   149

	 * Create an instance of this Blitter-class.

   150

	 */

   151

	virtual Blitter *CreateInstance() = 0;

   152

};

   153

   154

/**

   155

 * A template factory, so ->GetName() works correctly. This because else some compiler will complain.

   156

 */

   157

template <class T>

   158

class BlitterFactory: public BlitterFactoryBase {

   159

public:

   160

	BlitterFactory() { this->RegisterBlitter(((T *)this)->GetName()); }

   161

   162

	/**

   163

	 * Get the long, human readable, name for the Blitter-class.

   164

	 */

   165

	const char *GetName();

   166

};

   167

   168

#endif /* BLITTER_HPP */