-
Notifications
You must be signed in to change notification settings - Fork 1
/
connect.r
192 lines (183 loc) · 4.98 KB
/
connect.r
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
#' HDFql Library Paths
#'
#' Environment containing information related to the
#' HDFql library on the user's system.
#'
#' @keywords internal
hql.paths = new.env()
#' HDFql Wrapper Constants and Functions
#'
#' Access the constants and functions provided by the
#' HDFql wrapper. The wrapper contents are stored in an
#' environment when the HDFql library is loaded and used
#' internally by hdfqlr to perform operations.
#'
#' @details This environment is exported so that users
#' can directly use the HDFql wrapper functions.
#' The intended method of use is to [attach()] the environment
#' to the search path. For more information on what is provided
#' by the wrapper, consult the
#' [HDFql reference manual](http://www.hdfql.com/#documentation).
#'
#' @examples
#'\dontrun{
#' attach(hql$wrapper)
#' }
#'
#' @export
hql = new.env()
#' HDFql Default Path
#'
#' Retrieve the HDFql installation directory from existing options.
#' This function is used to automatically connect to HDFql without
#' needing to specify the installation path.
#'
#' @param startup If `TRUE`, indicates the paths are being
#' detected as part of package startup.
#'
#' @details The function first looks for the R option `hdfqlr.dir`,
#' and second looks for the environment variable `HDFQL_DIR`.
#'
#' @keywords internal
path_from_options = function(startup = FALSE) {
path = NULL
if (startup) {
msgfun = packageStartupMessage
} else {
msgfun = message
}
if (!is.null(options()[["hdfqlr.dir"]]) && nzchar(options()[["hdfqlr.dir"]])) {
path = options("hdfqlr.dir")[[1]]
msgfun('Using existing HDFql directory ',
'from option "hdfqlr.dir".')
} else if (nzchar(Sys.getenv("HDFQL_DIR"))) {
path = Sys.getenv("HDFQL_DIR")
msgfun("Using existing HDFql directory from ",
'"HDFQL_DIR" environment variable.')
}
if (is.null(path)) {
FALSE
} else {
assign("install", path, envir = hql.paths)
TRUE
}
}
#' HDFql Paths
#'
#' Set the partial paths to the HDFql library and wrapper.
#'
#' @keywords internal
set_paths = function() {
hdfql_operating_system = Sys.info()["sysname"]
if (hdfql_operating_system == "Windows") {
lib.names = c(
"lib/HDFql_dll.dll",
"wrapper/R/HDFqlR.dll"
)
} else if (hdfql_operating_system == "Linux") {
lib.names = c(
"lib/libHDFql.so",
"wrapper/R/libHDFqlR.so"
)
} else # macOS
{
lib.names = c(
"lib/libHDFql.dylib",
"wrapper/R/libHDFqlR.dylib"
)
}
assign("dll", lib.names, envir = hql.paths)
assign("wrapper", "wrapper/R/HDFql.R", envir = hql.paths)
invisible(NULL)
}
#' HDFql Library Status
#'
#' Check if the HDFql library loaded.
#'
#' @return Logical `TRUE` if DLLs are found, `FALSE` otherwise.
#'
#' @export
hql_is_loaded = function() {
if (all(gsub("(.*?)\\..*$", "\\1", basename(hql.paths$dll)) %in% names(getLoadedDLLs()))) {
TRUE
} else {
FALSE
}
}
#' HDFql Load Requirement
#'
#' Return an error if the HDFql library is not loaded.
#'
#' @keywords internal
stop_not_loaded = function() {
if (!hql_is_loaded())
stop("HDFql is not loaded.")
invisible(NULL)
}
#' Load HDFql DLLs
#'
#' Load the HDFql library.
#'
#' @param path The path to the HDFql installation.
#'
#' @importFrom utils packageName tail
#' @export
hql_load = function(path) {
if (hql_is_loaded()) {
return(invisible(NULL))
}
if (!missing(path)) {
assign("install", path, envir = hql.paths)
} else {
if (is.null(hql.paths$install)) {
if (!path_from_options()) {
stop('Argument "path" not specified.', call. = FALSE)
}
}
}
# get paths to DLLs and wrapper
dllpath = normalizePath(file.path(hql.paths$install,
hql.paths$dll), mustWork = TRUE)
message("Connecting to:\n ",
paste(dllpath, collapse = "\n "))
wrapperpath = normalizePath(file.path(hql.paths$install,
hql.paths$wrapper), mustWork = TRUE)
# prepare wrapper code
wrapper.file = tempfile(fileext = ".r")
wrapper.lines = readLines(wrapperpath)
writeLines(wrapper.lines[-grep("dyn\\.load", wrapper.lines)],
wrapper.file)
# load DLLs
for (dll in dllpath) {
dyn.load(dll, local = FALSE, now = TRUE)
if (!dll %in% sapply(getLoadedDLLs(), function(x) normalizePath(x[["path"]], mustWork = FALSE))) {
stop("Error loading HDFql shared library object ", dll)
}
}
# load wrapper
wrapper = new.env(parent = .BaseNamespaceEnv)
tryCatch(
sys.source(wrapper.file, envir = wrapper, toplevel.env = packageName()),
error = function(e) {
stop("Failed to execute HDFql R wrapper.\n Additional Information:\n",
e)
}
)
assign("wrapper", wrapper, envir = hql)
invisible(NULL)
}
#' @describeIn hql_load Unload HDFql Library.
#'
#' @export
hql_unload = function() {
if (hql_is_loaded()) {
dllpath = normalizePath(file.path(hql.paths$install,
hql.paths$dll), mustWork = TRUE)
lapply(dllpath, dyn.unload)
if (hql_is_loaded()) {
stop("HDFql DLLs could not be unloaded.")
}
rm(list = "wrapper", envir = hql)
}
invisible(NULL)
}