initial commit

git-svn-id: http://svn.miranda-ng.org/main/trunk@2 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c

2 files changed, 327 insertions, 0 deletions

diff --git a/plugins/yapp/sdk/m_ieview.h b/plugins/yapp/sdk/m_ieview.h
new file mode 100644
index 0000000000..732d2849e7
--- /dev/null
+++ b/plugins/yapp/sdk/m_ieview.h
@@ -0,0 +1,177 @@
+/*

+

+IEView Plugin for Miranda IM

+Copyright (C) 2005  Piotr Piastucki

+

+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_IEVIEW_INCLUDED

+#define M_IEVIEW_INCLUDED

+

+#define MS_IEVIEW_WINDOW  "IEVIEW/NewWindow"

+#define MS_IEVIEW_EVENT	  "IEVIEW/Event"

+#define MS_IEVIEW_UTILS   "IEVIEW/Utils"

+

+#define ME_IEVIEW_OPTIONSCHANGED  "IEVIEW/OptionsChanged"

+#define ME_IEVIEW_NOTIFICATION  "IEVIEW/Notification"

+

+#define IEW_CREATE  1               // create new window (control)

+#define IEW_DESTROY 2               // destroy control

+#define IEW_SETPOS  3               // set window position and size

+#define IEW_SCROLLBOTTOM 4          // scroll text to bottom

+

+//#define IEWM_SRMM     0             // regular SRMM

+#define IEWM_TABSRMM  1             // TabSRMM-compatible HTML builder

+#define IEWM_SCRIVER  3             // Scriver-compatible HTML builder

+#define IEWM_MUCC     4             // MUCC group chats GUI

+#define IEWM_CHAT     5             // chat.dll group chats GUI

+#define IEWM_HISTORY  6             // history viewer

+

+typedef struct {

+	int			cbSize;             // size of the strusture

+	int			iType;				// one of IEW_* values

+	DWORD		dwMode;				// compatibility mode - one of IEWM_* values

+	DWORD		dwFlags;			// flags, one of IEWF_* values

+	HWND		parent;             // parent window HWND

+	HWND 		hwnd;               // IEW_CREATE returns WebBrowser control's HWND here

+	int			x;                  // IE control horizontal position

+	int			y;                  // IE control vertical position

+	int			cx;                 // IE control horizontal size

+	int			cy;                 // IE control vertical size

+

+} IEVIEWWINDOW;

+

+#define IEEDF_UNICODE 		1          // if set pszText is a pointer to wchar_t string instead of char string

+#define IEEDF_UNICODE_TEXT	1          // if set pszText is a pointer to wchar_t string instead of char string

+#define IEEDF_UNICODE_NICK	2          // if set pszNick is a pointer to wchar_t string instead of char string

+#define IEEDF_UNICODE_TEXT2	4          // if set pszText2 is a pointer to wchar_t string instead of char string

+/* The following flags are valid only for message events (IEED_EVENT_MESSAGE) */

+#define IEEDF_FORMAT_FONT	0x00000100 // if set pszFont (font name) is valid and should be used

+#define IEEDF_FORMAT_SIZE	0x00000200 // if set fontSize is valid and should be used

+#define IEEDF_FORMAT_COLOR	0x00000400 // if set color is valid and should be used

+#define IEEDF_FORMAT_STYLE	0x00000800 // if set fontSize is valid and should be used

+

+#define IEEDF_READ			0x00001000 // if set

+#define IEEDF_SENT			0x00002000 // if set

+#define IEEDF_RTL			0x00004000 //

+

+#define IEED_EVENT_MESSAGE			0x0001 // message

+#define IEED_EVENT_STATUSCHANGE		0x0002 // status change

+#define IEED_EVENT_FILE				0x0003 // file

+#define IEED_EVENT_URL				0x0004 // url

+#define IEED_EVENT_ERRMSG           0x0005 // error message

+#define IEED_EVENT_SYSTEM           0x0006 // system event

+

+#define IEED_MUCC_EVENT_MESSAGE		0x0001 // message

+#define IEED_MUCC_EVENT_TOPIC		0x0002 // topic change

+#define IEED_MUCC_EVENT_JOINED		0x0003 // user joined

+#define IEED_MUCC_EVENT_LEFT		0x0004 // user left

+#define IEED_MUCC_EVENT_ERROR		0x0005 // error

+

+#define IEED_GC_EVENT_HIGHLIGHT 	0x8000

+#define IEED_GC_EVENT_MESSAGE   	0x0001

+#define IEED_GC_EVENT_TOPIC     	0x0002

