![]() |
Oyranos Color Management System API |
A group of options for a device. More...
#include <oyConfig_s.h>
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, int32_t *rank_value) |
search a configuration in the DB for a configuration from module More... | |
OYAPI int OYEXPORT | oyConfig_GetFromDB (oyConfig_s *device, oyConfigs_s *configs, int32_t *rank_value) |
search a configuration in the DB for a configuration from module More... | |
OYAPI int OYEXPORT | oyConfig_SaveToDB (oyConfig_s *config) |
Store a oyConfig_s in DB. More... | |
OYAPI int OYEXPORT | oyConfig_EraseFromDB (oyConfig_s *config) |
Remove a oyConfig_s from DB. More... | |
int | oyConfig_Compare (oyConfig_s *module_device, oyConfig_s *db_pattern, int32_t *rank_value) |
Check for 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_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 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... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
A group of options for a device.
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.
[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_SetFromText(.., flags,..) |
We provide basically a wrapper for oyOptions_SetFromText().
References OY_SLASH, OY_SLASH_C, oyOBJECT_CONFIG_S, and oyOptions_s::oyOptions_SetFromText().
Referenced by oyConfig_SaveToDB(), oyConfigs_s::oyConfigs_FromDB(), oyDeviceFromJSON(), oyDeviceSetProfile(), and oyDevicesFromTaxiDB().
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().
[in] | config | the configuration |
References oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_New(), and oyOptions_s::oyOptions_Release().
Referenced by oyDeviceSetProfile().
int oyConfig_Compare | ( | oyConfig_s * | module_device, |
oyConfig_s * | db_pattern, | ||
int32_t * | rank_value | ||
) |
Check for matching to a given pattern.
Function oyConfig_Compare
[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 |
[out] | rank_value | the number of matches between config and pattern, -1 means invalid |
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?
References oy_debug, oyConfig_DomainRank(), oyFilterRegistrationToText(), oyOBJECT_CONFIG_S, oyOption_s::oyOption_GetRegistration(), oyOption_s::oyOption_GetValueText(), oyOption_s::oyOption_Release(), oyOptions_s::oyOptions_Count(), and oyOptions_s::oyOptions_Get().
Referenced by oyConfig_GetFromDB(), oyDevicesFromTaxiDB(), and oyProfiles_s::oyProfiles_DeviceRank().
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.
[in] | config | Config struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_CONFIG_S.
Referenced by oyConfig_GetFromDB(), and oyDeviceBackendCall().
OYAPI int OYEXPORT oyConfig_Count | ( | oyConfig_s * | config | ) |
Number of all options.
Function oyConfig_Count
[in] | config | the configuration |
References oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_AppendOpts(), oyOptions_s::oyOptions_Count(), oyOptions_s::oyOptions_New(), and oyOptions_s::oyOptions_Release().
Referenced by oyDeviceSelectSimiliar(), oyDeviceToJSON(), and oyProfile_s::oyProfile_AddDevice().
OYAPI int OYEXPORT oyConfig_DomainRank | ( | oyConfig_s * | config | ) |
Check for being recognised by a given module.
Function oyConfig_DomainRank
[in] | config | the configuration to be checked wether or not the module can make sense of it and support the data |
Ask the module if it wants later on to accept this configuration.
References oyCMMapiFilters_s::oyCMMapiFilters_Get(), oyCMMapiFilters_s::oyCMMapiFilters_Release(), oyOBJECT_CMM_API8_S, oyOBJECT_CONFIG_S, and oyCMMapiFilter_s::release.
Referenced by oyConfig_Compare().
OYAPI int OYEXPORT oyConfig_EraseFromDB | ( | oyConfig_s * | config | ) |
Remove a oyConfig_s from DB.
Function oyConfig_EraseFromDB
[in] | config | the configuration |
References OY_SLASH_C, oyOBJECT_CONFIG_S, oyOption_s::oyOption_GetRegistration(), oyOption_s::oyOption_Release(), and oyOptions_s::oyOptions_Get().
Referenced by oyDeviceSetProfile().
OYAPI oyOption_s *OYEXPORT oyConfig_Find | ( | oyConfig_s * | config, |
const char * | key | ||
) |
Search in data sets for a key.
Function oyConfig_Find
[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 |
References oyOBJECT_CONFIG_S, and oyOptions_s::oyOptions_Find().
Referenced by oyDeviceAskProfile2(), and oyDeviceProfileFromDB().
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
[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 |
References oyOBJECT_CONFIG_S, and oyOptions_s::oyOptions_FindString().
Referenced by oyConfigs_s::oyConfigs_FromDeviceClass(), oyConfigs_s::oyConfigs_SelectSimilars(), oyDeviceProfileFromDB(), oyDeviceSelectSimiliar(), oyDeviceSetProfile(), oyDeviceSetup(), oyDevicesFromTaxiDB(), oyDeviceToJSON(), oyDeviceUnset(), oyProfile_s::oyProfile_AddDevice(), and oyProfiles_s::oyProfiles_DeviceRank().
OYAPI oyConfig_s *OYEXPORT oyConfig_FromRegistration | ( | const char * | registration, |
oyObject_s | object | ||
) |
New config with registration.
Function oyConfig_FromRegistration
registration | no or full qualified registration |
object | the optional object |
References oyConfig_New().
Referenced by oyConfigs_s::oyConfigs_FromDB(), oyDeviceFromJSON(), and oyProfiles_s::oyProfiles_DeviceRank().
OYAPI oyOption_s *OYEXPORT oyConfig_Get | ( | oyConfig_s * | config, |
int | pos | ||
) |
Get one option.
Function oyConfig_Get
[in] | config | the configuration |
[in] | pos | option position |
References oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_AppendOpts(), oyOptions_s::oyOptions_Get(), oyOptions_s::oyOptions_New(), and oyOptions_s::oyOptions_Release().
Referenced by oyDeviceSelectSimiliar(), oyDeviceToJSON(), and oyProfile_s::oyProfile_AddDevice().
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
[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 |
References oyConfig_GetFromDB(), oyConfigs_s::oyConfigs_Release(), oyDevicesFromTaxiDB(), oyOBJECT_CONFIG_S, and oyOptions_s::oyOptions_Release().
OYAPI int OYEXPORT oyConfig_GetDB | ( | oyConfig_s * | device, |
int32_t * | rank_value | ||
) |
search a configuration in the DB for a configuration from module
Function oyConfig_GetDB
[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 |
References oyConfig_GetFromDB(), oyConfigs_s::oyConfigs_FromDB(), oyConfigs_s::oyConfigs_Release(), and oyOBJECT_CONFIG_S.
Referenced by oyDeviceProfileFromDB(), and oyDeviceSetProfile().
OYAPI int OYEXPORT oyConfig_GetFromDB | ( | oyConfig_s * | device, |
oyConfigs_s * | configs, | ||
int32_t * | rank_value | ||
) |
search a configuration in the DB for a configuration from module
Function oyConfig_GetFromDB
[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 |
References oyConfig_Compare(), oyConfig_Copy(), oyConfig_Release(), oyConfigs_s::oyConfigs_Count(), oyConfigs_s::oyConfigs_Get(), oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_Copy(), and oyOptions_s::oyOptions_Release().
Referenced by oyConfig_GetBestMatchFromTaxiDB(), and oyConfig_GetDB().
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*"
[in] | config | the configuration |
[in] | source | use of the options,
|
References oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_Clear(), and oyOptions_s::oyOptions_New().
Referenced by oyDeviceToJSON().
OYAPI const oyRankMap *OYEXPORT oyConfig_GetRankMap | ( | oyConfig_s * | config | ) |
Get the ranking table.
Function oyConfig_GetRankMap
[in] | config | the configuration |
References oyOBJECT_CONFIG_S.
OYAPI const char *OYEXPORT oyConfig_GetRegistration | ( | oyConfig_s * | config | ) |
Get the registration string registration.
Function oyConfig_GetRegistration
[in] | config | the config |
References oyOBJECT_CONFIG_S.
OYAPI int OYEXPORT oyConfig_Has | ( | oyConfig_s * | config, |
const char * | key | ||
) |
Search in data sets for a key.
Function oyConfig_Has
[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 |
References oyOBJECT_CONFIG_S, oyOption_s::oyOption_Release(), and oyOptions_s::oyOptions_Find().
Referenced by oyDeviceSetup().
OYAPI oyConfig_s *OYEXPORT oyConfig_New | ( | oyObject_s | object | ) |
allocate a new Config object
Function oyConfig_New
References oyOBJECT_OBJECT_S.
Referenced by oyConfig_FromRegistration().
OYAPI int OYEXPORT oyConfig_Release | ( | oyConfig_s ** | config | ) |
release and possibly deallocate a oyConfig_s object
Function oyConfig_Release
[in,out] | config | Config struct object |
References oyOBJECT_CONFIG_S.
Referenced by oyConfig_GetFromDB(), oyConfigs_s::oyConfigs_FromDeviceClass(), oyConfigs_s::oyConfigs_FromDomain(), oyConfigs_s::oyConfigs_Modify(), oyConfigs_s::oyConfigs_SelectSimilars(), oyDeviceGet(), oyDeviceGetInfo(), oyDeviceSelectSimiliar(), oyDeviceSetProfile(), and oyDevicesFromTaxiDB().
OYAPI int OYEXPORT oyConfig_SaveToDB | ( | oyConfig_s * | config | ) |
Store a oyConfig_s in DB.
Function oyConfig_SaveToDB
The new key set name is stored inside the key "key_set_name".
[in] | config | the configuration |
References oyConfig_AddDBData(), oyOBJECT_CONFIG_S, oyOptions_s::oyOptions_AppendOpts(), oyOptions_s::oyOptions_New(), oyOptions_s::oyOptions_Release(), and oyOptions_s::oyOptions_SaveToDB().
Referenced by oyDeviceSetProfile().
OYAPI int OYEXPORT oyConfig_Set | ( | oyConfig_s * | config, |
const char * | registration_domain, | ||
oyOptions_s * | options, | ||
oyBlob_s * | data | ||
) |
Unimplemented!
Function oyConfig_Set
OYAPI int OYEXPORT oyConfig_SetRankMap | ( | oyConfig_s * | config, |
const oyRankMap * | rank_map | ||
) |
Set the ranking table.
Function oyConfig_SetRankMap
[in,out] | config | the configuration |
[in] | rank_map | the new rank map |
References oyOBJECT_CONFIG_S, oyRankMapCopy(), and oyRankMapRelease().
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.
[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 |
References oyRankMapRelease().
OYAPI oyRankMap *OYEXPORT oyRankMapCopy | ( | const oyRankMap * | rank_map, |
oyAlloc_f | allocateFunc | ||
) |
Copy a rank map.
Function oyRankMapCopy
Referenced by oyConfig_SetRankMap(), and oyConfigs_s::oyConfigs_FromDB().
OYAPI int OYEXPORT oyRankMapFromJSON | ( | const char * | json_text, |
oyOptions_s * | options, | ||
oyRankMap ** | rank_map, | ||
oyAlloc_f | allocateFunc | ||
) |
Create a Rank Map.
Function oyRankMapFromJSON
[in] | json_text | the rank map definition |
[in] | options | optional
|
[out] | rank_map | the result |
[in] | allocateFunc | the memory allocate function |
References oyOptions_s::oyOptions_FindInt().
OYAPI void OYEXPORT oyRankMapRelease | ( | oyRankMap ** | rank_map, |
oyDeAlloc_f | deAllocateFunc | ||
) |
Release a Rank Map.
Function oyRankMapRelease
[in,out] | rank_map | the rank map |
[in] | deAllocateFunc | the memory release function |
Referenced by oyConfig_SetRankMap(), and oyRankMapAppend().
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
[in] | rank_map | the rank map |
[in] | options | optional
|
[out] | json_text | the result |
[in] | allocateFunc | the memory allocate function |
References oyOptions_s::oyOptions_FindString().
oyStruct_Copy_f oyConfig_s::copy |
Copy function.
oyObject_s oyConfig_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
Referenced by oyConfigs_s::oyConfigs_FromDeviceClass().
oyStruct_Release_f oyConfig_s::release |
Release function.
const oyOBJECT_e oyConfig_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyConfigs_s::oyConfigs_MoveIn().