SmileyAdd plugin for Miranda IM
=====================================================================
A plugin that adds smileys to the standard message dialog. 
Features:
- Customizable smiley support
- Alpha blended icons support on Windows XP
- Plugin support
- Smiley 'select tool window' button during messaging
- Translation support

Remarks:
"Send smileys as pictures so my buddies see them" will not be 
implemented... (if they wanna see smileys, they will probably 
have enabled it already). Furthermore it is technically impossible.

Author: Rein-Peter de Boer (peacow), bid, borkra
Email:
Date: Febuary, 2006
Current version: 0.1.11.10


Installation Instructions
=========================
Extract the zip file in the Miranda home directory. This will create a directory
'Smileys' with the default smiley pack. And the smileyadd.dll will go in the
plugins directory. 
Or you can copy this by hand from the archive. Note: to make the default work,
the default smiley pack HAS to be in the 'Smileys' directory.

GDI+ installation required to use non icon smiley packs
GDI+ come pre-installed on Windows XP, Office XP and later, for everybody else you can get it here: 
http://www.microsoft.com/downloads/details.aspx?FamilyID=6a63ab9c-df12-4d41-933c-be590feaa05a&DisplayLang=en


Smiley Packs
================
SmileyAdd supports *.msl, *.asl and *.xep Smiley Packs.
For syntax of in *.msl or *.asl files check the example file "smileyadd_example_libfile.msl".

Note SmileyAdd provide better validation for malformed Regular Expressions then nCpnvers. 
As a result some Smiley Packs working under nConvers will give errors under SmileyAdd. 
Although if these errors are fixed resulting Smiley Pack will work correctly under both plugins.

Pre-packaged Smiley Packs could be found here:
http://miranda-im.org/download/index.php?action=display&id=41

Any Smiley Pack from SmileyAdd, IEView or nConvers sections is usable with SmileyAdd


Limitations
===========
Non Unicode version does not support DBCS characters in smiley codes and file names. 
DBCS character sets are Chinese, Japanese, Korean, etc. 
It's recommended to use Unicode version in this case

For true Unicode operation of Unicode SmileyAdd Unicode Smiley Packs required

Unicode SmileyAdd will only work with Unicode Miranda 0.4.3 or later and 
Windows 2000 or later.

GIF with "Disposal method" other then "To Background" not supported

Bugs
====
No guarantees, but probably there are some bugs. If you find something, and would 
like to see this fixed then post on the Miranda forum as detailed as possible report 
on the bug (version numbers, OS, how to reproduce it) and I will get back on that.


Source
======
Source is published on the Miranda site.
http://www.miranda-im.org/download/details.php?action=viewfile&id=2152


Developers
==========
There is also some smiley support for plugins... There is something remotely 
resembling documentation in "m_smileyadd.h". Contact me if you have questions. 
At this moment you can: 
    - replace smileys in a RichEdit with only supplying the RichEdit handle
    - retrieve a Milken by supplying the emoticon text, i.e. ":)"
    - show a smiley select window
    - contact me if you need more support (see the developer.txt also)



Thanks to:
==========
- MatriX       For helping out with the icons and other stuff!
- Pixador      For some bug tracking :)
- Wesslén      For even more enhancing the standard message dialog and 
               fine tuning my subclass routines.. :)
- Various forum people tracking bugs for me
- Miranda crew for Miranda IM... :)
- Everyone pointing out bugs to me!
- Creators of all the smiley packs for SmileyAdd :)             


ChangeLog
=========

0.1.11.10
--------
  Attempt to fix high CPU usage on/after smiley selection on some computers

0.1.11.9
--------
  Attempt to fix desktop redraw issue
  Fixed high cpu usage

0.1.11.8
--------
  Attempt to fix desktop redraw issue
  Fixed random crash

0.1.11.7
--------
  Attempt to fix desktop redraw issue

0.1.11.6
--------
  Animation antilockup logic
  Less invasive window subclassing 

0.1.11.5
--------
  Animation performance improvemnets 
  Animation antilockup logic

0.1.11.4
--------
  Fixed crash with hidden animated smiley
  Fixed smiley corruption in scale to text mode

0.1.11.3
--------
  Fixed crash

0.1.11.2
--------
  Fixed improper delay on animated GIFs
  Fixed png smiley corruption
  Fixed smiley corruption with EMF
  Fixed smileys do not animate after scroll up 

0.1.11.1
--------
  Fixed smileys do not animate sometimes in selector window
  Added mouse wheel scrolling in selector window
  Animation performance improvements
  Fixed smiley no show with TabSRMM

