A group of options for a device. More...

#include <oyConfig_s.h>

Inheritance diagram for oyConfig_s:

Collaboration diagram for oyConfig_s:

Public Member Functions
OYAPI oyConfig_s *OYEXPORT	oyConfig_New (oyObject_s object)
	allocate a new Config object More...

OYAPI oyConfig_s *OYEXPORT	oyConfig_Copy (oyConfig_s *config, oyObject_s object)
	Copy or Reference a Config object. More...

OYAPI int OYEXPORT	oyConfig_Release (oyConfig_s **config)
	release and possibly deallocate a oyConfig_s object More...

OYAPI int OYEXPORT	oyConfig_AddDBData (oyConfig_s config, const char key, const char *value, uint32_t flags)
	add a key value pair to a oyConfig_s::db More...

OYAPI int OYEXPORT	oyConfig_ClearDBData (oyConfig_s *config)
	Remove all additional data from the oyConfig_s::db object cache. More...

OYAPI int OYEXPORT	oyConfig_GetDB (oyConfig_s device, oyOptions_s options, int32_t *rank_value)
	search a configuration in the DB for a configuration from module More...

OYAPI int OYEXPORT	oyConfig_SelectDB (oyConfig_s device, oyConfigs_s configs, int32_t *rank_value)
	select a db configuration More...

OYAPI int OYEXPORT	oyConfig_SaveToDB (oyConfig_s *config, oySCOPE_e scope)
	Store a oyConfig_s in DB. More...

OYAPI int OYEXPORT	oyConfig_EraseFromDB (oyConfig_s *config, oySCOPE_e scope)
	Remove a oyConfig_s from DB. More...

OYAPI int OYEXPORT	oyConfig_Match (oyConfig_s module_device, oyConfig_s db_pattern, char path_separator, char key_separator, int flags, int32_t *rank_value)
	Check for fine grained matching to a given pattern. More...

OYAPI int OYEXPORT	oyConfig_DomainRank (oyConfig_s *config)
	Check for being recognised by a given module. More...

OYAPI const char *OYEXPORT	oyConfig_FindString (oyConfig_s config, const char key, const char *value)
	Search in data sets for a key/value. More...

OYAPI int OYEXPORT	oyConfig_Has (oyConfig_s config, const char key)
	Search in data sets for a key. More...

OYAPI oyOption_s *OYEXPORT	oyConfig_Find (oyConfig_s config, const char key)
	Search in data sets for a key. More...

OYAPI int OYEXPORT	oyConfig_Count (oyConfig_s *config)
	Number of all options. More...

OYAPI oyOption_s *OYEXPORT	oyConfig_Get (oyConfig_s *config, int pos)
	Get one option. More...

OYAPI oyOptions_s **OYEXPORT	oyConfig_GetOptions (oyConfig_s config, const char source)
	Get options from a source. More...

OYAPI int OYEXPORT	oyConfig_FromJSON (const char registration, const char json_text, oyOptions_s options, oyObject_s object, oyConfig_s *config)
	Create a config object from JSON. More...

OYAPI int OYEXPORT	oyConfig_SetRankMap (oyConfig_s config, const oyRankMap rank_map)
	Set the ranking table. More...

OYAPI const oyRankMap *OYEXPORT	oyConfig_GetRankMap (oyConfig_s *config)
	Get the ranking table. More...

OYAPI oyRankMap *OYEXPORT	oyRankMapCopy (const oyRankMap *rank_map, oyAlloc_f allocateFunc)
	Copy a rank map. More...

OYAPI void OYEXPORT	oyRankMapRelease (oyRankMap **rank_map, oyDeAlloc_f deAllocateFunc)
	Release a Rank Map. More...

OYAPI int OYEXPORT	oyRankMapAppend (oyRankMap *rank_map, const char key, int match_value, int none_match_value, int not_found_value, oyAlloc_f allocateFunc, oyDeAlloc_f deAllocateFunc)
	Append a rank map entry. More...

