Module or script loader. More...

#include <oyCMMapi5_s.h>

Inheritance diagram for oyCMMapi5_s:

Collaboration diagram for oyCMMapi5_s:

Public Types
typedef int(*	oyCMMFilterSocket_MatchPlug_f) (oyFilterSocket_s socket, oyFilterPlug_s plug)
	verify connectors matching each other More...

typedef oyOptions_s (	oyCMMFilter_ValidateOptions_f) (oyFilterCore_s filter, oyOptions_s validate, int statical, uint32_t *result)
	a function to check and validate options More...

typedef int(*	oyCMMFilterScan_f) (oyPointer data, size_t size, const char file_name, oyOBJECT_e type, int num, char registration, char name, oyAlloc_f allocateFunc, oyCMMinfo_s *info, oyObject_s object)
	load a filter from a in memory data blob More...

typedef oyCMMapiFilter_s (	oyCMMFilterLoad_f) (oyPointer data, size_t size, const char *file_name, oyOBJECT_e type, int num)
	load a filter from a in memory data blob More...

Public Types inherited from oyCMMapi_s
typedef int(*	oyCMMInit_f) (oyStruct_s *filter)
	optional CMM init function More...

typedef int(*	oyCMMReset_f) (oyStruct_s *filter)
	optional CMM reset function More...

typedef int(*	oyCMMMessageFuncSet_f) (oyMessage_f message_func)
	optionaly sets a CMM message function More...

typedef int(*	oyCMMCanHandle_f) (oyCMMQUERY_e type, uint32_t value)
	CMM feature declaration function. More...

typedef int(*	oyCMMOptions_Check_f) (oyOptions_s *validate)
	a function to check options More...

typedef const char (	oyCMMGetText_f) (const char select, oyNAME_e type, oyStruct_s context)
	get strings from a CMM More...

Public Member Functions
OYAPI oyCMMapi5_s *OYEXPORT	oyCMMapi5_New (oyObject_s object)
	allocate a new CMMapi5 object More...

OYAPI oyCMMapi5_s *OYEXPORT	oyCMMapi5_Copy (oyCMMapi5_s *cmmapi5, oyObject_s object)
	Copy or Reference a CMMapi5 object. More...

OYAPI int OYEXPORT	oyCMMapi5_Release (oyCMMapi5_s **cmmapi5)
	release and possibly deallocate a oyCMMapi5_s object More...

void	oyCMMapi5_Release__Members (oyCMMapi5_s_ *cmmapi5)
	Custom CMMapi5 destructor. More...

int	oyCMMapi5_Init__Members (oyCMMapi5_s_ *cmmapi5 OY_UNUSED)
	Custom CMMapi5 constructor. More...

int	oyCMMapi5_Copy__Members (oyCMMapi5_s_ dst, oyCMMapi5_s_ src)
	Custom CMMapi5 copy constructor. More...

Public Member Functions inherited from oyCMMapi_s
OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_New (oyObject_s object)
	allocate a new CMMapi object More...

OYAPI oyCMMapi_s *OYEXPORT	oyCMMapi_Copy (oyCMMapi_s *cmmapi, oyObject_s object)
	Copy or Reference a CMMapi object. More...

OYAPI int OYEXPORT	oyCMMapi_Release (oyCMMapi_s **cmmapi)
	release and possibly deallocate a oyCMMapi_s object More...

void	oyCMMapi_Set (oyCMMapi_s api, oyCMMInit_f init, oyCMMReset_f reset, oyCMMMessageFuncSet_f msg_set, const char registration, int32_t version[3], int32_t module_api[3])
	CMMapi member setter. More...

void	oyCMMapi_SetNext (oyCMMapi_s api, oyCMMapi_s next)
	chain CMMapi's More...

oyCMMapi_s *	oyCMMapi_GetNext (oyCMMapi_s *api)
	get next CMMapi More...

void	oyCMMapi_Release__Members (oyCMMapi_s_ *cmmapi)
	Custom CMMapi destructor. More...

int	oyCMMapi_Init__Members (oyCMMapi_s_ *cmmapi OY_UNUSED)
	Custom CMMapi constructor. More...

int	oyCMMapi_Copy__Members (oyCMMapi_s_ dst, oyCMMapi_s_ src)
	Custom CMMapi copy constructor. 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 oyCMMapi_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...

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

Module or script loader.

Member Function Documentation

◆ oyCMMapi5_Copy()

OYAPI oyCMMapi5_s *OYEXPORT oyCMMapi5_Copy	(	oyCMMapi5_s *	cmmapi5,
		oyObject_s	object
	)

Copy or Reference a CMMapi5 object.

Function oyCMMapi5_Copy

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

Parameters

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

◆ oyCMMapi5_Copy__Members()

int oyCMMapi5_Copy__Members	(	oyCMMapi5_s_ *	dst,
		oyCMMapi5_s_ *	src
	)

Custom CMMapi5 copy constructor.

Function oyCMMapi5_Copy__Members

◆ oyCMMapi5_Init__Members()

int oyCMMapi5_Init__Members ( oyCMMapi5_s_ *cmmapi5 OY_UNUSED )

Custom CMMapi5 constructor.

Function oyCMMapi5_Init__Members

◆ oyCMMapi5_New()

OYAPI oyCMMapi5_s *OYEXPORT oyCMMapi5_New ( oyObject_s object )

allocate a new CMMapi5 object

Function oyCMMapi5_New

◆ oyCMMapi5_Release()

OYAPI int OYEXPORT oyCMMapi5_Release ( oyCMMapi5_s ** cmmapi5 )

release and possibly deallocate a oyCMMapi5_s object

Function oyCMMapi5_Release

Parameters

[in,out] cmmapi5 CMMapi5 struct object

◆ oyCMMapi5_Release__Members()

void oyCMMapi5_Release__Members ( oyCMMapi5_s_ * cmmapi5 )

Custom CMMapi5 destructor.

Function oyCMMapi5_Release__Members

Field Documentation

◆ copy

oyStruct_Copy_f oyCMMapi5_s::copy

Copy function.

◆ oy_

oyObject_s oyCMMapi5_s::oy_

Oyranos internal object.

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

◆ release

oyStruct_Release_f oyCMMapi5_s::release

Release function.

◆ type_

const oyOBJECT_e oyCMMapi5_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Types

Public Member Functions

Data Fields