Class: Annotation

• Inheritance
• Description
• Class protocol
  • finding
  • initialization
  • instance creation
  • instance creation - basic
  • private
• Instance protocol
  • accessing
  • accessing-method
  • accessing-pragma
  • comparing
  • compatibility - squeak
  • initialization
  • printing & storing
  • processing
  • queries
  • testing
• Private classes

Inheritance:

   Object
   |
   +--Annotation
      |
      +--Annotation::JavaScriptSelector
      |
      +--Annotation::NameSpace
      |
      +--Annotation::Resource
      |
      +--Annotation::Unknown
      |
      +--HTTPSimpleJSONRestService::RestCallAnnotation

Package:

stx:libbasic

Category:

Kernel-Extensions

Version:

rev: 1.33 date: 2019/05/28 22:47:07

user: cg

file: Annotation.st directory: libbasic

module: stx stc-classLibrary: libbasic

Description:

I represent an occurrence of a pragma in a compiled method.  

A pragma is a literal message pattern that occurs between angle brackets 
at the start of a method before or after any temporaries.  

A common example is the primitive pragma:
    <primitive: 123 errorCode: 'errorCode'>
but you can add your own and use them as metadata attached to a method.  

Because pragmas are messages one can browse senders and implementors and perform them.  
One can query a method for its pragmas by sending it the pragmas message, which answers an Array of instances of me, 
one for each pragma in the method.
I can provide information about the defining class, method, its selector, 
as well as the information about the pragma keyword and its arguments. See the two 'accessing' protocols for details. 
'accessing-method' provides information about the method the pragma is found in, 
while 'accessing-pragma' is about the pragma itself.
Instances are retrieved using one of the pragma search methods of the 'finding' protocol on the class side.

To browse all methods with pragmas in the system evaluate
        SystemBrowser default browseAllSelect: [:m| m pragmas notEmpty] 
    or: 
        Smalltalk browseAllSelect: [:m| m pragmas notEmpty]

(in Squeak/Pharo): to browse all nonprimitive methods with pragmas evaluate
    SystemBrowser default browseAllSelect: [:m| m primitive isZero and: [m pragmas notEmpty]]

knownPragmas
    context flagging:
        <context: #return>
            tells the compiler that this context will be returned through
            via 'thisContext sender ... sender return' from a lower context.
            The compiler's will create a returnable context
            (i.e. prevent context optimizations/eliminations)

    exception handling:    
        <exception: #handle> 
            marks contexts as exception handlers.

        <exception: #unwind>
            marks contexts which contain unwind actions

        <exception: #raise>
            marks contexts which raise an exception

    misc:        
        <resource: #skipInDebuggersWalkBack>
            will not be shown in the debugger

        <resource: #style (...)>
            affected by style sheet

        <resource: #obsolete>
            marks obsolete methods

        <modifier: #super> 
            must be called if redefined i.e. redefiners MUST do a super-send

        <inspector2Tab>     
        <postLoad>
        <swizzle: selector>

        <category: '...'>
            GNU-smalltalk's way of defining method categories

Class protocol:

 allInMethod: aMethod

VisualWorks compatibility.
Answer a collection of all pragmas found in the given method

 allNamed: aSymbol

Answer a collection of all pragmas found in all methods of all classes whose keyword is aSymbol.

usage example(s):

Annotation allNamed:'worldMenu'

 allNamed: aSymbol from: aSubClass to: aSuperClass

Answer a collection of all pragmas found in methods of all classes
between aSubClass and aSuperClass (inclusive) whose keyword is aSymbol.

 allNamed: aSymbol from: aSubClass to: aSuperClass sortedByArgument: anInteger

Answer a collection of all pragmas found in methods of all classes between aSubClass and aSuperClass (inclusive) whose keyword is aSymbol, sorted according to argument anInteger.

 allNamed: aSymbol from: aSubClass to: aSuperClass sortedUsing: aSortBlock

