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
|
###########################################################################/**
# @RdocClass RspLanguage
# @alias escape.HtmlRspLanguage
#
# @title "The RspLanguage class"
#
# \description{
# @classhierarchy
#
# An RspLanguage object specifies what the markup language of the
# response/output document is, e.g. plain text and HTML.
# The RspLanguage class provides methods to obtain language specific
# strings/output such as how newlines and comments are written.
# The RspLanguage class describes a plain text languages. For HTML
# see the @see "HtmlRspLanguage" subclass.
# }
#
# @synopsis
#
# \arguments{
# \item{language}{A @character string.}
# \item{...}{Not used.}
# }
#
# \section{Fields and Methods}{
# @allmethods
# }
#
# @author
# @keyword internal
#*/###########################################################################
setConstructorS3("RspLanguage", function(language="plain", ...) {
language <- Arguments$getCharacter(language, length=1, nchar=c(1,64))
extend(Object(), "RspLanguage",
language=language
)
})
#########################################################################/**
# @RdocMethod getLanguage
#
# @title "Gets the language string"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getLanguage", "RspLanguage", function(this, ...) {
this$language
})
#########################################################################/**
# @RdocMethod getNewline
#
# @title "Gets the newline string specific for a given RSP response language"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getNewline", "RspLanguage", function(this, ...) {
"\n"
})
#########################################################################/**
# @RdocMethod getComment
# @alias getComment.HtmlRspLanguage
#
# @title "Gets a comment string specific for a given RSP response language"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{R objects to be pasted together.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getComment", "RspLanguage", function(this, ...) {
s <- paste(..., collapse="\n", sep="")
# By default, no output!
""
})
#########################################################################/**
# @RdocMethod escape
#
# @title "Escapes a string specifically for a given RSP response language"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{R objects to be pasted together.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("escape", "RspLanguage", function(this, ...) {
paste(..., collapse="\n", sep="")
})
#########################################################################/**
# @RdocMethod getVerbatim
# @alias getVerbatim.HtmlRspLanguage
#
# @title "Gets a verbatim string specific for a given RSP response language"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{R objects to be pasted together.}
# }
#
# \value{
# Returns a @character string.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword IO
#*/#########################################################################
setMethodS3("getVerbatim", "RspLanguage", function(this, ...) {
escape(this, ...)
})
|
