File: NstApiRewinder.hpp

package info (click to toggle)
libretro-nestopia 1.52.0%2B20230102.gitcb1e24e-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 12,960 kB
  • sloc: cpp: 107,513; xml: 27,221; python: 1,329; ansic: 772; makefile: 634
file content (188 lines) | stat: -rw-r--r-- 3,837 bytes parent folder | download | duplicates (8)
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
////////////////////////////////////////////////////////////////////////////////////////
//
// Nestopia - NES/Famicom emulator written in C++
//
// Copyright (C) 2003-2008 Martin Freij
//
// This file is part of Nestopia.
//
// Nestopia is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// Nestopia 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Nestopia; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
////////////////////////////////////////////////////////////////////////////////////////

#ifndef NST_API_REWINDER_H
#define NST_API_REWINDER_H

#include "NstApi.hpp"

#ifdef NST_PRAGMA_ONCE
#pragma once
#endif

#if NST_ICC >= 810
#pragma warning( push )
#pragma warning( disable : 304 444 )
#elif NST_MSVC >= 1200
#pragma warning( push )
#pragma warning( disable : 4512 )
#endif

namespace Nes
{
	namespace Api
	{
		/**
		* Game rewinder interface.
		*/
		class Rewinder : public Base
		{
			struct StateCaller;

		public:

			/**
			* Interface constructor.
			*
			* @param instance emulator instance
			*/
			template<typename T>
			Rewinder(T& instance)
			: Base(instance) {}

			/**
			* Direction.
			*/
			enum Direction
			{
				/**
				* Forward.
				*/
				FORWARD,
				/**
				* Backward.
				*/
				BACKWARD
			};

			/**
			* Enables rewinder.
			*
			* @param state true to enable
			* @return result code
			*/
			Result Enable(bool state=true) throw();

			/**
			* Checks if rewinder is enabled.
			*
			* @return true if enabled
			*/
			bool IsEnabled() const throw();

			/**
			* Resets rewinder.
			*/
			void Reset() throw();

			/**
			* Enables backward sound.
			*
			* @param state true to enable
			*/
			void EnableSound(bool state=true) throw();

			/**
			* Checks if backward sound is enabled.
			*
			* @return true if enabled
			*/
			bool IsSoundEnabled() const throw();

			/**
			* Sets direction.
			*
			* @param direction direction, FORWARD or BACKWARD
			* @return result code
			*/
			Result SetDirection(Direction direction) throw();

			/**
			* Returns the current direction.
			*
			* @return current direction
			*/
			Direction GetDirection() const throw();

			/**
			* Rewinder state.
			*/
			enum State
			{
				/**
				* Rewinding has stopped.
				*/
				STOPPED,
				/**
				* Rewinding will soon start.
				*/
				PREPARING,
				/**
				* Rewinding has begun.
				*/
				REWINDING
			};

			enum
			{
				NUM_STATE_CALLBACKS = 3
			};

			/**
			* Rewinder state callback prototype.
			*
			* @param userData optional user data
			* @param state type of state
			*/
			typedef void (NST_CALLBACK *StateCallback) (UserData userData,State state);

			/**
			* Rewinder state callback manager.
			*
			* Static object used for adding the user defined callback.
			*/
			static StateCaller stateCallback;
		};

		/**
		* Rewinder state callback invoker.
		*
		* Used internally by the core.
		*/
		struct Rewinder::StateCaller : Core::UserCallback<Rewinder::StateCallback>
		{
			void operator () (State state) const
			{
				if (function)
					function( userdata, state );
			}
		};
	}
}

#if NST_MSVC >= 1200 || NST_ICC >= 810
#pragma warning( pop )
#endif

#endif