![]() |
Oyranos Color Management System API - Version 0.9.6 |
Basic objects to make all higher level object types happy. More...
![]() |
Data Structures | |
struct | oyHash_s |
A cache entry. More... | |
struct | oyObserver_s |
Oyranos object observers. More... | |
struct | oyPointer_s |
custom pointer More... | |
struct | oyStruct_s |
Oyranos base structure. More... | |
struct | oyStructList_s |
a pointer list More... |
Typedefs | |
typedef struct oyObject_s_ * | oyObject_s |
Functions | |
oyObject_s | oyObject_New (void) |
object management | |
oyObject_s | oyObject_NewWithAllocators (oyAlloc_f allocateFunc, oyDeAlloc_f deallocateFunc) |
object management | |
oyObject_s | oyObject_NewFrom (oyObject_s object) |
object management | |
oyObject_s | oyObject_Copy (oyObject_s object) |
object management | |
int | oyObject_Release (oyObject_s *obj) |
release an Oyranos object | |
oyObject_s | oyObject_SetParent (oyObject_s o, oyOBJECT_e type, oyPointer parent) |
custom object memory managersNormally a sub object should not know about its parent structure, but follow a hierarchical design. We break this here to allow the observation of all objects including the parents structures as a feature in oyObject_s. Then we just need a list of all oyObject_s objects and have an overview. This facility is intented to work even without debugging tools. | |
int | oyObject_SetName (oyObject_s object, const char *text, oyNAME_e type) |
object naming | |
int | oyObject_SetNames (oyObject_s object, const char *nick, const char *name, const char *description) |
object naming | |
int | oyObject_CopyNames (oyObject_s dest, oyObject_s src) |
object naming | |
const oyChar * | oyObject_GetName (const oyObject_s obj, oyNAME_e type) |
object get names | |
int | oyObject_Lock (oyObject_s object, const char *marker, int line) |
Lock a object. | |
int | oyObject_UnLock (oyObject_s object, const char *marker, int line) |
Unlock a object. | |
int | oyObject_UnSetLocking (oyObject_s object, const char *marker, int line) |
remove a object's lock pointer | |
int | oyObject_GetRefCount (oyObject_s obj) |
get the identification number of a object | |
int | oyObject_UnRef (oyObject_s obj) |
decrease the ref counter and return the above zero ref value | |
OYAPI oyAlloc_f OYEXPORT | oyObject_GetAlloc (oyObject_s object) |
get objects allocator | |
OYAPI oyDeAlloc_f OYEXPORT | oyObject_GetDeAlloc (oyObject_s object) |
get objects deallocator | |
int | oyObject_GetId (oyObject_s object) |
get the identification number of a object | |
OYAPI const char *OYEXPORT | oyObject_Show (oyObject_s object) |
Print object informations. | |
void | oyObjectTreePrint (int flags) |
Print the current object trees to stderr.Probably the most simple and still useful function from the Object tree debug APIs. It prints to stderr with OY_DEBUG_OBJECTS set. |
Basic objects to make all higher level object types happy.
typedef struct oyObject_s_* oyObject_s |
Declare oyObject_s Globally
enum oyNAME_e |
Information levelMessages consist of text, which contains information depending on the purpose. The information provider obtains with this enum a brief request, what to put into a information request.
enum oyOBJECT_e |
Oyranos structure type.
oyOBJECT_OBJECT_S |
oyObject_s |
oyOBJECT_MONITOR_S |
oyMonitor_s |
oyOBJECT_NAMED_COLOR_S | |
oyOBJECT_NAMED_COLORS_S | |
oyOBJECT_PROFILE_S | |
oyOBJECT_PROFILE_TAG_S | |
oyOBJECT_PROFILES_S | |
oyOBJECT_OPTION_S | |
oyOBJECT_OPTIONS_S | |
oyOBJECT_RECTANGLE_S | |
oyOBJECT_IMAGE_S | |
oyOBJECT_ARRAY2D_S | |
oyOBJECT_CONNECTOR_S | |
oyOBJECT_CONNECTOR_IMAGING_S | |
oyOBJECT_CONNECTOR_MAX_S |
not defined |
oyOBJECT_FILTER_PLUG_S | |
oyOBJECT_FILTER_PLUGS_S | |
oyOBJECT_FILTER_SOCKET_S | |
oyOBJECT_FILTER_CORE_S | |
oyOBJECT_FILTER_CORES_S |
oyFilterCores_s |
oyOBJECT_FILTER_NODE_S | |
oyOBJECT_FILTER_NODES_S | |
oyOBJECT_FILTER_GRAPH_S | |
oyOBJECT_PIXEL_ACCESS_S | |
oyOBJECT_CONVERSION_S | |
oyOBJECT_CMM_HANDLE_S |
oyCMMhandle_s |
oyOBJECT_POINTER_S | |
oyOBJECT_CMM_INFO_S |
oyCMMinfo_s |
oyOBJECT_CMM_API_S | |
oyOBJECT_CMM_APIS_S | |
oyOBJECT_CMM_API_FILTER_S | |
oyOBJECT_CMM_API1_S |
oyCMMapi1_s |
oyOBJECT_CMM_API2_S |
oyCMMapi2_s |
oyOBJECT_CMM_API3_S |
oyCMMapi3_s |
oyOBJECT_CMM_API4_S | |
oyOBJECT_CMM_API5_S |
oyCMMapi5_s |
oyOBJECT_CMM_API6_S |
oyCMMapi6_s |
oyOBJECT_CMM_API7_S | |
oyOBJECT_CMM_DATA_TYPES_S |
oyCMMDataTypes_s |
oyOBJECT_CMM_API8_S |
oyCMMapi8_s |
oyOBJECT_CMM_API9_S |
oyCMMapi9_s |
oyOBJECT_CMM_API10_S |
oyCMMapi10_s |
oyOBJECT_CMM_UI_S | |
oyOBJECT_CMM_OBJECT_TYPE_S |
oyCMMobjectType_s |
oyOBJECT_CMM_API_FILTERS_S | |
oyOBJECT_CMM_API_MAX |
not defined |
oyOBJECT_ICON_S | |
oyOBJECT_MODULE_S |
oyModule_s |
oyOBJECT_EXTERNFUNC_S |
oyExternFunc_s |
oyOBJECT_NAME_S |
oyName_s |
oyOBJECT_COMP_S_ |
oyComp_s_ |
oyOBJECT_FILE_LIST_S_ |
oyFileList_s_ |
oyOBJECT_HASH_S | |
oyOBJECT_STRUCT_LIST_S | |
oyOBJECT_BLOB_S | |
oyOBJECT_CONFIG_S | |
oyOBJECT_CONFIGS_S | |
oyOBJECT_UI_HANDLER_S |
oyUiHandler_s |
oyOBJECT_FORMS_ARGS_S |
oyFormsArgs_s |
oyOBJECT_CALLBACK_S |
oyCallback_s |
oyOBJECT_OBSERVER_S | |
oyOBJECT_CONF_DOMAIN_S | |
oyOBJECT_INFO_STATIC_S | |
oyOBJECT_LIST_S |
oyList_s |
oyOBJECT_LIS_S |
oyLis_s dummy |
oyOBJECT_JOB_S |
oyJob_s dummy |
oyOBJECT_DB_API_S |
oyDbAPI_s |
oyOBJECT_MONITOR_HOOKS_S |
enum oySIGNAL_e |
observer signalsThe signal types are similiar to the graph event enum oyCONNECTOR_EVENT_e.
oyObject_s oyObject_Copy | ( | oyObject_s | object | ) |
object management
[in] | object | the object |
Referenced by oyObject_NewWithAllocators(), and oyProfile_s::oyProfile_SetChannelNames().
int oyObject_CopyNames | ( | oyObject_s | dest, |
oyObject_s | src | ||
) |
object naming
[in] | dest | the object to modify |
[in] | src | the object to take names from |
References oyNAME_DESCRIPTION, oyNAME_NAME, oyNAME_NICK, oyObject_GetName(), oyOBJECT_OBJECT_S, and oyObject_SetNames().
OYAPI oyAlloc_f OYEXPORT oyObject_GetAlloc | ( | oyObject_s | object | ) |
get objects allocator
Function oyObject_GetAlloc
object | the object |
Referenced by oyCMMapi7_s::oyCMMapi7_Create(), oyNamedColors_s::oyNamedColors_GetColorName(), oyNamedColors_s::oyNamedColors_SetPrefix(), and oyNamedColors_s::oyNamedColors_SetSuffix().
OYAPI oyDeAlloc_f OYEXPORT oyObject_GetDeAlloc | ( | oyObject_s | object | ) |
get objects deallocator
Function oyObject_GetDeAlloc
object | the object |
Referenced by oyCMMapi7_s::oyCMMapi7_Create(), oyNamedColors_s::oyNamedColors_GetColorName(), oyNamedColors_s::oyNamedColors_SetPrefix(), and oyNamedColors_s::oyNamedColors_SetSuffix().
int oyObject_GetId | ( | oyObject_s | object | ) |
get the identification number of a object
Function oyObject_GetId
References oy_debug, OY_DEBUG_OBJECTS, oyObject_Show(), oyStruct_s::oyStructTypeToText(), and oyStruct_s::type_.
Referenced by oyConversion_s::oyConversion_RunPixels(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_Connect(), oyFilterNode_s::oyFilterNode_Create(), oyFilterNode_s::oyFilterNode_GetId(), oyFilterPlug_s::oyFilterPlug_Callback(), oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), oyFilterSocket_s::oyFilterSocket_Callback(), oyFilterSocket_s::oyFilterSocket_SignalToGraph(), oyImage_s::oyImage_CreateForDisplay(), oyObject_UnRef(), oyOptions_s::oyOptions_ForFilter_(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_ObserverCopyModel(), oyObserver_s::oyStruct_ObserverCopyObserver(), and oyObserver_s::oyStruct_ObserverSignal().
const oyChar* oyObject_GetName | ( | const oyObject_s | obj, |
oyNAME_e | type | ||
) |
object get names
Function oyObject_GetName
[in] | obj | the object |
[in] | type | name type |
References oyNAME_DESCRIPTION, oyOBJECT_OBJECT_S, and oyOptions_s::oyOptions_FindString().
Referenced by oyContextCollectData_(), oyFilterCore_s::oyFilterCore_GetText(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_GetText(), oyImage_s::oyImage_FillArray(), oyNamedColor_s::oyNamedColor_GetName(), oyNamedColors_s::oyNamedColors_GetColorName(), oyObject_CopyNames(), oyOption_s::oyOption_GetText(), oyOptions_s::oyOptions_GetText(), oyPointer_s::oyPointer_LookUpFromObject(), oyProfile_s::oyProfile_GetChannelName(), oyProfile_s::oyProfile_GetID(), oyProfile_s::oyProfile_GetText(), oyStruct_s::oyStruct_GetText(), oyStruct_s::oyStruct_GetTextFromModule(), oyStructList_s::oyStructList_GetID(), and oyStructList_s::oyStructList_GetText().
int oyObject_GetRefCount | ( | oyObject_s | obj | ) |
get the identification number of a object
Function oyObject_GetRefCount
References oyOBJECT_OBJECT_S.
int oyObject_Lock | ( | oyObject_s | object, |
const char * | marker, | ||
int | line | ||
) |
Lock a object.
Function oyObject_Lock
[in] | object | the object |
[in] | marker | debug hints, e.g. FILE |
[in] | line | source line number, e.g. LINE |
References oyOBJECT_OBJECT_S.
Referenced by oyObject_UnRef(), oyProfile_s::oyProfile_GetMem(), oyProfile_s::oyProfile_GetTagById(), oyProfile_s::oyProfile_GetTagByPos(), oyProfile_s::oyProfile_GetTagCount(), oyProfile_s::oyProfile_TagMoveIn(), oyProfile_s::oyProfile_TagReleaseAt(), oyStructList_s::oyStructList_GetRef(), oyStructList_s::oyStructList_MoveIn(), oyStructList_s::oyStructList_ReleaseAt(), and oyStructList_s::oyStructList_Sort().
oyObject_s oyObject_New | ( | void | ) |
object management
References oyObject_NewWithAllocators().
Referenced by oyFilterNode_s::oyFilterNode_ShowConnector(), and oyObject_NewFrom().
oyObject_s oyObject_NewFrom | ( | oyObject_s | object | ) |
object management
[in] | object | the object |
References oyObject_New(), oyObject_NewWithAllocators(), oyOBJECT_OBJECT_S, and oyObject_SetNames().
Referenced by oyNamedColor_s::oyNamedColor_CreateWithName(), and oyProfile_s::oyProfile_GetChannelNames().
oyObject_s oyObject_NewWithAllocators | ( | oyAlloc_f | allocateFunc, |
oyDeAlloc_f | deallocateFunc | ||
) |
object management
References oyObject_Copy(), oyOBJECT_OBJECT_S, oyObject_Release(), and oyVersion().
Referenced by oyObject_New(), and oyObject_NewFrom().
int oyObject_Release | ( | oyObject_s * | obj | ) |
release an Oyranos object
References oyOBJECT_OBJECT_S, and oyObject_UnRef().
Referenced by oyFilterNode_s::oyFilterNode_ShowConnector(), oyNamedColor_s::oyNamedColor_CreateWithName(), and oyObject_NewWithAllocators().
int oyObject_SetName | ( | oyObject_s | object, |
const char * | text, | ||
oyNAME_e | type | ||
) |
object naming
[in] | object | the object |
[in] | text | the name to set |
[in] | type | the kind of name |
References OY_CREATE_NEW, oyNAME_DESCRIPTION, oyNAME_NAME, oyOBJECT_OBJECT_S, and oyOptions_s::oyOptions_SetFromText().
Referenced by oyConfigs_s::oyConfigs_FromDeviceClass(), oyContextCollectData_(), oyFilterCore_s::oyFilterCore_GetText(), oyFilterNode_s::oyFilterNode_GetText(), oyNamedColor_s::oyNamedColor_GetName(), oyNamedColors_s::oyNamedColors_GetColorName(), oyObject_SetNames(), oyOption_s::oyOption_GetText(), oyOptions_s::oyOptions_GetText(), oyProfile_s::oyProfile_GetID(), oyProfile_s::oyProfile_GetText(), and oyStructList_s::oyStructList_GetText().
int oyObject_SetNames | ( | oyObject_s | object, |
const char * | nick, | ||
const char * | name, | ||
const char * | description | ||
) |
object naming
[in] | object | the object |
[in] | nick | short name, about 1-4 letters |
[in] | name | the name should fit into usual labels |
[in] | description | the description |
References oyNAME_DESCRIPTION, oyNAME_NAME, oyNAME_NICK, oyOBJECT_OBJECT_S, and oyObject_SetName().
Referenced by oyNamedColor_s::oyNamedColor_CreateWithName(), oyObject_CopyNames(), oyObject_NewFrom(), oyProfile_s::oyProfile_GetChannelNames(), oyProfile_s::oyProfile_GetMem(), oyProfiles_s::oyProfiles_Create(), and oyStructList_s::oyStructList_Create().
oyObject_s oyObject_SetParent | ( | oyObject_s | o, |
oyOBJECT_e | type, | ||
oyPointer | parent | ||
) |
custom object memory managersNormally a sub object should not know about its parent structure, but follow a hierarchical design. We break this here to allow the observation of all objects including the parents structures as a feature in oyObject_s. Then we just need a list of all oyObject_s objects and have an overview. This facility is intented to work even without debugging tools.
Each inheritent initialiser should call this function separately during normal object allocation and class initialisation.
[in] | o | the object to modify |
[in] | type | the parents struct type |
[in] | parent | a pointer to the parent struct |
OYAPI const char* OYEXPORT oyObject_Show | ( | oyObject_s | object | ) |
Print object informations.
Function oyObject_Show
References oyNAME_NAME, oyOBJECT_ARRAY2D_S, oyOBJECT_RECTANGLE_S, oyStruct_s::oyStruct_GetInfo(), and oyStruct_s::type_.
Referenced by oyObject_GetId().
int oyObject_UnLock | ( | oyObject_s | object, |
const char * | marker, | ||
int | line | ||
) |
Unlock a object.
Function oyObject_UnLock
[in] | object | the object |
[in] | marker | debug hints, e.g. FILE |
[in] | line | source line number, e.g. LINE |
References oyOBJECT_OBJECT_S.
Referenced by oyObject_UnRef(), oyProfile_s::oyProfile_GetMem(), oyProfile_s::oyProfile_GetTagById(), oyProfile_s::oyProfile_GetTagByPos(), oyProfile_s::oyProfile_GetTagCount(), oyProfile_s::oyProfile_TagMoveIn(), oyProfile_s::oyProfile_TagReleaseAt(), oyStructList_s::oyStructList_GetRef(), oyStructList_s::oyStructList_MoveIn(), oyStructList_s::oyStructList_ReleaseAt(), and oyStructList_s::oyStructList_Sort().
int oyObject_UnRef | ( | oyObject_s | obj | ) |
decrease the ref counter and return the above zero ref value
Function oyObject_UnRef
References oy_debug, oyNAME_NAME, oyObject_GetId(), oyObject_Lock(), oyOBJECT_NAMED_COLORS_S, oyOBJECT_OBJECT_S, oyObject_UnLock(), oyStruct_s::oyStruct_GetInfo(), and oyStruct_s::oyStructTypeToText().
Referenced by oyObject_Release().
int oyObject_UnSetLocking | ( | oyObject_s | object, |
const char * | marker, | ||
int | line | ||
) |
remove a object's lock pointer
Function oyObject_UnSetLocking
[in] | object | the object |
[in] | marker | debug hints, e.g. FILE |
[in] | line | source line number, e.g. LINE |
References oyOBJECT_OBJECT_S.
void oyObjectTreePrint | ( | int | flags | ) |
Print the current object trees to stderr.Probably the most simple and still useful function from the Object tree debug APIs. It prints to stderr with OY_DEBUG_OBJECTS set.
flags | - 0x01 show a graph
|