Debian Codegraph @

core/libs/dngwriter/extra/xmp_sdk/public/include/XMP.hpp

raw
1 #ifndef __XMP_hpp__
2 #define __XMP_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 #if AdobePrivate
15 // =================================================================================================
16 // Change history
17 // ==============
18 //
19 // Writers:
20 // AWL Alan Lillich
21 //
22 // mm/dd/yy who Description of changes, most recent on top.
23 //
24 // 03-16-15 AJ 5.6-c048 Fixing build break due to XMPCore.def
25 // 03-02-15 AJ 5.6-c039 Marker Extensibility - Backward compatibility for extensions in GetBulkMarkers() and SetBulkMarkers()
26 // 05-19-09 AWL 5.0-c031-f039 First part of threading improvements. Force full rebuilds.
27 //
28 // 10-31-07 AWL 4.2-c023 Add new class XMPDocOps.
29 // 08-24-07 AWL 4.2-c019 Remove support for ancient CXMP_* init/term routines and non-public (AXE) expat.
30 // 08-02-07 AWL 4.2 Incorporate major revamp to doxygen comments.
31 //
32 // 03-24-06 AWL 4.0 Adapt for move to ham-perforce, integrate XMPFiles, bump version to 4.
33 //
34 // 04-19-05 AWL Improve Doxygen comments for SDK.
35 // 01-28-05 AWL Remove BIB.
36 // 01-17-04 AWL Move into new Perforce depot, cosmetic cleanup.
37 // 03-06-03 AWL Add conditional template class typedefs and Doxygen comments.
38 // 09-11-02 AWL Started first draft.
39 //
40 // =================================================================================================
41 #endif // AdobePrivate
42
43 // ================================================================================================
44 /// \file XMP.hpp
45 /// \brief Overall header file for the XMP Toolkit
46 ///
47 /// This is an overall header file, the only one that C++ clients should include.
48 ///
49 /// The full client API is in the \c TXMPMeta.hpp, \c TXMPIterator.hpp, \c TXMPUtils.hpp headers.
50 /// Read these for information, but do not include them directly. The \c TXMP... classes are C++
51 /// template classes that must be instantiated with a string class such as \c std::string. The
52 /// string class is used to return text strings for property values, serialized XMP, and so on.
53 /// Clients must also compile \c XMP.incl_cpp to ensure that all client-side glue code is generated.
54 /// This should be done by including it in exactly one client source file.
55 ///
56 /// There are two C preprocessor macros that simplify use of the templates:
57 ///
58 /// \li \c TXMP_STRING_TYPE - Define this as the string class to use with the template. You will get
59 /// the template headers included and typedefs (\c SXMPMeta, and so on) to use in your code.
60 ///
61 /// \li \c TXMP_EXPAND_INLINE - Define this as 1 if you want to have the template functions expanded
62 /// inline in your code. Leave it undefined, or defined as 0, to use out-of-line instantiations of
63 /// the template functions. Compiling \c XMP.incl_cpp generates explicit out-of-line
64 /// instantiations if \c TXMP_EXPAND_INLINE is off.
65 ///
66 /// The template parameter, class \c tStringObj, must have the following member functions (which
67 /// match those for \c std::string):
68 ///
69 /// <pre>
70 /// tStringObj& assign ( const char * str, size_t len )
71 /// size_t size() const
72 /// const char * c_str() const
73 /// </pre>
74 ///
75 /// The string class must be suitable for at least UTF-8. This is the encoding used for all general
76 /// values, and is the default encoding for serialized XMP. The string type must also be suitable
77 /// for UTF-16 or UTF-32 if those serialization encodings are used. This mainly means tolerating
78 /// embedded 0 bytes, which \c std::string does.
79 // ================================================================================================
80
81 /// /c XMP_Environment.h must be the first included header.
82 #include "XMP_Environment.h"
83
84 #include "XMP_Version.h"
85 #include "XMP_Const.h"
86
87 #if XMP_WinBuild
88 #if XMP_DebugBuild
89 #pragma warning ( push, 4 )
90 #else
91 #pragma warning ( push, 3 )
92 #endif
93 #pragma warning ( disable : 4702 ) // unreachable code
94 #pragma warning ( disable : 4800 ) // forcing value to bool 'true' or 'false' (performance warning)
95 #endif
96
97 #if defined ( TXMP_STRING_TYPE )
98
99 #include "TXMPMeta.hpp"
100 #include "TXMPIterator.hpp"
101 #include "TXMPUtils.hpp"
102 #if AdobePrivate
103 #include "TXMPDocOps.hpp"
104 #endif
105
106 typedef class TXMPMeta <TXMP_STRING_TYPE> SXMPMeta; // For client convenience.
107 typedef class TXMPIterator <TXMP_STRING_TYPE> SXMPIterator;
108 typedef class TXMPUtils <TXMP_STRING_TYPE> SXMPUtils;
109 #if AdobePrivate
110 typedef class TXMPDocOps <TXMP_STRING_TYPE> SXMPDocOps;
111 #endif
112
113 #if TXMP_EXPAND_INLINE
114 #error "TXMP_EXPAND_INLINE is not working at present. Please don't use it."
115 #include "client-glue/TXMPMeta.incl_cpp"
116 #include "client-glue/TXMPIterator.incl_cpp"
117 #include "client-glue/TXMPUtils.incl_cpp"
118 #if AdobePrivate
119 #include "client-glue/TXMPDocOps.incl_cpp"
120 #endif
121 #include "client-glue/TXMPFiles.incl_cpp"
122 #endif
123
124 #if XMP_INCLUDE_XMPFILES
125 #if AdobePrivate
126 #include "TXMPAlbumArt.hpp"
127 typedef class TXMPAlbumArt<TXMP_STRING_TYPE> SXMPAlbumArt;
128 #endif
129 #include "TXMPFiles.hpp" // ! Needs typedef for SXMPMeta.
130 typedef class TXMPFiles <TXMP_STRING_TYPE> SXMPFiles;
131 #if TXMP_EXPAND_INLINE
132 #include "client-glue/TXMPFiles.incl_cpp"
133 #endif
134 #endif
135
136 #endif // TXMP_STRING_TYPE
137
138 #if XMP_WinBuild
139 #pragma warning ( pop )
140 #endif
141
142 // =================================================================================================
143
144 #endif // __XMP_hpp__