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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
###########################################################################/**
# @RdocDefault rstring
# @alias rstring.RspString
# @alias rstring.RspDocument
# @alias rstring.RspSourceCode
# @alias rstring.function
# @alias rstring.expression
#
# @title "Evaluates an RSP string and returns the generated string"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{A @character string with RSP markup.}
# \item{file, path}{Alternatively, a file, a URL or a @connection from
# with the strings are read.
# If a file, the \code{path} is prepended to the file, iff given.}
# \item{envir}{The @environment in which the RSP string is
# preprocessed and evaluated.}
# \item{args}{A named @list of arguments assigned to the environment
# in which the RSP string is parsed and evaluated.
# See @see "R.utils::cmdArgs".}
# \item{verbose}{See @see "R.utils::Verbose".}
# }
#
# \value{
# Returns an @see "RspStringProduct".
# }
#
# @examples "../incl/rstring.Rex"
#
# @author
#
# \seealso{
# To display the output (instead of returning a string), see
# @see "rcat".
# For evaluating and postprocessing an RSP document and
# writing the output to a file, see @see "rfile".
# }
#
# @keyword file
# @keyword IO
#*/###########################################################################
setMethodS3("rstring", "default", function(..., file=NULL, path=NULL, envir=parent.frame(), args="*", verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'file' & 'path':
if (inherits(file, "connection")) {
} else if (is.character(file)) {
if (!is.null(path)) {
file <- file.path(path, file)
}
if (!isUrl(file)) {
file <- Arguments$getReadablePathname(file, absolute=TRUE)
}
}
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for default")
if (is.null(file)) {
s <- RspString(...)
} else {
verbose && cat(verbose, "Input file: ", file)
s <- .readText(file)
s <- RspString(s, source=file, ...)
s <- setMetadata(s, name="source", value=file)
}
verbose && cat(verbose, "Length of RSP string: ", nchar(s))
res <- rstring(s, envir=envir, args=args, verbose=verbose)
verbose && exit(verbose)
res
}) # rstring()
setMethodS3("rstring", "RspString", function(object, envir=parent.frame(), args="*", ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'args':
args <- cmdArgs(args)
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for ", class(object)[1L])
if (length(args) > 0L) {
verbose && enter(verbose, "Assigning RSP arguments to processing environment")
verbose && cat(verbose, "Environment: ", getName(envir))
verbose && cat(verbose, "RSP arguments:")
verbose && str(verbose, args)
# Assign arguments to the parse/evaluation environment
names <- attachLocally(args, envir=envir)
if (verbose) {
if (length(names) > 0L) {
printf(verbose, "Variables assigned: [%d] %s\n", length(names), hpaste(names))
member <- NULL; rm(list="member"); # To please R CMD check
ll <- subset(ll(envir=envir), member %in% names)
print(verbose, ll)
}
}
verbose && exit(verbose)
} else {
names <- NULL
}
if (verbose) {
enter(verbose, "Parse RSP string to RSP document")
cat(verbose, "Parse environment: ", getName(envir))
if (length(names) > 0L) {
ll <- subset(ll(envir=envir), member %in% names)
print(verbose, ll)
}
}
doc <- parseDocument(object, envir=envir, ..., verbose=verbose)
verbose && print(verbose, doc)
verbose && exit(verbose)
res <- rstring(doc, envir=envir, args=NULL, ..., verbose=verbose)
verbose && exit(verbose)
res
}) # rstring()
setMethodS3("rstring", "RspDocument", function(object, envir=parent.frame(), ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for ", class(object)[1L])
verbose && enter(verbose, "Coerce RSP document to source code")
# language <- getAttribute(object, "language", default="R")
language <- getMetadata(object, "language", default="R")
language <- capitalize(tolower(language))
className <- sprintf("Rsp%sSourceCodeFactory", language)
ns <- getNamespace("R.rsp")
clazz <- Class$forName(className, envir=ns)
factory <- newInstance(clazz)
verbose && cat(verbose, "Language: ", getLanguage(factory))
code <- toSourceCode(factory, object, verbose=verbose)
verbose && cat(verbose, "Generated source code:")
verbose && cat(verbose, head(code, n=3L))
verbose && cat(verbose)
verbose && cat(verbose, "[...]")
verbose && cat(verbose)
verbose && cat(verbose, tail(code, n=3L))
verbose && exit(verbose)
res <- rstring(code, ..., envir=envir, verbose=verbose)
verbose && exit(verbose)
res
}) # rstring()
setMethodS3("rstring", "RspSourceCode", function(object, envir=parent.frame(), ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for ", class(object)[1L])
verbose && cat(verbose, "Environment: ", getName(envir))
res <- process(object, envir=envir, ..., verbose=less(verbose,10))
verbose && exit(verbose)
res
}) # rstring()
setMethodS3("rstring", "function", function(object, envir=parent.frame(), ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'object':
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for ", class(object)[1L])
verbose && cat(verbose, "Environment: ", getName(envir))
## Temporarily assign the function to the evaluation environment
## and set its own environment also to the evaluation environment
fcn <- object
environment(fcn) <- envir
fcnName <- tempvar(".rfcn", value=fcn, envir=envir)
on.exit({
rm(list=fcnName, envir=envir, inherits=FALSE)
}, add=TRUE)
code <- sprintf("%s()", fcnName)
rcode <- RspRSourceCode(code)
res <- rstring(rcode, envir=envir, ..., verbose=less(verbose,10))
verbose && exit(verbose)
res
}) # rstring()
setMethodS3("rstring", "expression", function(object, envir=parent.frame(), ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'object':
# Argument 'verbose':
verbose <- Arguments$getVerbose(verbose)
if (verbose) {
pushState(verbose)
on.exit(popState(verbose))
}
verbose && enter(verbose, "rstring() for ", class(object)[1L])
verbose && cat(verbose, "Environment: ", getName(envir))
# Deparsing 'object[[1L]]' instead of 'object' in order to drop
# the 'expression({ ... })' wrapper.
code <- deparse(object[[1L]])
rcode <- RspRSourceCode(code)
res <- rstring(rcode, envir=envir, ..., verbose=less(verbose,10))
verbose && exit(verbose)
res
}) # rstring()
|
