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