Base class that enables using methods available for System.Object class in C#. All non-trivial classes used with translated environment should inherit it. More...

#include "object.h"

Public Types
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type.

Public Member Functions
	Object ()
	Creates object. Initializes all internal data structures.

virtual	~Object ()
	Destroys object. Frees all internal data structures.

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value.

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object.

int	SharedCount () const
	Gets current value of shared reference counter.

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object.

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics.

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string.

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call.

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator.

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only.

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr.

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings.

Static Public Member Functions
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference.

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference.

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr.

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style.

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style.

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct.

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.

Detailed Description

Base class that enables using methods available for System.Object class in C#. All non-trivial classes used with translated environment should inherit it.

Alongside with methods available in C# System.Object class, it also enables support for some concepts specific for translated code environment. This includes reference counting used by smart pointer classes (System::SmartPtr, System::WeakPtr, System::DynamicWeakPtr) and other services related to memory management, debug, etc.

Each Object has two reference counters: shared reference counter and weak reference counter. Weak reference counter is always stored in detached data structure rather than in Object itself which allows weak pointers overlive referenced object. Smart reference counter is stored either in object itself or in same detached structure, depending on ENABLE_EXTERNAL_REFCOUNT macro state. By default, it is enabled in debug builds and disabled in release builds. If smart pointer counter is stored in object itself, detached data structure is created only if weak pointers to object exist. Otherwise, it is created alongside with object itself.

All smart pointers use these two reference counters and contribute to same and only ownership group.

If Object subclass is created on stack, no smart pointers to it may be created, otherwise there is a stack deletion issue.

This type can be allocated either in stack as value type or in heap using System::MakeObject() function. Once the object is allocated, never mix up these two usecases: having SmartPtr pointers onto stack-allocated objects is strictly prohibited.

Member Typedef Documentation

◆ ptr

SmartPtr<Object> System::Object::ptr

Alias for smart pointer type.

Constructor & Destructor Documentation

◆ Object() [1/2]

System::Object::Object ( )

Creates object. Initializes all internal data structures.

◆ ~Object()

virtual System::Object::~Object ( )

virtual

Destroys object. Frees all internal data structures.

◆ Object() [2/2]

System::Object::Object ( Object const & x )

Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Parameters

x	Formal parameter.

Member Function Documentation

◆ Equals() [1/5]

template<>

bool System::Object::Equals	(	double const &	objA,
		double const &	objB )

inlinestatic

Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.

Parameters

objA	LHS floating point value.
objB	RHS floating point value.

Returns: True if objA and objB are both NaN or equal, false otherwise.

◆ Equals() [2/5]

template<>

bool System::Object::Equals	(	float const &	objA,
		float const &	objB )

inlinestatic

Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN.

Parameters

objA	LHS floating point value.
objB	RHS floating point value.

Returns: True if objA and objB are both NaN or equal, false otherwise.

◆ Equals() [3/5]

virtual bool System::Object::Equals ( ptr obj )

virtual

Compares objects using C# Object.Equals semantics.

Parameters

obj	Object to compare current one to.

Returns: True if objects are considered equal and false otherwise.

Reimplemented in System::BoxedValue< T >, System::DefaultBoxedValue< T >, and System::Drawing::Drawing2D::Matrix.

◆ Equals() [4/5]

template<typename T1 , typename T2 >

static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type System::Object::Equals	(	T1 const &	objA,
		T2 const &	objB )

inlinestatic

Compares reference type objects in C# style.

Template Parameters

T1	Type of first object to compare.
T2	Type of second object to compare.

Parameters

objA	First object to compare.
objB	Second object to compare.

Returns: True if objects match either by reference or semantically (by Object.Equals-alike comparison), false otherwise.

◆ Equals() [5/5]

template<typename T1 , typename T2 >

static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type System::Object::Equals	(	T1 const &	objA,
		T2 const &	objB )

inlinestatic

Compares value type objects in C# style.

Template Parameters

T1	Type of first object to compare.
T2	Type of second object to compare.

Parameters

objA	First object to compare.
objB	Second object to compare.

Returns: True if objects are considered equal by equality operator available, false otherwise.

◆ FastCast()

virtual bool System::Object::FastCast	(	const Details::FastRttiBase &	helper,
		void **	out_ptr ) const

virtual

For internal purposes only.

Parameters

helper	FastRttiBase structure specialized with a desired type.
out_ptr	A pointer to a desired type if conversion is available.

Returns: True if a class supports FastRTTI operations.

◆ GetCounter()

Detail::SmartPtrCounter * System::Object::GetCounter ( )

inline

Gets reference counter data structure associated with the object.

Implementation.

Returns: Pointer to reference counting data structure associated with object.

◆ GetHashCode()

virtual int32_t System::Object::GetHashCode ( ) const

virtual

Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

Returns: Hash code value as calculated by corresponding class.

◆ GetType()

virtual const TypeInfo & System::Object::GetType ( ) const

virtual

Gets actual type of object. Analog of C# System.Object.GetType() call.

Returns: TypeInfo object which describes final type.

Reimplemented in System::BoxedValue< T >, and System::DefaultBoxedValue< T >.

◆ Is()

virtual bool System::Object::Is ( const TypeInfo & targetType ) const

