oyPointer_s Struct Reference

custom pointer More...

#include <oyPointer_s.h>

Inheritance diagram for oyPointer_s:

Collaboration diagram for oyPointer_s:

Public Member Functions
OYAPI oyPointer_s *OYEXPORT	oyPointer_New (oyObject_s object)
	allocate a new Pointer object More...
OYAPI oyPointer_s *OYEXPORT	oyPointer_Copy (oyPointer_s *pointer, oyObject_s object)
	Copy or Reference a Pointer object. More...
OYAPI int OYEXPORT	oyPointer_Release (oyPointer_s **pointer)
	release and possibly deallocate a oyPointer_s object More...
int	oyPointer_Set (oyPointer_s *cmm_ptr, const char *lib_name, const char *resource, oyPointer ptr, const char *func_name, oyPointer_release_f ptrRelease)
	set a oyPointer_s More...
oyPointer_s *	oyPointer_LookUpFromObject (oyStruct_s *data, const char *data_type)
	Get a module specific pointer from cache. More...
oyPointer_s *	oyPointer_LookUpFromText (const char *text, const char *data_type)
	Get a module specific pointer from cache. More...
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...
int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...
const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...
const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
const oyOBJECT_e	type_
	Type of object. More...
oyStruct_Copy_f	copy
	Copy function. More...
oyStruct_Release_f	release
	Release function. More...
oyObject_s	oy_
	Oyranos internal object. More...
Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...
oyStruct_Copy_f	copy
	Copy function. More...
oyStruct_Release_f	release
	Release function. More...
oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

custom pointer

Examples:

oyranos_cmm_oJPG.c.

Member Function Documentation

oyPointer_Copy()

OYAPI oyPointer_s *OYEXPORT oyPointer_Copy	(	oyPointer_s *	pointer,
		oyObject_s	object
	)

Copy or Reference a Pointer object.

Function oyPointer_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	pointer	Pointer struct object
	object	NULL - means reference, the optional object triggers a real copy

oyPointer_LookUpFromObject()

oyPointer_s * oyPointer_LookUpFromObject	(	oyStruct_s *	data,
		const char *	data_type
	)

Get a module specific pointer from cache.

The returned oyPointer_s has to be released after using by the module with oyPointer_Release(). In case the the oyPointer_s::ptr member is empty, it should be set by the requesting module.

See also

oyPointer_LookUpFromText()

Parameters

[in]	data	object to look up
[in]	data_type	four byte module type for this object type; The data_type shall enshure the returned oyPointer_s is specific to the calling module.

Returns

the CMM specific oyPointer_s; It is owned by the CMM.

Version

Oyranos: 0.1.10

Since

2008/12/28 (Oyranos: 0.1.10)

Date

2009/11/05

References oyStruct_s::oy_, oy_debug, oyNAME_NICK, oyObject_GetName(), and oyPointer_LookUpFromText().

oyPointer_LookUpFromText()

oyPointer_s * oyPointer_LookUpFromText	(	const char *	text,
		const char *	data_type
	)

Get a module specific pointer from cache.

The returned oyPointer_s has to be released after using by the module with oyPointer_Release(). In case the the oyPointer_s::ptr member is empty, it should be set by the requesting module.

See also

e.g. lcmsCMMData_Open()

Parameters

[in]	text	hash text to look up
[in]	data_type	four byte module type for this object type; The data_type shall enshure the returned oyPointer_s is specific to the calling module.

Returns

the CMM specific oyPointer_s; It is owned by the CMM.

Version

Oyranos: 0.1.10

Since

2009/11/05 (Oyranos: 0.1.10)

Date

2009/11/05

Cache Search

1. hash from input
   
2. query for hash in cache
   
3. check
   3a. eighter take cache entry or
   3b. update cache entry

Referenced by oyPointer_LookUpFromObject().

oyPointer_New()

OYAPI oyPointer_s *OYEXPORT oyPointer_New

(

oyObject_s

object

)

allocate a new Pointer object

Function oyPointer_New

Examples:

oyranos_cmm_oJPG.c.

oyPointer_Release()

OYAPI int OYEXPORT oyPointer_Release

(

oyPointer_s **

pointer

)

release and possibly deallocate a oyPointer_s object

Function oyPointer_Release

Parameters

[in,out]

pointer

Pointer struct object

Examples:

oyranos_cmm_oJPG.c.

Field Documentation

copy

oyStruct_Copy_f oyPointer_s::copy

Copy function.

oy_

oyObject_s oyPointer_s::oy_

Oyranos internal object.

Features name and hash. Do not change during object life time.

release

oyStruct_Release_f oyPointer_s::release

Release function.

type_

const oyOBJECT_e oyPointer_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.