OYAPI int OYEXPORT	oyRankMapFromJSON (const char json_text, oyOptions_s options, oyRankMap **rank_map, oyAlloc_f allocateFunc)
	Create a Rank Map. More...

OYAPI int OYEXPORT	oyRankMapToJSON (const oyRankMap rank_map, oyOptions_s options, char **json_text, oyAlloc_f allocateFunc)
	Create JSON from a Rank Map. More...

OYAPI int OYEXPORT	oyRankMapList (const char filter, oyOptions_s options, char ***rank_map_file_names, oyAlloc_f allocateFunc)
	List installed Rank Map Files. More...

OYAPI oyConfig_s *OYEXPORT	oyConfig_FromRegistration (const char *registration, oyObject_s object)
	New config with registration. More...

OYAPI int OYEXPORT	oyConfig_GetBestMatchFromTaxiDB (oyConfig_s device, int32_t rank_value)
	search a profile ID in the Taxi DB for a configuration More...

OYAPI const char *OYEXPORT	oyConfig_GetRegistration (oyConfig_s *config)
	Get the registration string Registration. More...

OYAPI int OYEXPORT	oyConfig_Set (oyConfig_s config, const char registration_domain, oyOptions_s options, oyBlob_s data)
	Unimplemented! 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

A group of options for a device.

Version: Oyranos: 0.1.10

Since: 2009/01/15 (Oyranos: 0.1.10)

Date: 2009/01/15

Examples:: image2pdf.c, tutorial1.c, and tutorial_taxi.c.

Member Function Documentation

◆ oyConfig_AddDBData()

OYAPI int OYEXPORT oyConfig_AddDBData	(	oyConfig_s *	config,
		const char *	key,
		const char *	value,
		uint32_t	flags
	)

add a key value pair to a oyConfig_s::db

Function oyConfig_AddDBData

This functions handles canonical user side settings. The keys added with this function can later be stored in the DB. A call to oyConfig_GetDB() or oyConfig_ClearDBData() overwrite the added entries.
Modules should add informations to oyConfig_s::data.

Parameters

[in]	config	the configuration
[in]	key	a key name, e.g. "my_key"
[in]	value	a value, e.g. "my_value"
[in]	flags	see oyOptions_s::oyOptions_SetFromString(.., flags,..)

Returns: 0 - good, 1 >= error

Version: Oyranos: 0.1.10

Since: 2009/01/21 (Oyranos: 0.1.10)

Date: 2009/02/08

We provide basically a wrapper for oyOptions_SetFromString().

◆ oyConfig_ClearDBData()

OYAPI int OYEXPORT oyConfig_ClearDBData ( oyConfig_s * config )

Remove all additional data from the oyConfig_s::db object cache.

Function oyConfig_ClearDBData

Clear the local DB cache. The function will be called as well from oyConfig_GetDB().

Parameters

[in] config the configuration

Returns: 0 - good, 1 >= error

Version: Oyranos: 0.1.10

Since: 2009/02/08 (Oyranos: 0.1.10)

Date: 2009/02/08

◆ oyConfig_Copy()

OYAPI oyConfig_s *OYEXPORT oyConfig_Copy	(	oyConfig_s *	config,
		oyObject_s	object
	)

Copy or Reference a Config object.

Function oyConfig_Copy

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

Parameters

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

◆ oyConfig_Count()

OYAPI int OYEXPORT oyConfig_Count ( oyConfig_s * config )

Number of all options.

Function oyConfig_Count

Parameters

[in] config the configuration

Returns: the options count

Version: Oyranos: 0.1.10

Since: 2009/02/08 (Oyranos: 0.1.10)

Date: 2009/02/08

Referenced by oyDeviceToJSON().

◆ oyConfig_DomainRank()

OYAPI int OYEXPORT oyConfig_DomainRank ( oyConfig_s * config )

Check for being recognised by a given module.

Function oyConfig_DomainRank

Parameters

[in] config the configuration to be checked wether or not the module can make sense of it and support the data

Returns: 0 - indifferent, <= -1 - no fit