virtual

Check if object represents an instance of type described by targetType. Analog of C# 'is' operator.

Parameters

targetType TypeInfo structure describing the type to test current object against.

Returns: True if object is of tagged type or its subclass, false otherwise.

◆ Lock()

void System::Object::Lock ( )

Implements C# lock() statement locking. Call directly or use LockContext sentry object.

◆ MemberwiseClone()

virtual ptr System::Object::MemberwiseClone ( ) const

virtual

Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.

Returns: Pointer to object copy created.

Exceptions

NotImplemented exception is thrown by default. Implement manually or use polymorphic_memberwiseclone option to enable this method in translated code.

◆ operator=()

Object & System::Object::operator= ( Object const & x )

inline

Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.

Parameters

x	Formal parameter.

◆ ReferenceEquals() [1/5]

static bool System::Object::ReferenceEquals	(	ptr const &	objA,
		ptr const &	objB )

inlinestatic

Compares objects by reference.

Parameters

objA	First pointer to compare.
objB	Second pointer to compare.

Returns: True if pointers match and false otherwise.

◆ ReferenceEquals() [2/5]

template<>

bool System::Object::ReferenceEquals	(	String const &	str,
		std::nullptr_t	)

inline

Specialization of Object::ReferenceEquals for case of string and nullptr.

Parameters

str	String to compare to nullptr.

Returns: true if string is null, false otherwise.

◆ ReferenceEquals() [3/5]

template<>

bool System::Object::ReferenceEquals	(	String const &	str1,
		String const &	str2 )

inline

Specialization of Object::ReferenceEquals for case of strings.

Parameters

str1	First string to compare.
str2	Second string to compare.

Returns: true if strings match, false otherwise.

◆ ReferenceEquals() [4/5]

template<typename T >

static std::enable_if<!IsSmartPtr< T >::value, bool >::type System::Object::ReferenceEquals	(	T const &	objA,
		std::nullptr_t	)

inlinestatic

Reference-compares value type object with nullptr.

Template Parameters

T	Type of object to compare.

Parameters

objA	First object to compare.

Returns: Always returns false as value types cannot be nulled.

◆ ReferenceEquals() [5/5]

template<typename T >

static std::enable_if<!IsSmartPtr< T >::value, bool >::type System::Object::ReferenceEquals	(	T const &	objA,
		T const &	objB )

inlinestatic

Compares objects by reference.

Template Parameters

T	Type of objects to compare.

Parameters

objA	First object to compare.
objB	Second object to compare.

Returns: True if object addresses match and false otherwise.

◆ RemovedSharedRefs()

int System::Object::RemovedSharedRefs ( int count )

inline

Decreases shared reference count by specified value.

Implementation.

Parameters

count Number of shared references to remove.

Returns: Decreased value of shared reference counter.

◆ SetTemplateWeakPtr()

virtual void System::Object::SetTemplateWeakPtr ( uint32_t argument )

virtual

Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.

Parameters

argument Index of template argument to treat as weak poiner.

◆ SharedCount()

int System::Object::SharedCount ( ) const

inline

Gets current value of shared reference counter.

Implementation.

Returns: Current value of shared reference counter.

◆ SharedRefAdded()

Object * System::Object::SharedRefAdded ( )

inline

Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

Implementation.

Returns: Raw pointer to current object.

◆ SharedRefRemovedSafe()

int System::Object::SharedRefRemovedSafe ( )

inline

Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

Implementation.

Returns: Decremented value of shared reference counter.

◆ ToString()

virtual String System::Object::ToString ( ) const

virtual

Analog of C# Object.ToString() method. Enables converting custom objects to string.

Returns: String representation as provided by final class.

◆ Type()

static const TypeInfo & System::Object::Type ( )

inlinestatic

Implements C# typeof(System.Object) construct.

Returns: TypeInfo object which describes System::Object type.

◆ Unlock()

void System::Object::Unlock ( )

Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.

◆ WeakRefAdded()

Detail::SmartPtrCounter * System::Object::WeakRefAdded ( )

inline

Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

Implementation.

Returns: Pointer to reference counting data structure associated with object.

◆ WeakRefRemoved()

void System::Object::WeakRefRemoved ( )

inline

Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.

Implementation.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ptr

Constructor & Destructor Documentation

◆ Object() [1/2]

◆ ~Object()

◆ Object() [2/2]

Member Function Documentation

◆ Equals() [1/5]

◆ Equals() [2/5]

◆ Equals() [3/5]

◆ Equals() [4/5]

◆ Equals() [5/5]

◆ FastCast()

◆ GetCounter()

◆ GetHashCode()

◆ GetType()

◆ Is()

◆ Lock()

◆ MemberwiseClone()

◆ operator=()

◆ ReferenceEquals() [1/5]

◆ ReferenceEquals() [2/5]

◆ ReferenceEquals() [3/5]

◆ ReferenceEquals() [4/5]

◆ ReferenceEquals() [5/5]

◆ RemovedSharedRefs()

◆ SetTemplateWeakPtr()

◆ SharedCount()

◆ SharedRefAdded()

◆ SharedRefRemovedSafe()

◆ ToString()

◆ Type()

◆ Unlock()

◆ WeakRefAdded()

◆ WeakRefRemoved()