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:
/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* 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 Zeriph, Zeriph Enterprises, LLC, 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 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_OBJECT_HPP)
#define OMNI_OBJECT_HPP 1
#include <omni/defs/class_macros.hpp>
#include <omni/type_value.hpp>
#include <omni/ostream.hpp>
#include <omni/string/util.hpp>
#include <omni/generic_ptr.hpp>
#include <omni/delegate/0.hpp>
namespace omni {
/**
* omni::object is a base type containing generic data that allows any children
* to inherit certain feature sets, like a 'tag' and a 'name' property, as well as
* an event to alert any subscribers of when the object is being disposed (destroyed)
*/
class object
{
public:
object() :
disposing(),
name(),
tag(),
m_type(omni::type_id<omni::object>())
{
OMNI_D5_FW("created omni::object with no name");
}
object(const omni::object& cp) :
disposing(cp.disposing),
name(cp.name),
tag(cp.tag),
m_type(omni::type_id<omni::object>())
{
OMNI_DV5_FW("copied omni::object with name ", this->name);
}
explicit object(const omni::string_t& nm) :
disposing(),
name(nm),
tag(),
m_type(omni::type_id<omni::object>())
{
OMNI_DV5_FW("created omni::object with name ", this->name);
}
explicit object(const char* nm) :
disposing(),
name(),
tag(),
m_type(omni::type_id<omni::object>())
{
this->name = omni::string::util::to_string_t(std::string(nm));
OMNI_DV5_FW("created omni::object with name ", this->name);
}
explicit object(const omni::callback& ev) :
disposing(ev),
name(),
tag(),
m_type(omni::type_id<omni::object>())
{
OMNI_DV5_FW("created omni::object with name ", this->name);
}
object(const char* nm, const omni::callback& ev) :
disposing(ev),
name(),
tag(),
m_type(omni::type_id<omni::object>())
{
this->name = omni::string::util::to_string_t(std::string(nm));
OMNI_DV5_FW("created omni::object with name ", this->name);
}
object(const omni::string_t& nm, const omni::callback& ev) :
disposing(ev),
name(nm),
tag(),
m_type(omni::type_id<omni::object>())
{
OMNI_DV5_FW("created omni::object with name ", this->name);
}
virtual ~object()
{
OMNI_TRY_FW
// Call the disposing event to allow any subscribers to clean up
if (this->disposing) { this->disposing(); }
OMNI_CATCH_FW
OMNI_D5_FW("destroyed");
}
virtual const omni::string_t to_string_t() const { return this->name; }
omni::type_value type() const { return this->m_type; }
std::size_t hash() const { return this->m_type.hash(); }
omni::object& operator=(const omni::object& o)
{
if (this != &o) {
this->m_type = o.m_type;
this->disposing = o.disposing;
this->name = o.name;
this->tag = o.tag;
}
return *this;
}
bool operator==(const omni::object& o) const
{
return (
this == &o ||
(this->m_type == o.m_type &&
this->disposing == o.disposing &&
this->name == o.name &&
this->tag == o.tag)
);
}
bool operator!=(const omni::object& o) const
{
return !(*this == o);
}
OMNI_OSTREAM_STR_FW(omni::object)
/** Called when the instance is being destroyed (destructor is called) */
omni::action disposing;
/** A property that allows you to assign a name to this object */
omni::string_t name;
/** A property allowing assignment of various objects and types. */
omni::generic_ptr tag;
protected:
object(std::string nm, std::size_t id) :
disposing(),
name(),
tag(),
m_type(id)
{
this->name = omni::string::util::to_string_t(nm);
// this ctor is only valid for derived types
OMNI_DV5_FW("created omni::object with name ", this->name);
}
/** The associated type info for this and derived classes */
omni::type_value m_type;
};
} // namespace omni
#endif // OMNI_OBJECT_HPP