Version: Oyranos: 0.1.10

Since: 2009/01/26 (Oyranos: 0.1.10)

Date: 2009/01/26

Ask the module if it wants later on to accept this configuration.

◆ oyConfig_EraseFromDB()

OYAPI int OYEXPORT oyConfig_EraseFromDB	(	oyConfig_s *	config,
		oySCOPE_e	scope
	)

Remove a oyConfig_s from DB.

Function oyConfig_EraseFromDB

Parameters

[in]	config	the configuration
	scope	oySCOPE_USER and oySCOPE_SYS are possible

Returns: 0 - good, 1 >= error

Version: Oyranos: 0.9.7

Date: 2020/10/26

Since: 2009/01/27 (Oyranos: 0.1.10)

If a key has one slash more than 4. Cut the last slash off.

Cut off any attributes to the config::registration.

◆ oyConfig_Find()

OYAPI oyOption_s *OYEXPORT oyConfig_Find	(	oyConfig_s *	config,
		const char *	key
	)

Search in data sets for a key.

Function oyConfig_Find

Parameters

[in]	config	the configuration to be checked wether or not the module can make sense of it and support the data
[in]	key	the key name

Returns: the found value

Version: Oyranos: 0.1.10

Since: 2009/02/08 (Oyranos: 0.1.10)

Date: 2009/02/08

◆ oyConfig_FindString()

OYAPI const char *OYEXPORT oyConfig_FindString	(	oyConfig_s *	config,
		const char *	key,
		const char *	value
	)

Search in data sets for a key/value.

Function oyConfig_FindString

Parameters

[in]	config	the configuration to be checked wether or not the module can make sense of it and support the data
[in]	key	the key name
[in]	value	the optional value

Returns: the found value

Version: Oyranos: 0.1.10

Since: 2009/02/08 (Oyranos: 0.1.10)

Date: 2009/02/08

Examples:: tutorial_taxi.c.

Referenced by oyDeviceToJSON(), and oyProfile_s::oyProfile_AddDevice().

◆ oyConfig_FromJSON()

OYAPI int OYEXPORT oyConfig_FromJSON	(	const char *	registration,
		const char *	json_text,
		oyOptions_s *	options,
		oyObject_s	object,
		oyConfig_s **	config
	)

Create a config object from JSON.

Function oyConfig_FromJSON

Get all ICC profiles, which can be used as assumed RGB profile:

    // Get all ICC profiles, which can be used as assumed RGB profile
    uint32_t icc_profile_flags = oyICCProfileSelectionFlagsFromOptions( 
                                      OY_CMM_STD, "//" OY_TYPE_STD "/icc_color",
                                                                     NULL, 0 );
    oyProfiles_s * p_list = oyProfiles_ForStd( oyASSUMED_RGB,
                                               icc_profile_flags, 0,testobj );
    int32_t * rank_list = (int32_t*) malloc( oyProfiles_Count(p_list) *
                                             sizeof(int32_t) );
    oyRankMap * rank_map = 0;
    const char * rank_map_text = "{\"org\":{\"freedesktop\":{\"openicc\":{\"rank_map\":{\"meta\":[{\"STANDARD_space\": [2,-1,0,\"matching\",\"not matching\",\"key not found\"]}]}}}}}";
    oyRankMapFromJSON( rank_map_text, NULL, &rank_map, malloc );
    const char * filter_text = "{\"org\":{\"freedesktop\":{\"openicc\":{\"config\":{\"meta\":[{\"STANDARD_space\": \"rgb\"}]}}}}}",
               * filter_registration = "org/freedesktop/openicc/config/meta";
    oyConfig_s * config = NULL;
    oyConfig_FromJSON( filter_registration, filter_text, 0,0, &config );
    oyConfig_SetRankMap( config, rank_map );
    oyRankMapRelease( &rank_map, free );
    // Sort the profiles according to eaches match to a given device
    oyProfiles_Rank( p_list, config, '/', ',', OY_MATCH_SUB_STRING |
             OY_SYNTAX_SKIP_PATTERN | OY_SYNTAX_SKIP_REG, rank_list );
    int n = oyProfiles_Count( p_list );
    if(verbose)
    for(i = 0; i < n; ++i)
    {
      oyProfile_s * temp_prof = oyProfiles_Get( p_list, i );
      // Show the rank value, the profile internal and file names on the command line
      printf("%d %d: \"%s\" %s\n", rank_list[i], i,
             oyProfile_GetText( temp_prof, oyNAME_DESCRIPTION ),
             oyProfile_GetFileName(temp_prof, 0));
      oyProfile_Release( &temp_prof );
    } // Done print