Answer a collection of all pragmas found in methods of all classes between aSubClass and aSuperClass (inclusive) whose keyword is aSymbol, sorted according to aSortBlock.

 allNamed: aSymbol in: aClass

Answer a collection of all pragmas found in methods of aClass whose keyword is aSymbol.

 allNamed: aSymbol in: aClass sortedByArgument: anInteger

Answer a collection of all pragmas found in methods of aClass whose keyword is aSymbol, sorted according to argument anInteger.

 allNamed: aSymbol in: aClass sortedUsing: aSortBlock

Answer a collection of all pragmas found in methods of aClass whose keyword is aSymbol, sorted according to aSortBlock.

 initialize

Invoked at system start or when the class is dynamically loaded.

 Rest: args
( an extension from the stx:goodies/webServer package )

Used by HTTPRestService to define service call entry methods

 javaScript: aSymbolOrString

 nameSpace: aString

 namespace: aString

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 resource: type

resource method - returns menu, spec or image,
or accesses/uses the viewStyle

 resource: type values: value

resource method - returns menu, spec or image,
or accesses/uses the viewStyle

 for: aMethod selector: aSelector arguments: anArray

Modified (format): / 29-08-2018 / 10:32:45 / Claus Gittinger

 key: key arguments: arguments

cg: do not react on all those methods inherited from Object (such as inline:)

 keyword: aSymbol arguments: anArray

Modified (format): / 29-08-2018 / 10:32:31 / Claus Gittinger

 method: method key: key arguments: arguments

cg: do not react on all those methods inherited from Object (such as inline:)

 withPragmasIn: aClass do: aBlock

Instance protocol:

 arguments

 first

 key

 method

Answer the compiled-method containing the pragma.

 methodClass

Answer the class of the method containing the pragma.

 methodSelector

Answer the selector of the method containing the pragma.
Added to not confuse this with the selector (i.e. key) of the pragma's message pattern.

 selector

Answer the selector of the method containing the pragma.
Do not confuse this with the selector (i.e. key) of the pragma's message pattern.
(use methodSelector, to make this clear)

 argumentAt: anInteger

Answer one of the arguments of the pragma.

 argumentAt: anInteger ifAbsent: exceptionValue

Answer one of the arguments of the pragma or exceptionValue's value if not present.

 argumentCount

Answer the number of arguments in the pragma.

 message

Answer the message of the receiving pragma.

 numArgs

Answer the number of arguments in the pragma.

 analogousCodeTo: anObject

 keyword

 key: keyArg

 key: keyArg arguments: argumentsArg

 setArguments: anArray

 setKeyword: aSymbol

 setMethod: aCompiledMethod

** This method raises an error - it must be redefined in concrete classes **

 printOn: aStream

append a printed representation of the receiver to the argument, aStream

 storeOn: aStream

superclass Annotation says that I am responsible to implement this method

 annotatesClass: aClass

Nothing to do

 annotatesMethod: aMethod

Nothing to do

 installedInMethod: aMethod

called right after being added to a method's annotations.
Can be redefined in concrete annotation classes to do something with the
method or class

 sendTo: anObject

Send the pragma keyword together with its arguments to anObject and answer the result.

 withArgumentsDo: aBlock

Pass the arguments of the receiving pragma into aBlock and answer the result.

 refersToLiteral: anObject

return true if the receiver or recursively any array element in the
receiver refers to aLiteral (i.e. a deep search)

 refersToLiteralMatching: aMatchString

 hasLiteral: aLiteral

 hasLiteralSuchThat: aBlock

Answer true if litBlock returns true for any literal in the receiver, even if embedded in further array structure.
This method is only intended for private use by CompiledMethod hasLiteralSuchThat:

 isJavaScriptSelector

true if this is a (wellknown) javascript selector annotation

 isResource

true if this is a (wellknown) resource annotation

 isUnknown

true if this is a (non-wellknown) other annotation

Private classes:

    JavaScriptSelector
    NameSpace
    Resource
    Unknown