File: pgtimerobject.h

package info (click to toggle)
asc 2.6.1.0-9
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 81,740 kB
  • sloc: cpp: 158,704; sh: 11,544; ansic: 6,736; makefile: 604; perl: 138
file content (125 lines) | stat: -rw-r--r-- 3,097 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/*
    ParaGUI - crossplatform widgetset
    Copyright (C) 2000,2001,2002  Alexander Pipelka
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
    Alexander Pipelka
    pipelka@teleweb.at
 
    Last Update:      $Author: mbickel $
    Update Date:      $Date: 2009-04-18 13:48:39 $
    Source File:      $Source: /home/martin/asc/v2/svntest/games/asc/source/libs/paragui/include/pgtimerobject.h,v $
    CVS/RCS Revision: $Revision: 1.3 $
    Status:           $State: Exp $
*/

/** \file pgtimerobject.h
	Header file for the PG_TimerObject class.
*/

#ifndef PG_TIMEROBJECT_H
#define PG_TIMEROBJECT_H

#include "paragui.h"
#include <map>
#include <sigc++/sigc++.h>


/**
	@author Alexander Pipelka
 
	@short A class to handle periodical timers
 
	This class encapsulates the SDL_AddTimer, SDL_RemoveTimer functions.
*/

class DECLSPEC PG_TimerObject {

public:

	typedef unsigned long ID;

	/**
	Signal type declaration
	**/
class SignalTimer : public sigc::signal<bool, PG_TimerObject*, PG_TimerObject::ID> {}
	;

	/**
	Constructor of the PG_TimerObject class.
	The constructor also calls SDL_InitSubSystem(SDL_Timer) to enable
	the SDL timer subsystem.
	*/
	PG_TimerObject();

	virtual ~PG_TimerObject();

	/**
	Add a timer to the object.

	@param interval timer intervall in ms
	@return id of the timer

	You can add any number of timers to an object.
	After the timer-interval the virtual function eventTimer(PG_TimerObject::ID id, Uint32 interval)
	will be called
	*/
	PG_TimerObject::ID AddTimer(Uint32 interval);

	/**
	Remove a timer

	@param id id of the timer to remove
	*/
	bool RemoveTimer(PG_TimerObject::ID id);

	int SetTimer(Uint32 interval);

	void StopTimer();

	/**
	timer event handler

	@param id id of the elapsed timer
	@param interval timer interval
	@return should return the interval of the next timer event
	*/
	virtual Uint32 eventTimer(PG_TimerObject::ID id, Uint32 interval);

	virtual Uint32 eventTimer(Uint32 interval);

	SignalTimer sigTimer;

private:

	DLLLOCAL static Uint32 callbackTimer(Uint32 interval, void* data);

	DLLLOCAL static Uint32 callbackSingleTimer(Uint32 interval);

	static PG_TimerObject::ID globalTimerID;

	static std::map<PG_TimerObject::ID, PG_TimerObject*> timermap;

	static Uint32 objectcount;

	static PG_TimerObject* objSingleTimer;

	std::map<PG_TimerObject::ID, SDL_TimerID> my_timermap;

	SDL_mutex* my_lock;
};

#endif // PG_TIMEROBJECT_H