0.1.11.0
--------
  Added ability to show animated smileys in selector window
  Added API to insert EMF into RichEdit (allows "true" transparency)
  Fixed crash on exit with Win98
  Fixed error reporting for not found smileys 

0.1.10.9
--------
  Fixed smiley selector window with large number of smileys
  Do not allow smiley selector window to cover more then 1/4 of the screen area

0.1.10.8
--------
  Fixed grid lines in smiley selector

0.1.10.7
--------
  Fixed issue with smiley replacement when "Replace only isolated smileys" selected 
  Added grid lines to IEView smiley selector 

0.1.10.6
--------
  Fixed smiley replacement at the beginning of the line

0.1.10.5
--------
  More IEView like selector window (in IEView mode) clipping, scroll bar
  Fixed non-Unicode SmileyAdd with DBCS character sets (Chinese, Japanese, Korean, etc.)

0.1.10.4
--------
  Fixed insertion code when regular expressions used in msl/asl smiley pack
  IEView style selection window now selectable option (default SmileyAdd one)
  Fixed preview window update on option change in Option dialog
  Added ability to select gif frame to display as static smiley 

0.1.10.3
--------
  Added Regular Expression support to msl/asl Smiley Packs
  Attempt to correct message log repainting problems

0.1.10.2
--------
  More IEView like selector window
  Attempt to correct message log repainting problems

0.1.10.1
--------
  Fixed Preview window for xep and asl smiley packs
  Attempt to fix "jumping"

0.1.10.0
--------
  Added batch parsing API (to support IEView)
  Fixed checkbox operation in Option Dialog
  Added support for SelectionSize in asl/msl packs

0.1.9.6
--------
  Added ability to paste smiley codes from message log
  (This feature works only if RichEdit v3 or later is used)
  Perfomance improvements in smiley drawing
  Fixed "Surround Smiley with spaces" checkbox in Option dialog

0.1.9.5
--------
  Fixed Smiley Pack information display in Option dialog 

0.1.9.4
--------
  Fixed inadvertent smiley pack change in Option dialog
  Fixed random crash in Message Dialog smiley parsing
  Perfomance improvements in smiley drawing
  Support for Unicode file names in Unicode version

0.1.9.3
--------
  Fixed crash on Disable Message Dialog Support
  Fixed resource leak
  Added GETINFO2 API where deleting Smiley handle is user responsibility
  (GETINFO API should not be used any longer)
  Added protection against multiple SmileyAdd instances execution

0.1.9.2 
--------
  Fixed Smiley Pack info display for Unicode version
  A lot of robustness updates for Unicode version
  Added option to scale all smileys in selector window
  Fixed translation file
  Error messages in Unicode 
  Fixed crash with nonexistent xep smiley pack 

0.1.9.0
--------
  Fixed xep smiley replacement (longer smiley have precedence over shorter ones)
  Fixed button smiley for xep smileys (works now by the same rule as msl one)
  Added unloading GDI+ when it's no longer needed
  Improved smiley parsing performance by at least 20%
  Final resolution for SmileyAdd related flickering
  Updates for Unicode version
  Added support for Unicode (UTF8 and UTF16) msl, asl and xep files
  Added Unicode version for ParseText API

0.1.8.8
--------
  Added workaround for crashing ISee being reported as SmileyAdd crash
  Smiley Preview Window now shows smileys in it's original size (window might get pretty big) 
   
0.1.8.7
--------
  Fixed unicode conversion problem 
  (now Windows language for non-Unicode programs always used) 

0.1.8.6
--------
  Improved performance for smiley parsing
  Fixed flickering durig smiley replacement
  Fixed for rare crashes in non message log window

0.1.8.4
--------
  Improved performance for smiley parsing
  Added workarounds for 32bit_Icons and '&' problems in xep smileys

0.1.8.3
--------
  Improved performance for msl smiley parsing
  Fixed selection restore in message log

0.1.8.2
--------
  Fixed Message Log position restore after smiley insertion
  Fixed cursor flickering durig smiley replacement
  Improved performance on smiley replacement
  Fixed smiley replacement issues for xep smiley pack
  Added workaround for non compliant XML node name

0.1.8.1
--------
  Fixed smiley replacement at the end of the line
  A lot of error checking and notifications for xep Smiley Pack
  Some perfomance improvements

0.1.8.0
--------
  Added support for nConvers (xep) Smiley Packs
  Fixed few potential problems with unicode
  