See also: oyProfiles_Rank()

Parameters

	registration	full qualified registration
[in]	json_text	the JSON containing the config keys under the registration path
[in]	options	optional "underline_key_suffix" will be used as suffix for keys starting with underline '_' "pos" integer selects position in array; defaults to: 0 "xpath" replaces xpath; defaults to: registration + "/[%d]"
	object	the optional object
[out]	config	the result

Returns: error

Version: Oyranos: 0.9.7

Date: 2017/01/28

Since: 2011/08/21 (Oyranos: 0.3.2)

References oyOptions_s::oyOptions_FindString().

◆ oyConfig_FromRegistration()

OYAPI oyConfig_s *OYEXPORT oyConfig_FromRegistration	(	const char *	registration,
		oyObject_s	object
	)

New config with registration.

Function oyConfig_FromRegistration

Parameters

registration	no or full qualified registration
object	the optional object

Returns: the config

Version: Oyranos: 0.1.11

Since: 2010/08/09 (Oyranos: 0.1.11)

Date: 2010/08/09

◆ oyConfig_Get()

OYAPI oyOption_s *OYEXPORT oyConfig_Get	(	oyConfig_s *	config,
		int	pos
	)

Get one option.

Function oyConfig_Get

Parameters

[in]	config	the configuration
[in]	pos	option position

Returns: the selected option

Version: Oyranos: 0.1.10

Since: 2009/02/08 (Oyranos: 0.1.10)

Date: 2009/02/08

Referenced by oyDeviceToJSON().

◆ oyConfig_GetBestMatchFromTaxiDB()

OYAPI int OYEXPORT oyConfig_GetBestMatchFromTaxiDB	(	oyConfig_s *	device,
		int32_t *	rank_value
	)

search a profile ID in the Taxi DB for a configuration

Function oyConfig_GetBestMatchFromTaxiDB

Parameters

[in]	device	the to be checked configuration from oyConfigs_FromPattern_f
[out]	rank_value	the number of matches between config and pattern, -1 means invalid

Returns: 0 - good, >= 1 - error + a message should be sent

Version: Oyranos: 0.3.2

Since: 2009/01/26 (Oyranos: 0.3.2)

Date: 2011/09/14

◆ oyConfig_GetDB()

OYAPI int OYEXPORT oyConfig_GetDB	(	oyConfig_s *	device,
		oyOptions_s *	options,
		int32_t *	rank_value
	)

search a configuration in the DB for a configuration from module

Function oyConfig_GetDB

Parameters

[in]	device	the to be checked configuration from oyConfigs_FromPattern_f
[in]	options	supported is "module" containing a registration string to select a module, see as well oyConfigs_FromDB()
[out]	rank_value	the number of matches between config and pattern, -1 means invalid

Returns: 0 - good, >= 1 - error + a message should be sent

Version: Oyranos: 0.3.0

Since: 2009/01/26 (Oyranos: 0.1.10)

Date: 2012/09/15

◆ oyConfig_GetOptions()

OYAPI oyOptions_s **OYEXPORT oyConfig_GetOptions	(	oyConfig_s *	config,
		const char *	source
	)

Get options from a source.

Function oyConfig_GetOptions

This API allows low level operations on a Config object. Do not release the returned Options without replacement inside the Config object.

A Config object has three kind of options.

The data base "db" properties are for persistent storage in a DB, e.g. "org/freedesktop/imaging/config.monitor.xorg/1/manufacturer=EIZO"

