001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
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:
189:
190:
191:
192:
193:
194:
195:
196:
197:
198:
199:
200:
201:
202:
203:
204:
205:
206:
207:
208:
209:
210:
211:
212:
213:
214:
215:
216:
217:
218:
219:
220:
221:
222:
223:
224:
225:
226:
227:
228:
229:
230:
231:
232:
233:
234:
235:
236:
237:
238:
239:
240:
241:
242:
243:
244:
245:
246:
247:
248:
249:
250:
251:
252:
253:
254:
255:
256:
257:
258:
259:
260:
261:
262:
263:
264:
265:
266:
267:
268:
269:
270:
271:
272:
273:
274:
275:
276:
277:
278:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "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 ZERIPH AND 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.
*/
#if !defined(OMNI_PROPERTY_HPP)
#define OMNI_PROPERTY_HPP 1
#include <omni/defs/class_macros.hpp>
#include <omni/delegate/0.hpp>
#include <omni/delegate/1.hpp>
#include <omni/defs/consts.hpp>
// DEV_NOTE: defining OMNI_SAFE_PROP will make all property types thread safe
#if defined(OMNI_SAFE_PROP)
#include <omni/sync/scoped_lock.hpp>
#define OMNI_SAFE_PROP_MTX_FW mutable OMNI_MUTEX_T m_mtx;
#define OMNI_SAFE_PROP_MILST_FW m_mtx(),
#define OMNI_SAFE_PROP_INIT_FW omni::sync::mutex_init(this->m_mtx);
#define OMNI_SAFE_PROP_DTOR_FW omni::sync::mutex_destroy(this->m_mtx);
#define OMNI_SAFE_PROP_LOCK_FW omni::sync::mutex_lock(this->m_mtx);
#define OMNI_SAFE_PROP_UNLOCK_FW omni::sync::mutex_unlock(this->m_mtx);
#define OMNI_SAFE_PROP_ALOCK_FW omni::sync::scoped_lock<omni::sync::mutex_t> auto_mtx(&this->m_mtx);
#else
#define OMNI_SAFE_PROP_MTX_FW
#define OMNI_SAFE_PROP_MILST_FW
#define OMNI_SAFE_PROP_INIT_FW
#define OMNI_SAFE_PROP_DTOR_FW
#define OMNI_SAFE_PROP_LOCK_FW
#define OMNI_SAFE_PROP_UNLOCK_FW
#define OMNI_SAFE_PROP_ALOCK_FW
#endif
namespace omni {
template < typename T >
class property
{
public:
typedef T value_t;
typedef omni::delegate<value_t> get;
typedef omni::delegate1<void, value_t> set;
typedef property<value_t> property_t;
property() :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(), m_set()
{
OMNI_SAFE_PROP_INIT_FW
this->m_get.template bond_const<property_t, &property_t::_get>(*this);
this->m_set.template bond<property_t, &property_t::_set>(*this);
}
property(get gfn) :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(gfn), m_set()
{
OMNI_SAFE_PROP_INIT_FW
this->m_set.template bond<property_t, &property_t::_set>(*this);
}
property(set sfn) :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(), m_set(sfn)
{
OMNI_SAFE_PROP_INIT_FW
this->m_get.template bond_const<property_t, &property_t::_get>(*this);
}
property(set sfn, value_t val) :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(), m_set(sfn)
{
OMNI_SAFE_PROP_INIT_FW
this->m_get.template bond_const<property_t, &property_t::_get>(*this);
this->_vset(val);
}
property(get gfn, set sfn) :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(gfn), m_set(sfn)
{
OMNI_SAFE_PROP_INIT_FW
}
property(get gfn, set sfn, value_t val) :
OMNI_CTOR_FW(omni::property<T>)
OMNI_SAFE_PROP_MILST_FW
m_get(gfn), m_set(sfn)
{
OMNI_SAFE_PROP_INIT_FW
this->_vset(val);
}
property(const omni::template property<T> &cp) :
OMNI_CPCTOR_FW(cp)
OMNI_SAFE_PROP_MILST_FW
m_get(cp.m_get), m_set(cp.m_set)
{
OMNI_SAFE_PROP_INIT_FW
}
~property()
{
OMNI_TRY_FW
OMNI_DTOR_FW
OMNI_SAFE_PROP_DTOR_FW
OMNI_CATCH_FW
}
void bind_get(get gfn)
{
OMNI_SAFE_PROP_ALOCK_FW
this->m_get = gfn;
}
void bind_set(set sfn)
{
OMNI_SAFE_PROP_ALOCK_FW
this->m_set = sfn;
}
/*
DEV_NOTE: you might get compiler warnings about needing to return a `property<T>&` for
the post/pre operator overloads (e.g. ++/--), or that we should overload `operator=(property<T>)`,
but we specifically do not overload the `operator=(property<T>)` so as all rvals to this
instance _should_ be of `value_t` types. For example, in `property<int> t = 10;` if we
overloaded `operator=(property<T>)`, the assignment (i.e. `= 10;`) would preform an
implicit cast to a `property<int>` with the underlying value of 10, which is not what we want.
Instead, by overloading only the operators below, we can treat this `property` type
like it is underlying type with all other operations preformed.
*/
// Operators - get (rval)
operator value_t() { return this->_vget(); }
operator value_t() const { return this->_vget(); }
value_t operator()() { return this->_vget(); }
value_t operator()() const { return this->_vget(); }
// Operators - set (lval)
value_t operator++() { // pre increment
value_t tmp = this->_vget();
this->_vset(++tmp);
return tmp;
}
value_t operator--() { // pre decrement
value_t tmp = this->_vget();
this->_vset(--tmp);
return tmp;
}
value_t operator++(int) { // post increment
value_t tmp = this->_vget();
value_t t2 = tmp;
this->_vset(++t2);
return tmp;
}
value_t operator--(int) { // post decrement
value_t tmp = this->_vget();
value_t t2 = tmp;
this->_vset(--t2);
return tmp;
}
property_t& operator=(value_t val) {
this->_vset(val);
return *this;
}
property_t& operator+=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp + val);
return *this;
}
property_t& operator-=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp - val);
return *this;
}
property_t& operator*=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp * val);
return *this;
}
property_t& operator/=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp / val);
return *this;
}
property_t& operator%=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp % val);
return *this;
}
property_t& operator&=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp & val);
return *this;
}
property_t& operator|=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp | val);
return *this;
}
property_t& operator^=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp ^ val);
return *this;
}
property_t& operator<<=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp << val);
return *this;
}
property_t& operator>>=(value_t val) {
value_t tmp = this->_vget();
this->_vset(tmp >> val);
return *this;
}
OMNI_MEMBERS_FW(omni::property<T>) // disposing,name,type(),hash()
private:
OMNI_SAFE_PROP_MTX_FW
get m_get;
set m_set;
value_t _vget() const {
OMNI_SAFE_PROP_ALOCK_FW
return this->m_get();
}
void _vset(value_t value) {
OMNI_SAFE_PROP_ALOCK_FW
this->m_set(value);
}
value_t _get() const {
OMNI_ERR_RETV_FW("Property not bound to a get function", omni::exceptions::invalid_delegate(), value_t())
}
void _set(value_t value) {
OMNI_UNUSED(value);
OMNI_ERR_FW("Property not bound to a set function", omni::exceptions::invalid_delegate())
}
};
typedef omni::property<uint64_t> property64u_t;
typedef omni::property<int64_t> property64s_t;
typedef omni::property<uint32_t> property32u_t;
typedef omni::property<int32_t> property32s_t;
typedef omni::property<uint16_t> property16u_t;
typedef omni::property<int16_t> property16s_t;
typedef omni::property<uint8_t> property8u_t;
typedef omni::property<int8_t> property8s_t;
typedef omni::property<float> propertyF_t;
typedef omni::property<double> propertyD_t;
}
#endif // OMNI_PROPERTY_HPP