HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
library.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_ARCH_LIBRARY_H
25 #define PXR_BASE_ARCH_LIBRARY_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/arch/api.h"
29 
30 #include <string>
31 
32 #if defined(ARCH_OS_WINDOWS)
33 # define ARCH_LIBRARY_LAZY 0
34 # define ARCH_LIBRARY_NOW 0
35 # define ARCH_LIBRARY_LOCAL 0
36 # define ARCH_LIBRARY_GLOBAL 0
37 # define ARCH_LIBRARY_SUFFIX ".dll"
38 # define ARCH_STATIC_LIBRARY_SUFFIX ".lib"
39 #else
40 # include <dlfcn.h>
41 # define ARCH_LIBRARY_LAZY RTLD_LAZY
42 # define ARCH_LIBRARY_NOW RTLD_NOW
43 # define ARCH_LIBRARY_LOCAL RTLD_LOCAL
44 # define ARCH_LIBRARY_GLOBAL RTLD_GLOBAL
45 # if defined(ARCH_OS_DARWIN)
46 # define ARCH_LIBRARY_SUFFIX ".dylib"
47 # else
48 # define ARCH_LIBRARY_SUFFIX ".so"
49 # endif
50 # define ARCH_STATIC_LIBRARY_SUFFIX ".a"
51 #endif
52 
53 // On MacOS shared libraries and loadable modules (aka loadable bundles aka
54 // plugins) are different entities. Most cross-platform software packages
55 // that create loadable modules use .so as the extension on MacOS for
56 // compatibility, so we use that here.
57 #if defined(ARCH_OS_DARWIN)
58 # define ARCH_PLUGIN_SUFFIX ".so"
59 #else
60 # define ARCH_PLUGIN_SUFFIX ARCH_LIBRARY_SUFFIX
61 #endif
62 
64 
65 /// library.h
66 /// Architecture dependent loading and unloading of dynamic libraries.
67 /// \ingroup group_arch_SystemFunctions
68 
69 /// Load an executable object file.
70 /// \ingroup group_arch_SystemFunctions
71 ///
72 /// Opens the dynamic library that is specified by filename.
73 /// Returning the handle to the module if successful; false otherwise.
74 ARCH_API
75 void* ArchLibraryOpen(const std::string &filename, int flag);
76 
77 /// Obtain a description of the most recent error that occurred from
78 /// \c ArchLibraryOpen.
79 ///\ingroup group_arch_SystemFunctions
82 
83 /// Closes an object opened with \c ArchLibraryOpen.
84 /// \ingroup group_arch_SystemFunctions
86 int ArchLibraryClose(void* handle);
87 
88 /// Obtain the address of a symbol defined within an object opened with
89 /// \c ArchLibraryOpen.
90 /// \ingroup group_arch_SystemFunctions
91 ///
92 /// Obtain the address of a symbol that is specified by name.
93 /// Returning the address of the symbol if successful; nullptr otherwise.
95 void* ArchLibraryGetSymbolAddress(void* handle, const char* name);
96 
98 
99 #endif // PXR_BASE_ARCH_LIBRARY_H
GT_API const UT_StringHolder filename
GLuint const GLchar * name
Definition: glcorearb.h:785
ARCH_API int ArchLibraryClose(void *handle)
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
ARCH_API void * ArchLibraryGetSymbolAddress(void *handle, const char *name)
PXR_NAMESPACE_OPEN_SCOPE ARCH_API void * ArchLibraryOpen(const std::string &filename, int flag)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define ARCH_API
Definition: api.h:40
ARCH_API std::string ArchLibraryError()