The "backend_core" options are the module core properties, the ones to identify the device and store in DB. They must be filled by the module. e.g. "org/freedesktop/imaging/config.monitor.xorg/manufacturer=EIZO"

The "data" properties are additional options without identification purpose and not intended for DB storage, e.g. "org/freedesktop/imaging/config.monitor.xorg/edid=oyBlob_s*"

Parameters

[in]	config	the configuration
[in]	source	use of the options, "db" for persistent options "backend_core" for module options "data" for module options without identification purpose

Returns: the selected options, in the domain of the config

Version: Oyranos: 0.5.0

Date: 2012/10/03

Since: 2012/10/03 (Oyranos: 0.5.0)

Examples:: tutorial_taxi.c.

Referenced by oyDeviceToJSON().

◆ oyConfig_GetRankMap()

OYAPI const oyRankMap *OYEXPORT oyConfig_GetRankMap ( oyConfig_s * config )

Get the ranking table.

Function oyConfig_GetRankMap

Parameters

[in] config the configuration

Returns: rank_map the rank map

Version: Oyranos: 0.5.0

Date: 2012/10/03

Since: 2012/10/03 (Oyranos: 0.5.0)

◆ oyConfig_GetRegistration()

OYAPI const char *OYEXPORT oyConfig_GetRegistration ( oyConfig_s * config )

Get the registration string Registration.

Function oyConfig_GetRegistration

Parameters

[in] config the config

Returns: the registration string

Version: Oyranos: 0.5.0

Date: 2012/09/19

Since: 2012/09/19 (Oyranos: 0.5.0)

◆ oyConfig_Has()

OYAPI int OYEXPORT oyConfig_Has	(	oyConfig_s *	config,
		const char *	key
	)

Search in data sets for a key.

Function oyConfig_Has

Parameters

[in]	config	the configuration to be checked wether or not the module can make sense of it and support the data
[in]	key	the key name

Returns: 0 - not found; 1 - key found

Version: Oyranos: 0.1.10

Since: 2009/12/10 (Oyranos: 0.1.10)

Date: 2009/12/10

◆ oyConfig_Match()

OYAPI int OYEXPORT oyConfig_Match	(	oyConfig_s *	module_device,
		oyConfig_s *	db_pattern,
		char	path_separator,
		char	key_separator,
		int	flags,
		int32_t *	rank_value
	)

Check for fine grained matching to a given pattern.

Parameters

[in]	module_device	the to be checked configuration from oyConfigs_FromPattern_f; Additional allowed are DB configs.
[in]	db_pattern	the to be compared configuration from elsewhere, e.g. ICC dict tag
	path_separator	a char to split into hierarchical levels
	key_separator	a char to split key strings
	flags	options: OY_MATCH_SUB_STRING - find sub string; default is whole word match
[out]	rank_value	the number of matches between config and pattern, -1 means invalid

Returns: 0 - good, >= 1 - error + a message should be sent

Version: Oyranos: 0.9.7

Date: 2017/01/05

Since: 2017/01/05 (Oyranos: 0.9.7)

Option name is equal and and value matches : increase rank value

  we need a comparision mechanism here. The pattern value
  should be expandable to several values.
  Do we need more than the ICC dict style syntax here?

◆ oyConfig_New()

OYAPI oyConfig_s *OYEXPORT oyConfig_New ( oyObject_s object )

allocate a new Config object

Function oyConfig_New

◆ oyConfig_Release()

OYAPI int OYEXPORT oyConfig_Release ( oyConfig_s ** config )

release and possibly deallocate a oyConfig_s object

Function oyConfig_Release

Parameters

[in,out] config Config struct object

◆ oyConfig_SaveToDB()

OYAPI int OYEXPORT oyConfig_SaveToDB	(	oyConfig_s *	config,
		oySCOPE_e	scope
	)

Store a oyConfig_s in DB.

Function oyConfig_SaveToDB

The new key set name is stored inside the key "key_set_name".