0.1.7.6
--------
  Added support for environment variables in the path
  Fixed SmileyAdd operation with RSS plugin
  Utilizing Unicode hooks for Unicode SRMMs
  Added line number display for broken smiley
  Added translation capability for few error messages
  Fixed loading Smiley Pack once when used by multiple smiley categories 
  Fixed default Smiley Pack for RegisterCategory API
  Fixed Option Dialog icon for category registered with RegisterCategory API
  Fixed crash when call RegisterCategory API at power-up
  Changed ParseText API to support iterative operation
  Fixed icon retrieval by ParseText API

0.1.7.5
--------
  Fixed smiley detection and replacement issues

0.1.7.4
--------
  Fixed rare smiley detection and replacement issues
  Fixed "Use one for all" checkbox handling in Option Dialog  

0.1.7.3
--------
  Fixed rare smiley detection and replacement issues 

0.1.7.2
--------
  Fixed smiley replacement with no button bar
  Fixed images in Option Dialog for systems with Commmon Controls 5 or earlier 
  Added color selection in Option Dialog for smiley selector window 
  Spelling fixes in Register Category API

0.1.7.1
--------
  Fixed crash with massage dialog with no contact
  Fixed crash with PopUp++
  Attempt to fix Win9x icon size problem in Option Dialog
  Much reduced GDI resource utilization
  Added API to register a Smiley Category
  Many changes to API to Find Smiley in Text

0.1.7.0
--------
  Added support for non icon smileys (png, gif, etc.) 
     GDI+ required for this feature to work
  Added support for IEView .asl Smiley Packs
  Added error notification on missing smileys from the pack
  Better handling for relative paths in Smiley Pack
  Added API to find smileys in a text string (pescuma request for use in modern contact list)

0.1.6.2
--------
  Fixed URL corruption regression
  
0.1.6.1
--------
  Fixed Option Dialog for systems with many protocols
  Surround smiley with spaces option now make sure that any smiley   
      detected have spaces on both sides

  At this point I am not aware of any problems with SmileyAdd. 
  If you encounter some you want to report it together with detailed steps to reproduce it 
  and software versions (Miranda, plugins, OS, etc.) you are using.

0.1.6.0
--------
  API change, hookable event provided to notify plugins with "native"
      SmileyAdd support that options have changed, so they could redraw
  Fixed smiley selection window display location on multi-monitor systems
  Fixed protocol icon display in Option Dialog for protocols which don't 
      provide "small" icons (i.e MetaContacts)
  Increased size of controls in Option Dialog to aid translation
  Fixed string in translation file 
  Fixed changing checkbox "Specify smiley pack ..." would not enable Apply button
  Fixed translation of the protocol name could result in smiley not showing
     Caution: This fix could result in having to reselect smiley pack for protocol!

  At this point I am not aware of any problems with SmileyAdd. 
  If you encounter some you want to report it together with detailed steps to reproduce it 
  and software versions (Miranda, plugins, OS, etc.) you are using.

