obtest_private.h File Reference

obtest Private Interface More...

#include "../obtest.h"

Go to the source code of this file.

Classes
struct	obtest_struct
	obtest internal structure, encapsulating all data need for an instance of obtest More...

Functions
ob_hash_t	obtest_hash (const obj *to_hash)
	Hash function for obtest. More...
int8_t	obtest_compare (const obj *a, const obj *b)
	Compares two instances of obtest. More...
void	obtest_display (const obj *test)
	Display function for an instance of obtest. More...
void	obtest_destroy (obj *to_dealloc)
	Destructor for obtest. More...

Detailed Description

obtest Private Interface

Author

theck

Function Documentation

int8_t obtest_compare	(	const obj *	a,
		const obj *	b
	)

Compares two instances of obtest.

Parameters

a	A non-NULL obj pointer to type obtest
b	A non-NULL obj pointer to type obtest

Return values

OB_LESS_THAN	obj a is less than b
OB_GREATER_THAN	obj a is equivalent to b
OB_EQUAL_TO	obj a is greater than b

void obtest_destroy

(

obj *

to_dealloc)

Destructor for obtest.

Parameters

to_dealloc

An obj pointer to an instance of obtest with reference count of 0

Warning

Do not call manually, release will call automatically when instance reference count drops to 0!

void obtest_display

(

const obj *

test)

Display function for an instance of obtest.

Parameters

test	A non-NULL obj pointer to type obtest

ob_hash_t obtest_hash

(

const obj *

to_hash)

Hash function for obtest.

Parameters

to_hash

An obj pointer to an instance of OBString

Returns

Key value (hash) for the given obj pointer to a OBString