oyCMMapi5_s Struct Reference

module or script loader More...

#include <oyranos_cmm.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
typedef oyOptions_s *(*	oyCMMFilter_ValidateOptions_f )(oyFilterCore_s *filter, oyOptions_s *validate, int statical, uint32_t *result)
	a function to check and validate options
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
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
Public Types inherited from oyCMMapi_s
typedef int(*	oyCMMCanHandle_f )(oyCMMQUERY_e type, uint32_t value)
	CMM feature declaration function.
typedef int(*	oyCMMInit_f )(oyStruct_s *filter)
	optional CMM init function
typedef int(*	oyCMMMessageFuncSet_f )(oyMessage_f message_func)
	optionaly sets a CMM message function
typedef int(*	oyCMMOptions_Check_f )(oyOptions_s *validate)
	a function to check options

Data Fields
oyOBJECT_e	type
oyPointer	dummya
oyPointer	dummyb
oyPointer	dummyc
oyCMMapi_s *	next
oyCMMInit_f	oyCMMInit
oyCMMMessageFuncSet_f	oyCMMMessageFuncSet
const char *	registration
int32_t	version [3]
int32_t	module_api [3]
const char *	sub_paths
const char *	ext
int32_t	data_type
oyCMMFilterLoad_f	oyCMMFilterLoad
oyCMMFilterScan_f	oyCMMFilterScan
Data Fields inherited from oyCMMapi_s

---

Detailed Description

module or script loader

Filters can be provided in non library form, e.g. as text files. This API allowes for registring of paths and file types to be recognised as filters. The API must provide the means to search, list, verify and open these script filters through Oyranos. The filters are opened in Oyranos and passed as blobs to the API function for obtaining light wight informations, e.g. list the scanned filters in a user selection widget. Further the API is responsible to open the filter and create a oyFilter_s object.

Version:

Oyranos: 0.1.10

Since:

2008/11/22 (Oyranos: 0.1.9)

Date:

2010/06/25

---

Field Documentation

int32_t oyCMMapi5_s::data_type

0: libs - libraries, Oyranos searches in the XDG_LIBRARY_PATH and sub_paths, The library will be provided as file_name
1: scripts - platform independent filters, Oyranos will search in the XDG_DATA_* paths, Script are provided as i memory blobs

oyPointer oyCMMapi5_s::dummya

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi5_s::dummyb

keep to zero

Reimplemented from oyCMMapi_s.

oyPointer oyCMMapi5_s::dummyc

keep to zero

Reimplemented from oyCMMapi_s.

const char* oyCMMapi5_s::ext

optional filename extensions, e.g. "shi:ctl"

int32_t oyCMMapi5_s::module_api[3]

0: last major Oyranos version during development time, e.g. 0 1: last minor Oyranos version during development time, e.g. 0 2: last Oyranos patch version during development time, e.g. 10

Reimplemented from oyCMMapi_s.

oyCMMapi_s* oyCMMapi5_s::next

the next CMM api

Reimplemented from oyCMMapi_s.

oyCMMFilterLoad_f oyCMMapi5_s::oyCMMFilterLoad

oyCMMFilterScan_f oyCMMapi5_s::oyCMMFilterScan

oyCMMInit_f oyCMMapi5_s::oyCMMInit

Reimplemented from oyCMMapi_s.

oyCMMMessageFuncSet_f oyCMMapi5_s::oyCMMMessageFuncSet

Reimplemented from oyCMMapi_s.

const char* oyCMMapi5_s::registration

e.g. "sw/oyranos.org/colour.tonemap.imaging/hydra.shiva" or "sw/oyranos.org/colour/icc", see as well Registration

Reimplemented from oyCMMapi_s.

const char* oyCMMapi5_s::sub_paths

a colon separated list of sub paths to expect the scripts in, e.g. "color/shiva:color/octl"

oyOBJECT_e oyCMMapi5_s::type

struct type oyOBJECT_CMM_API5_S

Reimplemented from oyCMMapi_s.

int32_t oyCMMapi5_s::version[3]

0: major - should be stable for the live time of a filter,
1: minor - mark new features,
2: patch version - correct errors

Reimplemented from oyCMMapi_s.