0.1.5.3
--------
  Option Dialog redesigned. It's hopefully more understandable now. 
  (Thanks to HikoH for lot's of suggestions)
  Unfortunatly all translations will have to change with this release.
  Changing Options in option dialog no longer require restart for them to take effect.
  
  At this point I am not aware of any problems with SmileyAdd. 
  If you encounter some you want to report it together with detailed steps to reproduce it 
  and software versions (Miranda, plugins, OS, etc.) you are using.

0.1.5.2
--------
  Fixed smiley replace in history 
  Fixed smiley selection tool sometimes open in strange location
  Fixed Option dialog filename problem when you browse for it

0.1.5.1
--------
  Fixed overwrite of "Add Contact to buddy list" button (for not listed contacts) 
  Fixed "Use One for all" radio buttons problem in Option Dialog

0.1.5.0
--------
  API change to support TabSRMM 0.9.9.96 and later (per Nightwish request)
     (the parent window for smiley selection dialog could be specified now)
  Fixed smiley scaling issue with some smiley packs on Miranda Button.

0.1.4.14
--------
  Fixed File Open Dialog for empty or broken file names

0.1.4.13
--------
  Better handling of broken msl files (Button S on message dialog instead of icon)
  Attempt to fix no File Open dialog on Win9x.
  Error messages are now using balloon notification, when it works
  Force focus to entry dialog after selecting smiley
  Code cleanup

0.1.4.12
--------
  Implemented much more robust algorithm for detecting 
     SRMM 2.x interface supporting plugins versa 
     SRMM 1.x interface supporting plugins

  This release have been tested to work with: 
	SRMM      2.4.0.0  and 1.0.4.2 (2.x and 1.x)
	TabSRMM   0.9.9.95 and 0.0.8.0 (built-in support and 1.x)
	SRAMM     0.3.2.2  (1.x)
	SRMM Mod  0.5.8.0  (1.x)
	Scriver   2.2.2.2  (built-in support)
  Single Mode SRMM 0.1 have built-in text-only SmileyAdd support and it's working as such
  
  This will fix "smiley button does not show" problems.

0.1.4.11
--------
  Fixed latest SRMM support regression
  Improved relative path support
  Smiley packs disabled in the Option dialog no longer loaded
  
0.1.4.9
-------
  Fixed handling of SRMM interface (interface changed between Miranda 3.3.1 and 4.0)
  Bottom smiley button option is not available any more for Miranda later then 3.3.1 
  Smiley packs which specified but don't exist now give error messages (at power up too)
  Non IM protocols (i.e. weather, time, etc.) are ignored now
  Fixed Option dialog translation
  Fixed Option dialog handling of missing Smiley Packs
  Fixed Option dialog Cancel/Apply functions
  Option dialog accepts relative paths now (if you type them in)
  Changing settings in Option dialog will affect all open windows on Apply
  Fixed numerous resource leaks
  A lot of general code robustness and performance updates
  Removed Windows API calls that don't exist on Win95
  MS VC++ 6 portability updates (dsp file provided)
  Fixed older TabSRMM support

  Extensive testing have been performed on plugin for this release.
  Plugin have been tested to work with Windows XP, 2000, 95, Miranda 4.0.1 and 3.3.1
     SRMM and TabSRMM

0.1.4.8
-------
  Fixed transparency with TabSRMM
  Fixed losing focus after entering smiley in SRMM
  Fixed memory leak in smiley dialog
  GCC portability updates 

0.1.4.7
-------
  Fixed crashes and option dialog.

0.1.4.6
-------
  More crash fixes.

0.1.4.5a
-------
  Fixed back merge

0.1.4.5
-------
  OLE resource leak fixed (by NightWish)
  Includes TabSRMM version (by NightWish)

0.1.4.4a
-------
  Compiled in .NET studio as before.

0.1.4.4
-------
  Multiple crash fixes with invalid files (by bidyut)

0.1.4.3
-------
  Fixed incompatibility with Jabber plugin
  Plugin support for showing a smiley selection window
  Internal changes, better memory/resource management
  Order of the smileys in the smiley pack doesn't matter anymore

0.1.3.2
-------
  Minor fixes:
    - Smiley button scales the image now correctly
    - Fixed problem with spaces and " in smiley text when used with smiley select window
    
0.1.3.1
-------
  Minor fixes:
    - Smiley selection window placement is better
    - Button is better shown when quote button is disabled
    
0.1.3.0
-------
- Works now with Miranda version 0.3.3
- Fixed 4 character smiley bug
- Smileybutton can now be on top row buttons (default)
- More than 2 consecutive smileys without spaces are now 
  recognized in 'isolated smiley' mode
- Support for spaces or " in smileys (see sample .msl file)

0.1.2.3
-------
- Fixed incompatibility (2) with message dialog in nightly build of 30-06-2003 

0.1.2.2
-------
- Fixed incompatibility with message dialog in nightly build of 30-06-2003

0.1.2.1
-------
- (Small) bug with smiley pack loading fixed

0.1.2.0
-------
- Ability for hidden smileys (not shown in select window)
- Ability for separate tooltip text in select window
- Fixed display bug in select window with large smiley packs
- Fixed bug with random smileys not being replaced (at least i hope so)
- Fixed bug with smiley replacement if some text was selected
- Fixed bug when using large smiley texts
- Fixed bug with (non) case sensitivity (now case sensitive)
- Fixed some buffer overflow bugs
- Other minor bug fixes


0.1.1.0
-------
- Added Support for smiley sizes other than 16x16
- Added SmileySelectWindow button
- Fixed (disabled) display of smileys in hyperlinks 
- Added 'scale to text height' option
- Fixed GDI leakage bugs 
- Other minor bugfixes

0.1.0.0
-------
Official 1.0 release
- Support for customizable icon packs
- Standard shipment with full OG smiley pack of MatriX
- Better smiley parsing (support for 'isolated' smileys)
- Specify smileys on a 'per protocol' basis
- Smiley replacementsupport for plugins

0.0.2.0
-------
Second alpha release with OG smileys of MatriX

0.0.1.0
-------
Initial alpha (test) release with beautyfully :) styled greenish icons.


Miranda IM
==========
Miranda IM is an open source instant messenger framework that 
support plugins for many different networks; ICQ, MSN, YAHOO
AIM to mention a few (but not all). Get it at:
http://miranda.sourceforge.net


Copyright and license
=====================

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.