1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkResourceFileLocator.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkResourceFileLocator
* @brief utility to locate resource files.
*
* VTK based application often need to locate resource files, such configuration
* files, Python modules, etc. vtkResourceFileLocator provides methods that can
* be used to locate such resource files at runtime.
*
* Using `Locate`, one can locate files relative to an
* anchor directory such as the executable directory, or the library directory.
*
* `GetLibraryPathForSymbolUnix` and `GetLibraryPathForSymbolWin32` methods can
* be used to locate the library that provides a particular symbol. For example,
* this is used by `vtkPythonInterpreter` to ensure that the `vtk` Python package
* is located relative the VTK libraries, irrespective of the application location.
*/
#ifndef vtkResourceFileLocator_h
#define vtkResourceFileLocator_h
#include "vtkCommonMiscModule.h" // For export macro
#include "vtkObject.h"
#include <string> // needed for std::string
#include <vector> // needed for std::vector
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONMISC_EXPORT vtkResourceFileLocator : public vtkObject
{
public:
static vtkResourceFileLocator* New();
vtkTypeMacro(vtkResourceFileLocator, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* The log verbosity to use when logging information about the resource
* searching. Default is `vtkLogger::VERBOSITY_TRACE`.
*/
vtkSetMacro(LogVerbosity, int);
vtkGetMacro(LogVerbosity, int);
///@}
///@{
/**
* Given a starting anchor directory, look for the landmark file relative to
* the anchor. If found return the anchor. If not found, go one directory up
* and then look the landmark file again.
*/
virtual std::string Locate(const std::string& anchor, const std::string& landmark,
const std::string& defaultDir = std::string());
///@}
///@{
/**
* This variant is used to look for landmark relative to the anchor using
* additional prefixes for the landmark file. For example, if you're looking for
* `vtk/__init__.py`, but it can be placed relative to your anchor location
* (let's say the executable directory), under "lib" or "lib/python", then
* use this variant with "lib", and "lib/python" passed in as the landmark
* prefixes. On success, the returned value will be anchor + matching prefix.
*/
virtual std::string Locate(const std::string& anchor,
const std::vector<std::string>& landmark_prefixes, const std::string& landmark,
const std::string& defaultDir = std::string());
///@}
///@{
/**
* Returns the name of the library providing the symbol. For example, if you
* want to locate where the VTK libraries located call
* `GetLibraryPathForSymbolUnix("GetVTKVersion")` on Unixes and
* `GetLibraryPathForSymbolWin32(GetVTKVersion)` on Windows. Alternatively, you
* can simply use the `vtkGetLibraryPathForSymbol(GetVTKVersion)` macro
* that makes the appropriate call as per the current platform.
*/
static VTK_FILEPATH std::string GetLibraryPathForSymbolUnix(const char* symbolname);
static VTK_FILEPATH std::string GetLibraryPathForSymbolWin32(const void* fptr);
///@}
protected:
vtkResourceFileLocator();
~vtkResourceFileLocator() override;
private:
vtkResourceFileLocator(const vtkResourceFileLocator&) = delete;
void operator=(const vtkResourceFileLocator&) = delete;
int LogVerbosity;
};
#if defined(_WIN32) && !defined(__CYGWIN__)
#define vtkGetLibraryPathForSymbol(function) \
vtkResourceFileLocator::GetLibraryPathForSymbolWin32(reinterpret_cast<const void*>(&function))
#else
#define vtkGetLibraryPathForSymbol(function) \
vtkResourceFileLocator::GetLibraryPathForSymbolUnix(#function)
#endif
VTK_ABI_NAMESPACE_END
#endif
|
