1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
|
/*
Copyright (C) 2006 Ricardo Pescuma Domenecci
This is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this file; see the file license.txt. If
not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __M_HISTORYEVENTS_H__
# define __M_HISTORYEVENTS_H__
#define MIID_HISTORYEVENTS { 0xc8be8543, 0x6618, 0x4030, { 0x85, 0xcf, 0x90, 0x82, 0xc7, 0xde, 0x7f, 0xf7 } }
#define HISTORYEVENTS_FORMAT_CHAR 1
#define HISTORYEVENTS_FORMAT_WCHAR 2
#define HISTORYEVENTS_FORMAT_RICH_TEXT 4
#define HISTORYEVENTS_FORMAT_HTML 8
#define HISTORYEVENTS_FLAG_DEFAULT (1 << 0) // Is a miranda core event type
#define HISTORYEVENTS_FLAG_SHOW_IM_SRMM (1 << 1) // If this event has to be shown in srmm dialog
#define HISTORYEVENTS_FLAG_USE_SENT_FLAG (1 << 2) // Means that it can be a sent or received and uses DBEF_SENT to mark that
#define HISTORYEVENTS_FLAG_EXPECT_CONTACT_NAME_BEFORE (1 << 3) // Means that who is drawing this should draw the contact name before the text
#define HISTORYEVENTS_FLAG_ONLY_LOG_IF_SRMM_OPEN (1 << 4) // If this event will be logged only if the message window is open
#define HISTORYEVENTS_FLAG_FLASH_MSG_WINDOW (1 << 5) // If this event will trigger the openning/flashing of the message window
#define HISTORYEVENTS_REGISTERED_IN_ICOLIB (9 << 16) // If the icon is a name already registered in icolib
#define HISTORYEVENTS_FLAG_KEEP_ONE_YEAR (1 << 8) // By default store in db for 1 year
#define HISTORYEVENTS_FLAG_KEEP_SIX_MONTHS (2 << 8) // By default store in db for 6 months
#define HISTORYEVENTS_FLAG_KEEP_ONE_MONTH (3 << 8) // By default store in db for 1 month
#define HISTORYEVENTS_FLAG_KEEP_ONE_WEEK (4 << 8) // By default store in db for 1 week
#define HISTORYEVENTS_FLAG_KEEP_ONE_DAY (5 << 8) // By default store in db for 1 day
#define HISTORYEVENTS_FLAG_KEEP_FOR_SRMM (6 << 8) // By default store in db only enought for message log
#define HISTORYEVENTS_FLAG_KEEP_MAX_TEN (7 << 8) // By default store in db max 10 entries
#define HISTORYEVENTS_FLAG_KEEP_MAX_HUNDRED (8 << 8) // By default store in db for 100 entries
#define HISTORYEVENTS_FLAG_KEEP_DONT (9 << 8) // By default don't store in db (aka ignore it)
// This function must be implemented by subscribers. It must return a pointer or NULL
// to say it can't handle the text
typedef void * (*fGetHistoryEventText)(HANDLE hContact, HANDLE hDbEvent, DBEVENTINFO *dbe, int format);
typedef struct {
int cbSize;
char *module;
char *name; // Internal event name
char *description; // Will be translated. When retrieving it is already translated
WORD eventType; // The event type it can handle
union {
HICON defaultIcon;
char * defaultIconName; // if HISTORYEVENTS_REGISTERED_IN_ICOLIB is set. Always use this one when retrieving
};
int supports; // What kind of return is supported - or of HISTORYEVENTS_FORMAT_*
int flags; // or of HISTORYEVENTS_FLAG_*
fGetHistoryEventText pfGetHistoryEventText; // NULL to use default get text (similar to message, without extra format)
// Aditional data if wants to use add to history services
char **templates; // Each entry is: "Name\nDefault\n%var%\tDescription\n%var%\tDescription\n%var%\tDescription"
int numTemplates;
} HISTORY_EVENT_HANDLER;
/*
Get the number of registered events
wParam: ignored
lParam: ignored
Return: The number of events registered with the plugin
*/
#define MS_HISTORYEVENTS_GET_COUNT "HistoryEvents/GetCount"
/*
Get an event by number or by type.
To retrieve by number, pass -1 as type. To retrieve by type, pass -1 as number.
wParam: (int) event number
lParam: (int) event type
Return: (const HISTORY_EVENT_HANDLER *) if the event exists, NULL otherwise. Don't change the
returned strunc: it is a pointer to the internall struct.
*/
#define MS_HISTORYEVENTS_GET_EVENT "HistoryEvents/GetEvent"
/*
Register a plugin that can handle an event type. This must be called during the call to the
Load function of the plugin. In ModulesLoaded callback all plugins have to be already registered,
so srmm and history modules can query then.
wParam: HISTORY_EVENT_HANDLER *
lParam: ignored
Return: 0 for success
*/
#define MS_HISTORYEVENTS_REGISTER "HistoryEvents/Register"
typedef struct {
int cbSize;
HANDLE hDbEvent;
DBEVENTINFO *dbe; // Optional
int format; // one of HISTORYEVENTS_FORMAT_*
} HISTORY_EVENT_PARAM;
/*
Check if an event can be handled by any subscribers
wParam: WORD - event type
lParam: ignored
Return: BOOL
*/
#define MS_HISTORYEVENTS_CAN_HANDLE "HistoryEvents/CanHandle"
/*
Get the icon for a history event type
wParam: WORD - event type
lParam: ignored
Return: HICON - after use free with MS_HISTORYEVENTS_RELEASE_ICON
*/
#define MS_HISTORYEVENTS_GET_ICON "HistoryEvents/GetIcon"
/*
Get the flags for a history event type
wParam: WORD - event type
lParam: ignored
Return: int - or of HISTORYEVENTS_FLAG_* or -1 if error
*/
#define MS_HISTORYEVENTS_GET_FLAGS "HistoryEvents/GetFlags"
/*
Release the icon for a history event type. This is really just a forward to icolib
wParam: HICON
lParam: ignored
*/
#define MS_HISTORYEVENTS_RELEASE_ICON "Skin2/Icons/ReleaseIcon"
/*
Get the text for a history event type
wParam: HISTORY_EVENT_PARAM *
lParam: ignored
Return: char * or wchar * depending on sent flags. Free with mir_free or MS_HISTORYEVENTS_RELEASE_TEXT
*/
#define MS_HISTORYEVENTS_GET_TEXT "HistoryEvents/GetText"
/*
Release the text for a history event type. Internally is just a call to mir_free
wParam: char * or wchar *
lParam: ignored
*/
#define MS_HISTORYEVENTS_RELEASE_TEXT "HistoryEvents/ReleaseText"
typedef struct {
int cbSize;
HANDLE hContact;
WORD eventType;
int templateNum;
TCHAR **variables;
int numVariables;
PBYTE additionalData;
int additionalDataSize;
int flags; // Flags for the event type
} HISTORY_EVENT_ADD;
/*
Add an registered event to the history. This is a helper service
wParam: HISTORY_EVENT_ADD
lParam: ignored
Return: HANDLE to the db event
*/
#define MS_HISTORYEVENTS_ADD_TO_HISTORY "HistoryEvents/AddToHistory"
/*
Check if a template is enabled
wParam: event type
lParam: template num
Return: TRUE or FALSE
*/
#define MS_HISTORYEVENTS_IS_ENABLED_TEMPLATE "HistoryEvents/IsEnabledTemplate"
// Helper functions //////////////////////////////////////////////////////////////////////////////
static __inline int HistoryEvents_Register(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int supports, int flags, fGetHistoryEventText pfGetHistoryEventText)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.supports = supports;
heh.flags = flags;
heh.pfGetHistoryEventText = pfGetHistoryEventText;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static __inline int HistoryEvents_RegisterWithTemplates(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int supports, int flags, fGetHistoryEventText pfGetHistoryEventText,
char **templates, int numTemplates)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.supports = supports;
heh.flags = flags;
heh.pfGetHistoryEventText = pfGetHistoryEventText;
heh.templates = templates;
heh.numTemplates = numTemplates;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static __inline int HistoryEvents_RegisterMessageStyle(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int flags, char **templates, int numTemplates)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.flags = flags;
heh.templates = templates;
heh.numTemplates = numTemplates;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static __inline BOOL HistoryEvents_CanHandle(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_CAN_HANDLE))
return FALSE;
return (BOOL) CallService(MS_HISTORYEVENTS_CAN_HANDLE, (WPARAM) eventType, 0);
}
static __inline HICON HistoryEvents_GetIcon(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_GET_ICON))
return NULL;
return (HICON) CallService(MS_HISTORYEVENTS_GET_ICON, (WPARAM) eventType, 0);
}
static __inline int HistoryEvents_GetFlags(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_GET_FLAGS))
return -1;
return (int) CallService(MS_HISTORYEVENTS_GET_FLAGS, (WPARAM) eventType, 0);
}
static __inline void HistoryEvents_ReleaseIcon(HICON icon)
{
CallService(MS_HISTORYEVENTS_RELEASE_ICON, (WPARAM) icon, 0);
}
static __inline char * HistoryEvents_GetTextA(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_CHAR;
return (char *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
static __inline wchar_t * HistoryEvents_GetTextW(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_WCHAR;
return (wchar_t *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
static __inline char * HistoryEvents_GetRichText(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_RICH_TEXT;
return (char *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
#define HistoryEvents_ReleaseText mir_free
//static void HistoryEvents_ReleaseText(void *str)
//{
// if (!ServiceExists(MS_HISTORYEVENTS_RELEASE_TEXT))
// return;
//
// CallService(MS_HISTORYEVENTS_RELEASE_TEXT, (WPARAM) str, 0);
//}
static __inline HANDLE HistoryEvents_AddToHistoryEx(HANDLE hContact, WORD eventType, int templateNum,
TCHAR **variables, int numVariables,
PBYTE additionalData, int additionalDataSize,
int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.numVariables = numVariables;
hea.variables = variables;
hea.additionalData = additionalData;
hea.additionalDataSize = additionalDataSize;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static __inline HANDLE HistoryEvents_AddToHistoryVars(HANDLE hContact, WORD eventType, int templateNum,
TCHAR **variables, int numVariables,
int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.numVariables = numVariables;
hea.variables = variables;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static __inline HANDLE HistoryEvents_AddToHistorySimple(HANDLE hContact, WORD eventType, int templateNum, int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static __inline BOOL HistoryEvents_IsEnabledTemplate(WORD eventType, int templateNum)
{
return (BOOL) CallService(MS_HISTORYEVENTS_IS_ENABLED_TEMPLATE, eventType, templateNum);
}
#ifdef UNICODE
# define HistoryEvents_GetTextT HistoryEvents_GetTextW
#else
# define HistoryEvents_GetTextT HistoryEvents_GetTextA
#endif
#endif // __M_HISTORYEVENTS_H__
/*
Copyright (C) 2006 Ricardo Pescuma Domenecci
This is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this file; see the file license.txt. If
not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __M_HISTORYEVENTS_H__
# define __M_HISTORYEVENTS_H__
#define MIID_HISTORYEVENTS { 0xc8be8543, 0x6618, 0x4030, { 0x85, 0xcf, 0x90, 0x82, 0xc7, 0xde, 0x7f, 0xf7 } }
#define HISTORYEVENTS_FORMAT_CHAR 1
#define HISTORYEVENTS_FORMAT_WCHAR 2
#define HISTORYEVENTS_FORMAT_RICH_TEXT 4
#define HISTORYEVENTS_FORMAT_HTML 8
#define HISTORYEVENTS_FLAG_DEFAULT (1 << 0) // Is a miranda core event type
#define HISTORYEVENTS_FLAG_SHOW_IM_SRMM (1 << 1) // If this event has to be shown in srmm dialog
#define HISTORYEVENTS_FLAG_USE_SENT_FLAG (1 << 2) // Means that it can be a sent or received and uses DBEF_SENT to mark that
#define HISTORYEVENTS_FLAG_EXPECT_CONTACT_NAME_BEFORE (1 << 3) // Means that who is drawing this should draw the contact name before the text
#define HISTORYEVENTS_FLAG_ONLY_LOG_IF_SRMM_OPEN (1 << 4) // If this event will be logged only if the message window is open
#define HISTORYEVENTS_REGISTERED_IN_ICOLIB (9 << 16) // If the icon is a name already registered in icolib
#define HISTORYEVENTS_FLAG_KEEP_ONE_YEAR (1 << 8) // By default store in db for 1 year
#define HISTORYEVENTS_FLAG_KEEP_SIX_MONTHS (2 << 8) // By default store in db for 6 months
#define HISTORYEVENTS_FLAG_KEEP_ONE_MONTH (3 << 8) // By default store in db for 1 month
#define HISTORYEVENTS_FLAG_KEEP_ONE_WEEK (4 << 8) // By default store in db for 1 week
#define HISTORYEVENTS_FLAG_KEEP_ONE_DAY (5 << 8) // By default store in db for 1 day
#define HISTORYEVENTS_FLAG_KEEP_FOR_SRMM (6 << 8) // By default store in db only enought for message log
#define HISTORYEVENTS_FLAG_KEEP_MAX_TEN (7 << 8) // By default store in db max 10 entries
#define HISTORYEVENTS_FLAG_KEEP_MAX_HUNDRED (8 << 8) // By default store in db for 100 entries
#define HISTORYEVENTS_FLAG_KEEP_DONT (9 << 8) // By default don't store in db (aka ignore it)
// This function must be implemented by subscribers. It must return a pointer or NULL
// to say it can't handle the text
typedef void * (*fGetHistoryEventText)(HANDLE hContact, HANDLE hDbEvent, DBEVENTINFO *dbe, int format);
typedef struct {
int cbSize;
char *module;
char *name; // Internal event name
char *description; // Will be translated. When retrieving it is already translated
WORD eventType; // The event type it can handle
union {
HICON defaultIcon;
char * defaultIconName; // if HISTORYEVENTS_REGISTERED_IN_ICOLIB is set. Always use this one when retrieving
};
int supports; // What kind of return is supported - or of HISTORYEVENTS_FORMAT_*
int flags; // or of HISTORYEVENTS_FLAG_*
fGetHistoryEventText pfGetHistoryEventText; // NULL to use default get text (similar to message, without extra format)
// Aditional data if wants to use add to history services
char **templates; // Each entry is: "Name\nDefault\n%var%\tDescription\n%var%\tDescription\n%var%\tDescription"
int numTemplates;
} HISTORY_EVENT_HANDLER;
/*
Get the number of registered events
wParam: ignored
lParam: ignored
Return: The number of events registered with the plugin
*/
#define MS_HISTORYEVENTS_GET_COUNT "HistoryEvents/GetCount"
/*
Get an event by number or by type.
To retrieve by number, pass -1 as type. To retrieve by type, pass -1 as number.
wParam: (int) event number
lParam: (int) event type
Return: (const HISTORY_EVENT_HANDLER *) if the event exists, NULL otherwise. Don't change the
returned strunc: it is a pointer to the internall struct.
*/
#define MS_HISTORYEVENTS_GET_EVENT "HistoryEvents/GetEvent"
/*
Register a plugin that can handle an event type. This must be called during the call to the
Load function of the plugin. In ModulesLoaded callback all plugins have to be already registered,
so srmm and history modules can query then.
wParam: HISTORY_EVENT_HANDLER *
lParam: ignored
Return: 0 for success
*/
#define MS_HISTORYEVENTS_REGISTER "HistoryEvents/Register"
typedef struct {
int cbSize;
HANDLE hDbEvent;
DBEVENTINFO *dbe; // Optional
int format; // one of HISTORYEVENTS_FORMAT_*
} HISTORY_EVENT_PARAM;
/*
Check if an event can be handled by any subscribers
wParam: WORD - event type
lParam: ignored
Return: BOOL
*/
#define MS_HISTORYEVENTS_CAN_HANDLE "HistoryEvents/CanHandle"
/*
Get the icon for a history event type
wParam: WORD - event type
lParam: ignored
Return: HICON - after use free with MS_HISTORYEVENTS_RELEASE_ICON
*/
#define MS_HISTORYEVENTS_GET_ICON "HistoryEvents/GetIcon"
/*
Get the flags for a history event type
wParam: WORD - event type
lParam: ignored
Return: int - or of HISTORYEVENTS_FLAG_* or -1 if error
*/
#define MS_HISTORYEVENTS_GET_FLAGS "HistoryEvents/GetFlags"
/*
Release the icon for a history event type. This is really just a forward to icolib
wParam: HICON
lParam: ignored
*/
#define MS_HISTORYEVENTS_RELEASE_ICON "Skin2/Icons/ReleaseIcon"
/*
Get the text for a history event type
wParam: HISTORY_EVENT_PARAM *
lParam: ignored
Return: char * or wchar * depending on sent flags. Free with mir_free or MS_HISTORYEVENTS_RELEASE_TEXT
*/
#define MS_HISTORYEVENTS_GET_TEXT "HistoryEvents/GetText"
/*
Release the text for a history event type. Internally is just a call to mir_free
wParam: char * or wchar *
lParam: ignored
*/
#define MS_HISTORYEVENTS_RELEASE_TEXT "HistoryEvents/ReleaseText"
typedef struct {
int cbSize;
HANDLE hContact;
WORD eventType;
int templateNum;
TCHAR **variables;
int numVariables;
PBYTE additionalData;
int additionalDataSize;
int flags; // Flags for the event type
} HISTORY_EVENT_ADD;
/*
Add an registered event to the history. This is a helper service
wParam: HISTORY_EVENT_ADD
lParam: ignored
Return: HANDLE to the db event
*/
#define MS_HISTORYEVENTS_ADD_TO_HISTORY "HistoryEvents/AddToHistory"
/*
Check if a template is enabled
wParam: event type
lParam: template num
Return: TRUE or FALSE
*/
#define MS_HISTORYEVENTS_IS_ENABLED_TEMPLATE "HistoryEvents/IsEnabledTemplate"
// Helper functions //////////////////////////////////////////////////////////////////////////////
static int HistoryEvents_Register(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int supports, int flags, fGetHistoryEventText pfGetHistoryEventText)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.supports = supports;
heh.flags = flags;
heh.pfGetHistoryEventText = pfGetHistoryEventText;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static int HistoryEvents_RegisterWithTemplates(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int supports, int flags, fGetHistoryEventText pfGetHistoryEventText,
char **templates, int numTemplates)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.supports = supports;
heh.flags = flags;
heh.pfGetHistoryEventText = pfGetHistoryEventText;
heh.templates = templates;
heh.numTemplates = numTemplates;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static int HistoryEvents_RegisterMessageStyle(char *module, char *name, char *description, int eventType, HICON defaultIcon,
int flags, char **templates, int numTemplates)
{
HISTORY_EVENT_HANDLER heh = {0};
if (!ServiceExists(MS_HISTORYEVENTS_REGISTER))
return 1;
heh.cbSize = sizeof(heh);
heh.module = module;
heh.name = name;
heh.description = description;
heh.eventType = eventType;
heh.defaultIcon = defaultIcon;
heh.flags = flags;
heh.templates = templates;
heh.numTemplates = numTemplates;
return CallService(MS_HISTORYEVENTS_REGISTER, (WPARAM) &heh, 0);
}
static BOOL HistoryEvents_CanHandle(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_CAN_HANDLE))
return FALSE;
return (BOOL) CallService(MS_HISTORYEVENTS_CAN_HANDLE, (WPARAM) eventType, 0);
}
static HICON HistoryEvents_GetIcon(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_GET_ICON))
return NULL;
return (HICON) CallService(MS_HISTORYEVENTS_GET_ICON, (WPARAM) eventType, 0);
}
static int HistoryEvents_GetFlags(WORD eventType)
{
if (!ServiceExists(MS_HISTORYEVENTS_GET_FLAGS))
return -1;
return (int) CallService(MS_HISTORYEVENTS_GET_FLAGS, (WPARAM) eventType, 0);
}
static void HistoryEvents_ReleaseIcon(HICON icon)
{
CallService(MS_HISTORYEVENTS_RELEASE_ICON, (WPARAM) icon, 0);
}
static char * HistoryEvents_GetTextA(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_CHAR;
return (char *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
static wchar_t * HistoryEvents_GetTextW(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_WCHAR;
return (wchar_t *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
static char * HistoryEvents_GetRichText(HANDLE hDbEvent, DBEVENTINFO *dbe)
{
HISTORY_EVENT_PARAM hep = {0};
if (!ServiceExists(MS_HISTORYEVENTS_GET_TEXT))
return NULL;
hep.cbSize = sizeof(hep);
hep.hDbEvent = hDbEvent;
hep.dbe = dbe;
hep.format = HISTORYEVENTS_FORMAT_RICH_TEXT;
return (char *) CallService(MS_HISTORYEVENTS_GET_TEXT, (WPARAM) &hep, 0);
}
#define HistoryEvents_ReleaseText mir_free
//static void HistoryEvents_ReleaseText(void *str)
//{
// if (!ServiceExists(MS_HISTORYEVENTS_RELEASE_TEXT))
// return;
//
// CallService(MS_HISTORYEVENTS_RELEASE_TEXT, (WPARAM) str, 0);
//}
static HANDLE HistoryEvents_AddToHistoryEx(HANDLE hContact, WORD eventType, int templateNum,
TCHAR **variables, int numVariables,
PBYTE additionalData, int additionalDataSize,
int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.numVariables = numVariables;
hea.variables = variables;
hea.additionalData = additionalData;
hea.additionalDataSize = additionalDataSize;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static HANDLE HistoryEvents_AddToHistoryVars(HANDLE hContact, WORD eventType, int templateNum,
TCHAR **variables, int numVariables,
int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.numVariables = numVariables;
hea.variables = variables;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static HANDLE HistoryEvents_AddToHistorySimple(HANDLE hContact, WORD eventType, int templateNum, int flags)
{
HISTORY_EVENT_ADD hea = {0};
if (!ServiceExists(MS_HISTORYEVENTS_ADD_TO_HISTORY))
return NULL;
hea.cbSize = sizeof(hea);
hea.hContact = hContact;
hea.eventType = eventType;
hea.templateNum = templateNum;
hea.flags = flags;
return (HANDLE) CallService(MS_HISTORYEVENTS_ADD_TO_HISTORY, (WPARAM) &hea, 0);
}
static BOOL HistoryEvents_IsEnabledTemplate(WORD eventType, int templateNum)
{
return (BOOL) CallService(MS_HISTORYEVENTS_IS_ENABLED_TEMPLATE, eventType, templateNum);
}
#ifdef UNICODE
# define HistoryEvents_GetTextT HistoryEvents_GetTextW
#else
# define HistoryEvents_GetTextT HistoryEvents_GetTextA
#endif
#endif // __M_HISTORYEVENTS_H__
|