All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
library.h
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 ARCH_LIBRARY_H
25 #define 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 PXR_NAMESPACE_OPEN_SCOPE
54 
58 
64 ARCH_API
65 void* ArchLibraryOpen(const std::string &filename, int flag);
66 
70 ARCH_API
71 std::string ArchLibraryError();
72 
75 ARCH_API
76 int ArchLibraryClose(void* handle);
77 
78 PXR_NAMESPACE_CLOSE_SCOPE
79 
80 #endif // ARCH_LIBRARY_H
ARCH_API int ArchLibraryClose(void *handle)
Closes an object opened with ArchLibraryOpen.
ARCH_API void * ArchLibraryOpen(const std::string &filename, int flag)
library.h Architecture dependent loading and unloading of dynamic libraries.
ARCH_API std::string ArchLibraryError()
Obtain a description of the most recent error that occurred from ArchLibraryOpen. ...