+#define IEED_GC_EVENT_JOIN      	0x0003

+#define IEED_GC_EVENT_PART      	0x0004

+#define IEED_GC_EVENT_QUIT      	0x0006

+#define IEED_GC_EVENT_NICK      	0x0007

+#define IEED_GC_EVENT_ACTION    	0x0008

+#define IEED_GC_EVENT_KICK      	0x0009

+#define IEED_GC_EVENT_NOTICE    	0x000A

+#define IEED_GC_EVENT_INFORMATION   0x000B

+#define IEED_GC_EVENT_ADDSTATUS     0x000C

+#define IEED_GC_EVENT_REMOVESTATUS  0x000D

+

+#define IE_FONT_BOLD			0x000100	// Bold font flag

+#define IE_FONT_ITALIC			0x000200	// Italic font flag

+#define IE_FONT_UNDERLINE		0x000400	// Underlined font flags

+

+typedef struct tagIEVIEWEVENTDATA {

+	int			cbSize;

+	int			iType;				// Event type, one of MUCC_EVENT_* values

+	DWORD		dwFlags;			// Event flags - IEEF_*

+	const char *fontName;			// Text font name

+	int			fontSize;			// Text font size (in pixels)

+	int         fontStyle;          // Text font style (combination of IE_FONT_* flags)

+	COLORREF	color;				// Text color

+	union {

+		const char *pszNick;		// Nick, usage depends on type of event

+		const wchar_t *pszNickW;    // Nick - Unicode

+	};

+	union {

+		const char *pszText;			// Text, usage depends on type of event

+		const wchar_t *pszTextW;			// Text - Unicode

+	};

+	DWORD		dwData;				// DWORD data e.g. status

+	BOOL		bIsMe;				// TRUE if the event is related to the user

+	DWORD		time;				// Time of the event

+	struct tagIEVIEWEVENTDATA *next;

+	union {

+		const char *pszText2;			// Text, usage depends on type of event

+		const wchar_t *pszText2W;		// Text - Unicode

+	};

+} IEVIEWEVENTDATA;

+

+#define IEE_LOG_DB_EVENTS  	1       // log specified number of DB events

+#define IEE_CLEAR_LOG		2       // clear log

+#define IEE_GET_SELECTION	3       // get selected text

+#define IEE_SAVE_DOCUMENT	4       // save current document

+#define IEE_LOG_MEM_EVENTS 	5       // log specified number of IEView events

+

+#define IEEF_RTL          1           // turn on RTL support

+#define IEEF_NO_UNICODE   2           // disable Unicode support

+#define IEEF_NO_SCROLLING 4           // do not scroll logs to bottom

+

+#define IEVIEWEVENT_SIZE_V1 28

+#define IEVIEWEVENT_SIZE_V2 32

+#define IEVIEWEVENT_SIZE_V3 36

+

+typedef struct {

+	int			cbSize;             // size of the strusture

+	int			iType;				// one of IEE_* values

+	DWORD		dwFlags;			// one of IEEF_* values

+	HWND		hwnd;               // HWND returned by IEW_CREATE

+	HANDLE      hContact;           // contact

+	union {

+		HANDLE 		hDbEventFirst;      // first event to log, when IEE_LOG_EVENTS returns it will contain

+										// the last event actually logged or NULL if no event was logged (IEE_LOG_EVENTS)

+		IEVIEWEVENTDATA *eventData;	    // the pointer to an array of IEVIEWEVENTDATA objects (IEE_LOG_IEV_EVENTS)

+	};

+	int 		count;              // number of events to log

+	int         codepage;           // ANSI codepage

+	const char *pszProto;			// Name of the protocol

+} IEVIEWEVENT;

+

+typedef struct {

+	int cbSize;                //size of the structure

+	const char* Protocolname;  //protocol to use... if you have defined a protocol, u can

+                             //use your own protocol name. Smiley add wil automatically

+                             //select the smileypack that is defined for your protocol.

+                             //Or, use "Standard" for standard smiley set. Or "ICQ", "MSN"

+                             //if you prefer those icons.

+                             //If not found or NULL: "Standard" will be used

+	int xPosition;             //Postition to place the selectwindow

+	int yPosition;             // "

+	int Direction;             //Direction (i.e. size upwards/downwards/etc) of the window 0, 1, 2, 3

+  	HWND hwndTarget;           //Window, where to send the message when smiley is selected.

+	UINT targetMessage;        //Target message, to be sent.

+	LPARAM targetWParam;       //Target WParam to be sent (LParam will be char* to select smiley)

+                             //see the example file.

+} IEVIEWSHOWSMILEYSEL;

