1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
//! @file IConfigurationManager.h
#ifndef IConfigurationManager_h__
#define IConfigurationManager_h__ 1
//
// =================================================================================================
// Copyright Adobe
// Copyright 2014 Adobe
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================
//
#include "XMPCommon/Interfaces/BaseInterfaces/ISharedObject.h"
#include "XMPCommon/Interfaces/BaseInterfaces/IVersionable.h"
#include "XMPCommon/XMPCommonFwdDeclarations.h"
namespace AdobeXMPCommon {
//!
//! @class IConfigurationManager_v1
//! \brief Version1 of the interface that represents configuration settings controllable by the client.
//! \details Provides functions through which client can plug in its own memory allocators, error notifiers.
//! \attention Not Thread Safe as this functionality is generally used at the initialization phase.
//!
class XMP_PUBLIC IConfigurationManager_v1
: public virtual ISharedObject
, public virtual IVersionable
{
public:
//!
//! @brief Allows the client to plug in its own memory allocation procedures which will be used to allocate/deallocate memory from the heap.
//!
//! \param[in] memoryAllocator A pointer to an object of type AdobeXMPCommon::IMemoryAllocator.
//! NULL pointer will switch to default allocator built in the library.
//! \return A value of bool type; true means successful and false otherwise.
//!
virtual bool APICALL RegisterMemoryAllocator( pIMemoryAllocator memoryAllocator ) = 0;
//!
//! @brief Allows the client to plug in its own error notification procedures which will be used to
//! inform client about various warnings and errors.
//! \param[in] clientErrorNotifier A pointer to an object of type AdobeXMPCommon::IErrorNotifier. NULL
//! pointer means client no longer wants to be notified of any warnings or errors.
//! \return a value of bool type; true means successful and false otherwise.
//!
virtual bool APICALL RegisterErrorNotifier( pIErrorNotifier_base clientErrorNotifier ) = 0;
//!
//! @brief Allows the client to disable the support for multi threading inside the library.
//! By default library supports multi-threading.
//! \return A value of bool type; true means successful and false otherwise.
//!
virtual bool APICALL DisableMultiThreading() = 0;
//!
//! @brief Returns whether library supports multi threading or not
//! \return A value of bool type; true means it supports multi threading and false otherwise.
//!
virtual bool APICALL IsMultiThreaded() const = 0;
//!
//! \cond XMP_INTERNAL_DOCUMENTATION
//! @{
//! @brief Returns the actual raw pointer from the shared pointer, which can be a shared pointer of a proxy class.
//! \return Either a const or non const pointer to IConfigurationManager interface.
//!
virtual pIConfigurationManager APICALL GetActualIConfigurationManager() __NOTHROW__ = 0;
XMP_PRIVATE pcIConfigurationManager GetActualIConfigurationManager() const __NOTHROW__ {
return const_cast< IConfigurationManager_v1 * >( this )->GetActualIConfigurationManager();
}
//!
//! @}
//!
//! @{
//! @brief Convert raw pointer to shared pointer.
//! @detail The raw pointer is of version 1 interface where as the returned shared pointer depends on the version client is interested in.
//!
//! \return Shared pointer to const or non constant IConfigurationManager interface.
//!
XMP_PRIVATE static spIConfigurationManager MakeShared( pIConfigurationManager_base ptr );
XMP_PRIVATE static spcIConfigurationManager MakeShared( pcIConfigurationManager_base ptr ) {
return MakeShared( const_cast< pIConfigurationManager_base >( ptr ) );
}
//!
//! @}
//!
//! @brief Return the unique ID assigned to the interface.
//! \return 64 bit unsigned integer representing the unique ID assigned to the interface.
//!
XMP_PRIVATE static uint64 GetInterfaceID() { return kIConfigurationManagerID; }
//!
//! @brief Returns the version of the interface.
//! \return 32 bit unsigned integer representing the version of the interface.
//!
XMP_PRIVATE static uint32 GetInterfaceVersion() { return 1; }
//! \endcond
virtual ~IConfigurationManager_v1() __NOTHROW__ {}
protected:
//! \cond XMP_INTERNAL_DOCUMENTATION
virtual uint32 APICALL registerMemoryAllocator( pIMemoryAllocator_base memoryAllocator, pcIError_base & error ) __NOTHROW__ = 0;
virtual uint32 APICALL registerErrorNotifier( pIErrorNotifier_base clientErrorNotifier, pcIError_base & error ) __NOTHROW__ = 0;
virtual uint32 APICALL disableMultiThreading( pcIError_base & error ) __NOTHROW__ = 0;
virtual uint32 APICALL isMultiThreaded( pcIError_base & error ) const __NOTHROW__ = 0;
//! \endcond
#ifdef FRIEND_CLASS_DECLARATION
FRIEND_CLASS_DECLARATION();
#endif
REQ_FRIEND_CLASS_DECLARATION();
//! \endcond
};
}
#if !BUILDING_XMPCOMMON_LIB && !SOURCE_COMPILING_XMP_ALL
namespace AdobeXMPCommon {
class IConfigurationManagerProxy
: public virtual IConfigurationManager
{
private:
pIConfigurationManager mRawPtr;
public:
IConfigurationManagerProxy( pIConfigurationManager ptr )
: mRawPtr( ptr )
{
mRawPtr->Acquire();
}
~IConfigurationManagerProxy() __NOTHROW__ { mRawPtr->Release(); }
pIConfigurationManager APICALL GetActualIConfigurationManager() __NOTHROW__ { return mRawPtr; }
AdobeXMPCommon_Int::pISharedObject_I APICALL GetISharedObject_I() __NOTHROW__ { return mRawPtr->GetISharedObject_I(); }
void APICALL Acquire() const __NOTHROW__;
void APICALL Release() const __NOTHROW__;
pvoid APICALL GetInterfacePointer( uint64 interfaceID, uint32 interfaceVersion );
virtual bool APICALL RegisterMemoryAllocator( pIMemoryAllocator memoryAllocator );
virtual bool APICALL RegisterErrorNotifier( pIErrorNotifier_base clientErrorNotifier );
virtual bool APICALL DisableMultiThreading();
virtual bool APICALL IsMultiThreaded() const;
protected:
virtual uint32 APICALL registerMemoryAllocator( pIMemoryAllocator_base memoryAllocator, pcIError_base & error ) __NOTHROW__;
virtual uint32 APICALL registerErrorNotifier( pIErrorNotifier_base clientErrorNotifier, pcIError_base & error ) __NOTHROW__;
virtual uint32 APICALL disableMultiThreading( pcIError_base & error ) __NOTHROW__;
virtual uint32 APICALL isMultiThreaded( pcIError_base & error ) const __NOTHROW__;
pvoid APICALL getInterfacePointer( uint64 interfaceID, uint32 interfaceVersion, pcIError_base & error ) __NOTHROW__;
};
}
#endif // BUILDING_XMPCOMMON_LIB && !SOURCE_COMPILING_XMP_LIB
#endif // IConfigurationManager_h__
|
