jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Renamed new* to init*.

Browse source 
Added example code for documentation.
Fixed a small documentation issue.
Rewrote newEventEmitter...
Updated test.
This commit is contained in:
Amrykid 2011-07-27 18:04:13 -05:00
commit 79dafe08e3
2 changed files with 26 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

31
lib/pure/events.nim
View file

@ -11,11 +11,28 @@
## ##
## This module implements an event system that is not dependant on external ## This module implements an event system that is not dependant on external
## graphical toolkits. It was originally called ``NimEE`` because ## graphical toolkits. It was originally called ``NimEE`` because
## it was inspired by Ptyhon's PyEE module. ## it was inspired by Python's PyEE module. There are two ways you can use events: one is a python-inspired way; the other is more of a C-style way.
## .. code-block:: Nimrod
## var ee = initEventEmitter()
## var genericargs : TEventArgs
## proc handleevent(e : TEventArgs) =
## echo("Handled!")
##
## # Python way
## ee.on("EventName", handleevent)
## ee.emit("EventName", genericargs)
##
## # C/Java way
## # Declare a type
## type
## TSomeObject = object of TObject
## SomeEvent : TEventHandler
## var myobj : TSomeObject
## myobj.SomeEvent = initEventHandler("SomeEvent")
## myobj.SomeEvent.addHandler(handleevent)
## ee.emit(myobj.SomeEvent, genericargs)
type type
TEventArgs* = object of TObject ## Base object for event arguments TEventArgs* = object of TObject ## Base object for event arguments that are passed to callback functions.
## that are passed to callback functions.
TEventHandler* = tuple[name: string, handlers: seq[proc(e:TEventArgs)]] ## An eventhandler for an event. TEventHandler* = tuple[name: string, handlers: seq[proc(e:TEventArgs)]] ## An eventhandler for an event.
type type
@ -23,7 +40,7 @@ type
s: seq[TEventHandler] s: seq[TEventHandler]
EInvalidEvent* = object of EInvalidValue EInvalidEvent* = object of EInvalidValue
proc newEventHandler*(name: string): TEventHandler = proc initEventHandler*(name: string): TEventHandler =
## Initializes an EventHandler with the specified name and returns it. ## Initializes an EventHandler with the specified name and returns it.
#new(result) #new(result)
result.handlers = @[] result.handlers = @[]
@ -73,9 +90,7 @@ proc emit*(emitter: var TEventEmitter, event: string, args: TEventArgs) =
else: else:
raise newException(EInvalidEvent, "invalid event: " & event) raise newException(EInvalidEvent, "invalid event: " & event)
proc newEventEmitter*(): TEventEmitter = proc initEventEmitter*(): TEventEmitter =
## Creates and returns a new EventEmitter. ## Creates and returns a new EventEmitter.
#new(result) #new(result)
var result : TEventEmitter
result.s = @[] result.s = @[]
return result

4
tests/accept/run/tevents.nim
View file

@ -18,7 +18,7 @@ proc handleprintevent2*(e: TEventArgs) =
var args: TPrintEventArgs = TPrintEventArgs(e) var args: TPrintEventArgs = TPrintEventArgs(e)
write(stdout, "HandlePrintEvent2: Output -> printing for " & args.user) write(stdout, "HandlePrintEvent2: Output -> printing for " & args.user)
var ee = newEventEmitter() var ee = initEventEmitter()
var eventargs: TPrintEventArgs var eventargs: TPrintEventArgs
eventargs.user = "ME\n" eventargs.user = "ME\n"
@ -37,7 +37,7 @@ type
PrintEvent: TEventHandler PrintEvent: TEventHandler
var obj: TSomeObject var obj: TSomeObject
obj.PrintEvent = newEventHandler("print") obj.PrintEvent = initEventHandler("print")
obj.PrintEvent.addHandler(handleprintevent2) obj.PrintEvent.addHandler(handleprintevent2)
ee.emit(obj.PrintEvent, eventargs) ee.emit(obj.PrintEvent, eventargs)