+

+#endif

+

diff --git a/plugins/yapp/sdk/m_updater.h b/plugins/yapp/sdk/m_updater.h
new file mode 100644
index 0000000000..488d3722ce
--- /dev/null
+++ b/plugins/yapp/sdk/m_updater.h
@@ -0,0 +1,150 @@
+#ifndef _M_UPDATER_H

+#define _M_UPDATER_H

+

+// NOTES:

+// - For langpack updates, include a string of the following format in the langpack text file:

+//    ";FLID: <file listing name> <version>"

+//    version must be four numbers seperated by '.', in the range 0-255 inclusive

+// - Updater will disable plugins that are downloaded but were not active prior to the update (this is so that, if an archive contains e.g. ansi and 

+//    unicode versions, the correct plugin will be the only one active after the new version is installed)...so if you add a support plugin, you may need 

+//    to install an ini file to make the plugin activate when miranda restarts after the update

+// - Updater will replace all dlls that have the same internal shortName as a downloaded update dll (this is so that msn1.dll and msn2.dll, for example,

+//    will both be updated) - so if you have a unicode and a non-unicode version of a plugin in your archive, you should make the internal names different (which will break automatic 

+//    updates from the file listing if there is only one file listing entry for both versions, unless you use the 'MS_UPDATE_REGISTER' service below)

+// - Updater will install all files in the root of the archive into the plugins folder, except for langpack files that contain the FLID string which go into the root folder (same

+//    folder as miranda32.exe)...all folders in the archive will also be copied to miranda's root folder, and their contents transferred into the new folders. The only exception is a 

+//    special folder called 'root_files' - if there is a folder by that name in the archive, it's contents will also be copied into miranda's root folder - this is intended to be used 

+//    to install additional dlls etc that a plugin may require)

+

+// if you set Update.szUpdateURL to the following value when registering, as well as setting your beta site and version data,

+// Updater will ignore szVersionURL and pbVersionPrefix, and attempt to find the file listing URL's from the backend XML data.

+// for this to work, the plugin name in pluginInfo.shortName must match the file listing exactly (except for case)

+#define UPDATER_AUTOREGISTER		"UpdaterAUTOREGISTER"

+// Updater will also use the backend xml data if you provide URL's that reference the miranda file listing for updates (so you can use that method 

+// if e.g. your plugin shortName does not match the file listing) - it will grab the file listing id from the end of these URLs

+

+typedef struct Update_tag {

+  int cbSize;     

+  char *szComponentName;		// component name as it will appear in the UI (will be translated before displaying)

+

+  char *szVersionURL;			// URL where the current version can be found (NULL to disable)

+  BYTE *pbVersionPrefix;		// bytes occuring in VersionURL before the version, used to locate the version information within the URL data

+								// (note that this URL could point at a binary file - dunno why, but it could :)

+  int cpbVersionPrefix;			// number of bytes pointed to by pbVersionPrefix

+  char *szUpdateURL;			// URL where dll/zip is located

+								// set to UPDATER_AUTOREGISTER if you want Updater to find the file listing URLs (ensure plugin shortName matches file listing!)

+

+  char *szBetaVersionURL;		// URL where the beta version can be found (NULL to disable betas)

+  BYTE *pbBetaVersionPrefix;	// bytes occuring in VersionURL before the version, used to locate the version information within the URL data

+  int cpbBetaVersionPrefix;		// number of bytes pointed to by pbVersionPrefix

+  char *szBetaUpdateURL;		// URL where dll/zip is located

+

+  BYTE *pbVersion;				// bytes of current version, used for comparison with those in VersionURL

+  int cpbVersion;				// number of bytes pointed to by pbVersion

+

+  char *szBetaChangelogURL;		// url for displaying changelog for beta versions

+} Update;

+

+// register a comonent with Updater

+//

+// wparam = 0

+// lparam = (LPARAM)&Update

+#define MS_UPDATE_REGISTER      "Update/Register"

+

+// utility functions to create a version string from a DWORD or from pluginInfo

+// point buf at a buffer at least 16 chars wide - but note the version string returned may be shorter

+//

+__inline static char *CreateVersionString(DWORD version, char *buf) {

+	mir_snprintf(buf, 16, "%d.%d.%d.%d", (version >> 24) & 0xFF, (version >> 16) & 0xFF, (version >> 8) & 0xFF, version & 0xFF);

+	return buf;

+}

+