Parameters

[in]	config	the configuration
	scope	oySCOPE_USER and oySCOPE_SYS are possible

Returns: 0 - good, 1 >= error

Version: Oyranos: 0.1.10

Since: 2009/01/21 (Oyranos: 0.1.10)

Date: 2011/01/29

◆ oyConfig_SelectDB()

OYAPI int OYEXPORT oyConfig_SelectDB	(	oyConfig_s *	device,
		oyConfigs_s *	configs,
		int32_t *	rank_value
	)

select a db configuration

Function oyConfig_SelectDB

This function is useful to fill the best matching config into the db options set.

Parameters

[in,out]	device	the to be checked configuration from oyConfigs_FromPattern_f
[in]	configs	the possible configs to select the best db match from
[out]	rank_value	the number of matches between config and pattern, -1 means invalid

Returns: 0 - good, >= 1 - error + a message should be sent

Version: Oyranos: 0.9.6

Date: 2015/02/15

Since: 2009/01/26 (Oyranos: 0.3.2)

iterate over all configs
oyDeviceCompare() with the provided device
store the biggest rank_value
copy the config::db from configs with the biggest rank_value into the device::db

◆ oyConfig_Set()

OYAPI int OYEXPORT oyConfig_Set	(	oyConfig_s *	config,
		const char *	registration_domain,
		oyOptions_s *	options,
		oyBlob_s *	data
	)

Unimplemented!

Function oyConfig_Set

◆ oyConfig_SetRankMap()

OYAPI int OYEXPORT oyConfig_SetRankMap	(	oyConfig_s *	config,
		const oyRankMap *	rank_map
	)

Set the ranking table.

Function oyConfig_SetRankMap

Parameters

[in,out]	config	the configuration
[in]	rank_map	the new rank map

Returns: error

Version: Oyranos: 0.5.0

Date: 2012/10/03

Since: 2012/10/03 (Oyranos: 0.5.0)

◆ oyRankMapAppend()

OYAPI int OYEXPORT oyRankMapAppend	(	oyRankMap **	rank_map,
		const char *	key,
		int	match_value,
		int	none_match_value,
		int	not_found_value,
		oyAlloc_f	allocateFunc,
		oyDeAlloc_f	deAllocateFunc
	)

Append a rank map entry.

Function oyRankMapAppend

A helper function to continually construct rank maps.

Parameters

[in,out]	rank_map	a pointer to a data structure, The pointed to structure can be NULL.
[in]	key	the key to apply ranking to
[in]	match_value	a found and matched value
[in]	none_match_value	a found and not matched value
[in]	not_found_value	a not found value
[in]	allocateFunc	the memory allocation function, optional
[in]	deAllocateFunc	the memory release function, optional

Version: Oyranos: 0.9.5

Date: 2013/02/22

Since: 2013/02/22 (Oyranos: 0.9.5)

◆ oyRankMapCopy()

OYAPI oyRankMap *OYEXPORT oyRankMapCopy	(	const oyRankMap *	rank_map,
		oyAlloc_f	allocateFunc
	)

Copy a rank map.

Function oyRankMapCopy

Version: Oyranos: 0.1.10

Since: 2009/01/27 (Oyranos: 0.1.10)

Date: 2009/01/27

◆ oyRankMapFromJSON()

OYAPI int OYEXPORT oyRankMapFromJSON	(	const char *	json_text,
		oyOptions_s *	options,
		oyRankMap **	rank_map,
		oyAlloc_f	allocateFunc
	)

Create a Rank Map.

Function oyRankMapFromJSON

const char * rank_map_text = "{\"org\":{\"freedesktop\":{\"openicc\":{\"rank_map\":{\"my_type\":[{\"key\": [2,-1,0,\"matching\",\"not matching\",\"key not found\"]}]}}}}}";
oyRankMap * rank_map = NULL;
int error = oyRankMapFromJSON( rank_map_text, NULL, &rank_map, malloc ); 

Parameters

