Pointer Struct Reference

#include <Pointer.h>

Overview

Pointers provide Object encapsulation for raw C pointers.

Definition at line 40 of file Pointer.h.

Inheritance diagram for Pointer:

Properties
Consumer	destroy
	An optional destructor that, if set, is called on dealloc.
Object	object
	The superclass.
ident	pointer
	The backing pointer.
Properties inherited from Object
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 *	_Pointer (void)
	The Pointer archetype.
Pointer *	initWithBytes (Pointer *self, const uint8_t *bytes, size_t length)
	Initializes this Pointer by copying length of bytes.
Pointer *	initWithPointer (Pointer *self, ident pointer, Consumer destroy)
	Initializes this Pointer.
Methods inherited from Object
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
PointerInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Related Symbols
OBJECTIVELY_EXPORT Pointer *	ptr (ident pointer, Consumer destroy)
	A convenience function for instantiating Pointers.

Property Details

destroy

Consumer Pointer::destroy

An optional destructor that, if set, is called on dealloc.

Definition at line 56 of file Pointer.h.

interface

PointerInterface* Pointer::interface

protected

The interface.

Definition at line 51 of file Pointer.h.

object

Object Pointer::object

The superclass.

Definition at line 45 of file Pointer.h.

pointer

ident Pointer::pointer

The backing pointer.

Definition at line 61 of file Pointer.h.

Method Details

_Pointer()

Class * _Pointer

(

void

)

The Pointer archetype.

Returns

The Pointer Class.

Definition at line 137 of file Pointer.c.

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

initWithBytes()

Pointer * initWithBytes	(	Pointer *	self,
		const uint8_t *	bytes,
		size_t	length
	)

Initializes this Pointer by copying length of bytes.

Parameters

self	The Pointer.
bytes	The bytes to copy.
length	The count of bytes to copy.

Returns

The initialized Pointer, or NULL on error.

Remarks

The copied bytes will be freed on dealloc.

Definition at line 87 of file Pointer.c.

                                                                                  {
 
  self = (Pointer *) super(Object, self, init);
  if (self) {
    if (bytes) {
      self->pointer = calloc(1, length);
      assert(self->pointer);
 
      memcpy(self->pointer, bytes, length);
      self->destroy = free;
    }
  }
 
  return self;
}

initWithPointer()

Pointer * initWithPointer	(	Pointer *	self,
		ident	pointer,
		Consumer	destroy
	)

Initializes this Pointer.

Parameters

self	The Pointer.
pointer	The backing pointer.
destroy	An optional destructor, or NULL.

Returns

The initialized Pointer, or NULL on error.

Definition at line 107 of file Pointer.c.

                                                                                {
 
  self = (Pointer *) super(Object, self, init);
  if (self) {
    self->pointer = pointer;
    self->destroy = destroy;
  }
 
  return self;
}

Related

ptr()

OBJECTIVELY_EXPORT Pointer * ptr ( ident  pointer, Consumer  destroy  )

related

A convenience function for instantiating Pointers.

Parameters

pointer	The backing pointer.
destroy	An optional destructor, or NULL.

Returns

A new Pointer, or NULL on error.

Definition at line 157 of file Pointer.c.

                                              {
  return $(alloc(Pointer), initWithPointer, pointer, destroy);
}

---

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

• Sources/Objectively/Pointer.h
• Sources/Objectively/Pointer.c