|
check out this[^] article, it shows how to do page breaks and lots of other stuff using Word automation (which you have commented out at the top of your button handler)
|
|
|
|
|
After a discussion yesterday I'm playing around with the idea of a Singleton 'Notifier' class that can be subscribed to application wide. To make this more useable by allowing any type to be passed in event args, I figured generics would be a good idea. The genric TEventArgs<T> : EventArgs is set up and working fine
A generic class for the singleton is not possible as then the instance would be tied to a single type so I've got a generic method that in turn calls
protected virtual void OnNotify<T>(TEventArgs<T> e) { }
Because the class itself isn't generic, I can't figure out how to create a generic event
public event EventHandler<TEventArgs<T>> Notification;
as T isn't yet defined of course. Is there a way?
Failing that, is it possible to raise a specific event that has the type hard coded
(e.g. public event EventHandler<TEventArgs<int>> Notification)
based upon the type of T in the OnNotify method and use the e parameter?
I could be barking up the wrong tree here but I'm sure it should be possible!
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
The short answer is you are not allowed to do that.
The long answer would involve looking into how delegates work under the covers. In general, an event declaration get translated into a delegate class member, an add handler function, and a remove handler function (Reflector should be useful in seeing the gory details). This means that for each possible generic argument that you will use to qualify the event, there would need to be a corresponding delegate member and add/remove functions. This is something the compiler will never be able to do. [Except possibly in a few rare circumstances when the only possible way to call and handle the event is entirely contained within the same library (Yes, there are a lot of qualifiers in that statement. That's the point)]
I would have expected the compiler to let you declare an event with a generic signature in a generic class, but that does not seem to work either. I tried something like this:
public class test<T>
{
public event EventHandler<TEventArgs<T>> Notification;
}
and got a compile error. I expected this to work because I thought the compiler would only have to output one delegate that would then be qualified fully when the generic class is given a type argument, but the compiler disagrees.
|
|
|
|
|
public class test<T>
{
public event EventHandler<TEventArgs<T>> Notification;
}That works for me, not sure why it didn't work for you - but is no good for a singleton unfortunately as T can't be 'dynamic'. Maybe what I thought would be a useful tool isn't going to be possible, or at least simply.
Thanks anyway
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
hmm, just tried it again and it's working now. I must have typed something else and didn't copy/paste into the post.
|
|
|
|
|
I think I got a working version of your second idea. The trick was to use event accessors. The type of the value parameter in the Dictionary should be a list - I took a shortcut so it works only for one subscriber per type 
class TEventArgs<T> : EventArgs { public T Value { get; set; } }
class Test
{
Dictionary<Type, object> d = new Dictionary<Type,object>();
public event EventHandler<TEventArgs<int>> MyEvent1
{
add
{
d.Add(typeof(int), value);
}
remove
{
d.Remove(typeof(int));
}
}
public event EventHandler<TEventArgs<string>> MyEvent2
{
add
{
d.Add(typeof(string), value);
}
remove
{
d.Remove(typeof(string));
}
}
public void OnNotify<T>(T t)
{
EventHandler<TEventArgs<T>> del = (EventHandler<TEventArgs<T>> ) d[t.GetType()];
del(this, new TEventArgs<T>() { Value = t });
}
}
static void Main()
{
Test t = new Test();
t.MyEvent1 += new EventHandler<TEventArgs<int>>((sender, args) => Console.WriteLine(args.Value + 1));
t.MyEvent2 += new EventHandler<TEventArgs<string>>((sender, args) => Console.WriteLine(args.Value.Trim()));
t.OnNotify(23);
t.OnNotify("Senthil Rocks ");
The code inside the add and remove accessors is very similar, but the compiler doesn't like if the event declaration has a generic parameter.
|
|
|
|
|
Cool - thanks Senthil, looks good. I'll have a play with it tomorrow. Been coding all night since I got in so I'll be in trouble with the other half if I carry on!  
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
public class TEventArgs< T> : EventArgs<br />
{<br />
public T Value { get; set; }<br />
}<br />
<br />
public static class CoreEventThing<br />
{<br />
private static List< Delegate> handlers = new List< Delegate>();<br />
<br />
public static class TypedEvents< J><br />
{<br />
public static event EventHandler< TEventArgs< J>> Event<br />
{<br />
add { handlers.Add(value); }<br />
remove { handlers.Remove(value); }<br />
}<br />
}<br />
<br />
<br />
public static void Raise< T>(T value)<br />
{<br />
foreach (var d in handlers)<br />
{<br />
if (d is EventHandler< TEventArgs< T>>) <br />
d.DynamicInvoke(null, new TEventArgs< T> {Value = value});<br />
}<br />
}<br />
}<br />
<br />
[STAThread]<br />
public static void Main()<br />
{<br />
CoreEventThing.TypedEvents< int>.Event += ((o, e) => Console.WriteLine(e.Value * 5));<br />
CoreEventThing.TypedEvents< string>.Event += ((o, e) => Console.WriteLine(e.Value));<br />
<br />
CoreEventThing.Raise(5);<br />
CoreEventThing.Raise("Mark rocks more!");<br />
}
|
|
|
|
|
Nice. Couldn't make the leap from (illegal) generic event with unbounded type to static generic inner class. You really do rock more
Have you used this technique before?
|
|
|
|
|
I think the main disadvantage of my technique is that its forced to be static (I can't see an elegant workaround for this in any case). Kinda precludes it from being a component in an IOC scenario. I think my preferred compromise would be just providing a eventerInstance.Subscribe< T>(EventHandler< TEventArgs>> handler) pattern. Pity you can't do generic operator overloading - that would allow the same syntax as delegates.
I wouldn't use this in real code. Closest I've come for simpler things is the command handling and actions in the Composite Application Block, which is mainly for dispatching simple GUI events. If I wanted some serious pub/sub I'd probably end up needing finer differentiation than just event types - so I'd probably be looking at a service bus to handle it.
|
|
|
|
|
Few, perhaps dumb, questions about your idea:
DaveyM69 wrote: any type to be passed in event args
Are the types known to the singleton class or can it be any type, even a class that the singleton isn't aware of?
If the type is known to the singleton, wouldn't this lead to hardcoding the possible types to the singleton implementation thus leading to several different event declarations and subsrciptions (based on type). I understood that this is what you're trying to prevent.
If the type can be unknown, what is it's role in event firing in singleton? Should only those methods be invoked that have subscribed this event with a certain type or is the logic for the type fully in the code that has subscribed the event. If it is the latter, wouldn't it be sufficient to carry the type info in custom eventargs without generics.
|
|
|
|
|
Hi Mika, not dumb questions at all!
Mika Wendelius wrote: can it be any type, even a class that the singleton isn't aware of?
Ideally yes, but using a Singleton, I couldn't find a way of making it work.
Mika Wendelius wrote: If the type is known to the singleton, wouldn't this lead to hardcoding the possible types... this is what you're trying to prevent.
Correct, and correct - hence the question.
Mika Wendelius wrote: wouldn't it be sufficient to carry the type info in custom eventargs without generics
Yes, but I'd have to box/unbox to and from object. I thought it's be nice (if possible) to do it with generics. As you can probably guess, I've not needed/used generics much apart from List<T> so I'm learning as I go a little trying to get this concept to work
I think the only way to do this is to have seperate static instances of each type, instead of one singleton.
To explain more clearly, here's some working code. I've used a winforms app where two forms receive and send notifications. I've used the static Program class to create static instances of Notifier<T> (instead of a singleton) that the notifiction can be done through application wide. Sorry for the long post.
Edit: The code below is improved by creating a GlobalNotifier singleton, and adding the Notifier<T> instance fields and properties to there (instead of Program class) as needed. Still gotta hard code the types somewhere though 
using System;
public class TEventArgs<T> : EventArgs
{
private T m_Value;
public TEventArgs(T value)
{
m_Value = value;
}
public T Value
{
get { return m_Value; }
}
}
using System;
public class Notifier<T>
{
public event EventHandler<TEventArgs<T>> Notification;
public void Notify(T value)
{
OnNotify(new TEventArgs<T>(value));
}
protected virtual void OnNotify(TEventArgs<T> e)
{
EventHandler<TEventArgs<T>> eh = Notification;
if (eh != null)
eh(this, e);
}
}
using System;
using System.Windows.Forms;
static class Program
{
[STAThread]
static void Main()
{
Application.Run(new Form1());
}
private static Notifier<int> intNotifier = new Notifier<int>();
private static Notifier<string> stringNotifier = new Notifier<string>();
public static Notifier<int> IntNotifier
{
get { return intNotifier; }
}
public static Notifier<string> StringNotifier
{
get { return stringNotifier; }
}
}
using System;
using System.Windows.Forms;
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
Form2 frm2 = new Form2();
Program.IntNotifier.Notification += new EventHandler<TEventArgs<int>>(IntNotifier_Notification);
Program.StringNotifier.Notification += new EventHandler<TEventArgs<string>>(StringNotifier_Notification);
Program.IntNotifier.Notify(5);
Program.StringNotifier.Notify("This rocks!");
}
void IntNotifier_Notification(object sender, TEventArgs<int> e)
{
Console.WriteLine(e.Value);
}
void StringNotifier_Notification(object sender, TEventArgs<string> e)
{
Console.WriteLine(e.Value);
}
}
using System;
using System.Windows.Forms;
public partial class Form2 : Form
{
public Form2()
{
InitializeComponent();
Program.IntNotifier.Notification += new EventHandler<TEventArgs<int>>(IntNotifier_Notification);
}
void IntNotifier_Notification(object sender, TEventArgs<int> e)
{
Program.StringNotifier.Notify("Got the integer " + e.Value);
}
}
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
modified on Tuesday, January 13, 2009 5:13 AM
|
|
|
|
|
So far I think the singleton isn't aware of the type anymore. The subsriber is and it subscribes an 'event' based on a type. Also when the 'event' is raised using Notify, the instance is defined for the type. This could be taken furher by adding a reason for an event and that could be delivered to the subscriber or the subscriber could define that it want's only certain event reasons.
static class Program {
[STAThread]
static void Main() {
Application.EnableVisualStyles();
Application.SetCompatibleTextRenderingDefault(false);
int testVariable = 23;
Singleton a = Singleton.Instance;
Tester b = new Tester();
a.Notify(testVariable);
...
}
public delegate void NotifyDelegate<T>(T instance);
public class Tester {
public Tester() {
Singleton.Instance.Subscribe<int>(this.MethodToCall);
}
public void MethodToCall(int value) {
System.Windows.Forms.MessageBox.Show(value.ToString());
}
}
public class Singleton {
private class Subscriber {
private System.Type _type;
private object _notifyDelegate;
internal Subscriber(System.Type type, object notifyDelegate) {
this._type = type;
this._notifyDelegate = notifyDelegate;
}
internal System.Type Type {
get {
return this._type;
}
}
internal NotifyDelegate<T> GetNotifyDelegate<t>() {
return (NotifyDelegate<T> )this._notifyDelegate;
}
}
private static Singleton _instance;
private System.Collections.Generic.List<Subscriber> _subsribers = new List<Subscriber>();
private Singleton() {
_instance = this;
}
public void Subscribe<T>(NotifyDelegate<T> delegateToAdd) {
this._subsribers.Add(new Subscriber(typeof(T), delegateToAdd));
}
public void Notify<T>(T instance) {
foreach (Subscriber item in this._subsribers) {
if (item.Type.Equals(typeof(T))) {
item.GetNotifyDelegate<T>()(instance);
}
}
}
public static Singleton Instance {
get {
if (_instance == null) {
_instance = new Singleton();
}
return _instance;
}
}
}</t>
|
|
|
|
|
Having a busy morning here - will try and look this afternoon or this evening.
Just done a copy and paste so far and the compiler's complaining about the T in:
internal NotifyDelegate<T> GetNotifyDelegate()
Mika Wendelius wrote: I'm really loosing some hair over here
Too late for me... it's already gone!
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
I tried to double check the code, but still the formatting removed parts if the generic definitions. At first it replaced them with emoticons.... The method should be:
internal NotifyDelegate<T > GetNotifyDelegate<T > () {
return (NotifyDelegate<T > )this._notifyDelegate;
}
There are few extra spaces after T and before parenthesis, but if I don't add the the result is
Hopefully it compiles now.
The need to optimize rises from a bad design.My articles[^]
|
|
|
|
|
Yeah, that compiles fine 
It works too! Nice one. I've only scanned it very quickly. I will look in depth tonight to figure out exactly what you're doing and post back.
Thanks for your help Mika. Interesting problem isn't it?
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
It's a problem but I'm not sure if interesting is the correct word 
Just kidding, you're right, it is. I'm trying to figure when and how to use this in different scenarios in real life. Obviously what we're trying to do isn't suitable for every case, but I believe it would have it's place. Most likely in UI scenarios, but I can see some scenarios also in business logic layer even if it resides in separate middle-tier.
|
|
|
|
|
Had a good look at the code you posted. Very good! I've extended it a little so the delegate signature is now (object sender, NotifyEventArgs<T> e) so it's more like a normal event. Only problem with this at the moment is the object calling the Notify method needs to send this like it would in a normal protected virtual void OnEvent method. I might have a look to see if there's some 'magic' way to determine what class called the method.
By using NotifyEventArgs<T> : EventArgs it's easy to extend it so a Reason enum or whatever can be incorporated. I've given it a Value property who's type is set by T so any type can be passed still.
I've still got a bit of work to do - an Unsubscribe method at least, but it's been very helpful and insightful
I might do an article on this. If I do, I'll pass it by you first as I think this should be a co-author thing with the quality of your help/input.
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
DaveyM69 wrote: I've extended it a little so the delegate signature is now (object sender, NotifyEventArgs<t> e)
Yep, I thought of the same, but then I was thinking maybe there should be some other base class for the arguments. For example if we add reason and other enums they could reside in the base class and then the application could extend that to whatever it wants to deliver, complex types, arrays etc.
DaveyM69 wrote: I might have a look to see if there's some 'magic' way to determine what class called the method
I'd be very interested if you find a solution. I've been looking for a way and not found anything reasonable so I implemented a bit different strategy. The only thing I found when investigating was StackFrame, but it had too severe performance penalty. However, it was a long time ago and based on framework 1.1
DaveyM69 wrote: Unsubscribe method at least
That would be handy in most cases along with few other methods
DaveyM69 wrote: I'll pass it by you first as I think this should be a co-author thing with the quality of your help/input
I'd be happy to participate (just brief me how it happens, since never done that before). I must say that the logic for the singleton class isn't what I would do. There's a lot of things to correct, but at the time I was writing it, it was very late in the evening so I decided to do it brute-force.
|
|
|
|
|
Mika Wendelius wrote: I'd be very interested if you find a solution
There doesn't appear to be a way to get the instance that called the method. I can get the Type easily by using the StackTrace but not the actual instance. I'll keep investigating and ask a new question here, but in the meantime I've just overloaded the Notify method so the instance can be passed, and if not the Type is used.
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
I'd say the workaround you used may be sufficient for most of the cases. Do you think there's something in the implementation I could help you with?
|
|
|
|
|
Well there's the base class you mentioned earlier. So far I've just done this.
public enum NotifyReasons
{
Unspecified = 0,
Created,
Updated,
Removed
}
public class NotifyArgs<T>
{
#region Fields
private T m_Value;
private NotifyReasons m_Reason;
#endregion
#region Constructors
public NotifyArgs(T value)
{
m_Value = value;
}
public NotifyArgs(T value, NotifyReasons reason)
{
m_Value = value;
m_Reason = reason;
}
#endregion
#region Properties
public T Value
{
get { return m_Value; }
}
public NotifyReasons Reason
{
get { return m_Reason; }
}
#endregion
}
which is created by this method (all the overloads call this method)
private void Notify<T>(object source, NotifyArgs<T> a)
{
foreach (Subscriber item in m_Subsribers)
if (item.Type.Equals(typeof(T)))
item.GetNotifyDelegate<T>()(source, a);
}
I haven't looked at the best way to implement this so it can be extended by the user and still passed through the notifier...
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
|
|
|
|
|
Sorry for the delay. I was going to answer you sooner, but I fell  while the putting children to sleep
One change I had in mind is that the list base operation is going to be slow. So if we're targeting for 3.5 I'd suggest that we use this kind of approach for notifying the subscribers.
private System.Collections.Generic.HashSet< Subscriber > _subsribers = new HashSet<subscriber>();
...
public void Notify< T >(T instance) {
var subscribers = from item in this._subsribers
where item.Type.Equals(typeof(T))
select item;
foreach (Subscriber subscriber in subscribers) {
subscriber.GetNotifyDelegate< T >()(instance);
}
}</subscriber>
That's based on my version of the singleton so the Notify signature is different from yours but the contents should quite same.
What do you think if we would use another way to communicate? I'm afraid we'll flood the forum at certain point and it's also a bit difficult to change code like this. Perhaps using email so we could transfer the entire projects?
|
|
|
|
|
Mika Wendelius wrote: Perhaps using email so we could transfer the entire projects
I agree.
DaveBTW, in software, hope and pray is not a viable strategy. (Luc Pattyn)Visual Basic is not used by normal people so we're not covering it here. (Uncyclopedia)
modified on Friday, January 16, 2009 7:57 AM
|
|
|
|
|
Okay, I got the address so you can remove it from the post. I'll send you a message in the evening.
|
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
