| XMP Toolkit SDK 6.0.0

WXMPUtils.hpp
Go to the documentation of this file.
1 #if ! __WXMPUtils_hpp__
2 #define __WXMPUtils_hpp__ 1
3
4 // =================================================================================================
5 // Copyright 2002 Adobe
6 // All Rights Reserved.
7 //
8 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
9 // of the Adobe license agreement accompanying it. If you have received this file from a source other
10 // than Adobe, then your use, modification, or distribution of it requires the prior written permission
11 // of Adobe.
12 // =================================================================================================
13
14 #include "client-glue/WXMP_Common.hpp"
15 #if __cplusplus
16 extern "C" {
17 #endif
18
19 // =================================================================================================
20
21 #define zXMPUtils_ComposeArrayItemPath_1(schemaNS,arrayName,itemIndex,itemPath,SetClientString) \
22 WXMPUtils_ComposeArrayItemPath_1 ( schemaNS, arrayName, itemIndex, itemPath, SetClientString, &wResult );
23
24 #define zXMPUtils_ComposeStructFieldPath_1(schemaNS,structName,fieldNS,fieldName,fieldPath,SetClientString) \
25 WXMPUtils_ComposeStructFieldPath_1 ( schemaNS, structName, fieldNS, fieldName, fieldPath, SetClientString, &wResult );
26
27 #define zXMPUtils_ComposeQualifierPath_1(schemaNS,propName,qualNS,qualName,qualPath,SetClientString) \
28 WXMPUtils_ComposeQualifierPath_1 ( schemaNS, propName, qualNS, qualName, qualPath, SetClientString, &wResult );
29
30 #define zXMPUtils_ComposeLangSelector_1(schemaNS,arrayName,langName,selPath,SetClientString) \
31 WXMPUtils_ComposeLangSelector_1 ( schemaNS, arrayName, langName, selPath, SetClientString, &wResult );
32
33 #define zXMPUtils_ComposeFieldSelector_1(schemaNS,arrayName,fieldNS,fieldName,fieldValue,selPath,SetClientString) \
34 WXMPUtils_ComposeFieldSelector_1 ( schemaNS, arrayName, fieldNS, fieldName, fieldValue, selPath, SetClientString, &wResult );
35
36 #define zXMPUtils_ConvertFromBool_1(binValue,strValue,SetClientString) \
37 WXMPUtils_ConvertFromBool_1 ( binValue, strValue, SetClientString, &wResult );
38
39 #define zXMPUtils_ConvertFromInt_1(binValue,format,strValue,SetClientString) \
40 WXMPUtils_ConvertFromInt_1 ( binValue, format, strValue, SetClientString, &wResult );
41
42 #define zXMPUtils_ConvertFromInt64_1(binValue,format,strValue,SetClientString) \
43 WXMPUtils_ConvertFromInt64_1 ( binValue, format, strValue, SetClientString, &wResult );
44
45 #define zXMPUtils_ConvertFromFloat_1(binValue,format,strValue,SetClientString) \
46 WXMPUtils_ConvertFromFloat_1 ( binValue, format, strValue, SetClientString, &wResult );
47
48 #define zXMPUtils_ConvertFromDate_1(binValue,strValue,SetClientString) \
49 WXMPUtils_ConvertFromDate_1 ( binValue, strValue, SetClientString, &wResult );
50
51 #define zXMPUtils_ConvertToBool_1(strValue) \
52 WXMPUtils_ConvertToBool_1 ( strValue, &wResult );
53
54 #define zXMPUtils_ConvertToInt_1(strValue) \
55 WXMPUtils_ConvertToInt_1 ( strValue, &wResult );
56
57 #define zXMPUtils_ConvertToInt64_1(strValue) \
58 WXMPUtils_ConvertToInt64_1 ( strValue, &wResult );
59
60 #define zXMPUtils_ConvertToFloat_1(strValue) \
61 WXMPUtils_ConvertToFloat_1 ( strValue, &wResult );
62
63 #define zXMPUtils_ConvertToDate_1(strValue,binValue) \
64 WXMPUtils_ConvertToDate_1 ( strValue, binValue, &wResult );
65
66 #define zXMPUtils_CurrentDateTime_1(time) \
67 WXMPUtils_CurrentDateTime_1 ( time, &wResult );
68
69 #define zXMPUtils_SetTimeZone_1(time) \
70 WXMPUtils_SetTimeZone_1 ( time, &wResult );
71
72 #define zXMPUtils_ConvertToUTCTime_1(time) \
73 WXMPUtils_ConvertToUTCTime_1 ( time, &wResult );
74
75 #define zXMPUtils_ConvertToLocalTime_1(time) \
76 WXMPUtils_ConvertToLocalTime_1 ( time, &wResult );
77
78 #define zXMPUtils_CompareDateTime_1(left,right) \
79 WXMPUtils_CompareDateTime_1 ( left, right, &wResult );
80
81 #define zXMPUtils_EncodeToBase64_1(rawStr,rawLen,encodedStr,SetClientString) \
82 WXMPUtils_EncodeToBase64_1 ( rawStr, rawLen, encodedStr, SetClientString, &wResult );
83
84 #define zXMPUtils_DecodeFromBase64_1(encodedStr,encodedLen,rawStr,SetClientString) \
85 WXMPUtils_DecodeFromBase64_1 ( encodedStr, encodedLen, rawStr, SetClientString, &wResult );
86
87 #define zXMPUtils_PackageForJPEG_1(xmpObj,stdStr,extStr,digestStr,SetClientString) \
88 WXMPUtils_PackageForJPEG_1 ( xmpObj, stdStr, extStr, digestStr, SetClientString, &wResult );
89
90 #define zXMPUtils_MergeFromJPEG_1(fullXMP,extendedXMP) \
91 WXMPUtils_MergeFromJPEG_1 ( fullXMP, extendedXMP, &wResult );
92
93 #define zXMPUtils_CatenateArrayItems_1(xmpObj,schemaNS,arrayName,separator,quotes,options,catedStr,SetClientString) \
94 WXMPUtils_CatenateArrayItems_1 ( xmpObj, schemaNS, arrayName, separator, quotes, options, catedStr, SetClientString, &wResult );
95
96 #define zXMPUtils_SeparateArrayItems_1(xmpObj,schemaNS,arrayName,options,catedStr) \
97 WXMPUtils_SeparateArrayItems_1 ( xmpObj, schemaNS, arrayName, options, catedStr, &wResult );
98
99 #define zXMPUtils_ApplyTemplate_1(workingXMP,templateXMP,actions) \
100 WXMPUtils_ApplyTemplate_1 ( workingXMP, templateXMP, actions, &wResult );
101
102 #define zXMPUtils_RemoveProperties_1(xmpObj,schemaNS,propName,options) \
103 WXMPUtils_RemoveProperties_1 ( xmpObj, schemaNS, propName, options, &wResult );
104
105 #define zXMPUtils_DuplicateSubtree_1(source,dest,sourceNS,sourceRoot,destNS,destRoot,options) \
106 WXMPUtils_DuplicateSubtree_1 ( source, dest, sourceNS, sourceRoot, destNS, destRoot, options, &wResult );
107
108 // =================================================================================================
109
110 extern void
111 XMP_PUBLIC WXMPUtils_ComposeArrayItemPath_1 ( XMP_StringPtr schemaNS,
112 XMP_StringPtr arrayName,
113 XMP_Index itemIndex,
114 void * itemPath,
115 SetClientStringProc SetClientString,
116 WXMP_Result * wResult );
117
118 extern void
119 XMP_PUBLIC WXMPUtils_ComposeStructFieldPath_1 ( XMP_StringPtr schemaNS,
120 XMP_StringPtr structName,
121 XMP_StringPtr fieldNS,
122 XMP_StringPtr fieldName,
123 void * fieldPath,
124 SetClientStringProc SetClientString,
125 WXMP_Result * wResult );
126
127 extern void
128 XMP_PUBLIC WXMPUtils_ComposeQualifierPath_1 ( XMP_StringPtr schemaNS,
129 XMP_StringPtr propName,
130 XMP_StringPtr qualNS,
131 XMP_StringPtr qualName,
132 void * qualPath,
133 SetClientStringProc SetClientString,
134 WXMP_Result * wResult );
135
136 extern void
137 XMP_PUBLIC WXMPUtils_ComposeLangSelector_1 ( XMP_StringPtr schemaNS,
138 XMP_StringPtr arrayName,
139 XMP_StringPtr langName,
140 void * selPath,
141 SetClientStringProc SetClientString,
142 WXMP_Result * wResult );
143
144 extern void
145 XMP_PUBLIC WXMPUtils_ComposeFieldSelector_1 ( XMP_StringPtr schemaNS,
146 XMP_StringPtr arrayName,
147 XMP_StringPtr fieldNS,
148 XMP_StringPtr fieldName,
149 XMP_StringPtr fieldValue,
150 void * selPath,
151 SetClientStringProc SetClientString,
152 WXMP_Result * wResult );
153
154 // -------------------------------------------------------------------------------------------------
155
156 extern void
157 XMP_PUBLIC WXMPUtils_ConvertFromBool_1 ( XMP_Bool binValue,
158 void * strValue,
159 SetClientStringProc SetClientString,
160 WXMP_Result * wResult );
161
162 extern void
163 XMP_PUBLIC WXMPUtils_ConvertFromInt_1 ( XMP_Int32 binValue,
164 XMP_StringPtr format,
165 void * strValue,
166 SetClientStringProc SetClientString,
167 WXMP_Result * wResult );
168
169 extern void
170 XMP_PUBLIC WXMPUtils_ConvertFromInt64_1 ( XMP_Int64 binValue,
171 XMP_StringPtr format,
172 void * strValue,
173 SetClientStringProc SetClientString,
174 WXMP_Result * wResult );
175
176 extern void
177 XMP_PUBLIC WXMPUtils_ConvertFromFloat_1 ( double binValue,
178 XMP_StringPtr format,
179 void * strValue,
180 SetClientStringProc SetClientString,
181 WXMP_Result * wResult );
182
183 extern void
184 XMP_PUBLIC WXMPUtils_ConvertFromDate_1 ( const XMP_DateTime & binValue,
185 void * strValue,
186 SetClientStringProc SetClientString,
187 WXMP_Result * wResult );
188
189 // -------------------------------------------------------------------------------------------------
190
191 extern void
192 XMP_PUBLIC WXMPUtils_ConvertToBool_1 ( XMP_StringPtr strValue,
193 WXMP_Result * wResult );
194
195 extern void
196 XMP_PUBLIC WXMPUtils_ConvertToInt_1 ( XMP_StringPtr strValue,
197 WXMP_Result * wResult );
198
199 extern void
200 XMP_PUBLIC WXMPUtils_ConvertToInt64_1 ( XMP_StringPtr strValue,
201 WXMP_Result * wResult );
202
203 extern void
204 XMP_PUBLIC WXMPUtils_ConvertToFloat_1 ( XMP_StringPtr strValue,
205 WXMP_Result * wResult );
206
207 extern void
208 XMP_PUBLIC WXMPUtils_ConvertToDate_1 ( XMP_StringPtr strValue,
209 XMP_DateTime * binValue,
210 WXMP_Result * wResult );
211
212 // -------------------------------------------------------------------------------------------------
213
214 extern void
215 XMP_PUBLIC WXMPUtils_CurrentDateTime_1 ( XMP_DateTime * time,
216 WXMP_Result * wResult );
217
218 extern void
219 XMP_PUBLIC WXMPUtils_SetTimeZone_1 ( XMP_DateTime * time,
220 WXMP_Result * wResult );
221
222 extern void
223 XMP_PUBLIC WXMPUtils_ConvertToUTCTime_1 ( XMP_DateTime * time,
224 WXMP_Result * wResult );
225
226 extern void
227 XMP_PUBLIC WXMPUtils_ConvertToLocalTime_1 ( XMP_DateTime * time,
228 WXMP_Result * wResult );
229
230 extern void
231 XMP_PUBLIC WXMPUtils_CompareDateTime_1 ( const XMP_DateTime & left,
232 const XMP_DateTime & right,
233 WXMP_Result * wResult );
234
235 // -------------------------------------------------------------------------------------------------
236
237 extern void
238 XMP_PUBLIC WXMPUtils_EncodeToBase64_1 ( XMP_StringPtr rawStr,
239 XMP_StringLen rawLen,
240 void * encodedStr,
241 SetClientStringProc SetClientString,
242 WXMP_Result * wResult );
243
244 extern void
245 XMP_PUBLIC WXMPUtils_DecodeFromBase64_1 ( XMP_StringPtr encodedStr,
246 XMP_StringLen encodedLen,
247 void * rawStr,
248 SetClientStringProc SetClientString,
249 WXMP_Result * wResult );
250
251 // -------------------------------------------------------------------------------------------------
252
253 extern void
254 XMP_PUBLIC WXMPUtils_PackageForJPEG_1 ( XMPMetaRef xmpObj,
255 void * stdStr,
256 void * extStr,
257 void * digestStr,
258 SetClientStringProc SetClientString,
259 WXMP_Result * wResult );
260
261 extern void
262 XMP_PUBLIC WXMPUtils_MergeFromJPEG_1 ( XMPMetaRef fullXMP,
263 XMPMetaRef extendedXMP,
264 WXMP_Result * wResult );
265
266 // -------------------------------------------------------------------------------------------------
267
268 extern void
269 XMP_PUBLIC WXMPUtils_CatenateArrayItems_1 ( XMPMetaRef xmpObj,
270 XMP_StringPtr schemaNS,
271 XMP_StringPtr arrayName,
272 XMP_StringPtr separator,
273 XMP_StringPtr quotes,
274 XMP_OptionBits options,
275 void * catedStr,
276 SetClientStringProc SetClientString,
277 WXMP_Result * wResult );
278
279 extern void
280 XMP_PUBLIC WXMPUtils_SeparateArrayItems_1 ( XMPMetaRef xmpObj,
281 XMP_StringPtr schemaNS,
282 XMP_StringPtr arrayName,
283 XMP_OptionBits options,
284 XMP_StringPtr catedStr,
285 WXMP_Result * wResult );
286
287 extern void
288 XMP_PUBLIC WXMPUtils_ApplyTemplate_1 ( XMPMetaRef workingXMP,
289 XMPMetaRef templateXMP,
290 XMP_OptionBits options,
291 WXMP_Result * wResult );
292
293 extern void
294 XMP_PUBLIC WXMPUtils_RemoveProperties_1 ( XMPMetaRef xmpObj,
295 XMP_StringPtr schemaNS,
296 XMP_StringPtr propName,
297 XMP_OptionBits options,
298 WXMP_Result * wResult );
299
300 extern void
301 XMP_PUBLIC WXMPUtils_DuplicateSubtree_1 ( XMPMetaRef source,
302 XMPMetaRef dest,
303 XMP_StringPtr sourceNS,
304 XMP_StringPtr sourceRoot,
305 XMP_StringPtr destNS,
306 XMP_StringPtr destRoot,
307 XMP_OptionBits options,
308 WXMP_Result * wResult );
309
310 // =================================================================================================
311
312 #if __cplusplus
313 } /* extern "C" */
314 #endif
315
316 #endif // __WXMPUtils_hpp__
WXMPUtils_ComposeQualifierPath_1
void XMP_PUBLIC WXMPUtils_ComposeQualifierPath_1(XMP_StringPtr schemaNS, XMP_StringPtr propName, XMP_StringPtr qualNS, XMP_StringPtr qualName, void *qualPath, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_ComposeLangSelector_1
void XMP_PUBLIC WXMPUtils_ComposeLangSelector_1(XMP_StringPtr schemaNS, XMP_StringPtr arrayName, XMP_StringPtr langName, void *selPath, SetClientStringProc SetClientString, WXMP_Result *wResult)
SetClientStringProc
void(* SetClientStringProc)(void *clientPtr, XMP_StringPtr valuePtr, XMP_StringLen valueLen)
Definition: WXMP_Common.hpp:25
WXMPUtils_ConvertToDate_1
void XMP_PUBLIC WXMPUtils_ConvertToDate_1(XMP_StringPtr strValue, XMP_DateTime *binValue, WXMP_Result *wResult)
WXMPUtils_ComposeStructFieldPath_1
void XMP_PUBLIC WXMPUtils_ComposeStructFieldPath_1(XMP_StringPtr schemaNS, XMP_StringPtr structName, XMP_StringPtr fieldNS, XMP_StringPtr fieldName, void *fieldPath, SetClientStringProc SetClientString, WXMP_Result *wResult)
XMP_PUBLIC
#define XMP_PUBLIC
Definition: XMP_Environment.h:221
WXMPUtils_ConvertToBool_1
void XMP_PUBLIC WXMPUtils_ConvertToBool_1(XMP_StringPtr strValue, WXMP_Result *wResult)
WXMPUtils_ConvertFromDate_1
void XMP_PUBLIC WXMPUtils_ConvertFromDate_1(const XMP_DateTime &binValue, void *strValue, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_ComposeArrayItemPath_1
void XMP_PUBLIC WXMPUtils_ComposeArrayItemPath_1(XMP_StringPtr schemaNS, XMP_StringPtr arrayName, XMP_Index itemIndex, void *itemPath, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_CompareDateTime_1
void XMP_PUBLIC WXMPUtils_CompareDateTime_1(const XMP_DateTime &left, const XMP_DateTime &right, WXMP_Result *wResult)
WXMPUtils_ConvertFromFloat_1
void XMP_PUBLIC WXMPUtils_ConvertFromFloat_1(double binValue, XMP_StringPtr format, void *strValue, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_RemoveProperties_1
void XMP_PUBLIC WXMPUtils_RemoveProperties_1(XMPMetaRef xmpObj, XMP_StringPtr schemaNS, XMP_StringPtr propName, XMP_OptionBits options, WXMP_Result *wResult)
WXMPUtils_ConvertToUTCTime_1
void XMP_PUBLIC WXMPUtils_ConvertToUTCTime_1(XMP_DateTime *time, WXMP_Result *wResult)
WXMPUtils_ConvertFromInt64_1
void XMP_PUBLIC WXMPUtils_ConvertFromInt64_1(XMP_Int64 binValue, XMP_StringPtr format, void *strValue, SetClientStringProc SetClientString, WXMP_Result *wResult)
XMP_StringPtr
const typedef char * XMP_StringPtr
The type for input string parameters. A const char *, a null-terminated UTF-8 string.
Definition: XMP_Const.h:178
WXMPUtils_DuplicateSubtree_1
void XMP_PUBLIC WXMPUtils_DuplicateSubtree_1(XMPMetaRef source, XMPMetaRef dest, XMP_StringPtr sourceNS, XMP_StringPtr sourceRoot, XMP_StringPtr destNS, XMP_StringPtr destRoot, XMP_OptionBits options, WXMP_Result *wResult)
WXMP_Result
Definition: WXMP_Common.hpp:28
XMPMetaRef
struct __XMPMeta__ * XMPMetaRef
An "ABI safe" pointer to the internal part of an XMP object. Use to pass an XMP object across client ...
Definition: XMP_Const.h:139
WXMPUtils_MergeFromJPEG_1
void XMP_PUBLIC WXMPUtils_MergeFromJPEG_1(XMPMetaRef fullXMP, XMPMetaRef extendedXMP, WXMP_Result *wResult)
WXMPUtils_ConvertToLocalTime_1
void XMP_PUBLIC WXMPUtils_ConvertToLocalTime_1(XMP_DateTime *time, WXMP_Result *wResult)
WXMPUtils_PackageForJPEG_1
void XMP_PUBLIC WXMPUtils_PackageForJPEG_1(XMPMetaRef xmpObj, void *stdStr, void *extStr, void *digestStr, SetClientStringProc SetClientString, WXMP_Result *wResult)
XMP_StringLen
XMP_Uns32 XMP_StringLen
The type for string length parameters. A 32-bit unsigned integer, as big as will be practically neede...
Definition: XMP_Const.h:179
WXMPUtils_ConvertFromInt_1
void XMP_PUBLIC WXMPUtils_ConvertFromInt_1(XMP_Int32 binValue, XMP_StringPtr format, void *strValue, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_ConvertToInt_1
void XMP_PUBLIC WXMPUtils_ConvertToInt_1(XMP_StringPtr strValue, WXMP_Result *wResult)
XMP_Index
XMP_Int32 XMP_Index
The type for offsets and indices. A 32-bit signed integer. It is signed to allow -1 for loop terminat...
Definition: XMP_Const.h:180
WXMPUtils_EncodeToBase64_1
void XMP_PUBLIC WXMPUtils_EncodeToBase64_1(XMP_StringPtr rawStr, XMP_StringLen rawLen, void *encodedStr, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_CatenateArrayItems_1
void XMP_PUBLIC WXMPUtils_CatenateArrayItems_1(XMPMetaRef xmpObj, XMP_StringPtr schemaNS, XMP_StringPtr arrayName, XMP_StringPtr separator, XMP_StringPtr quotes, XMP_OptionBits options, void *catedStr, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_ConvertFromBool_1
void XMP_PUBLIC WXMPUtils_ConvertFromBool_1(XMP_Bool binValue, void *strValue, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_ConvertToInt64_1
void XMP_PUBLIC WXMPUtils_ConvertToInt64_1(XMP_StringPtr strValue, WXMP_Result *wResult)
WXMPUtils_CurrentDateTime_1
void XMP_PUBLIC WXMPUtils_CurrentDateTime_1(XMP_DateTime *time, WXMP_Result *wResult)
XMP_Bool
XMP_Uns8 XMP_Bool
Definition: XMP_Const.h:111
WXMPUtils_ConvertToFloat_1
void XMP_PUBLIC WXMPUtils_ConvertToFloat_1(XMP_StringPtr strValue, WXMP_Result *wResult)
WXMPUtils_ApplyTemplate_1
void XMP_PUBLIC WXMPUtils_ApplyTemplate_1(XMPMetaRef workingXMP, XMPMetaRef templateXMP, XMP_OptionBits options, WXMP_Result *wResult)
WXMPUtils_ComposeFieldSelector_1
void XMP_PUBLIC WXMPUtils_ComposeFieldSelector_1(XMP_StringPtr schemaNS, XMP_StringPtr arrayName, XMP_StringPtr fieldNS, XMP_StringPtr fieldName, XMP_StringPtr fieldValue, void *selPath, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_SeparateArrayItems_1
void XMP_PUBLIC WXMPUtils_SeparateArrayItems_1(XMPMetaRef xmpObj, XMP_StringPtr schemaNS, XMP_StringPtr arrayName, XMP_OptionBits options, XMP_StringPtr catedStr, WXMP_Result *wResult)
WXMP_Common.hpp
XMP_OptionBits
XMP_Uns32 XMP_OptionBits
The type for a collection of 32 flag bits.
Definition: XMP_Const.h:181
XMP_DateTime
The expanded type for a date and time.
Definition: XMP_Const.h:232
WXMPUtils_DecodeFromBase64_1
void XMP_PUBLIC WXMPUtils_DecodeFromBase64_1(XMP_StringPtr encodedStr, XMP_StringLen encodedLen, void *rawStr, SetClientStringProc SetClientString, WXMP_Result *wResult)
WXMPUtils_SetTimeZone_1
void XMP_PUBLIC WXMPUtils_SetTimeZone_1(XMP_DateTime *time, WXMP_Result *wResult)