From 67010ebc31ce45e6c42d2c31d983f3988bb320e1 Mon Sep 17 00:00:00 2001 From: Kirill Volinsky Date: Wed, 20 Mar 2013 13:04:46 +0000 Subject: added some old plugins git-svn-id: http://svn.miranda-ng.org/main/trunk@4123 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c --- plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h | 291 ++++++++++++++++++++++++ 1 file changed, 291 insertions(+) create mode 100644 plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h (limited to 'plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h') diff --git a/plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h b/plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h new file mode 100644 index 0000000000..b32abf3dc0 --- /dev/null +++ b/plugins/!NotAdopted/WinPopup/sdk/newpluginapi.h @@ -0,0 +1,291 @@ +/* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2008 Miranda ICQ/IM project, +all portions of this codebase are copyrighted to the people +listed in contributors.txt. + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +*/ + +#ifndef M_NEWPLUGINAPI_H__ +#define M_NEWPLUGINAPI_H__ + +#include "m_plugins.h" + +#define PLUGIN_MAKE_VERSION(a,b,c,d) (((((DWORD)(a))&0xFF)<<24)|((((DWORD)(b))&0xFF)<<16)|((((DWORD)(c))&0xFF)<<8)|(((DWORD)(d))&0xFF)) +#define MAXMODULELABELLENGTH 64 + +#if defined( _UNICODE ) + #define UNICODE_AWARE 1 +#else + #define UNICODE_AWARE 0 +#endif + +typedef struct { + int cbSize; + char *shortName; + DWORD version; + char *description; // [TRANSLATED-BY-CORE] + char *author; + char *authorEmail; + char *copyright; + char *homepage; + BYTE flags; // right now the only flag, UNICODE_AWARE, is recognized here + int replacesDefaultModule; //one of the DEFMOD_ constants in m_plugins.h or zero + //if non-zero, this will supress the loading of the specified built-in module + //with the implication that this plugin provides back-end-compatible features +} PLUGININFO; + +/* 0.7+ + New plugin loader implementation +*/ +/* The UUID structure below is used to for plugin UUID's and module type definitions */ +typedef struct _MUUID { + unsigned long a; + unsigned short b; + unsigned short c; + unsigned char d[8]; +} MUUID; + + +/* Used to define the end of the MirandaPluginInterface list */ +#define MIID_LAST {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}} + +/* Replaceable internal modules interface ids */ +#define MIID_HISTORY {0x5ca0cbc1, 0x999a, 0x4ea2, {0x8b, 0x44, 0xf8, 0xf6, 0x7d, 0x7f, 0x8e, 0xbe}} +#define MIID_UIFINDADD {0xb22c528d, 0x6852, 0x48eb, {0xa2, 0x94, 0xe, 0x26, 0xa9, 0x16, 0x12, 0x13}} +#define MIID_UIUSERINFO {0x570b931c, 0x9af8, 0x48f1, {0xad, 0x9f, 0xc4, 0x49, 0x8c, 0x61, 0x8a, 0x77}} +#define MIID_SRURL {0x5192445c, 0xf5e8, 0x46c0, {0x8f, 0x9e, 0x2b, 0x6d, 0x43, 0xe5, 0xc7, 0x53}} +#define MIID_SRAUTH {0x377780b9, 0x2b3b, 0x405b, {0x9f, 0x36, 0xb3, 0xc4, 0x87, 0x8e, 0x6f, 0x33}} +#define MIID_SRAWAY {0x5ab54c76, 0x1b4c, 0x4a00, {0xb4, 0x4, 0x48, 0xcb, 0xea, 0x5f, 0xef, 0xe7}} +#define MIID_SREMAIL {0xd005b5a6, 0x1b66, 0x445a, {0xb6, 0x3, 0x74, 0xd4, 0xd4, 0x55, 0x2d, 0xe2}} +#define MIID_SRFILE {0x989d104d, 0xacb7, 0x4ee0, {0xb9, 0x6d, 0x67, 0xce, 0x46, 0x53, 0xb6, 0x95}} +#define MIID_UIHELP {0xf2d35c3c, 0x861a, 0x4cc3, {0xa7, 0x8f, 0xd1, 0xf7, 0x85, 0x4, 0x41, 0xcb}} +#define MIID_UIHISTORY {0x7f7e3d98, 0xce1f, 0x4962, {0x82, 0x84, 0x96, 0x85, 0x50, 0xf1, 0xd3, 0xd9}} +#define MIID_AUTOAWAY {0x9c87f7dc, 0x3bd7, 0x4983, {0xb7, 0xfb, 0xb8, 0x48, 0xfd, 0xbc, 0x91, 0xf0}} +#define MIID_USERONLINE {0x130829e0, 0x2463, 0x4ff8, {0xbb, 0xc8, 0xce, 0x73, 0xc0, 0x18, 0x84, 0x42}} +#define MIID_IDLE {0x296f9f3b, 0x5b6f, 0x40e5, {0x8f, 0xb0, 0xa6, 0x49, 0x6c, 0x18, 0xbf, 0xa}} +#define MIID_FONTSERVICE {0x56f39112, 0xe37f, 0x4234, {0xa9, 0xe6, 0x7a, 0x81, 0x17, 0x45, 0xc1, 0x75}} +#define MIID_UPDATENOTIFY {0x4e68b12a, 0x6b54, 0x44de, {0x86, 0x37, 0xf1, 0x12, 0xd, 0xb6, 0x81, 0x40}} + +/* Common plugin interfaces (core plugins) */ +#define MIID_DATABASE {0xae77fd33, 0xe484, 0x4dc7, {0x8c, 0xbc, 0x9, 0x9f, 0xed, 0xcc, 0xcf, 0xdd}} +#define MIID_CLIST {0x9d8da8bf, 0x665b, 0x4908, {0x9e, 0x61, 0x9f, 0x75, 0x98, 0xae, 0x33, 0xe}} +#define MIID_CHAT {0x23576a43, 0x3a26, 0x4357, {0x9b, 0x1b, 0x4a, 0x71, 0x9e, 0x42, 0x5d, 0x48}} +#define MIID_SRMM {0x58c7eea6, 0xf9db, 0x4dd9, {0x80, 0x36, 0xae, 0x80, 0x2b, 0xc0, 0x41, 0x4c}} +#define MIID_IMPORT {0x5f3bcad4, 0x75f8, 0x476e, {0xb3, 0x6b, 0x2b, 0x30, 0x70, 0x32, 0x49, 0xc}} +#define MIID_IMGSERVICES {0xf3974915, 0xc9d5, 0x4c87, {0x85, 0x64, 0xa0, 0xeb, 0xf9, 0xd2, 0x5a, 0xa0}} +#define MIID_TESTPLUGIN {0x53b974f4, 0x3c74, 0x4dba, {0x8f, 0xc2, 0x6f, 0x92, 0xfe, 0x1, 0x3b, 0x8c}} + +/* Common plugin interfaces (non-core plugins) */ +#define MIID_VERSIONINFO {0xcfeb6325, 0x334e, 0x4052, {0xa6, 0x45, 0x56, 0x21, 0x93, 0xdf, 0xcc, 0x77}} +#define MIID_FOLDERS {0xcfebec29, 0x39ef, 0x4b62, {0xad, 0x38, 0x9a, 0x65, 0x2c, 0xa3, 0x24, 0xed}} +#define MIID_BIRTHDAYNOTIFY {0xcfba5784, 0x3701, 0x4d83, {0x81, 0x6a, 0x19, 0x9c, 0x00, 0xd4, 0xa6, 0x7a}} +#define MIID_BONSAI {0xcfaae811, 0x30e1, 0x4a4f, {0x87, 0x84, 0x15, 0x3c, 0xcc, 0xb0, 0x03, 0x7a}} +#define MIID_EXCHANGE {0xcfd79a89, 0x9959, 0x4e65, {0xb0, 0x76, 0x41, 0x3f, 0x98, 0xfe, 0x0d, 0x15}} +#define MIID_MIRPY {0xcff91a5c, 0x1786, 0x41c1, {0x88, 0x86, 0x09, 0x4b, 0x14, 0x28, 0x1f, 0x15}} +#define MIID_SERVICESLIST {0xcf4bdf02, 0x5d27, 0x4241, {0x99, 0xe5, 0x19, 0x51, 0xaa, 0xb0, 0xc4, 0x54}} +#define MIID_TRANSLATOR {0xcfb637b0, 0x7217, 0x4c1e, {0xb2, 0x2a, 0xd9, 0x22, 0x32, 0x3a, 0x5d, 0x0b}} +#define MIID_TOOLTIPS {0xbcbda043, 0x2716, 0x4404, {0xb0, 0xfa, 0x3d, 0x2d, 0x93, 0x81, 0x9e, 0x3}} +#define MIID_POPUPS {0x33299069, 0x1919, 0x4ff8, {0xb1, 0x31, 0x1d, 0x7, 0x21, 0x78, 0xa7, 0x66}} +#define MIID_LOGWINDOW {0xc53afb90, 0xfa44, 0x4304, {0xbc, 0x9d, 0x6a, 0x84, 0x1c, 0x39, 0x05, 0xf5}} +#define MIID_EVENTNOTIFY {0xF3D7EC5A, 0xF7EF, 0x45DD, {0x8C, 0xA5, 0xB0, 0xF6, 0xBA, 0x18, 0x64, 0x7B}} +#define MIID_SRCONTACTS {0x7CA6050E, 0xBAF7, 0x42D2, {0xB9, 0x36, 0x0D, 0xB9, 0xDF, 0x57, 0x2B, 0x95}} +#define MIID_HISTORYEXPORT {0x18fa2ade, 0xe31b, 0x4b5d, {0x95, 0x3d, 0xa, 0xb2, 0x57, 0x81, 0xc6, 0x4}} + +/* Special exception interface for protocols. + This interface allows more than one plugin to implement it at the same time +*/ +#define MIID_PROTOCOL {0x2a3c815e, 0xa7d9, 0x424b, {0xba, 0x30, 0x2, 0xd0, 0x83, 0x22, 0x90, 0x85}} + +#define MIID_SERVICEMODE {0x8a92c026, 0x953a, 0x4f5f, { 0x99, 0x21, 0xf2, 0xc2, 0xdc, 0x19, 0x5e, 0xc5}} + +/* Each service mode plugin must implement MS_SERVICEMODE_LAUNCH */ +#define MS_SERVICEMODE_LAUNCH "ServiceMode/Launch" + +typedef struct { + int cbSize; + char *shortName; + DWORD version; + char *description; + char *author; + char *authorEmail; + char *copyright; + char *homepage; + BYTE flags; // right now the only flag, UNICODE_AWARE, is recognized here + int replacesDefaultModule; //one of the DEFMOD_ constants in m_plugins.h or zero + //if non-zero, this will supress the loading of the specified built-in module + //with the implication that this plugin provides back-end-compatible features + /*********** WILL BE DEPRECATED in 0.8 * *************/ + MUUID uuid; // Not required until 0.8. +} PLUGININFOEX; + +#ifndef MODULES_H_ + typedef int (*MIRANDAHOOK)(WPARAM,LPARAM); + typedef int (*MIRANDAHOOKPARAM)(WPARAM,LPARAM,LPARAM); + typedef int (*MIRANDAHOOKOBJ)(void*,WPARAM,LPARAM); + typedef int (*MIRANDAHOOKOBJPARAM)(void*,WPARAM,LPARAM,LPARAM); + + typedef INT_PTR (*MIRANDASERVICE)(WPARAM,LPARAM); + typedef INT_PTR (*MIRANDASERVICEPARAM)(WPARAM,LPARAM,LPARAM); + typedef INT_PTR (*MIRANDASERVICEOBJ)(void*,WPARAM,LPARAM); + typedef INT_PTR (*MIRANDASERVICEOBJPARAM)(void*,WPARAM,LPARAM,LPARAM); + +#ifdef _WIN64 + #define CALLSERVICE_NOTFOUND ((INT_PTR)0x8000000000000000) +#else + #define CALLSERVICE_NOTFOUND ((int)0x80000000) +#endif + +#endif + +//see modules.h for what all this stuff is +typedef struct tagPLUGINLINK { + HANDLE (*CreateHookableEvent)(const char *); + int (*DestroyHookableEvent)(HANDLE); + int (*NotifyEventHooks)(HANDLE,WPARAM,LPARAM); + HANDLE (*HookEvent)(const char *,MIRANDAHOOK); + HANDLE (*HookEventMessage)(const char *,HWND,UINT); + int (*UnhookEvent)(HANDLE); + HANDLE (*CreateServiceFunction)(const char *,MIRANDASERVICE); + HANDLE (*CreateTransientServiceFunction)(const char *,MIRANDASERVICE); + int (*DestroyServiceFunction)(HANDLE); + INT_PTR (*CallService)(const char *,WPARAM,LPARAM); + int (*ServiceExists)(const char *); //v0.1.0.1+ + INT_PTR (*CallServiceSync)(const char *,WPARAM,LPARAM); //v0.3.3+ + int (*CallFunctionAsync) (void (__stdcall *)(void *), void *); //v0.3.4+ + int (*SetHookDefaultForHookableEvent) (HANDLE, MIRANDAHOOK); // v0.3.4 (2004/09/15) + HANDLE (*CreateServiceFunctionParam)(const char *,MIRANDASERVICEPARAM,LPARAM); // v0.7+ (2007/04/24) + int (*NotifyEventHooksDirect)(HANDLE,WPARAM,LPARAM); // v0.7+ + #if MIRANDA_VER >= 0x800 + INT_PTR (*CallProtoService)(const char *, const char *, WPARAM, LPARAM ); + INT_PTR (*CallContactService)( HANDLE, const char *, WPARAM, LPARAM ); + HANDLE (*HookEventParam)(const char *,MIRANDAHOOKPARAM,LPARAM); + HANDLE (*HookEventObj)(const char *,MIRANDAHOOKOBJ, void* ); + HANDLE (*HookEventObjParam)(const char *, MIRANDAHOOKOBJPARAM, void*, LPARAM); + HANDLE (*CreateServiceFunctionObj)(const char *,MIRANDASERVICEOBJ,void*); + HANDLE (*CreateServiceFunctionObjParam)(const char *,MIRANDASERVICEOBJPARAM,void*,LPARAM); + void (*KillObjectServices)(void *); + void (*KillObjectEventHooks)(void *); + #endif +} PLUGINLINK; + +#ifndef MODULES_H_ + #ifndef NODEFINEDLINKFUNCTIONS + //relies on a global variable 'pluginLink' in the plugins + extern PLUGINLINK *pluginLink; + #define CreateHookableEvent(a) pluginLink->CreateHookableEvent(a) + #define DestroyHookableEvent(a) pluginLink->DestroyHookableEvent(a) + #define NotifyEventHooks(a,b,c) pluginLink->NotifyEventHooks(a,b,c) + #define HookEventMessage(a,b,c) pluginLink->HookEventMessage(a,b,c) + #define HookEvent(a,b) pluginLink->HookEvent(a,b) + #define UnhookEvent(a) pluginLink->UnhookEvent(a) + #define CreateServiceFunction(a,b) pluginLink->CreateServiceFunction(a,b) + #define CreateTransientServiceFunction(a,b) pluginLink->CreateTransientServiceFunction(a,b) + #define DestroyServiceFunction(a) pluginLink->DestroyServiceFunction(a) + #define CallService(a,b,c) pluginLink->CallService(a,b,c) + #define ServiceExists(a) pluginLink->ServiceExists(a) + #define CallServiceSync(a,b,c) pluginLink->CallServiceSync(a,b,c) + #define CallFunctionAsync(a,b) pluginLink->CallFunctionAsync(a,b) + #define SetHookDefaultForHookableEvent(a,b) pluginLink->SetHookDefaultForHookableEvent(a,b) + #define CreateServiceFunctionParam(a,b,c) pluginLink->CreateServiceFunctionParam(a,b,c) + #define NotifyEventHooksDirect(a,b,c) pluginLink->NotifyEventHooksDirect(a,b,c) + #if MIRANDA_VER >= 0x800 + #define CallProtoService(a,b,c,d) pluginLink->CallProtoService(a,b,c,d) + #define CallContactService(a,b,c,d) pluginLink->CallContactService(a,b,c,d) + #define HookEventParam(a,b,c) pluginLink->HookEventParam(a,b,c) + #define HookEventObj(a,b,c) pluginLink->HookEventObj(a,b,c) + #define HookEventObjParam(a,b,c,d) pluginLink->HookEventObjParam(a,b,c,d) + #define CreateServiceFunctionObj(a,b,c) pluginLink->CreateServiceFunctionObj(a,b,c) + #define CreateServiceFunctionObjParam(a,b,c,d) pluginLink->CreateServiceFunctionObjParam(a,b,c,d) + #define KillObjectServices(a) pluginLink->KillObjectServices(a) + #define KillObjectEventHooks(a) pluginLink->KillObjectEventHooks(a) + #endif + #endif +#endif + +/* + Database plugin stuff +*/ + +// grokHeader() error codes +#define EGROKPRF_NOERROR 0 +#define EGROKPRF_CANTREAD 1 // can't open the profile for reading +#define EGROKPRF_UNKHEADER 2 // header not supported, not a supported profile +#define EGROKPRF_VERNEWER 3 // header correct, version in profile newer than reader/writer +#define EGROKPRF_DAMAGED 4 // header/version fine, other internal data missing, damaged. + +// makeDatabase() error codes +#define EMKPRF_CREATEFAILED 1 // for some reason CreateFile() didnt like something + +typedef struct { + int cbSize; + + /* + returns what the driver can do given the flag + */ + int (*getCapability) ( int flag ); + + /* + buf: pointer to a string buffer + cch: length of buffer + shortName: if true, the driver should return a short but descriptive name, e.g. "3.xx profile" + Affect: The database plugin must return a "friendly name" into buf and not exceed cch bytes, + e.g. "Database driver for 3.xx profiles" + Returns: 0 on success, non zero on failure + */ + int (*getFriendlyName) ( char * buf, size_t cch, int shortName ); + + /* + profile: pointer to a string which contains full path + name + Affect: The database plugin should create the profile, the filepath will not exist at + the time of this call, profile will be C:\..\.dat + Note: Do not prompt the user in anyway about this operation. + Note: Do not initialise internal data structures at this point! + Returns: 0 on success, non zero on failure - error contains extended error information, see EMKPRF_* + */ + int (*makeDatabase) ( char * profile, int * error ); + + /* + profile: [in] a null terminated string to file path of selected profile + error: [in/out] pointer to an int to set with error if any + Affect: Ask the database plugin if it supports the given profile, if it does it will + return 0, if it doesnt return 1, with the error set in error -- EGROKPRF_* can be valid error + condition, most common error would be [EGROKPRF_UNKHEADER] + Note: Just because 1 is returned, doesnt mean the profile is not supported, the profile might be damaged + etc. + Returns: 0 on success, non zero on failure + */ + int (*grokHeader) ( char * profile, int * error ); + + /* + Affect: Tell the database to create all services/hooks that a 3.xx legecy database might support into link, + which is a PLUGINLINK structure + Returns: 0 on success, nonzero on failure + */ + int (*Load) ( char * profile, void * link ); + + /* + Affect: The database plugin should shutdown, unloading things from the core and freeing internal structures + Returns: 0 on success, nonzero on failure + Note: Unload() might be called even if Load() was never called, wasLoaded is set to 1 if Load() was ever called. + */ + int (*Unload) ( int wasLoaded ); + +} DATABASELINK; + +#endif // M_NEWPLUGINAPI_H__ -- cgit v1.2.3