author | Jan Vrany <jan.vrany@fit.cvut.cz> |
Mon, 18 Jul 2011 16:22:09 +0100 | |
branch | jv |
changeset 17846 | 24edc476ac18 |
parent 17845 | 7e0cfaac936d |
child 17864 | e6010e48defb |
permissions | -rw-r--r-- |
5477 | 1 |
" |
2 |
COPYRIGHT (c) 2000 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
17845 | 12 |
|
13 |
||
14 |
||
5543
02ae5b02191a
re-checkin to force packageID change
Claus Gittinger <cg@exept.de>
parents:
5477
diff
changeset
|
15 |
"{ Package: 'stx:libbasic' }" |
5477 | 16 |
|
8402 | 17 |
AspectVisitor subclass:#ObjectCoder |
5477 | 18 |
instanceVariableNames:'stream' |
19 |
classVariableNames:'' |
|
20 |
poolDictionaries:'' |
|
21 |
category:'System-Storage' |
|
22 |
! |
|
23 |
||
24 |
!ObjectCoder class methodsFor:'documentation'! |
|
25 |
||
26 |
copyright |
|
27 |
" |
|
28 |
COPYRIGHT (c) 2000 by eXept Software AG |
|
29 |
All Rights Reserved |
|
30 |
||
31 |
This software is furnished under a license and may be used |
|
32 |
only in accordance with the terms of that license and with the |
|
33 |
inclusion of the above copyright notice. This software may not |
|
34 |
be provided or otherwise made available to, or used by, any |
|
35 |
other person. No title to or ownership of the software is |
|
36 |
hereby transferred. |
|
37 |
" |
|
38 |
||
39 |
||
40 |
! |
|
41 |
||
42 |
documentation |
|
43 |
" |
|
44 |
This is an abstract class. Subclasses implement encoding and decoding |
|
45 |
of Objects onto resp. from a stream. Possible coders are ASN.1/BER, |
|
46 |
CORBA/CDR, BOSS, RMI ... |
|
47 |
||
48 |
Classes which implement basic types (Boolean, Integer, Float, ...) |
|
8402 | 49 |
implement the visitor methods #acceptVisitor:with:, which dispatches onto an ObjectCoder. |
5477 | 50 |
|
51 |
[author:] |
|
52 |
Stefan Vogel |
|
53 |
||
54 |
[see also:] |
|
55 |
OSI::ASN1_Coder |
|
56 |
||
57 |
[instance variables:] |
|
58 |
stream <Stream> the stream we read/write the encodings from/to |
|
59 |
||
60 |
[class variables:] |
|
61 |
" |
|
62 |
! ! |
|
63 |
||
64 |
!ObjectCoder class methodsFor:'instance creation'! |
|
65 |
||
66 |
on:aStream |
|
67 |
"return an encoder/decoder for a stream" |
|
68 |
||
69 |
^ self new stream:aStream |
|
70 |
||
71 |
||
72 |
! ! |
|
73 |
||
74 |
!ObjectCoder class methodsFor:'encoding'! |
|
75 |
||
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
76 |
decode:anObject |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
77 |
"decode anObject" |
6896 | 78 |
|
79 |
^ (self on:anObject readStream) upToEnd |
|
80 |
||
81 |
" |
|
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
82 |
Base64Coder encode:#[1 2 16rFe 16rFF] |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
83 |
Base64Coder decode:'AQL+/w==' |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
84 |
" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
85 |
! |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
86 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
87 |
decodingOf:anObject |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
88 |
"use encode" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
89 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
90 |
<resource: #obsolete> |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
91 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
92 |
^ self decode:anObject |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
93 |
! |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
94 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
95 |
encode:anObject |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
96 |
"encode of anObject" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
97 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
98 |
^ self new encodingOf:anObject with:nil |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
99 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
100 |
" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
101 |
Base64Coder encode:#[1 2 16rFe 16rFF] |
6896 | 102 |
" |
103 |
! |
|
104 |
||
6705 | 105 |
encode:anObject on:aStream |
106 |
||
107 |
|coder| |
|
108 |
||
109 |
coder := self new stream:aStream. |
|
8402 | 110 |
anObject acceptVisitor:coder with:nil. |
6705 | 111 |
! |
112 |
||
113 |
encode:anObject on:aStream with:info |
|
114 |
||
115 |
|coder| |
|
116 |
||
117 |
coder := self new stream:aStream. |
|
8402 | 118 |
anObject acceptVisitor:coder with:info. |
6705 | 119 |
! |
120 |
||
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
121 |
encode:anObject with:aParameter |
5477 | 122 |
"return the encoding of anObject" |
123 |
||
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
124 |
^ self new encodingOf:anObject with:aParameter |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
125 |
! |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
126 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
127 |
encodingOf:anObject |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
128 |
"use #encode:" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
129 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
130 |
<resource: #obsolete> |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
131 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
132 |
^ self encode:anObject |
6896 | 133 |
|
134 |
" |
|
135 |
Base64Coder encodingOf:#[1 2 16rFe 16rFF] |
|
136 |
" |
|
5477 | 137 |
! |
138 |
||
139 |
encodingOf:anObject with:aParameter |
|
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
140 |
"use #encode:with:" |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
141 |
|
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
142 |
<resource: #obsolete> |
5477 | 143 |
|
144 |
^ self new encodingOf:anObject with:aParameter |
|
145 |
! ! |
|
146 |
||
6479 | 147 |
!ObjectCoder methodsFor:'accessing'! |
148 |
||
149 |
contents |
|
150 |
||
151 |
self flush. |
|
152 |
^ stream contents |
|
153 |
! ! |
|
154 |
||
5477 | 155 |
!ObjectCoder methodsFor:'decoding'! |
156 |
||
157 |
next |
|
158 |
"read, decode and return the next object" |
|
159 |
||
160 |
^ self subclassResponsibility |
|
161 |
||
162 |
||
163 |
! ! |
|
164 |
||
165 |
!ObjectCoder methodsFor:'encoding'! |
|
166 |
||
167 |
encodingOf:anObject |
|
168 |
"answer the encoded argument anObject" |
|
169 |
||
170 |
^ self encodingOf:anObject with:nil |
|
171 |
||
172 |
||
173 |
! |
|
174 |
||
175 |
encodingOf:anObject with:aParameter |
|
176 |
"answer the encoded argument anObject" |
|
177 |
||
178 |
stream isNil ifTrue:[ |
|
6595
94466b4392d4
#emptyWriteStream and #encodeSeqenceableCollection
Stefan Vogel <sv@exept.de>
parents:
6594
diff
changeset
|
179 |
stream := self emptyWriteStream. |
5477 | 180 |
] ifFalse:[ |
181 |
stream reset. |
|
182 |
]. |
|
183 |
||
8621
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
184 |
anObject acceptVisitor:self with:aParameter. |
b57b1e5b2eca
Define #encode: and #decode: instead of #encodingOf: an #decodingOf:
Stefan Vogel <sv@exept.de>
parents:
8402
diff
changeset
|
185 |
|
5477 | 186 |
^ stream contents. |
187 |
! |
|
188 |
||
189 |
nextPut:anObject |
|
190 |
"encode anObject onto my stream" |
|
191 |
||
8402 | 192 |
self nextPut:anObject with:nil. |
8369
4ed7a6453f44
only one method sends encodeOn (to allow for easier redefinition)
Claus Gittinger <cg@exept.de>
parents:
7257
diff
changeset
|
193 |
! |
5477 | 194 |
|
8369
4ed7a6453f44
only one method sends encodeOn (to allow for easier redefinition)
Claus Gittinger <cg@exept.de>
parents:
7257
diff
changeset
|
195 |
nextPut:anObject with:aParameter |
4ed7a6453f44
only one method sends encodeOn (to allow for easier redefinition)
Claus Gittinger <cg@exept.de>
parents:
7257
diff
changeset
|
196 |
"encode anObject onto my stream" |
4ed7a6453f44
only one method sends encodeOn (to allow for easier redefinition)
Claus Gittinger <cg@exept.de>
parents:
7257
diff
changeset
|
197 |
|
8402 | 198 |
anObject acceptVisitor:self with:aParameter. |
5477 | 199 |
! |
200 |
||
201 |
nextPutAll:aCollectionOfObjects |
|
202 |
"encode all objects from the argument" |
|
203 |
||
204 |
aCollectionOfObjects do:[:o | |
|
205 |
self nextPut:o |
|
206 |
] |
|
207 |
||
208 |
! ! |
|
209 |
||
8402 | 210 |
!ObjectCoder methodsFor:'encoding-smalltalk types'! |
211 |
||
212 |
visitBlock:aBlock with:aParameter |
|
213 |
"encoding of blocks is rather difficult and an error by default. |
|
214 |
If your encoder supports this, redefine it there" |
|
215 |
||
216 |
self error:'encoding of blocks is not supported' |
|
217 |
! ! |
|
218 |
||
5477 | 219 |
!ObjectCoder methodsFor:'initialization'! |
220 |
||
221 |
close |
|
222 |
"close the underlying stream" |
|
223 |
||
224 |
stream notNil ifTrue:[ |
|
225 |
stream close. |
|
226 |
]. |
|
227 |
||
228 |
||
229 |
! |
|
230 |
||
6595
94466b4392d4
#emptyWriteStream and #encodeSeqenceableCollection
Stefan Vogel <sv@exept.de>
parents:
6594
diff
changeset
|
231 |
emptyWriteStream |
94466b4392d4
#emptyWriteStream and #encodeSeqenceableCollection
Stefan Vogel <sv@exept.de>
parents:
6594
diff
changeset
|
232 |
"answer an empty stream for writing the encoded object" |
6594 | 233 |
|
6595
94466b4392d4
#emptyWriteStream and #encodeSeqenceableCollection
Stefan Vogel <sv@exept.de>
parents:
6594
diff
changeset
|
234 |
^ self subclassResponsibility |
6594 | 235 |
! |
236 |
||
6479 | 237 |
flush |
238 |
"flush possibly internally buffered data. |
|
239 |
Nothing is done by default. Subclasses may redefine this" |
|
240 |
||
241 |
^ self |
|
242 |
! |
|
243 |
||
5477 | 244 |
reset |
245 |
"reset the coder" |
|
246 |
||
247 |
stream notNil ifTrue:[ |
|
248 |
stream reset. |
|
249 |
]. |
|
250 |
||
251 |
||
252 |
! ! |
|
253 |
||
7257 | 254 |
!ObjectCoder methodsFor:'private-accessing'! |
5477 | 255 |
|
256 |
stream:aStream |
|
5617 | 257 |
stream := aStream. |
5477 | 258 |
! ! |
259 |
||
260 |
!ObjectCoder class methodsFor:'documentation'! |
|
261 |
||
262 |
version |
|
17846 | 263 |
^ '$Id: ObjectCoder.st 10660 2011-07-18 15:22:09Z vranyj1 $' |
264 |
! ! |