[in]	json_text	the rank map definition
[in]	options	optional "pos" integer selects position in array
[out]	rank_map	the result
[in]	allocateFunc	the memory allocate function

Returns: 0 - good, >= 1 - error + a message should be sent, < 0 - an issue

Version: Oyranos: 0.9.5

Date: 2013/02/13

Since: 2013/02/13 (Oyranos: 0.9.5)

◆ oyRankMapList()

OYAPI int OYEXPORT oyRankMapList	(	const char *	filter,
		oyOptions_s *	options,
		char ***	rank_map_file_names,
		oyAlloc_f	allocateFunc
	)

List installed Rank Map Files.

Function oyRankMapList

Load the file content with oyRankMapFromJSON().

Parameters

[in]	filter	a string to prefilter file names; optional
[in]	options	- "path" - show paths instead of files
[out]	rank_map_file_names	zero terminated list of rank map JSON files
[in]	allocateFunc	the memory allocate function

Returns: 0 - good, >= 1 - error + a message should be sent, < 0 - an issue

Version: Oyranos: 0.9.6

Date: 2015/08/04

Since: 2015/08/04 (Oyranos: 0.9.6)

References oyOptions_s::oyOptions_FindString().

◆ oyRankMapRelease()

OYAPI void OYEXPORT oyRankMapRelease	(	oyRankMap **	rank_map,
		oyDeAlloc_f	deAllocateFunc
	)

Release a Rank Map.

Function oyRankMapRelease

Parameters

[in,out]	rank_map	the rank map
[in]	deAllocateFunc	the memory release function

Returns: error

Version: Oyranos: 0.5.0

Date: 2012/10/03

Since: 2012/10/03 (Oyranos: 0.5.0)

◆ oyRankMapToJSON()

OYAPI int OYEXPORT oyRankMapToJSON	(	const oyRankMap *	rank_map,
		oyOptions_s *	options,
		char **	json_text,
		oyAlloc_f	allocateFunc
	)

Create JSON from a Rank Map.

Function oyRankMapToJSON

Parameters

[in]	rank_map	the rank map
[in]	options	optional "pos" integer selects position in array "device_class" will be placed into the JSON
[out]	json_text	the result
[in]	allocateFunc	the memory allocate function

Returns: 0 - good, >= 1 - error + a message should be sent, < 0 - an issue

Version: Oyranos: 0.9.5

Date: 2013/02/13

Since: 2013/02/13 (Oyranos: 0.9.5)

References oyOptions_s::oyOptions_FindString().

Field Documentation

◆ copy

oyStruct_Copy_f oyConfig_s::copy

Copy function.

◆ oy_

oyObject_s oyConfig_s::oy_

Oyranos internal object.

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

◆ release

oyStruct_Release_f oyConfig_s::release

Release function.

◆ type_

const oyOBJECT_e oyConfig_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ oyConfig_AddDBData()

◆ oyConfig_ClearDBData()

◆ oyConfig_Copy()

◆ oyConfig_Count()

◆ oyConfig_DomainRank()

◆ oyConfig_EraseFromDB()

◆ oyConfig_Find()

◆ oyConfig_FindString()

◆ oyConfig_FromJSON()

◆ oyConfig_FromRegistration()

◆ oyConfig_Get()

◆ oyConfig_GetBestMatchFromTaxiDB()

◆ oyConfig_GetDB()

◆ oyConfig_GetOptions()

◆ oyConfig_GetRankMap()

◆ oyConfig_GetRegistration()

◆ oyConfig_Has()

◆ oyConfig_Match()

◆ oyConfig_New()

◆ oyConfig_Release()

◆ oyConfig_SaveToDB()

◆ oyConfig_SelectDB()

◆ oyConfig_Set()

◆ oyConfig_SetRankMap()

◆ oyRankMapAppend()

◆ oyRankMapCopy()

◆ oyRankMapFromJSON()

◆ oyRankMapList()

◆ oyRankMapRelease()

◆ oyRankMapToJSON()

Field Documentation

◆ copy

◆ oy_

◆ release

◆ type_