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
|
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.
#ifndef NV_PARAMETERIZED_CONVERSION_TEMPLATE_H
#define NV_PARAMETERIZED_CONVERSION_TEMPLATE_H
#include <NvTraitsInternal.h>
#include <nvparameterized/NvParameterizedTraits.h>
namespace NvParameterized
{
/**
\brief Class to handle all the redundant part of version upgrades.
It verifies class names and versions, and it runs the default converter. The user may overload
convert(), getPreferredVersions() and release() methods.
*/
template<typename Told, typename Tnew, uint32_t oldVersion, uint32_t newVersion>
class ParamConversionTemplate : public NvParameterized::Conversion
{
public:
typedef Told TOldClass;
typedef Tnew TNewClass;
bool operator()(NvParameterized::Interface& legacyObj, NvParameterized::Interface& obj)
{
if (!mDefaultConversion)
{
mDefaultConversion = NvParameterized::internalCreateDefaultConversion(mTraits, getPreferredVersions());
}
// verify class names
if (physx::shdfnd::strcmp(legacyObj.className(), Told::staticClassName()) != 0)
{
return false;
}
if (physx::shdfnd::strcmp(obj.className(), Tnew::staticClassName()) != 0)
{
return false;
}
// verify version
if (legacyObj.version() != oldVersion)
{
return false;
}
if (obj.version() != newVersion)
{
return false;
}
//Copy unchanged fields
if (!(*mDefaultConversion)(legacyObj, obj))
{
return false;
}
mLegacyData = static_cast<Told*>(&legacyObj);
mNewData = static_cast<Tnew*>(&obj);
if (!convert())
{
return false;
}
NvParameterized::Handle invalidHandle(mNewData);
if (!mNewData->areParamsOK(&invalidHandle, 1))
{
if (invalidHandle.isValid())
{
char buf[256];
physx::shdfnd::strlcpy(buf, 256, "First invalid item: ");
invalidHandle.getLongName(buf + strlen("First invalid item: "), 256UL - static_cast<uint32_t>(strlen("First invalid item: ")));
mTraits->traitsWarn(buf);
}
return false;
}
return true;
}
/// User code, frees itself with the traits, and also calls destroy() on the ParamConversionTemplate object
virtual void release()
{
destroy();
mTraits->free(this);
}
protected:
ParamConversionTemplate(NvParameterized::Traits* traits)
: mTraits(traits), mDefaultConversion(0), mLegacyData(0), mNewData(0)
{
// Virtual method getPreferredVersions() can not be called in constructors
// so we defer construction of mDefaultConversion
}
~ParamConversionTemplate()
{
destroy();
}
/// User code, return list of preferred versions.
virtual const NvParameterized::PrefVer* getPreferredVersions() const
{
return 0;
}
/// User code, return true if conversion is successful.
virtual bool convert()
{
return true;
}
void destroy()
{
if (mDefaultConversion)
{
mDefaultConversion->release();
}
}
NvParameterized::Traits* mTraits;
NvParameterized::Conversion* mDefaultConversion;
Told* mLegacyData;
Tnew* mNewData;
};
}
// Force inclusion of files with initParamRef before we redefine it below
#include "nvparameterized/NvParameterized.h"
#include "nvparameterized/NvParamUtils.h"
#include "NvParameters.h"
// Do not call initParamRef in converter - prefer Traits::createNvParameterized with explicit version
// (see wiki for more details)
#define initParamRef DO_NOT_USE_ME
#endif // PARAM_CONVERSION_TEMPLATE_H
|