+__inline static char *CreateVersionStringPlugin(PLUGININFO *pluginInfo, char *buf) {

+	return CreateVersionString(pluginInfo->version, buf);

+}

+

+__inline static char *CreateVersionStringPluginEx(PLUGININFOEX *pluginInfo, char *buf) {

+	return CreateVersionString(pluginInfo->version, buf);

+}

+

+

+// register the 'easy' way - use this method if you have no beta URL and the plugin is on the miranda file listing

+// NOTE: the plugin version string on the file listing must be the string version of the version in pluginInfo (i.e. 0.0.0.1,

+// four numbers between 0 and 255 inclusivem, so no letters, brackets, etc.)

+//

+// wParam = (int)fileID				- this is the file ID from the file listing (i.e. the number at the end of the download link)

+// lParam = (PLUGININFO*)&pluginInfo

+#define MS_UPDATE_REGISTERFL	"Update/RegisterFL"

+

+// this function can be used to 'unregister' components - useful for plugins that register non-plugin/langpack components and

+// may need to change those components on the fly

+// lParam = (char *)szComponentName

+#define MS_UPDATE_UNREGISTER	"Update/Unregister"

+

+// this event is fired when the startup process is complete, but NOT if a restart is imminent

+// it is designed for status managment plugins to use as a trigger for beggining their own startup process

+// wParam = lParam = 0 (unused)

+// (added in version 0.1.6.0)

+#define ME_UPDATE_STARTUPDONE	"Update/StartupDone"

+

+// this service can be used to enable/disable Updater's global status control

+// it can be called from the StartupDone event handler

+// wParam = (BOOL)enable

+// lParam = 0

+// (added in version 0.1.6.0)

+#define MS_UPDATE_ENABLESTATUSCONTROL	"Update/EnableStatusControl"

+

+// An description of usage of the above service and event:

+// Say you are a status control plugin that normally sets protocol or global statuses in your ModulesLoaded event handler.

+// In order to make yourself 'Updater compatible', you would move the status control code from ModulesLoaded to another function, 

+// say DoStartup. Then, in ModulesLoaded you would check for the existence of the MS_UPDATE_ENABLESTATUSCONTROL service.

+// If it does not exist, call DoStartup. If it does exist, hook the ME_UPDATE_STARTUPDONE event and call DoStartup from there. You may

+// also wish to call MS_UPDATE_ENABLESTATUSCONTROL with wParam == FALSE at this time, to disable Updater's own status control feature.

+

+// this service can be used to determine whether updates are possible for a component with the given name

+// wParam = 0

+// lParam = (char *)szComponentName

+// returns TRUE if updates are supported, FALSE otherwise

+#define MS_UPDATE_ISUPDATESUPPORTED		"Update/IsUpdateSupported"

+

+#endif

+

+

+/////////////// Usage Example ///////////////

+

+#ifdef EXAMPLE_CODE

+

+// you need to #include "m_updater.h" and HookEvent(ME_SYSTEM_MODULESLOADED, OnModulesLoaded) in your Load function...

+

+int OnModulesLoaded(WPARAM wParam, LPARAM lParam) {

+

+	Update update = {0}; // for c you'd use memset or ZeroMemory...

+	char szVersion[16];

+

+	update.cbSize = sizeof(Update);

+

+	update.szComponentName = pluginInfo.shortName;

+	update.pbVersion = (BYTE *)CreateVersionString(&pluginInfo, szVersion);

+	update.cpbVersion = strlen((char *)update.pbVersion);

+

+	// these are the three lines that matter - the archive, the page containing the version string, and the text (or data) 

+	// before the version that we use to locate it on the page

+	// (note that if the update URL and the version URL point to standard file listing entries, the backend xml

+	// data will be used to check for updates rather than the actual web page - this is not true for beta urls)

+	update.szUpdateURL = "http://scottellis.com.au:81/test/updater.zip";

+	update.szVersionURL = "http://scottellis.com.au:81/test/updater_test.html";

+	update.pbVersionPrefix = (BYTE *)"Updater version ";

+	

+	update.cpbVersionPrefix = strlen((char *)update.pbVersionPrefix);

+

+	// do the same for the beta versions of the above struct members if you wish to allow beta updates from another URL

+

+	CallService(MS_UPDATE_REGISTER, 0, (WPARAM)&update);

+

+	// Alternatively, to register a plugin with e.g. file ID 2254 on the file listing...

+	// CallService(MS_UPDATE_REGISTERFL, (WPARAM)2254, (LPARAM)&pluginInfo);

+

+	return 0;

+}

+

+#endif