summaryrefslogtreecommitdiff
path: root/Runtime/Serialize/TransferFunctions/RemapPPtrTransfer.h
blob: 853d83be809ad9373d5b5a065ee281236a296fa4 (plain)
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
#ifndef REMAPPPTRTRANSFER_H
#define REMAPPPTRTRANSFER_H

#include "Runtime/Serialize/TransferFunctions/TransferBase.h"
#include "Runtime/Serialize/SerializationMetaFlags.h"
#include "Runtime/Allocator/MemoryMacros.h"

#include <stack>

template<class T>
class PPtr;
template<class T>
class ImmediatePtr;
struct StreamingInfo;

class GenerateIDFunctor
{
	public:

	/// Calls GenerateInstanceID for every PPtr that is found while transferring.
	/// oldInstanceID is the instanceID of the PPtr. metaFlag is the ored metaFlag of the the Transfer trace to the currently transferred pptr.
	/// After GenerateInstanceID returns, the PPtr will be set to the returned instanceID
	/// If you dont want to change the PPtr return oldInstanceID
	virtual SInt32 GenerateInstanceID (SInt32 oldInstanceID, TransferMetaFlags metaFlag) = 0;
};


////@todo: Think about a smart way to calculate to let the compiler optimize transfer code of non-pptr classes away
//// currently we have  a serializeTraits::MightContainPPtr but this should be somehow automatic!


/// Transfer that scans for PPtrs and optionally allows to replace them in-place.  Is given a GenerateIDFunctor which maps one
/// or more existing instance IDs to new instance IDs and then crawls through an object's transfers looking for PPtr transfers.
/// Does not touch any other data.
class EXPORT_COREMODULE RemapPPtrTransfer : public TransferBase
{
private:

	GenerateIDFunctor*              m_GenerateIDFunctor;
	UNITY_TEMP_VECTOR(TransferMetaFlags) m_MetaMaskStack;
	TransferMetaFlags               m_CachedMetaMaskStackTop;
	bool                            m_ReadPPtrs;

public:

	RemapPPtrTransfer (int flags, bool readPPtrs);

	void SetGenerateIDFunctor (GenerateIDFunctor* functor)	{ m_GenerateIDFunctor = functor; }
	GenerateIDFunctor* GetGenerateIDFunctor () const { return m_GenerateIDFunctor; }

	bool IsReadingPPtr ()       { return m_ReadPPtrs; }
	bool IsWritingPPtr ()       { return true; }
	bool IsRemapPPtrTransfer () { return true; }

	bool DidReadLastPPtrProperty () { return true; }

	void AddMetaFlag (TransferMetaFlags flag);

	void PushMetaFlag (TransferMetaFlags flag);
	void PopMetaFlag ();

	template<class T>
	void Transfer (T& data, const char* name, TransferMetaFlags metaFlag = kNoTransferFlags);
	template<class T>
	void TransferWithTypeString (T& data, const char*, const char*, TransferMetaFlags metaFlag = kNoTransferFlags);

	void TransferTypeless (unsigned*, const char*, TransferMetaFlags /*metaFlag*/ = kNoTransferFlags) { }

	void TransferTypelessData (unsigned, void*, TransferMetaFlags /*metaFlag*/ = kNoTransferFlags) { }

	template<class T>
	void TransferSTLStyleArray (T& data, TransferMetaFlags metaFlag = kNoTransferFlags);

	template<class T>
	void TransferSTLStyleMap (T& data, TransferMetaFlags metaFlag = kNoTransferFlags);

	SInt32 GetNewInstanceIDforOldInstanceID (SInt32 oldInstanceID) { return m_GenerateIDFunctor->GenerateInstanceID (oldInstanceID, m_CachedMetaMaskStackTop);}
};

template<class T>
struct RemapPPtrTraits
{
	static bool IsPPtr () 												{ return false; }
	static int GetInstanceIDFromPPtr (const T& )		       			{ AssertString ("Never"); return 0; }
	static void SetInstanceIDOfPPtr (T& , SInt32)						{ AssertString ("Never");  }
};

template<class T>
struct RemapPPtrTraits<PPtr<T> >
{
	static bool IsPPtr () 												{ return true; }
	static int GetInstanceIDFromPPtr (const PPtr<T>& data)				{ return data.GetInstanceID (); }
	static void SetInstanceIDOfPPtr (PPtr<T>& data, SInt32 instanceID)	{ data.SetInstanceID (instanceID);  }
};

template<class T>
struct RemapPPtrTraits<ImmediatePtr<T> >
{
	static bool IsPPtr () 														{ return true; }
	static int GetInstanceIDFromPPtr (const ImmediatePtr<T>& data)				{ return data.GetInstanceID (); }
	static void SetInstanceIDOfPPtr (ImmediatePtr<T>& data, SInt32 instanceID)	{ data.SetInstanceID (instanceID);  }
};

template<class T>
void RemapPPtrTransfer::Transfer (T& data, const char*, TransferMetaFlags metaFlag)
{
	if (SerializeTraits<T>::MightContainPPtr ())
	{
		if (metaFlag != 0)
			PushMetaFlag(metaFlag);

		if (RemapPPtrTraits<T>::IsPPtr ())
		{
			AssertIf (m_GenerateIDFunctor == NULL);
			ANALYSIS_ASSUME (m_GenerateIDFunctor);
			SInt32 oldInstanceID = RemapPPtrTraits<T>::GetInstanceIDFromPPtr (data);
			SInt32 newInstanceID = GetNewInstanceIDforOldInstanceID(oldInstanceID);

			if (m_ReadPPtrs)
			{
				RemapPPtrTraits<T>::SetInstanceIDOfPPtr (data, newInstanceID);
			}
			else
			{
				AssertIf(oldInstanceID != newInstanceID);
			}
		}
		else
			SerializeTraits<T>::Transfer (data, *this);

		if (metaFlag != 0)
			PopMetaFlag();
	}
}

template<class T>
void RemapPPtrTransfer::TransferWithTypeString (T& data, const char*, const char*, TransferMetaFlags metaFlag)
{
	Transfer(data, NULL, metaFlag);
}


template<class T>
void RemapPPtrTransfer::TransferSTLStyleArray (T& data, TransferMetaFlags metaFlag)
{
	if (SerializeTraits<typename T::value_type>::MightContainPPtr ())
	{
		typename T::iterator i = data.begin ();
		typename T::iterator end = data.end ();
		while (i != end)
		{
			Transfer (*i, "data", metaFlag);
			++i;
		}
	}
}

template<class T>
void RemapPPtrTransfer::TransferSTLStyleMap (T& data, TransferMetaFlags metaFlag)
{
	typedef typename NonConstContainerValueType<T>::value_type NonConstT;
	if (SerializeTraits<NonConstT>::MightContainPPtr ())
	{
		typename T::iterator i = data.begin ();
		typename T::iterator end = data.end ();

		// maps value_type is: pair<const First, Second>
		// So we have to write to maps non-const value type
		while (i != end)
		{
			NonConstT& p = (NonConstT&) (*i);
			Transfer (p, "data", metaFlag);
			i++;
		}
	}
}

#endif