Resource Struct Reference

#include <Resource.h>

Overview

Resources provide an abstraction for file and stream resources.

Definition at line 53 of file Resource.h.

Inheritance diagram for Resource:

Properties
Data *	data
	The resource data.
char *	name
	The resource name.
Object	object
	The superclass.
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 *	_Resource (void)
	The Resource archetype.
void	addResourcePath (const char *path)
	Adds the specified Resource path.
void	addResourceProvider (ResourceProvider provider)
	Adds the specified ResourceProvider.
Resource *	initWithBytes (Resource *self, const uint8_t *bytes, size_t length, const char *name)
	Initializes this Resource with the specified bytes.
Resource *	initWithData (Resource *self, Data *data)
Resource *	initWithData (Resource *self, Data *data, const char *name)
	Initializes this Resource with the specified Data.
Resource *	initWithName (Resource *self, const char *name)
	Initializes this Resource with the specified name.
void	removeResourcePath (const char *path)
	Removes the specified Resource path.
void	removeResourceProvider (ResourceProvider provider)
	Removes the specified ResourceProvider.
Resource *	resourceWithName (const char *name)
	Returns a new Resource with the specified name.
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
ResourceInterface *	interface
	The interface.
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface.

Property Details

data

Data* Resource::data

The resource data.

Definition at line 69 of file Resource.h.

interface

ResourceInterface* Resource::interface

protected

The interface.

Definition at line 64 of file Resource.h.

name

char* Resource::name

The resource name.

Definition at line 74 of file Resource.h.

object

Object Resource::object

The superclass.

Definition at line 58 of file Resource.h.

Method Details

_Resource()

Class * _Resource

(

void

)

The Resource archetype.

Returns

The Resource Class.

Definition at line 241 of file Resource.c.

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

addResourcePath()

void addResourcePath

(

const char *

path

)

Adds the specified Resource path.

Parameters

path	The resource path to add.

Remarks

Resource paths may be relative to the working directory, or absolute.

Definition at line 61 of file Resource.c.

                                              {
 
  assert(path);
  String *string = str(path);
 
  $(_resourcePaths, addObject, string);
  release(string);
}

addResourceProvider()

void addResourceProvider

(

ResourceProvider

provider

)

Adds the specified ResourceProvider.

Parameters

provider

The ResoureProvider to add.

Definition at line 74 of file Resource.c.

                                                           {
 
  assert(provider);
  Pointer *pointer = $(alloc(Pointer), initWithPointer, provider, NULL);
 
  $(_resourceProviders, addObject, pointer);
  release(pointer);
}

initWithBytes()

Resource * initWithBytes	(	Resource *	self,
		const uint8_t *	bytes,
		size_t	length,
		const char *	name
	)

Initializes this Resource with the specified bytes.

Parameters

self	The Resource.
bytes	The bytes.
length	The length of bytes.
name	The resource name.

Returns

The initialized Resource, or NULL on error.

Definition at line 87 of file Resource.c.

                                                                                                      {
 
  Data *data = $$(Data, dataWithBytes, bytes, length);
  self = $(self, initWithData, data, name);
 
  release(data);
  return self;
}

initWithData() [1/2]

Resource * initWithData	(	Resource *	self,
		Data *	data
	)

initWithData() [2/2]

Resource * initWithData	(	Resource *	self,
		Data *	data,
		const char *	name
	)

Initializes this Resource with the specified Data.

Parameters

self	The Resource.
data	The Data.
name	The resource name.

Returns

The initialized Resource, or NULL on error.

Definition at line 100 of file Resource.c.

                                                                            {
 
  self = (Resource *) super(Object, self, init);
  if (self) {
    assert(data);
    self->data = retain(data);
 
    assert(name);
    self->name = strdup(name);
  }
 
  return self;
}

initWithName()

Resource * initWithName	(	Resource *	self,
		const char *	name
	)

Initializes this Resource with the specified name.

Parameters

self	The Resource.
name	The resource name.

Returns

The initialized Resource, or NULL on error.

The configured resource paths are searched, in order, for a file by the given name.

Definition at line 118 of file Resource.c.

                                                                {
 
  Data *data = NULL;
 
  const Array *resourceProviders = (Array *) _resourceProviders;
  for (size_t i = 0; i < resourceProviders->count && data == NULL; i++) {
 
    const Pointer *pointer = $(resourceProviders, objectAtIndex, i);
    data = ((ResourceProvider) (pointer->pointer))(name);
  }
 
  const Array *resourcePaths = (Array *) _resourcePaths;
  for (size_t i = 0; i < resourcePaths->count && data == NULL; i++) {
 
    const String *resourcePath = $(resourcePaths, objectAtIndex, i);
    String *path = str("%s%s%s", resourcePath->chars, PATH_SEPAR, name);
 
    struct stat s;
    if (stat(path->chars, &s) == 0 && S_ISREG(s.st_mode)) {
      data = $$(Data, dataWithContentsOfFile, path->chars);
    }
 
    release(path);
  }
 
  if (data) {
    self = $(self, initWithData, data, name);
  } else {
    self = release(self);
  }
 
  release(data);
 
  return self;
}

removeResourcePath()

void removeResourcePath

(

const char *

path

)

Removes the specified Resource path.

Parameters

path	The resource path to remove.

Definition at line 158 of file Resource.c.

                                                 {
 
  String *string = $$(String, stringWithCharacters, path);
 
  $(_resourcePaths, removeObject, string);
 
  release(string);
}

removeResourceProvider()

void removeResourceProvider

(

ResourceProvider

provider

)

Removes the specified ResourceProvider.

Parameters

provider

The ResourceProvider to remove.

Definition at line 171 of file Resource.c.

                                                              {
 
  Pointer *pointer = $(alloc(Pointer), initWithPointer, provider, NULL);
 
  $(_resourceProviders, removeObject, pointer);
 
  release(pointer);
}

resourceWithName()

Resource * resourceWithName

(

const char *

name

)

Returns a new Resource with the specified name.

Parameters

name	The resource name.

Returns

The new Resource, or NULL on error.

Definition at line 184 of file Resource.c.

                                                    {
  return $(alloc(Resource), initWithName, name);
}

---

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

• Sources/Objectively/Resource.h
• Sources/Objectively/Resource.c