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
|
###########################################################################/**
# @RdocClass FileRspResponse
#
# @title "The FileRspResponse class"
#
# \description{
# @classhierarchy
# }
#
# @synopsis
#
# \arguments{
# \item{file}{A filename or a @connection to write responses to.}
# \item{path}{An optional path to the file.}
# \item{overwrite}{If @FALSE, an error is thrown if the output file already
# exists, otherwise not.}
# \item{...}{Not used.}
# }
#
# \section{Fields and Methods}{
# @allmethods
# }
#
# @author
#
# @keyword internal
#*/###########################################################################
setConstructorS3("FileRspResponse", function(file=stdout(), path=NULL, overwrite=FALSE, ...) {
# Argument 'file' and 'path':
if (is.character(file)) {
file <- Arguments$getWritablePathname(file=file, path=path, mustNotExist=!overwrite)
# Empty the file
cat(file=file, "")
} else if (!inherits(file, "connection")) {
throw("Argument 'file' must be a filename or a connection: ",
class(file)[1])
}
extend(RspResponse(), "FileRspResponse",
file = file
)
})
#########################################################################/**
# @RdocMethod getOutput
#
# @title "Gets the output for an RSP response"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @connection or a filename.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getOutput", "FileRspResponse", function(this, ...) {
this$file
})
setMethodS3("writeResponse", "FileRspResponse", function(this, ..., collapse="", sep="") {
msg <- paste(..., collapse=collapse, sep=sep)
msg <- as.character(GString(msg))
out <- getOutput(this)
cat(file=out, append=TRUE, msg)
})
setMethodS3("flush", "FileRspResponse", function(con) {
# To please R CMD check.
this <- con
out <- getOutput(this)
flush(out)
}, appendVarArgs=FALSE)
#########################################################################/**
# @RdocMethod getPath
#
# @title "Gets the path of the directory of the current RSP file"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getPath", "FileRspResponse", function(this, ...) {
getParent(this$file)
}, createGeneric=FALSE)
#########################################################################/**
# @RdocMethod getName
#
# @title "Gets the (base)name of the current RSP file"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getName", "FileRspResponse", function(this, ...) {
basename(this$file)
}, createGeneric=FALSE)
#########################################################################/**
# @RdocMethod getAbsolutePath
#
# @title "Gets the absolute pathname to the current RSP file"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getAbsolutePath", "FileRspResponse", function(this, ...) {
getAbsolutePath(this$file)
}, createGeneric=FALSE)
|
