From 48540940b6c28bb4378abfeb500ec45a625b37b6 Mon Sep 17 00:00:00 2001 From: Vadim Dashevskiy Date: Tue, 15 May 2012 10:38:20 +0000 Subject: initial commit git-svn-id: http://svn.miranda-ng.org/main/trunk@2 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c --- include/delphi/README.txt | 92 +++++ include/delphi/m_addcontact.inc | 54 +++ include/delphi/m_api.pas | 75 ++++ include/delphi/m_awaymsg.inc | 40 +++ include/delphi/m_clc.inc | 284 +++++++++++++++ include/delphi/m_clist.inc | 641 +++++++++++++++++++++++++++++++++ include/delphi/m_clui.inc | 215 ++++++++++++ include/delphi/m_contacts.inc | 84 +++++ include/delphi/m_database.inc | 654 ++++++++++++++++++++++++++++++++++ include/delphi/m_email.inc | 39 +++ include/delphi/m_file.inc | 66 ++++ include/delphi/m_findadd.inc | 38 ++ include/delphi/m_globaldefs.pas | 97 +++++ include/delphi/m_helpers.inc | 613 ++++++++++++++++++++++++++++++++ include/delphi/m_history.inc | 37 ++ include/delphi/m_icq.inc | 191 ++++++++++ include/delphi/m_ignore.inc | 74 ++++ include/delphi/m_langpack.inc | 82 +++++ include/delphi/m_message.inc | 57 +++ include/delphi/m_netlib.inc | 713 +++++++++++++++++++++++++++++++++++++ include/delphi/m_options.inc | 109 ++++++ include/delphi/m_plugins.inc | 70 ++++ include/delphi/m_popup.inc | 222 ++++++++++++ include/delphi/m_protocols.inc | 180 ++++++++++ include/delphi/m_protomod.inc | 105 ++++++ include/delphi/m_protosvc.inc | 760 ++++++++++++++++++++++++++++++++++++++++ include/delphi/m_skin.inc | 120 +++++++ include/delphi/m_system.inc | 170 +++++++++ include/delphi/m_url.inc | 39 +++ include/delphi/m_userinfo.inc | 84 +++++ include/delphi/m_utils.inc | 279 +++++++++++++++ include/delphi/newpluginapi.inc | 94 +++++ include/delphi/statusmodes.inc | 54 +++ include/delphi/testdll.dpr | 60 ++++ 34 files changed, 6492 insertions(+) create mode 100644 include/delphi/README.txt create mode 100644 include/delphi/m_addcontact.inc create mode 100644 include/delphi/m_api.pas create mode 100644 include/delphi/m_awaymsg.inc create mode 100644 include/delphi/m_clc.inc create mode 100644 include/delphi/m_clist.inc create mode 100644 include/delphi/m_clui.inc create mode 100644 include/delphi/m_contacts.inc create mode 100644 include/delphi/m_database.inc create mode 100644 include/delphi/m_email.inc create mode 100644 include/delphi/m_file.inc create mode 100644 include/delphi/m_findadd.inc create mode 100644 include/delphi/m_globaldefs.pas create mode 100644 include/delphi/m_helpers.inc create mode 100644 include/delphi/m_history.inc create mode 100644 include/delphi/m_icq.inc create mode 100644 include/delphi/m_ignore.inc create mode 100644 include/delphi/m_langpack.inc create mode 100644 include/delphi/m_message.inc create mode 100644 include/delphi/m_netlib.inc create mode 100644 include/delphi/m_options.inc create mode 100644 include/delphi/m_plugins.inc create mode 100644 include/delphi/m_popup.inc create mode 100644 include/delphi/m_protocols.inc create mode 100644 include/delphi/m_protomod.inc create mode 100644 include/delphi/m_protosvc.inc create mode 100644 include/delphi/m_skin.inc create mode 100644 include/delphi/m_system.inc create mode 100644 include/delphi/m_url.inc create mode 100644 include/delphi/m_userinfo.inc create mode 100644 include/delphi/m_utils.inc create mode 100644 include/delphi/newpluginapi.inc create mode 100644 include/delphi/statusmodes.inc create mode 100644 include/delphi/testdll.dpr (limited to 'include/delphi') diff --git a/include/delphi/README.txt b/include/delphi/README.txt new file mode 100644 index 0000000000..4c0ab5f0cf --- /dev/null +++ b/include/delphi/README.txt @@ -0,0 +1,92 @@ + + - Miranda Module API for Borland Delphi, FreePascal - + + These include files allow you to write modules to extend Miranda + Older versions of these files + limited support for FPC, versions & compilers are : + + Borland Delphi 2.0 thru 6.0 + FreePascal 1.0.4, 1.0.6 + + You can now create modules for Miranda (v0.1.2.2) and use + new stuff like Netlib! though you can still write for + the current stable release (v0.1.2.1) but you'll have to + be aware of version dependant things. + + Worry not though, every service/event is marked with a version + code if it's not present in older Miranda versions. + + Be warned, this is a brand new porting though it has borrowed + from older ports (see CVS, oh this is viewCVS? mmm, cheese.) + Things are presented in a more Delphi esque than a C esque manner + so if you feel confused refer to the C header. + + A word of warning, don't try to compile /delphiplugins examples + with these include files and expect it to work, + + + Include files use the {$include } syntax and will never work + as units. + + -- FPC support? -- + + FPC is now properly supported, but you may need to use -SD -S2 + command line switches (for Delphi, BP7 mode) remember to use -Fi + and -Fu to give the path to these files or use {$UNITPATH} and {$INCLUDEPATH} + + These include files don't any FPC stuff like macros + and inlined functions. + + -- Things to be aware of -- + + This version is not yet directly supported, if you want to learn + the API look at the CVS tree for documentation on plugins, as well + as guidelines and examples of the general structure of Miranda. + + This is my cop out for now, I'll try to write a more general 'guide' later + on. + + - + + Miranda uses a manifest to allow COMCTRL v6 to be loaded on XP, + This causes problems with image lists with Delphi (there are work arounds) + see borland.com for the article. + + You may want to refuse to load on XP or try to use Miranda's API to work with + imagelists and load images from resource as bitmaps (ugh) + + - lstrcat, lstrcpy + + I've used the Windows API calls to these C functions over Delphi's RTL + because SysUtils.pas just adds a bloat. + + - *If* you use SysUtils.pas + + Delphi loads OLE for variant support, it maybe advisable to unload + the DLL as soon as you start, this maybe a problem though, since Miranda + also uses OLE for extended image support, it doesn't however keep + it loaded all the time. + + There should be no problem in just decrementing the reference count + to the DLL and it'll unload if you were the only reference. + + if however you're using variants in your code, blergh. + + -- How you get it to work -- + + see testdll.dpr, it won't do much but it'll show a pretty description in the + options dialog (oh impressive!) + + To bring in new files, just use {$include that_file_you_want.inc} + If other include files are needed by the include file you bring in, + it'll try to include it itself. + + Of course you need to add the path to where the .inc files are to the project's + search path, or if you compile via the command line, use -U and -I + -U is needed because m_globaldefs.pas is a unit. + + Each header file is marked with "UNITDEP" which will tell you which units + it requires. + + All files that require the PLUGINLINK structure require m_globaldefs.pas + (this is all the C header files that use such macros!) diff --git a/include/delphi/m_addcontact.inc b/include/delphi/m_addcontact.inc new file mode 100644 index 0000000000..6bf08e8208 --- /dev/null +++ b/include/delphi/m_addcontact.inc @@ -0,0 +1,54 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_ADDCONTACT} +{$DEFINE M_ADDCONTACT} + +const + + HANDLE_SEARCHRESULT = 0; + HANDLE_EVENT = 1; + HANDLE_CONTACT = 2; + +type + + PADDCONTACTSTRUCT = ^TADDCONTACTSTRUCT; + TADDCONTACTSTRUCT = record + handleType: Integer; + handle: THandle; // HDBEVENT, HCONTACT, SearchResult + szProto: PChar; // used by search result only + psr: Pointer; // @PROTOSEARCHRESULT + end; + +const + + { + wParam : (HWND) Parent window of the dialog that will be presented + lParam : Pointer to an initialised TADDCONTACTSTRUCT + Affect : Open's the add contact dialog + Version: 0.1.2.2+ + } + MS_ADDCONTACT_SHOW = 'AddContact/Show'; + +{$ENDIF} diff --git a/include/delphi/m_api.pas b/include/delphi/m_api.pas new file mode 100644 index 0000000000..412d33e517 --- /dev/null +++ b/include/delphi/m_api.pas @@ -0,0 +1,75 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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. + +*) + +{$IFDEF FPC} + {$PACKRECORDS C} + {$MODE Delphi} +{$ENDIF} + +unit m_api; + +interface + +uses + + m_globaldefs, windows; + + {$include m_plugins.inc} + {$include m_system.inc} + {$include m_database.inc} + {$include m_findadd.inc} + {$include m_awaymsg.inc} + {$include m_email.inc} + {$include m_history.inc} + {$include m_message.inc} + {$include m_url.inc} + {$include newpluginapi.inc} + {$include m_clui.inc} + {$include m_ignore.inc} + {$include m_skin.inc} + {$include m_file.inc} + {$include m_netlib.inc} + {$include m_langpack.inc} + {$include m_clist.inc} + {$include m_clc.inc} + {$include m_userinfo.inc} + {$include m_protosvc.inc} + {$include m_options.inc} + {$include m_icq.inc} + {$include m_protocols.inc} + {$include m_protomod.inc} + {$include m_utils.inc} + {$include m_addcontact.inc} + {$include statusmodes.inc} + {$include m_contacts.inc} + {$define M_API_UNIT} + {$include m_helpers.inc} + +implementation + + {$undef M_API_UNIT} + {$include m_helpers.inc} + +end. + diff --git a/include/delphi/m_awaymsg.inc b/include/delphi/m_awaymsg.inc new file mode 100644 index 0000000000..44be914423 --- /dev/null +++ b/include/delphi/m_awaymsg.inc @@ -0,0 +1,40 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_AWAYMSG} +{$DEFINE M_AWAYMSG} + +const + + { + wParam : HCONTACT + lParam : 0 + Affect : Show the away/na/etc message for a contact + Returns: 0 on success, non zero on failure, see notes + notes : returns without waiting for the message to be shown. + version: v0.1.0.1+ + } + MS_AWAYMSG_SHOWAWAYMSG = 'SRAway/GetMessage'; + +{$ENDIF} diff --git a/include/delphi/m_clc.inc b/include/delphi/m_clc.inc new file mode 100644 index 0000000000..743d8370aa --- /dev/null +++ b/include/delphi/m_clc.inc @@ -0,0 +1,284 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_CLC} +{$DEFINE M_CLC} + +const + + CLISTCONTROL_CLASS = 'CListControl'; + + // styles + + CLS_MANUALUPDATE = $0001; // todo + CLS_SHOWHIDDEN = $0002; + CLS_HIDEOFFLINE = $0004; // hides all offline users + CLS_CHECKBOXES = $0008; + CLS_MULTICOLUMN = $0010; // not true multi-column, just for ignore/vis options + CLS_HIDEEMPTYGROUPS = $0020; // note: this flag will be spontaneously removed if the 'new subgroup' menu item is clicked, for obvious reasons + CLS_USEGROUPS = $0040; + CLS_NOHIDEOFFLINE = $0080; // overrides CLS_HIDEOFFLINE and the per-group hideoffline setting + CLS_GREYALTERNATE = $0100; // make every other line slightly grey + CLS_GROUPCHECKBOXES = $0200; // put checkboxes on groups too (managed by CLC) + + CLS_EX_DISABLEDRAGDROP = $00000001; + CLS_EX_EDITLABELS = $00000002; + CLS_EX_SHOWSELALWAYS = $00000004; + CLS_EX_TRACKSELECT = $00000008; + CLS_EX_SHOWGROUPCOUNTS = $00000010; + CLS_EX_DIVIDERONOFF = $00000020; + CLS_EX_HIDECOUNTSWHENEMPTY = $00000040; + CLS_EX_NOTRANSLUCENTSEL = $00000080; + CLS_EX_LINEWITHGROUPS = $00000100; + CLS_EX_QUICKSEARCHVISONLY = $00000200; + CLS_EX_SORTGROUPSALPHA = $00000400; + CLS_EX_NOSMOOTHSCROLLING = $00000800; + + CLM_FIRST = $1000; // this is the same as LVM_FIRST + CLM_LAST = $1100; + +// messages, compare with equivalent TVM_* in the WINAPI + + CLM_ADDCONTACT = (CLM_FIRST+0); // wParam=hContact + CLM_ADDGROUP = (CLM_FIRST+1); // wParam=hGroup + CLM_AUTOREBUILD = (CLM_FIRST+2); + CLM_DELETEITEM = (CLM_FIRST+3); // wParam=hItem + CLM_EDITLABEL = (CLM_FIRST+4); // wParam=hItem + CLM_ENDEDITLABELNOW = (CLM_FIRST+5); // wParam=cancel, 0 to save + CLM_ENSUREVISIBLE = (CLM_FIRST+6); // wParam=hItem, lParam=partialOk + + CLE_TOGGLE = -1; + CLE_COLLAPSE = 0; + CLE_EXPAND = 1; + CLE_INVALID = $FFFF; + + CLM_EXPAND = (CLM_FIRST+7); // wParam=hItem, lParam=CLE_ + CLM_FINDCONTACT = (CLM_FIRST+8); // wParam=hContact, returns an hItem + CLM_FINDGROUP = (CLM_FIRST+9); // wParam=hGroup, returns an hItem + CLM_GETBKCOLOR = (CLM_FIRST+10); // returns a COLORREF + CLM_GETCHECKMARK = (CLM_FIRST+11); // wParam=hItem, returns 1 or 0 + CLM_GETCOUNT = (CLM_FIRST+12); // returns the total number of items + + CLM_GETEDITCONTROL = (CLM_FIRST+13); // returns the HWND, or NULL + CLM_GETEXPAND = (CLM_FIRST+14); // wParam=hItem, returns a CLE_, CLE_INVALID if not a group + CLM_GETEXTRACOLUMNS = (CLM_FIRST+15); // returns number of extra columns + CLM_GETEXTRAIMAGE = (CLM_FIRST+16); // wParam=hItem, lParam=MAKELPARAM(iColumn (0 based),0), returns iImage or $FF + CLM_GETEXTRAIMAGELIST = (CLM_FIRST+17); // returns HIMAGELIST + CLM_GETFONT = (CLM_FIRST+18); // wParam=fontId, see clm_setfont. returns hFont. + CLM_GETINDENT = (CLM_FIRST+19); // wParam=new group indent + CLM_GETISEARCHSTRING = (CLM_FIRST+20); // lParam=(char*)pszStr, max 120 bytes, returns number of chars in string + CLM_GETITEMTEXT = (CLM_FIRST+21); // wParam=hItem, lParam=(char*)pszStr, max 120 bytes + CLM_GETSCROLLTIME = (CLM_FIRST+22); // returns time in ms + CLM_GETSELECTION = (CLM_FIRST+23); // returns hItem + + CLCHT_ABOVE = $0001; // above client area + CLCHT_BELOW = $0002; // below client area + CLCHT_TOLEFT = $0004; // left of client area + CLCHT_TORIGHT = $0008; // right of client area + CLCHT_NOWHERE = $0010; // in client area, not on an item + CLCHT_ONITEMICON = $0020; + CLCHT_ONITEMCHECK = $0040; + CLCHT_ONITEMLABEL = $0080; + CLCHT_ONITEMINDENT = $0100; // to the left of an item icon + CLCHT_ONITEMEXTRA = $0200; // on an extra icon, HIBYTE(HIWORD()) says which + CLCHT_ONITEM = $03E0; + CLCHT_INLEFTMARGIN = $0400; + CLCHT_BELOWITEMS = $0800; // in client area but below last item + + CLM_HITTEST = (CLM_FIRST+25); // lParam=MAKELPARAM(x,y) (relative to control), wParam=(PDWORD)&hitTest (see encoding of HitTest() in clc.h, can be NULL) returns hItem or NULL + CLM_SELECTITEM = (CLM_FIRST+26); // wParam=hItem + + CLB_TOPLEFT = 0; + CLB_STRETCHV = 1; + CLB_STRETCHH = 2; // and tile vertically + CLB_STRETCH = 3; + + CLBM_TYPE = $00FF; + CLBF_TILEH = $1000; + CLBF_TILEV = $2000; + CLBF_PROPORTIONAL = $4000; + CLBF_SCROLL = $8000; + + CLM_SETBKBITMAP = (CLM_FIRST+27); // wParam=mode, lParam=hBitmap (don't delete it), NULL for none + CLM_SETBKCOLOR = (CLM_FIRST+28); // wParam=a COLORREF, default is GetSysColor(COLOR_3DFACE) + CLM_SETCHECKMARK = (CLM_FIRST+29); // wParam=hItem, lParam=1 or 0 + CLM_SETEXTRACOLUMNS = (CLM_FIRST+30); // wParam=number of extra columns (zero to MAXEXTRACOLUMNS from clc.h, currently 16) + CLM_SETEXTRAIMAGE = (CLM_FIRST+31); // wParam=hItem, lParam=MAKELPARAM(iColumn (0 based),iImage). iImage=$FF is a blank + CLM_SETEXTRAIMAGELIST = (CLM_FIRST+32); // lParam=HIMAGELIST + + FONTID_CONTACTS = 0; + FONTID_INVIS = 1; + FONTID_OFFLINE = 2; + FONTID_NOTONLIST = 3; + FONTID_GROUPS = 4; + FONTID_GROUPCOUNTS = 5; + FONTID_DIVIDERS = 6; + FONTID_OFFINVIS = 7; + FONTID_MAX = 7; + + CLM_SETFONT = (CLM_FIRST+33); // wParam=hFont, lParam=MAKELPARAM(fRedraw,fontId) + CLM_SETINDENT = (CLM_FIRST+34); // wParam=new indent, default is 3 pixels + CLM_SETITEMTEXT = (CLM_FIRST+35); // wParam=hItem, lParam=(char*)pszNewText + CLM_SETSCROLLTIME = (CLM_FIRST+36); // wParam=time in ms, default 200 + CLM_SETHIDEEMPTYGROUPS = (CLM_FIRST+38); // wParam=TRUE/FALSE + + GREYF_UNFOCUS = $80000000; + MODEF_OFFLINE = $40000000; + + // and use the PF2_ #defines from m_protosvc.inc + CLM_SETGREYOUTFLAGS = (CLM_FIRST+39); // wParam=new flags + CLM_GETHIDEOFFLINEROOT = (CLM_FIRST+40); // returns TRUE/FALSE + CLM_SETHIDEOFFLINEROOT = (CLM_FIRST+41); // wParam=TRUE/FALSE + CLM_SETUSEGROUPS = (CLM_FIRST+42); // wParam=TRUE/FALSE + CLM_SETOFFLINEMODES = (CLM_FIRST+43); // for 'hide offline', wParam=PF2_ flags and MODEF_OFFLINE + CLM_GETEXSTYLE = (CLM_FIRST+44); // returns CLS_EX_ flags + CLM_SETEXSTYLE = (CLM_FIRST+45); // wParam=CLS_EX_ flags + CLM_GETLEFTMARGIN = (CLM_FIRST+46); // returns count of pixels + CLM_SETLEFTMARGIN = (CLM_FIRST+47); // wParam=pixels + // the order of info items is never changed, so make sure you add them in the + // order you want them to remain + CLM_ADDINFOITEM = (CLM_FIRST+48); // lParam=&TCLCINFOITEM, returns hItem + CLM_GETITEMTYPE = (CLM_FIRST+49); // wParam=hItem, returns a CLCIT_ + CLM_GETNEXTITEM = (CLM_FIRST+50); // wParam=flag, lParam=hItem, returns an hItem + CLM_GETTEXTCOLOR = (CLM_FIRST+51); // wParam=FONTID_, returns COLORREF + CLM_SETTEXTCOLOR = (CLM_FIRST+52); // wParam=FONTID_, lParam=COLORREF + + CLCIIF_BELOWGROUPS = 1; // put it between groups and contacts, default is at top + CLCIIF_BELOWCONTACTS = 2; // put it at the bottom + CLCIIF_CHECKBOX = $40; // give this item a check box + CLCIIF_GROUPFONT = $80; // draw the item using FONTID_GROUPS + + CLCIT_INVALID = -1; + CLCIT_GROUP = 0; + CLCIT_CONTACT = 1; + CLCIT_DIVIDER = 2; + CLCIT_INFO = 3; + + CLGN_ROOT = 0; + CLGN_CHILD = 1; + CLGN_PARENT = 2; + CLGN_NEXT = 3; + CLGN_PREVIOUS = 4; + CLGN_NEXTCONTACT = 5; + CLGN_PREVIOUSCONTACT = 6; + CLGN_NEXTGROUP = 7; + CLGN_PREVIOUSGROUP = 8; + + CLNF_ISGROUP = 1; + CLNF_ISINFO = 2; + + CLN_FIRST = (0-100); + CLN_EXPANDED = (CLN_FIRST-0); // hItem=hGroup, action=CLE_* + CLN_LISTREBUILT = (CLN_FIRST-1); + CLN_ITEMCHECKED = (CLN_FIRST-2); // todo // hItem,action,flags valid + CLN_DRAGGING = (CLN_FIRST-3); // hItem,pt,flags valid. only sent when cursor outside window, return nonzero if processed + CLN_DROPPED = (CLN_FIRST-4); // hItem,pt,flags valid. only sent when cursor outside window, return nonzero if processed + CLN_LISTSIZECHANGE = (CLN_FIRST-5); // pt.y valid. the vertical height of the visible items in the list has changed. + CLN_OPTIONSCHANGED = (CLN_FIRST-6); // nothing valid. If you set some extended options they have been overwritten and should be re-set + CLN_DRAGSTOP = (CLN_FIRST-7); // hItem,flags valid. sent when cursor goes back in to the window having been outside, return nonzero if processed + CLN_NEWCONTACT = (CLN_FIRST-8); // hItem,flags valid. sent when a new contact is added without a full list rebuild + CLN_CONTACTMOVED = (CLN_FIRST-9); // hItem,flags valid. sent when contact is moved without a full list rebuild + CLN_CHECKCHANGED = (CLN_FIRST-10); // hItem,flags valid. sent when any check mark is changed, but only for one change if there are many + +type + + PCLCINFOITEM = ^TCLCINFOITEM; + TCLCINFOITEM = record + cbSize: int; + pszText: PChar; + hParentGroup: THandle; + flags: DWORD; + hIcon: THandle; // todo + end; + + PNMCLISTCONTROL = ^TNMCLISTCONTROL; + TNMCLISTCONTROL = record + hdr: TNMHDR; // depends on Windows.pas + hItem: THandle; + action: int; + iColumn: int; // -1 if not on an extra column + flags: DWORD; + pt: TPoint; // depends on Windows.pas + end; + + PCLCINFOTIP = ^TCLCINFOTIP; + TCLCINFOTIP = record + cbSize: int; + isTreeFocused: int; // so the plugin can provide an option + isGroup: int; // 0 if it's contact, 1 if it's a group + hItem: THandle; // handle to group or contact + ptCursor: TPoint; + rcItem: TRect; + end; + +const + + { + wParam : 0 + lParam : Pointer to a TCLCINFOTIP structure + Affect : An InfoTip for an item should be shown now, see notes + Returns: [non zero] if you process this, because it makes no sense + for more than one module to process this. + Notes : It's upto the module where to put the InfoTip, Normally + it's a few pixels below and to the right of the cursor. + - + This event is called after the mouse ehas been stationary over + a contact for (by default) 200ms + } + ME_CLC_SHOWINFOTIP = 'CLC/ShowInfoTip'; + + { + wParam : 0 + lParam : Pointer to an initialised TCLCINFOTIP + Affect : It's time to destroy an infotip, see notes + Notes : Only cbSize, isGroup, hItem are set + notes : This is sent when the mouse moves off a contact when ME_CLC_SHOWINFOTIP + has previously been called. + - + If you don't want this behaviour, you should have grabbed the mouse + capture yourself -- + } + ME_CLC_HIDEINFOTIP = 'CLC/HideInfoTip'; + + { + wParam : new_time + lParam : 0 + Affect : Set a new hover time before the info tip hooks are called, see notes + Returns: 0 on success, [non zero] on failure + Notes : The value of this setting is applid to all current CLC windows + and saved to b applied to all future windows, it is persistent. + - + Time is in milliseconds, default is 750ms + } + MS_CLC_SETINFOTIPHOVERTIME = 'CLC/SetInfoTipHoverTime'; + + { + wParam : 0 + lParam : 0 + Affect : get the hover time before the infotip hooks are called + returns: the hover time in MS + } + MS_CLC_GETINFOTIPHOVERTIME = 'CLC/GetInfoTipHoverTime'; + +{$ENDIF} \ No newline at end of file diff --git a/include/delphi/m_clist.inc b/include/delphi/m_clist.inc new file mode 100644 index 0000000000..20a3fb0e29 --- /dev/null +++ b/include/delphi/m_clist.inc @@ -0,0 +1,641 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_CLIST} +{$DEFINE M_CLIST} + +{$ifndef STATUSMODES} + {$include statusmodes.inc} +{$endif} + +const + + // for MS_CLIST_GETSTATUSMODEDESCRIPTION + + GSMDF_PREFIXONLINE = 1; // prefix "Online :" for online submodes, e.g. 'away' + + // for MS_CLIST_ADDMAINMENUITEM + + CMIF_GRAYED = 1; + CMIF_CHECKED = 2; + CMIF_HIDDEN = 4; // only works on contact menus + CMIF_NOTOFFLINE = 8; // item won't appear for contacts that are offline + CMIF_NOTONLINE = 16; // " online + CMIF_NOTONLIST = 32; // item won't appear on standard contacts + CMIF_NOTOFFLIST = 64; // item won't appear on contacts that have the 'NotOnList' setting + + // for MS_CLIST_MODIFYMENUITEM + + CMIM_NAME = $80000000; + CMIM_FLAGS = $40000000; + CMIM_ICON = $20000000; + CMIM_HOTKEY = $10000000; + CMIM_ALL = $F0000000; + + // for MS_CLIST_GETCONTACTDISPLAYNAME + + // will never return the user's custom name, even if that's the one to be displayed + GCDNF_NOMYHANDLE = 1; + + // for MS_CLIST_ADDEVENT + + //flashes the icon even if the user is occupied, and puts the event + // at the top of the queue + CLEF_URGENT = 1; + { icon will not flash forever, only a few times, e.g. online alert } + CLEF_ONLYAFEW = 2; + + // for MS_CLIST_GETICONSIMAGELIST + + IMAGE_GROUPOPEN = 11; + IMAGE_GROUPSHUT = 12; + + // for MS_CLIST_MENUPROCESSCOMMAND + + MPCF_CONTACTMENU = 1; // test commands from a contact menu + MPCF_MAINMENU = 2; // test commands from the main menu + + // for MS_CLIST_GROUPGETNAME/2 + + GROUPF_EXPANDED = $04; + GROUPF_HIDEOFFLINE = $08; + + // + + SETTING_TOOLWINDOW_DEFAULT = 1; + SETTING_SHOWMAINMENU_DEFAULT = 1; + SETTING_SHOWCAPTION_DEFAULT = 1; + SETTING_CLIENTDRAG_DEFAULT = 0; + SETTING_ONTOP_DEFAULT = 1; + SETTING_MIN2TRAY_DEFAULT = 1; + SETTING_TRAY1CLICK_DEFAULT = 0; + SETTING_HIDEOFFLINE_DEFAULT = 0; + SETTING_HIDEEMPTYGROUPS_DEFAULT = 0; + SETTING_USEGROUPS_DEFAULT = 1; + SETTING_SORTBYSTATUS_DEFAULT = 0; + SETTING_TRANSPARENT_DEFAULT = 0; + SETTING_ALPHA_DEFAULT = 200; + SETTING_AUTOALPHA_DEFAULT = 150; + SETTING_CONFIRMDELETE_DEFAULT = 1; + SETTING_AUTOHIDE_DEFAULT = 0; + SETTING_HIDETIME_DEFAULT = 30; + SETTING_CYCLETIME_DEFAULT = 4; + SETTING_ALWAYSSTATUS_DEFAULT = 0; + SETTING_ALWAYSMULTI_DEFAULT = 0; + SETTING_TRAYICON_SINGLE = 0; + SETTING_TRAYICON_CYCLE = 1; + SETTING_TRAYICON_MULTI = 2; + SETTING_TRAYICON_DEFAULT = SETTING_TRAYICON_SINGLE; + SETTING_STATE_HIDDEN = 0; + SETTING_STATE_MINIMIZED = 1; + SETTING_STATE_NORMAL = 2; + +type + + PCLISTMENUITEM = ^TCLISTMENUITEM; + TCLISTMENUITEM = record + cbSize: int; // size in bytes of this structure + pszName: PChar; // text of the menu item + flags: DWORD; + position: int; // approx position on the menu, lower numbers go nearer the top + hIcon: THandle; // icon to put by the item, if this was *not* loaded from + // a resource, you can delete it straight after the call + pszService: PChar; // name of the service to call when the service is clicked + pszPopupName: PChar;// name of the popup menu that this item is on, if this + // is NULL the iteem is on the root of the menu + popupPosition: int; // position of the popup menu on the root menu, ignored + // if pszPopupName is NULL(0) or if the popup menu already exists + hotKey: DWORD; // keyboard accelerator, same as lParam of WM_HOTKEY, 0 for none + pszContactOwner: PChar; // contact menus only, the protocol module that owns + // the contacts to which this to which this menu item + // applies, NULL(0) if it applies to all contacts. + // if it applies to multiple but not all protocols + // add multiple menu items or use ME_CLIST_PREBUILDCONTACTMENU + end; + + PCLISTDOUBLECLICKACTION = ^TCLISTDOUBLECLICKACTION; + TCLISTDOUBLECLICKACTION = record + cbSize: int; + pszContactOwner: PChar; // name of the protocol owning the contact or NULL(0) for all + flags: DWORD; // CMIF_NOT flags above + pszService: PChar; // service to call on double click, is called with wParam=hContact, lParam=0 + end; + + PCLISTEVENT = ^TCLISTEVENT; + TCLISTEVENT = record + cbSize: int; // size in bytes + hContact: THandle; // handle to the contact to put the icon by + hIcon: THandle; // icon to flash! + flags: DWORD; + hDBEvent: THandle; // caller defined, but should be unique for hContact + lParam: LPARAM; + pszService: PChar; // name of service to call on activation + pszTooltip: PChar; // short description of the event to display as a tooltip on the systray + end; + +const + + { + wParam : new_status + lParam : 0 + Affect : Sent when the user acks to change their status, see notes + Notes : Also sent due to a MS_CLIST_SETSTATUSMODE + } + ME_CLIST_STATUSMODECHANGE = 'CList/StatusModeChange'; + + { + wParam : new_status + lParam : 0 + Affect : Force a change of status mode, see statusmodes.inc + } + MS_CLIST_SETSTATUSMODE = 'CList/SetStatusMode'; + + { + wParam : 0 + lParam : 0 + Affect : Get the current status mode, see notes + Notes : This is the status, as set by the user, not any protocol specific status + all protocol modules will attempt to conform to this setting at ALL times. + } + MS_CLIST_GETSTATUSMODE = 'CList/GetStatusMode'; + + { + wParam : status_mode + lParam : flags + Affect : Get a textual description of the given status mode + Returns: pointer to a static buffer of the description of the given status mode + or NULL(0) if the mode was unknown. + Version: v0.1.0.1+ + } + MS_CLIST_GETSTATUSMODEDESCRIPTION = 'CList/GetStatusModeDescription'; + + { + wParam : 0 + lParam : Pointer to a initalised TCLISTMENUITEM structure + Affect : Add a new menu item to the main menu, see notes + Returns: A handle to the new MENU item or NULL(0) on failure + Notes : The given TCLISTMENUITEM.pszService in is called when the item + get clicked with : + - + wParam = 0, lParam = hwndContactList + } + MS_CLIST_ADDMAINMENUITEM = 'CList/AddMainMenuItem'; + + { + wParam : 0 + lParam : Pointer to a initalised TCLISTMENUITEM structure + Affect : Add a new item to the user contact menus, see notes + Notes : exactly the same as MS_CLIST_ADDMAINMENUITEM except when an item + is selected, the service gets called with wParam=hContact, + pszContactOwner is obeyed. + - + Popup menus are not supported, pszPopupName and popupPosition + are ignored. If CTRL is held down when right clicking the menu + position numbers will be displayed in brackets afterr the menu item + text, this only works in debug builds! + } + MS_CLIST_ADDCONTACTMENUITEM = 'CList/AddContactMenuItem'; + + { + wParam : HMENUITEM + lParam : Pointer to a initalised TCLISTMENUITEM + Affect : Modify an existing menu item, see notes + Returns: 0 on success, [non zero] on failure + Notes : hMenuItem will have been returned by MS_CLIST_ADD[MAIN]MENUITEM + TCLISTMENUITEM.flags should contain CMIM_* constants (see above) + to mark which fields should be updated, if it's not present, they + can't be updated -- if flags do not exist for a field it can not + be updated. + Version: v0.1.0.1+ + } + MS_CLIST_MODIFYMENUITEM = 'CList/ModifyMenuItem'; + + { + wParam : HCONTACT + lParam : 0 + Affect : the context menu for a contact is about to be built, see notes + Notes : modules should use this to change menu items that are specific + to the contact that has them + Version: v0.1.0.1+ + } + ME_CLIST_PREBUILDCONTACTMENU = 'CList/PreBuildContactMenu'; + + { + wParam : 0 + lParam : Pointer to a initalised TCLISTDOUBLECLICKACTION structure + Affect : Sets the service to call when a contact is double-clicked, see notes + Returns: 0 on success, [non zero] on failure + Notes : in case of conflicts, the first module to have registered + will get the double click, no others will, this service + will return success even for duplicates + - + This service was dropped from development during 0.3.0.0, it is no + longer supported, see ME_CLIST_DOUBLECLICKED + Version: 0.1.2.2+, 0.2.0+ ONLY (not 3.0a) + } + MS_CLIST_SETDOUBLECLICKACTION = 'CList/SetDoubleClickAction'; + + { + wParam : HCONTACT + lParam : + Affect : Register with this event to be notified of a double click on the CList + against a HCONTACT, you will not be notified if there is a pending CList event + that the double click clears, (i.e. flashing icon is presented to be clicked) + Version: 0.3.0.0 + } + ME_CLIST_DOUBLECLICKED = 'CList/DoubleClicked'; + + { + wParam : HCONTACT + lParam : flags + Affect : Gets the string that the contact list will use to represent a contact + Returns: Always a pointer + Notes : Returns a pointer to the name, will always succeed, even if it needs + to return "(Unknown Contact)" + - + this pointer is a statically allocated buffer which will + be overwritten on every call to this service, callers should make + sure that they copy the information before they call it again + Version: v0.1.2.0+, 0.2.0+ ONLY (0.3a supports the contacts module) + } + MS_CLIST_GETCONTACTDISPLAYNAME = 'CList/GetContactDisplayName'; + + { + wParam : 0 + lParam : Pointer to a TCLISTEVENT + Affect : Add's an event to the list + Notes : The service will flash TCLISTEVENT.hIcon, next to the + contact, TCLISTEVENT.hContact + - + pszService is called is called wParam=hwndContactList, + lParam=pointer to a TCLISTEVENT. + - + the TCLISTEVENT data is invalidated after this service returns + so copy anything from it if required. + - + TCLISTEVENT.pszService will also be called if the user + double clicks on the icon, at which point it will be removed + from the contact lists queue automatically. + - + TCLISTEVENT.hContact and TCLISTEVENT.hDBEvent should be unique. + } + MS_CLIST_ADDEVENT = 'CList/AddEvent'; + + { + wParam : HCONTACT + lParam : HDBEVENT + Affect : Remove an event from the contact list queue + Returns: 0 on success, [non zero] on failure + } + MS_CLIST_REMOVEEVENT = 'Clist/RemoveEvent'; + + { + wParam : HCONTACT + lParam : iEvent + Affect : Get the details of an event in the queue, see notes + Returns: A CLISTEVENT* or NULL(0) on failure + Notes : Returns the iEvent'1st/2nd/3rd/nth elemented queried, + e.g. iEvent=0 will get the event that will be returned if the + user double clicks on that HCONTACT + - + Use HCONTACT=NULL, iEvent=0 for example to get the event + the user will get if they double click on the tray. + Version: v0.1.2.1+ + } + MS_CLIST_GETEVENT = 'CList/GetEvent'; + + { + wParam : ControlID + lParam : Pointer to MEASUREITEMSTRUCT struct + Affect : Process a WM_MEASUREITEM message for user context menus, see notes + Notes : just because wParam, lParam is defined here, only pass them + opaquely to this service, as is. + - + This is just to draw icons, if it is not called, the icons + will not be drawn + Version: v0.1.1.0+ + } + MS_CLIST_MENUMEASUREITEM = 'CList/MenuMeasureItem'; + + { + wParam : + lParam : + Affect : Process a WM_DRAWITEM message for user context menus, + wParam, lParam should be passed from such message handler. + Version: v0.1.1.0+ + } + MS_CLIST_MENUDRAWITEM = 'CList/MenuDrawItem'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Built the context menu for a specific contact + Returns: A HMENU handle identifying the menu, thhis should be DestroyMenu()ed + when done. + Version: v0.1.1.0+ + } + MS_CLIST_MENUBUILDCONTACT = 'CList/MenuBuildContact'; + + { + wParam : 0 + lParam : 0 + Affect : Get the image list handle with all the useful icons in it + Version: v0.1.1.0+ + } + MS_CLIST_GETICONSIMAGELIST = 'CList/GetIconsImageList'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Get the icon that should be associated with a contact + Returns: an index into the contact list imagelist, if the icon + is a flashing icon, this service won't return information about it + see below + Version: v0.1.2.0+ + } + MS_CLIST_GETCONTACTICON = 'CList/GetContactIcon'; + + { + wParam : HCONTACT + lParam : ICON_ID + Affect : The icon of a contact in the contact list has changed, + ICON_ID is an index to what image has changed + Version: v0.1.2.1+ + } + ME_CLIST_CONTACTICONCHANGED = 'CList/ContactIconChanged'; + + // ideally only used by a CLIST UI module + + { + wParam : 0 + lParam : 0 + Affect : Get the handle to Miranda's main menu + Version: v0.1.1.0+ + } + MS_CLIST_MENUGETMAIN = 'CList/MenuGetMain'; + + { + wParam : 0 + lParam : 0 + Affect : Get a handle to Miranda's status menu + Version: v0.1.1.0+ + } + MS_CLIST_MENUGETSTATUS = 'CList/MenuGetStatus'; + + { + wParam : MAKEWPARAM(LOWORD(wParam of WM_COMMAND),flags) + lParam : HCONTACT + Affect : Process a mennu selection from a menu, see notes + Returns: True if it processed the command, False otherwise + notes : hContact is the currently selected contact, it is not used + if this is a main menu command, if this is NULL then the command + is a contact menu one, the command is ignored + Version: v0.1.1.0+ + } + MS_CLIST_MENUPROCESSCOMMAND = 'CList/MenuProcessCommand'; + + { + wParam : virtual key code + lParam : MPCF_* flags + Affect : Process a menu hotkey, see notes + Returns: True if it processed the command, False otherwise + Notes : this should be called in WM_KEYDOWN + Version: v0.1.1.0+ + } + MS_CLIST_MENUPROCESSHOTKEY = 'CList/MenuProcessHotkey'; + + { + wParam : Pointer to a MSG structurer + lParam : Pointer to an LRESULT + Affect : Process all the messages required for docking, see notes + Returns: True if the message should NOT be processed anymore, False otherwise + Notes : only msg.hwnd, msg.message, msg.wParam and msg.lParam are used + your WndProc should return the lResult if AND only IF, TRUE is returned + Version: v0.1.1.0+ + } + MS_CLIST_DOCKINGPROCESSMESSAGE = 'CList/DockingProcessMessage'; + + { + wParam : 0 + lParam : 0 + Affect : Determines wheter the contact list docked + Returns: pnon zero] if the contact list is docked, or 0 if it's not + Version: v0.1.1.0+ + } + MS_CLIST_DOCKINGISDOCKED = 'CList/DockingIsDocked'; + + { + wParam : Pointer to a TMSG + lParam : Pointer to an LRESULT + Affect : Process all the messages required for the tray icon, see notes + Returns: TRUE if the message should not be processed anymore, False otherwise + Notes : Only msg.hwnd, msg.message, msg.wparam and msg.lParam are used + your WndProc should return LRESULT if and ONLY if TRUE is returned + Version: v0.1.1.0+ + } + MS_CLIST_TRAYICONPROCESSMESSAGE = 'CList/TrayIconProcessMessage'; + + { + wParam : Pointer to TMSG + lParam : Pointer to an LRESULT + Affect : Process all the messages required for hotkeys, see notes + Returns: True if the message should not be processed anymore or False otherwise + Notes : only msg.hwnd, msg.message, msg.wParam, msg.lParam are used + Version: v0.1.1.0+ + } + MS_CLIST_HOTKEYSPROCESSMESSAGE = 'CList/HotkeysProcessMessage'; + + { + wParam : 0 + lParam : 0 + Affect : Toggles the show/hide status of the contact list + Returns: 0 on success, [non zero] on failure + Version: v0.1.1.0+ + } + MS_CLIST_SHOWHIDE = 'CList/ShowHide'; + + { + wParam : 0 + lParam : 0 + Affect : temporarily disable the autohide feature, see notes + Notes : this service will restart the auto hide timer, so if you need + to keep the window visible you'll have to bee getting user input + or calling this service each time + Version: v0.1.2.1+ + } + MS_CLIST_PAUSEAUTOHIDE = 'CList/PauseAutoHide'; + + { + wParam : HPARENTGROUP + lParam : 0 + Affect : Create a new group and calls CLUI to display it, see notes + Returns: A handle to the new group. + Notes : If HPARENTGROUP is NULL(0) it will create a group at the root. + Version: v0.1.1.0+ + } + MS_CLIST_GROUPCREATE = 'CList/GroupCreate'; + + { + wParam : HGROUP + lParam : 0 + Affect : Delete a group and call CLUI to display the change + Returns: 0 on success, [non zero] on failure + Version: v0.1.1.0+ + } + MS_CLIST_GROUPDELETE = 'CList/GroupDelete'; + + { + wParam : HGROUP + lParam : newState + Affect : Change the expanded state flag for a group internally, see notes + Returns: 0 on success, [non zero] on failure + Notes : if newState is non zero then the group is expanded, 0 it's collapsed + CLUI IS *NOT* called when the change is made. + Version: v0.1.1.0+ + } + MS_CLIST_GROUPSETEXPANDED = 'CList/GroupSetExpanded'; + + { + wParam : HGROUP + lParam : MAKELPARAM(flags, flagsMask) + Affect : Change the flag for a group, see notes + Returns: 0 on success, [non zero] on failure + Notes : only if flags given in flagsmask are altered, + CLUI is called on change to GROUPF_HIDEOFFLINE + Version: v0.1.2.1+ + } + MS_CLIST_GROUPSETFLAGS = 'CList/GroupSetFlags'; + + { + wParam : HGROUP + lParam : Pointer to a integer to be filled with expanded state + Affect : get the name of a group, see notes + Returns: a static buffer pointing to the name of the group + returns NULL(0) if HGROUP is invalid. + Notes : the returned buffer is only valid til the next call + to this service, lParam can be NULL(0) if you don't + want to know if the group is expanded + Version: v0.1.1.0+ + } + MS_CLIST_GROUPGETNAME = 'CList/GroupGetName'; + + { + wParam : HGROUP + lParam : Pointer to flags + Affect : Get the name of the group, see notes + Returns: A static buffer pointing to the name of the group + returns NULL(0) if HGROUP is invalid + Note : this buffer is only valid til the next call to this service + flags can be NULL(0), otherwise it'll return GROUPF_* constants + Version: v0.1.2.1+ + } + MS_CLIST_GROUPGETNAME2 = 'CList/GroupGetName2'; + + { + wParam : HGROUP + lParam : HBEFOREGROUP + Affect : Move a group directly before another group + Returns: the new handle of the group on success, NULL(0) on failure + Notes : the order is represented by the order in which MS_CLUI_GROUPADDED + is called, however UI's are free to ignore this order and sort + if they wish. + Version: v0.1.2.1+ + } + MS_CLIST_GROUPMOVEBEFORE = 'CList/GroupMoveBefore'; + + { + wParam : HGROUP + lParam : Pointer to a null terminated string containing the new name + Affect : Rename a group internally, see notes + Returns: 0 on success, [non zero] on failure + Notes : this will fail if the group name is a duplicate of an existing + a name, CLUI is not called when this change is made. + Version: v0.1.1.0+ + } + MS_CLIST_GROUPRENAME = 'CList/GroupRename'; + + { + wParam : 0 + lParam : 0 + Affect : Build a menu of the group tree, see notes + Returns: Handle to the menu, NULL(0) on failure + Notes : NULL be returned if the user doesn't have any groups + the dwItemData of every menu item is the handle to that group. + Menu item ID's are assigned starting at 100 in no particular order + Version: v0.1.2.1+ + } + MS_CLIST_GROUPBUILDMENU = 'CList/GroupBuildMenu'; + + { + wParam : newValue + lParam : 0 + Affect : Changes the 'hide offline contacts' flag and calls CLUI, see notes + Returns: 0 success, [non zero] on failure + Notes : newValue is 0 to show all contacts, 1 to show only online contacts + -1 to toggle the value + Version: v0.1.1.0+ + } + MS_CLIST_SETHIDEOFFLINE = 'CList/SetHideOffline'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Do the message processing associated with the double clicking a contact + Returns: 0 on success, [non zero] on failure + Version: v0.1.1.0+ + } + MS_CLIST_CONTACTDOUBLECLICKED = 'CList/ContactDoubleClicked'; + + { + wParam : HCONTACT + lParam : Pointer to an array of pchar's containing files/dirs + Affect : Do the processing when some files are droppeed on a contact, see notes + Returns: 0 on success, [non zero] on failure + Notes : the array is terminated when a NULL(0) entry is found + Version: v0.1.2.1+ + } + MS_CLIST_CONTACTFILESDROPPED = 'CList/ContactFilesDropped'; + + { + wParam : HCONTACT + lParam : HGROUP + Affect : Change the group a contact belongs to, see notes + Returns: 0 on success, [non zero] on failure + Notes : use hGroup=NULL(0) to remove any group association with the contact + Version: v0.1.1.0+ + } + MS_CLIST_CONTACTCHANGEGROUP = 'CList/ContactChangeGroup'; + + { + wParam : HCONTACT_1 + lParam : HCONTACT_2 + Affect : Determine the ordering of two given contacts + Returns: 0 if hContact1 is the same as hContact2 + 1 if hContact1 should be displayed before hContact2 + -1 if hContact1 should be displayed after hCotnact2 + Version: v0.1.1.0+ + } + MS_CLIST_CONTACTSCOMPARE = 'CList/ContactsCompare'; + +{$ENDIF} diff --git a/include/delphi/m_clui.inc b/include/delphi/m_clui.inc new file mode 100644 index 0000000000..c62b40e458 --- /dev/null +++ b/include/delphi/m_clui.inc @@ -0,0 +1,215 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_CLUI} +{$DEFINE M_CLUI} + + {<>} + +const + + { + wParam : 0 + lParam : 0 + Affects: Returns a window handle for the contact list window, see notes + Returns: "" + Notes : This call has a very specific purpose internally Miranda + and shouldn't be used gratuitously, in almost all cases + there's another call to do whatever it is that you're + trying to do. + } + MS_CLUI_GETHWND = 'CLUI/GetHwnd'; + + { + wParam : new status + lParam : null terminated string to a protocol ID + Affects: Change the protocol specific status indicators, see notes! + Returns: 0 on success, [non zero] on failure + Notes : protocol modules don't want to call this, they want + clist/protocolstatuschanged instead + } + MS_CLUI_PROTOCOLSTATUSCHANGED = 'CLUI/ProtocolStatusChanged'; + + { + wParam : Handle to a group + lParam : 1 or 0 + Affect : A new group was created, add it to the list, see notes + Notes : lParam is set to 1 or 0 if the user just created + the group or not. + - + this is also called when the contact list is being rebuilt, + new groups are always created with the name 'New group' + } + MS_CLUI_GROUPADDED = 'CLUI/GroupCreated'; + + { + wParam : HCONTACT + lParam : ICON_ID + Affect : Change the icon for a contact, see notes + Returns: 0 on success, [non zero] on failure + Notes : ICON_ID is an offset in the imagelist, see clist/geticonsimagelist + } + MS_CLUI_CONTACTSETICON = 'CLUI/ContactSetIcon'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Remove a contact from the list, see notes + Returns: 0 on success, [non zereo] on failure + Notes : this contact is NOT actually being deleted, since if + a contact goes offline while 'hide offline' option is sset, + this service will be called then ALSO + } + MS_CLUI_CONTACTDELETED = 'CLUI/ContactDeleted'; + + { + wParam : HCONTACT + lParam : ICON_ID + Affect : Add a contact to the list, see note + returns: 0 on success, [non zero] on failure + Notes : the caller processes the 'hide offline' setting, so the callee + should not do further processing based on the value of this setting + - + WARNING: this will be called to re-add a contact when they come + online if 'hide offline' is on, but it cannot determine if + the contact is already on the list, so you may get requests to + add a contact when it is already on the list, which you should ignore. + - + You'll also get this whenever an event is added for a contact, + since if the contact was offline, it needs to be shown to + display the mesage, even if 'hide offlines' is on. + - + you should not resort the list on this call, a seperate resort + request will be sent. + - + ICON_ID is an offset in the image list, see clist/geticonsimagelist + + } + MS_CLUI_CONTACTADDED = 'CLUI/ContactAdded'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Reename a contact in the lists, see notes + Returns: 0 on success, [non zero] on failure + Notes : You should not re-sort the list on this call, a separate resort + request will be sent, you can get the new name from clist/getcontactdisplayname + } + MS_CLUI_CONTACTRENAMED = 'CLUI/ContactRenamed'; + + { + wParam : 0 + lParam : 0 + Affect : Start a rebuild of the contact list, see notes + Returns: 0 on success, [non zero] on failure + Notes : this is the cue to clear the existing content of the list + expect to get a series of : + + clui/groupadded + clui/contactadded + clui/resortlist + } + MS_CLUI_LISTBEGINREBUILD = 'CLUI/ListBeginRebuild'; + + { + wParam : 0 + lParam : 0 + Affect : End a rebuild of the contact list, see notes + Returns: 0 on success, [non zero] on error + Notes : if you dissplayed an hourglass in beginbuild, set it back + here, you do not need to explicitly sort the list + } + MS_CLUI_LISTENDREBUILD = 'CLUI/ListEndRebuild'; + + { + wParam : 0 + lParam : 0 + Affect : Sort the contact list now, see notes + Returns: 0 success, [non zero] on failure + Notes : Sorts are buffered so you won't get this message lots of times + if the lists needs to be resorted many times rapidly + } + MS_CLUI_SORTLIST = 'CLUI/SortList'; + + { + wParam : CLUICAPS_* + lParam : 0 + Affect : Gets a load of capabilites for the loaded CLUI, see notes + Returns: the requested value, 0 of wParam is unknown -- + if this service is not implemented it is assumed all return + values will be 0. + Version: v0.1.2.1+ + } + + { can only provide this flag to return the following set of caps, the strings + show the database setting/type to store the list option, changing the value + does not reflect what the change is, i.e. ontop can only be affected with + a call to SetWindowPos() } + CLUICAPS_FLAGS1 = 0; + { empty groups aren't shown, 'CList/HideEmptyGroups' (byte) [changes make the list reload] } + CLUIF_HIDEEMPTYGROUPS = 1; + { groups can be disabled, lists can be merged into one seamlessly, (byte) 'CList/UseGroups' } + CLUIF_DISABLEGROUPS = 2; + { list can be displayed 'on top' of all other windows, 4 (byte) 'CList/OnTop' } + CLUIF_HASONTOPOPTION = 4; + { can disappear after a while of inactive use, + (byte) 'CList/AutoHide' (word) 'CList/HideTime' } + CLUIF_HASAUTOHIDEOPTION = 8; + + MS_CLUI_GETCAPS = 'CLUI/GetCaps'; + + { + wParam : HCONTACT + lParam : MAKELPARAM(screenX, screenY) + Affect : A contact is being dragged outside the main window + Return : return [non zero] to show the drag cursor as "accepting" the drag + or zero to show the circle/slash 'not allowed' + Version: v0.1.2.0+ + } + ME_CLUI_CONTACTDRAGGING = 'CLUI/ContactDragging'; + + { + wParam : HCONTACT + lParam : MAKELPARAM(screenX, screenY) + Affect : a contact has just been dropped outside the main window, see notes + Notes : return non zero to stop other hooks processing this event. + Version: v0.1.2.0+ + } + ME_CLUI_CONTACTDROPPED = 'CLUI/ContactDropped'; + + { + wParam : HCONTACT + lParam : 0 + Affect : A contact that *was* being dragged outside the main window + has gone back to the main window + Return : always return 0 + Version: v0.1.2.1+ + } + ME_CLUI_CONTACTDRAGSTOP = 'CLUI/ContactDragStop'; + +{$ENDIF} \ No newline at end of file diff --git a/include/delphi/m_contacts.inc b/include/delphi/m_contacts.inc new file mode 100644 index 0000000000..4ea0d936c3 --- /dev/null +++ b/include/delphi/m_contacts.inc @@ -0,0 +1,84 @@ +(* +Miranda IM + +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. +*) + +type + + PCONTACTINFO = ^TCONTACTINFO; + TCONTACTINFO = record + cbSize: int; + dwFlag: Byte; + hContact: THandle; + szProto: PChar; + type_: Byte; + retval: record (* in C this is a nameless union *) + case longint of + 0: (bVal: Byte); + 1: (wVal: WORD); + 2: (dVal: DWORD); + 3: (pszVal: PChar); + 4: (cchVal: Word); + end; + end; + +const + +// CNF_* Types of information you can retreive by setting the dwFlag in CONTACTINFO + + CNF_FIRSTNAME = 1; // returns first name (string) + CNF_LASTNAME = 2; // returns last name (string) + CNF_NICK = 3; // returns nick name (string) + CNF_CUSTOMNICK = 4; // returns custom nick name, clist name (string) + CNF_EMAIL = 5; // returns email (string) + CNF_CITY = 6; // returns city (string) + CNF_STATE = 7; // returns state (string) + CNF_COUNTRY = 8; // returns country (string) + CNF_PHONE = 9; // returns phone (string) + CNF_HOMEPAGE = 10; // returns homepage (string) + CNF_ABOUT = 11; // returns about info (string) + CNF_GENDER = 12; // returns gender (byte,'M','F' character) + CNF_AGE = 13; // returns age (byte, 0==unspecified) + CNF_FIRSTLAST = 14; // returns first name + last name (string) + CNF_UNIQUEID = 15; // returns uniqueid, protocol username (must check type for type of return) + +// Special types +// Return the custom name using the name order setting +// IMPORTANT: When using CNF_DISPLAY you MUST free the string returned +// You must **NOT** do this from your version of free() you have to use Miranda's free() +// you can get a function pointer to Miranda's free() via MS_SYSTEM_GET_MMI, see m_system.h + CNF_DISPLAY = 16; +// Same as CNF_DISPLAY except the custom handle is not used +// IMPORTANT: When using CNF_DISPLAYNC you MUST free the string returned +// You must **NOT** do this from your version of free() you have to use Miranda's free() +// you can get a function pointer to Miranda's free() via MS_SYSTEM_GET_MMI, see m_system.h + CNF_DISPLAYNC = 17; + +// If MS_CONTACT_GETCONTACTINFO returns 0 (valid), then one of the following +// types is setting telling you what type of info you received + CNFT_BYTE = 1; + CNFT_WORD = 2; + CNFT_DWORD = 3; + CNFT_ASCIIZ = 4; + + { + wParam : not used + lParam : Pointer to an initialised TCONTACTINFO structure + affects: Get contact information + returns: Zero on success, non zero on failure. + notes : If successful, the type is set and the result is put into the associated member of TCONTACTINFO + } + MS_CONTACT_GETCONTACTINFO = 'Miranda/Contact/GetContactInfo'; diff --git a/include/delphi/m_database.inc b/include/delphi/m_database.inc new file mode 100644 index 0000000000..678977979c --- /dev/null +++ b/include/delphi/m_database.inc @@ -0,0 +1,654 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_DATABASE} +{$DEFINE M_DATABASE} + +const + + DBVT_DELETED = 0; // setting got deleted, no values are valid + DBVT_BYTE = 1; // bVal, cVal are valid + DBVT_WORD = 2; // wVal, sVal are valid + DBVT_DWORD = 4; // dVal, lVal are valid + DBVT_ASCIIZ = 255; // pszVal is valid + DBVT_BLOB = 254; // cpbVal and pbVal are valid + DBVTF_VARIABLELENGTH = $80; // ? + +type + + HCONTACT = Integer; + HDBEVENT = Integer; + + PDBVARIANT = ^TDBVARIANT; + TDBVARIANT = record + type_: Byte; + case LongInt of + 0: (bVal: Byte); + 1: (cVal: Char); + 2: (wVal: Word); + 3: (sVal: SmallInt); + 4: (dVal: LongInt); + 5: (lVal: Integer); + 6: ( + pszVal: PChar; + cchVal: Word; + ); + 7: ( + cpbVal: Word; + pbVal: PByte; + ); + end; + +const + + { + wParam : size of the buffer to be filled + lParam : pointer to the buffer to be filled + affect : Get's the name of the current profile being used by the database + module -- this is the same as the filename of the profile without + the .ext + return : 0 on success, non zero on failure + } + MS_DB_GETPROFILENAME = 'DB/GetProfileName'; + + { + wParam : size of buffer pointed to by lParam + lParam : pointer to a buffer to be filled + affect : Fill a buffer with the current profile path being used, this does not include the trailing backslash. + return : 0 on success, non zero on failure + version: 0.3a only + } + MS_DB_GETPROFILEPATH = 'DB/GetProfilePath'; + +type + + PDBCONTACTGETSETTING = ^TDBCONTACTGETSETTING; + TDBCONTACTGETSETTING = record + { name of the module that wrote the setting to get } + szModule: PChar; + { the name of the setting to get } + szSetting: PChar; + { pointer to DBVARIANT to receive the value -- must be allocated for GETSETTINGSTATIC + calls thou } + pValue: PDBVARIANT; + end; + + PDBCONTACTWRITESETTING = ^TDBCONTACTWRITESETTING; + TDBCONTACTWRITESETTING = record + { module sig to write this setting under } + szModule: PChar; + { setting name to write } + szSetting: PChar; + { variant containing value to set } + value: TDBVARIANT; + end; + +const + + { + wParam : Handle of a contact to get the setting for (see notes) + lParam : pointer to a TDBCONTACTGETSETTING structure to be filled with setting + this structure also has to be initalised (see notes) + affect : Queries the database module for a setting from a contact. + returns: 0 on success, non zero on failure (contact not found, setting doesn't exist) + notes : TDBCONTACTGETSETTING must be filled with the module name that created + /wrote the setting you want to get (e.g. your module name) + and the actual setting to read with TDBCONTACTGETSETTING.szModule and + TDBCONTACTGETSETTING.szSetting -- TDBCONTACTGETSETTING.pValue is + a pointer to a TDBVARIANT with the returned setting, this maybe nil + and MUST be freed after you're done with it with FreeVariant() + + There are helper functions for reading/writing/deleting common types to and + from the database -- see DBGetContactSetting + + the contact handle (hContact) can be returned by FindContact/AddContact + } + MS_DB_CONTACT_GETSETTING = 'DB/Contact/GetSetting'; + + { + wParam : Handle for a contact to query a setting for + lParam : Pointer to a TDBCONTACTGETSETTING structure + affects: This service is almost the same as the one above, but it does + not return a dynamic copy (with malloc()) -- the caller + must do this for datatypes which require it, e.g. a string. + + This means the TDBCONTACTGETSETTING.pValue *has* to exist and be + allocated by the caller (doesn't have to be allocated from the heap) + the DBVARIANT structure has to be initalised with the type wanted + and enough buffer space around to return the info, do not + expect this service to be as fast as the one above. + + returns: 0 on success, non zero on failure. + } + MS_DB_CONTACT_GETSETTINGSTATIC = 'DB/Contact/GetSettingStatic'; + + { + wParam : 0 + lParam : Pointer to a TDBVARIANT structure + affect : Free's the passed DBVARIANT's dynamic memory (if any) see notes + returns: 0 on success, non zero on failure + notes : use the helper function FreeVariant() + } + MS_DB_CONTACT_FREEVARIANT = 'DB/Contact/FreeVariant'; + + { + wParam : Handle to contact to write setting for + lParam : Pointer to TDBCONTACTWRITESETTING which must be initalised + affects: writes a setting under a contact -- TDBCONTACTWRITESETTING structure + must contain the module name writing -- the setting name, and the value + to write (which is NOT a pointer) .szModule, .szSetting, .Value, see notes + returns: 0 on success, non zero on failure + notes : this service triggers 'DB/Contact/SettingChanged' before it returns + as always, there is a helper function to use this service. + } + MS_DB_CONTACT_WRITESETTING = 'DB/Contact/WriteSetting'; + + { + wParam : hContact under which the setting should be deleted + lParam : Pointer to a TDBCONTACTGETSETTING structure + affects: Deletes the given setting for a contact, the TDBCONTACTGETSETTING.pValue + field is ignored -- only .szModule and .szSetting are needed, see notes + returns: 0 on success, non zero on failure + notes : triggers 'DB/Contact/SettingChanged' BEFORE it deletes the given + setting, when the service returns the TDBVARIANT structure .type_ is set + to 0 and no fields are valid, there is a helper function for this + service, see below. + } + MS_DB_CONTACT_DELETESETTING = 'DB/Contact/DeleteSetting'; + + { + wParam : Handle of a contact to enum settings for + lParam : Pointer to a TDBCONTACTENUMSETTINGS structure, must be initalised + affect : Enumerates all settings for a given contact under a module, + TDBCONTACTENUMSETTINGS must be filled with the function pointer to call + the TDBCONTACTENUMSETTINGS.lParam value to pass to it each time, + as well as the .szModule under which the contact is valid + returns: returns the value of the last call to the enum function, or -1 + if no settings could be enumerated + notes : the szSetting argument passed to the enumeration function is only + valid for the duration of that enumeration call, + it must be allocated dynamically if it is required after that call frame + has returned. + Also, deleting settings as they are enumerated has unpredictable results! + but writing a new value for a setting is okay. + it is unclear how you stop the enumeration once it is started, maybe + possible to return -1 to stop it. + vesion : only valid for 0.1.0.1+ + } + +type + + TDBSETTINGENUMPROC = function(const szSetting: PChar; lParam: LPARAM): int; cdecl; + + PDBCONTACTENUMSETTINGS = ^TDBCONTACTENUMSETTINGS; + TDBCONTACTENUMSETTINGS = record + { function pointer to call to start the enum via MS_DB_CONTACT_ENUMSETTINGS } + pfnEnumProc: TDBSETTINGENUMPROC; + { passed to the above function } + lParam: LPARAM; + { name of the module to get settings for } + szModule: PChar; + { not used by us } + ofsSettings: DWORD; + end; + +const + + MS_DB_CONTACT_ENUMSETTINGS = 'DB/Contact/EnumSettings'; + + { + wParam : 0 + lParam : 0 + affect : none + returns: Returns the number of contacts in the database for the loaded profile + not including the profile user, see notes. + notes : the contacts in the database can be read with FindFirst/FindNext + } + MS_DB_CONTACT_GETCOUNT = 'DB/Contact/GetCount'; + + { + wParam : 0 + lParam : 0 + returns: Returns a handle to the first contact in the database, + this handle does not need to be closed, if there are no users + NULL(0) is returned. + } + MS_DB_CONTACT_FINDFIRST = 'DB/Contact/FindFirst'; + + { + wParam : Contact handle + lParam : 0 + returns: Returns a handle to the next contact after the given contact in + wParam, this handle does not neeed to be closed -- may return NULL(0) + if the given contact in wParam was the last in the database, or the + given contact was invalid + } + MS_DB_CONTACT_FINDNEXT = 'DB/Contact/FindNext'; + + { + wParam : Handle of a contact to delete + lParam : 0 + affect : the user by the given handle is deleted from the database, see notes + returns: Returns 0 on success or nonzero if the handle was invalid + notes : this triggers DB/Contact/Deleted BEFORE it actually deletes the contact + all events are also deleted -- other modules may end up with invalid + handles because of this, which they should be prepared for. + } + MS_DB_CONTACT_DELETE = 'DB/Contact/Delete'; + + { + wParam : 0 + lParam : 0 + affects: creates a new contact in the database, they have no settings, + settings must be added with MS_DB_CONTACT_WRITESETTING or + database helper functions for writing, see notes + returns: A handle to a new contact or NULL(0) on failure. + notes : triggers the ME_DB_CONTACT_ADDED event just before the service returns + } + MS_DB_CONTACT_ADD = 'DB/Contact/Add'; + + + { + wParam : (HANDLE) hContact + lParam : 0 + affects: Checks the given handle within the database for valid information, for + a proper internal header. + returns: Returns 1 if the contact handle is valid, 0 if it is not + notes : Due to the nature of multiple threading a contact handle can be deleted + soon after this service has returned a handle as valid, however it will never point + to another contact. + } + MS_DB_CONTACT_IS = 'DB/Contact/Is'; + + + { + wParam : contact handle for events count is needed + lParam : 0 + service: Gets the number of events in the chain belonging to a contact + in the databasee. + returns: the numbef of events owned by hContact or -1 if hContact + is invalid, they can be found with the event/find* servicees + } + MS_DB_EVENT_GETCOUNT = 'DB/Event/GetCount'; + + { + wParam : contact handle to add an event for + lParam : Pointer to TDBEVENTINFO initialised with data + affect : Add's an event to the contact's event list, the TDBEVENTINFO + structure should be filled with the event of message -- see notes + returns: a handle to a DB event (HDBEVENT), or NULL on error + notes : Triggers DB/Event/Added event just before it returns, + Events are sorted chronologically as they are entered, + so you cannot guarantee that the new hEvent is the last event in the chain, + however if a new event is added that has a timestamp less than + 90 seconds *before* the event that should be after it, + it will be added afterwards, to allow for protocols that only + store times to the nearest minute, and slight delays in transports. + There are a few predefined eventTypes below for easier compatibility, but + modules are free to define their own, beginning at 2000 + DBEVENTINFO.timestamp is in GMT, as returned by time() + } + + DBEF_FIRST = 1; // internally only, do not use + DBEF_SENT = 2; // if set, the event was sent by the user, otherwise it was received + DBEF_READ = 4; // event has been read by the user -- only needed for history + + EVENTTYPE_MESSAGE = 0; + EVENTTYPE_URL = 1; + EVENTTYPE_CONTACTS = 2; // v0.1.2.2+ + EVENTTYPE_ADDED = 1000; // v0.1.1.0+: these used to be module- + EVENTTYPE_AUTHREQUEST = 1001; // specific codes, hence the module- + EVENTTYPE_FILE = 1002; // specific limit has been raised to 2000 + +type + + PDBEVENTINFO = ^TDBEVENTINFO; + TDBEVENTINFO = record + { size of the structure } + cbSize: int; + { module that 'owns' this event and controls the data format } + szModule: PChar; + { timestamp in UNIX time } + timestamp: DWORD; + { the DBEF_* flags above } + flags: DWORD; + { event type, such as message, can be module defined } + eventType: WORD; + { size in bytes of pBlob^ } + cbBlob: DWORD; + { pointer to buffer containing the module defined event data } + pBlob: PByte; + end; + +const + + MS_DB_EVENT_ADD = 'DB/Event/Add'; + + + + { + wParam : Handle to the contact + lParam : HDBEVENT handle to delete + affects: Removes a single event from the database for the given contact + returns: 0 on success, nonzero on failure + notes : Triggers DB/Event/Deleted just before the event *is* deleted + } + MS_DB_EVENT_DELETE = 'DB/Event/Delete'; + + { + wParam : Handle to DB event + lParam : 0 + returns: Returns the space in bytes requried to store the blob in HDBEVENT + given by HDBEVENT(wParam) -- or -1 on error + } + MS_DB_EVENT_GETBLOBSIZE = 'DB/Event/GetBlobSize'; + + { + wParam : Handle to a DB event + lParam : Pointer to a TDBEVENTINFO structure which must be initialised + affects: Returns all the information about an DB event handle to a TDBEVENTINFO + structure which must be initalised, DBEI.cbSize, DBEI.pBlob and DBEI.cbSize + before calling this service, the size can be assertained with + GetBlobSize() service, see notes + returns: Returns 0 on success, non zero on failure + notes : The correct value dbe.cbBlob can be got using db/event/getblobsize + If successful, all the fields of dbe are filled. dbe.cbBlob is set to the + actual number of bytes retrieved and put in dbe.pBlob + If dbe.cbBlob is too small, dbe.pBlob is filled up to the size of dbe.cbBlob + and then dbe.cbBlob is set to the required size of data to go in dbe.pBlob + On return, dbe.szModule is a pointer to the database module's + own internal list of modules. Look but don't touch. + } + MS_DB_EVENT_GET = 'DB/Event/Get'; + + { + wParam : HCONTACT + lParam : HDBEVENT + affect : Changes the flag for an event to mark it as read + Returns: Returns the entire flag DWORD for the event after the change, or -1 + if HDBEVENT is invalid, see notes + notes : This iss one of the database write operations that does not trigger + an event, modules should not save flagss states for any length of time. + } + MS_DB_EVENT_MARKREAD = 'DB/Event/MarkRead'; + + { + wParam : HDBEVENT + lParam : 0 + Affect : Returns a handle to a contact that owns the HDBEVENT, + see notes + Returns: Returns a handle if successful or HDBEEVENT(-1) on failure + notes : This service is very slow, only use wheen you have no other choice + at all. + } + MS_DB_EVENT_GETCONTACT = 'DB/Event/GetContact'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Retrieves a handlee to the first event in the chain + for a HCONTACT + returns: Returns a handle, or NULL(0) if HCONTACT is invalid or has + no events, events in a chain are sorted chronologically automatically + } + MS_DB_EVENT_FINDFIRST = 'DB/Event/FindFirst'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Retrieves a handle to the first unreead event in a chain for a HCONTACT + see notes + Returns: Returns a HDBEVENT handle or NULL(0) if the HCONTACT is invalid + or all it's events have beeen read. + Notes : Events in a chain are sorted chronologically automatically, + but this does not necessarily mean that all events after + the first unread are unread too. + They should be checked individually with event/findnext and event/get + This service is designed for startup, reloading all the events that remained + unread from last time + } + MS_DB_EVENT_FINDFIRSTUNREAD = 'DB/Event/FindFirstUnread'; + + { + wParam : HCONTACT + lParam : 0; + Affects: Retrieves a handle to the lasts event in the chain for a HCONTACT + Returns: Returns a handle or NULL(0) if HCONTACT is invalid or has no events + } + MS_DB_EVENT_FINDLAST = 'DB/Event/FindLast'; + + { + wParam : HDBEVENT + lParam : 0 + Affects: Retrieves a handle to the next event in a chain after HDBEVENT + Returns: A handle to the next DB event or NULL(0) if HDBEVENT is invalid + or the last event in the chain. + } + MS_DB_EVENT_FINDNEXT = 'DB/Event/FindNext'; + + { + wParam : HDBEVENT + lParam : 0 + Affects: Retrieves a handle to the previous event in a chain before HDBEVENT + Returns: A handle to the previous HDBEVENT or NULL(0) if HDBEVENT is invalid + or is the first event in the chain + } + MS_DB_EVENT_FINDPREV = 'DB/Event/FindPrev'; + + + + { + wParam : size in bytes of string buffer (including null term) + lParam : pointer to string buffer + Affect : Scrambles the string buffer in place using a strange encryption algorithm, + see notes + Returns: Always returns 0 + notes : this service may be changed at a later date such that it increasess + the length of the string + } + MS_DB_CRYPT_ENCODESTRING = 'DB/Crypt/EncodeString'; + + { + wParam : size in bytes of string buffer, including null term + lParam : pointer to string buffer + Affect : Descrambles pszString in-place using the strange encryption algorithm, + see notes. + Return : Always returns 0 + notes : Reverses the operation done by MS_DB_CRYPT_ENCODINGSTRING + } + MS_DB_CRYPT_DECODESTRING = 'DB/Crypt/DecodeString'; + + + + { + wParam : timestamp (DWORD) + lParam : 0 + Affect : Converts a GMT timestap into local time + Returns: Returns the converted value, see notes + Notes : Timestamps have a zereo at midnight 1/1/1970 GMT, this service + converts such a value to be based at midnight 1/1/1970 local time. + This service does not use a simple conversion based on the current offset + between GMT and local. Rather, it figures out whether daylight savings time + would have been in place at the time of the stamp and gives the local time as + it would have been at the time and date the stamp contains. + } + MS_DB_TIME_TIMESTAMPTOLOCAL = 'DB/Time/TimestampToLocal'; + + { + wParam : timestamp (DWORD) + lParam : pointer to initalised DBTIMETOSTRING structure + Affect : Converts a GMT timestamp to a customisable local time string + see notes + Returns: Always returns 0 + notes : The string is formatted according to thhe current user's locale + language and preference -- + + .szFormat can have the following special chars : + t time without seconds, e.g. hh:mm + s time with seconds, e.g. hh:mm:ss + m time without minutes e.g. hh + d short date, e.g. dd/mm/yyyy + D long date, e.g. d mmmm yyyy + + all other characters are copied as is. + } + +type + + PDBTIMETOSTRING = ^TDBTIMETOSTRING; + TDBTIMETOSTRING = record + { format string, see above } + szFormat: PChar; + { pointer to dest buffer to store the result } + szDest: PChar; + { size of the buffer } + cbDest: int; + end; + +const + + MS_DB_TIME_TIMESTAMPTOSTRING = 'DB/Time/TimestampToString'; + + + + { + wParam : newSetting (BOOLEAN) + lParam : 0 + Affect : Miranda's database is normally protected against corruption by + aggressively flushing data to the disk on writes, if you're doing + alot of writes e.g. an import plugin, it can sometimes be desirable + to switch this feature off to speed up the process, if you do switch + it off, you must remember that crashes are far more likely to be + catastrophic, so switch it back on at the earliest possible opportunity. + if you're doing a lot of setting writes, the flush is already delayed + so you need not use this service for that purpose, see notes. + Returns: Always returns 0 (successful) + notes : This is set to true initally + } + MS_DB_SETSAFETYMODE = 'DB/SetSafetyMode'; + + { + wParam : (caller defined data) will be passed to lParam of the call back + lParam : function pointer to TDBMODULEENUMPROC + Affects: Enumerates the names of all modules that have stored or + requested information from the database, + the modules are returned in no real order -- + Writing to the database while module names are being enumerated will cause + unpredictable results in the enumeration, but the write will work. + + the enumeration will stop if the callback returns a non zero value. + + Returns: the last return value from the enumeration call back. + Notes : This service is only useful for debugging or EnumSettings + version: The service registered to enumerate all modules that have touched + the database module uses wParam as the lParam cookie value and the lParam + value given here is the function pointer -- this is not safe + to use before v0.1.2.1 because I don't know if this was done in v0.1.2.1- + + prior to v0.1.2.1 you can not pass a value to the enumeration because + of a bug -- which is fixed, but hey :) -- [sam] + } +type + TDBMODULEENUMPROC = function(const szModule: PChar; ofsModuleName: DWORD; lParam: LPARAM): int; cdecl; +const + MS_DB_MODULES_ENUM = 'DB/Modules/Enum'; + + + + { + wParam : HCONTACT + lParam : HDBCONTACT + Affect : Called when a new event has been added to the event chain + for a contact, HCONTACT contains the contact who added the event, + HDBCONTACT a handle to what was added. + see notes + notes : since events are sorted chronologically, you can not guarantee + that HDBEVEnT is in any particular position in the chain. + + } + ME_DB_EVENT_ADDED = 'DB/Event/Added'; + + { + wParam : HANDLE (hContact) + lParam : @DBEVENTINFO + Affects: Hook is fired before any DBEVENTS are created within the database for + a contact (or a user, if hContact is NULL(0)) - It allows a module to + query/change DBEVENTINFO before it is created, see notes. + Returns: Hook should return 1 to stop event being added (will stop other hooks seeing the event too) + Or 0 to continue processing (passing the data on as well) + Notes : This hook is fired for all event types, and the BLOBS that the eventypes mark + Maybe changed, therefore be careful about using BLOB formats. + Because the memory pointing within the DBEVENTINFO CAN NOT BE OWNED or free()'d + it is recommended that the hook only be used to stop events. + Version: 0.3.3a+ (2003/12/03) + } + ME_DB_EVENT_FILTER_ADD = 'DB/Event/FilterAdd'; + + { + wParam : HCONTACT + lParam : HDBEVENT + Affect : Called when an event is about to be deleted from the event chain + for a contact, see notes + notes : Returning non zero from your hook will NOT stop the deletion, + but it will as usual stop other hooks being called + } + ME_DB_EVENT_DELETED = 'DB/Event/Deleted'; + + + + { + wParam : HCONTACT + lParam : 0 + Affect : Called when a new contact has been added to the database, + HCONTACT contains a handle to the new contact. + } + ME_DB_CONTACT_ADDED = 'DB/Contact/Added'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Called when a contact is about to be deleted + Returns: Returning nonzero from your hook will not stop the deletion + but it will stop the other hooks from being called + } + ME_DB_CONTACT_DELETED = 'DB/Contact/Deleted'; + + { + wParam : HCONTACT + lParam : Pointer to a TDBCONTACTWRITESETTING + Affect : Calleed when a contact has one of it's settings changed + hContact is a valid handle to the contact that has changed, + see notes. + notes : this event will be triggered many times rapidly when alot of values + are set. + Modules that hook this should be aware of this fact and quickly + return if they are not interested in the value that has changed. + Careful not to get into infinite loops with this event, + + The TDBCONTACTWRITESETTING pointer is the same one as the + original service all, so don't change any of it's fields + } + ME_DB_CONTACT_SETTINGCHANGED = 'DB/Contact/SettingChanged'; + +{$ENDIF} diff --git a/include/delphi/m_email.inc b/include/delphi/m_email.inc new file mode 100644 index 0000000000..71859ed208 --- /dev/null +++ b/include/delphi/m_email.inc @@ -0,0 +1,39 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_EMAIL} +{$DEFINE M_EMAIL} + +const + + { + wParam : HCONTACT + lParam : 0 + Affects: Send an e-mail to the specified contact, see notes + Returns: Returns 0 on success or nonzero on failure + Notes : If an error occurs the service displays a message box + with the error text -- use this service to alter this + } + MS_EMAIL_SENDEMAIL = 'SREMail/SendCommand'; + +{$ENDIF} diff --git a/include/delphi/m_file.inc b/include/delphi/m_file.inc new file mode 100644 index 0000000000..e1e388fcdc --- /dev/null +++ b/include/delphi/m_file.inc @@ -0,0 +1,66 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_FILE} +{$DEFINE M_FILE} + +const + + { + wParam : HCONTACT + lParam : 0 + Affects: Brings up the send file dialog for a contact, see notes + Returns: 0 on success [non zero] on failure + Notes : Returns immediately without waiting for the send + } + MS_FILE_SENDFILE = 'SRFile/SendCommand'; + + { + wParam : HCONTACT + lParam : pointer to an array of PChar's the first nil item + terminates the list -- see notes + Affects: Brings up the send file dialog with specifieed files already chosen + the user is not prevented from editing the list -- + Returns: 0 on success [non zero] on failure -- returns immediately without + waiting for the send to finish + Notes : both directories and files can be given + Version: v0.1.2.1+ + } + MS_FILE_SENDSPECIFICFILES = 'SRFile/SendSpecificFiles'; + + { + wParam : HCONTACT + lParam : Pointer to a buffer + Affects: returns the received files folder for a contact, the buffer + should be at least MAX_PATH long (defined with WinAPI), + the returned path may not exist -- see notes + Returns: Returns 0 on success [non zero] on failure + notes : If HCONTACT is NULL(0) the path returned is the path + without the postfix contact name. + Version: v0.1.2.2+ + } + MS_FILE_GETRECEIVEDFILESFOLDER = 'SRFile/GetReceivedFilesFolder'; + + +{$ENDIF} diff --git a/include/delphi/m_findadd.inc b/include/delphi/m_findadd.inc new file mode 100644 index 0000000000..9952a787c8 --- /dev/null +++ b/include/delphi/m_findadd.inc @@ -0,0 +1,38 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_FINDADD} +{$DEFINE M_FINDADD} + +const + + { + wParam : 0 + lParam : 0 + Affects: Openss the find/add users dialog box, or gives it focus if it's + already open. + Returns: Always returns 0 + } + MS_FINDADDFINDADD = 'FindAdd/FindAddCommand'; + +{$ENDIF} diff --git a/include/delphi/m_globaldefs.pas b/include/delphi/m_globaldefs.pas new file mode 100644 index 0000000000..1e8270696b --- /dev/null +++ b/include/delphi/m_globaldefs.pas @@ -0,0 +1,97 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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. + +*) + +{$IFDEF FPC} + {$PACKRECORDS C} + {$MODE Delphi} +{$ENDIF} + +unit m_globaldefs; + +interface + +uses + +{$ifdef FPC} + strings; +{$else} + Windows; +{$endif} + +type + + PByte = ^Byte; + int = Integer; + pint = ^int; + WPARAM = Integer; + LPARAM = Integer; + DWORD = Integer; + THandle = Integer; + + // strcpy() + + {$ifdef FPC} + TStrCpy = function(Dst, Src: PChar): PChar; + {$else} + TStrCpy = function(Dst, Src: PChar): PChar; stdcall; + {$endif} + + // strcat() + + {$ifdef FPC} + TStrCat = function(Dst, Src: PChar): PChar; + {$else} + TStrCat = function(Dst, Src: PChar): PChar; stdcall; + {$endif} + +const + + {$ifdef FPC} + strcpy: TStrCpy = strings.strcopy; + {$else} + strcpy: TStrCpy = lstrcpy; + {$endif} + + {$ifdef FPC} + strcat: TStrCat = strings.strcat; + {$else} + strcat: TStrCat = lstrcat; + {$endif} + + {$include newpluginapi.inc} + +var + { this is now a pointer to a record of function pointers to match the C API, + and to break old code and annoy you. } + + PLUGINLINK: PPLUGINLINK; + + { has to be returned via MirandaPluginInfo and has to be statically allocated, + this means only one module can return info, you shouldn't be merging them anyway! } + + PLUGININFO: TPLUGININFO; + +implementation + +end. diff --git a/include/delphi/m_helpers.inc b/include/delphi/m_helpers.inc new file mode 100644 index 0000000000..ae5b28db8f --- /dev/null +++ b/include/delphi/m_helpers.inc @@ -0,0 +1,613 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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. + +*) + +{$ifdef M_API_UNIT} + + function PLUGIN_MAKE_VERSION(a,b,c,d: Cardinal): int; + function PLUGIN_CMP_VERSION(verA: LongInt; verB: LongInt): int; + +{$else} + + function PLUGIN_MAKE_VERSION(a,b,c,d: Cardinal): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := (a shl 24) or (b shl 16) or (c shl 8) or d; + end; + + function PLUGIN_CMP_VERSION(verA: LongInt; verB: LongInt): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := 0; + { could be used to compare for severity of age for positive values, if a 0 then + Result := ErrorValue + else + Result := dbv.bVal; + end; + + function DBGetContactSettingWord(hContact: THandle; + const szModule: PChar; const szSetting: PChar; errorValue: Integer): Integer; + {$ifdef FPC} + inline; + {$endif} + var + dbv: TDBVARIANT; + cgs: TDBCONTACTGETSETTING; + begin + cgs.szModule := szModule; + cgs.szSetting := szSetting; + cgs.pValue := @dbv; + If PluginLink^.CallService(MS_DB_CONTACT_GETSETTING, hContact, lParam(@cgs)) <> 0 then + Result := ErrorValue + else + Result := dbv.wVal; + end; + + function DBGetContactSettingDword(hContact: THandle; + const szModule: PChar; const szSetting: PChar; errorValue: Integer): Integer; + {$ifdef FPC} + inline; + {$endif} + var + dbv: TDBVARIANT; + cgs: TDBCONTACTGETSETTING; + begin + cgs.szModule := szModule; + cgs.szSetting := szSetting; + cgs.pValue := @dbv; + If PluginLink^.CallService(MS_DB_CONTACT_GETSETTING, hContact, lParam(@cgs)) <> 0 then + Result := ErrorValue + else + Result := dbv.dVal; + end; + + function DBGetContactSetting(hContact: THandle; + const szModule: PChar; const szSetting: PChar; dbv: PDBVARIANT): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cgs: TDBCONTACTGETSETTING; + begin + cgs.szModule := szModule; + cgs.szSetting := szSetting; + cgs.pValue := dbv; + Result := PluginLink^.CallService(MS_DB_CONTACT_GETSETTING, hContact, lParam(@cgs)); + end; + + function DBFreeVariant(dbv: PDBVARIANT): Integer; + {$ifdef FPC} + inline; + {$endif} + begin + Result := PluginLink^.CallService(MS_DB_CONTACT_FREEVARIANT, 0, lParam(dbv)); + end; + + function DBDeleteContactSetting(hContact: THandle; const szModule: PChar; const szSetting: PChar): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cgs: TDBCONTACTGETSETTING; + begin + cgs.szModule := szModule; + cgs.szSetting := szSetting; + Result := PluginLink^.CallService(MS_DB_CONTACT_DELETESETTING, hContact, lParam(@cgs)); + end; + + function DBWriteContactSettingByte(hContact: THandle; const szModule: PChar; const szSetting: PChar; val: Byte): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cws: TDBCONTACTWRITESETTING; + begin + cws.szModule := szModule; + cws.szSetting := szSetting; + cws.value.type_ := DBVT_BYTE; + cws.value.bVal := Val; + Result := PluginLink^.CallService(MS_DB_CONTACT_WRITESETTING, hContact, lParam(@cws)); + end; + + function DBWriteContactSettingWord(hContact: THandle; const szModule: PChar; const szSetting: PChar; val: Word): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cws: TDBCONTACTWRITESETTING; + begin + cws.szModule := szModule; + cws.szSetting := szSetting; + cws.value.type_ := DBVT_WORD; + cws.value.wVal := Val; + Result := PluginLink^.CallService(MS_DB_CONTACT_WRITESETTING, hContact, lParam(@cws)); + end; + + function DBWriteContactSettingDWord(hContact: THandle; const szModule: PChar; const szSetting: PChar; val: LongInt): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cws: TDBCONTACTWRITESETTING; + begin + cws.szModule := szModule; + cws.szSetting := szSetting; + cws.value.type_ := DBVT_DWORD; + cws.value.dVal := Val; + Result := PluginLink^.CallService(MS_DB_CONTACT_WRITESETTING, hContact, lParam(@cws)); + end; + + function DBWriteContactSettingString(hContact: THandle; const szModule: PChar; const szSetting: PChar; const val: PChar): Integer; + {$ifdef FPC} + inline; + {$endif} + var + cws: TDBCONTACTWRITESETTING; + begin + cws.szModule := szModule; + cws.szSetting := szSetting; + cws.value.type_ := DBVT_ASCIIZ; + cws.value.pszVal := Val; + Result := PluginLink^.CallService(MS_DB_CONTACT_WRITESETTING, hContact, lParam(@cws)); + end; + + {$endif} + +{$endif} + +{$ifdef M_NETLIB} + + {$ifdef M_API_UNIT} + + function Netlib_CloseHandle(Handle: THandle): int; + + function Netlib_GetBase64DecodedBufferSize(const cchEncoded: int): int; + + function Netlib_GetBase64EncodedBufferSize(const cbDecoded: int): int; + + function Netlib_Send(hConn: THandle; const buf: PChar; len: int; flags: int): int; + + function Netlib_Recv(hConn: THandle; const buf: PChar; len: int; flags: int): int; + + procedure Netlib_Log(hNetLib: THandle; const sz: PChar); + + {$else} + + function Netlib_CloseHandle(Handle: THandle): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := PluginLink^.CallService(MS_NETLIB_CLOSEHANDLE, Handle, 0); + end; + + function Netlib_GetBase64DecodedBufferSize(const cchEncoded: int): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := (cchEncoded shr 2) * 3; + end; + + function Netlib_GetBase64EncodedBufferSize(const cbDecoded: int): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := (cbDecoded * 4+11) div 12*4+1; + end; + + function Netlib_Send(hConn: THandle; const buf: PChar; len: int; flags: int): int; + {$ifdef FPC} + inline; + {$endif} + var + nlb: TNETLIBBUFFER; + begin + nlb.buf := buf; + nlb.len := len; + nlb.flags := flags; + Result := PluginLink^.CallService(MS_NETLIB_SEND, wParam(hConn), lParam(@nlb)); + end; + + function Netlib_Recv(hConn: THandle; const buf: PChar; len: int; flags: int): int; + {$ifdef FPC} + inline; + {$endif} + var + nlb: TNETLIBBUFFER; + begin + nlb.buf := buf; + nlb.len := len; + nlb.flags := flags; + Result := PluginLink^.CallService(MS_NETLIB_RECV, wParam(hConn), lParam(@nlb)); + end; + + procedure Netlib_Log(hNetLib: THandle; const sz: PChar); + {$ifdef FPC} + inline; + {$endif} + begin + PluginLink^.CallService(MS_NETLIB_LOG, hNetLib, lParam(sz)); + end; + + {$endif} + +{$endif} + +{$ifdef M_UTILS} + + {$ifdef M_API_UNIT} + + function WindowList_Add(hList: THandle; hWnd: HWND; hContact: THandle): int; + + function WindowList_Remove(hList: THandle; hWnd: THandle): int; + + function WindowList_Find(hList: THandle; hContact: THandle): int; + + function WindowList_Broadcast(hList: THandle; message: int; wParam: WPARAM; lParam: LPARAM): int; + + function Utils_SaveWindowPosition(hWnd: THandle; hContact: THandle; const szModule, szNamePrefix: PChar): int; + + function Utils_RestoreWindowPosition(hWnd: THandle; hContact: THandle; Flags: int; const szModule, szNamePrefix: PChar): int; + + {$else} + + function WindowList_Add(hList: THandle; hWnd: hWnd; hContact: THandle): int; + var + wle: TWINDOWLISTENTRY; + begin + wle.hList := hList; + wle.hWnd := hWnd; + wle.hContact := hContact; + Result := PluginLink^.CallService(MS_UTILS_ADDTOWINDOWLIST, 0, lParam(@wle)); + end; + + function WindowList_Remove(hList: THandle; hWnd: THandle): int; + begin + Result := PluginLink^.CallService(MS_UTILS_REMOVEFROMWINDOWLIST, hList, hWnd); + end; + + function WindowList_Find(hList: THandle; hContact: THandle): int; + begin + Result := PluginLink^.CallService(MS_UTILS_FINDWINDOWINLIST, hList, hContact); + end; + + function WindowList_Broadcast(hList: THandle; message: int; wParam: WPARAM; lParam: LPARAM): int; + var + msg: TMSG; + begin + msg.message := message; + msg.wParam := wParam; + msg.lParam := lParam; + Result := PluginLink^.CallService(MS_UTILS_BROADCASTTOWINDOWLIST, hList, Integer(@Msg)); + end; + + function Utils_SaveWindowPosition(hWnd: THandle; hContact: THandle; const szModule, szNamePrefix: PChar): int; + var + swp: TSAVEWINDOWPOS; + begin + swp.hWnd := hWnd; + swp.hContact := hContact; + swp.szModule := szModule; + swp.szNamePrefix := szNamePrefix; + Result := PluginLink^.CallService(MS_UTILS_SAVEWINDOWPOSITION, 0, lParam(@swp)); + end; + + function Utils_RestoreWindowPosition(hWnd: THandle; hContact: THandle; Flags: int; const szModule, szNamePrefix: PChar): int; + var + swp: TSAVEWINDOWPOS; + begin + swp.hWnd := hWnd; + swp.hContact := hContact; + swp.szModule := szModule; + swp.szNamePrefix := szNamePrefix; + Result := PluginLink^.CallService(MS_UTILS_RESTOREWINDOWPOSITION, Flags, lParam(@swp)); + end; + + {$endif} + +{$endif} + +{$ifdef M_LANGPACK} + + {$ifdef M_API_UNIT} + + function Translate(sz: PChar): PChar; + + function TranslateString(sz: string): string; + + function TranslateDialogDefault(hwndDlg: THandle): int; + + {$else} + + function Translate(sz: PChar): PChar; + {$ifdef FPC} + inline; + {$endif} + begin + { the return value maybe NULL(0) -- it's upto the caller to know if the allocated + string has to be removed from the DLL heap, this has little to do with Miranda, + but if a dynamic string is passed and a return string is used -- the dynamic + string is lost -- be careful, lazy? use TranslateString (note it's slower) } + Result := PChar(PluginLink^.CallService(MS_LANGPACK_TRANSLATESTRING, 0, lParam(sz))); + end; + + function TranslateString(sz: string): string; + {$ifdef FPC} + inline; + {$endif} + begin + Result := string(PChar( PluginLink^.CallService(MS_LANGPACK_TRANSLATESTRING, 0, lParam(sz)))); + end; + + function TranslateDialogDefault(hwndDlg: THandle): int; + {$ifdef FPC} + inline; + {$endif} + var + lptd: TLANGPACKTRANSLATEDIALOG; + begin + lptd.cbSize := sizeof(lptd); + lptd.flags := 0; + lptd.hwndDlg := hwndDlg; + lptd.ignoreControls := nil; + Result := PluginLink^.CallService(MS_LANGPACK_TRANSLATEDIALOG, 0, lParam(@lptd)); + end; + + {$endif} + +{$endif} + +{$ifdef M_PROTOCOLS} + {$ifdef M_API_UNIT} + + function CallContactService(hContact: THandle; const szProtoService: PChar; wParam: WPARAM; lParam: LPARAM): int; + + function CallProtoService(const szModule, szService: PChar; wParam: WPARAM; lParam: LPARAM): int; + + {$else} + + function CallContactService(hContact: THandle; const szProtoService: PChar; wParam: WPARAM; lParam: LPARAM): int; + {$ifdef FPC} + inline; + {$endif} + var + css: TCCSDATA; + begin + css.hContact := hContact; + css.szProtoService := szProtoService; + css.wParam := wParam; + css.lParam := lParam; + Result := PluginLink^.CallService(MS_PROTO_CALLCONTACTSERVICE, 0, Integer(@css)); + end; + + function CallProtoService(const szModule, szService: PChar; wParam: WPARAM; lParam: LPARAM): int; + {$ifdef FPC} + inline; + {$endif} + var + szStr: array[0..MAXMODULELABELLENGTH] of Char; + begin + strcpy(szStr, szModule); + strcat(szStr, szService); + Result := PluginLink^.CallService(szStr, wParam, lParam); + end; + + {$endif} +{$endif} + +{$ifdef M_PROTOMOD} + {$ifdef M_API_UNIT} + + function ProtoBroadcastAck(const szModule: PChar; hContact: THandle; type_: int; result_: int; hProcess: THandle; lParam: LPARAM): int; + + function CreateProtoServiceFunction(const szModule, szService: PChar; serviceProc: TMIRANDASERVICE): int; + + {$else} + + function ProtoBroadcastAck(const szModule: PChar; hContact: THandle; type_: int; result_: int; hProcess: THandle; lParam: LPARAM): int; + {$ifdef FPC} + inline; + {$endif} + var + ack: TACKDATA; + begin + ack.cbSize := sizeof(TACKDATA); + ack.szModule := szModule; + ack.hContact := hContact; + ack.type_ := type_; + ack.result_ := result_; + ack.hProcess := hProcess; + ack.lParam := lParam; + Result := PluginLink^.CallService(MS_PROTO_BROADCASTACK, 0, Integer(@ack)); + end; + + function CreateProtoServiceFunction(const szModule, szService: PChar; serviceProc: TMIRANDASERVICE): int; + {$ifdef FPC} + inline; + {$endif} + var + szStr: array[0..MAXMODULELABELLENGTH] of Char; + begin + strcpy(szStr, szModule); + strcat(szStr, szService); + Result := PluginLink^.CreateServiceFunction(szStr, @serviceProc); + end; + + {$endif} + +{$endif} + +{$ifdef M_SKIN} + + {$ifdef M_API_UNIT} + + function LoadSkinnedIcon(id: int): THandle; + + function LoadSkinnedProtoIcon(const szProto: PChar; status: int): THandle; + + function SkinAddNewSound(const name, description, defaultFile: PChar): int; + + function SkinPlaySound (const name: PChar): int; + + {$else} + + function LoadSkinnedIcon(id: int): THandle; + {$ifdef FPC} + inline; + {$endif} + begin + Result := PluginLink^.CallService(MS_SKIN_LOADICON, id, 0); + end; + + function LoadSkinnedProtoIcon(const szProto: PChar; status: int): THandle; + {$ifdef FPC} + inline; + {$endif} + begin + Result := PluginLink^.CallService(MS_SKIN_LOADPROTOICON, wParam(szProto), status); + end; + + function SkinAddNewSound(const name, description, defaultFile: PChar): int; + {$ifdef FPC} + inline; + {$endif} + var + ssd: TSKINSOUNDDESC; + begin + ssd.cbSize := sizeof(ssd); + ssd.pszName := name; + ssd.pszDescription := description; + ssd.pszDefaultFile := defaultFile; + Result := PluginLink^.CallService(MS_SKIN_ADDNEWSOUND, 0, lParam(@ssd)); + end; + + function SkinPlaySound (const name: PChar): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := PluginLink^.CallService(MS_SKIN_PLAYSOUND, 0, lParam(name)); + end; + + {$endif} + +{$endif} diff --git a/include/delphi/m_history.inc b/include/delphi/m_history.inc new file mode 100644 index 0000000000..af019ee255 --- /dev/null +++ b/include/delphi/m_history.inc @@ -0,0 +1,37 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_HISTORY} +{$DEFINE M_HISTORY} + +const + + { + wParam : HCONTACT + lParam : 0 + Affects: Show's the history dialog box for a contact, see notes + Notes : HCONTACT can be NULL(0) to show system messages + } + MS_HISTORY_SHOWCONTACTHISTORY = 'History/ShowContactHistory'; + +{$ENDIF} diff --git a/include/delphi/m_icq.inc b/include/delphi/m_icq.inc new file mode 100644 index 0000000000..a498513f01 --- /dev/null +++ b/include/delphi/m_icq.inc @@ -0,0 +1,191 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_ICQ} +{$DEFINE M_ICQ} + +const + + // extra database event type + ICQEVENTTYPE_WEBPAGER = 2003; + + // extra flags for PSS_MESSAGE + PIMF_ROUTE_DEFAULT = 0; + PIMF_ROUTE_DIRECT = $10000; + PIMF_ROUTE_THRUSERVER = $20000; + PIMF_ROUTE_BESTWAY = $30000; + PIMF_ROUTE_MASK = $30000; + + // for SMS + + ICQACKTYPE_SMS = 1001; + ICQEVENTTYPE_SMS = 2001; // database event type + + // for e-mail express + + { + BLOB: + text: ASCIIZ usually in the form "Subject: %s\r\n%s" + from-name: ASCIIZ + from-e-mail: ASCIIZ + } + + ICQEVENTTYPE_EMAILEXPRESS = 2002; + + // for server side lists, used internally only + + // hProcess=dwSequence, lParam=server's error code, 0 for success + ICQACKTYPE_SERVERCLIST = 1003; + +{$ifndef m_protosvc} + {$include m_protosvc.inc} +{$endif} + +type + + PICQSEARCHRESULT = ^TICQSEARCHRESULT; + TICQSEARCHRESULT = record + hdr: TPROTOSEARCHRESULT; + uin: DWORD; + auth: Byte; + end; + + PICQDETAILSSEARCH = ^TICQDETAILSSEARCH; + TICQDETAILSSEARCH = record + nick: PChar; + firstName: PChar; + lastNamee: PChar; + end; + +const + + { + wParam : 0 + lParam : null terminated string containing e-mail to search + affects: Start a search for all ICQ users by e-mail -- see notes + returns: Returnss a handle to the search on success, NULL(0) on failure + notes : uses the same scheme as PSS_BASICSEARCH, + *DEPRECATED* in favour of PS_SEARCHBYEMAIL + } + MS_ICQ_SEARCHBYEMAIL = 'ICQ/SearchByEmail'; + + { + wParam : 0 + lParam : POinter to a TICQDETAILSSEARCH structure + Affect : Start a search of all ICQ users by details, see notes + Returns: A handle to the search on success, NULL(0) on failure + Notes : Results are returned in the same scheme as in PSS_BASICSEARCH, + Not recommended, use PS_SEARCHBYNAME + } + MS_ICQ_SEARCHBYDETAILS = 'ICQ/SearchByDetails'; + + { + wParam : Pointer to a null terminated string containing phone number + lParam : Pointer to a null terminated string containing the message + Affect : Send an SMS via the ICQ network, See notes + Returns: Handle to the send on success, NULL(0) on failure + Notes : the phone number should be the full number with internation code + and prefixed by + e.g. +44 + } + MS_ICQ_SENDSMS = 'ICQ/SendSMS'; + + { + wParam : level + lParam : null terminated string containing logging message + Affect : a logging message was sent from ICQLib + } + ME_ICQ_LOG = 'ICQ/Log'; + +{$ENDIF} + + {$ifdef __} +//Changing user info: +//See documentation of PS_CHANGEINFO +//The changing user info stuff built into the protocol is purposely extremely +//thin, to the extent that your data is passed as-is to the server without +//verification. Don't mess up. +//Everything is byte-aligned +//WORD: 2 bytes, little-endian (that's x86 order) +//DWORD: 4 bytes, little-endian +//LNTS: a WORD containing the length of the string, followed by the string +// itself. No zero terminator. +#define ICQCHANGEINFO_MAIN 0xEA03 +/* pInfoData points to: + WORD datalen + LNTS nick + LNTS first + LNTS last + LNTS email + LNTS city + LNTS state + LNTS phone + LNTS fax + LNTS street + LNTS cellular (if SMS-able string contains an ending ' SMS') + LNTS zip + WORD country + BYTE gmt + BYTE unknown, usually 0 +*/ +#define ICQCHANGEINFO_MORE 0xFD03 +/* pInfoData points to: + WORD datalen + BYTE age + BYTE 0 + BYTE sex + LNTS homepage + WORD birth-year + BYTE birth-month + BYTE birth-day + BYTE lang1 + BYTE lang2 + BYTE lang3 +*/ +#define ICQCHANGEINFO_ABOUT 0x0604 +/* pInfoData points to: + WORD datalen + LNTS about +*/ +#define ICQCHANGEINFO_WORK 0xF303 +/* pInfoData points to: + WORD datalen + LNTS city + LNTS state + DWORD 0 + LNTS street + LNTS zip + WORD country + LNTS company-name + LNTS company-dept + LNTS company-position + WORD 0 + LNTS company-web +*/ +#define ICQCHANGEINFO_PASSWORD 0x2E04 +/* pInfoData points to: + WORD datalen + LNTS newpassword +*/ + {$endif} + diff --git a/include/delphi/m_ignore.inc b/include/delphi/m_ignore.inc new file mode 100644 index 0000000000..4dd83c4cee --- /dev/null +++ b/include/delphi/m_ignore.inc @@ -0,0 +1,74 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_IGNORE} +{$DEFINE M_IGNORE} + + { this module only provides UI and storage for blocking only, protocol modules + are responsible for implementing the block } + +const + + IGNOREEVENT_ALL = LPARAM(-1); + IGNOREEVENT_MESSAGE = 1; + IGNOREEVENT_URL = 2; + IGNOREEVENT_FILE = 3; + IGNOREEVENT_USERONLINE = 4; + IGNOREEVENT_AUTHORIZATION=5; + IGNOREEVENT_YOUWEREADDED=6; // 0.3.3a+ + + { + wParam : HCONTACT + lParam : IGNOREEVENT_* + Affects: Determines if a message type to a contact should be ignored, see notes + Returns: 0 if the message type MUST be shown [non zero] if it MUST be ignored + Notes : HCONTACT can be NULL(0) to see what to do with a contact + that isn't on the list (or is unknown in some way) + don't use the IGNOREEVENT_ALL type! + Version: v0.1.0.1+ + } + MS_IGNORE_ISIGNORED = 'Ignore/IsIgnored'; + + { + wParam : HCONTACT + lParam : IGNOREEVENT_* constant + Affects: Ignore future messages from a contact, see notes + Returns: 0 on success, [nonzero] on failure + Notes : wParam: NULL(0) can be used to see if an unknown contact should be ignored + or not - you can't SET unknown contact's ignore types, this is to stop + a plugin allowing certain functions (I guess) + Version: v0.1.0.1+ + } + MS_IGNORE_IGNORE = 'Ignore/Ignore'; + + { + wParam : HCONTACT + lParam : IGNOREEVENT_* + Affects: Receive future messages from a contact -- of the given type, see notes + Returns: 0 on success, non zero on failure + Notes : Use NULL(0) for HCONTACT to retrieve the setting for an unknown contact + Version: v0.1.0.1+ + } + MS_IGNORE_UNIGNORE = 'Ignore/Unignore'; + +{$ENDIF} diff --git a/include/delphi/m_langpack.inc b/include/delphi/m_langpack.inc new file mode 100644 index 0000000000..2c1f99478c --- /dev/null +++ b/include/delphi/m_langpack.inc @@ -0,0 +1,82 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_LANGPACK} +{$DEFINE M_LANGPACK} + +const + + { + wParam : 0 + lParam : pointer to a null terminated string + Affects: Returns a pointer to a localised string, if there is no known + translation it will return lParam, the return value does *not* + have to be freed in anyway (if successful) -- see notes + Returns: a pointer to a null terminated string + Notes : No check is done to see if Miranda has the required version + Version: v0.1.1.0+ + } + MS_LANGPACK_TRANSLATESTRING = 'LangPack/TranslateString'; + + { + wParam : 0 + lParam : Pointer to a LANGPACKTRANSLATEDIALOG initialised structure, see notes + Affects: Translates a dialog into the user's local language + Returns: 0 on successs [non zero] on failure + Notes : this service only knows about the following window classes/elements: + Window titles, STATIC, EDIT, Hyperlink, BUTTON. + Version: v0.1.1.0+ + } + +type + + PLANGPACKTRANSLATEDIALOG = ^TLANGPACKTRANSLATEDIALOG; + TLANGPACKTRANSLATEDIALOG = record + cbSize: int; + flags: DWORD; + hwndDlg: THandle; + ignoreControls: ^Integer; // pointer to an array of integers? mebbe? + end; + +const + + { translate all edit controls, by default non-read-only edit controls are not } + LPTDF_NOIGNOREEDIT = 1; + { don't translate the title of the dialog } + LPTDF_NOTITLE = 2; + + MS_LANGPACK_TRANSLATEDIALOG = 'LangPack/TranslateDialog'; + + { + wParam : HMENU handle (WinAPI handle to a menu) + lParam : 0 + Affects: Translates a menu into the user's local language -- see notes + Returns: 0 on success [non zero] on failure + Notes : This doesn't work with owner draw menus that store their + captions in a structure known by the owner -- something to be aware of ;) + version: v0.1.1.0+ + } + MS_LANGPACK_TRANSLATEMENU = 'LangPack/TranslateMenu'; + +{$ENDIF} diff --git a/include/delphi/m_message.inc b/include/delphi/m_message.inc new file mode 100644 index 0000000000..dec113bb53 --- /dev/null +++ b/include/delphi/m_message.inc @@ -0,0 +1,57 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_MESSAGE} +{$DEFINE M_MESSAGE} + +const + + { + wParam : HCONTACT + lParam : Pointer to a null terminated string + Affects: brings up the send message dialog for a contact, see notes + Returns: 0 on success, non zero on failure + Notes : returns immediately, just after the send dialog is shown, + the lParam is entered into the editbox of the window, + but it's not sent. + Version: v0.1.2.0+ only supports a string, prior NULL(0) is expected + this service was defined as 'SRMsg/LaunchMessageWindow' + use both if compatibility use both, the correct one will work, + but don't rely on the message to be displayed + + } + MS_MSG_SENDMESSAGE = 'SRMsg/SendCommand'; + MS_MSG_SENDMESSAGE_OLD = 'SRMsg/LaunchMessageWindow'; + + { + wParam : 0 + lParam : Pointer to a null termed string + Affects: displays the send message dialog with the 'multiple' option open + and no contacts selected + Returns: Returns 0 on success, nonzero on failure + Version: only present after v0.1.2.1+ + } + MS_MSG_FORWARDMESSAGE = 'SRMsg/ForwardMessage'; + +{$ENDIF} diff --git a/include/delphi/m_netlib.inc b/include/delphi/m_netlib.inc new file mode 100644 index 0000000000..8c5f37ef9c --- /dev/null +++ b/include/delphi/m_netlib.inc @@ -0,0 +1,713 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_NETLIB} +{$DEFINE M_NETLIB} + +{>>/ + + NetLib : + + Instead of you writing all the code for working with sockets and supporting + app level protocols such as SOCKS5, it's all done for you. + + NetLib takes care of all that and you can even register a special abstract + nexus, e.g. ICQ direct, the user can configure all this from the options dialog + and you don't have to bother with any of it. + + NetLib wraps up any Winsock calls but you can still get the socket handle + from your netlib handle and do stuff. + + It gives all modules an abstract way of dealing with transport -- mainly sockets + and proxies, Now the but.. + + It's new (mmmm) thus unsupported by any older version of Miranda, and if you + want to be lazy and not write any "wrapper" mini netlib then you'll have + the kudos of "only works with nightly build version of Miranda" :) + +/<<} + + {$ifndef M_SYSTEM} + {$include m_system.inc} + {$endif} + +const + + // for TNETLIBUSER.flags + + { bind incoming ports } + NUF_INCOMING = $01; + { makes outgoing plain connections } + NUF_OUTGOING = $02; + { can use HTTP gateway for plain sockets. ???HttpGateway* are valid, + enables the HTTP proxy option, displayed in options } + NUF_HTTPGATEWAY = $04; + { don't show this as an entry for custom settings to be defined for, + TNETLIB.szDescriptiveName is ignored } + NUF_NOOPTIONS = $08; + { some connections are made for HTTP communication, + enables the HTTP proxy option, displayed in options } + NUF_HTTPCONNS = $10; + { Disables the HTTPS proxy option in options, Use this if all communication + is HTTP } + NUF_NOHTTPSOPTION = $20; + + // for TNETLIBUSERSETTINGS.proxyType + + { SOCKS4 -- No DNS or multi addressing mode (proxy side) -- optional username can + be given, no password } + PROXYTYPE_SOCKS4 = 1; + { SOCKS5 -- DNS names can be given as addresses to connect to, optional + plain text username/password scheme (which may cause failure due to denied access) + IP address maybe returned for DNS addresses -- thus server side DNS } + PROXYTYPE_SOCKS5 = 2; + PROXYTYPE_HTTP = 3; + PROXYTYPE_HTTPS = 4; + + // for TNETLIBOPENCONNECTION.flags + + { this connection will be useed for HTTP communications, + if configured for an HTTP(S) proxy the connection is opened as if there + was no proxy } + + NLOCF_HTTP = $0001; + + // for TNETLIBHTTPPROXYINFO.flags + + { append sequence numbers to GET requests } + NLHPIF_USEGETSEQUENCE = $0001; + { append sequence numbers to POST requests } + NLHPIF_USEPOSTSEQUENCE = $0002; + { GET and POST use the same sequence } + NLHPIF_GETPOSTSAMESEQUENCE = $0004; + + // for TNETLIBHTTPREQUEST.flags, .requestType + + { used by MS_NETLIB_RECVHTTPHEADERS returned structure } + + REQUEST_RESPONSE = 0; + REQUEST_GET = 1; + REQUEST_POST = 2; + REQUEST_CONNECT = 3; + + { auto generate a 'host' header from .szUrl } + NLHRF_GENERATEHOST = $00000001; + { remove any host and/or protocol portion of szUrl before sending it } + NLHRF_REMOVEHOST = $00000002; + { removes host and/or protocol from szUrl unless the connection was + opened through an HTTP or HTTPS proxy. } + NLHRF_SMARTREMOVEHOST = $00000004; + { if the connection was opened through an HTTP or HTTPS proxy then + send a Proxy-Authorization header if required. } + NLHRF_SMARTAUTHHEADER = $00000008; + { never dump this to the log } + NLHRF_NODUMP = $00010000; + { don't dump http headers (only useful for POSTs and MS_NETLIB_HTTPTRANSACTION } + NLHRF_NODUMPHEADERS = $00020000; + { this transaction is a proxy communication. For dump filtering only. } + NLHRF_DUMPPROXY = $00040000; + { dump posted and reply data as text. Headers are always dumped as text. } + NLHRF_DUMPASTEXT = $00080000; + + // for TNETLIBBUFFER.flags + + { don't wrap outgoing packet using TNETLIBUSER.pfnHttpGatewayWrapSend } + MSG_NOHTTPGATEWAYWRAP = $010000; + { don't dump this packet to the log } + MSG_NODUMP = $020000; + { this iss proxy communication, for dump filtering only } + MSG_DUMPPROXY = $040000; + { don't dump as hex, it's text } + MSG_DUMPASTEXT = $080000; + { send as raw, bybpass HTTP proxy stuff } + MSG_RAW = $100000; + + + // all record types structures are declared in their own block because the C header + // file used forward declaration (to get typed parameters for certain function pointers) + // This sort of define-type-pointer-before-type can only be done in the same type block + // in D2 (don't know about later versions) + +type + + { forward typed pointers to records } + + PNETLIBOPENCONNECTION = ^TNETLIBOPENCONNECTION; + PNETLIBHTTPREQUEST = ^TNETLIBHTTPREQUEST; + + { This function pointer is to the CRT realloc() used by Miranda -- it allows reallocation of memory passed + to us (not that we could EVER share the same CRT) but to allow DLLs in general to reallocate memory } + TNetlibRealloc = function(Mem: Pointer; size_t: int): Pointer; cdecl; + TNetlibHTTPGatewayInitProc = function(hConn: THandle; nloc: PNETLIBOPENCONNECTION; nlhr: PNETLIBHTTPREQUEST): int; cdecl; + TNetlibHTTPGatewayBeginProc = function(hConn: THandle; nloc: PNETLIBOPENCONNECTION): int; cdecl; + TNetlibHTTPGatewayWrapSendProc = function(hConn: THandle; buf: PByte; len: int; flags: int; pfnNetLibSend: TMIRANDASERVICE): int; cdecl; + TNetlibHTTPGatewayUnwrapRecvProc = function(nlhr: PNETLIBHTTPREQUEST; buf: PByte; len: int; outBufLen: pInt; NetlibRealloc: TNetlibRealloc): PByte; cdecl; + + PNETLIBUSER = ^TNETLIBUSER; + TNETLIBUSER = record + cbSize: int; + { used for DB settings and log, 'NL' stuff } + szSettingsModule: PChar; + { shows a descriptive name for which different proxy settings can be defined } + szDescriptiveName: PChar; + { see NUF_* constants above } + flags: DWORD; + szHttpGatewayHello: PChar; + { can be NULL(0) to send no User-Agent: also used by HTTPS proxies } + szHttpGatewayUserAgent: PChar; + pfnHttpGatewayInit: TNetlibHTTPGatewayInitProc; + { can be NULL(0) if no begin is required } + pfnHttpGatewayBegin: TNetlibHTTPGatewayBeginProc; + { can be NULL(0) if no wrapping is required } + pfnHttpGatewayWrapSend: TNetlibHTTPGatewayWrapSendProc; + { can be NULL(0) " " } + pfnHttpGatewayUnwrapRecv: TNetlibHTTPGatewayUnwrapRecvProc; + { only if NUF_INCOMING, will be used for validation of user input } + minIncomingPorts: int; + end; + + PNETLIBUSERSETTINGS = ^TNETLIBUSERSETTINGS; + TNETLIBUSERSETTINGS = record + { filled before calling } + cbSize: int; + { 1 or 0 } + useProxy: int; + { PROXYTYPE_* constant, see above } + proxyType: int; + { can be NULL(0) } + szProxyServer: PChar; + { in host byte order } + wProxyPort: int; + { 1 or 0, always 0 for SOCKS4 (doesn't have auth) } + useProxyAuth: int; + { can be NULL(0), always used by SOCKS4 } + szProxyAuthUser: PChar; + { can be NULL(0) } + szProxyAuthPassword: PChar; + { 1 or 0, only used by HTTP, HTTPS } + useProxyAuthNtlm: int; + { 1 or 0 } + dnsThroughProxy: int; + { 1 or 0 } + specifyIncomingPorts: int; + { can be NULL(0), form '1024-1050,1060-1070,2000' } + szIncomingPorts: PChar; + end; + + TNetlibNewConnectionProc = procedure(hNewConnection: THandle; dwRemoveIP: DWORD); cdecl; + + PNETLIBBIND = ^TNETLIBBIND; + TNETLIBBIND = record + cbSize: int; + { function to call when there's a new connection, dwRemoteIP is in host byte + order -- the handle is to the new connection } + pfnNewConnection: TNetlibNewConnectionProc; + { set on return, host byte order } + dwInternalIP: DWORD; + { set on return, host byte order } + wPort: WORD; + end; + + { Pointered type is above } + TNETLIBOPENCONNECTION = record + cbSize: int; + szHost: PChar; // can be an IP in string form + wPort: Word; + flags: DWORD; // see NLOCF_* flags + end; + + PNETLIBHTTPPROXYINFO = ^TNETLIBHTTPPROXYINFO; + TNETLIBHTTPPROXYINFO = record + cbSize: int; + { see NLHPIF_* above } + flags: DWORD; + szHttpPostUrl: PChar; + szHttpGetUrl: PChar; + firstGetSequence: int; + firstPostSequence: int; + end; + + PNETLIBBASE64 = ^TNETLIBBASE64; + TNETLIBBASE64 = record + pszEncoded: PChar; + cchEncoded: int; + pbDecoded: PByte; + cbDecoded: int; + end; + + PNETLIBHTTPHEADER = ^TNETLIBHTTPHEADER; + TNETLIBHTTPHEADER = record + szName: PChar; + szValue: PChar; + end; + + { PNETLIBHTTPREQUEST = ^TNETLIBHTTPREQUEST, defined above because this is + forward referenced from there } + TNETLIBHTTPREQUEST = record + cbSize: int; + requestType: int; // REQUEST_* constant + flags: DWORD; + szUrl: PChar; + { doesn't contain Content-Length, it'll be added automatically } + headers: PNETLIBHTTPHEADER; // pointer to an array of em? + headersCount: int; // yes they do + pData: PChar; // data to be sent on POST request + dataLength: int; // must be 0 for REQUEST_GET/REQUEST_CONNECT + resultCode: int; + szResultDescr: PChar; + end; + + PNETLIBBUFFER = ^TNETLIBBUFFER; + TNETLIBBUFFER = record + buf: PChar; + len: int; + { see MSG_* constants above } + flags: int; + end; + + PNETLIBSELECT = ^TNETLIBSELECT; + TNETLIBSELECT = record + cbSize: int; + dwTimeout: DWORD; // in milliseconds, INFINITE is acceptable + hReadConns: array[0..64+1] of THandle; + hWriteConns: array[0..64+1] of THandle; + hExceptConns: array[0..64+1] of THandle; + end; + + PNETLIBPACKETRECVER = ^TNETLIBPACKETRECVER; + TNETLIBPACKETRECVER = record + cbSize: int; + { infinite is allowed -- initialise before use } + dwTimeout: DWORD; + { this many bytes are removed from the start of the buffer, + set to 0 on return -- initialise before use } + bytesUsed: int; + { equal the returnd value by service, unless the return value is 0 (connection closed) } + bytesAvailable: int; + { same as the parameter given to MS_NETLIB_CREATEPACKETRECVER: wParam } + bufferSize: int; + { contains the read data } + buffer: PByte; + end; + +const + + { + wParam : 0 + lParam : Pointer to an initalised TNETLIBUSER structure + Affects: Initialises the netlib for a set of connections, see notes + Returns: Returns a handle for future netlib calls, NULL on failure. + Notes : Netlib is loaded AFTER all plugins, thus a call to this service + in Load() will fail, hook ME_SYSTEM_MODULESLOADED and call it + from there. + - + Netlib will save settings under .szSettings module, all settings + (being?) begin with 'NL'. + - + Defacto settings are the same as combobox entry option + as seen in Miranda->Options->Network + Version: v0.1.2.2+ + Errors : ERROR_INVALID_PARAMETER, ERROR_OUTOFMEMORY, ERROR_DUP_NAME + } + MS_NETLIB_REGISTERUSER = 'Netlib/RegisterUser'; + + { + wParam : HANDLE + lParam : Pointer to a initalised TNETLIBUSERSETTINGS structure + Affects: Gets the user configured settings for a Netlib user, see notes + Returns: [non zero] on SUCCESS, NULL(0) on failure + Notes : .cbSize must be filled with sizeof() before calling -- + the returned null terminated strings (in the structure) are valid + as long as HANDLE remains open or proxy options are changed + again, do not rely on them being around forever. + Version: v0.1.2.2+ + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_GETUSERSETTINGS = 'Netlib/GetUserSettings'; + + { + wParam : HANDLE + lParam : Pointer to a initalised NETLIBUSERSETTINGS structure + Affect : Changes the configurable settings for a Netlib user -- see notes + Returns: [non zero] on success, NULL(0) on failure + Notes : This service is only really useful for people that specify NUF_NOOPTIONS + when registering and want to create their own options. + Settings will be stored even if the option to enable it, is it not enabled, + e.g. useProxyAuth is 0, szProxyAuthPassword will still be saved + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_SETUSERSETTINGS = 'Netlib/SetUserSettings'; + + { + wParam : HANDLE / SOCKET + lParam : 0 + Affects: Closes a handle, see notes + Returns: Returns [non zero] on success, NULL(0) on failure + Notes : All netlib handles should be closed once they're finished with, + If a SOCKET type is passed instead of netlib handle type, it is closed + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_CLOSEHANDLE = 'Netlib/CloseHandle'; + + { + wParam : HANDLE + lParam : Pointer to a initialised TNETLIBBIND + Affects: Open a port and wait for connections on it -- see notes + Returns: Returns a handle on success, NULL(0) on failure + Notes : this function does the equivalent of socket(), bind(), getsockname(), + listen(), accept() -- internally this function creates a new thread + which waits around in accept() for new connections. + When one is received, TNETLIBBIND.pfnNewConnection is called, + from the context of the NEW thread and then it + returns to waiting for connections. + - + Close the returned handle to end the thread and close the port. + - + Errors : ERROR_INVALID_PARAMETER, any returned by socket(), bind(), listen() + getsockname() + } + MS_NETLIB_BINDPORT = 'Netlib/BindPort'; + + { + wParam : HANDLE + lParam : Pointer to an initalised TNETLIBOPENCONNECTION structure + Affects: Opens a connection -- see notes + Returns: Returns a Handle to a new connection on success, NULL(0) on failure + Notes : internally this service is the equivalent of socket(), gethostbyname(), + connect() + - + If NLOCF_HTTP is set and HANDLE is configured for HTTP(S) proxy + then this function will connect() to that proxy server ONLY, + without performing any initialisation conversation. + - + If HANDLE is configured for an HTTP proxy and does not support + HTTP gateways and you try to open a connection without NLOCF_HTTP + then this service will first attempt to open an HTTPS connection, + if that fails, it will try a direct connection, if *that* fails + then it will return failure with the error + from connect() during the connection attempt + Errors : ERROR_INVALID_PARAMETER, any returned by socket(), gethostbyname(), + connect(), MS_NETLIB_SEND, MS_NETLIB_RECV, select() + - + ERROR_TIMEOUT (during proxy communication) + ERROR_BAD_FORMAT (very invalid proxy reply) + ERROR_ACCESS_DENIED (by proxy) + ERROR_CONNECTION_UNAVAIL (socks proxy can't connect to identd) + ERROR_INVALID_ACCESS (proxy refused identd auth) + ERROR_INVALID_DATA (proxy returned invalid code) + ERROR_INVALID_ID_AUTHORITY (proxy requires use of auth method that's not supported) + ERROR_GEN_FAILURE (socks5/https general failure) + ERROR_CALL_NOT_IMPLEMENTED (socks5 command not supported) + ERROR_INVALID_ADDRESS (socks5 address type not supported) + - + HTTP: anything from TNETLIBUSER.pfnHttpGatewayInit, TNETLIBUSER.pfnHttpGatewayBegin, + MS_NETLIB_SENDHTTPREQUEST or MS_NETLIB_RECVHTTPHEADERS + } + MS_NETLIB_OPENCONNECTION = 'Netlib/OpenConnection'; + + { + wParam : HANDLE + lParam : Pointer to an initialised NETLIBHTTPPROXYINFO structure + Affects: Sets the required information for an HTTP proxy connection -- see notes + Returns: [non zero] on success, NULL(0) on failure + Notes : This service is designed to be called from + within TNETLIBUSER.pfnHttpGatewayInit (see notes in C header under + MS_NETLIB_REGISTERUSER) + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_SETHTTPPROXYINFO = 'Netlib/SetHttpProxyInfo'; + + { + wParam : HANDLE + lParam : 0 + Affects: Get's the SOCKET associated with a handle -- see notes + Returns: the SOCKET on success, INVALID_SOCKET on failure + Notes : The Netlib handle passed to this service should only be passed + if they were returned with MS_NETLIB_OPENCONNECTION or MS_NETLIB_BINDPORT + - + Be careful how you use this socket because you might be connected via an + HTTP proxy, in which case calling send/recv() will break things + - + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_GETSOCKET = 'Netlib/GetSocket'; + + { + wParam : 0 + lParam : Pointer to a null terminated string + Affects: URL-encodes a string for x-www-form-urlencoded (and other uses) -- see notes + Returns: A pointer to a null terminated string, NULL(0) on failure + Notes : The returned string must be freed after it's no longer needed, + to do this Miranda's process heap must be used (under the WINAPI), e.g. + HeapFree(GetProcessHeap(), 0, the_returned_string) + Errors : ERROR_INVALID_PARAMETER, ERROR_OUTOFMEMORY + } + MS_NETLIB_URLENCODE = 'Netlib/UrlEncode'; + + { + wParam : 0 + lParam : Pointer to a TNETLIBBASE64 initialised structure + Affects: Decodes a Base64 null terminated string, see notes + Returns: [non zero] on success, NULL(0) on failure + Notes : TNETLIBBASE64.pszEncoded and cchEncoded must contain a pointer to + a buffer to use as input, and it's length, the length + should not include space taken for null termination -- + - + Output is placed in ..pbDecoded and ..cbDecoded for buffer and + length of buffer -- the maxiumum output for a given input can + be worked out with Netlib_GetBase64DecodedBufferSize() function + see below. + - + For more information on Base64 see rfc-1421. + Errors : ERROR_INVALID_PARAMETER, ERROR_INVALID_DATA, ERROR_BUFFER_OVERFLOW + } + MS_NETLIB_BASE64DECODE = 'Netlib/Base64Decode'; + + { + wParam : 0 + lParam : Pointer to an initialised TNETLIBBASE64 structure + Affect : Base64 encode a string, see notes + Returns: [non zero] on success, NULL(0) on failure + Notes : TNETLIBBASE64.pbDecode and TNETLIBBASE64.cbDecoded contain + the input buffer and it's length -- + TNETLIBBASE64.pszEncoded and TNETLIBBASE64.cchEncoded contain the + buffer in which to put the output and it's length. + - + The maximum output size for a given input can be worked + out with the function Netlib_GetBase64EncodedBufferSize() below + .pszEncoded is null terminated, on return TNETLIBBASE64.cchEncoded + is set to the actual length excluding 0. + Errors : ERROR_INVALID_PARAMETER, ERROR_BUFFER_OVERFLOW + } + MS_NETLIB_BASE64ENCODE = 'Netlib/Base64Encode'; + + { + wParam : HANDLE + lParam : Pointer to a initialised TNETLIBHTTPREQUEST structure + Affect : Send an HTTP request over a connection, see notes + Returns: The number of bytes on success, SOCKET_ERROR on failure + Notes : HANDLE must of been returned by MS_NETLIB_OPENCONNECTION,, + If you use NLHRF_SMARTAUTHHEADER and NTLM auth is in use then + full NTLM auth transcation occurs, comprising sending the + domain, getting the challenge, sending the response. + NETLIBHTTPREQUEST.resultCode and NETLIBHTTPREQUEST.szResultDescr are + ignored by this service. + Errors : ERROR_INVALID_PARAMETER, MS_NETLIB_SEND (return codes) + } + MS_NETLIB_SENDHTTPREQUEST = 'Netlib/SendHttpRequest'; + + { + wParam : HANDLE + lParam : 0 + Affect : Receive HTTP headers, see notes + Returns: A pointer to a TNETLIBHTTPREQUEST structure on success, NULL(0) on failure + Notes : The returned pointer must be freed after it's done with + use MS_NETLIB_FREEHTTPREQUESTSTRUCT. + - + HANDLE must be returned by MS_NETLIB_OPENCONNECTION + - + Return^.pData=NIL and Return^.dataLength=0 always + - + The returned data should be retrieved using MS_NETLIB_RECV once + the headers have been parsed. + If headers haven't finished within 60 seconds the function returns + NULL(0) and ERROR_TIMEOUT + Errors : ERROR_INVALID_PARAMETER, any MS_NETLIB_RECV or select() + ERROR_HANDLE_EOF (connection closed bfore headers complete) + ERROR_TIMEOUT (headers still not complete after 60 seconds) + ERROR_BAD_FORMAT (invalid character or line ending in headers, or first line is blank) + ERROR_BUFFER_OVERFLOW (each header line must be less than 4096 chars long) + ERROR_INVALID_DATA (first header line is malformed ("http/[01].[0-9] [0-9]+ .*", or no colon in subsequent line) + + } + MS_NETLIB_RECVHTTPHEADERS = 'Netlib/RecvHttpHeaders'; + + { + wParam : 0 + lParam : Pointer returned by MS_NETLIB_RECVHTTPHEADERS to free + Affect : Free the memory used by a TNETLIBHTTPREQUEST structure, see notes + Returns: [non zero] on success, NULL(0) on failure + Notes : This service should only be used with memory pointers returned + by either MS_NETLIB_RECVHTTPHEADERS or MS_NETLIB_HTTPTRANSACTION!. + Errors : ERROR_INVALID_PARAMETER + + } + MS_NETLIB_FREEHTTPREQUESTSTRUCT = 'Netlib/FreeHttpRequestStruct'; + + { + wParam : HANDLE + lParam : Pointer to a TNETLIBHTTPREQUEST structure + Affect : Carry out an entire HTTP transaction, see notes + Returns: another pointer to a TNETLIBHTTPREQUEST structure or NULL(0) + on failure + Notes : The returned pointer must be freed at some point + with MS_NETLIB_FREEHTTPREQUESTSTRUCT, + - + TNETLIBHTTPREQUEST.szUrl should have a full HTTP URL, if it + does not start with http://, that will be assumed, but do not + take this assumption to stay assumed (heh..) in the future + - + this service equivalent of open(), sendhttp(), getheaders() + netlib_recv(), netlib_closehandle() + - + TNETLIBHTTPREQUEST.headers will be added to with the following + headers if they're not already present : + "Host" (even if it is requested in .flags) + "User-Agent" (in form : 'Miranda/d.d.d.d <(status of release)>') + "Content-Length" (for POSTs only, set to TNETLIBHTTPREQUEST.dataLength) + + If you don't want to send any of these headers -- + set TNETLIBHTTPREQUEST.headers to NULL(0) + - + In the returned pointer, pData[dataLen] is always 0 for 'safety' + also : headers, headersCount, pData, dataLength, resultCode and + szResultDescr are all valid + - + Also take care not to assume that a returned pointer means that + at the HTTP level it all worked out -- refer to the resultCode for + 2xx before doing anything else + - + Errors : ERROR_INVALID_PARAMETER, ERROR_OUTOFMEMORY + Errors returned by the aforementioned internally used functions + } + MS_NETLIB_HTTPTRANSACTION = 'Netlib/HttpTransaction'; + + { + wParam : HANDLE + lParam : Pointer to an initialised TNETLIBBUFFER structure + Affect : Send data over an open connection see notes + Returns: The number of bytes sent on success, SOCKET_ERROR on failure + Notes : see Netlib_Send() helper function + Errors : ERROR_INVALID_PARAMETER, + anything from socket(), connect() + send(), TNETLIBUSER.pfnHttpGatewayWrapSend(), + (HTTP proxy): ERROR_GEN_FAILURE (http result code wasn't 2xx) + MS_NETLIB_SENDHTTPREQUEST, MS_NETLIB_RECVHTTPHEADERS + } + MS_NETLIB_SEND = 'Netlib/Send'; + + { + wParam : HANDLE + lParam : Pointer to an initialised TNETLIBBUFFER structure + Affect : Receive data over a connection, see notes + Returns: The number of bytes read on success, SOCKET_ERROR on failure + Notes : + This service uses some of the same flags as MS_NETLIB_SEND : + MSG_PEEK, + MSG_NODUMP, + MSG_DUMPPROXY, + MSG_NOHTTPGATEWAYWRAP, + MSG_DUMPASTEXT, + MSG_RAW + - + On using MSG_NOHTTPGATEWAYWRAP: Because packets through an HTTP proxy are + batched and cached and stuff, using this flag is not a guarantee that it + will be obeyed, and if it is it may even be propogated to future calls + even if you don't specify it then. Because of this, the flag should be + considered an all-or-nothing thing: either use it for the entire duration + of a connection, or not at all. + Errors : ERROR_INVALID_PARAMETER, anything from recv() + (HTTP proxy): + ERROR_GEN_FAILURE (http result code wasn't 2xx) + ERROR_INVALID_DATA (no Content-Length header in reply) + ERROR_NOT_ENOUGH_MEMORY (Content-Length very large) + ERROR_HANDLE_EOF (connection closed before Content-Length bytes recved) + anything from select(), + MS_NETLIB_RECVHTTPHEADERS, nlu.pfnHttpGatewayUnwrapRecv, socket(), + connect(), MS_NETLIB_SENDHTTPREQUEST + + } + MS_NETLIB_RECV = 'Netlib/Recv'; + + { + wParam : 0 + lParam : Pointer to an initialised TNETLIBSELECT structure + Affect : Determine the status of one or more connections, see notes + Returns: The numbe of ready connections, SOCKET_ERROR on failure + Notes : All handles passed to this service must have been returned + either by MS_NETLIB_OPENCONNECTION or MS_NETLIB_BINDPORT, + the last handle in each list must be followed by either NULL + or INVALID_HANDLE_VALUE. + Errors : ERROR_INVALID_HANDLE, ERROR_INVALID_DATA, anything from select() + } + MS_NETLIB_SELECT = 'Netlib/Select'; + + { + wParam : HANDLE + lParam : maxPacketSize + Affect : Create a packet receiver, see notes + Returns: A handle on success, NULL(0) on failure + Notes : The packet receiver implements the common situation where + you have a variable length of packets coming thru over a connection + and you want them split up in order to handle them. + - + The major limiation is, that the buffer is created in memory, + so you can't have arbitrarily large packets + Errors : ERROR_INVALID_PARAMETER, ERROR_OUTOFMEMORY + } + MS_NETLIB_CREATEPACKETRECVER = 'Netlib/CreatePacketRecver'; + + { + wParam : Handle returned by MS_NETLIB_CREATEPACKETRECVER + lParam : Pointer to an initialised TNETLIBPACKETRECVER + Returns: The total number of bytes available in the buffer, NULL(0) + if the connection was closed or SOCKET_ERROR. + - + If TNETLIBPACKETRECVER.bytesUsed is set to zero and the + buffer is already full up to the maxPacketSize, it is assumed + that a too large packet has been received, All data in + the buffer is discarded and receiving has started anew. + - + This will probably cause alignment problem so if you think + that tis iss likely to happen, then you should deal with it + yourself. + - + Closing the packet receiver will not close the associated + connection but will discard any bytes still in the buffer, + so if you intend to carry on reading from that connection, + make sure you have processed the buffer first. + - + This service is equivalent of memmove() to remove + the first bytesUsed from the buffer, select(), if dwTimeOut + is not INFINITE, then MS_NETLIB_RECV + Errors : ERROR_INVALID_PARAMETER, ERROR_TIMEOUT, anything from select(), + MS_NETLIB_RECV + } + MS_NETLIB_GETMOREPACKETS = 'Netlib/GetMorePackets'; + + { + wParam : HANDLE + lParam : Pointer to null terminated string to uh, log. + Affect : Add a message to the log (if it's running) see notes + Returns: non zeror on success, NULL(0) on failure + Notes : Don't include \r\n or #13#10 it's not needed, + - + Doesn't support formatting like the given C code for + Netlib_Logf, just use FmtStr() and then call this service + if you want that. + Errors : ERROR_INVALID_PARAMETER + } + MS_NETLIB_LOG = 'Netlib/Log'; + +{$ENDIF} diff --git a/include/delphi/m_options.inc b/include/delphi/m_options.inc new file mode 100644 index 0000000000..23d891a81c --- /dev/null +++ b/include/delphi/m_options.inc @@ -0,0 +1,109 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_OPTIONS} +{$DEFINE M_OPTIONS} + +const + + { + wParam : addinfo + lParam : 0 + Affects: The user opened the options dialog, see notes + Notes : Modules should do whatever initalisation they need and call + MS_OPT_ADDPAGE with the wParam -- MS_OPT_ADDPAGE + can be called one or more times + if more than one page wants to be displayed. + } + ME_OPT_INITIALISE = 'Opt/Initialise'; + + { + wParam : wParam from ME_OPT_INITIALISE + lParam : Pointer to an initialised TOPTIONSDIALOGPAGE + Affects: Adds a page to the options dialog, see notes + Notes : Strings in the structure can be released as soon as the + service returns -- but icons must be kept around, this iss + not a problem if you're loading theem from a resource. + - + This service should only be called within the ME_OPT_INITIALISE + event hook. + - + Pages in the options dialog operate just like pages in property + sheets, See the WinAPI documentation for details on how they operate. + Version: Prior to v0.1.2.1 the options dialog would resize + to fit the largest page, but since then it's a fixed size + The largest page that fits neatly is 314x240 DLU's + - + Some of OPTIONSDIALOGPAGE's fields are version dependant. + } + MS_OPT_ADDPAGE = 'Opt/AddPage'; + + { defacto size } + + OPTIONSDIALOGPAGE_V0100_SIZE = $18; + OPTIONSDIALOGPAGE_V0120_SIZE = $28; + + { page is only shown when in 'simple' mode } + ODPF_SIMPLEONLY = 1; + { page is only shown when in 'expert' mode } + ODPF_EXPERTONLY = 2; + { give group box titles a bold font } + ODPF_BOLDGROUPS = 4; + +type + + POPTIONSDIALOGPAGE = ^TOPTIONSDIALOGPAGE; + TOPTIONSDIALOGPAGE = record + cbSize: int; + position: int; // position number, lower numbers are top most + pszTitle: PChar; + pfnDlgProc: Pointer; // DLGPROC prototype + pszTemplate: PChar; + hInstance: THandle; + hIcon: THandle; // v0.1.0.1+ + pszGroup: PChar; // v0.1.0.1+ + groupPosition: int; // v0.1.0.1+ + hGroupIcon: THandle; // v0.1.0.1+ + flags: DWORD; // v0.1.2.1+ + { if in simple mode the dialog will be cut off AFTER this control ID, 0 + for disable } + nIDBottomSimpleControl: int; // v0.1.2.1+ + { if in simple mode the dialog will cut off AFTER this control ID, 0 to disable } + nIDRightSimpleControl: int; // v0.1.2.1+ + { these controls will be hidden in simple mode, pointer to an array of ID's + must remain valid for the duration of the dialog } + expertOnlyControls: ^int; + nExpertOnlyControls: int; // v0.1.2.1+ + end; + +const + + { sent to pages via WM_NOTIFY when the expert checkbox is clicked, lParam = new state } + PSN_EXPERTCHANGED = 2; + { returns true/false } + PSM_ISEXPERT = ($0400 + 101); + { returns HFONT used for group box titles } + PSM_GETBOLDFONT = ($0400 + 102); + +{$ENDIF} diff --git a/include/delphi/m_plugins.inc b/include/delphi/m_plugins.inc new file mode 100644 index 0000000000..689b7a39e7 --- /dev/null +++ b/include/delphi/m_plugins.inc @@ -0,0 +1,70 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_PLUGINS} +{$DEFINE M_PLUGINS} + +const + + DEFMOD_PROTOCOLICQ = 1; // removed from v0.3.0.0 alpha + DEFMOD_PROTOCOLMSN = 2; // removed from v0.1.2.0+ + DEFMOD_UIFINDADD = 3; + DEFMOD_UIUSERINFO = 4; + DEFMOD_SRMESSAGE = 5; + DEFMOD_SRURL = 6; + DEFMOD_SREMAIL = 7; + DEFMOD_SRAUTH = 8; + DEFMOD_SRFILE = 9; + DEFMOD_UIHELP = 10; + DEFMOD_UIHISTORY = 11; + DEFMOD_RNDCHECKUPD = 12; + DEFMOD_RNDICQIMPORT = 13; // not built in to v0.1.0.1+ + DEFMOD_RNDAUTOAWAY = 14; + DEFMOD_RNDUSERONLINE = 15; + DEFMOD_RNDCRYPT = 16; // v0.1.0.1-v0.1.2.0 + DEFMOD_SRAWAY = 17; // v0.1.0.1+ + DEFMOD_RNDIGNORE = 18; // v0.1.0.1+ + DEFMOD_UIVISIBILITY = 19; // v0.1.1.0+, options page only + DEFMOD_UICLUI = 20; // v0.1.1.0+ + DEFMOD_UIPLUGINOPTS = 21; // v0.1.2.1+ + DEFMOD_PROTOCOLNETLIB = 22; // v0.1.2.2+ + + DEFMOD_HIGHEST = 22; + + + + { + wParam : 0 + lParam : 0 + Affect : Gets an array of modules that the plugins report they want to replace + Returns: Returns a pointer to an array of ints, with elements 1 or 0, + indexed by the DEFMOD_* constants, 1 is to mark that the default + module shouldn't be loaded, see notes + Notes : this is primarily for use by the core's module initialiser, + but could also be used by modules that are doing + naughty things that are very feature-dependent. + } + MS_PLUGINS_GETDISABLEDEFAULTARRAY = 'Plugins/GetDisableDefaultArray'; + +{$ENDIF} diff --git a/include/delphi/m_popup.inc b/include/delphi/m_popup.inc new file mode 100644 index 0000000000..f8d2ea9df9 --- /dev/null +++ b/include/delphi/m_popup.inc @@ -0,0 +1,222 @@ +(* +=============================================================================== + PopUp plugin +Plugin Name: PopUp +Plugin author: hrk, Luca Santarelli, hrk@users.sourceforge.net +This file has been created by egodust, Sam, egodust@users.sourceforge.net +=============================================================================== + +The purpose of this plugin is to give developers a common "platform/interface" to show PopUps. It is born from the source code of NewStatusNotify, another plugin I've made. + +Remember that users *must* have this plugin enabled, or they won't get any popup. Write this in the requirements, do whatever you wish ;-)... but tell them! +=============================================================================== + +-- To use this file you need Windows.pas, m_globaldefs.pas (get it from the CVS under the 'inc' module) +-- To include this in the source, use {$include m_popup.h} + +*) + +{$ifndef M_POPUP_H} +{$define M_POPUP_H} + +{$ifdef FPC} + {$PACKRECORDS C} + {$MODE Delphi} +{$endif} + +const + + MAX_CONTACTNAME = 2048; + MAX_SECONDLINE = 2048; + + SM_WARNING = $01; //Triangle icon. + SM_NOTIFY = $02; //Exclamation mark icon. + +type + + // for info on what this stuff is, see m_popup.h + + PPOPUPDATA = ^TPOPUPDATA; + TPOPUPDATA = record + lchContact: HCONTACT; + lchIcon: THandle; + lpszContactName: array[0..MAX_CONTACTNAME-1] of Char; + lpszText: array[0..MAX_SECONDLINE-1] of Char; + colorBack: COLORREF; + colorForeText: COLORREF; + PluginWindowProc: Pointer; // must be a window procedure using stdcall + PluginData: Pointer; + end; + +type + + // for info on what this stuff is, see m_popup.h + + PPOPUPDATAEX = ^TPOPUPDATAEX; + TPOPUPDATAEX = record + lchContact: HCONTACT; + lchIcon: THandle; + lpszContactName: array[0..MAX_CONTACTNAME-1] of Char; + lpszText: array[0..MAX_SECONDLINE-1] of Char; + colorBack: COLORREF; + colorForeText: COLORREF; + PluginWindowProc: Pointer; // must be a window procedure using stdcall + PluginData: Pointer; + iSeconds: int; //Custom delay time in seconds. -1 means "forever", 0 means "default time". + cZero: array[0..15] of Char; //16 unused bytes which may come useful in the future. + end; + +const + +(* + Creates, adds and shows a popup, given a (valid) POPUPDATA structure pointer. + wParam = (WPARAM)(*POPUPDATA)PopUpDataAddress + lParam = 0 + Returns: > 0 on success, 0 if creation went bad, -1 if the PopUpData contained unacceptable values. + NOTE: it returns -1 if the PopUpData was not valid, if there were already too many popups, if the module was disabled. + Otherwise, it can return anything else... +*) + + MS_POPUP_ADDPOPUP = 'PopUp/AddPopUp'; + +(* + The same, but with a POPUPDATAEX structure pointer. + wParam = (WPARAM)(*POPUPDATAEX)PopUpDataExAddress + lParam = 0 +*) + + MS_POPUP_ADDPOPUPEX = 'PopUp/AddPopUpEx'; + +(* + Returns the handle to the contact associated to the specified PopUpWindow. + You will probably need to know this handle inside your WNDPROC. Exampole: you want to open the MessageWindow. :-) + Call MS_POPUP_GETCONTACT on the hWnd you were given in the WNDPROC. + wParam = (WPARAM)(HWND)hPopUpWindow + lParam = 0; + Returns: the HANDLE of the contact. Can return NULL, meaning it's the main contact. -1 means failure. +*) + + MS_POPUP_GETCONTACT = 'PopUp/GetContact'; + +(* + wParam = hPopUpWindow + lParam = PluginDataAddress; + Returns: the address of the PLUGINDATA structure. Can return NULL, meaning nothing was given. -1 means failure. + IMPORTANT NOTE: it doesn't seem to work if you do: + CallService(..., (LPARAM)aPointerToAStruct); + and then use that struct. + Do this, instead: + aPointerToStruct = CallService(..., (LPARAM)aPointerToAStruct); + and it will work. Just look at the example I've written above (PopUpDlgProc). +*) + MS_POPUP_GETPLUGINDATA = 'PopUp/GetPluginData'; + +(* + wParam = 0 + lParam = 0 + Returns: 0 if the user has chosen not to have the second line, 1 if he choose to have the second line. +*) + MS_POPUP_ISSECONDLINESHOWN = 'PopUp/IsSecondLineShown'; + +(* + UM_FREEPLUGINDATA + wParam = lParam = 0. Process this message if you have allocated your own memory. (i.e.: POPUPDATA.PluginData != NULL) +*) + UM_FREEPLUGINDATA = ((*WM_USER*)$400 + $200); + +(* + UM_DESTROYPOPUP + wParam = lParam = 0. Send this message when you want to destroy the popup, or use the function below. +*) + UM_DESTROYPOPUP = ((*WM_USER*)$400 + $201); + +(* + UM_INITPOPUP + wParam = (WPARAM)(HWND)hPopUpWindow (but this is useless, since I'll directly send it to your hPopUpWindow + lParam = 0. + This message is sent to the PopUp when its creation has been finished, so POPUPDATA (and thus your PluginData) is reachable. + Catch it if you needed to catch WM_CREATE or WM_INITDIALOG, which you'll never ever get in your entire popup-life. + Return value: if you process this message, return 0. If you don't process it, return 0. Do whatever you like ;-) +*) + UM_INITPOPUP = ($400(*WM_USER*) + $202); + +(* + wParam = hPopUpWindow + lParam = lpzNewText + returns: > 0 for success, -1 for failure, 0 if the failure is due to second line not being shown. (but you could call PUIsSecondLineShown() before changing the text...) + Changes the text displayed in the second line of the popup. +*) + MS_POPUP_CHANGETEXT = 'PopUp/Changetext'; + +(* + This is mainly for developers. + Shows a warning message in a PopUp. It's useful if you need a "MessageBox" like function, but you don't want a modal window (which will interfere with a DialogProcedure. MessageBox steals focus and control, this one not. + wParam = lpzMessage + lParam = 0; Returns: 0 if the popup was shown, -1 in case of failure. +*) + MS_POPUP_SHOWMESSAGE = 'PopUp/ShowMessage'; + + + (* helper functions, will be inlined on FPC if you have the swithces enabled *) + + function PUAddPopup(ppdp: PPOPUPDATA): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := CallService(MS_POPUP_ADDPOPUP, WPARAM(ppdp), 0); + end; + + function PUGetContact(hPopUpWindow: THandle): THandle; + {$ifdef FPC} + inline; + {$endif} + begin + Result := CallService(MS_POPUP_GETCONTACT, WPARAM(hPopUpWindow), 0); + end; + + function PUGetPluginData(hPopUpWindow: THandle): Pointer; + {$ifdef FPC} + inline; + {$endif} + var + dummy: pointer; + begin + dummy := nil; + Int(Result) := CallService(MS_POPUP_GETPLUGINDATA, WPARAM(hPopUpWindow), LPARAM(dummy)); + end; + + function PUIsSecondLineShown: BOOL; + {$ifdef FPC} + inline; + {$endif} + begin + Int(Result) := CallService(MS_POPUP_ISSECONDLINESHOWN, 0, 0); + end; + + function PUDeletePopUp(hWndPopUp: THandle): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := SendMessage(hWndPopUp, UM_DESTROYPOPUP, 0, 0); + end; + + function PUChangeText(hWndPopUp: THandle; lpzNewText: PChar): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := CallService(MS_POPUP_CHANGETEXT, WPARAM(hWndPopUp), LPARAM(lpzNewText)); + end; + + function PUShowMessage(lpzText: PChar; kind: Byte): int; + {$ifdef FPC} + inline; + {$endif} + begin + Result := CallService(MS_POPUP_SHOWMESSAGE, WPARAM(lpzText), LPARAM(kind)); + end; + +{$endif} + diff --git a/include/delphi/m_protocols.inc b/include/delphi/m_protocols.inc new file mode 100644 index 0000000000..f198d40a8b --- /dev/null +++ b/include/delphi/m_protocols.inc @@ -0,0 +1,180 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_PROTOCOLS} +{$DEFINE M_PROTOCOLS} + +const + + ACKTYPE_MESSAGE = 0; + ACKTYPE_URL = 1; + ACKTYPE_FILE = 2; + ACKTYPE_CHAT = 3; + ACKTYPE_AWAYMSG = 4; + ACKTYPE_AUTHREQ = 5; + ACKTYPE_ADDED = 6; + ACKTYPE_GETINFO = 7; + ACKTYPE_SETINFO = 8; + ACKTYPE_LOGIN = 9; + ACKTYPE_SEARCH = 10; + ACKTYPE_NEWUSER = 11; + ACKTYPE_STATUS = 12; + ACKTYPE_CONTACTS = 13; //send/recv of contacts + + ACKRESULT_SUCCESS = 0; + ACKRESULT_FAILED = 1; + //'in progress' result codes: + ACKRESULT_CONNECTING = 100; + ACKRESULT_CONNECTED = 101; + ACKRESULT_INITIALISING = 102; + ACKRESULT_SENTREQUEST = 103; // waiting for reply... + ACKRESULT_DATA = 104; // blob of file data sent/recved, or search result + ACKRESULT_NEXTFILE = 105; // file transfer went to next file + ACKRESULT_FILERESUME = 106; // a file is about to be received, see PS_FILERESUME + ACKRESULT_DENIED = 107; // a file send has been denied (0.3a + only) + + // for PROTOCOLDESCRIPTOR.type + + PROTOTYPE_PROTOCOL = 1000; + PROTOTYPE_ENCRYPTION = 2000; + PROTOTYPE_FILTER = 3000; + PROTOTYPE_TRANSLATION = 4000; + PROTOTYPE_OTHER = 10000;//avoid using this if at all possible + +type + + PCCSDATA = ^TCCSDATA; + TCCSDATA = record + hContact: THandle; + szProtoService: PChar; // a PS_* constant + wParam: WPARAM; + lParam: LPARAM; + end; + + PACKDATA = ^TACKDATA; + TACKDATA = record + cbSize: int; + szModule: PChar; // the name of the protocol module which initiated this ack + hContact: THandle; + type_: int; // an ACKTYPE_* constant + result_: int; // an ACKRESULT_* constant + hProcess: THandle; // caller defined seq, I mean process code + lParam: LPARAM; // caller defined data + end; + + // when type=ACKTYPE_FILE and (result=ACKRESULT_DATA or result=ACKRESULT_FILERESUME) + + PPROTOFILETRANSFERSTATUS = ^TPROTOFILETRANSFERSTATUS; + TPROTOFILETRANSFERSTATUS = record + cbSize: int; + hContact: THandle; + sending: int; // true if sending, false if receiving + files: PChar; // pointer to an array of pchar's + totalFiles: int; + currentFileNumber: int; + totalBytes: LongInt; + totalProgress: LongInt; + workingDir: PChar; + currentFile: PChar; + currentFileSize: LongInt; + currentFileProgress: LongInt; + currentFileTime: LongInt; // UNIX time + end; + + // for registering a protocol, enumeration + + PPROTOCOLDESCRIPTOR = ^TPROTOCOLDESCRIPTOR; + TPROTOCOLDESCRIPTOR = record + cbSize: int; + szName: PChar; // unique name of module + type_: int; // a PROTOTYPE_* constant + end; + +const + + { + wParam : 0 + lParam : Pointer to an initalised CSSDATA structure + Affect : Send a general request thru the protocol chain for a contact + Return : the return value documented in the PS_* def (m_protosvc.inc) + } + MS_PROTO_CALLCONTACTSERVICE = 'Proto/CallContactService'; + + { + wParam : 0 + lParam : Pointer to an initalised TACKDATA structure + Affect : a general 'ack', see notes + Notes : Just because defs are here doesn't mean they will be sent + read the docs for the function you are calling to see what + replies you will get. + } + ME_PROTO_ACK = 'Proto/Ack'; + + { + wParam : pointer to an int to store number of protocols + lParam : Pointer to an an array of PPROTOCOLDESCRIPTOR pointers + Affect : Enumerate the currently running protocols, see notes + Returns: 0 on success, [non zero] on failure + Notes : Neither wParam/lParam maybe NULL(0), the list returned by + this service is the protocol modules currently installed + and running, it is not a complete list of protocols that have + ever been installed. + - + A protocol module does not have to be a protocol running thru + the internet, it can be a vast number of things + } + MS_PROTO_ENUMPROTOCOLS = 'Proto/EnumProtocols'; + + { + wParam : 0 + lParam : Pointer to null terminated string containing protocol name + Affect : Determines if a protocol is running or not. + Returns: A pointer to the PPROTOCOLDESCRIPTOR if the protocol is loaded + or NULL(0) if it isn't + } + MS_PROTO_ISPROTOCOLLOADED = 'Proto/IsProtocolLoaded'; + + { + wParam : HCONTACT + lParam : Pointer to a null terminated string containing a name + Affect : Determine whether the given contact has the given protocol + in it's chain. + Returns : 0 if the protocol isn't in the chain, [non zero] if it is + } + MS_PROTO_ISPROTOONCONTACT = 'Proto/IsProtoOnContact'; + + { + wParam : HCONTACT + lParam : 0 + Affect : Gets the network-level protocol associated with a contact + Returns: a PChar pointing to the ASCIIZ name of the protocol or NULL(0) + if the contact has no protocol, There's no need to dispsose + the returned string. + - + This is the name of the module that actually accesses the network + for that contact. + } + MS_PROTO_GETCONTACTBASEPROTO = 'Proto/GetContactBaseProto'; + +{$ENDIF} \ No newline at end of file diff --git a/include/delphi/m_protomod.inc b/include/delphi/m_protomod.inc new file mode 100644 index 0000000000..3b790d42b7 --- /dev/null +++ b/include/delphi/m_protomod.inc @@ -0,0 +1,105 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_PROTOMOD} +{$DEFINE M_PROTOMOD} + + {$ifndef M_PROTOCOLS} + {$include m_protocols.inc} + {$endif} + +const + + { + wParam : 0 + lParam : Pointer to a initalised TPROTOCOLDESCRIPTOR structure + Affect : Register a protocol module, see notes + Returns: 0 on success, [non zero] on failure + Notes : This service MUST be called from your module's Load() function + TPROTOCOLDESCRIPTOR.type can be a value other than PROTOTYPE_* + which are used to provide a more precise positioning information + for the contact protocol lists. + - + Relative values to the constants can be given, but this MUST NOT + be done for PROTOTYPE_PROTOCOL. + } + MS_PROTO_REGISTERMODULE = 'Proto/RegisterModule'; + + { + wParam : HCONTACT + lParam : protocol_name_string + Affect : Add the given protocol module to the chain for a contact, see notes + Returns: 0 success, [non zero] on failure + Notes : The module is added to the correct positioning according to it's + registered type. + } + MS_PROTO_ADDTOCONTACT = 'Proto/AddToContact'; + + { + wParam : HCONTACT + lParam : protocol_name_string + Affect : Remove the given protocol name from the chain for the given contact + Returns: 0 on success, [non zero] on failure + } + MS_PROTO_REMOVEFROMCONTACT = 'Proto/RemoveFromContact'; + + { see m_globaldefs.pas for CreateProtoServiceFunction } + + { + wParam : wParam [arg] + lParam : lParam [arg] + Affect : Call the next service in the chain for the send operation, see notes + Return : Return value should be returned by CallService(MS_PROTO_CHAINSEND,wParam,lParam) + Notes : wParam MUST remain untouched, lParam is a pointer to a CSSDATA structure + and can be modified or copid if needed. + wParam and lParam should be the values passed to your service, + typically your service should return ASAP. + } + MS_PROTO_CHAINSEND = 'Proto/ChainSend'; + + { + wParam : wParam [arg] + lParam : lParam [arg] + Affect : Call the next service in the chain in this receive operation, see notes + Return : Return value should be returned by CallService(MS_PROTO_CHAINRECV,wParam,lParam) + Notes : wParam MUST remain untouched, lParam is a pointer to a CSSDATA structure + and can be modified or copied if needed. + wParam and lParam should be the values passed to your service, + typically your service should return ASAP. + - + MS_PROTO_CHAINRECV is thread safe since 0.1.2.0 -- calls + are translated to the main thread and passed from there. + } + MS_PROTO_CHAINRECV = 'Proto/ChainRecv'; + + { + wParam : 0 + lParam : Pointer to an initalised ACKDATA + Affect : Broadcast a ME_PROTO_ACK event, see notes + Returns: The return value of the NotifyEventHooks() call + Notes : ME_PROTO_ACK is completely thread safe since 01.2.0 + see notes in core/modules.h under NotifyEventHooks() + } + MS_PROTO_BROADCASTACK = 'Proto/BroadcastAck'; +{$ENDIF} diff --git a/include/delphi/m_protosvc.inc b/include/delphi/m_protosvc.inc new file mode 100644 index 0000000000..e546d5775b --- /dev/null +++ b/include/delphi/m_protosvc.inc @@ -0,0 +1,760 @@ +(* + +Miranda IM: the free IM client for Microsoft* Windows* + +Copyright 2000-2003 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_PROTOSVC} +{$DEFINE M_PROTOSVC} + +{<>} + +const + + PFLAGNUM_1 = $1; + PF1_IMSEND = $00000001; // supports IM sending + PF1_IMRECV = $00000002; // supports IM receiving + PF1_IM = (PF1_IMSEND or PF1_IMRECV); + PF1_URLSEND = $00000004; // supports separate URL sending + PF1_URLRECV = $00000008; // supports separate URL receiving + PF1_URL = (PF1_URLSEND or PF1_URLRECV); + PF1_FILESEND = $00000010; // supports file sending + PF1_FILERECV = $00000020; // supports file receiving + PF1_FILE = (PF1_FILESEND or PF1_FILERECV); + PF1_MODEMSGSEND = $00000040; // supports broadcasting away messages + PF1_MODEMSGRECV = $00000080; // supports reading others' away messages + PF1_MODEMSG = (PF1_MODEMSGSEND or PF1_MODEMSGRECV); + PF1_SERVERCLIST = $00000100; // contact lists are stored on the server, not locally. See notes below + PF1_AUTHREQ = $00000200; // will get authorisation requests for some or all contacts + PF1_ADDED = $00000400; // will get 'you were added' notifications + PF1_VISLIST = $00000800; // has an invisible list + PF1_INVISLIST = $00001000; // has a visible list for when in invisible mode + PF1_INDIVSTATUS = $00002000; // supports setting different status modes to each contact + PF1_EXTENSIBLE = $00004000; // the protocol is extensible and supports plugin-defined messages + PF1_PEER2PEER = $00008000; // supports direct (not server mediated) communication between clients + PF1_NEWUSER = $00010000; // supports creation of new user IDs + PF1_CHAT = $00020000; // has a realtime chat capability + PF1_INDIVMODEMSG = $00040000; // supports replying to a mode message request with different text depending on the contact requesting + PF1_BASICSEARCH = $00080000; // supports a basic user searching facility + PF1_EXTSEARCH = $00100000; // supports one or more protocol-specific extended search schemes + PF1_CANRENAMEFILE = $00200000; // supports renaming of incoming files as they are transferred + PF1_FILERESUME = $00400000; // can resume broken file transfers, see PS_FILERESUME below + PF1_ADDSEARCHRES = $00800000; // can add search results to the contact list + PF1_CONTACTSEND = $01000000; // can send contacts to other users + PF1_CONTACTRECV = $02000000; // can receive contacts from other users + PF1_CONTACT = (PF1_CONTACTSEND or PF1_CONTACTRECV); + PF1_CHANGEINFO = $04000000; // can change our user information stored on server + PF1_SEARCHBYEMAIL = $08000000; // supports a search by e-mail feature + PF1_USERIDISEMAIL = $10000000; // set if the uniquely identifying field of the network is the e-mail address + PF1_SEARCHBYNAME = $20000000; // supports searching by nick/first/last names + PF1_EXTSEARCHUI = $40000000; // has a dialog box to allow searching all the possible fields + PF1_NUMERICUSERID = $80000000; // the unique user IDs for this protocol are numeric + + PFLAGNUM_2 = 2; // the status modes that the protocol supports + PF2_ONLINE = $00000001; // an unadorned online mode + PF2_INVISIBLE = $00000002; + PF2_SHORTAWAY = $00000004; // Away on ICQ, BRB on MSN + PF2_LONGAWAY = $00000008; // NA on ICQ, Away on MSN + PF2_LIGHTDND = $00000010; // Occupied on ICQ, Busy on MSN + PF2_HEAVYDND = $00000020; // DND on ICQ + PF2_FREECHAT = $00000040; + PF2_OUTTOLUNCH = $00000080; + PF2_ONTHEPHONE = $00000100; + + PFLAGNUM_3 = 3; //the status modes that the protocol supports + //away-style messages for. Uses the PF2_ flags. + PFLAG_UNIQUEIDTEXT = 100; //returns a static buffer of text describing the unique field by which this protocol identifies users (already translated), or NULL + + PFLAG_MAXCONTACTSPERPACKET = 200; //v0.1.2.2+: returns the maximum number of contacts which can be sent in a single PSS_CONTACTS. + + PFLAGNUM_4 = 4; // v0.3+: flag asking a protocol plugin how auths are handled + PF4_FORCEAUTH = $00000001; // protocol has to send auth's for things to work + PF4_FORCEADDED = $00000002; // protocol has to tell people that they were added (otherwise things don't work) + PF4_NOCUSTOMAUTH = $00000004; // protocol can't send a custom message while asking others for auth + PF4_SUPPORTTYPING = $00000008; // protocol supports user is typing messages v0.3.3+ + PF4_SUPPORTIDLE = $00000010; // protocol understands idle, added during v0.3.4+ (2004/09/13) + PF4_AVATARS = $00000020; // protocol has avatar support, added during v0.3.4 (2004/09/13) + PF4_OFFLINEFILES = $00000040; // protocols supports sending files to offline users (v0.5.2) + PF4_IMSENDUTF = $00000080; // protocol is able to process messages in utf-8 (v.0.7.0+) + PF4_IMSENDOFFLINE = $00000100; // protocol supports sending offline messages (v0.8.0+) + PF4_INFOSETTINGSVC = $00000200; // protocol supports user info translation services (v0.8.0+) + + PFLAG_UNIQUEIDSETTING = 300; // v0.3+: returns the DB setting name (e.g. szProto=ICQ, szSetting=UIN) that has the ID which makes this user unique on that system (0.3a ONLY), the string is statically allocated so no need to free() + + // for PS_SETSTATUS + + LOGINERR_WRONGPASSWORD = 1; + LOGINERR_NONETWORK = 2; + LOGINERR_PROXYFAILURE = 3; + LOGINERR_BADUSERID = 4; + LOGINERR_NOSERVER = 5; + LOGINERR_TIMEOUT = 6; + LOGINERR_WRONGPROTOCOL = 7; + + // flag for PS_ADDTOLIST + + PALF_TEMPORARY = 1; // add the contact temporarily and invisibly, just to get user info or something + + // flags for PS_GETINFO + + SGIF_MINIMAL = 1; // get only the most basic information. This should + // contain at least a Nick and e-mail. + + // for PSR_MESSAGE + + PREF_CREATEREAD = 1; // create the database event with the 'read' flag set + + // for PS_FILERESUME + + FILERESUME_OVERWRITE= 1; + FILERESUME_RESUME = 2; + FILERESUME_RENAME = 3; + FILERESUME_SKIP = 4; + +type + + PPROTOSEARCHRESULT = ^TPROTOSEARCHRESULT; + TPROTOSEARCHRESULT = record + cbSize: int; + nick: PChar; + firstName: PChar; + lastName: PChar; + email: PChar; + reserved: array [0..15] of Byte; + // Protocols may extend this structure with extra members at will and supply + // a larger cbSize to reflect the new information, but they must not change + // any elements above this comment + // The 'reserved' field is part of the basic structure, not space to + // overwrite with protocol-specific information. + // If modules do this, they should take steps to ensure that information + // they put there will be retained by anyone trying to save this structure. + end; + + PPROTOSEARCHBYNAME = ^TPROTOSEARCHBYNAME; + TPROTOSEARCHBYNAME = record + pszNick: PChar; + pszFirstName: PChar; + pszLastName: PChar; + end; + + PPROTORECVEVENT = ^TPROTORECVEVENT; + TPROTORECVEVENT = record + flags: DWORD; + timestamp: DWORD; + szMessage: PChar; + lParam: LPARAM; + end; + + PPROTORECVFILE = ^TPROTORECVFILE; + TPROTORECVFILE = record + flags: DWORD; + timestamp: DWORD; // unix time + szDescription: PChar; + pFiles: PChar; // pointer to an array of pchar's + lParam: LPARAM; + end; + + PPROTOFILERESUME = ^TPROTOFILERESUME; + TPROTOFILERESUME = record + action: int; // FILERESUME_* flag + szFilename: PChar; // full path, only valid if action=FILERESUME_RENAME + end; + +const + + { + wParam : PFLAGNUM_* (see above) + lParam : 0 + Affects: Returns a bitfield for settings corresponding to flag number, see notes + Returns: a bitfield of supported features -- or 0 if flag_num is not supported + Notes : this checks what sort of things are actively supported by a protocol + module + } + PS_GETCAPS = '/GetCaps'; + + { + wParam : cchName + lParam : Pointer to a buffer to fill with human-readable name + Affect : Get a human-readable name for the protocol, see notes + Result : 0 on success, [non zero] on failure + Notes : Should be translated before being returned, cchName + has the size of the buffer, example strings: "ICQ", "AIM" + } + PS_GETNAME = '/GetName'; + + { + wParam : whichIcon + lParam : 0 + Affect : Loads one of the protocol-sspecific icons + Returns: the HICON or NULL on failure, the returned icon + must be DestroyIcon()ed, the UI should overlay + the online icon with further UI-specified icon to + repressent the exact status mode. + } + PLI_PROTOCOL = $1; // An icon representing the protocol (eg the multicoloured flower for ICQ) + PLI_ONLINE = $2; // Online state icon for that protocol (eg green flower for ICQ) + PLI_OFFLINE = $3; // Offline state icon for that protocol (eg red flower for ICQ) + PLIF_LARGE = $0; // Or with one of the above to get the large (32x32 by default) icon + PLIF_SMALL = $10000; // Or with one of the above to get the small (16x16 by default) icon + + PS_LOADICON = '/LoadIcon'; + + { + wParam : status_mode + lParam : Pointer to a null terminated string containing message + Affect : Sets the status mode specific message for the user, see notes + Returns: 0 on success, [non zero] on failure + Notes : This service is not available unless PF1_MODEMSGSEND is set, + and PF1_INDIVMODEMSG is *not* set. + If PF1_INDIVMODEMSG is set, then see PSS_AWAYMSSG for details + of operations of away messages. + - + Protocol modules smust support lParam=NULL, it may eithere mean + to use an empty message or (preferably) not to reply at all to + any requests. + } + PS_SETAWAYMSG = '/SetAwayMsg'; + + { + wParam : newMode from statusmodes.inc + lParam : 0 + Affect : Change the protocol's status mode, see notes + Returns: 0 on success, [non zero] on failure + Notes : Will send an ack with : + type=ACKTYPE_SUCCESS, result=ACKRESULT_SUCCESS, hProcess=previousMode, lParam=newMode + - + when the change completes. This ack is sent for all changes, not + just ones caused by calling this function. + - + NewMode can be ID_STATUS_CONNECTING<=newMode