Changeset 1566

Timestamp:

07/31/08 21:19:39 (4 months ago)

Author:

Chuck.Esterbrook

Message:

Added support for omitting "this" and/or EventArgs?() in a "raise" statement.
Also, added warning that "this" is unnecessary and can be removed.
Also, added more error checking.

Location:

cobra/trunk

Files:

• Developer/IntermediateReleaseNotes.text (modified) (1 diff)
• Source/Statements.cobra (modified) (4 diffs)
• Tests/220-delegates-etc/120-events/300-raise.cobra (modified) (2 diffs)
• Tests/220-delegates-etc/120-events/304-raise-protected.cobra (modified) (1 diff)

cobra/trunk/Developer/IntermediateReleaseNotes.text

@@ -3 +3 @@
 * Added a new built-in doc tool accessible via "cobra -doc ...". The documentation is generated to local HTML files using your declarations, doc strings, contracts, etc.
 
-* Added support for declaring and raising events.
+* Added support for declaring and raising events. When raising events, passing "this" is implied (e.g., not required) since that is the normal behavior for events. Also, if the events argument has a default constructor, it too can be omitted.
 
 * Add support for specifying unsigned integers as Hex literals

cobra/trunk/Source/Statements.cobra

@@ -1172 +1172 @@
 
         var _name = ''
+        var _exprs as List<of Expr>
+
+        # computed in _bindImp
+        var _definition as BoxEvent?
         var _eventType as IType?
-        var _exprs as List<of Expr>
-        var _definition as BoxEvent?
+        var _params as List<of Param>?
+        var _args as List<of Expr>?
 
         def init(token as IToken, exprs as List<of Expr>)
@@ -1206 +1210 @@
                                         _definition = defi
                                         _name = defi.name
-                                        _eventType = defi.handlerType           
+                                        _eventType = defi.handlerType
                                 else
                                         .throwError('Expecting an event to raise.')
@@ -1215 +1219 @@
                         else
                                 .throwError('Invalid expression for raising events. Try "raise .someEvent, args" or "throw SomeException(args)".')
+                        if _eventType inherits MethodSig
+                                _params = _eventType.params
+                        else
+                                member = _eventType.memberForName('invoke')
+                                if member inherits Method
+                                        _params = member.params
+                                else
+                                        .throwError('Cannot find a single "invoke" method for "_eventType.name".')
+                        # TODO: check type compatibility of exprs with params
+                        args = _exprs[1:]
+                        params = _params
+                        unThis = 'Unnecessary "this" which is already implied by raising an event. You can remove it.'
+                        if args.count == params.count
+                                if args.count > 0 and args[0] inherits ThisLit
+                                        .compiler.warning(this, unThis)
+                        else if args.count == params.count - 1
+                                # off by one.
+                                if args[0] inherits ThisLit
+                                        .compiler.warning(this, unThis)
+                                        # since we have 'this', try appending the args object
+                                        args.add(_postCallForType(params[params.count-1].type))
+                                else
+                                        # since we don't have 'this', try prepending 'this'
+                                        args.insert(0, ThisLit(.token, .compiler.boxStack.peek).bindImp)
+                        else if args.count == 0 and params.count == 2
+                                # missing both 'this' and event args
+                                args.add(ThisLit(.token, .compiler.boxStack.peek).bindImp)
+                                args.add(_postCallForType(params[params.count-1].type))
+                        else
+                                .throwError('Event expects [params.count] arguments, but the "raise" statement is providing [args.count].')
+                        _args = args
+
+        def _postCallForType(type as IType) as PostCallExpr             
+                inits = type.memberForName('init')
+                if inits inherits Initializer
+                        if inits.params.count <> 0
+                                .throwError('Missing argument for "raise" of type "[type.name]".')
+                        else
+                                token = .token.copy('ID', type.name)
+                                return PostCallExpr(token, TypeExpr(token, type), List<of Expr>()).bindImp
+                else
+                        .throwError('Missing argument for "raise" of type "[type.name]".')
+                throw FallThroughException() # suppress an error
 
         def writeSharpDef(sw as SharpWriter)
@@ -1220 +1267 @@
                 name = Utils.capped(.name)
                 localName = '_lh_event_[.serialNum]'
+                sw.writeLine('// raise [.name] ...')
                 sw.write('{ [_eventType.sharpRef] [localName] = this.[name]; if ([localName]!=null) [localName](')
                 sep = ''
-                # Assuming usual argsList case is 2 args (sender, eventArgs). If have fewer than this
-                # presume the first arg - sender ('this') -  is elided
-                # TODO: need to compare to the actual count of the parameter list instead of assuming this
-                if _exprs.count == 2 
-                        sep = 'this, '
-                for expr in _exprs[1:]
+                for expr in _args
                         sw.write(sep)
                         expr.writeSharpDef(sw, false)
                         sep = ', '
                 sw.write('); }\n')
-                
+
 
 class ReturnStmt

cobra/trunk/Tests/220-delegates-etc/120-events/300-raise.cobra

@@ -5 +5 @@
         event click as ClickHandler
 
-        def receiveMouseClick
+        def receiveMouseClick1
                 # pretend it's always in our bounds and we're enabled
-#               raise .click(this, EventArgs())
-                raise .click, this, EventArgs()
-#               raise .click, EventArgs()
-#               raise .click
-#               raise .click, this
+                raise .click, this, EventArgs()  # .warning. unnecessary "this"
+        
+        def receiveMouseClick2
+                raise .click, EventArgs()
+
+        def receiveMouseClick3
+                raise .click, this  # .warning. unnecessary "this"
+
+        def receiveMouseClick4
+                raise .click
 
 
@@ -18 +23 @@
         shared
 
-                var _didClick = false
+                var _butt as Button
+                var _clickCount = 0
                 
                 def main
-                        butt = Button()
+                        butt = _butt = Button()
+
                         listen butt.click, ref .handleClick
-                        assert not _didClick
-                        butt.receiveMouseClick
-                        assert _didClick
+                        assert .clickCount == 0
+
+                        butt.receiveMouseClick1
+                        assert .clickCount == 1
+
+                        butt.receiveMouseClick2
+                        assert .clickCount == 2
+
+                        butt.receiveMouseClick3
+                        assert .clickCount == 3
+
+                        butt.receiveMouseClick4
+                        assert .clickCount == 4
+
+                get clickCount from var
 
                 def handleClick(sender as Object, args as EventArgs)
-                        _didClick = true
+                        assert sender is _butt
+                        assert (args to dynamic?) inherits EventArgs
+                        _clickCount += 1

cobra/trunk/Tests/220-delegates-etc/120-events/304-raise-protected.cobra

@@ -5 +5 @@
         event _click as ClickHandler
 
-        def addClickHandler( clickhdlr as ClickHandler)
+        def addClickHandler(clickhdlr as ClickHandler)
                 listen _click, clickhdlr
                 
         def _onMouseClick
                 # pretend it's always in our bounds and we're enabled
-#               raise .click(this, EventArgs())
-                raise _click, this, EventArgs()
-#               raise .click, EventArgs()
-#               raise .click
-#               raise .click, this
+                raise _click, EventArgs()
 
         def receiveMouseClick
                 _onMouseClick
+
 
 class Program