Object Struct Reference

#include <Object.h>

Overview

Object is the root Class of The Objectively Class hierarchy.

Every Class descends from Object, and every instance can be cast to Object.

Definition at line 46 of file Object.h.

Inheritance diagram for Object:

Properties
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
ObjectInterface *	interface
	The interface.

Property Details

clazz

Class* Object::clazz

Every instance of Object begins with a pointer to its Class.

Definition at line 55 of file Object.h.

interface

ObjectInterface* Object::interface

protected

The interface.

Definition at line 61 of file Object.h.

magic

unsigned int Object::magic

A header to allow introspection of Object types.

Definition at line 50 of file Object.h.

Method Details

_Object()

Class * _Object

(

void

)

The Object archetype.

Returns

The Object Class.

Definition at line 136 of file Object.c.

                     {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Object",
      .instanceSize = sizeof(Object),
      .interfaceOffset = offsetof(Object, interface),
      .interfaceSize = sizeof(ObjectInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

copy()

Object * copy

(

const Object *

self

)

Creates a shallow copy of this Object.

Parameters

self	The Object.

Returns

The copy.

Definition at line 84 of file Array.c.

                                        {
 
  const Array *this = (Array *) self;
 
  Array *copy = $(alloc(Array), initWithCapacity, this->count);
  assert(copy);
 
  $(copy, addObjectsFromArray, this);
 
  return (Object *) copy;
}

dealloc()

void dealloc

(

Object *

self

)

Frees all resources held by this Object.

Parameters

self	The Object.

Definition at line 99 of file Array.c.

                                  {
 
  Array *this = (Array *) self;
 
  for (size_t i = 0; i < this->count; i++) {
    release(this->elements[i]);
  }
 
  free(this->elements);
 
  super(Object, self, dealloc);
}

description()

String * description

(

const Object *

self

)

Parameters

self	The Object.

Returns

A brief description of this Object.

Definition at line 115 of file Array.c.

                                               {
 
  String *components = $((Array *) self, componentsJoinedByCharacters, ", ");
 
  String *desc = $(alloc(String), initWithFormat, "[%s]", components->chars ?: "");
 
  release(components);
 
  return desc;
}

hash()

int hash

(

const Object *

self

)

Parameters

self	The Object.

Returns

An integer hash for use in hash tables, etc.

Definition at line 129 of file Array.c.

                                    {
 
  Array *this = (Array *) self;
 
  int hash = HashForInteger(HASH_SEED, this->count);
 
  for (size_t i = 0; i < this->count; i++) {
    hash = HashForObject(hash, this->elements[i]);
  }
 
  return hash;
}

init()

Object * init

(

Object *

self

)

Initializes this Object.

Parameters

self	The Object.

Returns

The initialized Object, or the unmodified pointer on error.

Definition at line 83 of file Object.c.

                                  {
 
  return self;
}

isEqual()

bool isEqual	(	const Object *	self,
		const Object *	other
	)

Tests equality of the other Object.

Parameters

self	The Object.
other	The Object to test for equality.

Returns

True if other is deemed equal, false otherwise.

Definition at line 145 of file Array.c.

                                                             {
 
  if (super(Object, self, isEqual, other)) {
    return true;
  }
 
  if (other && $(other, isKindOfClass, _Array())) {
 
    const Array *this = (Array *) self;
    const Array *that = (Array *) other;
 
    if (this->count == that->count) {
 
      for (size_t i = 0; i < this->count; i++) {
 
        const Object *thisObject = this->elements[i];
        const Object *thatObject = that->elements[i];
 
        if ($(thisObject, isEqual, thatObject) == false) {
          return false;
        }
      }
 
      return true;
    }
  }
 
  return false;
}

isKindOfClass()

bool isKindOfClass	(	const Object *	self,
		const Class *	clazz
	)

Tests for Class hierarchy membership.

Parameters

self	The Object.
clazz	The Class to test for membership.

Returns

True if this instance belongs to Class' hierarchy, false otherwise.

Definition at line 101 of file Object.c.

                                                                  {
 
  assert(clazz);
  
  const Class *c = self->clazz;
  while (c) {
    if (memcmp(c, clazz, sizeof(*c)) == 0) {
      return true;
    }
    c = c->def.superclass;
  }
 
  return false;
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Object.h
• Sources/Objectively/Object.c