author | Stefan Vogel <sv@exept.de> |
Tue, 26 Nov 2002 17:19:10 +0100 | |
changeset 1352 | e9e91394ca1a |
parent 1331 | 0951a2122a85 |
child 1357 | 3936e1d64491 |
permissions | -rw-r--r-- |
2 | 1 |
" |
2 |
COPYRIGHT (c) 1993 by Claus Gittinger |
|
49 | 3 |
All Rights Reserved |
2 | 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 |
" |
|
12 |
||
1081 | 13 |
"{ Package: 'stx:libcomp' }" |
14 |
||
141 | 15 |
Parser subclass:#Explainer |
263 | 16 |
instanceVariableNames:'' |
17 |
classVariableNames:'' |
|
18 |
poolDictionaries:'' |
|
19 |
category:'System-Compiler' |
|
2 | 20 |
! |
21 |
||
396 | 22 |
!Explainer class methodsFor:'documentation'! |
2 | 23 |
|
20 | 24 |
copyright |
25 |
" |
|
26 |
COPYRIGHT (c) 1993 by Claus Gittinger |
|
49 | 27 |
All Rights Reserved |
20 | 28 |
|
29 |
This software is furnished under a license and may be used |
|
30 |
only in accordance with the terms of that license and with the |
|
31 |
inclusion of the above copyright notice. This software may not |
|
32 |
be provided or otherwise made available to, or used by, any |
|
33 |
other person. No title to or ownership of the software is |
|
34 |
hereby transferred. |
|
35 |
" |
|
36 |
! |
|
37 |
||
2 | 38 |
documentation |
39 |
" |
|
20 | 40 |
a very simple explainer - much more should be added ... |
41 |
This one is involved, when the 'explain' function is used in a |
|
84 | 42 |
codeView (popup or via CMD-E). |
263 | 43 |
|
44 |
[author:] |
|
45 |
Claus Gittinger |
|
2 | 46 |
" |
47 |
! ! |
|
48 |
||
396 | 49 |
!Explainer class methodsFor:'explaining'! |
2 | 50 |
|
1316
30806ca08095
commonSuperClassOf: - allow for classes and names in arg
Claus Gittinger <cg@exept.de>
parents:
1289
diff
changeset
|
51 |
commonSuperClassOf:listOfClassesOrClassNames |
1352 | 52 |
|common| |
141 | 53 |
|
1316
30806ca08095
commonSuperClassOf: - allow for classes and names in arg
Claus Gittinger <cg@exept.de>
parents:
1289
diff
changeset
|
54 |
listOfClassesOrClassNames do:[:classOrClassName | |
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
55 |
|class| |
141 | 56 |
|
1316
30806ca08095
commonSuperClassOf: - allow for classes and names in arg
Claus Gittinger <cg@exept.de>
parents:
1289
diff
changeset
|
57 |
class := classOrClassName isBehavior |
30806ca08095
commonSuperClassOf: - allow for classes and names in arg
Claus Gittinger <cg@exept.de>
parents:
1289
diff
changeset
|
58 |
ifTrue:[classOrClassName] |
1352 | 59 |
ifFalse:[Smalltalk classNamed:classOrClassName]. |
1317
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
60 |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
61 |
common isNil ifTrue:[ |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
62 |
common := class |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
63 |
] ifFalse:[ |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
64 |
(class isSubclassOf:common) ifTrue:[ |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
65 |
"keep common" |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
66 |
] ifFalse:[ |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
67 |
(common isSubclassOf:class) ifTrue:[ |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
68 |
common := class |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
69 |
] ifFalse:[ |
1317
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
70 |
common := common commonSuperclass:class. |
1151 | 71 |
|
1317
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
72 |
"/ "walk up, checking" |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
73 |
"/ found := false. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
74 |
"/ |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
75 |
"/ common allSuperclassesDo:[:sup | |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
76 |
"/ (found not and:[class isSubclassOf:sup]) ifTrue:[ |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
77 |
"/ common := sup. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
78 |
"/ found := true. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
79 |
"/ ] |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
80 |
"/ ]. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
81 |
"/ found ifFalse:[ |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
82 |
"/ class allSuperclassesDo:[:sup | |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
83 |
"/ (found not and:[common isSubclassOf:sup]) ifTrue:[ |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
84 |
"/ common := sup. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
85 |
"/ found := true. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
86 |
"/ ] |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
87 |
"/ ]. |
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
88 |
"/ ]. |
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
89 |
] |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
90 |
]. |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
91 |
]. |
1317
064ed982ddf8
commonSuperClassOf: easier (fixed ?)
Claus Gittinger <cg@exept.de>
parents:
1316
diff
changeset
|
92 |
(common isNil or:[common == Object]) ifTrue:[^ common]. |
141 | 93 |
]. |
94 |
^ common |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
95 |
|
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
96 |
"Modified: 17.6.1996 / 17:09:21 / stefan" |
336 | 97 |
"Modified: 5.9.1996 / 19:34:41 / cg" |
141 | 98 |
! |
99 |
||
2 | 100 |
explain:someText in:source forClass:aClass |
6 | 101 |
"Given a source and a substring of it, return a string containing |
102 |
an explanation. |
|
49 | 103 |
This is just a q&d implementation - to be correct, it should use the parser, |
104 |
and explain from the parsetree (instead of doing string matches). |
|
105 |
This leads to some wrong explanations, for example if some string is |
|
839 | 106 |
used as selector within a string, or if a variable is named like a |
107 |
message selector. I.e. the explanation should be context sensitive. |
|
49 | 108 |
Also, there could be much more detailed explanations." |
2 | 109 |
|
1183 | 110 |
^ self |
111 |
explain:someText in:source forClass:aClass short:false |
|
112 |
! |
|
113 |
||
114 |
explain:someText in:source forClass:aClass short:shortText |
|
115 |
"Given a source and a substring of it, return a string containing |
|
116 |
an explanation. |
|
117 |
This is just a q&d implementation - to be correct, it should use the parser, |
|
118 |
and explain from the parsetree (instead of doing string matches). |
|
119 |
This leads to some wrong explanations, for example if some string is |
|
120 |
used as selector within a string, or if a variable is named like a |
|
121 |
message selector. I.e. the explanation should be context sensitive. |
|
122 |
Also, there could be much more detailed explanations." |
|
123 |
||
1159 | 124 |
|parser variables c string tmp |
1289 | 125 |
spc sym sel stringText clsName val valString| |
2 | 126 |
|
675 | 127 |
string := someText string withoutSeparators. |
1198 | 128 |
stringText := string allBold. |
1233 | 129 |
stringText := '''' , stringText , ''''. |
49 | 130 |
|
131 |
" |
|
132 |
ask parser for variable names |
|
133 |
" |
|
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
134 |
parser := self parseMethod:source in:aClass ignoreErrors:true ignoreWarnings:true. |
2 | 135 |
parser notNil ifTrue:[ |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
136 |
"look for variables" |
2 | 137 |
|
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
138 |
variables := parser methodVars. |
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
139 |
(variables notNil and:[variables includes:string]) ifTrue:[ |
1233 | 140 |
^ stringText , ' is a method variable.' |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
141 |
]. |
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
142 |
variables := parser methodArgs. |
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
143 |
(variables notNil and:[variables includes:string]) ifTrue:[ |
1233 | 144 |
^ stringText , ' is a method argument.' |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
145 |
] |
2 | 146 |
]. |
49 | 147 |
|
2 | 148 |
parser isNil ifTrue:[ |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
149 |
parser := self for:(ReadStream on:source) in:aClass |
2 | 150 |
]. |
151 |
||
152 |
"instvars" |
|
84 | 153 |
c := aClass whichClassDefinesInstVar:string. |
154 |
c notNil ifTrue:[ |
|
396 | 155 |
c isMeta ifTrue:[ |
1211
91e94e294819
isMeta/soleInstance -> theMetaclass / theNonMetaclass
Claus Gittinger <cg@exept.de>
parents:
1210
diff
changeset
|
156 |
clsName := c theNonMetaclass name. |
1198 | 157 |
shortText ifTrue:[ |
1233 | 158 |
^ stringText , ' is a class instVar in ' , clsName , '.' |
1198 | 159 |
]. |
1233 | 160 |
^ stringText, ' is a class instance variable in ' , clsName , '.' |
396 | 161 |
]. |
162 |
||
1233 | 163 |
clsName := c name. |
1198 | 164 |
shortText ifTrue:[ |
1233 | 165 |
^ stringText , ' is an instVar in ' , clsName , '.' |
1198 | 166 |
]. |
1233 | 167 |
^ stringText , ' is an instance variable in ' , clsName , '.' |
2 | 168 |
]. |
169 |
||
84 | 170 |
"/ variables := aClass allInstVarNames. |
171 |
"/ (variables notNil and:[variables includes:string]) ifTrue:[ |
|
172 |
"/ "where is it" |
|
173 |
"/ c := aClass. |
|
1159 | 174 |
"/ [c notNil] whileTrue:[ |v| |
84 | 175 |
"/ v := c instVarNames. |
176 |
"/ (v notNil and:[v includes:string]) ifTrue:[ |
|
177 |
"/ ^ string , ' is an instance variable in ' , c name |
|
178 |
"/ ]. |
|
179 |
"/ c := c superclass |
|
180 |
"/ ]. |
|
181 |
"/ self error:'oops' |
|
182 |
"/ ]. |
|
183 |
||
442 | 184 |
"/ "class instvars" |
185 |
"/ variables := aClass class allInstVarNames. |
|
186 |
"/ (variables notNil and:[variables includes:string]) ifTrue:[ |
|
187 |
"/ "where is it" |
|
188 |
"/ c := aClass. |
|
1159 | 189 |
"/ [c notNil] whileTrue:[ |v| |
442 | 190 |
"/ v := c class instVarNames. |
191 |
"/ (v notNil and:[v includes:string]) ifTrue:[ |
|
192 |
"/ ^ string , ' is a class instance variable in ' , c name |
|
193 |
"/ ]. |
|
194 |
"/ c := c superclass |
|
195 |
"/ ]. |
|
196 |
"/ self error:'oops' |
|
197 |
"/ ]. |
|
2 | 198 |
|
199 |
"classvars" |
|
200 |
c := parser inWhichClassIsClassVar:string. |
|
201 |
c notNil ifTrue:[ |
|
1233 | 202 |
clsName := c name. |
1198 | 203 |
shortText ifTrue:[ |
1289 | 204 |
stringText := stringText , ' is a classVar in ' , clsName |
205 |
] ifFalse:[ |
|
206 |
stringText := stringText , ' is a class variable in ' , clsName |
|
1198 | 207 |
]. |
1289 | 208 |
val := Smalltalk at:(clsName , ':' , string) asSymbol. |
209 |
(val isBoolean or:[val isNil or:[val isSymbol]]) ifTrue:[ |
|
210 |
valString := val storeString. |
|
211 |
] ifFalse:[ |
|
212 |
valString := val classNameWithArticle. |
|
213 |
]. |
|
214 |
^ stringText , ' (' , valString , ').' |
|
2 | 215 |
]. |
216 |
||
1210
e3174ccbb5bb
isMeta/soleInstance -> theMetaclass / theNonMetaclass
Claus Gittinger <cg@exept.de>
parents:
1198
diff
changeset
|
217 |
c := aClass theNonMetaclass. |
509
d8475399ca3e
Correct handling of private classes.
Stefan Vogel <sv@exept.de>
parents:
503
diff
changeset
|
218 |
c privateClasses do:[:pClass | |
d8475399ca3e
Correct handling of private classes.
Stefan Vogel <sv@exept.de>
parents:
503
diff
changeset
|
219 |
(pClass name = string |
d8475399ca3e
Correct handling of private classes.
Stefan Vogel <sv@exept.de>
parents:
503
diff
changeset
|
220 |
or:[pClass nameWithoutPrefix = string]) ifTrue:[ |
1233 | 221 |
string := stringText , ' is a private class in ''' , c name , '''.'. |
222 |
shortText ifFalse:[ |
|
1183 | 223 |
string := (string , '\\It is only visible locally.') withCRs |
224 |
]. |
|
225 |
^ string withCRs |
|
422 | 226 |
]. |
227 |
]. |
|
228 |
||
456 | 229 |
(spc := aClass nameSpace) notNil ifTrue:[ |
796 | 230 |
sym := (spc name , '::' , string) asSymbolIfInterned. |
231 |
sym notNil ifTrue:[ |
|
232 |
(Smalltalk at:sym) isBehavior ifTrue:[ |
|
1233 | 233 |
string := stringText , ' is a class in the ''' , spc name , ''' nameSpace.'. |
1183 | 234 |
shortText ifFalse:[ |
235 |
string := (string |
|
796 | 236 |
, '\\It is only visible within this nameSpace.' |
237 |
, '\Access from the outside is possible' |
|
238 |
, '\by the special name ''' , spc name , '::' , string , '''.') withCRs |
|
1183 | 239 |
]. |
240 |
^ string withCRs |
|
796 | 241 |
]. |
422 | 242 |
]. |
243 |
]. |
|
244 |
||
796 | 245 |
"/ string knownAsSymbol ifTrue:[ |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
246 |
"globals & symbols" |
2 | 247 |
|
1183 | 248 |
tmp := self explainKnownSymbol:string inClass:aClass short:shortText. |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
249 |
tmp notNil ifTrue:[ ^ tmp]. |
839 | 250 |
|
251 |
"/ try with added colon ... |
|
252 |
sel := string , ':'. |
|
253 |
Symbol allInstancesDo:[:sym | |
|
254 |
(sym startsWith:sel) ifTrue:[ |
|
1183 | 255 |
tmp := self explainKnownSymbol:sym inClass:aClass short:shortText. |
839 | 256 |
tmp notNil ifTrue:[ ^ tmp]. |
257 |
] |
|
258 |
]. |
|
796 | 259 |
"/ ]. |
2 | 260 |
|
261 |
"try for some obvious things" |
|
1183 | 262 |
tmp := self explainPseudoVariable:string in:aClass short:true. |
2 | 263 |
tmp notNil ifTrue:[ ^ tmp]. |
264 |
||
265 |
"try syntax ..." |
|
266 |
||
1183 | 267 |
tmp := self explainSyntax:string short:shortText. |
49 | 268 |
tmp notNil ifTrue:[ ^ tmp]. |
20 | 269 |
|
1183 | 270 |
shortText ifTrue:[ |
271 |
^ '' |
|
272 |
]. |
|
273 |
||
2 | 274 |
parser isNil ifTrue:[ |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
275 |
^ 'parse error - no explanation' |
2 | 276 |
]. |
796 | 277 |
^ 'cannot explain this (could not figure out what this is).' |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
278 |
|
675 | 279 |
"Created: / 3.12.1995 / 12:47:37 / cg" |
280 |
"Modified: / 16.4.1997 / 12:46:11 / stefan" |
|
1211
91e94e294819
isMeta/soleInstance -> theMetaclass / theNonMetaclass
Claus Gittinger <cg@exept.de>
parents:
1210
diff
changeset
|
281 |
"Modified: / 5.11.2001 / 16:54:23 / cg" |
2 | 282 |
! |
283 |
||
1188 | 284 |
explainGlobal:string inClass:aClass short:shortText |
1183 | 285 |
"return explanation or nil" |
286 |
||
1245 | 287 |
|sym stringText tmp val classCategory| |
141 | 288 |
|
1245 | 289 |
"if not even known as key, its definitely not a global" |
290 |
sym := string asSymbolIfInterned. |
|
796 | 291 |
sym isNil ifTrue:[^ nil]. |
141 | 292 |
|
293 |
"try globals" |
|
1245 | 294 |
(Smalltalk includesKey:sym) ifFalse:[ ^ nil]. |
141 | 295 |
|
1198 | 296 |
stringText := string allBold. |
297 |
||
1245 | 298 |
"/ stringText := '''' , stringText , ''''. |
299 |
tmp := stringText , ' is a global variable.'. |
|
1183 | 300 |
|
1245 | 301 |
val := Smalltalk at:sym. |
302 |
val isBehavior ifTrue:[ |
|
303 |
"/ a class |
|
1331 | 304 |
val isNameSpace ifTrue:[ |
1330 | 305 |
^ stringText , ' is a namespace.' |
306 |
]. |
|
307 |
||
308 |
classCategory := val category ? 'uncategorized'. |
|
1245 | 309 |
shortText ifTrue:[ |
310 |
^ stringText , ' is ' , (val isLoaded ifTrue:['a'] ifFalse:['an autoloaded']) |
|
311 |
, ' class in the ''' , classCategory , ''' category.'. |
|
312 |
]. |
|
313 |
||
314 |
val name = string ifTrue:[ |
|
1183 | 315 |
tmp := tmp , ' |
1245 | 316 |
' , string , ' is ' , (val isLoaded ifTrue:['a'] ifFalse:['an autoloaded']) |
317 |
, ' class categorized as ' , classCategory , ' |
|
318 |
in the ''' , val package , ''' package.'. |
|
1183 | 319 |
^ tmp. |
320 |
]. |
|
141 | 321 |
|
1183 | 322 |
tmp := tmp , ' |
323 |
||
1245 | 324 |
' , string , ' is bound to the class ' , val name , |
325 |
' in the ''' , classCategory , ''' category.'. |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
326 |
^ tmp. |
141 | 327 |
]. |
328 |
||
1245 | 329 |
shortText ifTrue:[ |
330 |
^ stringText , ' is a global, currently bound to ''' , val classNameWithArticle , '''.'. |
|
331 |
]. |
|
332 |
tmp := tmp , ' |
|
333 |
||
334 |
Its current value is ''' , val classNameWithArticle , '''.'. |
|
335 |
^ tmp. |
|
1188 | 336 |
! |
337 |
||
338 |
explainHereIn:aClass |
|
339 |
^ 'like self, here refers to the object which received the message. |
|
340 |
||
341 |
However, when sending a message to here the search for methods |
|
342 |
implementing this message will start in the defining class (' , aClass name , ') |
|
343 |
instead of the receivers class (' , aClass name , ' or subclass). |
|
344 |
Thus, using here, redefined methods will NOT be reached with a here-send.' |
|
345 |
! |
|
346 |
||
347 |
explainKnownSymbol:string inClass:aClass |
|
348 |
"return explanation or nil" |
|
349 |
||
350 |
^ self explainKnownSymbol:string inClass:aClass short:false |
|
351 |
! |
|
352 |
||
353 |
explainKnownSymbol:string inClass:aClass short:shortText |
|
354 |
"return explanation or nil" |
|
355 |
||
356 |
|sym| |
|
357 |
||
358 |
sym := string asSymbolIfInterned. |
|
359 |
sym isNil ifTrue:[^ nil]. |
|
360 |
||
361 |
"try globals" |
|
362 |
||
363 |
(Smalltalk includesKey:sym) ifTrue:[ |
|
364 |
^ self explainGlobal:string inClass:aClass short:shortText |
|
365 |
]. |
|
366 |
||
367 |
^ self explainSelector:string inClass:aClass short:shortText |
|
368 |
! |
|
369 |
||
370 |
explainPseudoVariable:string in:aClass |
|
371 |
"return explanation for the pseudoVariables self, super etc." |
|
372 |
||
373 |
^ self explainPseudoVariable:string in:aClass short:false |
|
374 |
! |
|
375 |
||
376 |
explainPseudoVariable:string in:aClass short:shortText |
|
377 |
"return explanation for the pseudoVariables self, super etc." |
|
378 |
||
379 |
(string = 'self') ifTrue:[ |
|
380 |
^ self explainSelfIn:aClass short:shortText |
|
381 |
]. |
|
382 |
||
383 |
(string = 'super') ifTrue:[ |
|
384 |
shortText ifTrue:[ |
|
385 |
^ '''super'' - message lookup starts in superclass ''' , aClass superclass name , '''.' |
|
386 |
]. |
|
387 |
^ self explainSuperIn:aClass short:shortText |
|
388 |
]. |
|
389 |
||
390 |
(string = 'here') ifTrue:[ |
|
391 |
shortText ifTrue:[ |
|
392 |
^ '''here'' - message lookup always starts in ''' , aClass name , '''.' |
|
393 |
]. |
|
394 |
^ self explainHereIn:aClass |
|
395 |
]. |
|
396 |
||
397 |
(string = 'thisContext') ifTrue:[ |
|
398 |
shortText ifTrue:[ |
|
399 |
^ '''thisContext'' - the current stack frame as an object.' |
|
400 |
]. |
|
401 |
^ 'thisContext is a pseudo variable (i.e. it is built in). |
|
402 |
||
403 |
ThisContext always refers to the context object for the currently executed method or |
|
404 |
block (an instance of Context or BlockContext respectively). The calling chain and calling |
|
405 |
receivers/selectors can be accessed via thisContext.' |
|
406 |
]. |
|
407 |
||
408 |
(string = 'true') ifTrue:[ |
|
409 |
shortText ifTrue:[ |
|
410 |
^ '''true'' - the truth and nothing but the truth.' |
|
411 |
]. |
|
412 |
^ 'true is a pseudo variable (i.e. it is built in). |
|
413 |
||
414 |
True represents logical truth. It is the one and only instance of class True.' |
|
415 |
]. |
|
416 |
||
417 |
(string = 'false') ifTrue:[ |
|
418 |
shortText ifTrue:[ |
|
419 |
^ '''false'' - obvisously not true.' |
|
420 |
]. |
|
421 |
^ 'false is a pseudo variable (i.e. it is built in). |
|
422 |
||
423 |
False represents logical falseness. It is the one and only instance of class False.' |
|
424 |
]. |
|
425 |
||
426 |
(string = 'nil') ifTrue:[ |
|
427 |
shortText ifTrue:[ |
|
428 |
^ '''nil'' - undefined, unknown, void or dont care.' |
|
429 |
]. |
|
430 |
^ 'nil is a pseudo variable (i.e. it is built in). |
|
431 |
||
432 |
Nil is used for unitialized variables (among other uses). |
|
433 |
Nil is the one and only instance of class UndefinedObject.' |
|
434 |
]. |
|
435 |
^ nil |
|
436 |
! |
|
437 |
||
438 |
explainSelector:string inClass:aClass short:shortText |
|
439 |
"return explanation or nil" |
|
440 |
||
1352 | 441 |
|sym list count tmp commonSuperClass s s2 |
1188 | 442 |
firstImplementingClass cm msg t| |
443 |
||
444 |
sym := string asSymbolIfInterned. |
|
445 |
sym isNil ifTrue:[^ nil]. |
|
446 |
||
141 | 447 |
" |
448 |
try selectors |
|
449 |
look who implements it |
|
450 |
" |
|
451 |
list := Set new. |
|
1081 | 452 |
Smalltalk allClassesDo:[:c| |
1249
780b4a1a3967
implements -> includesSelector
Claus Gittinger <cg@exept.de>
parents:
1245
diff
changeset
|
453 |
(c includesSelector:sym) ifTrue:[ |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
454 |
list add:(c name). |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
455 |
firstImplementingClass isNil ifTrue:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
456 |
firstImplementingClass := c |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
457 |
] |
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
458 |
]. |
1249
780b4a1a3967
implements -> includesSelector
Claus Gittinger <cg@exept.de>
parents:
1245
diff
changeset
|
459 |
(c class includesSelector:sym) ifTrue:[ |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
460 |
list add:(c name , ' class'). |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
461 |
firstImplementingClass isNil ifTrue:[ |
912 | 462 |
firstImplementingClass := c class |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
463 |
] |
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
464 |
] |
141 | 465 |
]. |
466 |
||
835 | 467 |
(aClass canUnderstand:sym) ifTrue:[ |
1184 | 468 |
s2 := ('Instances of ''' , aClass name , ''' respond to #') , sym asText allBold , '.'. |
469 |
shortText ifFalse:[ |
|
470 |
s2 := '\\' , s2 |
|
471 |
, '\- inherited from ' withCRs |
|
472 |
, (aClass whichClassImplements:sym) name asText allBold. |
|
473 |
]. |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
474 |
firstImplementingClass := (aClass whichClassImplements:sym) |
835 | 475 |
] ifFalse:[ |
476 |
s2 := ''. |
|
477 |
]. |
|
478 |
||
141 | 479 |
count := list size. |
480 |
(count ~~ 0) ifTrue:[ |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
481 |
" |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
482 |
for up-to 4 implementing classes, |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
483 |
list them |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
484 |
" |
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
485 |
list := list asOrderedCollection sort. |
1185 | 486 |
shortText ifTrue:[ |
487 |
tmp := ' is implemented in '. |
|
488 |
] ifFalse:[ |
|
489 |
tmp := ' is a selector implemented in '. |
|
490 |
]. |
|
835 | 491 |
s := '#' , string asText allBold. |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
492 |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
493 |
(count == 1) ifTrue:[ |
1183 | 494 |
(t := list first) isMeta ifTrue:[ |
495 |
t := 'the ' , t |
|
496 |
]. |
|
1184 | 497 |
msg := s , tmp , t , '.'. |
498 |
shortText ifFalse:[ |
|
499 |
msg := msg , s2. |
|
500 |
] |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
501 |
] ifFalse:[ |
1185 | 502 |
(count == 2) ifTrue:[ |
503 |
msg := s , tmp , (list at:1) , ' and ' , (list at:2) , '.'. |
|
504 |
shortText ifFalse:[ |
|
505 |
msg := msg , s2. |
|
506 |
]. |
|
507 |
] ifFalse:[ |
|
508 |
shortText ifTrue:[ |
|
509 |
msg := s , tmp , count printString , ' classes.'. |
|
510 |
^ msg |
|
511 |
]. |
|
1183 | 512 |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
513 |
(count == 3) ifTrue:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
514 |
msg := s , tmp , ' |
835 | 515 |
' , (list at:1) , ', ' , (list at:2) , ' and ' , (list at:3) , '.' , s2 |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
516 |
] ifFalse:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
517 |
(count == 4) ifTrue:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
518 |
msg := s , tmp , ' |
835 | 519 |
' , (list at:1) , ', ' , (list at:2) , ', ' , (list at:3), ' and ' , (list at:4) , '.' , s2 |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
520 |
] ifFalse:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
521 |
" |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
522 |
if there are more, look for a common |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
523 |
superclass and show it ... |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
524 |
" |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
525 |
commonSuperClass := self commonSuperClassOf:list. |
913 | 526 |
(commonSuperClass ~~ Object |
527 |
and:[commonSuperClass ~~ Behavior |
|
528 |
and:[commonSuperClass ~~ Class |
|
529 |
and:[commonSuperClass ~~ ClassDescription]]]) ifTrue:[ |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
530 |
(list includes:commonSuperClass) ifTrue:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
531 |
msg := s . tmp , count printString , commonSuperClass name |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
532 |
, ' and redefined in ' , (count - 1) printString |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
533 |
, ' subclasses' |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
534 |
, s2. |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
535 |
firstImplementingClass := commonSuperClass |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
536 |
] ifFalse:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
537 |
msg := s , tmp, count printString , ' subclasses of ' , commonSuperClass name , s2 |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
538 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
539 |
] ifFalse:[ |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
540 |
(commonSuperClass == Object |
1249
780b4a1a3967
implements -> includesSelector
Claus Gittinger <cg@exept.de>
parents:
1245
diff
changeset
|
541 |
and:[commonSuperClass includesSelector:sym]) ifTrue:[ |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
542 |
msg := s , tmp , count printString , ' classes. |
834 | 543 |
|
544 |
All objects seem to respond to that message, |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
545 |
since there is an implementation in Object.' , s2. |
141 | 546 |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
547 |
firstImplementingClass := Object |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
548 |
] ifFalse:[ |
913 | 549 |
((commonSuperClass == Behavior |
550 |
or:[commonSuperClass == Class |
|
551 |
or:[commonSuperClass == ClassDescription]]) |
|
1249
780b4a1a3967
implements -> includesSelector
Claus Gittinger <cg@exept.de>
parents:
1245
diff
changeset
|
552 |
and:[commonSuperClass includesSelector:sym]) ifTrue:[ |
913 | 553 |
msg := s , tmp , count printString , ' classes. |
554 |
||
555 |
All classes seem to respond to that message, |
|
556 |
since there is an implementation in ' , commonSuperClass name , '.' , s2. |
|
557 |
||
558 |
firstImplementingClass := commonSuperClass |
|
559 |
] ifFalse:[ |
|
560 |
" |
|
561 |
otherwise just give the number. |
|
562 |
" |
|
563 |
msg := s , tmp , count printString , ' classes.' , s2 |
|
564 |
] |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
565 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
566 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
567 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
568 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
569 |
]. |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
570 |
]. |
1185 | 571 |
shortText ifFalse:[ |
572 |
firstImplementingClass notNil ifTrue:[ |
|
573 |
WindowGroup activeGroup withWaitCursorDo:[ |
|
574 |
cm := firstImplementingClass compiledMethodAt:sym. |
|
575 |
cm notNil ifTrue:[ |
|
576 |
cm := cm methodComment. |
|
577 |
] |
|
578 |
]. |
|
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
579 |
cm notNil ifTrue:[ |
1185 | 580 |
msg := msg , '\\The comment in ' withCRs , firstImplementingClass name allBold , ' is:\' withCRs , cm allItalic. |
911
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
581 |
] |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
582 |
]. |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
583 |
]. |
be6ce6482a7f
extract the methods comment and show it.
Claus Gittinger <cg@exept.de>
parents:
839
diff
changeset
|
584 |
^ msg |
141 | 585 |
]. |
586 |
||
587 |
^ nil |
|
290
d1650b17b9e9
Change the name of a classes Metaclass from e.g. "SmallIntegerclass" to
Stefan Vogel <sv@exept.de>
parents:
263
diff
changeset
|
588 |
|
796 | 589 |
"Modified: / 17.6.1996 / 17:09:30 / stefan" |
835 | 590 |
"Created: / 23.3.1999 / 13:29:33 / cg" |
591 |
"Modified: / 23.3.1999 / 13:40:40 / cg" |
|
141 | 592 |
! |
593 |
||
1183 | 594 |
explainSelfIn:aClass short:shortText |
1244 | 595 |
|sub subNames selfString className nSubClasses| |
1198 | 596 |
|
597 |
selfString := '''' , 'self' allBold , ''''. |
|
6 | 598 |
|
1244 | 599 |
sub := aClass allSubclasses. |
600 |
nSubClasses := sub size. |
|
601 |
||
602 |
aClass isMeta ifTrue:[ |
|
603 |
className := aClass theNonMetaclass name. |
|
604 |
subNames := sub collect:[:c | c theNonMetaclass name]. |
|
605 |
nSubClasses == 0 ifTrue:[ |
|
606 |
shortText ifTrue:[ |
|
607 |
^ selfString , ' - the ''' , className , '''-class.' |
|
608 |
]. |
|
609 |
^ selfString , 'refers to the object which received the message. |
|
610 |
||
611 |
In this case, it will be the ' , className , '-class itself.' |
|
612 |
]. |
|
613 |
||
614 |
shortText ifTrue:[ |
|
615 |
nSubClasses == 1 ifTrue:[ |
|
616 |
^ selfString , ' - the ''' , className , '''- or ''' , subNames first , '''-class.' |
|
617 |
]. |
|
618 |
^ selfString , ' - the ''' , className , '''-class or one of its subclasses.' |
|
619 |
]. |
|
620 |
nSubClasses <= 5 ifTrue:[ |
|
621 |
^ selfString , ' refers to the object which received the message. |
|
622 |
||
623 |
In this case, it will be the ' , className , '-class |
|
624 |
or one of its subclasses: |
|
625 |
||
626 |
' , subNames asStringCollection asString |
|
627 |
]. |
|
628 |
||
629 |
^ selfString , ' refers to the object which received the message. |
|
630 |
||
631 |
In this case, it will be the ' , className , '-class |
|
632 |
or one of its ' , nSubClasses printString , ' subclasses.' |
|
633 |
]. |
|
634 |
||
1256 | 635 |
subNames := aClass allSubclasses collect:[:c | c theNonMetaclass name]. |
1244 | 636 |
className := aClass name. |
637 |
nSubClasses == 0 ifTrue:[ |
|
1183 | 638 |
shortText ifTrue:[ |
1244 | 639 |
^ selfString , ' - an instance of ''' , className , '''.' |
1183 | 640 |
]. |
1198 | 641 |
^ selfString , 'refers to the object which received the message. |
6 | 642 |
|
1244 | 643 |
In this case, it will be an instance of ' , className , '.' |
6 | 644 |
]. |
645 |
||
1183 | 646 |
shortText ifTrue:[ |
1244 | 647 |
nSubClasses == 1 ifTrue:[ |
1256 | 648 |
^ selfString , ' - an instance of ''' , className , ''' or ''' , subNames first , '''.' |
1185 | 649 |
]. |
1244 | 650 |
^ selfString , ' - an instance of ''' , className , ''' or one of its subclasses.' |
1183 | 651 |
]. |
1244 | 652 |
nSubClasses <= 5 ifTrue:[ |
1198 | 653 |
^ selfString , ' refers to the object which received the message. |
6 | 654 |
|
1244 | 655 |
In this case, it will be an instance of ' , className , ' |
6 | 656 |
or one of its subclasses: |
657 |
||
1256 | 658 |
' , subNames asStringCollection asString |
6 | 659 |
]. |
660 |
||
1198 | 661 |
^ selfString , ' refers to the object which received the message. |
6 | 662 |
|
1244 | 663 |
In this case, it will be an instance of ' , className , ' |
664 |
or one of its ' , nSubClasses printString , ' subclasses.' |
|
6 | 665 |
! |
666 |
||
1188 | 667 |
explainSuperIn:aClass short:shortText |
1352 | 668 |
|superName| |
1244 | 669 |
|
670 |
superName := aClass superclass name. |
|
1188 | 671 |
|
672 |
shortText ifTrue:[ |
|
1244 | 673 |
^ '''super'' - message lookup starts in ' , superName , '.' |
1188 | 674 |
]. |
675 |
||
6 | 676 |
^ 'like self, super refers to the object which received the message. |
677 |
||
678 |
However, when sending a message to super the search for methods |
|
1244 | 679 |
implementing this message will start in the superclass (' , superName , ') |
84 | 680 |
instead of the receivers class (' , aClass name , ' or subclass). |
49 | 681 |
Thus, using super, a redefined method can call the original method in its superclass.' |
6 | 682 |
! |
2 | 683 |
|
49 | 684 |
explainSyntax:string |
685 |
"try syntax ...; return explanation or nil" |
|
686 |
||
1183 | 687 |
^ self explainSyntax:string short:false |
688 |
! |
|
689 |
||
690 |
explainSyntax:string short:shortText |
|
691 |
"try syntax ...; return explanation or nil" |
|
692 |
||
49 | 693 |
((string = ':=') or:[string = '_']) ifTrue:[ |
1183 | 694 |
shortText ifTrue:[ |
695 |
^ 'Assign to variable on the left side.'. |
|
696 |
]. |
|
697 |
||
796 | 698 |
^ '<variable> := <expression> |
49 | 699 |
|
834 | 700 |
'':='' and ''_'' (which is left-arrow in some fonts) mean assignment. |
49 | 701 |
The variable is bound to (i.e. points to) the value of <expression>.' |
702 |
]. |
|
703 |
||
704 |
(string = '^') ifTrue:[ |
|
1183 | 705 |
shortText ifTrue:[ |
706 |
^ 'Return value from method.'. |
|
707 |
]. |
|
796 | 708 |
^ '^ <expression> |
49 | 709 |
|
834 | 710 |
returns the value of <expression> as value from the method. |
49 | 711 |
A return from within a block exits the method where the block is defined.' |
712 |
]. |
|
713 |
||
714 |
(string = ';') ifTrue:[ |
|
1183 | 715 |
shortText ifTrue:[ |
716 |
^ 'Cascade expression.'. |
|
717 |
]. |
|
796 | 718 |
^ '<expression> ; selector1 ; .... ; selectorN |
49 | 719 |
|
720 |
a cascade expression; evaluate expression, and send messages |
|
721 |
<selector1> ... <selectorN> to the first expressions receiver. |
|
722 |
Returns the value of the last send. The cascade sends may also have arguments.' |
|
723 |
]. |
|
724 |
||
725 |
(string = '|') ifTrue:[ |
|
1183 | 726 |
shortText ifTrue:[ |
727 |
^ ''. |
|
728 |
]. |
|
796 | 729 |
^ '| locals | or: [:arg | statements] |
49 | 730 |
|
834 | 731 |
''|'' is used to mark a local variable declaration or separates arguments |
49 | 732 |
from the statements in a block. Notice, that in a block-argument declaration |
733 |
these must be prefixed by a colon character. |
|
834 | 734 |
''|'' is also a selector understood by Booleans.' |
49 | 735 |
]. |
736 |
||
737 |
((string startsWith:'(') or:[string endsWith:')']) ifTrue:[ |
|
1183 | 738 |
shortText ifTrue:[ |
739 |
^ ''. |
|
740 |
]. |
|
796 | 741 |
^ '(<expression>) |
49 | 742 |
|
743 |
expression grouping.' |
|
744 |
]. |
|
745 |
||
746 |
((string startsWith:'[') or:[string endsWith:']']) ifTrue:[ |
|
1183 | 747 |
shortText ifTrue:[ |
748 |
^ ''. |
|
749 |
]. |
|
834 | 750 |
^ '[:arg1 .. :argN | statements] |
49 | 751 |
|
752 |
defines a block. |
|
753 |
Blocks represent pieces of executable code. Definition of a block does |
|
754 |
not evaluate it. The block is evaluated by sending it a value/value: |
|
755 |
message. |
|
756 |
Blocks are often passed as arguments to Booleans (i.e. ifTrue:[...]) or |
|
757 |
collections (i.e. do:[...]).' |
|
758 |
]. |
|
759 |
||
760 |
(string = ':') ifTrue:[ |
|
1183 | 761 |
shortText ifTrue:[ |
762 |
^ ''. |
|
763 |
]. |
|
796 | 764 |
^ 'colons have different meaning depending on context: |
49 | 765 |
|
766 |
1) they separate keyword-parts in symbols and keyword-messages as in: |
|
767 |
||
768 |
#at:put: a constant keyword symbol |
|
769 |
||
770 |
rec at:index put:value sends the #at:put: message to rec, |
|
796 | 771 |
passing index and value as arguments. |
49 | 772 |
|
773 |
2) within block-argument declarations as in: |
|
774 |
||
775 |
[:arg1 :arg2 | statements] |
|
834 | 776 |
|
777 |
3) within an identifier, they separate the nameSpace part from |
|
778 |
the name part; as in: |
|
779 |
||
780 |
Smalltalk::Array - the Array class in the Smalltalk nameSpace. |
|
781 |
Foo::Array - the Array class in the Foo nameSpace. |
|
49 | 782 |
' |
783 |
]. |
|
784 |
||
785 |
(string = '.') ifTrue:[ |
|
796 | 786 |
^ 'statement. "<- period here" |
49 | 787 |
statement |
788 |
||
789 |
within a method or block, individual statements are separated by periods. |
|
790 |
' |
|
791 |
]. |
|
792 |
||
793 |
(string startsWith:'#' ) ifTrue:[ |
|
796 | 794 |
(string startsWith:'#(' ) ifTrue:[ |
1183 | 795 |
shortText ifTrue:[ |
796 |
^ 'Array Literal.'. |
|
797 |
]. |
|
796 | 798 |
^ 'is a constant Array. |
49 | 799 |
|
800 |
The elements of a constant Array must be Number-constants, nil, true or false. |
|
801 |
(notice, that not all Smalltalk implementations allow true, false and nil as |
|
802 |
constant-Array elements).' |
|
796 | 803 |
]. |
49 | 804 |
|
796 | 805 |
(string startsWith:'#[') ifTrue:[ |
1183 | 806 |
shortText ifTrue:[ |
807 |
^ 'ByteArray Literal.'. |
|
808 |
]. |
|
796 | 809 |
^ 'is a constant ByteArray. |
49 | 810 |
|
811 |
The elements of a constant ByteArray must be Integer constants in the range |
|
812 |
0 .. 255. |
|
813 |
(notice, that not all Smalltalk implementations support constant ByteArrays).' |
|
796 | 814 |
]. |
49 | 815 |
|
796 | 816 |
(string startsWith:'#''') ifTrue:[ |
1183 | 817 |
shortText ifTrue:[ |
818 |
^ 'Symbol Literal.'. |
|
819 |
]. |
|
796 | 820 |
^ 'is a constant symbol containing non-alphanumeric characters. |
49 | 821 |
|
822 |
Symbols are unique strings, meaning that there exists |
|
823 |
exactly one instance of a given symbol. Therefore symbols can |
|
824 |
be compared using == (identity compare) in addition to = (contents compare). |
|
825 |
Beside this, Symbols behave mostly like Strings. |
|
826 |
||
827 |
Notice, that not all Smalltalk implementations support this kind of symbols.' |
|
796 | 828 |
]. |
49 | 829 |
|
1232 | 830 |
shortText ifTrue:[ |
831 |
^ 'Symbol Literal.'. |
|
832 |
]. |
|
796 | 833 |
^ 'is a symbol. |
49 | 834 |
|
835 |
Symbols are unique strings, meaning that there exists |
|
836 |
exactly one instance of a given symbol. Therefore symbols can |
|
837 |
be compared using == (identity compare) in addition to = (contents compare). |
|
838 |
Beside this, Symbols behave mostly like Strings.' |
|
839 |
]. |
|
840 |
||
841 |
"/ is it a symbol without hash-character ? |
|
842 |
"/ |
|
796 | 843 |
"/ string knownAsSymbol ifTrue:[ |
844 |
"/ ^ 'is nothing, but #' , string , ' is known as a symbol. |
|
845 |
"/ |
|
846 |
"/Symbols are unique strings, meaning that there exists |
|
847 |
"/exactly one instance of a given symbol. Therefore symbols can |
|
848 |
"/be compared using == (identity compare) in addition to = (contents compare). |
|
849 |
"/Beside this, Symbols behave mostly like Strings.' |
|
850 |
"/ ]. |
|
49 | 851 |
|
852 |
^ nil |
|
796 | 853 |
|
854 |
"Modified: / 31.10.1998 / 14:28:58 / cg" |
|
141 | 855 |
! ! |
49 | 856 |
|
396 | 857 |
!Explainer class methodsFor:'documentation'! |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
858 |
|
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
859 |
version |
1352 | 860 |
^ '$Header: /cvs/stx/stx/libcomp/Explainer.st,v 1.58 2002-11-26 16:19:10 stefan Exp $' |
146
3d407ab8ac44
suppress messages on transcript when explaining
Claus Gittinger <cg@exept.de>
parents:
141
diff
changeset
|
861 |
! ! |