HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dl.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_TF_DL_H
25 #define PXR_BASE_TF_DL_H
26 
27 /// \file tf/dl.h
28 /// \ingroup group_tf_SystemsExt
29 /// Interface for opening code libraries.
30 
31 #include "pxr/pxr.h"
32 #include "pxr/base/tf/api.h"
33 #include "pxr/base/arch/library.h"
34 
35 #include <string>
36 
38 
39 /// \addtogroup group_tf_SystemsExt
40 ///@{
41 
42 /// Open a dynamic library and notify \c lib/tf that a new module has been
43 /// loaded.
44 ///
45 /// This is a wrapper around ArchLibraryOpen() in the sense that this function
46 /// calls \c ArchLibraryOpen(\p filename, \p flag) but it will additionally
47 /// load script bindings if scripting is initialized and loading is requested.
48 ///
49 /// If \p error is not \c NULL it will be set to a system reported error
50 /// if opening the library failed, otherwise it will be cleared.
51 ///
52 /// If you set TF_DLOPEN in the TF_DEBUG environment variable then debug
53 /// output will be reported on each invocation of this function.
54 ///
55 /// This returns an opaque handle to the opened library or \c NULL on
56 /// failure.
57 TF_API
58 void* TfDlopen(const std::string &filename,
59  int flag,
60  std::string *error = NULL,
61  bool loadScriptBindings = true);
62 
63 /// Close a dynamic library.
64 TF_API
65 int TfDlclose(void* handle);
66 
67 /// \private
68 TF_API
69 bool Tf_DlOpenIsActive();
70 /// \private
71 TF_API
72 bool Tf_DlCloseIsActive();
73 
74 ///@}
75 
77 
78 #endif
GT_API const UT_StringHolder filename
#define TF_API
Definition: api.h:40
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
TF_API int TfDlclose(void *handle)
Close a dynamic library.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
TF_API void * TfDlopen(const std::string &filename, int flag, std::string *error=NULL, bool loadScriptBindings=true)