BBApi.h File Reference

#include <windows.h>
#include <winnt.h>
#include <stdio.h>

Classes
struct	StyleItemImage
struct	StyleItem
struct	string_node
class	DesktopInfo
struct	trayIconItem

Macros
#define	WINVER   0x0601
#define	_WIN32_WINNT   0x0601
#define	WIN32_LEAN_AND_MEAN
#define	VC_EXTRALEAN
#define	NOCRYPT
#define	NOSERVICE
#define	NOIME
#define	NOMCX
#define	NO_INTSHCUT_GUIDS
#define	NO_SHDOCVW_GUIDS
#define	_CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES   1
#define	DLL_EXPORT   __declspec(dllexport)
#define	MAX_LINE_LENGTH   4096
#define	B_PARENTRELATIVE   -1
#define	B_HORIZONTAL   0
#define	B_VERTICAL   1
#define	B_DIAGONAL   2
#define	B_CROSSDIAGONAL   3
#define	B_PIPECROSS   4
#define	B_ELLIPTIC   5
#define	B_RECTANGLE   6
#define	B_PYRAMID   7
#define	B_SOLID   8
#define	B_IMAGEFROMFILE   99
#define	B_SPLITHORIZONTAL   B_HORIZONTAL+100
#define	B_SPLITVERTICAL   B_VERTICAL+100
#define	B_SPLITSOLID   B_SOLID+100
#define	B_SUPERHORIZONTAL   B_HORIZONTAL+150
#define	B_SUPERVERTICAL   B_VERTICAL+150
#define	B_MIRRORHORIZONTAL   B_HORIZONTAL+200
#define	B_MIRRORVERTICAL   B_VERTICAL+200
#define	B_WAVEHORIZONTAL   B_HORIZONTAL+300
#define	B_WAVEVERTICAL   B_VERTICAL+300
#define	B_BLOCKHORIZONTAL   B_HORIZONTAL+400
#define	B_BLOCKVERTICAL   B_VERTICAL+400
#define	BEVEL_FLAT   0
#define	BEVEL_RAISED   1
#define	BEVEL_SUNKEN   2
#define	BEVEL1   1
#define	BEVEL2   2
#define	GLYPH_MENU_EMPTY   0
#define	GLYPH_MENU_SQUARE   1
#define	GLYPH_WINDOW_SHADE   101
#define	GLYPH_WINDOW_PIN   102
#define	GLYPH_WINDOW_ALWAYSONTOP   103
#define	GLYPH_WINDOW_MINIMIZE   104
#define	GLYPH_WINDOW_MAXIMIZE   105
#define	GLYPH_WINDOW_CLOSE   106
#define	CORNER_TOPLEFT   (1<<0)
#define	CORNER_TOPRIGHT   (1<<1)
#define	CORNER_BOTTOMLEFT   (1<<2)
#define	CORNER_BOTTOMRIGHT   (1<<3)
#define	METRIC_BORDER   (1<<0)
#define	METRIC_MARGIN   (1<<1)
#define	METRIC_BEVEL   (1<<2)
#define	BB_REGISTERMESSAGE   10001
#define	BB_UNREGISTERMESSAGE   10002
#define	BB_QUIT   10101
#define	BB_RESTART   10102
#define	BB_RECONFIGURE   10103
#define	BB_SETSTYLE   10104
#define	BB_SETTHEME   10107
#define	BB_EDITFILE   10201
#define	BB_MENU   10301
#define	BB_HIDEMENU   10302
#define	BB_TOGGLESYSTEMBAR   10303
#define	BB_SETTOOLBARLABEL   10304
#define	BB_CONSOLEMESSAGE   10304
#define	BB_POPUPMESSAGE   20608
#define	BB_TOGGLEPLUGINS   10305
#define	BB_SUBMENU   10306
#define	BB_TOGGLESLIT   10307
#define	BB_TOGGLEDOCK   10307
#define	BB_TOGGLETOOLBAR   10308
#define	BB_AUTOHIDE   10309
#define	BB_TOGGLECONSOLE   10310
#define	BB_SHUTDOWN   10401
#define	BB_RUN   10402
#define	BB_DESKTOPINFO   10501
#define	BB_LISTDESKTOPS   10502
#define	BB_SWITCHTON   10503
#define	BB_BRINGTOFRONT   10504
#define	BB_WORKSPACE   10505
#define	BB_TASKSUPDATE   10506
#define	BB_TRAYUPDATE   10507
#define	BB_DRAGTODESKTOP   10510
#define	BB_ADDTASK   10601
#define	BB_REMOVETASK   10602
#define	BB_ACTIVATESHELLWINDOW   10603
#define	BB_ACTIVETASK   10604
#define	BB_MINMAXTASK   10605
#define	BB_REDRAW   10610
#define	BB_WINDOWSHADE   10606
#define	BB_WINDOWGROWHEIGHT   10607
#define	BB_WINDOWGROWWIDTH   10608
#define	BB_WINDOWLOWER   10609
#define	BB_WINDOWMINIMIZE   10611
#define	BB_WINDOWRAISE   10612
#define	BB_REDRAWGUI   10881
#define	BBRG_TOOLBAR   (1<<0)
#define	BBRG_MENU   (1<<1)
#define	BBRG_WINDOW   (1<<2)
#define	BBRG_DESK   (1<<3)
#define	BBRG_DESKTOP   BBRG_DESK
#define	BBRG_SLIT   (1<<8)
#define	BBRG_DOCK   BBRG_SLIT
#define	BBRG_HARDWARE   (1<<16)
#define	BB_BROADCAST   10901
#define	BB_TRAYICONMESSAGE   10999
#define	DOCK_ADD   11001
#define	DOCK_REMOVE   11002
#define	DOCK_UPDATE   11003
#define	SLIT_ADD   DOCK_ADD
#define	SLIT_REMOVE   DOCK_REMOVE
#define	SLIT_UPDATE   DOCK_UPDATE
#define	PLUGIN_NAME   1
#define	PLUGIN_VERSION   2
#define	PLUGIN_AUTHOR   3
#define	PLUGIN_RELEASEDATE   4
#define	PLUGIN_LINK   5
#define	PLUGIN_EMAIL   6
#define	PLUGIN_BROAMS   7
#define	PLUGIN_UPDATE_URL   8
#define	PLUGIN_RELEASE   PLUGIN_RELEASEDATE
#define	TRAYICON_ADDED   0
#define	TRAYICON_MODIFIED   1
#define	TRAYICON_REMOVED   2
#define	TRAYICON_REFRESH   3
#define	TASKITEM_ADDED   0
#define	TASKITEM_MODIFIED   1
#define	TASKITEM_ACTIVATED   2
#define	TASKITEM_REMOVED   3
#define	TASKITEM_REFRESH   4
#define	TASKITEM_FLASHED   5
#define	CONSOLE_REGULAR_MESSAGE   0
#define	CONSOLE_INFORMATION_MESSAGE   1
#define	CONSOLE_WARNING_MESSAGE   2
#define	CONSOLE_ERROR_MESSAGE   3
#define	CONSOLE_SHELL_MESSAGE   4
#define	CONSOLE_PLAIN_MESSAGE   253
#define	CONSOLE_INDENTED_MESSAGE   254
#define	CONSOLE_SEPARATOR   255
#define	SN_HANDLEHEIGHT   SN_HANDLEWIDTH
#define	PicColor   foregroundColor
#define	BulletColor   foregroundColor
#define	Color1   Color
#define	Color2   ColorTo
#define	CORE_SHELL_STYLEITEM   315185
#define	BBWS_TOGGLESTICKY   12 /* lParam: hwnd or NULL for foregroundwindow */
#define	BBWS_MAKESTICKY   14 /* lParam: hwnd or NULL for foregroundwindow */
#define	BBWS_CLEARSTICKY   15 /* lParam: hwnd or NULL for foregroundwindow */
#define	BBWS_TOGGLEONTOP   17 /* lParam: hwnd or NULL for foregroundwindow */

Typedefs
typedef struct StyleItemImage	StyleItemImage
typedef struct StyleItem	StyleItem
typedef struct string_node	string_node

Enumerations
enum	{   SN_TOOLBAR = 1 , SN_TOOLBARBUTTON , SN_TOOLBARBUTTONP , SN_TOOLBARLABEL ,   SN_TOOLBARWINDOWLABEL , SN_TOOLBARCLOCK , SN_MENUTITLE , SN_MENUFRAME ,   SN_MENUHILITE , SN_MENUBULLET , SN_MENUBULLETPOS , SN_BORDERWIDTH ,   SN_BORDERCOLOR , SN_BEVELWIDTH , SN_FRAMEWIDTH , SN_HANDLEWIDTH ,   SN_ROOTCOMMAND , SN_MENUALPHA , SN_TOOLBARALPHA , SN_METRICSUNIX ,   SN_BULLETUNIX , SN_WINFOCUS_TITLE , SN_WINFOCUS_LABEL , SN_WINFOCUS_HANDLE ,   SN_WINFOCUS_GRIP , SN_WINFOCUS_BUTTON , SN_WINFOCUS_BUTTONP , SN_WINUNFOCUS_TITLE ,   SN_WINUNFOCUS_LABEL , SN_WINUNFOCUS_HANDLE , SN_WINUNFOCUS_GRIP , SN_WINUNFOCUS_BUTTON ,   SN_WINFOCUS_FRAME_COLOR , SN_WINUNFOCUS_FRAME_COLOR , SN_NEWMETRICS , SN_ISSTYLE070 ,   SN_SLIT , SN_MENUSEPMARGIN , SN_MENUSEPCOLOR , SN_MENUSEPSHADOWCOLOR ,   SN_MENUGRIP , SN_LAST }

Functions
DLL_EXPORT LPCSTR	GetBBVersion ()
DLL_EXPORT HWND	GetBBWnd ()
DLL_EXPORT LPCSTR	GetOSInfo ()
DLL_EXPORT bool WINAPI	GetBlackboxPath (LPSTR path, int maxLength)
DLL_EXPORT HINSTANCE	BBExecute (HWND Owner, LPCSTR szOperation, LPCSTR szCommand, LPCSTR szArgs, LPCSTR szDirectory, int nShowCmd, bool noErrorMsgs)
DLL_EXPORT void	BBSmartExecute (LPSTR inputString)
DLL_EXPORT void	Log (LPCSTR variable, LPCSTR description)
DLL_EXPORT int	MBoxErrorFile (LPCSTR szFile)
DLL_EXPORT int	MBoxErrorValue (LPCSTR szValue)
DLL_EXPORT LPSTR	Tokenize (LPCSTR sourceString, LPSTR targetString, LPSTR delimiter)
DLL_EXPORT int	BBTokenize (LPCSTR sourceString, LPSTR *targetStrings, DWORD numTokensToParse, LPSTR remainingString)
DLL_EXPORT bool	IsInString (LPCSTR inputString, LPCSTR searchString)
bool	IsInStringUnicode (LPWSTR inputString, LPWSTR searchString)
bool	GetConfigFilePath (LPSTR filePath, LPCSTR setPath, LPCSTR checkName1, LPCSTR checkName2)
DLL_EXPORT LPCSTR	ConfigFileExists (LPCSTR filename, LPCSTR pluginDir)
DLL_EXPORT bool	FileExists (LPCSTR szFileName)
DLL_EXPORT bool	FolderExists (LPCSTR szFolderPath)
DLL_EXPORT LPCSTR	bbrcPath (LPCSTR bbrcFileName=NULL)
DLL_EXPORT LPCSTR	extensionsrcPath (LPCSTR extensionsrcFileName=NULL)
DLL_EXPORT LPCSTR	plugrcPath (LPCSTR pluginrcFileName=NULL)
DLL_EXPORT LPCSTR	menuPath (LPCSTR menurcFileName=NULL)
DLL_EXPORT LPCSTR	stylePath (LPCSTR styleFileName=NULL)
DLL_EXPORT void	GetBlackboxEditor (LPSTR editor)
DLL_EXPORT bool	DownloadFile (LPCSTR url, LPCSTR path)
DLL_EXPORT FILE *	FileOpen (LPCSTR fileName)
DLL_EXPORT bool	FileClose (FILE *filePointer)
DLL_EXPORT bool	FileRead (FILE *filePointer, LPSTR readString)
int	GetParentFolder (LPSTR path)
DLL_EXPORT LPSTR	ReadValue (LPCSTR fp, LPCSTR keyword, LPLONG ptr=NULL)
DLL_EXPORT bool	ReadBool (LPCSTR filePointer, LPCSTR string, bool defaultBool)
DLL_EXPORT int	ReadInt (LPCSTR filePointer, LPCSTR string, int defaultInt)
DLL_EXPORT LPSTR	ReadString (LPCSTR filePointer, LPCSTR string, LPSTR defaultString)
DLL_EXPORT COLORREF	ReadColor (LPCSTR filePointer, LPCSTR string, LPCSTR defaultString)
DLL_EXPORT bool	ReadNextCommand (FILE *filePointer, LPSTR readLine, DWORD lineLength)
void	WriteValue (LPCSTR fp, LPCSTR keyword, LPCSTR value)
DLL_EXPORT void	WriteBool (LPCSTR filePointer, LPCSTR keyword, bool value)
DLL_EXPORT void	WriteInt (LPCSTR filePointer, LPCSTR keyword, int value)
DLL_EXPORT void	WriteString (LPCSTR filePointer, LPCSTR keyword, LPSTR value)
DLL_EXPORT void	WriteColor (LPCSTR filePointer, LPCSTR keyword, COLORREF value)
DLL_EXPORT void *	GetSettingPtr (int index)
DLL_EXPORT void	ParseItem (LPCSTR szItem, StyleItem *item)
DLL_EXPORT LPSTR	StrRemoveEncap (LPSTR string)
DLL_EXPORT void	ReplaceEnvVars (LPSTR string)
DLL_EXPORT void	ReplaceShellFolders (LPSTR string)
DLL_EXPORT void	ParseFontString (LPSTR string, StyleItem *item)
DLL_EXPORT void	CheckFontSubstitution (LPSTR font)
COLORREF	ParseLiteralColor (LPCSTR colour)
int	ParseDropFiles (HWND hwnd, WPARAM wParam)
DLL_EXPORT bool	CopyStringToClipboard (LPSTR string)
DLL_EXPORT bool	RetrieveStringFromClipboard (LPSTR target)
DLL_EXPORT void	GetPositionEvolved (LPSTR placement, SIZE size, POINT *pt)
StyleItem *	FindStyleElement (LPSTR styleElement)
DLL_EXPORT bool	MakeGradientEvolved (HDC hdc, RECT rect, LPSTR styleElement, bool drawBevel, bool drawBorder)
DLL_EXPORT bool	DrawTextEvolved (HDC hdc, RECT *rect, LPSTR styleElement, LPWSTR textUnicode, LPSTR textANSI, unsigned int fontHeightOverride, unsigned int format, bool getSize)
DLL_EXPORT int	GetMetricsEvolved (LPSTR styleElement, int metricsToInclude)
DLL_EXPORT void	MakeGradientSuper (HDC hdc, RECT rect, int type, COLORREF color1, COLORREF color2, COLORREF color3, COLORREF color4, COLORREF color5, COLORREF color6, COLORREF color7, COLORREF color8, bool bInterlaced, int bevelStyle, int bevelPosition, int bevelWidth, COLORREF borderColour, int borderWidth)
DLL_EXPORT void	MakeGradientEx (HDC hdc, RECT rect, int gradientType, COLORREF colourFrom, COLORREF colourTo, COLORREF splitFrom, COLORREF splitTo, bool interlaced, int bevelStyle, int bevelPosition, int bevelWidth, COLORREF borderColour, int borderWidth)
DLL_EXPORT void	MakeGradient (HDC hdc, RECT rect, int gradientType, COLORREF colourFrom, COLORREF colourTo, bool interlaced, int bevelStyle, int bevelPosition, int bevelWidth, COLORREF borderColour, int borderWidth)
DLL_EXPORT void	MakeStyleGradient (HDC hdc, RECT *rect, StyleItem *item, bool withBorder)
DLL_EXPORT HFONT	CreateStyleFont (StyleItem *item)
DLL_EXPORT void	CreateBorder (HDC hdc, RECT *rect, int borderColour, int borderWidth)
DLL_EXPORT void	CreateBorderSuper (HDC hdc, RECT rect, int type, COLORREF color1, COLORREF color2, COLORREF color3, COLORREF color4, COLORREF color5, COLORREF color6, COLORREF color7, COLORREF color8, int borderWidth)
void	CreateElementImage (StyleItem *styleItem)
void	DrawImageIntoRect (HDC hdc, RECT r, StyleItem *styleItem, bool useAlpha, bool drawBorder)
void	DrawTextWithEffectsEx (HDC hdc, RECT r, LPWSTR textUnicode, LPSTR textANSI, unsigned int format, COLORREF textColor, bool outline, COLORREF outlineColor, bool shadow, COLORREF shadowColor, int shadowX, int shadowY)
DLL_EXPORT void	DrawTextWithEffects (HDC hdc, RECT r, LPSTR text, unsigned int format, COLORREF textColor, bool outline, COLORREF outlineColor, bool shadow, COLORREF shadowColor, int shadowX, int shadowY)
void	DrawTextWithEffectsUnicode (HDC hdc, RECT r, LPWSTR text, unsigned int format, COLORREF textColor, bool outline, COLORREF outlineColor, bool shadow, COLORREF shadowColor, int shadowX, int shadowY)
DLL_EXPORT void	DrawSatHueIcon (HDC hdc, RECT r, HICON icon, int size, int saturation, int hue)
DLL_EXPORT void	DrawGlyph (HDC hdc, RECT r, int glyph, COLORREF glyphColor)
DLL_EXPORT void	AlphaRect (HDC hdc, RECT rect, unsigned char alpha)
DLL_EXPORT void	AlphaBorder (HDC hdc, RECT rect, unsigned char alpha, int borderWidth)
DLL_EXPORT void	AlphaCorner (HDC hdc, RECT rect, int corner, int bevelStyle, int bevelPosition, int bevelWidth, int borderWidth, unsigned char minAlpha, unsigned char maxAlpha)
DLL_EXPORT void	AlphaFromRGB (HDC hdc, RECT rect, unsigned char minAlpha, unsigned char maxAlpha, bool recolor, COLORREF color)
void	AlphaMask (HDC destHdc, RECT destRect, HDC srcHdc, RECT srcRect, bool useSrcRGBAsAlpha)
DLL_EXPORT void	AlphaApply (HDC hdc, RECT rect)
DLL_EXPORT void	PrepareCorner (HDC hdc, RECT rect, int corner, int bevelStyle, int bevelPosition, int bevelWidth, int borderWidth)
DLL_EXPORT int	PrepareCornerEvolved (HDC hdc, RECT rect, int corner, LPSTR styleElement)
DLL_EXPORT Menu *	MakeMenu (LPCSTR HeaderText)
DLL_EXPORT void	DelMenu (Menu *PluginMenu)
DLL_EXPORT Menu *	MakeNamedMenu (LPCSTR HeaderText, LPCSTR MenuId, bool popup)
DLL_EXPORT MenuItem *	MakeSubmenu (Menu *ParentMenu, Menu *ChildMenu, LPCSTR Title)
DLL_EXPORT MenuItem *	MakeMenuItem (Menu *PluginMenu, LPCSTR Title, LPCSTR Cmd, bool ShowIndicator)
DLL_EXPORT MenuItem *	MakeMenuItemBool (Menu *PluginMenu, LPCSTR Title, LPCSTR Cmd, bool state, int selectionGroup)
DLL_EXPORT MenuItem *	MakeMenuItemInt (Menu *PluginMenu, LPCSTR Title, LPCSTR Cmd, int val, int minval, int maxval)
DLL_EXPORT MenuItem *	MakeMenuItemString (Menu *PluginMenu, LPCSTR Title, LPCSTR Cmd, LPCSTR init_string)
DLL_EXPORT MenuItem *	MakeMenuNOP (Menu *PluginMenu, LPCSTR Title)
DLL_EXPORT void	ShowMenu (Menu *PluginMenu)
DLL_EXPORT bool	IsAppWindow (HWND hwnd)
DLL_EXPORT bool	SetTransparency (HWND hwnd, BYTE alpha)
DLL_EXPORT bool	SetTransparencyEx (HWND hwnd, COLORREF crKey, BYTE bAlpha, DWORD dwFlags)
DLL_EXPORT void	SnapWindowToEdge (WINDOWPOS *windowPosition, int snapDistance, bool useScreenSize)
DLL_EXPORT void	MakeSticky (HWND window)
DLL_EXPORT void	RemoveSticky (HWND window)
DLL_EXPORT bool	CheckSticky (HWND window)
DLL_EXPORT void	ToggleSticky (HWND window)
void	ClearSticky ()
DLL_EXPORT void	GetDesktopInfo (DesktopInfo *deskInfo)
DLL_EXPORT int	GetTraySize ()
DLL_EXPORT trayIconItem *	GetTrayIcon (int pointer)
DLL_EXPORT bool	GetUnderExplorer ()
DLL_EXPORT int	GetTaskListSize ()
DLL_EXPORT void	SetTaskWorkspace (HWND hwnd, int workspace)
DLL_EXPORT int	GetTaskWorkspace (HWND hwnd)
DLL_EXPORT HWND	GetTask (int pointer)
DLL_EXPORT int	GetActiveTask ()
bool	IsOnTaskbar (HWND hwnd)
DLL_EXPORT HWND	IsAppRunning (LPSTR path)
DLL_EXPORT HMONITOR	GetMonitorRect (void *from, RECT *r, int Flags)

Macro Definition Documentation

WINVER

#define WINVER   0x0601

_WIN32_WINNT

#define _WIN32_WINNT   0x0601

WIN32_LEAN_AND_MEAN

#define WIN32_LEAN_AND_MEAN

VC_EXTRALEAN

#define VC_EXTRALEAN

NOCRYPT

#define NOCRYPT

NOSERVICE

#define NOSERVICE

NOIME

#define NOIME

NOMCX

#define NOMCX

NO_INTSHCUT_GUIDS

#define NO_INTSHCUT_GUIDS

NO_SHDOCVW_GUIDS

#define NO_SHDOCVW_GUIDS

_CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES

#define _CRT_SECURE_CPP_OVERLOAD_STANDARD_NAMES   1

DLL_EXPORT

#define DLL_EXPORT   __declspec(dllexport)

MAX_LINE_LENGTH

#define MAX_LINE_LENGTH   4096

B_PARENTRELATIVE

#define B_PARENTRELATIVE   -1

B_HORIZONTAL

#define B_HORIZONTAL   0

B_VERTICAL

#define B_VERTICAL   1

B_DIAGONAL

#define B_DIAGONAL   2

B_CROSSDIAGONAL

#define B_CROSSDIAGONAL   3

B_PIPECROSS

#define B_PIPECROSS   4

B_ELLIPTIC

#define B_ELLIPTIC   5

B_RECTANGLE

#define B_RECTANGLE   6

B_PYRAMID

#define B_PYRAMID   7

B_SOLID

#define B_SOLID   8

B_IMAGEFROMFILE

#define B_IMAGEFROMFILE   99

B_SPLITHORIZONTAL

#define B_SPLITHORIZONTAL   B_HORIZONTAL+100

B_SPLITVERTICAL

#define B_SPLITVERTICAL   B_VERTICAL+100

B_SPLITSOLID

#define B_SPLITSOLID   B_SOLID+100

B_SUPERHORIZONTAL

#define B_SUPERHORIZONTAL   B_HORIZONTAL+150

B_SUPERVERTICAL

#define B_SUPERVERTICAL   B_VERTICAL+150

B_MIRRORHORIZONTAL

#define B_MIRRORHORIZONTAL   B_HORIZONTAL+200

B_MIRRORVERTICAL

#define B_MIRRORVERTICAL   B_VERTICAL+200

B_WAVEHORIZONTAL

#define B_WAVEHORIZONTAL   B_HORIZONTAL+300

B_WAVEVERTICAL

#define B_WAVEVERTICAL   B_VERTICAL+300

B_BLOCKHORIZONTAL

#define B_BLOCKHORIZONTAL   B_HORIZONTAL+400

B_BLOCKVERTICAL

#define B_BLOCKVERTICAL   B_VERTICAL+400

BEVEL_FLAT

#define BEVEL_FLAT   0

BEVEL_RAISED

#define BEVEL_RAISED   1

BEVEL_SUNKEN

#define BEVEL_SUNKEN   2

BEVEL1

#define BEVEL1   1

BEVEL2

#define BEVEL2   2

GLYPH_MENU_EMPTY

#define GLYPH_MENU_EMPTY   0

GLYPH_MENU_SQUARE

#define GLYPH_MENU_SQUARE   1

GLYPH_WINDOW_SHADE

#define GLYPH_WINDOW_SHADE   101

GLYPH_WINDOW_PIN

#define GLYPH_WINDOW_PIN   102

GLYPH_WINDOW_ALWAYSONTOP

#define GLYPH_WINDOW_ALWAYSONTOP   103

GLYPH_WINDOW_MINIMIZE

#define GLYPH_WINDOW_MINIMIZE   104

GLYPH_WINDOW_MAXIMIZE

#define GLYPH_WINDOW_MAXIMIZE   105

GLYPH_WINDOW_CLOSE

#define GLYPH_WINDOW_CLOSE   106

CORNER_TOPLEFT

#define CORNER_TOPLEFT   (1<<0)

CORNER_TOPRIGHT

#define CORNER_TOPRIGHT   (1<<1)

CORNER_BOTTOMLEFT

#define CORNER_BOTTOMLEFT   (1<<2)

CORNER_BOTTOMRIGHT

#define CORNER_BOTTOMRIGHT   (1<<3)

METRIC_BORDER

#define METRIC_BORDER   (1<<0)

METRIC_MARGIN

#define METRIC_MARGIN   (1<<1)

METRIC_BEVEL

#define METRIC_BEVEL   (1<<2)

BB_REGISTERMESSAGE

#define BB_REGISTERMESSAGE   10001

BB_UNREGISTERMESSAGE

#define BB_UNREGISTERMESSAGE   10002

BB_QUIT

#define BB_QUIT   10101

BB_RESTART

#define BB_RESTART   10102

BB_RECONFIGURE

#define BB_RECONFIGURE   10103

BB_SETSTYLE

#define BB_SETSTYLE   10104

BB_SETTHEME

#define BB_SETTHEME   10107

BB_EDITFILE

#define BB_EDITFILE   10201

BB_MENU

#define BB_MENU   10301

BB_HIDEMENU

#define BB_HIDEMENU   10302

BB_TOGGLESYSTEMBAR

#define BB_TOGGLESYSTEMBAR   10303

BB_SETTOOLBARLABEL

#define BB_SETTOOLBARLABEL   10304

BB_CONSOLEMESSAGE

#define BB_CONSOLEMESSAGE   10304

BB_POPUPMESSAGE

#define BB_POPUPMESSAGE   20608

BB_TOGGLEPLUGINS

#define BB_TOGGLEPLUGINS   10305

BB_SUBMENU

#define BB_SUBMENU   10306

BB_TOGGLESLIT

#define BB_TOGGLESLIT   10307

BB_TOGGLEDOCK

#define BB_TOGGLEDOCK   10307

BB_TOGGLETOOLBAR

#define BB_TOGGLETOOLBAR   10308

BB_AUTOHIDE

#define BB_AUTOHIDE   10309

BB_TOGGLECONSOLE

#define BB_TOGGLECONSOLE   10310

BB_SHUTDOWN

#define BB_SHUTDOWN   10401

BB_RUN

#define BB_RUN   10402

BB_DESKTOPINFO

#define BB_DESKTOPINFO   10501

BB_LISTDESKTOPS

#define BB_LISTDESKTOPS   10502

BB_SWITCHTON

#define BB_SWITCHTON   10503

BB_BRINGTOFRONT

#define BB_BRINGTOFRONT   10504

BB_WORKSPACE

#define BB_WORKSPACE   10505

BB_TASKSUPDATE

#define BB_TASKSUPDATE   10506

BB_TRAYUPDATE

#define BB_TRAYUPDATE   10507

BB_DRAGTODESKTOP

#define BB_DRAGTODESKTOP   10510

BB_ADDTASK

#define BB_ADDTASK   10601

BB_REMOVETASK

#define BB_REMOVETASK   10602

BB_ACTIVATESHELLWINDOW

#define BB_ACTIVATESHELLWINDOW   10603

BB_ACTIVETASK

#define BB_ACTIVETASK   10604

BB_MINMAXTASK

#define BB_MINMAXTASK   10605

BB_REDRAW

#define BB_REDRAW   10610

BB_WINDOWSHADE

#define BB_WINDOWSHADE   10606

BB_WINDOWGROWHEIGHT

#define BB_WINDOWGROWHEIGHT   10607

BB_WINDOWGROWWIDTH

#define BB_WINDOWGROWWIDTH   10608

BB_WINDOWLOWER

#define BB_WINDOWLOWER   10609

BB_WINDOWMINIMIZE

#define BB_WINDOWMINIMIZE   10611

BB_WINDOWRAISE

#define BB_WINDOWRAISE   10612

BB_REDRAWGUI

#define BB_REDRAWGUI   10881

BBRG_TOOLBAR

#define BBRG_TOOLBAR   (1<<0)

BBRG_MENU

#define BBRG_MENU   (1<<1)

BBRG_WINDOW

#define BBRG_WINDOW   (1<<2)

BBRG_DESK

#define BBRG_DESK   (1<<3)

BBRG_DESKTOP

#define BBRG_DESKTOP   BBRG_DESK

BBRG_SLIT

#define BBRG_SLIT   (1<<8)

BBRG_DOCK

#define BBRG_DOCK   BBRG_SLIT

BBRG_HARDWARE

#define BBRG_HARDWARE   (1<<16)

BB_BROADCAST

#define BB_BROADCAST   10901

BB_TRAYICONMESSAGE

#define BB_TRAYICONMESSAGE   10999

DOCK_ADD

#define DOCK_ADD   11001

DOCK_REMOVE

#define DOCK_REMOVE   11002

DOCK_UPDATE

#define DOCK_UPDATE   11003

SLIT_ADD

#define SLIT_ADD   DOCK_ADD

SLIT_REMOVE

#define SLIT_REMOVE   DOCK_REMOVE

SLIT_UPDATE

#define SLIT_UPDATE   DOCK_UPDATE

PLUGIN_NAME

#define PLUGIN_NAME   1

PLUGIN_VERSION

#define PLUGIN_VERSION   2

PLUGIN_AUTHOR

#define PLUGIN_AUTHOR   3

PLUGIN_RELEASEDATE

#define PLUGIN_RELEASEDATE   4

PLUGIN_LINK

#define PLUGIN_LINK   5

PLUGIN_EMAIL

#define PLUGIN_EMAIL   6

PLUGIN_BROAMS

#define PLUGIN_BROAMS   7

PLUGIN_UPDATE_URL

#define PLUGIN_UPDATE_URL   8

PLUGIN_RELEASE

#define PLUGIN_RELEASE   PLUGIN_RELEASEDATE

TRAYICON_ADDED

#define TRAYICON_ADDED   0

TRAYICON_MODIFIED

#define TRAYICON_MODIFIED   1

TRAYICON_REMOVED

#define TRAYICON_REMOVED   2

TRAYICON_REFRESH

#define TRAYICON_REFRESH   3

TASKITEM_ADDED

#define TASKITEM_ADDED   0

TASKITEM_MODIFIED

#define TASKITEM_MODIFIED   1

TASKITEM_ACTIVATED

#define TASKITEM_ACTIVATED   2

TASKITEM_REMOVED

#define TASKITEM_REMOVED   3

TASKITEM_REFRESH

#define TASKITEM_REFRESH   4

TASKITEM_FLASHED

#define TASKITEM_FLASHED   5

CONSOLE_REGULAR_MESSAGE

#define CONSOLE_REGULAR_MESSAGE   0

CONSOLE_INFORMATION_MESSAGE

#define CONSOLE_INFORMATION_MESSAGE   1

CONSOLE_WARNING_MESSAGE

#define CONSOLE_WARNING_MESSAGE   2

CONSOLE_ERROR_MESSAGE

#define CONSOLE_ERROR_MESSAGE   3

CONSOLE_SHELL_MESSAGE

#define CONSOLE_SHELL_MESSAGE   4

CONSOLE_PLAIN_MESSAGE

#define CONSOLE_PLAIN_MESSAGE   253

CONSOLE_INDENTED_MESSAGE

#define CONSOLE_INDENTED_MESSAGE   254

CONSOLE_SEPARATOR

#define CONSOLE_SEPARATOR   255

SN_HANDLEHEIGHT

#define SN_HANDLEHEIGHT   SN_HANDLEWIDTH

PicColor

#define PicColor   foregroundColor

BulletColor

#define BulletColor   foregroundColor

Color1

#define Color1   Color

Color2

#define Color2   ColorTo

CORE_SHELL_STYLEITEM

#define CORE_SHELL_STYLEITEM   315185

BBWS_TOGGLESTICKY

#define BBWS_TOGGLESTICKY   12 /* lParam: hwnd or NULL for foregroundwindow */

BBWS_MAKESTICKY

#define BBWS_MAKESTICKY   14 /* lParam: hwnd or NULL for foregroundwindow */

BBWS_CLEARSTICKY

#define BBWS_CLEARSTICKY   15 /* lParam: hwnd or NULL for foregroundwindow */

BBWS_TOGGLEONTOP

#define BBWS_TOGGLEONTOP   17 /* lParam: hwnd or NULL for foregroundwindow */

Typedef Documentation

StyleItemImage

typedef struct StyleItemImage StyleItemImage

StyleItem

typedef struct StyleItem StyleItem

string_node

typedef struct string_node string_node

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
SN_TOOLBAR
SN_TOOLBARBUTTON
SN_TOOLBARBUTTONP
SN_TOOLBARLABEL
SN_TOOLBARWINDOWLABEL
SN_TOOLBARCLOCK
SN_MENUTITLE
SN_MENUFRAME
SN_MENUHILITE
SN_MENUBULLET
SN_MENUBULLETPOS
SN_BORDERWIDTH
SN_BORDERCOLOR
SN_BEVELWIDTH
SN_FRAMEWIDTH
SN_HANDLEWIDTH
SN_ROOTCOMMAND
SN_MENUALPHA
SN_TOOLBARALPHA
SN_METRICSUNIX
SN_BULLETUNIX
SN_WINFOCUS_TITLE
SN_WINFOCUS_LABEL
SN_WINFOCUS_HANDLE
SN_WINFOCUS_GRIP
SN_WINFOCUS_BUTTON
SN_WINFOCUS_BUTTONP
SN_WINUNFOCUS_TITLE
SN_WINUNFOCUS_LABEL
SN_WINUNFOCUS_HANDLE
SN_WINUNFOCUS_GRIP
SN_WINUNFOCUS_BUTTON
SN_WINFOCUS_FRAME_COLOR
SN_WINUNFOCUS_FRAME_COLOR
SN_NEWMETRICS
SN_ISSTYLE070
SN_SLIT
SN_MENUSEPMARGIN
SN_MENUSEPCOLOR
SN_MENUSEPSHADOWCOLOR
SN_MENUGRIP
SN_LAST

{
     SN_TOOLBAR = 1             // StyleItem*
    ,SN_TOOLBARBUTTON           // StyleItem*
    ,SN_TOOLBARBUTTONP          // StyleItem*
    ,SN_TOOLBARLABEL            // StyleItem*
    ,SN_TOOLBARWINDOWLABEL      // StyleItem*
    ,SN_TOOLBARCLOCK            // StyleItem*
    ,SN_MENUTITLE               // StyleItem*
    ,SN_MENUFRAME               // StyleItem*
    ,SN_MENUHILITE              // StyleItem*
 
    ,SN_MENUBULLET              // char*
    ,SN_MENUBULLETPOS           // char*
 
    ,SN_BORDERWIDTH             // int*
    ,SN_BORDERCOLOR             // int*
    ,SN_BEVELWIDTH              // int*
    ,SN_FRAMEWIDTH              // int*
    ,SN_HANDLEWIDTH             // int*
 
    ,SN_ROOTCOMMAND             // char*
 
    ,SN_MENUALPHA               // int*
    ,SN_TOOLBARALPHA            // int*
 
    ,SN_METRICSUNIX             // bool*
    ,SN_BULLETUNIX              // bool*
 
    //===============================================
    // For compatibility with bbLeanSkin/bbIconBox...
    // ########### WORK IN PROGRESS / TBD ###########
    //===============================================
 
    ,SN_WINFOCUS_TITLE         // StyleItem*
    ,SN_WINFOCUS_LABEL         // StyleItem*
    ,SN_WINFOCUS_HANDLE           // StyleItem*
    ,SN_WINFOCUS_GRIP           // StyleItem*
    ,SN_WINFOCUS_BUTTON           // StyleItem*
    ,SN_WINFOCUS_BUTTONP     // StyleItem*
 
    ,SN_WINUNFOCUS_TITLE     // StyleItem*
    ,SN_WINUNFOCUS_LABEL     // StyleItem*
    ,SN_WINUNFOCUS_HANDLE       // StyleItem*
    ,SN_WINUNFOCUS_GRIP           // StyleItem*
    ,SN_WINUNFOCUS_BUTTON       // StyleItem*
 
    ,SN_WINFOCUS_FRAME_COLOR // COLORREF*
    ,SN_WINUNFOCUS_FRAME_COLOR // COLORREF*
 
    ,SN_NEWMETRICS             // bool (not a pointer)
 
    //===============================================
    // + Stuff added later by bb/C/Lean/Zero/Mod...?
    // ########### WORK IN PROGRESS / TBD ###########
    //===============================================
 
    ,SN_ISSTYLE070             // bool*
    ,SN_SLIT                 // StyleItem*
 
    ,SN_MENUSEPMARGIN           // int*
    ,SN_MENUSEPCOLOR         // COLORREF*
    ,SN_MENUSEPSHADOWCOLOR     // COLORREF*
    ,SN_MENUGRIP             // StyleItem*
 
    ,SN_LAST
};

Function Documentation

GetBBVersion()

DLL_EXPORT LPCSTR GetBBVersion

(

)

{
    char buffer[MAX_LINE_LENGTH];
    ULONG *size = 0;
    DWORD number = GetFileVersionInfoSize("Blackbox.exe", size);
    GetFileVersionInfo("Blackbox.exe", NULL, number, (LPVOID)buffer);
 
    void *value;
    UINT bytes;
     // Make sure the correct version encoding is used (currently "000004b0" = language neutral)
    VerQueryValue(buffer, TEXT("\\StringFileInfo\\000004b0\\ProductVersion"), &value, &bytes);
    strcpy(tempBuf, (LPCSTR)value);
 
    return tempBuf;
}

GetBBWnd()

DLL_EXPORT HWND GetBBWnd

(

)

{
    if (!hBlackbox) hBlackbox = FindWindow("xoblite", NULL);
    return hBlackbox;
}

GetOSInfo()

DLL_EXPORT LPCSTR GetOSInfo

(

)

{
    char buffer[MAX_LINE_LENGTH];
 
    OSVERSIONINFO osv;
    ZeroMemory(&osv, sizeof(osv));
    osv.dwOSVersionInfoSize = sizeof(osv);
    GetVersionEx(&osv);
 
    if (IsWindows10OrGreater())
    {
        if (osv.dwBuildNumber >= 22000) strcpy(buffer, "Windows 11"); // PLACEHOLDER - No IsWindows11OrGreater() function available in the Windows API yet (?)
        else strcpy(buffer, "Windows 10");
    }
    else if (IsWindows8Point1OrGreater()) strcpy(buffer, "Windows 8.1");
    else if (IsWindows8OrGreater()) strcpy(buffer, "Windows 8");
    else if (IsWindows7OrGreater()) strcpy(buffer, "Windows 7");
    else if (IsWindowsVistaOrGreater()) strcpy(buffer, "Windows Vista");
    else
    {
        // As per Microsoft: "In Windows 8.1 and Windows 10, the GetVersion and GetVersionEx functions have been deprecated.
        // In Windows 10, the VerifyVersionInfo function has also been deprecated. While you can still call the
        // deprecated functions, if your application does not specifically target Windows 8.1 or Windows 10,
        // the functions will return the Windows 8 version (6.2)."
        // ### -> Added a basic application manifest with compatibility settings, see Resources/Compatbility.manifest ###
    
        if (osv.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS) // Windows 9x/ME
        {
            if (osv.dwMinorVersion >= 90) strcpy(buffer, "Windows ME");
            else if (osv.dwMinorVersion >= 10) strcpy(buffer, "Windows 98");
            else strcpy(buffer, "Windows 95");
        }
        else // Windows NT/2000/XP/Vista/7/8/8.1/10/11... (nb. not including server variants here as alternative shells are really only for clients anyway)
        {
            sprintf(buffer, "Windows NT %d.%d", osv.dwMajorVersion, osv.dwMinorVersion); // Fallback in case of unknown Windows version...
 
            if (osv.dwMajorVersion == 10)
            {
                if (osv.dwMinorVersion == 0)
                {
                    if (osv.dwBuildNumber >= 22000) strcpy(buffer, "Windows 11");
                    else strcpy(buffer, "Windows 10");
                }
            }
            else if (osv.dwMajorVersion == 6)
            {
                if (osv.dwMinorVersion == 3) strcpy(buffer, "Windows 8.1");
                else if (osv.dwMinorVersion == 2) strcpy(buffer, "Windows 8");
                else if (osv.dwMinorVersion == 1) strcpy(buffer, "Windows 7");
                else if (osv.dwMinorVersion == 0) strcpy(buffer, "Windows Vista");
            }
            else if (osv.dwMajorVersion == 5)
            {
                if (osv.dwMinorVersion == 2) strcpy(buffer, "Windows XP (64-bit)");
                else if (osv.dwMinorVersion == 1) strcpy(buffer, "Windows XP (32-bit)");
                else if (osv.dwMinorVersion == 0) strcpy(buffer, "Windows 2000");
            }
        }
    }
 
    strcpy(tempBuf, buffer);
 
    return tempBuf;
}

GetBlackboxPath()

DLL_EXPORT bool WINAPI GetBlackboxPath	(	LPSTR	path,
		int	maxLength )

{
    static char szPath[MAX_PATH] = "";
    
    if (!szPath[0])
    {
        GetModuleFileName(NULL, szPath, MAX_PATH);
//      int nLen = strlen(szPath) - 1;
//      while (nLen > 0 && szPath[nLen] != '\\') nLen--;
//      szPath[nLen+1] = 0;
        GetParentFolder(szPath);
    }
    
    strncpy(pszPath, szPath, nMaxLen);
 
    return true;
}

BBExecute()

DLL_EXPORT HINSTANCE BBExecute	(	HWND	Owner,
		LPCSTR	szOperation,
		LPCSTR	szCommand,
		LPCSTR	szArgs,
		LPCSTR	szDirectory,
		int	nShowCmd,
		bool	noErrorMsgs )

{
    if (!strlen(szCommand)) return HINSTANCE(32);
 
    //====================
 
    HINSTANCE retValue;
    PVOID oldRedirectionValue;
 
    //====================
 
    if (pSettings->runningUnderWOW64)
    {
        LPFN_WOW64_DISABLE_REDIRECTION BBWow64DisableRedirection = (LPFN_WOW64_DISABLE_REDIRECTION)GetProcAddress(GetModuleHandle("kernel32"),"Wow64DisableWow64FsRedirection");
        BBWow64DisableRedirection(&oldRedirectionValue);
    }
 
    //====================
 
    DWORD type = GetFileAttributes(szCommand);
 
    if (type & FILE_ATTRIBUTE_DIRECTORY && type != 0xFFFFFFFF)
    {
        retValue = ShellExecute(Owner, szOperation, szCommand, szArgs, NULL, nShowCmd ? nShowCmd : SW_SHOWNORMAL);
    }
    else
    {
        SHELLEXECUTEINFO si;
        ZeroMemory(&si, sizeof(si));
        si.cbSize = sizeof(SHELLEXECUTEINFO);
        si.fMask = SEE_MASK_DOENVSUBST | SEE_MASK_FLAG_NO_UI;
        si.hwnd = Owner;
        si.lpVerb = szOperation;
 
        if ((strlen(szCommand) >= 4) && (!_stricmp(&szCommand[strlen(szCommand)-4], ".lnk")))
        {
            // Let Explorer execute .lnk shortcuts to (hopefully?)
            // avoid some potential WoW64 redirection related issues...
            si.lpFile = "explorer";
            si.lpParameters = szCommand;
            si.lpDirectory = NULL;
        }
        else
        {
            // ...otherwise use ShellExecuteEx as usual...
            si.lpFile = szCommand;
            si.lpParameters = szArgs;
            si.lpDirectory = szDirectory;
        }
        si.nShow = nShowCmd ? nShowCmd : SW_SHOWNORMAL;
 
        BOOL result = ShellExecuteEx(&si);
 
        if (((result == FALSE) || ((int)si.hInstApp <= 32)) && !noErrorMsgs)
        {
            DWORD error = GetLastError();
 
            char msg[MAX_LINE_LENGTH];
            _snprintf_s(msg, sizeof(msg), _TRUNCATE, "%s %s (%s)", szCommand, szArgs, szDirectory);
            Log("BBExecute failed", msg);
 
            strcpy(msg, "ERROR: Could not execute ");
            strncat_s(msg, sizeof(msg), szCommand, 128);
            if (strlen(szCommand) >= 128) strcat(msg, "..."); // ...truncating long paths for the console error message...
 
            switch (error)
            {
                case ERROR_PATH_NOT_FOUND: { strcat(msg, " -> Path not found!"); break; }
                case ERROR_DDE_FAIL: { strcat(msg, " -> DDE transaction failed!"); break; }
                case ERROR_NO_ASSOCIATION: { strcat(msg, " -> No application associated with extension!"); break; }
                case ERROR_ACCESS_DENIED: { strcat(msg, " -> Access denied!"); break; }
                case ERROR_DLL_NOT_FOUND: { strcat(msg, " -> DLL not found!"); break; }
                case ERROR_CANCELLED: { strcat(msg, " -> Cancelled!"); break; }
                case ERROR_NOT_ENOUGH_MEMORY: { strcat(msg, " -> Not enough memory!"); break; }
                case ERROR_SHARING_VIOLATION: { strcat(msg, " -> Sharing violation!"); break; }
                default: { strcat(msg, " -> File not found!"); break; } // ERROR_FILE_NOT_FOUND
            }
 
            SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_ERROR_MESSAGE, (LPARAM)msg);
/*
            if (pSettings->debugLogging)
            {
                sprintf(msg, "DEBUG -> Command: %s / Arguments: %s / Directory: %s", szCommand, szArgs, szDirectory);
                SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)msg);
            }
*/
/*
            strcpy(msg, "Could not execute...\n\nCommand:\n");
 
            if (szCommand != NULL) strcat(msg, szCommand);
                strcat(msg, "   \n\nArguments:\n");
            if (szArgs != NULL) strcat(msg, szArgs);
                strcat(msg, "   \n\nWorking directory:\n");
            if (szDirectory != NULL) strcat(msg, szDirectory);
                strcat(msg, "   ");
 
            MessageBox(GetBBWnd(), msg, "xoblite", MB_OK | MB_ICONERROR | MB_TOPMOST);
*/
        }
 
        retValue = si.hInstApp;
    }
 
    //====================
 
    if (pSettings->runningUnderWOW64)
    {
        LPFN_WOW64_REVERT_REDIRECTION BBWow64RevertRedirection = (LPFN_WOW64_REVERT_REDIRECTION)GetProcAddress(GetModuleHandle("kernel32"),"Wow64RevertWow64FsRedirection");
        BBWow64RevertRedirection(&oldRedirectionValue);
    }
 
    return retValue;
}

BBSmartExecute()

DLL_EXPORT void BBSmartExecute

(

LPSTR

inputString

)

{
    if (!strlen(inputString)) return;
 
    //====================
 
    if (inputString[0] == '@') // Broadcast message (bro@m)
    {
        // Note: We need to use SendMessage() here for any "parent" @Script scripts to be executing sequentially!
        // (i.e. if we had used PostMessage() here any @Script "child" bro@ms would be more like executing in parallel...)
        SendMessage(GetBBWnd(), BB_BROADCAST, 0, (LPARAM)inputString);
    }
 
    //====================
 
    else if (!_strnicmp(inputString, "Pause", 5)) // @Script Pause <milliseconds> command
    {
        Sleep(atoi(&inputString[6]));
    }
 
    //====================
 
    else if ((!_strnicmp(inputString, "? ", 2)) && (strlen(inputString) > 2))
    {
        // Open the default browser to perform a web search using DuckDuckGo...
        char searchString[MAX_LINE_LENGTH];
        sprintf(searchString, "https://duckduckgo.com/?q=\"%s\"", &inputString[2]);
        BBSmartExecute(searchString);
    }
 
    else if ((!_strnicmp(inputString, "http", 4)) && pPluginManager->IsPluginLoaded("xWebViewer"))
//  else if ((!_strnicmp(inputString, "http://xoblite.net/", 19)) && pPluginManager->IsPluginLoaded("xWebViewer"))
    {
        // Open the URL in the xWebViewer plugin... (nb. if the plugin is *not* loaded, the URL will open in the default browser instead)
        char broam[MAX_LINE_LENGTH];
        sprintf(broam, "@xWebViewer URL %s", inputString);
        BBSmartExecute(broam);
    }
 
    //====================
 
    else // Regular command - extract working directory, arguments etc from input string
    {
        if (strchr(inputString, '$')) ReplaceShellFolders(inputString);
        if (strchr(inputString, '%')) ReplaceEnvVars(inputString);
 
        char command[MAX_LINE_LENGTH], arguments[MAX_LINE_LENGTH], workingdir[MAX_LINE_LENGTH];
        LPSTR tokens[1];
        tokens[0] = command;
        command[0] = arguments[0] = workingdir[0] = '\0';
        BBTokenize (inputString, tokens, 1, arguments);
 
        if (command[1] == ':')
        {
            strcpy(workingdir, command);
            GetParentFolder(workingdir);
        }
 
        BBExecute(GetDesktopWindow(), NULL, command, arguments, workingdir, SW_SHOWNORMAL, false);
 
//      PlaySoundFX(SFX_MENU_CLICK);
    }
}

Log()

DLL_EXPORT void Log	(	LPCSTR	variable,
		LPCSTR	description )

{
    char date[9], time[9];
    char tempBuf[MAX_LINE_LENGTH];
    GetBlackboxPath(tempBuf, sizeof(tempBuf));
    strcat(tempBuf, "xoblite.log");
 
    FILE *f = fopen(tempBuf, "a+");
    if (f)
    {
        _strdate(date);
        _strtime(time);
        if (strlen(line)) fprintf(f, "%s %s - %s: %s\n", date, time, des, line);
        else fprintf(f, "%s %s - %s\n", date, time, des);
        fclose(f);
    }
    else MBoxErrorFile(tempBuf);
}

MBoxErrorFile()

DLL_EXPORT int MBoxErrorFile

(

LPCSTR

szFile

)

{
    sprintf(tempBuf, "Error: Unable to open file \"%s\". Please check location and try again.", szFile);
    Log("MBoxErrorFile Called", szFile);
 
    return MessageBox(GetBBWnd(), tempBuf, "xoblite", MB_OK | MB_ICONERROR | MB_SETFOREGROUND | MB_TOPMOST);
}

MBoxErrorValue()

DLL_EXPORT int MBoxErrorValue

(

LPCSTR

szValue

)

{
    sprintf(tempBuf, "Error: %s", szValue);
    Log("MBoxErrorValue Called", szValue);
 
    return MessageBox(GetBBWnd(), tempBuf, "xoblite", MB_OK | MB_ICONERROR | MB_SETFOREGROUND | MB_TOPMOST);
}

Tokenize()

DLL_EXPORT LPSTR Tokenize	(	LPCSTR	sourceString,
		LPSTR	targetString,
		LPSTR	delimiter )

{
    static char remaining[MAX_LINE_LENGTH];
    strcpy(remaining, string);
 
    char character, quoted = 0, *b = buf, *r = remaining;
 
    while ((character = *r) != 0)
    {
        r++;
 
        if (!quoted)
        {
            if (strchr(delims, character)) break; // User-specified delimiter
            else if (character == '\"' || character == '\'') quoted = character;
            else if (((unsigned char)character <= 32) && (b == buf)) continue;
        }
        else if (character == quoted) quoted = 0;
 
        *b++ = character;
    }
 
    while ((b > buf) && ((unsigned char)b[-1] <= 32)) b--;
 
    *b = '\0';
 
    while (((unsigned char)*r <= 32) && (*r)) r++;
 
    strcpy(remaining, r);
 
    return remaining;
}

BBTokenize()

DLL_EXPORT int BBTokenize	(	LPCSTR	sourceString,
		LPSTR *	targetStrings,
		DWORD	numTokensToParse,
		LPSTR	remainingString )

IsInString()

DLL_EXPORT bool IsInString	(	LPCSTR	inputString,
		LPCSTR	searchString )

{
    // StrStrIA -> ANSI version of StrStrI, a case insensitive strstr (Win32 shlwapi.lib)
    if (StrStrIA(inputString, searchString) != NULL) return true;
    else return false;
}

IsInStringUnicode()

bool IsInStringUnicode	(	LPWSTR	inputString,
		LPWSTR	searchString )

{
    // StrStrIW -> Unicode version of StrStrI, a case insensitive strstr (Win32 shlwapi.lib)
    if (StrStrIW(inputString, searchString) != NULL) return true;
    else return false;
}

GetConfigFilePath()

bool GetConfigFilePath	(	LPSTR	filePath,
		LPCSTR	setPath,
		LPCSTR	checkName1,
		LPCSTR	checkName2 )

{
    if (setPath != NULL)
    {
        strcpy(filePath, setPath);
        if (strchr(filePath, '\"')) StrRemoveEncap(filePath);
    }
 
    else if (strlen(filePath) == 0) // We only need to do this once!
    {
        // Check for the file specified by checkName1 in the
        // Blackbox and $UserAppData$\Blackbox directories...
        strcpy(filePath, ConfigFileExists(checkName1, NULL));
        if (!_stricmp(filePath, ""))
        {
            if (checkName2 != NULL)
            {
                // If not found, check for the file specified
                // by checkName2 in the same directories...
                strcpy(filePath, ConfigFileExists(checkName2, NULL));
                if (!_stricmp(filePath, "")) return false;
            }
            else return false;
        }
    }
 
    return true;
}

ConfigFileExists()

DLL_EXPORT LPCSTR ConfigFileExists	(	LPCSTR	filename,
		LPCSTR	pluginDir )

{
    // First we look for the file in the $UserAppData$\Blackbox directory
    // (previously C:\Documents and Settings\username\Application Data\Blackbox ,
    // nowadays more often C:\Users\username\AppData\Blackbox ),
    // i.e. allowing per-user specific configuration for a given file:
    strcpy(tempBuf, pSettings->SF_userAppData);
    strcat(tempBuf, "\\Blackbox\\");
    strcat(tempBuf, filename);
    if (!FileExists(tempBuf))
    {
        // If not found, we check the root of the current theme folder,
        // i.e. allowing per theme configuration data while re-using 
        // shared plugin .dll's located in another folder for all themes:
        sprintf(tempBuf, "%s\\%s", pSettings->SF_currentThemePath, filename);
        if (FileExists(tempBuf)) return tempBuf;
 
        // If still not found, and if a pluginDir was specified,
        // we look for the file in this directory... (note: this would typically be the same
        // folder as the plugin .dll, i.e. not allowing plugin re-use across themes like above)
        if (pluginDir != NULL)
        {
            strcpy(tempBuf, pluginDir);
            strcat(tempBuf, filename);
            if (FileExists(tempBuf)) return tempBuf;
        }
 
        // Finally, if *still* not found, we look for the file in the Blackbox directory...
        GetBlackboxPath(tempBuf, sizeof(tempBuf));
        strcat(tempBuf, filename);
        if (!FileExists(tempBuf)) strcpy(tempBuf, "");
    }
 
    return tempBuf;
}

FileExists()

DLL_EXPORT bool FileExists

(

LPCSTR

szFileName

)

{
    HANDLE handle;
    WIN32_FIND_DATA findData;
 
    handle = FindFirstFile(szFileName, &findData);
    if (handle != INVALID_HANDLE_VALUE)
    {
        FindClose(handle);
        if (!(findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY))
            return true;
    }
 
    return false;
}

FolderExists()

DLL_EXPORT bool FolderExists

(

LPCSTR

szFolderPath

)

{
    HANDLE handle;
    WIN32_FIND_DATA findData;
 
    handle = FindFirstFile(szFolderPath, &findData);
    if (handle != INVALID_HANDLE_VALUE)
    {
        FindClose(handle);
        if (findData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
            return true;
    }
 
    return false;
}

bbrcPath()

DLL_EXPORT LPCSTR bbrcPath

(

LPCSTR

bbrcFileName = NULL

)

{
    // Check for xoblite.rc/blackbox.rc in the main Blackbox and $UserAppData$\Blackbox directories...
    if (!GetConfigFilePath(pSettings->bbrcFile, other, "xoblite.rc", "blackbox.rc"))
    {
        // If still not found, we create a new default
        // blackbox.rc (legacy fallback!) in the main Blackbox directory...
        pSettings->WriteDefaultRCSettings();
    }
 
    return pSettings->bbrcFile;
}

extensionsrcPath()

DLL_EXPORT LPCSTR extensionsrcPath

(

LPCSTR

extensionsrcFileName = NULL

)

{
    // Check for xoblite.rc/extensions.rc in the main Blackbox and $UserAppData$\Blackbox directories...
    if (!GetConfigFilePath(pSettings->xobrcFile, other, "xoblite.rc", "extensions.rc"))
    {
        // If still not found, set the default path
        // -> xoblite.rc in the main Blackbox directory...
        GetBlackboxPath(pSettings->xobrcFile, sizeof(pSettings->xobrcFile));
        strcat(pSettings->xobrcFile, "xoblite.rc");
    }
 
    return pSettings->xobrcFile;
}

plugrcPath()

DLL_EXPORT LPCSTR plugrcPath

(

LPCSTR

pluginrcFileName = NULL

)

{
/*
    // Check for plugins.rc in the Blackbox and $UserAppData$\Blackbox directories...
    if (!GetConfigFilePath(pSettings->pluginsFile, other, "plugins.rc", NULL))
    {
        // If still not found, set the default path
        // -> plugins.rc in the main Blackbox directory...
        GetBlackboxPath(pSettings->pluginsFile, sizeof(pSettings->pluginsFile));
        strcat(pSettings->pluginsFile, "plugins.rc");
    }
*/
    return pSettings->pluginsFile;
}

menuPath()

DLL_EXPORT LPCSTR menuPath

(

LPCSTR

menurcFileName = NULL

)

{
    if (other != NULL)
    {
        strcpy(pSettings->menuFile, other);
        if (strchr(pSettings->menuFile, '\"')) StrRemoveEncap(pSettings->menuFile);
        if (strchr(pSettings->menuFile, '$')) ReplaceShellFolders(pSettings->menuFile);
 
        // If the full path to the menu file is specified and it is in a subfolder
        // to the Blackbox folder, extract the relative path to the menu file
        // -> full path with the Blackbox folder replaced by an environment variable.
        // Example: "C:\Blackbox\menu.rc" becomes "$Blackbox$\menu.rc"
        // This way the Blackbox folder can be moved, and the menu path will still work! :D
 
        if (IsInString(pSettings->menuFile, pSettings->SF_blackboxPath))
        {
            char relativePath[MAX_LINE_LENGTH];
            strcpy(relativePath, "$Blackbox$");
            strcat(relativePath, &pSettings->menuFile[(strlen(pSettings->SF_blackboxPath))]);
            WriteString(pSettings->xobrcDefaultFile, "xoblite.menuFile:", relativePath);
        }
        else if (IsInString(pSettings->menuFile, pSettings->SF_userAppData))
        {
            char relativePath[MAX_LINE_LENGTH];
            strcpy(relativePath, "$UserAppData$");
            strcat(relativePath, &pSettings->menuFile[(strlen(pSettings->SF_userAppData))]);
            WriteString(pSettings->xobrcDefaultFile, "xoblite.menuFile:", relativePath);
        }
        else WriteString(pSettings->xobrcDefaultFile, "xoblite.menuFile:", pSettings->menuFile);
    }
 
    return pSettings->menuFile;
}

stylePath()

DLL_EXPORT LPCSTR stylePath

(

LPCSTR

styleFileName = NULL

)

{
    if (other != NULL)
    {
        strcpy(pSettings->styleFile, other);
        if (strchr(pSettings->styleFile, '\"')) StrRemoveEncap(pSettings->styleFile);
        if (strchr(pSettings->styleFile, '$')) ReplaceShellFolders(pSettings->styleFile);
 
        // If the full path to the style is specified and it is in a subfolder
        // to the Blackbox folder, extract the relative path to the style
        // -> full path with the Blackbox folder replaced by an environment variable.
        // Example: "C:\Blackbox\styles\charcoal" becomes "$Blackbox$\styles\charcoal"
        // This way the Blackbox folder can be moved, and the style path will still work! :D
 
        if (!pSettings->usingDefaultTheme && IsInString(pSettings->styleFile, pSettings->SF_currentThemePath))
        {
            char relativePath[MAX_LINE_LENGTH];
            strcpy(relativePath, "$CurrentTheme$");
            strcat(relativePath, &pSettings->styleFile[(strlen(pSettings->SF_currentThemePath))]);
            WriteString(pSettings->xobrcFile, "xoblite.styleFile:", relativePath);
        }
        else if (IsInString(pSettings->styleFile, pSettings->SF_blackboxPath))
        {
            char relativePath[MAX_LINE_LENGTH];
            strcpy(relativePath, "$Blackbox$");
            strcat(relativePath, &pSettings->styleFile[(strlen(pSettings->SF_blackboxPath))]);
            WriteString(pSettings->xobrcFile, "xoblite.styleFile:", relativePath);
        }
        else WriteString(pSettings->xobrcFile, "xoblite.styleFile:", pSettings->styleFile);
    }
 
    return pSettings->styleFile;
}

GetBlackboxEditor()

DLL_EXPORT void GetBlackboxEditor

(

LPSTR

editor

)

{
    strncpy_s(editor, MAX_PATH, pSettings->preferredEditor, _TRUNCATE); // Yes, this is still unsafe... (legacy API function)
}

DownloadFile()

DLL_EXPORT bool DownloadFile	(	LPCSTR	url,
		LPCSTR	path )

{
    // DownloadFile will accept an input string containing multiple URLs
    // (using space as the delimiter), in which case it will merge all
    // the files together into a single output file! :D
 
    HANDLE file = NULL;
    HINTERNET iopen = NULL, iopenurl = NULL;
    bool status = true; // Will be set to false if any of the specified downloads fail
 
    char remaining[MAX_LINE_LENGTH], token[MAX_LINE_LENGTH], extra[MAX_LINE_LENGTH];
    LPSTR tokens[1];
    tokens[0] = token;
 
    strcpy(remaining, url);
 
    //====================
 
    while (strlen(remaining))
    {
        // Get the next token from the list of URLs...
        token[0] = extra[0] = '\0';
        BBTokenize (remaining, tokens, 1, extra);
        strcpy(remaining, extra);
 
        // ...then try fetching the file from the web...
        iopen = InternetOpen("xoblite", INTERNET_OPEN_TYPE_PRECONFIG, NULL, NULL, 0);//INTERNET_FLAG_ASYNC);
        if (iopen)
        {
            iopenurl = InternetOpenUrl(iopen, token, NULL, 0, INTERNET_FLAG_RELOAD, 0);
            if (iopenurl)
            {
                // unsigned int size = 0;
                // InternetQueryDataAvailable(iopenurl, (LPDWORD)&size, 0, 0);
 
                char buffer[1024];
                DWORD bytesRead = 0, retLength = 0;
 
                // Create the file if we haven't done so already...
                if (!file) file = CreateFile(path, GENERIC_WRITE, FILE_SHARE_READ, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
 
                if (file)
                {
                    // Download data in chunks of 1024 bytes...
                    while (InternetReadFile(iopenurl, (LPVOID)buffer, 1024, &bytesRead))
                    {
                        if (bytesRead == 0) break;
 
                        // Stop downloading if the file seems to be 404...
//                      if (strstr(buffer, "<title>404 Not Found</title>")) break;
 
                        WriteFile(file, buffer, bytesRead, &retLength, NULL);
                    }
 
                    InternetCloseHandle(iopenurl);
                    InternetCloseHandle(iopen);
                }
                else
                {
                    status = false;
                    InternetCloseHandle(iopenurl);
                    InternetCloseHandle(iopen);
                }
            }
            else
            {
                status = false;
                InternetCloseHandle(iopen);
            }
        }
    }
 
    //====================
 
    // Close the file...
    if (file) CloseHandle(file);
 
    return status;
}

FileOpen()

DLL_EXPORT FILE * FileOpen

(

LPCSTR

fileName

)

{
    FILE *file = NULL;
    if (FileExists(szPath)) file = fopen(szPath, "r");
 
    return (file);
}

FileClose()

DLL_EXPORT bool FileClose

(

FILE *

filePointer

)

{
    if (fp)
    {
        if (fclose(fp)) return false;
        else return true;
    }
    else return false;
}

FileRead()

DLL_EXPORT bool FileRead	(	FILE *	filePointer,
		LPSTR	readString )

{
    int ch,                                     // Character read from file
        cnbr;                                   // Index into returned string
 
    cnbr = 0;                                   // Start at the beginning...
    memset(string, ' ', MAX_LINE_LENGTH);        // ...and prepare the entire line
 
    for (;;)
    {
        ch = fgetc(stream);                     // Get next character from the file...
 
        if (ch == '\t')                         // Jump if the character is a tab...
        {
            cnbr = ((cnbr >> 3) << 3) + 8;
        }
        // If the character is end of line, end of file, or MS-DOS Ctrl-Z...
        /*else*/ if ((ch == '\n') ||  (ch == EOF) ||  (ch == 26))
        {
            string[cnbr] = '\0';                // ...terminate the string...
            return(ch == '\n' || cnbr);         // ...and return true/false
        }
        else if (cnbr < MAX_LINE_LENGTH)
        {
            // ...otherwise add the character to the output string
            string[cnbr++] = (char) ch;
        }
 
        // Return in any case if line is too long, the line will be cut into pieces...
        if (cnbr >= MAX_LINE_LENGTH)
        {
            string[MAX_LINE_LENGTH] = '\0';
            return true;
        }
    }
}

GetParentFolder()

int GetParentFolder

(

LPSTR

path

)

{
    int nLen = strlen(path) - 1;
    if (path[nLen] == '\\') nLen--; // Looking for the parent folder of a folder?
 
    // Extract the parent folder from the specified path...
    while (nLen > 0 && path[nLen] != '\\') nLen--;
    path[nLen+1] = 0;
 
    return nLen+1; // Return the position of the file name following the folder path...
}

ReadValue()

DLL_EXPORT LPSTR ReadValue	(	LPCSTR	fp,
		LPCSTR	keyword,
		LPLONG	ptr = NULL )

{
    FILE *f = FileOpen(fp);
    if (!f) return NULL;
 
    //====================
 
    // Move to starting position if specified...
    if (ptr && *ptr != 0) fseek(f, *ptr, SEEK_SET);
    else fseek(f, 0, SEEK_SET);
 
    //====================
 
    LONG fpos = 0;
    char* currentLine;
 
    while (FileRead(f, lineFromFile))
    {
        lineFromFile[MAX_LINE_LENGTH-1] = '\0'; // Failsafe
 
        currentLine = lineFromFile;
        currentLine += strspn(currentLine, " \t\r\n");
 
        // Is the current line a comment line?
        if (*currentLine == '#' || *currentLine == '!')
        {
            fpos = ftell(f);
            continue;
        }
        // If not, look for the keyword a the beginning of the string...
        else if (!_strnicmp(currentLine, keyword, strlen(keyword)))
        {
            // We're only interested in the string after the keyword...
            currentLine += strlen(keyword);
            // Remove any space characters, tabs or returns...
            currentLine += strspn(currentLine, " \t\r\n");
            // Remove any trailing space characters...
            int nLen = strlen(currentLine) - 1;
            while (nLen >0 && currentLine[nLen] == ' ') nLen--;
            currentLine[nLen+1] = 0;
 
            if (ptr) *ptr = fpos;
            FileClose(f);
 
            return (char*)currentLine;
        }
 
        fpos = ftell(f);
    }
 
    //====================
 
    FileClose(f);
 
    return NULL;
}

ReadBool()

DLL_EXPORT bool ReadBool	(	LPCSTR	filePointer,
		LPCSTR	string,
		bool	defaultBool )

{
/*
    // NULL/empty filepointers are not supported for ReadBool,
    // but since it is the only Read* function that does not
    // support them I have added a safeguard here to prevent
    // a borked plugin from crashing the core... <g>
    if(!fp || ! _stricmp(fp, "")) return szDefault;
 
    LPSTR buffer = ReadValue(fp, szString);
    if (buffer)
    {
        if (! _stricmp(buffer, "true")) return true;
        else if (! _stricmp(buffer, "false")) return false;
        else return szDefault;
    }
 
    return szDefault;
*/
    return pSettings->GetBool(fp, NULL, szString, szDefault);
}

ReadInt()

DLL_EXPORT int ReadInt	(	LPCSTR	filePointer,
		LPCSTR	string,
		int	defaultInt )

{
    return pSettings->GetInt(fp, NULL, szString, szDefault);
}

ReadString()

DLL_EXPORT LPSTR ReadString	(	LPCSTR	filePointer,
		LPCSTR	string,
		LPSTR	defaultString )

{
    return pSettings->GetString(fp, NULL, szString, szDefault);
}

ReadColor()

DLL_EXPORT COLORREF ReadColor	(	LPCSTR	filePointer,
		LPCSTR	string,
		LPCSTR	defaultString )

{
    return pSettings->GetColor(fp, NULL, szString, szDefault, NULL, false);
}

ReadNextCommand()

DLL_EXPORT bool ReadNextCommand	(	FILE *	filePointer,
		LPSTR	readLine,
		DWORD	lineLength )

{
    if (!f) return false;
 
    while (FileRead(f, szTempBuffer))
    {
        while (isspace(*szTempBuffer) && *szTempBuffer) memmove(szTempBuffer, szTempBuffer+1, strlen(szTempBuffer)); // Clean out initial spaces...
 
        if (szTempBuffer[0] && szTempBuffer[0] != '#' && szTempBuffer != 0 && szTempBuffer[0] != '!') // Check for comment lines...
        {
            strncpy(szBuffer, szTempBuffer, dwLength);
            return true;
        }
 
        if (!strcmp(szTempBuffer, "[end]")) strncpy(szBuffer, szTempBuffer, dwLength);
    }
 
    return false;
}

WriteValue()

void WriteValue	(	LPCSTR	fp,
		LPCSTR	keyword,
		LPCSTR	value )

{
    if (pSettings)
    {
        if (pSettings->writeProtection) return;
    }
 
    vector <string> fileContents;
    char fileLine[MAX_LINE_LENGTH];
    int pointer;
    bool written = false;
 
    FILE *file = fopen(fp, "r");
    if (file)
    {
        fseek(file, 0, SEEK_SET);
        while (fgets(fileLine, sizeof(fileLine)-2, file))
        {
            if (!IsInString(fileLine, "\n")) strcat(fileLine, "\n");
            fileLine[sizeof(fileLine)-1] = '\0'; // Additional failsafe
 
            // Check for the specified keyword, disregarding lines beginning with ! (comments)
            if (IsInString(fileLine, keyword) && fileLine[0] != '!')
            {
                sprintf(fileLine, "%s %s\n", keyword, value);
                written = true;
            }
 
            fileContents.push_back(fileLine);
        }
        fclose(file);
    }
 
    if (!written)
    {
        sprintf(fileLine, "%s %s\n", keyword, value);
        fileContents.push_back(fileLine);
    }
 
    file = fopen(fp, "w");
    if (file)
    {
        fseek(file, 0, SEEK_SET);
        for (pointer = 0; pointer < (int)fileContents.size(); pointer++)
        {
            fputs(fileContents[pointer].c_str(), file);
        }
        fclose(file);
    }
}

WriteBool()

DLL_EXPORT void WriteBool	(	LPCSTR	filePointer,
		LPCSTR	keyword,
		bool	value )

{
    if (pSettings->writeProtection) return;
 
    char tmp[50];
    if (value) strcpy(tmp, "true");
    else strcpy(tmp, "false");
 
    WriteValue(fp, keyword, tmp);
}

WriteInt()

DLL_EXPORT void WriteInt	(	LPCSTR	filePointer,
		LPCSTR	keyword,
		int	value )

{
    if (pSettings->writeProtection) return;
 
    char tmp[50];
    sprintf(tmp, "%d", value);
 
    WriteValue(fp, keyword, tmp);
}

WriteString()

DLL_EXPORT void WriteString	(	LPCSTR	filePointer,
		LPCSTR	keyword,
		LPSTR	value )

{
    if (pSettings->writeProtection) return;
 
    WriteValue(fp, keyword, value);
}

WriteColor()

DLL_EXPORT void WriteColor	(	LPCSTR	filePointer,
		LPCSTR	keyword,
		COLORREF	value )

{
    if (pSettings->writeProtection) return;
 
    char tmp[MAX_LINE_LENGTH];
    sprintf(tmp, "#%02x%02x%02x", GetRValue(value), GetGValue(value), GetBValue(value));
 
    WriteValue(fp, keyword, tmp);
}

GetSettingPtr()

DLL_EXPORT void * GetSettingPtr

(

int

index

)

{
    switch (index)
    {
        case SN_TOOLBAR               : return (void*) pSettings->Toolbar;
        case SN_TOOLBARBUTTON       : return (void*) pSettings->ToolbarButton;
        case SN_TOOLBARBUTTONP     : return (void*) pSettings->ToolbarButtonPressed;
        case SN_TOOLBARLABEL     : return (void*) pSettings->ToolbarLabel;
        case SN_TOOLBARWINDOWLABEL : return (void*) pSettings->ToolbarWindowLabel;
        case SN_TOOLBARCLOCK     : return (void*) pSettings->ToolbarClock;
        case SN_MENUTITLE           : return (void*) pSettings->MenuTitle;
        case SN_MENUFRAME           : return (void*) pSettings->MenuFrame;
        case SN_MENUHILITE         : return (void*) pSettings->MenuActive;
 
        case SN_BORDERWIDTH           : return (void*) &pSettings->borderWidth;
        case SN_BORDERCOLOR           : return (void*) &pSettings->borderColor;
        case SN_BEVELWIDTH         : return (void*) &pSettings->bevelWidth;
 
        case SN_METRICSUNIX           : return (void*) false;
        case SN_BULLETUNIX         : return (void*) false;
        case SN_ROOTCOMMAND           : return (void*) &pSettings->rootCommand;
 
        case SN_MENUBULLET         : return (void*) &pSettings->menuBullet;
        case SN_MENUBULLETPOS       : return (void*) &pSettings->menuBulletPosition;
        case SN_FRAMEWIDTH         : return (void*) &pSettings->frameWidth;
        case SN_HANDLEWIDTH           : return (void*) &pSettings->handleHeight; // Note: Same index as SN_HANDLEHEIGHT
 
        case SN_MENUALPHA           : return (void*) &pSettings->menuTransparencyAlpha;
        case SN_TOOLBARALPHA     : return (void*) &pSettings->toolbarTransparencyAlpha;
 
        case SN_WINFOCUS_TITLE     : return (void*) pSettings->WindowTitleFocus;
        case SN_WINFOCUS_LABEL     : return (void*) pSettings->WindowLabelFocus;
        case SN_WINFOCUS_HANDLE       : return (void*) pSettings->WindowHandleFocus;
        case SN_WINFOCUS_GRIP       : return (void*) pSettings->WindowGripFocus;
        case SN_WINFOCUS_BUTTON       : return (void*) pSettings->WindowButtonFocus;
        case SN_WINFOCUS_BUTTONP : return (void*) pSettings->WindowButtonPressed;
 
        case SN_WINUNFOCUS_TITLE : return (void*) pSettings->WindowTitleUnfocus;
        case SN_WINUNFOCUS_LABEL : return (void*) pSettings->WindowLabelUnfocus;
        case SN_WINUNFOCUS_HANDLE   : return (void*) pSettings->WindowHandleUnfocus;
        case SN_WINUNFOCUS_GRIP       : return (void*) pSettings->WindowGripUnfocus;
        case SN_WINUNFOCUS_BUTTON   : return (void*) pSettings->WindowButtonUnfocus;
/*
        case SN_WINFOCUS_FRAME_COLOR    : return (void*) &pSettings->borderColor;
        case SN_WINUNFOCUS_FRAME_COLOR  : return (void*) &pSettings->borderColor;
*/
        case SN_NEWMETRICS         : return (void*) false;
 
        case SN_ISSTYLE070         : return (void*) true;                              // ...OK?
        case SN_SLIT             : return (void*) pSettings->Dock;
 
        case SN_MENUSEPMARGIN       : return (void*) 1;                                 // PLACEHOLDER (for basic API compatibility only)
        case SN_MENUSEPCOLOR     : return (void*) &pSettings->MenuSeparator->Color;
        case SN_MENUSEPSHADOWCOLOR : return (void*) &pSettings->MenuSeparator->Color; // PLACEHOLDER (for basic API compatibility only)
        case SN_MENUGRIP         : return (void*) pSettings->MenuGrip;
    }
 
    return NULL;
}

ParseItem()

DLL_EXPORT void ParseItem	(	LPCSTR	szItem,
		StyleItem *	item )

{
    // Default settings
    item->type = B_SOLID;
    item->bevelstyle = BEVEL_FLAT;
    item->bevelposition = BEVEL1;
    item->parentRelative = false;
    item->interlaced = false;
 
    if (strchr(szItem, '\\') || IsInString(szItem, "image")) // -> Simple (path in .appearance), or more advanced (path in .image, plus related options specified in .appearance)
    {
        item->type = B_IMAGEFROMFILE;
        return;
    }
 
    if (IsInString(szItem, "solid")) item->type = B_SOLID;
    else if (IsInString(szItem, "vertical")) item->type = B_VERTICAL;
    else if (IsInString(szItem, "horizontal")) item->type = B_HORIZONTAL;
    else if (IsInString(szItem, "crossdiagonal")) item->type = B_CROSSDIAGONAL; // Must be checked before diagonal!
    else if (IsInString(szItem, "diagonal")) item->type = B_DIAGONAL;
    else if (IsInString(szItem, "pipecross")) item->type = B_PIPECROSS;
    else if (IsInString(szItem, "elliptic")) item->type = B_ELLIPTIC;
    else if (IsInString(szItem, "rectangle")) item->type = B_RECTANGLE;
    else if (IsInString(szItem, "pyramid")) item->type = B_PYRAMID;
 
    if (IsInString(szItem, "split")) item->type += 100; // 4-colour "split" gradients (i.e. SplitHorizontal/SplitVertical)
    else if (IsInString(szItem, "super")) item->type += 150; // 8-colour "super" gradients (i.e. SuperHorizontal/SuperVertical)
    else if (IsInString(szItem, "mirror")) item->type += 200; // 2-colour "mirrored" gradients (i.e. MirrorHorizontal/MirrorVertical)
 
    if (IsInString(szItem, "flat")) item->bevelstyle=BEVEL_FLAT;
    else if (IsInString(szItem, "raised")) item->bevelstyle=BEVEL_RAISED; 
    else if (IsInString(szItem, "sunken")) item->bevelstyle=BEVEL_SUNKEN;
 
    if (IsInString(szItem, "bevel2")) item->bevelposition=BEVEL2;
    else if (IsInString(szItem, "bevel1")) item->bevelposition=BEVEL1;
 
    if (IsInString(szItem, "interlaced")) item->interlaced = true;
 
    if (IsInString(szItem, "parentrelative"))
    {
        item->type = B_PARENTRELATIVE;
        item->parentRelative = true;
    }
}

StrRemoveEncap()

DLL_EXPORT LPSTR StrRemoveEncap

(

LPSTR

string

)

{
    int nLen = strlen(string);
    nLen--;
    memmove(string, string+1, nLen-1);
    *(string+nLen-1) = '\0';
    return string;
}

ReplaceEnvVars()

DLL_EXPORT void ReplaceEnvVars

(

LPSTR

string

)

{
    LPSTR pos0 = string, pos1 = strchr(pos0+1,'%');
    if (pos1 == NULL) return; // Failsafe (only a single % character found in the string)
 
    while ((pos0 = strchr(pos0,'%')) && (pos1 = strchr(++pos0,'%')))
    {
        if (pos0 == pos1) continue; // ...this means that we have "%%"
 
        char var_name[MAX_LINE_LENGTH]="", var_value[MAX_LINE_LENGTH]="";
        memcpy(var_name,pos0,pos1-pos0);
 
        // Grab the variable name(s) from the string...
        int nSize = GetEnvironmentVariable(var_name, var_value, MAX_LINE_LENGTH);
        if (GetLastError() == ERROR_ENVVAR_NOT_FOUND)
        {
            SetLastError(ERROR_SUCCESS);
            continue;
        }
 
        if ((nSize + strlen(string) + 1 - (pos1-pos0+2)) > MAX_LINE_LENGTH)
        {
            //TODO signal some sort of error
            continue;
        }
 
        // Perform the substitution...
        memmove(pos0-1+nSize,pos1+1,strlen(pos1)+1); // Don't forget the \0 !!!
        memcpy(pos0-1,var_value,nSize);
    }
}

ReplaceShellFolders()

DLL_EXPORT void ReplaceShellFolders

(

LPSTR

string

)

{
    LPSTR pos0 = string, pos1 = strchr(pos0+1,'$');
    if (pos1 == NULL) return; // Failsafe (only a single $ character found in the string)
 
    char folderpath[MAX_LINE_LENGTH];
 
    while ((pos0 = strchr(pos0,'$')) && (pos1 = strchr(pos0+1,'$')))
    {
        if(pos0 == pos1) continue; // ...this means that we have "$$"
 
        // Note that there can be more than one shell folder
        // variable in a string, check current position only!
        if (!_strnicmp(pos0, "$ProgramFiles$", 14)) strcpy(folderpath, pSettings->SF_programFiles);
        else if (!_strnicmp(pos0, "$Blackbox$", 10)) strcpy(folderpath, pSettings->SF_blackboxPath);
        else if (!_strnicmp(pos0, "$CurrentTheme$", 14)) strcpy(folderpath, pSettings->SF_currentThemePath);
        else if (!_strnicmp(pos0, "$StartMenu$", 11)) strcpy(folderpath, pSettings->SF_startMenu);
        else if (!_strnicmp(pos0, "$CommonStartMenu$", 17)) strcpy(folderpath, pSettings->SF_commonStartMenu);
        else if (!_strnicmp(pos0, "$Desktop$", 9)) strcpy(folderpath, pSettings->SF_desktop);
        else if (!_strnicmp(pos0, "$UserAppData$", 13)) strcpy(folderpath, pSettings->SF_userAppData);
        else if (!_strnicmp(pos0, "$UserProfile$", 13)) strcpy(folderpath, pSettings->SF_userProfile);
        else if (!_strnicmp(pos0, "$Clipboard$", 11)) RetrieveStringFromClipboard(folderpath);
        else folderpath[0] = '\0'; // Failsafe
 
        memmove(pos0+strlen(folderpath), pos1+1, strlen(pos1)+1); // Don't forget the \0 !!!
        memcpy(pos0, folderpath, strlen(folderpath));
    }   
}

ParseFontString()

DLL_EXPORT void ParseFontString	(	LPSTR	string,
		StyleItem *	item )

{
    char height[MAX_LINE_LENGTH];
    strcpy(tempBuf, string);
 
    strcpy(tempBuf, Tokenize(tempBuf, item->Font, "/"));
    CheckFontSubstitution(item->Font);
 
    if (strlen(tempBuf))
    {
        strcpy(tempBuf, Tokenize(tempBuf, height, "/"));
        item->FontHeight = atoi(height);
 
        if (IsInString(tempBuf, "Bold")) item->FontWeight = FW_BOLD;
        else item->FontWeight = FW_NORMAL;
 
        if (IsInString(tempBuf, "Outline")) item->FontOutline = true;
        else item->FontOutline = false;
 
        if (IsInString(tempBuf, "Shadow")) item->FontShadow = true;
        else item->FontShadow = false;
    }
    else
    {
        item->FontHeight = 12;
        item->FontWeight = FW_NORMAL;
        item->FontOutline = item->FontShadow = false;
    }
}

CheckFontSubstitution()

DLL_EXPORT void CheckFontSubstitution

(

LPSTR

font

)

{
    // We can save a few IsInString's by checking for "-" in the font name...
    if (strchr(font, '-'))
    {
        if (IsInString(font, "lucidasans-")) strcpy(font, "verdana");
        else if (IsInString(font, "-lucidatypewriter-")) strcpy(font, "verdana");
        else if (IsInString(font, "-lucida-")) strcpy(font, "verdana");
        else if (IsInString(font, "-snap-")) strcpy(font, "snap");
        else if (IsInString(font, "-verdana-")) strcpy(font, "verdana");
        else if (IsInString(font, "-helvetica-")) strcpy(font, "verdana");
        else if (IsInString(font, "-arial-")) strcpy(font, "arial");
    }
    else
    {
        if (IsInString(font, "lucidatypewriter")) strcpy(font, "verdana");
        else if (IsInString(font, "helvetica")) strcpy(font, "verdana");
        else if (IsInString(font, "fixed")) strcpy(font, "terminal");
    }
 
    // No idea what to substitute with:
    // shine -beatbox- bright outcast -clean- seeds
}

ParseLiteralColor()

COLORREF ParseLiteralColor

(

LPCSTR

colour

)

{
    int i = strchr(colour, ' ') - colour;
    while (i > 0)
    {
        memmove ( (VOID*) (colour + i), (VOID*) (colour + i + 1), strlen (colour) - i );
        i = strchr(colour, ' ') - colour;
    }
 
    //====================
 
    if (!_strnicmp(colour, "gray", 4) || !_strnicmp(colour, "grey", 4))
    {
        i = strlen(colour);
        if (i > 5)
        {
            float tmp = (float)(2.55 * atoi(colour+4));
            i = (int)(tmp + .5);
            if (i < (int)tmp) i = (int)tmp;
            return RGB(i,i,i);
        }
        else return RGB(80,80,80);
    }
 
    char firstCharacter = colour[0];
 
    //====================
 
    switch (colour[0])
    {
        case 'a': //====================
        {
            if (! _stricmp(colour, "aliceblue")) return RGB(240,248,255);
            else if (! _stricmp(colour, "antiquewhite")) return RGB(250,235,215);
            else if (! _stricmp(colour, "aquamarine")) return RGB(127,255,212);
            else if (! _stricmp(colour, "azure")) return RGB(240,255,255);
/*
            else if (! _stricmp(colour, "antiquewhite1")) return RGB(255,239,219);
            else if (! _stricmp(colour, "antiquewhite2")) return RGB(238,223,204);
            else if (! _stricmp(colour, "antiquewhite3")) return RGB(205,192,176);
            else if (! _stricmp(colour, "antiquewhite4")) return RGB(139,131,120);
            else if (! _stricmp(colour, "aquamarine1")) return RGB(127,255,212);
            else if (! _stricmp(colour, "aquamarine2")) return RGB(118,238,198);
            else if (! _stricmp(colour, "aquamarine3")) return RGB(102,205,170);
            else if (! _stricmp(colour, "aquamarine4")) return RGB(69,139,116);
            else if (! _stricmp(colour, "azure1")) return RGB(240,255,255);
            else if (! _stricmp(colour, "azure2")) return RGB(224,238,238);
            else if (! _stricmp(colour, "azure3")) return RGB(193,205,205);
            else if (! _stricmp(colour, "azure4")) return RGB(131,139,139);
*/
        }
        case 'b': //====================
        {
            if (! _stricmp(colour, "beige")) return RGB(245,245,220);
            else if (! _stricmp(colour, "bisque")) return RGB(255,228,196);
            else if (! _stricmp(colour, "black")) return RGB(0,0,0);
            else if (! _stricmp(colour, "blanchedalmond")) return RGB(255,235,205);
            else if (! _stricmp(colour, "blue")) return RGB(0,0,255);
            else if (! _stricmp(colour, "blueviolet")) return RGB(138,43,226);
            else if (! _stricmp(colour, "brown")) return RGB(165,42,42);
            else if (! _stricmp(colour, "burlywood")) return RGB(222,184,135);
/*
            else if (! _stricmp(colour, "bisque1")) return RGB(255,228,196);
            else if (! _stricmp(colour, "bisque2")) return RGB(238,213,183);
            else if (! _stricmp(colour, "bisque3")) return RGB(205,183,158);
            else if (! _stricmp(colour, "bisque4")) return RGB(139,125,107);
            else if (! _stricmp(colour, "blue1")) return RGB(0,0,255);
            else if (! _stricmp(colour, "blue2")) return RGB(0,0,238);
            else if (! _stricmp(colour, "blue3")) return RGB(0,0,205);
            else if (! _stricmp(colour, "blue4")) return RGB(0,0,139);
            else if (! _stricmp(colour, "brown1")) return RGB(255,64,64);
            else if (! _stricmp(colour, "brown2")) return RGB(238,59,59);
            else if (! _stricmp(colour, "brown3")) return RGB(205,51,51);
            else if (! _stricmp(colour, "brown4")) return RGB(139,35,35);
            else if (! _stricmp(colour, "burlywood1")) return RGB(255,211,155);
            else if (! _stricmp(colour, "burlywood2")) return RGB(238,197,145);
            else if (! _stricmp(colour, "burlywood3")) return RGB(205,170,125);
            else if (! _stricmp(colour, "burlywood4")) return RGB(139,115,85);
*/
        }
        case 'c': //====================
        {
            if (! _stricmp(colour, "cadetblue")) return RGB(95,158,160);
            else if (! _stricmp(colour, "chartreuse")) return RGB(127,255,0);
            else if (! _stricmp(colour, "chocolate")) return RGB(210,105,30);
            else if (! _stricmp(colour, "coral")) return RGB(255,127,80);
            else if (! _stricmp(colour, "cornflowerblue")) return RGB(100,149,237);
            else if (! _stricmp(colour, "cornsilk")) return RGB(255,248,220);
            else if (! _stricmp(colour, "cyan")) return RGB(0,255,255);
/*
            else if (! _stricmp(colour, "cadetblue1")) return RGB(152,245,255);
            else if (! _stricmp(colour, "cadetblue2")) return RGB(142,229,238);
            else if (! _stricmp(colour, "cadetblue3")) return RGB(122,197,205);
            else if (! _stricmp(colour, "cadetblue4")) return RGB(83,134,139);
            else if (! _stricmp(colour, "chartreuse1")) return RGB(127,255,0);
            else if (! _stricmp(colour, "chartreuse2")) return RGB(118,238,0);
            else if (! _stricmp(colour, "chartreuse3")) return RGB(102,205,0);
            else if (! _stricmp(colour, "chartreuse4")) return RGB(69,139,0);
            else if (! _stricmp(colour, "chocolate1")) return RGB(255,127,36);
            else if (! _stricmp(colour, "chocolate2")) return RGB(238,118,33);
            else if (! _stricmp(colour, "chocolate3")) return RGB(205,102,29);
            else if (! _stricmp(colour, "chocolate4")) return RGB(139,69,19);
            else if (! _stricmp(colour, "coral1")) return RGB(255,114,86);
            else if (! _stricmp(colour, "coral2")) return RGB(238,106,80);
            else if (! _stricmp(colour, "coral3")) return RGB(205,91,69);
            else if (! _stricmp(colour, "coral4")) return RGB(139,62,47);
            else if (! _stricmp(colour, "cornsilk1")) return RGB(255,248,220);
            else if (! _stricmp(colour, "cornsilk2")) return RGB(238,232,205);
            else if (! _stricmp(colour, "cornsilk3")) return RGB(205,200,177);
            else if (! _stricmp(colour, "cornsilk4")) return RGB(139,136,120);
            else if (! _stricmp(colour, "cyan1")) return RGB(0,255,255);
            else if (! _stricmp(colour, "cyan2")) return RGB(0,238,238);
            else if (! _stricmp(colour, "cyan3")) return RGB(0,205,205);
            else if (! _stricmp(colour, "cyan4")) return RGB(0,139,139);
*/
        }
        case 'd': //====================
        {
            if (! _stricmp(colour, "darkblue")) return RGB(0,0,139);
            else if (! _stricmp(colour, "darkcyan")) return RGB(0,139,139);
            else if (! _stricmp(colour, "darkgoldenrod")) return RGB(184,134,11);
            else if (! _stricmp(colour, "darkgray")) return RGB(169,169,169);
            else if (! _stricmp(colour, "darkgreen")) return RGB(0,100,0);
            else if (! _stricmp(colour, "darkgrey")) return RGB(169,169,169);
            else if (! _stricmp(colour, "darkkhaki")) return RGB(189,183,107);
            else if (! _stricmp(colour, "darkmagenta")) return RGB(139,0,139);
            else if (! _stricmp(colour, "darkolivegreen")) return RGB(85,107,47);
            else if (! _stricmp(colour, "darkorange")) return RGB(255,140,0);
            else if (! _stricmp(colour, "darkorchid")) return RGB(153,50,204);
            else if (! _stricmp(colour, "darkred")) return RGB(139,0,0);
            else if (! _stricmp(colour, "darksalmon")) return RGB(233,150,122);
            else if (! _stricmp(colour, "darkseagreen")) return RGB(143,188,143);
            else if (! _stricmp(colour, "darkslateblue")) return RGB(72,61,139);
            else if (! _stricmp(colour, "darkslategray")) return RGB(47,79,79);
            else if (! _stricmp(colour, "darkslategrey")) return RGB(47,79,79);
            else if (! _stricmp(colour, "darkturquoise")) return RGB(0,206,209);
            else if (! _stricmp(colour, "darkviolet")) return RGB(148,0,211);
            else if (! _stricmp(colour, "deeppink")) return RGB(255,20,147);
            else if (! _stricmp(colour, "deepskyblue")) return RGB(0,191,255);
            else if (! _stricmp(colour, "dimgray")) return RGB(105,105,105);
            else if (! _stricmp(colour, "dimgrey")) return RGB(105,105,105);
            else if (! _stricmp(colour, "dodgerblue")) return RGB(30,144,255);
/*
            else if (! _stricmp(colour, "darkgoldenrod1")) return RGB(255,185,15);
            else if (! _stricmp(colour, "darkgoldenrod2")) return RGB(238,173,14);
            else if (! _stricmp(colour, "darkgoldenrod3")) return RGB(205,149,12);
            else if (! _stricmp(colour, "darkgoldenrod4")) return RGB(139,101,8);
            else if (! _stricmp(colour, "darkolivegreen1")) return RGB(202,255,112);
            else if (! _stricmp(colour, "darkolivegreen2")) return RGB(188,238,104);
            else if (! _stricmp(colour, "darkolivegreen3")) return RGB(162,205,90);
            else if (! _stricmp(colour, "darkolivegreen4")) return RGB(110,139,61);
            else if (! _stricmp(colour, "darkorange1")) return RGB(255,127,0);
            else if (! _stricmp(colour, "darkorange2")) return RGB(238,118,0);
            else if (! _stricmp(colour, "darkorange3")) return RGB(205,102,0);
            else if (! _stricmp(colour, "darkorange4")) return RGB(139,69,0);
            else if (! _stricmp(colour, "darkorchid1")) return RGB(191,62,255);
            else if (! _stricmp(colour, "darkorchid2")) return RGB(178,58,238);
            else if (! _stricmp(colour, "darkorchid3")) return RGB(154,50,205);
            else if (! _stricmp(colour, "darkorchid4")) return RGB(104,34,139);
            else if (! _stricmp(colour, "darkseagreen1")) return RGB(193,255,193);
            else if (! _stricmp(colour, "darkseagreen2")) return RGB(180,238,180);
            else if (! _stricmp(colour, "darkseagreen3")) return RGB(155,205,155);
            else if (! _stricmp(colour, "darkseagreen4")) return RGB(105,139,105);
            else if (! _stricmp(colour, "deeppink1")) return RGB(255,20,147);
            else if (! _stricmp(colour, "deeppink2")) return RGB(238,18,137);
            else if (! _stricmp(colour, "deeppink3")) return RGB(205,16,118);
            else if (! _stricmp(colour, "deeppink4")) return RGB(139,10,80);
            else if (! _stricmp(colour, "deepskyblue1")) return RGB(0,191,255);
            else if (! _stricmp(colour, "deepskyblue2")) return RGB(0,178,238);
            else if (! _stricmp(colour, "deepskyblue3")) return RGB(0,154,205);
            else if (! _stricmp(colour, "deepskyblue4")) return RGB(0,104,139);
            else if (! _stricmp(colour, "darkslategray1")) return RGB(151,255,255);
            else if (! _stricmp(colour, "darkslategray2")) return RGB(141,238,238);
            else if (! _stricmp(colour, "darkslategray3")) return RGB(121,205,205);
            else if (! _stricmp(colour, "darkslategray4")) return RGB(82,139,139);
            else if (! _stricmp(colour, "dodgerblue1")) return RGB(30,144,255);
            else if (! _stricmp(colour, "dodgerblue2")) return RGB(28,134,238);
            else if (! _stricmp(colour, "dodgerblue3")) return RGB(24,116,205);
            else if (! _stricmp(colour, "dodgerblue4")) return RGB(16,78,139);
*/
        }
        case 'f': //====================
        {
            if (! _stricmp(colour, "firebrick")) return RGB(178,34,34);
            else if (! _stricmp(colour, "floralwhite")) return RGB(255,250,240);
            else if (! _stricmp(colour, "forestgreen")) return RGB(34,139,34);
/*
            else if (! _stricmp(colour, "firebrick1")) return RGB(255,48,48);
            else if (! _stricmp(colour, "firebrick2")) return RGB(238,44,44);
            else if (! _stricmp(colour, "firebrick3")) return RGB(205,38,38);
            else if (! _stricmp(colour, "firebrick4")) return RGB(139,26,26);
*/
        }
        case 'g': //====================
        {
            if (! _stricmp(colour, "gainsboro")) return RGB(220,220,220);
            else if (! _stricmp(colour, "ghostwhite")) return RGB(248,248,255);
            else if (! _stricmp(colour, "gold")) return RGB(255,215,0);
            else if (! _stricmp(colour, "goldenrod")) return RGB(218,165,32);
            else if (! _stricmp(colour, "gray")) return RGB(190,190,190);
            else if (! _stricmp(colour, "green")) return RGB(0,255,0);
            else if (! _stricmp(colour, "greenyellow")) return RGB(173,255,47);
            else if (! _stricmp(colour, "grey")) return RGB(190,190,190);
/*
            else if (! _stricmp(colour, "gold1")) return RGB(255,215,0);
            else if (! _stricmp(colour, "gold2")) return RGB(238,201,0);
            else if (! _stricmp(colour, "gold3")) return RGB(205,173,0);
            else if (! _stricmp(colour, "gold4")) return RGB(139,117,0);
            else if (! _stricmp(colour, "goldenrod1")) return RGB(255,193,37);
            else if (! _stricmp(colour, "goldenrod2")) return RGB(238,180,34);
            else if (! _stricmp(colour, "goldenrod3")) return RGB(205,155,29);
            else if (! _stricmp(colour, "goldenrod4")) return RGB(139,105,20);
            else if (! _stricmp(colour, "green1")) return RGB(0,255,0);
            else if (! _stricmp(colour, "green2")) return RGB(0,238,0);
            else if (! _stricmp(colour, "green3")) return RGB(0,205,0);
            else if (! _stricmp(colour, "green4")) return RGB(0,139,0);
*/
        }
        case 'h': //====================
        {
            if (! _stricmp(colour, "honeydew")) return RGB(240,255,240);
            else if (! _stricmp(colour, "hotpink")) return RGB(255,105,180);
/*
            else if (! _stricmp(colour, "honeydew1")) return RGB(240,255,240);
            else if (! _stricmp(colour, "honeydew2")) return RGB(224,238,224);
            else if (! _stricmp(colour, "honeydew3")) return RGB(193,205,193);
            else if (! _stricmp(colour, "honeydew4")) return RGB(131,139,131);
            else if (! _stricmp(colour, "hotpink1")) return RGB(255,110,180);
            else if (! _stricmp(colour, "hotpink2")) return RGB(238,106,167);
            else if (! _stricmp(colour, "hotpink3")) return RGB(205,96,144);
            else if (! _stricmp(colour, "hotpink4")) return RGB(139,58,98);
*/
        }
        case 'i': //====================
        {
            if (! _stricmp(colour, "indianred")) return RGB(205,92,92);
            else if (! _stricmp(colour, "ivory")) return RGB(255,255,240);
/*
            else if (! _stricmp(colour, "indianred1")) return RGB(255,106,106);
            else if (! _stricmp(colour, "indianred2")) return RGB(238,99,99);
            else if (! _stricmp(colour, "indianred3")) return RGB(205,85,85);
            else if (! _stricmp(colour, "indianred4")) return RGB(139,58,58);
            else if (! _stricmp(colour, "ivory1")) return RGB(255,255,240);
            else if (! _stricmp(colour, "ivory2")) return RGB(238,238,224);
            else if (! _stricmp(colour, "ivory3")) return RGB(205,205,193);
            else if (! _stricmp(colour, "ivory4")) return RGB(139,139,131);
*/
        }
        case 'k': //====================
        {
            if (! _stricmp(colour, "khaki")) return RGB(240,230,140);
/*
            else if (! _stricmp(colour, "khaki1")) return RGB(255,246,143);
            else if (! _stricmp(colour, "khaki2")) return RGB(238,230,133);
            else if (! _stricmp(colour, "khaki3")) return RGB(205,198,115);
            else if (! _stricmp(colour, "khaki4")) return RGB(139,134,78);
*/
        }
        case 'l': //====================
        {
            if (! _stricmp(colour, "lavender")) return RGB(230,230,250);
            else if (! _stricmp(colour, "lavenderblush")) return RGB(255,240,245);
            else if (! _stricmp(colour, "lawngreen")) return RGB(124,252,0);
            else if (! _stricmp(colour, "lemonchiffon")) return RGB(255,250,205);
            else if (! _stricmp(colour, "lightblue")) return RGB(173,216,230);
            else if (! _stricmp(colour, "lightcoral")) return RGB(240,128,128);
            else if (! _stricmp(colour, "lightcyan")) return RGB(224,255,255);
            else if (! _stricmp(colour, "lightgoldenrod")) return RGB(238,221,130);
            else if (! _stricmp(colour, "lightgoldenrodyellow")) return RGB(250,250,210);
            else if (! _stricmp(colour, "lightgray")) return RGB(211,211,211);
            else if (! _stricmp(colour, "lightgreen")) return RGB(144,238,144);
            else if (! _stricmp(colour, "lightgrey")) return RGB(211,211,211);
            else if (! _stricmp(colour, "lightpink")) return RGB(255,182,193);
            else if (! _stricmp(colour, "lightsalmon")) return RGB(255,160,122);
            else if (! _stricmp(colour, "lightseagreen")) return RGB(32,178,170);
            else if (! _stricmp(colour, "lightskyblue")) return RGB(135,206,250);
            else if (! _stricmp(colour, "lightslateblue")) return RGB(132,112,255);
            else if (! _stricmp(colour, "lightslategray")) return RGB(119,136,153);
            else if (! _stricmp(colour, "lightslategrey")) return RGB(119,136,153);
            else if (! _stricmp(colour, "lightsteelblue")) return RGB(176,196,222);
            else if (! _stricmp(colour, "lightyellow")) return RGB(255,255,224);
            else if (! _stricmp(colour, "limegreen")) return RGB(50,205,50);
            else if (! _stricmp(colour, "linen")) return RGB(250,240,230);
/*
            else if (! _stricmp(colour, "lavenderblush1")) return RGB(255,240,245);
            else if (! _stricmp(colour, "lavenderblush2")) return RGB(238,224,229);
            else if (! _stricmp(colour, "lavenderblush3")) return RGB(205,193,197);
            else if (! _stricmp(colour, "lavenderblush4")) return RGB(139,131,134);
            else if (! _stricmp(colour, "lemonchiffon1")) return RGB(255,250,205);
            else if (! _stricmp(colour, "lemonchiffon2")) return RGB(238,233,191);
            else if (! _stricmp(colour, "lemonchiffon3")) return RGB(205,201,165);
            else if (! _stricmp(colour, "lemonchiffon4")) return RGB(139,137,112);
            else if (! _stricmp(colour, "lightblue1")) return RGB(191,239,255);
            else if (! _stricmp(colour, "lightblue2")) return RGB(178,223,238);
            else if (! _stricmp(colour, "lightblue3")) return RGB(154,192,205);
            else if (! _stricmp(colour, "lightblue4")) return RGB(104,131,139);
            else if (! _stricmp(colour, "lightcyan1")) return RGB(224,255,255);
            else if (! _stricmp(colour, "lightcyan2")) return RGB(209,238,238);
            else if (! _stricmp(colour, "lightcyan3")) return RGB(180,205,205);
            else if (! _stricmp(colour, "lightcyan4")) return RGB(122,139,139);
            else if (! _stricmp(colour, "lightgoldenrod1")) return RGB(255,236,139);
            else if (! _stricmp(colour, "lightgoldenrod2")) return RGB(238,220,130);
            else if (! _stricmp(colour, "lightgoldenrod3")) return RGB(205,190,112);
            else if (! _stricmp(colour, "lightgoldenrod4")) return RGB(139,129,76);
            else if (! _stricmp(colour, "lightpink1")) return RGB(255,174,185);
            else if (! _stricmp(colour, "lightpink2")) return RGB(238,162,173);
            else if (! _stricmp(colour, "lightpink3")) return RGB(205,140,149);
            else if (! _stricmp(colour, "lightpink4")) return RGB(139,95,101);
            else if (! _stricmp(colour, "lightsalmon1")) return RGB(255,160,122);
            else if (! _stricmp(colour, "lightsalmon2")) return RGB(238,149,114);
            else if (! _stricmp(colour, "lightsalmon3")) return RGB(205,129,98);
            else if (! _stricmp(colour, "lightsalmon4")) return RGB(139,87,66);
            else if (! _stricmp(colour, "lightskyblue1")) return RGB(176,226,255);
            else if (! _stricmp(colour, "lightskyblue2")) return RGB(164,211,238);
            else if (! _stricmp(colour, "lightskyblue3")) return RGB(141,182,205);
            else if (! _stricmp(colour, "lightskyblue4")) return RGB(96,123,139);
            else if (! _stricmp(colour, "lightsteelblue1")) return RGB(202,225,255);
            else if (! _stricmp(colour, "lightsteelblue2")) return RGB(188,210,238);
            else if (! _stricmp(colour, "lightsteelblue3")) return RGB(162,181,205);
            else if (! _stricmp(colour, "lightsteelblue4")) return RGB(110,123,139);
            else if (! _stricmp(colour, "lightyellow1")) return RGB(255,255,224);
            else if (! _stricmp(colour, "lightyellow2")) return RGB(238,238,209);
            else if (! _stricmp(colour, "lightyellow3")) return RGB(205,205,180);
            else if (! _stricmp(colour, "lightyellow4")) return RGB(139,139,122);
*/
        }
        case 'm': //====================
        {
            if (! _stricmp(colour, "magenta")) return RGB(255,0,255);
            else if (! _stricmp(colour, "maroon")) return RGB(176,48,96);
            else if (! _stricmp(colour, "mediumaquamarine")) return RGB(102,205,170);
            else if (! _stricmp(colour, "mediumblue")) return RGB(0,0,205);
            else if (! _stricmp(colour, "mediumorchid")) return RGB(186,85,211);
            else if (! _stricmp(colour, "mediumpurple")) return RGB(147,112,219);
            else if (! _stricmp(colour, "mediumseagreen")) return RGB(60,179,113);
            else if (! _stricmp(colour, "mediumslateblue")) return RGB(123,104,238);
            else if (! _stricmp(colour, "mediumspringgreen")) return RGB(0,250,154);
            else if (! _stricmp(colour, "mediumturquoise")) return RGB(72,209,204);
            else if (! _stricmp(colour, "mediumvioletred")) return RGB(199,21,133);
            else if (! _stricmp(colour, "midnightblue")) return RGB(25,25,112);
            else if (! _stricmp(colour, "mintcream")) return RGB(245,255,250);
            else if (! _stricmp(colour, "mistyrose")) return RGB(255,228,225);
            else if (! _stricmp(colour, "moccasin")) return RGB(255,228,181);
/*
            else if (! _stricmp(colour, "magenta1")) return RGB(255,0,255);
            else if (! _stricmp(colour, "magenta2")) return RGB(238,0,238);
            else if (! _stricmp(colour, "magenta3")) return RGB(205,0,205);
            else if (! _stricmp(colour, "magenta4")) return RGB(139,0,139);
            else if (! _stricmp(colour, "maroon1")) return RGB(255,52,179);
            else if (! _stricmp(colour, "maroon2")) return RGB(238,48,167);
            else if (! _stricmp(colour, "maroon3")) return RGB(205,41,144);
            else if (! _stricmp(colour, "maroon4")) return RGB(139,28,98);
            else if (! _stricmp(colour, "mediumorchid1")) return RGB(224,102,255);
            else if (! _stricmp(colour, "mediumorchid2")) return RGB(209,95,238);
            else if (! _stricmp(colour, "mediumorchid3")) return RGB(180,82,205);
            else if (! _stricmp(colour, "mediumorchid4")) return RGB(122,55,139);
            else if (! _stricmp(colour, "mediumpurple1")) return RGB(171,130,255);
            else if (! _stricmp(colour, "mediumpurple2")) return RGB(159,121,238);
            else if (! _stricmp(colour, "mediumpurple3")) return RGB(137,104,205);
            else if (! _stricmp(colour, "mediumpurple4")) return RGB(93,71,139);
            else if (! _stricmp(colour, "mistyrose1")) return RGB(255,228,225);
            else if (! _stricmp(colour, "mistyrose2")) return RGB(238,213,210);
            else if (! _stricmp(colour, "mistyrose3")) return RGB(205,183,181);
            else if (! _stricmp(colour, "mistyrose4")) return RGB(139,125,123);
*/
        }
        case 'n': //====================
        {
            if (! _stricmp(colour, "navajowhite")) return RGB(255,222,173);
            else if (! _stricmp(colour, "navy")) return RGB(0,0,128);
            else if (! _stricmp(colour, "navyblue")) return RGB(0,0,128);
/*
            else if (! _stricmp(colour, "navajowhite1")) return RGB(255,222,173);
            else if (! _stricmp(colour, "navajowhite2")) return RGB(238,207,161);
            else if (! _stricmp(colour, "navajowhite3")) return RGB(205,179,139);
            else if (! _stricmp(colour, "navajowhite4")) return RGB(139,121,94);
*/
        }
        case 'o': //====================
        {
            if (! _stricmp(colour, "oldlace")) return RGB(253,245,230);
            else if (! _stricmp(colour, "olivedrab")) return RGB(107,142,35);
            else if (! _stricmp(colour, "orange")) return RGB(255,165,0);
            else if (! _stricmp(colour, "orangered")) return RGB(255,69,0);
            else if (! _stricmp(colour, "orchid")) return RGB(218,112,214);
/*
            else if (! _stricmp(colour, "olivedrab1")) return RGB(192,255,62);
            else if (! _stricmp(colour, "olivedrab2")) return RGB(179,238,58);
            else if (! _stricmp(colour, "olivedrab3")) return RGB(154,205,50);
            else if (! _stricmp(colour, "olivedrab4")) return RGB(105,139,34);
            else if (! _stricmp(colour, "orange1")) return RGB(255,165,0);
            else if (! _stricmp(colour, "orange2")) return RGB(238,154,0);
            else if (! _stricmp(colour, "orange3")) return RGB(205,133,0);
            else if (! _stricmp(colour, "orange4")) return RGB(139,90,0);
            else if (! _stricmp(colour, "orangered1")) return RGB(255,69,0);
            else if (! _stricmp(colour, "orangered2")) return RGB(238,64,0);
            else if (! _stricmp(colour, "orangered3")) return RGB(205,55,0);
            else if (! _stricmp(colour, "orangered4")) return RGB(139,37,0);
            else if (! _stricmp(colour, "orchid1")) return RGB(255,131,250);
            else if (! _stricmp(colour, "orchid2")) return RGB(238,122,233);
            else if (! _stricmp(colour, "orchid3")) return RGB(205,105,201);
            else if (! _stricmp(colour, "orchid4")) return RGB(139,71,137);
*/
        }
        case 'p': //====================
        {
            if (! _stricmp(colour, "palegoldenrod")) return RGB(238,232,170);
            else if (! _stricmp(colour, "palegreen")) return RGB(152,251,152);
            else if (! _stricmp(colour, "paleturquoise")) return RGB(175,238,238);
            else if (! _stricmp(colour, "palevioletred")) return RGB(219,112,147);
            else if (! _stricmp(colour, "papayawhip")) return RGB(255,239,213);
            else if (! _stricmp(colour, "peachpuff")) return RGB(255,218,185);
            else if (! _stricmp(colour, "peru")) return RGB(205,133,63);
            else if (! _stricmp(colour, "pink")) return RGB(255,192,203);
            else if (! _stricmp(colour, "plum")) return RGB(221,160,221);
            else if (! _stricmp(colour, "powderblue")) return RGB(176,224,230);
            else if (! _stricmp(colour, "purple")) return RGB(160,32,240);
/*
            else if (! _stricmp(colour, "palegreen1")) return RGB(154,255,154);
            else if (! _stricmp(colour, "palegreen2")) return RGB(144,238,144);
            else if (! _stricmp(colour, "palegreen3")) return RGB(124,205,124);
            else if (! _stricmp(colour, "palegreen4")) return RGB(84,139,84);
            else if (! _stricmp(colour, "palevioletred1")) return RGB(255,130,171);
            else if (! _stricmp(colour, "palevioletred2")) return RGB(238,121,159);
            else if (! _stricmp(colour, "palevioletred3")) return RGB(205,104,137);
            else if (! _stricmp(colour, "palevioletred4")) return RGB(139,71,93);
            else if (! _stricmp(colour, "paleturquoise1")) return RGB(187,255,255);
            else if (! _stricmp(colour, "paleturquoise2")) return RGB(174,238,238);
            else if (! _stricmp(colour, "paleturquoise3")) return RGB(150,205,205);
            else if (! _stricmp(colour, "paleturquoise4")) return RGB(102,139,139);
            else if (! _stricmp(colour, "peachpuff1")) return RGB(255,218,185);
            else if (! _stricmp(colour, "peachpuff2")) return RGB(238,203,173);
            else if (! _stricmp(colour, "peachpuff3")) return RGB(205,175,149);
            else if (! _stricmp(colour, "peachpuff4")) return RGB(139,119,101);
            else if (! _stricmp(colour, "pink1")) return RGB(255,181,197);
            else if (! _stricmp(colour, "pink2")) return RGB(238,169,184);
            else if (! _stricmp(colour, "pink3")) return RGB(205,145,158);
            else if (! _stricmp(colour, "pink4")) return RGB(139,99,108);
            else if (! _stricmp(colour, "plum1")) return RGB(255,187,255);
            else if (! _stricmp(colour, "plum2")) return RGB(238,174,238);
            else if (! _stricmp(colour, "plum3")) return RGB(205,150,205);
            else if (! _stricmp(colour, "plum4")) return RGB(139,102,139);
            else if (! _stricmp(colour, "purple1")) return RGB(155,48,255);
            else if (! _stricmp(colour, "purple2")) return RGB(145,44,238);
            else if (! _stricmp(colour, "purple3")) return RGB(125,38,205);
            else if (! _stricmp(colour, "purple4")) return RGB(85,26,139);
*/
        }
        case 'r': //====================
        {
            if (! _stricmp(colour, "red")) return RGB(255,0,0);
            else if (! _stricmp(colour, "rosybrown")) return RGB(188,143,143);
            else if (! _stricmp(colour, "royalblue")) return RGB(65,105,225);
/*
            else if (! _stricmp(colour, "red1")) return RGB(255,0,0);
            else if (! _stricmp(colour, "red2")) return RGB(238,0,0);
            else if (! _stricmp(colour, "red3")) return RGB(205,0,0);
            else if (! _stricmp(colour, "red4")) return RGB(139,0,0);
            else if (! _stricmp(colour, "rosybrown1")) return RGB(255,193,193);
            else if (! _stricmp(colour, "rosybrown2")) return RGB(238,180,180);
            else if (! _stricmp(colour, "rosybrown3")) return RGB(205,155,155);
            else if (! _stricmp(colour, "rosybrown4")) return RGB(139,105,105);
            else if (! _stricmp(colour, "royalblue1")) return RGB(72,118,255);
            else if (! _stricmp(colour, "royalblue2")) return RGB(67,110,238);
            else if (! _stricmp(colour, "royalblue3")) return RGB(58,95,205);
            else if (! _stricmp(colour, "royalblue4")) return RGB(39,64,139);
*/
        }
        case 's': //====================
        {
            if (! _stricmp(colour, "saddlebrown")) return RGB(139,69,19);
            else if (! _stricmp(colour, "salmon")) return RGB(250,128,114);
            else if (! _stricmp(colour, "sandybrown")) return RGB(244,164,96);
            else if (! _stricmp(colour, "seagreen")) return RGB(46,139,87);
            else if (! _stricmp(colour, "seashell")) return RGB(255,245,238);
            else if (! _stricmp(colour, "sienna")) return RGB(160,82,45);
            else if (! _stricmp(colour, "skyblue")) return RGB(135,206,235);
            else if (! _stricmp(colour, "slateblue")) return RGB(106,90,205);
            else if (! _stricmp(colour, "slategray")) return RGB(112,128,144);
            else if (! _stricmp(colour, "slategrey")) return RGB(112,128,144);
            else if (! _stricmp(colour, "springgreen")) return RGB(0,255,127);
            else if (! _stricmp(colour, "steelblue")) return RGB(70,130,180);
/*
            else if (! _stricmp(colour, "salmon1")) return RGB(255,140,105);
            else if (! _stricmp(colour, "salmon2")) return RGB(238,130,98);
            else if (! _stricmp(colour, "salmon3")) return RGB(205,112,84);
            else if (! _stricmp(colour, "salmon4")) return RGB(139,76,57);
            else if (! _stricmp(colour, "seagreen1")) return RGB(84,255,159);
            else if (! _stricmp(colour, "seagreen2")) return RGB(78,238,148);
            else if (! _stricmp(colour, "seagreen3")) return RGB(67,205,128);
            else if (! _stricmp(colour, "seagreen4")) return RGB(46,139,87);
            else if (! _stricmp(colour, "seashell1")) return RGB(255,245,238);
            else if (! _stricmp(colour, "seashell2")) return RGB(238,229,222);
            else if (! _stricmp(colour, "seashell3")) return RGB(205,197,191);
            else if (! _stricmp(colour, "seashell4")) return RGB(139,134,130);
            else if (! _stricmp(colour, "sienna1")) return RGB(255,130,71);
            else if (! _stricmp(colour, "sienna2")) return RGB(238,121,66);
            else if (! _stricmp(colour, "sienna3")) return RGB(205,104,57);
            else if (! _stricmp(colour, "sienna4")) return RGB(139,71,38);
            else if (! _stricmp(colour, "skyblue1")) return RGB(135,206,255);
            else if (! _stricmp(colour, "skyblue2")) return RGB(126,192,238);
            else if (! _stricmp(colour, "skyblue3")) return RGB(108,166,205);
            else if (! _stricmp(colour, "skyblue4")) return RGB(74,112,139);
            else if (! _stricmp(colour, "slateblue1")) return RGB(131,111,255);
            else if (! _stricmp(colour, "slateblue2")) return RGB(122,103,238);
            else if (! _stricmp(colour, "slateblue3")) return RGB(105,89,205);
            else if (! _stricmp(colour, "slateblue4")) return RGB(71,60,139);
            else if (! _stricmp(colour, "slategray1")) return RGB(198,226,255);
            else if (! _stricmp(colour, "slategray2")) return RGB(185,211,238);
            else if (! _stricmp(colour, "slategray3")) return RGB(159,182,205);
            else if (! _stricmp(colour, "slategray4")) return RGB(108,123,139);
            else if (! _stricmp(colour, "snow1")) return RGB(255,250,250);
            else if (! _stricmp(colour, "snow2")) return RGB(238,233,233);
            else if (! _stricmp(colour, "snow3")) return RGB(205,201,201);
            else if (! _stricmp(colour, "snow4")) return RGB(139,137,137);
            else if (! _stricmp(colour, "springgreen1")) return RGB(0,255,127);
            else if (! _stricmp(colour, "springgreen2")) return RGB(0,238,118);
            else if (! _stricmp(colour, "springgreen3")) return RGB(0,205,102);
            else if (! _stricmp(colour, "springgreen4")) return RGB(0,139,69);
            else if (! _stricmp(colour, "steelblue1")) return RGB(99,184,255);
            else if (! _stricmp(colour, "steelblue2")) return RGB(92,172,238);
            else if (! _stricmp(colour, "steelblue3")) return RGB(79,148,205);
            else if (! _stricmp(colour, "steelblue4")) return RGB(54,100,139);
*/
        }
        case 't': //====================
        {
            if (! _stricmp(colour, "tan")) return RGB(210,180,140);
            else if (! _stricmp(colour, "thistle")) return RGB(216,191,216);
            else if (! _stricmp(colour, "tomato")) return RGB(255,99,71);
            else if (! _stricmp(colour, "turquoise")) return RGB(64,224,208);
/*
            else if (! _stricmp(colour, "tan1")) return RGB(255,165,79);
            else if (! _stricmp(colour, "tan2")) return RGB(238,154,73);
            else if (! _stricmp(colour, "tan3")) return RGB(205,133,63);
            else if (! _stricmp(colour, "tan4")) return RGB(139,90,43);
            else if (! _stricmp(colour, "thistle1")) return RGB(255,225,255);
            else if (! _stricmp(colour, "thistle2")) return RGB(238,210,238);
            else if (! _stricmp(colour, "thistle3")) return RGB(205,181,205);
            else if (! _stricmp(colour, "thistle4")) return RGB(139,123,139);
            else if (! _stricmp(colour, "tomato1")) return RGB(255,99,71);
            else if (! _stricmp(colour, "tomato2")) return RGB(238,92,66);
            else if (! _stricmp(colour, "tomato3")) return RGB(205,79,57);
            else if (! _stricmp(colour, "tomato4")) return RGB(139,54,38);
            else if (! _stricmp(colour, "turquoise1")) return RGB(0,245,255);
            else if (! _stricmp(colour, "turquoise2")) return RGB(0,229,238);
            else if (! _stricmp(colour, "turquoise3")) return RGB(0,197,205);
            else if (! _stricmp(colour, "turquoise4")) return RGB(0,134,139);
*/
        }
        case 'v': //====================
        {
            if (! _stricmp(colour, "violet")) return RGB(238,130,238);
            else if (! _stricmp(colour, "violetred")) return RGB(208,32,144);
/*
            else if (! _stricmp(colour, "violetred1")) return RGB(255,62,150);
            else if (! _stricmp(colour, "violetred2")) return RGB(238,58,140);
            else if (! _stricmp(colour, "violetred3")) return RGB(205,50,120);
            else if (! _stricmp(colour, "violetred4")) return RGB(139,34,82);
*/
        }
        case 'w': //====================
        {
            if (! _stricmp(colour, "wheat")) return RGB(245,222,179);
            else if (! _stricmp(colour, "white")) return RGB(255,255,255);
            else if (! _stricmp(colour, "whitesmoke")) return RGB(245,245,245);
/*
            else if (! _stricmp(colour, "wheat1")) return RGB(255,231,186);
            else if (! _stricmp(colour, "wheat2")) return RGB(238,216,174);
            else if (! _stricmp(colour, "wheat3")) return RGB(205,186,150);
            else if (! _stricmp(colour, "wheat4")) return RGB(139,126,102);
*/
        }
        case 'y': //====================
        {
            if (! _stricmp(colour, "yellow")) return RGB(255,255,0);
            else if (! _stricmp(colour, "yellowgreen")) return RGB(154,205,50);
/*
            else if (! _stricmp(colour, "yellow1")) return RGB(255,255,0);
            else if (! _stricmp(colour, "yellow2")) return RGB(238,238,0);
            else if (! _stricmp(colour, "yellow3")) return RGB(205,205,0);
            else if (! _stricmp(colour, "yellow4")) return RGB(139,139,0);
*/
        }
 
        //====================
 
        default:
            return 0x000000;
    }
}

ParseDropFiles()

int ParseDropFiles	(	HWND	hwnd,
		WPARAM	wParam )

{
    static TCHAR filename[MAX_LINE_LENGTH];
    DragQueryFile((HDROP)wParam, 0, filename, sizeof(filename));
 
    char path[MAX_LINE_LENGTH];
    strncpy(path, filename, MAX_LINE_LENGTH-1);
    if (path[0] == '\"') StrRemoveEncap(path);
 
    //====================
 
    if (pDesktop)
    {
        // Relay drag to desktop information to interrested plugins...
        if (hwnd == pDesktop->hDesktopWnd) SendMessage(GetBBWnd(), BB_DRAGTODESKTOP, 0, (LPARAM)path);
    }
 
    //====================
 
    // Make sure the dropped file isn't a directory...
    if (PathIsDirectory(filename))
    {
        DragFinish((HDROP)wParam);
        return 0;
    }
 
    //====================
 
    // We only need to check the last 4 characters to get the extension...
    int pointer = strlen(path) - 4;
 
    if (! _stricmp(&path[pointer], ".dll"))
    {
        // Load plugin...
        if (pPluginManager) pPluginManager->LoadPlugin(filename);
    }
    else if (! _stricmp(&path[pointer], ".jpg")
          || ! _stricmp(&path[pointer], ".png")
          || ! _stricmp(&path[pointer], ".bmp")
          || ! _stricmp(&path[pointer], "jpeg"))
    {
        // If the file is a JPG/JPEG, PNG or BMP we set it as wallpaper...
        if (GetAsyncKeyState(VK_CONTROL) & 0x8000) pWallpaper->SetWallpaper(path, "center");  // Is the control key held down? -> center mode
        else if (GetAsyncKeyState(VK_MENU) & 0x8000) pWallpaper->SetWallpaper(path, "tile");  // Is the alt key held down? -> tile mode
        else if (GetAsyncKeyState(VK_SHIFT) & 0x8000) pWallpaper->SetWallpaper(path, "span"); // Is the shift key held down? -> span mode
        else pWallpaper->SetWallpaper(path, "stretch");                                           // Default -> stretch/full mode
    }
    else
    {
        // Look for a line that should "always" exist in a style file...
        if (strlen(ReadString(filename, "menu.frame.", "")))
        {
            // Set new style...
            PostMessage(GetBBWnd(), BB_SETSTYLE, 0, (LPARAM)filename);
        }
    }
 
    //====================
 
    DragFinish((HDROP)wParam);
 
    return 0;
}

CopyStringToClipboard()

DLL_EXPORT bool CopyStringToClipboard

(

LPSTR

string

)

{
    HGLOBAL hGlobal = GlobalAlloc(GHND | GMEM_SHARE, strlen(string)+1) ;
    if (hGlobal == NULL) return false;
 
    char* pGlobal = (LPSTR)GlobalLock(hGlobal) ;
    if (pGlobal == NULL) return false;
 
    strcpy(pGlobal, string);
    GlobalUnlock (hGlobal);
 
    if (OpenClipboard(GetBBWnd()))
    {
        if (EmptyClipboard())
        {
            if (SetClipboardData(CF_TEXT, hGlobal) != NULL)
            {
                CloseClipboard();
                return true;
            }
        }
 
        CloseClipboard();
    }
 
    return false;
}

RetrieveStringFromClipboard()

DLL_EXPORT bool RetrieveStringFromClipboard

(

LPSTR

target

)

{
    HANDLE handle;
 
    if (IsClipboardFormatAvailable(CF_TEXT))
    {
        if (OpenClipboard(GetBBWnd()))
        {
            handle = GetClipboardData(CF_TEXT);
            if (handle != NULL)
            {
                strncpy(target, (char*)handle, MAX_LINE_LENGTH-1);
                CloseClipboard();
                return true;
            }
 
            CloseClipboard();
        }
    }
    
    strcpy(target, ""); // Failed or nothing was found on the clipboard...
 
    return false;
}

GetPositionEvolved()

DLL_EXPORT void GetPositionEvolved	(	LPSTR	placement,
		SIZE	size,
		POINT *	pt )

{
    Placement tempPlacement;
    tempPlacement.width = size.cx;
    tempPlacement.height = size.cy;
 
    pSettings->ParsePlacement(placement, &tempPlacement);
    pSettings->PositionFromPlacement(&tempPlacement);
 
    pt->x = tempPlacement.x;
    pt->y = tempPlacement.y;
}

FindStyleElement()

StyleItem * FindStyleElement

(

LPSTR

styleElement

)

{
    if (IsInString(styleElement, "toolbar"))
    {
        if (IsInString(styleElement, "windowLabel")) return pSettings->ToolbarWindowLabel;       // toolbar.windowLabel
        else if (IsInString(styleElement, "label")) return pSettings->ToolbarLabel;              // toolbar.label
        else if (IsInString(styleElement, "clock")) return pSettings->ToolbarClock;              // toolbar.clock
        else if (IsInString(styleElement, "pressed")) return pSettings->ToolbarButtonPressed;    // toolbar.button.pressed
        else if (IsInString(styleElement, "button")) return pSettings->ToolbarButton;            // toolbar.button
        else return pSettings->Toolbar;                                                            // toolbar (i.e. the background)
    }
    else if (IsInString(styleElement, "menu"))
    {
        if (IsInString(styleElement, "title")) return pSettings->MenuTitle;                      // menu.title
        else if (IsInString(styleElement, "hilite")) return pSettings->MenuActive;               // menu.hilite (i.e. legacy bb4nix syntax menu.active)
        else if (IsInString(styleElement, "active")) return pSettings->MenuActive;               // menu.active (i.e. bb4nix 0.70 syntax menu.hilite)
        else if (IsInString(styleElement, "grip")) return pSettings->MenuGrip;                   // menu.grip
        else return pSettings->MenuFrame;                                                      // menu.frame
    }
    else if (IsInString(styleElement, "dock")) return pSettings->Dock;                           // dock
    else if (IsInString(styleElement, "slit")) return pSettings->Dock;                           // + backwards compatibility with old "slit" syntax
    else if (IsInString(styleElement, "console")) return pSettings->Console;                 // console
    else if (IsInString(styleElement, "window"))
    {
        if (IsInString(styleElement, "title"))
        {
            if (IsInString(styleElement, "unfocus")) return pSettings->WindowTitleUnfocus; // window.title.unfocus
            else return pSettings->WindowTitleFocus; // window.title.focus
        }
        else if (IsInString(styleElement, "label"))
        {
            if (IsInString(styleElement, "unfocus")) return pSettings->WindowLabelUnfocus; // window.label.unfocus
            else return pSettings->WindowLabelFocus; // window.label.focus
        }
        else if (IsInString(styleElement, "button"))
        {
            if (IsInString(styleElement, "pressed")) return pSettings->WindowButtonPressed; // window.button.pressed
            else if (IsInString(styleElement, "unfocus")) return pSettings->WindowButtonUnfocus; // window.button.unfocus
            else return pSettings->WindowButtonFocus; //window.button.focus
        }
        else if (IsInString(styleElement, "grip"))
        {
            if (IsInString(styleElement, "unfocus")) return pSettings->WindowGripUnfocus; // window.grip.unfocus
            else return pSettings->WindowGripFocus; // window.grip.focus
        }
        else if (IsInString(styleElement, "handle"))
        {
            if (IsInString(styleElement, "unfocus")) return pSettings->WindowHandleUnfocus; // window.handle.unfocus
            else return pSettings->WindowHandleFocus; // window.handle.focus
        }
//      else if (IsInString(styleElement, "frame")) return pSettings->WindowFrame; // window.frame
    }
 
    return NULL;
}

MakeGradientEvolved()

DLL_EXPORT bool MakeGradientEvolved	(	HDC	hdc,
		RECT	rect,
		LPSTR	styleElement,
		bool	drawBevel,
		bool	drawBorder )

{
    StyleItem* element = FindStyleElement(styleElement);
 
    if (element != NULL) // -> Supported style element found!
    {
        if (!element->parentRelative)
        {
            // Make sure the requested gradient will actually fit within the target RECT; if not then deny the request...
            int borderSpace = element->borderWidth * 2;
            int availableSpace = rect.right - rect.left - 4;
            if ((borderSpace > availableSpace) || (availableSpace <= 0)) return false;
            availableSpace = rect.bottom - rect.top - 4;
            if ((borderSpace > availableSpace) || (availableSpace <= 0)) return false;
 
            // Let's draw the gradient... (including any *regular* border)
//          if ((element->type == B_IMAGEFROMFILE) && (element->Image.bitmap != NULL)) DrawImageIntoRect(hdc, rect, element, false, drawBorder);
            if ((element->type == B_IMAGEFROMFILE) && (element->Image.bitmap != NULL))
            {
/*
                if ((element == pSettings->Toolbar) ||
                    (element == pSettings->MenuTitle) || (element == pSettings->MenuFrame) || (element == pSettings->MenuGrip) ||
                    (element == pSettings->Dock) ||
                    (element == pSettings->WindowTitleFocus) || (element == pSettings->WindowTitleUnfocus) ||
                    (element == pSettings->WindowGripFocus) || (element == pSettings->WindowGripUnfocus) ||
                    (element == pSettings->WindowHandleFocus) || (element == pSettings->WindowHandleUnfocus))
                {
                    DrawImageIntoRect(hdc, rect, element, false, drawBorder);
                }
                else DrawImageIntoRect(hdc, rect, element, true, drawBorder); // -> Only allow ARGB image drawing for "non parent" elements (e.g. buttons)
*/
                if ((element == pSettings->ToolbarButton) || (element == pSettings->ToolbarButtonPressed) ||
                    (element == pSettings->WindowButtonFocus) || (element == pSettings->WindowButtonPressed) || (element == pSettings->WindowButtonUnfocus))
                {
                    DrawImageIntoRect(hdc, rect, element, true, drawBorder); // -> Only allow ARGB images drawing for button elements (assuming these are always drawn on top of a parent element)
                }
                else DrawImageIntoRect(hdc, rect, element, false, drawBorder);
            }
            else if (!drawBevel) MakeGradientSuper(hdc, rect, element->type, element->Color1, element->Color2, element->Color3, element->Color4, element->Color5, element->Color6, element->Color7, element->Color8, element->interlaced, BEVEL_FLAT, 0, 0, element->borderColor, drawBorder ? element->borderWidth : 0);
            else MakeGradientSuper(hdc, rect, element->type, element->Color1, element->Color2, element->Color3, element->Color4, element->Color5, element->Color6, element->Color7, element->Color8, element->interlaced, element->bevelstyle, element->bevelposition, pSettings->bevelWidth, element->borderColor, drawBorder ? element->borderWidth : 0);
 
            // Should we draw a *gradient* border around the gradient? (introduced in xoblite bb5 RC4)
            if (drawBorder)
            {
                StyleItem* elementBorder = NULL;
                if ((element == pSettings->Toolbar) && (pSettings->ToolbarBorder->type != B_PARENTRELATIVE)) elementBorder = pSettings->ToolbarBorder;
                else if ((element == pSettings->MenuFrame) && (pSettings->MenuFrameBorder->type != B_PARENTRELATIVE)) elementBorder = pSettings->MenuFrameBorder;
                else if ((element == pSettings->Dock) && (pSettings->DockBorder->type != B_PARENTRELATIVE)) elementBorder = pSettings->DockBorder;
 
                if (elementBorder != NULL) CreateBorderSuper(hdc, rect, elementBorder->type, elementBorder->Color1, elementBorder->Color2, elementBorder->Color3, elementBorder->Color4, elementBorder->Color5, elementBorder->Color6, elementBorder->Color7, elementBorder->Color8, element->borderWidth);
            }
 
            return true;
        }
        else return false; // Style element is parentRelative, nothing drawn...
    }
    else return false; // -> Unsupported style element, nothing drawn...
}

DrawTextEvolved()

DLL_EXPORT bool DrawTextEvolved	(	HDC	hdc,
		RECT *	rect,
		LPSTR	styleElement,
		LPWSTR	textUnicode,
		LPSTR	textANSI,
		unsigned int	fontHeightOverride,
		unsigned int	format,
		bool	getSize )

{
    StyleItem* element = FindStyleElement(styleElement);
 
    if (element != NULL) // -> Supported style element found!
    {
        unsigned int fontHeight;
        if (fontHeightOverride > 0) fontHeight = fontHeightOverride;
        else fontHeight = element->FontHeight;
 
        if (getSize) // -> Find out the necessary size RECT to draw the text... (i.e. element-aware GetTextExtentPoint32 wrapper)
        {
            SIZE size;
            HDC fonthdc = CreateDC("DISPLAY", NULL, NULL, NULL);
            HFONT font = CreateFont(fontHeight, 0, 0, 0, element->FontWeight, false, false, false, DEFAULT_CHARSET, OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS, DEFAULT_QUALITY, DEFAULT_PITCH, element->Font);
            HGDIOBJ oldfont = SelectObject(fonthdc, font);
 
            if (textUnicode != NULL) GetTextExtentPoint32W(fonthdc, textUnicode, wcslen(textUnicode), &size);
            else GetTextExtentPoint32(fonthdc, textANSI, strlen(textANSI), &size);
 
            if (element->FontOutline) size.cx += 2;
            else if (element->FontShadow) size.cx += 1;
            size.cx += (element->marginWidth * 2) + (element->borderWidth * 2);
            size.cy += (element->marginWidth * 2) + (element->borderWidth * 2);
 
            SetRect(rect, 0, 0, size.cx, size.cy);
 
            DeleteObject(SelectObject(fonthdc, oldfont));
            DeleteDC(fonthdc);
 
            return true;
        }
        else // -> Draw the text...
        {
            unsigned int textFormat = format;
            if (format == NULL) textFormat = element->Justify | DT_VCENTER | DT_NOPREFIX | DT_SINGLELINE | DT_WORD_ELLIPSIS;
            HFONT font = CreateFont(fontHeight, 0, 0, 0, element->FontWeight, false, false, false, DEFAULT_CHARSET, OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS, DEFAULT_QUALITY, DEFAULT_PITCH, element->Font);
            HGDIOBJ oldfont = SelectObject(hdc, font);
            SetBkMode(hdc, TRANSPARENT);
            if (textUnicode != NULL) DrawTextWithEffectsUnicode(hdc, *rect, textUnicode, textFormat, element->TextColor, element->FontOutline, element->OutlineColor, element->FontShadow, element->ShadowColor, element->ShadowX, element->ShadowY);
            else DrawTextWithEffects(hdc, *rect, textANSI, textFormat, element->TextColor, element->FontOutline, element->OutlineColor, element->FontShadow, element->ShadowColor, element->ShadowX, element->ShadowY);
            DeleteObject(SelectObject(hdc, oldfont));
            return true;
        }
    }
    else return false; // -> Unsupported style element, nothing drawn...
}

GetMetricsEvolved()

DLL_EXPORT int GetMetricsEvolved	(	LPSTR	styleElement,
		int	metricsToInclude )

{
    StyleItem* element = FindStyleElement(styleElement);
 
    if (element != NULL) // -> Supported style element found!
    {
        int padding = 0;
        if (metricsToInclude & METRIC_BORDER) padding += element->borderWidth;
        if (metricsToInclude & METRIC_MARGIN) padding += element->marginWidth;
        if (metricsToInclude & METRIC_BEVEL)
        {
            if (element->bevelstyle != BEVEL_FLAT)
            {
                if (element->bevelposition == BEVEL2) padding += 2;
                else padding += 1;
            }
        }
        return padding;
    }
    else return 0; // -> Unsupported style element...
}

MakeGradientSuper()

DLL_EXPORT void MakeGradientSuper	(	HDC	hdc,
		RECT	rect,
		int	type,
		COLORREF	color1,
		COLORREF	color2,
		COLORREF	color3,
		COLORREF	color4,
		COLORREF	color5,
		COLORREF	color6,
		COLORREF	color7,
		COLORREF	color8,
		bool	bInterlaced,
		int	bevelStyle,
		int	bevelPosition,
		int	bevelWidth,
		COLORREF	borderColour,
		int	borderWidth )

{
    if (borderWidth > 0)
    {
        gradientRect.left = rect.left + borderWidth;
        gradientRect.top = rect.top + borderWidth;
        gradientRect.right = rect.right - borderWidth;
        gradientRect.bottom = rect.bottom - borderWidth;
 
        pBImage->DrawBorder(hdc, rect, borderColour, borderWidth);
        pBImage->DrawGradient(hdc, gradientRect, type, color1, color2, color3, color4, color5, color6, color7, color8, bInterlaced, bevelStyle, bevelPosition, bevelWidth);
    }
    else pBImage->DrawGradient(hdc, rect, type, color1, color2, color3, color4, color5, color6, color7, color8, bInterlaced, bevelStyle, bevelPosition, bevelWidth);
}

MakeGradientEx()

DLL_EXPORT void MakeGradientEx	(	HDC	hdc,
		RECT	rect,
		int	gradientType,
		COLORREF	colourFrom,
		COLORREF	colourTo,
		COLORREF	splitFrom,
		COLORREF	splitTo,
		bool	interlaced,
		int	bevelStyle,
		int	bevelPosition,
		int	bevelWidth,
		COLORREF	borderColour,
		int	borderWidth )

{
    // Below: Allow limited "forwards compatibility" by supporting down-parsing of newer, otherwise normally 8-colour gradients,
    // to use only the 4 supplied input colours (i.e. at least avoiding partially "black" renders)
    int allowedType = type;
    if (type == B_SUPERHORIZONTAL || type == B_SUPERVERTICAL) allowedType -= 50; // -> Converted to 4-colour B_SPLITHORIZONTAL and B_SPLITVERTICAL respectively
 
    MakeGradientSuper(hdc, rect, allowedType, color1, color2, split1, split2, 0, 0, 0, 0, bInterlaced, bevelStyle, bevelPosition, bevelWidth, borderColour, borderWidth);
}

MakeGradient()

DLL_EXPORT void MakeGradient	(	HDC	hdc,
		RECT	rect,
		int	gradientType,
		COLORREF	colourFrom,
		COLORREF	colourTo,
		bool	interlaced,
		int	bevelStyle,
		int	bevelPosition,
		int	bevelWidth,
		COLORREF	borderColour,
		int	borderWidth )

{
    // Below: Allow limited "forwards compatibility" by supporting down-parsing of newer, otherwise normally 4- or 8-colour gradients,
    // to use only the 2 supplied input colours (i.e. at least avoiding partially "black" renders)
    int allowedType = type;
    if (type == B_SUPERHORIZONTAL || type == B_SUPERVERTICAL) allowedType -= 150; // -> Converted to 2-colour B_HORIZONTAL and B_VERTICAL respectively
    else if (type == B_SPLITHORIZONTAL || type == B_SPLITVERTICAL || type == B_SPLITSOLID) allowedType -= 100; // (etc)
 
    MakeGradientSuper(hdc, rect, allowedType, color1, color2, 0, 0, 0, 0, 0, 0, interlaced, bevelStyle, bevelPosition, bevelWidth, borderColor, borderWidth);
}

MakeStyleGradient()

DLL_EXPORT void MakeStyleGradient	(	HDC	hdc,
		RECT *	rect,
		StyleItem *	item,
		bool	withBorder )

{
    // Note: Currently for basic API compatibility only, e.g. not yet accessing StyleItem info beyond "safe" classic 2-colour gradients etc, hence re-parsing via MakeGradient here...
    // (read: possibly subject to change later on, pending renewed API version handling across branches? (note: not currently specified in e.g. the StyleItem definition))
    if (item->nVersion == CORE_SHELL_STYLEITEM) MakeGradientSuper(hdc, *rect, item->type, item->Color1, item->Color2, item->Color3, item->Color4, item->Color5, item->Color6, item->Color7, item->Color8, item->interlaced, item->bevelstyle, item->bevelposition, 0, pSettings->borderColor, withBorder ? pSettings->borderWidth : 0);
    else MakeGradient(hdc, *rect, item->type, item->Color, item->ColorTo, item->interlaced, item->bevelstyle, item->bevelposition, 0, pSettings->borderColor, withBorder ? pSettings->borderWidth : 0);
}

CreateStyleFont()

DLL_EXPORT HFONT CreateStyleFont

(

StyleItem *

item

)

{
    char *face = item->Font;
    int height = item->FontHeight;
    int weight = item->FontWeight;
 
    HDC hdc = CreateCompatibleDC(NULL);
    int data = 0;
    EnumFontFamilies(hdc, face, (FONTENUMPROC)EnumFontFamProc, (LPARAM)&data);
    DeleteDC(hdc);
    if (!data) face = "verdana";
 
    return CreateFont(height, 0, 0, 0, weight, false, false, false, DEFAULT_CHARSET, OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS, DEFAULT_QUALITY, DEFAULT_PITCH|FF_DONTCARE, face);
}

CreateBorder()

DLL_EXPORT void CreateBorder	(	HDC	hdc,
		RECT *	rect,
		int	borderColour,
		int	borderWidth )

{
    pBImage->DrawBorder(hdc, *rect, borderColour, borderWidth);
}

CreateBorderSuper()

DLL_EXPORT void CreateBorderSuper	(	HDC	hdc,
		RECT	rect,
		int	type,
		COLORREF	color1,
		COLORREF	color2,
		COLORREF	color3,
		COLORREF	color4,
		COLORREF	color5,
		COLORREF	color6,
		COLORREF	color7,
		COLORREF	color8,
		int	borderWidth )

{
    // ##################################################################################################
    // ##### BELOW: EXPERIMENTAL SUPPORT FOR GRADIENT BORDERS, NOT YET MEANT FOR PUBLIC CONSUMPTION #####
    // ##################################################################################################
 
    RECT borderRectLeft, borderRectTop, borderRectRight, borderRectBottom;
    SetRect(&borderRectLeft, rect.left, rect.top, rect.left + borderWidth, rect.bottom);
    SetRect(&borderRectTop, rect.left, rect.top, rect.right, rect.top + borderWidth);
    SetRect(&borderRectRight, rect.right - borderWidth, rect.top, rect.right, rect.bottom);
    SetRect(&borderRectBottom, rect.left, rect.bottom - borderWidth, rect.right, rect.bottom);
 
    int overlap = borderWidth - 1;
 
    if ((type == B_SUPERHORIZONTAL) || (type == B_SPLITHORIZONTAL) || (type == B_MIRRORHORIZONTAL) || (type == B_HORIZONTAL))
    {
        InflateRect(&borderRectTop, -overlap, 0);
        InflateRect(&borderRectBottom, -overlap, 0);
 
        COLORREF borderColorRight;
        if (type == B_SUPERHORIZONTAL) borderColorRight = color8;
        else if (type == B_SPLITHORIZONTAL) borderColorRight = color4;
        else if (type == B_MIRRORHORIZONTAL) borderColorRight = color1;
        else borderColorRight = color2;
 
        MakeGradientSuper(hdc, borderRectLeft, B_SOLID, color1, 0, 0, 0, 0, 0, 0, 0, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectRight, B_SOLID, borderColorRight, 0, 0, 0, 0, 0, 0, 0, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectTop, type, color1, color2, color3, color4, color5, color6, color7, color8, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectBottom, type, color1, color2, color3, color4, color5, color6, color7, color8, false, BEVEL_FLAT, 0, 0, 0, 0);
    }
    else if ((type == B_SUPERVERTICAL) || (type == B_SPLITVERTICAL) || (type == B_MIRRORVERTICAL) || (type == B_VERTICAL))
    {
        InflateRect(&borderRectLeft, 0, -overlap);
        InflateRect(&borderRectRight, 0, -overlap);
 
        COLORREF borderColorBottom;
        if (type == B_SUPERVERTICAL) borderColorBottom = color8;
        else if (type == B_SPLITVERTICAL) borderColorBottom = color4;
        else if (type == B_MIRRORVERTICAL) borderColorBottom = color1;
        else borderColorBottom = color2;
 
        MakeGradientSuper(hdc, borderRectTop, B_SOLID, color1, 0, 0, 0, 0, 0, 0, 0, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectBottom, B_SOLID, borderColorBottom, 0, 0, 0, 0, 0, 0, 0, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectLeft, type, color1, color2, color3, color4, color5, color6, color7, color8, false, BEVEL_FLAT, 0, 0, 0, 0);
        MakeGradientSuper(hdc, borderRectRight, type, color1, color2, color3, color4, color5, color6, color7, color8, false, BEVEL_FLAT, 0, 0, 0, 0);
    }
}

CreateElementImage()

void CreateElementImage

(

StyleItem *

styleItem

)

{
    if (styleItem->Image.bitmap != NULL) return;
 
//  if (pSettings->debugLogging) SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_WARNING_MESSAGE, (LPARAM)styleItem->Image.path);
 
    // Load the image using GDI+ to add support for JPG, PNG etc...
    // (nb. regular GDI LoadImage() only supports BMP images. GDI+ startup/shutdown is performed "globally" in Blackbox.cpp.)
    wchar_t imagePathWC[MAX_PATH];
    MultiByteToWideChar(CP_ACP, 0, styleItem->Image.path, strlen(styleItem->Image.path)+1, imagePathWC, MAX_PATH);
    Bitmap* bitmap = new Bitmap(imagePathWC, FALSE);
 
    // ...fetch some of its properties...
    styleItem->Image.width = bitmap->GetWidth();
    styleItem->Image.height = bitmap->GetHeight();
    PixelFormat pf = bitmap->GetPixelFormat();
    if ((pf == PixelFormat32bppARGB) || (pf == PixelFormat32bppPARGB) || (pf == PixelFormat64bppARGB) || (pf == PixelFormat64bppPARGB)) styleItem->Image.argb = true;
    else styleItem->Image.argb = false;
 
    // ...and finally create our target GDI HBITMAP from the loaded GDI+ Bitmap...
    bitmap->GetHBITMAP(0, &styleItem->Image.bitmap);
 
    delete bitmap;
}

DrawImageIntoRect()

void DrawImageIntoRect	(	HDC	hdc,
		RECT	r,
		StyleItem *	styleItem,
		bool	useAlpha,
		bool	drawBorder )

{
    if (styleItem->Image.bitmap == NULL) return;
 
    RECT tempRect;
    CopyRect(&tempRect, &r);
 
    if (drawBorder)
    {
        // Draw border...
        CreateBorder(hdc, &tempRect, styleItem->borderColor, styleItem->borderWidth);
        InflateRect(&tempRect, -styleItem->borderWidth, -styleItem->borderWidth);
    }
 
    // Draw image...
    HDC buf = CreateCompatibleDC(hdc);
    DeleteObject(SelectObject(buf, styleItem->Image.bitmap));
    SetStretchBltMode(hdc, HALFTONE);
 
    int itemWidth = tempRect.right - tempRect.left;
    int itemHeight = tempRect.bottom - tempRect.top;
    int edgesLeftRight = styleItem->Image.left + styleItem->Image.right;
    int edgesTopBottom = styleItem->Image.top + styleItem->Image.bottom;
 
    if (useAlpha && styleItem->Image.argb) // -> Should we draw an ARGB image using alpha blending on top of something else? (e.g. menu bullets)
    {
        // ### Note: While AlphaBlend() can be used to draw 32bpp ARGB images with per pixel alpha transparency, it also scales images down
        // much less smoothly than StretchBlt() as it reverts from HALFTONE (i.e. pixel averaging) to COLORONCOLOR (i.e. pixel deleting) mode;
        // for more information see https://docs.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-alphablend ###
        BLENDFUNCTION bf;
        ZeroMemory(&bf, sizeof(BLENDFUNCTION));
        bf.BlendOp = AC_SRC_OVER;
        bf.SourceConstantAlpha = 255;
        bf.AlphaFormat = AC_SRC_ALPHA;
        AlphaBlend(hdc, tempRect.left, tempRect.top, itemWidth, itemHeight, buf, 0, 0, styleItem->Image.width, styleItem->Image.height, bf);
    }
    else // -> If not, use the regular BitBlt/StretchBlt functions for RGB images as these provide better scaling quality... (see explanation above)
    {
        if ((styleItem->Image.width < edgesLeftRight) || (styleItem->Image.height < edgesTopBottom))
        {
            StretchBlt(hdc, tempRect.left, tempRect.top, itemWidth, itemHeight, buf, 0, 0, styleItem->Image.width, styleItem->Image.height, SRCCOPY);
        }
        else
        {
            if (styleItem->Image.left > 0)
            {
                if (styleItem->Image.top > 0) BitBlt(hdc, tempRect.left, tempRect.top, styleItem->Image.left, styleItem->Image.top, buf, 0, 0, SRCCOPY);
                if (styleItem->Image.bottom > 0) BitBlt(hdc, tempRect.left, (tempRect.bottom-styleItem->Image.bottom), styleItem->Image.left, styleItem->Image.bottom, buf, 0, (styleItem->Image.height-styleItem->Image.bottom), SRCCOPY);
                StretchBlt(hdc, tempRect.left, (tempRect.top+styleItem->Image.top), styleItem->Image.left, (itemHeight-edgesTopBottom), buf, 0, styleItem->Image.top, styleItem->Image.left, (styleItem->Image.height-edgesTopBottom), SRCCOPY);
            }
 
            if (styleItem->Image.right > 0)
            {
                if (styleItem->Image.top > 0) BitBlt(hdc, tempRect.right-styleItem->Image.right, tempRect.top, styleItem->Image.right, styleItem->Image.top, buf, (styleItem->Image.width-styleItem->Image.right), 0, SRCCOPY);
                if (styleItem->Image.bottom > 0) BitBlt(hdc, tempRect.right-styleItem->Image.right, (tempRect.bottom-styleItem->Image.bottom), styleItem->Image.right, styleItem->Image.bottom, buf, (styleItem->Image.width-styleItem->Image.right), (styleItem->Image.height-styleItem->Image.bottom), SRCCOPY);
                StretchBlt(hdc, tempRect.right-styleItem->Image.right, (tempRect.top+styleItem->Image.top), styleItem->Image.right, (itemHeight-edgesTopBottom), buf, (styleItem->Image.width-styleItem->Image.right), styleItem->Image.top, styleItem->Image.right, (styleItem->Image.height-edgesTopBottom), SRCCOPY);
            }
 
            if (styleItem->Image.top > 0)
            {
                if (styleItem->Image.left > 0) BitBlt(hdc, tempRect.left, tempRect.top, styleItem->Image.left, styleItem->Image.top, buf, 0, 0, SRCCOPY);
                if (styleItem->Image.right > 0) BitBlt(hdc, tempRect.right-styleItem->Image.right, tempRect.top, styleItem->Image.right, styleItem->Image.top, buf, (styleItem->Image.width-styleItem->Image.right), 0, SRCCOPY);
                StretchBlt(hdc, (tempRect.left+styleItem->Image.left), tempRect.top, (itemWidth-edgesLeftRight), (tempRect.top+styleItem->Image.top), buf, styleItem->Image.left, 0, (styleItem->Image.width-edgesLeftRight), styleItem->Image.top, SRCCOPY);
            }
 
            if (styleItem->Image.bottom > 0)
            {
                if (styleItem->Image.left > 0) BitBlt(hdc, tempRect.left, (tempRect.bottom-styleItem->Image.bottom), styleItem->Image.left, styleItem->Image.bottom, buf, 0, (styleItem->Image.height-styleItem->Image.bottom), SRCCOPY);
                if (styleItem->Image.right > 0) BitBlt(hdc, tempRect.right-styleItem->Image.right, (tempRect.bottom-styleItem->Image.bottom), styleItem->Image.right, styleItem->Image.bottom, buf, (styleItem->Image.width-styleItem->Image.right), (styleItem->Image.height-styleItem->Image.bottom), SRCCOPY);
                StretchBlt(hdc, (tempRect.left+styleItem->Image.left), (tempRect.bottom-styleItem->Image.bottom), (itemWidth-edgesLeftRight), styleItem->Image.bottom, buf, styleItem->Image.left, (styleItem->Image.height-styleItem->Image.bottom), (styleItem->Image.width-edgesLeftRight), styleItem->Image.bottom, SRCCOPY);
            }
 
            StretchBlt(hdc, (tempRect.left+styleItem->Image.left), (tempRect.top+styleItem->Image.top), (itemWidth-edgesLeftRight), (itemHeight-edgesTopBottom), buf, styleItem->Image.left, styleItem->Image.top, (styleItem->Image.width-edgesLeftRight), (styleItem->Image.height-edgesTopBottom), SRCCOPY);
        }
    }
 
    DeleteDC(buf);
}

DrawTextWithEffectsEx()

void DrawTextWithEffectsEx	(	HDC	hdc,
		RECT	r,
		LPWSTR	textUnicode,
		LPSTR	textANSI,
		unsigned int	format,
		COLORREF	textColor,
		bool	outline,
		COLORREF	outlineColor,
		bool	shadow,
		COLORREF	shadowColor,
		int	shadowX,
		int	shadowY )

{
    if (textUnicode != NULL) DrawTextWithEffectsUnicode(hdc, r, textUnicode, format, textColor, outline, outlineColor, shadow, shadowColor, shadowX, shadowY);
    else DrawTextWithEffects(hdc, r, textANSI, format, textColor, outline, outlineColor, shadow, shadowColor, shadowX, shadowY);
}

DrawTextWithEffects()

DLL_EXPORT void DrawTextWithEffects	(	HDC	hdc,
		RECT	r,
		LPSTR	text,
		unsigned int	format,
		COLORREF	textColor,
		bool	outline,
		COLORREF	outlineColor,
		bool	shadow,
		COLORREF	shadowColor,
		int	shadowX,
		int	shadowY )

{
    wchar_t textInUnicode[MAX_LINE_LENGTH*10]; // (nb. this much text is typically only remotely happening in e.g. logging popup dialogs, cf. matching size used in PopupDialog.h)
    MultiByteToWideChar(CP_ACP, 0, text, strlen(text)+1, textInUnicode, sizeof(textInUnicode)); // We need to use the system default Windows ANSI code page (CP_ACP) for conversion here...
    DrawTextWithEffectsUnicode(hdc, r, textInUnicode, format, textColor, outline, outlineColor, shadow, shadowColor, shadowX, shadowY);
}

DrawTextWithEffectsUnicode()

void DrawTextWithEffectsUnicode	(	HDC	hdc,
		RECT	r,
		LPWSTR	text,
		unsigned int	format,
		COLORREF	textColor,
		bool	outline,
		COLORREF	outlineColor,
		bool	shadow,
		COLORREF	shadowColor,
		int	shadowX,
		int	shadowY )

{
    // Note#1: As the text itself should be topmost, below that the outline, and below that the shadow,
    // we need to draw it in the opposite order i.e. shadow->outline->text, see below.
    // Note#2: Yes, this way is quite compute-intensive, but also the best looking, so... ;)
 
    RECT s;
 
    //====================
 
    if (outline && shadow)
    {
        CopyRect(&s, &r);
//      if (pSettings->doubleScaleHiDPI) OffsetRect(&s, shadowX*2, shadowY*2);
//      else OffsetRect(&s, shadowX, shadowY);
        if (pSettings->doubleScaleHiDPI && (shadowX==1) && (shadowY==1)) OffsetRect(&s, 2, 2);
        else OffsetRect(&s, shadowX, shadowY);
//      OffsetRect(&s, shadowX, shadowY);
        DrawTextWithEffectsUnicode(hdc, s, text, format, shadowColor, true, shadowColor, false, 0, 0, 0); // Draw [bigger due to the outline] shadow...
        DrawTextWithEffectsUnicode(hdc, r, text, format, textColor, true, outlineColor, false, 0, 0, 0); // ...with outline and regular text on top...
    }
    else if (shadow)
    {
        // Draw shadow... (1 pixel thick for non-HiDPI, 2 pixels thick for HiDPI,
        // with its position adjusted for outlined text if so applicable)
 
        SetTextColor(hdc, shadowColor);
 
        if (outline) // -> Outlined text -> Shadow offset positon adjusted accordingly
        {
            if (pSettings->doubleScaleHiDPI)
            {
                CopyRect(&s, &r);
                OffsetRect(&s, 4, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
 
                CopyRect(&s, &r);
                OffsetRect(&s, 3, -1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
            }
            else
            {
                CopyRect(&s, &r);
                OffsetRect(&s, 2, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, 0, 1);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
                OffsetRect(&s, -1, 0);
                DrawTextW(hdc, text, wcslen(text), &s, format);
            }
        }
        else // -> Non-outlined text -> Shadow offset position as per the input parameters
        {
            CopyRect(&s, &r);
////        OffsetRect(&s, 2, 2);
//          if (pSettings->doubleScaleHiDPI) OffsetRect(&s, shadowX*2, shadowY*2);
//          else OffsetRect(&s, shadowX, shadowY);
            OffsetRect(&s, shadowX, shadowY);
            DrawTextW(hdc, text, wcslen(text), &s, format);
        }
    }
 
    //====================
    
    if (outline)
    {
        // Draw outline... (1 pixel thick for non-HiDPI, 2 pixels thick for HiDPI)
 
        SetTextColor(hdc, outlineColor);
 
        if (pSettings->doubleScaleHiDPI)
        {
            CopyRect(&s, &r);
            OffsetRect(&s, 0, -2);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, 1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, 1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, 1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, 1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, -1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, -1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, -1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, -1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, -1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, -1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, -1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 0, -1);
            DrawTextW(hdc, text, wcslen(text), &s, format);
            OffsetRect(&s, 1, 0);
            DrawTextW(hdc, text, wcslen(text), &s, format);
        }
 
        CopyRect(&s, &r);
        OffsetRect(&s, 0, -1);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, 1, 0);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, 0, 1);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, 0, 1);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, -1, 0);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, -1, 0);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, 0, -1);
        DrawTextW(hdc, text, wcslen(text), &s, format);
        OffsetRect(&s, 0, -1);
        DrawTextW(hdc, text, wcslen(text), &s, format);
    }
 
    //====================
 
    // Draw text...
    SetTextColor(hdc, textColor);
    DrawTextW(hdc, text, wcslen(text), &r, format);
}

DrawSatHueIcon()

DLL_EXPORT void DrawSatHueIcon	(	HDC	hdc,
		RECT	r,
		HICON	icon,
		int	size,
		int	saturation,
		int	hue )

{
    // Should we apply saturation or hue?
    if (saturation < 255 || hue > 0)
    {
        HDC iconhdc = CreateCompatibleDC(hdc);
        HBITMAP iconbufbmp = ::CreateCompatibleBitmap(hdc, size, size*2);
        HBITMAP oldiconbuf = (HBITMAP) ::SelectObject(iconhdc, iconbufbmp);
 
        // An icon drawn using DI_NORMAL doesn't always seem to be masked properly,
        // so we perform the masking manually by drawing the icon and mask side-by-side
        // into a temporary buffer, applying saturation and hue to the icon's non-masked
        // pixels, and copying them into the destination HDC...
        DrawIconEx(iconhdc, 0, 0, icon, size, size, 0, NULL, DI_MASK);
        DrawIconEx(iconhdc, 0, size, icon, size, size, 0, NULL, DI_NORMAL);
 
        invsat = 255 - saturation;
        invhue = 255 - hue;
 
        for (int y=0; y < size; y++)
        {
            for (int x=0; x < size; x++)
            {
                // Check if the mask pixel is a transparent pixel...
//              if (!GetPixel(iconhdc, x, y))
                if (GetPixel(iconhdc, x, y) == 0x000000)
                {
                    // If not, we read the icon pixel color...
                    pixel = GetPixel(iconhdc, (x), (size+y));
                    red = GetRValue(pixel);
                    green = GetGValue(pixel);
                    blue = GetBValue(pixel);
 
                    // ...apply saturation...
                    if (saturation < 255)
                    {
                        greyscale = (BYTE)(red*0.3086 + green*0.6094 + blue*0.0820);
                        red = (BYTE)((red*saturation + greyscale*invsat + 255)>>8);
                        green = (BYTE)((green*saturation + greyscale*invsat + 255)>>8);
                        blue = (BYTE)((blue*saturation + greyscale*invsat + 255)>>8);
                    }
                    // ...and hue...
                    if (hue > 0)
                    {
                        // ...based on the colour of the destination pixel (i.e. the background)...
                        pixel = GetPixel(hdc, (r.left + x), (r.top + y));
                        destred = GetRValue(pixel);
                        destgreen = GetGValue(pixel);
                        destblue = GetBValue(pixel);
 
                        // ...and the hue intensity...
                        red = (BYTE)((red*invhue + destred*hue + 255)>>8);
                        green = (BYTE)((green*invhue + destgreen*hue + 255)>>8);
                        blue = (BYTE)((blue*invhue + destblue*hue + 255)>>8);
                    }
                    // ...and finally we copy the sat'n'hue icon pixel to the destination...
                    SetPixel(hdc, (r.left + x), (r.top + y), RGB(red, green, blue));
                }
//              else if (pSettings->debugLogging && saturation==0 && hue==255) SetPixel(hdc, (r.left + x), (r.top + y), 0xff00ff);
            }
        }
 
        SelectObject(iconhdc, oldiconbuf);
        DeleteObject(iconbufbmp);
        DeleteDC(iconhdc);
    }
    else
    {
        // No saturation or hue modifications, just draw the icon...
        DrawIconEx(hdc, r.left, r.top, icon, size, size, 0, NULL, DI_NORMAL);
    }
}

DrawGlyph()

DLL_EXPORT void DrawGlyph	(	HDC	hdc,
		RECT	r,
		int	glyph,
		COLORREF	glyphColor )

{
    pBImage->DrawGlyph(hdc, r, glyph, glyphColor);
}

AlphaRect()

DLL_EXPORT void AlphaRect	(	HDC	hdc,
		RECT	rect,
		unsigned char	alpha )

{
    // Note: Use alpha == 255 as input value to remove
    // per pixel alpha i.e. make the rect fully opaque.
    pBImage->AlphaRect(hdc, rect, alpha);
}

AlphaBorder()

DLL_EXPORT void AlphaBorder	(	HDC	hdc,
		RECT	rect,
		unsigned char	alpha,
		int	borderWidth )

{
    pBImage->AlphaBorder(hdc, rect, alpha, borderWidth);
}

AlphaCorner()

DLL_EXPORT void AlphaCorner	(	HDC	hdc,
		RECT	rect,
		int	corner,
		int	bevelStyle,
		int	bevelPosition,
		int	bevelWidth,
		int	borderWidth,
		unsigned char	minAlpha,
		unsigned char	maxAlpha )

{
    // Note: All input parameters are not currently used, but have been included
    // in the function definition to avoid API changes if/when the implementation
    // is improved (which is tricky given the numerous rendering options available)
    pBImage->AlphaCorner(hdc, rect, corner, borderWidth, minAlpha, maxAlpha);
}

AlphaFromRGB()

DLL_EXPORT void AlphaFromRGB	(	HDC	hdc,
		RECT	rect,
		unsigned char	minAlpha,
		unsigned char	maxAlpha,
		bool	recolor,
		COLORREF	color )

{
    pBImage->AlphaFromRGB(hdc, rect, minAlpha, maxAlpha, recolor, color);
}

AlphaMask()

void AlphaMask	(	HDC	destHdc,
		RECT	destRect,
		HDC	srcHdc,
		RECT	srcRect,
		bool	useSrcRGBAsAlpha )

{
    pBImage->AlphaMask(destHdc, destRect, srcHdc, srcRect, useSrcRGBAsAlpha);
}

AlphaApply()

DLL_EXPORT void AlphaApply	(	HDC	hdc,
		RECT	rect )

{
    // "AlphaApplyToRGB"
    // -> Pre-applies the per pixel alpha to the RGB values of each pixel
    //  (required by related Windows API functions before processing).
    pBImage->AlphaApply(hdc, rect);
}

PrepareCorner()

DLL_EXPORT void PrepareCorner	(	HDC	hdc,
		RECT	rect,
		int	corner,
		int	bevelStyle,
		int	bevelPosition,
		int	bevelWidth,
		int	borderWidth )

{
    pBImage->PrepareCorner(hdc, rect, corner, bevelStyle, bevelPosition, bevelWidth, borderWidth);
}

PrepareCornerEvolved()

DLL_EXPORT int PrepareCornerEvolved	(	HDC	hdc,
		RECT	rect,
		int	corner,
		LPSTR	styleElement )

{
    StyleItem* element = FindStyleElement(styleElement);
    if (element != NULL)
    {
        pBImage->PrepareCorner(hdc, rect, corner, element->bevelstyle, element->bevelposition, 1, element->borderWidth);
        return element->borderWidth;
    }
    else return 0;
}

MakeMenu()

DLL_EXPORT Menu * MakeMenu

(

LPCSTR

HeaderText

)

{
    Menu *newMenu = new Menu(pMenuCommon->hInst);
    pMenuCommon->AddHeaderItem(newMenu, (LPSTR)HeaderText);
    return newMenu;
}

DelMenu()

DLL_EXPORT void DelMenu

(

Menu *

PluginMenu

)

{
    if (PluginMenu == pMenuCommon->m_pPluginMenu)
    {
        delete pMenuCommon->m_pPluginMenu;
        pMenuCommon->m_pPluginMenu = NULL;
    }
}

MakeNamedMenu()

DLL_EXPORT Menu * MakeNamedMenu	(	LPCSTR	HeaderText,
		LPCSTR	MenuId,
		bool	popup )

{
    if (popup)
    {
        hideNamedMenu = false;
        return MakeMenu(HeaderText);
    }
    else
    {
        hideNamedMenu = true;
        return NULL;
    }
}

MakeSubmenu()

DLL_EXPORT MenuItem * MakeSubmenu	(	Menu *	ParentMenu,
		Menu *	ChildMenu,
		LPCSTR	Title )

{
    if (!ParentMenu) return NULL;
 
    MenuItem *newMenuItem = NULL;
 
    if (ChildMenu)
    {
        pMenuCommon->AddFooterItem(ChildMenu, "");
 
        ChildMenu->Invalidate();
        ChildMenu->Validate();
 
        if (ParentMenu)
        {
            newMenuItem = new FolderItem(ChildMenu, (LPSTR)Title, NULL);
            newMenuItem->SetHeight(pMenuCommon->m_nSubmenuHeight);
            ParentMenu->AddMenuItem(newMenuItem);
        }
    }
 
    return newMenuItem;
}

MakeMenuItem()

DLL_EXPORT MenuItem * MakeMenuItem	(	Menu *	PluginMenu,
		LPCSTR	Title,
		LPCSTR	Cmd,
		bool	ShowIndicator )

{
    if (!PluginMenu) return NULL;
//  if (strchr(Cmd, '[') && strchr(Cmd, ']')) pMenuCommon->CreateMenuItem(PluginMenu, (LPSTR)Cmd, (LPSTR)Cmd, (LPSTR)Title, ShowIndicator);
//  else pMenuCommon->CreateMenuItem(PluginMenu, "[exec]", (LPSTR)Cmd, (LPSTR)Title, ShowIndicator);
    return pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_COMMAND, "[exec]", (LPSTR)Cmd, (LPSTR)Title, ShowIndicator);
}

MakeMenuItemBool()

DLL_EXPORT MenuItem * MakeMenuItemBool	(	Menu *	PluginMenu,
		LPCSTR	Title,
		LPCSTR	Cmd,
		bool	state,
		int	selectionGroup )

{
    if (!PluginMenu) return NULL;
    MenuItem* newItem = pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_BOOLEAN, "[exec]", (LPSTR)Cmd, (LPSTR)Title, state);
    if (selectionGroup > 0) newItem->AddToSelectionGroup((1000+selectionGroup)); // Add the new menu item to a mutually exclusive group of boolean items (nb. often useful for e.g. placement menus where only one item is "true" at a time)
    return newItem;
}

MakeMenuItemInt()

DLL_EXPORT MenuItem * MakeMenuItemInt	(	Menu *	PluginMenu,
		LPCSTR	Title,
		LPCSTR	Cmd,
		int	val,
		int	minval,
		int	maxval )

{
    if (!PluginMenu) return NULL;
 
    char TitleWithColon [MAX_LINE_LENGTH], CmdValues[MAX_LINE_LENGTH];
 
    // Make sure there's a colon after the title for consistency... :)
    if (Title[strlen(Title)-1] == ':') sprintf(TitleWithColon, "%s", Title);
    else sprintf(TitleWithColon, "%s:", Title);
    // Does the command string includes spaces?
    if (strstr(Cmd, " ")) sprintf(CmdValues, "\"%s\" %d %d %d", Cmd, val, minval, maxval);
    else sprintf(CmdValues, "%s %d %d %d", Cmd, val, minval, maxval);
 
    bool enabled = false;
//  if ((val>=minval) && (val<=maxval)) enabled = true;
 
    return pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_EDITINT, (LPSTR)CmdValues, NULL, (LPSTR)TitleWithColon, enabled);
}

MakeMenuItemString()

DLL_EXPORT MenuItem * MakeMenuItemString	(	Menu *	PluginMenu,
		LPCSTR	Title,
		LPCSTR	Cmd,
		LPCSTR	init_string )

{
    if (!PluginMenu) return NULL;
 
    char TitleColonInitString[MAX_LINE_LENGTH];
 
    if (strlen(Title) > 0)
    {
        if ((strlen(Title) >= 3) && !_strnicmp(&Title[strlen(Title)-3], "...", 3))
        {
            // Hidden init_string -> Just copy the title...
            strcpy(TitleColonInitString, Title);
        }
        else
        {
            // Visible init_string -> Make sure there's a colon after the title for consistency... :)
            if (Title[strlen(Title)-1] == ':') sprintf(TitleColonInitString, "%s <%s>", Title, init_string);
            else sprintf(TitleColonInitString, "%s: <%s>", Title, init_string);
        }
    }
    else sprintf(TitleColonInitString, "<%s>", init_string); // No title specified, so no colon needed...
 
    return pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_EDITSTRING, (LPSTR)Cmd, (LPSTR)init_string, (LPSTR)TitleColonInitString, false);
}

MakeMenuNOP()

DLL_EXPORT MenuItem * MakeMenuNOP	(	Menu *	PluginMenu,
		LPCSTR	Title )

{
    if (!PluginMenu) return NULL;
 
    if (Title != NULL)
    {
        if (!_strnicmp(Title, "---", 3)) // If the first three characters are --- we convert the NOP into a separator
        {
            if (!pSettings->menuSeparators) return NULL;
            else return pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_SEPARATOR, NULL, NULL, (LPSTR)Title, false);
        }
    }
 
    return pMenuCommon->CreateMenuItem(PluginMenu, MENUITEM_NOP, NULL, NULL, (LPSTR)Title, false);
}

ShowMenu()

DLL_EXPORT void ShowMenu

(

Menu *

PluginMenu

)

{
    if (!PluginMenu) return;
 
    //====================
 
    if (hideNamedMenu && pMenuCommon->m_pPluginMenu)
    {
        if (PluginMenu == pMenuCommon->m_pPluginMenu)
        {
//          pMenuCommon->Hide();
            pMenuCommon->m_pPluginMenu->Hide(HIDE_CHILDREN);
            ShowWindow(pMenuCommon->m_pPluginMenu->GetWindow(), SW_HIDE);
            DelMenu(pMenuCommon->m_pPluginMenu);
        }
        hideNamedMenu = false;
        return;
    }
 
    //====================
 
    pMenuCommon->Hide();
    if (pMenuCommon->m_pPluginMenu) DelMenu(pMenuCommon->m_pPluginMenu);
    pMenuCommon->m_pPluginMenu = PluginMenu;
 
    pMenuCommon->AddFooterItem(PluginMenu, "");
 
    PluginMenu->Invalidate();
    PluginMenu->Validate();
 
    PluginMenu->Show();
    PlaySoundFX(SFX_MENU_SHOW);
}

IsAppWindow()

DLL_EXPORT bool IsAppWindow

(

HWND

hwnd

)

{
    if (!(GetWindowLong(hWnd, GWL_STYLE) & WS_SYSMENU))
    {
        char windowClass[MAX_LINE_LENGTH];
        GetClassName(hWnd, windowClass, sizeof(windowClass));
        if (!_strnicmp(windowClass, "BBAppPlugin", 11)) return true; // Allow specific "application-like" plugins to show up on the taskbar...
 
        char windowText[MAX_LINE_LENGTH];
        GetWindowText(hWnd, windowText, sizeof(windowText));
 
        // Below: Workarounds for various application not having the WS_SYSMENU flag set...
        // (nb. it remains to be seen if other such apps need to be added to this list too)
 
        if (!_stricmp(windowClass, "MozillaWindowClass"))
        {
            // ##### Some newer Mozilla Firefox builds (at least version >= 135.0 as of this writing) #####
            return true;
        }
        else if (!_stricmp(windowClass, "Chrome_WidgetWin_1"))
        {
            // ##### Visual Studio Code, Microsoft Teams and Termius main window (all window class "Chrome_WidgetWin_1") #####
            if (IsInString(windowText, "Visual Studio Code") || IsInString(windowText, "Microsoft Teams")) return true;
            else if (IsInString(windowText, "Termius -") && _stricmp(windowText, "Termius - Settings")) return true; // ...but not the Termius settings child window
 
            if (pSettings->debugLogging)
            {
                char msg[MAX_LINE_LENGTH];
                if (hWnd && (strlen(windowText) > 0)) sprintf(msg, "DEBUG -> BBApi::IsAppWindow (Chrome_WidgetWin_1 specific checks) -> WS_SYSMENU check failed! -> %s", windowText);
                else strcpy(msg, "DEBUG -> BBApi::IsAppWindow (Chrome_WidgetWin_1 specific checks) -> No HWND!");
                SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_WARNING_MESSAGE, (LPARAM)msg);
                Log(msg, "");
            }
 
            return false;
        }
        else
        {
            // ##### Any other applications not having the WS_SYSMENU flag set #####
/*
            if (pSettings->debugLogging)
            {
                char msg[MAX_LINE_LENGTH];
                if (hWnd)
                {
                    if (strlen(windowText) > 0) sprintf(msg, "DEBUG -> BBApi::IsAppWindow (non application specific checks) -> WS_SYSMENU check failed! -> %s %s", windowClass, windowText);
//                  else sprintf(msg, "DEBUG -> BBApi::IsAppWindow (non application specific checks) -> WS_SYSMENU check failed! -> %s <None>", windowClass); // Not really of any interest?
                }
                else strcpy(msg, "DEBUG -> BBApi::IsAppWindow (non application specific checks) -> No HWND!");
                SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_WARNING_MESSAGE, (LPARAM)msg);
                Log(msg, "");
            }
*/
            return false;
        }
    }
 
    //====================
 
//  if (!(GetWindowLong(hWnd, GWL_STYLE) & WS_VISIBLE)) return false;
//  if (GetWindowLong(hWnd, GWL_STYLE) & WS_DISABLED) return false;
 
    char windowClass[MAX_LINE_LENGTH];
    GetClassName(hWnd, windowClass, sizeof(windowClass));
    if (strlen(windowClass) == 0) return false;
    if (!_stricmp(windowClass, "AcrobatOffscreenDocumentWnd")) return false; // Check for Adobe Acrobat 7.0 offscreen windows...
 
    char windowText[MAX_LINE_LENGTH];
    GetWindowText(hWnd, windowText, sizeof(windowText));
    if (strlen(windowText) == 0)
    {
/*
        if (pSettings->debugLogging)
        {
            char msg[MAX_LINE_LENGTH];
            sprintf(msg, "DEBUG -> BBApi::IsAppWindow -> GetWindowText failed! -> %s", windowClass);
            // SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)msg);
            Log(msg, "");
        }
*/
        return false;
    }
 
    // if (IsInString(windowText, " Powerpoint - [")) return false; // Check for Microsoft Powerpoint non-document windows... (-> "Microsoft Powerpoint - [" or "Microsoft Office PowerPoint - [" )
 
    // The Windows 10 Cortana window is seemingly odd, non-cloaking but also non-closeable etc, so shouldn't be shown on the taskbar...
    if (!_stricmp(windowText, "Cortana")) return false;
 
    //====================
 
    if (IsWindowVisible(hWnd))
    {
        if (!(GetWindowLong(hWnd, GWL_EXSTYLE) & WS_EX_TOOLWINDOW))
        {
            if (!GetParent(hWnd))
            {
                HWND hwndOwner = GetWindow(hWnd, GW_OWNER);
                if (!hwndOwner ||
                    ((GetWindowLong(hwndOwner, GWL_STYLE) & (WS_VISIBLE | WS_CLIPCHILDREN)) != (WS_VISIBLE | WS_CLIPCHILDREN)) || 
                    GetWindowLong(hwndOwner, GWL_EXSTYLE) & WS_EX_TOOLWINDOW )
                {
                    return true;
                }
//              else if (pSettings->debugLogging && IsInString(windowClass, "Chrome_WidgetWin")) Log("...Chrome_WidgetWin -> IsWindowVisible GetWindow etc checks failed!", "");
            }
//          else if (pSettings->debugLogging && IsInString(windowClass, "Chrome_WidgetWin")) Log("...Chrome_WidgetWin -> IsWindowVisible GetParent check failed!", "");
        }
//      else if (pSettings->debugLogging && IsInString(windowClass, "Chrome_WidgetWin")) Log("...Chrome_WidgetWin -> IsWindowVisible GetWindowLong check failed!", "");
    }
/*
    else if (pSettings->debugLogging)
    {
        if (IsInString(windowClass, "Chrome_WidgetWin"))
        {
            char msg[MAX_LINE_LENGTH];
            if (!strlen(windowText)) strcpy(windowText, "NULL");
            sprintf(msg, "DEBUG -> BBApi::IsAppWindow -> IsWindowVisible etc checks failed! -> %s | %s", windowText, windowClass);
            // SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)msg);
            Log(msg, "");
        }
    }
*/
    return false;
}

SetTransparency()

DLL_EXPORT bool SetTransparency	(	HWND	hwnd,
		BYTE	alpha )

{
    return SetTransparencyEx(hwnd, 0, alpha, LWA_ALPHA);
}

SetTransparencyEx()

DLL_EXPORT bool SetTransparencyEx	(	HWND	hwnd,
		COLORREF	crKey,
		BYTE	bAlpha,
		DWORD	dwFlags )

{
    slwaFunc SLWA = (slwaFunc)GetProcAddress(GetModuleHandle("USER32"), "SetLayeredWindowAttributes");
    if (!SLWA) return false;
 
    //====================
 
    if (dwFlags == LWA_ALPHA)
    {
        if (bAlpha < 255)
        {
            LONG windowStyle = GetWindowLong(hwnd, GWL_EXSTYLE);
            windowStyle = windowStyle | WS_EX_LAYERED;
            SetWindowLong(hwnd, GWL_EXSTYLE, windowStyle);
            return SLWA(hwnd, NULL, bAlpha, LWA_ALPHA);
        }
        else
        {
            LONG windowStyle = GetWindowLong(hwnd, GWL_EXSTYLE);
            windowStyle = windowStyle & ~WS_EX_LAYERED;
            SetWindowLong(hwnd, GWL_EXSTYLE, windowStyle);
            return false;
        }
    }
 
    //====================
 
    else if (dwFlags == LWA_COLORKEY)
    {
        LONG windowStyle = GetWindowLong(hwnd, GWL_EXSTYLE);
        windowStyle = windowStyle | WS_EX_LAYERED;
        SetWindowLong(hwnd, GWL_EXSTYLE, windowStyle);
        return SLWA(hwnd, crKey, 255, LWA_COLORKEY);
    }
 
    //====================
 
    return false;
}

SnapWindowToEdge()

DLL_EXPORT void SnapWindowToEdge	(	WINDOWPOS *	windowPosition,
		int	snapDistance,
		bool	useScreenSize )

{
    RECT workArea;
    ZeroMemory(&workArea, sizeof(workArea));
    int nTemp;
 
    //====================
 
    if (bUseScreenSize)
    {
        workArea.right = GetSystemMetrics(SM_CXVIRTUALSCREEN);
        workArea.bottom = GetSystemMetrics(SM_CYVIRTUALSCREEN);
    }
    else
    {
        SystemParametersInfo(SPI_GETWORKAREA, 0, &workArea, 0);
    }
 
    //====================
 
    // Left edge
    nTemp = pwPos->x - workArea.left;
    if (nTemp < nDist && nTemp > -nDist)
        pwPos->x = workArea.left;
 
    // Top edge
    nTemp = pwPos->y - workArea.top;
    if (nTemp < nDist && nTemp > -nDist)
        pwPos->y = workArea.top;
 
    // Right edge
    nTemp = workArea.right - (pwPos->x + pwPos->cx);
    if (nTemp < nDist && nTemp > -nDist) 
        pwPos->x = workArea.right - pwPos->cx;
 
    // Bottom edge
    nTemp =  workArea.bottom - (pwPos->y + pwPos->cy);
    if (nTemp < nDist && nTemp > -nDist)
        pwPos->y = workArea.bottom - pwPos->cy;
}

MakeSticky()

DLL_EXPORT void MakeSticky

(

HWND

window

)

{
    stickyWindows.push_back(window); // Note: This step applies also to non-taskbar windows...
 
    if (pTaskbar)
    {
        int i = pTaskbar->FindTask(window);
        if (i >= 0) pTaskbar->taskList[i]->workspace = 254; // Making the window sticky -> "Visible on all workspaces"
    }
}

RemoveSticky()

DLL_EXPORT void RemoveSticky

(

HWND

window

)

{
    for (int i=0; i < (int)stickyWindows.size(); i++)
    {
        if (stickyWindows[i] == window) stickyWindows.erase(stickyWindows.begin() + i);  // Note: This step applies also to non-taskbar windows...
    }
 
    if (pTaskbar)
    {
        int i = pTaskbar->FindTask(window);
        if (i >= 0) pTaskbar->taskList[i]->workspace = pSettings->currentWorkspace; // Making the window non-sticky -> "Visible only on this particular workspace"
    }
}

CheckSticky()

DLL_EXPORT bool CheckSticky

(

HWND

window

)

{
    for (int i=0; i < (int)stickyWindows.size(); i++)
    {
        if (stickyWindows[i] == window) return true; // Note: This step applies also to non-taskbar windows...
    }
 
    return false;
}

ToggleSticky()

DLL_EXPORT void ToggleSticky

(

HWND

window

)

{
    if (!CheckSticky(window)) MakeSticky(window);
    else RemoveSticky(window);
}

ClearSticky()

void ClearSticky

(

)

{
    stickyWindows.clear(); // Clean up...
}

GetDesktopInfo()

DLL_EXPORT void GetDesktopInfo

(

DesktopInfo *

deskInfo

)

{
    strncpy(deskInfo->name, pWorkspaces->workspaceNames[pSettings->currentWorkspace].c_str(), 32);
    deskInfo->name[31] = 0;
    deskInfo->isCurrent = true;
    deskInfo->number = pSettings->currentWorkspace;
    deskInfo->ScreensX = pSettings->numberOfWorkspaces;
    // deskInfo->deskNames is currently not supported
}

GetTraySize()

DLL_EXPORT int GetTraySize

(

)

{ return 0; }

GetTrayIcon()

DLL_EXPORT trayIconItem * GetTrayIcon

(

int

pointer

)

{ return NULL; }

GetUnderExplorer()

DLL_EXPORT bool GetUnderExplorer

(

)

{ return pSettings->underExplorer; }; // Note: Even in xoblite bb5, we do a check for Explorer at startup for other purposes, so we might just return that boolean here even if typically always "true"...

GetTaskListSize()

DLL_EXPORT int GetTaskListSize

(

)

{
    if (pTaskbar) return (int)pTaskbar->taskList.size();
    else return 0;
}

SetTaskWorkspace()

DLL_EXPORT void SetTaskWorkspace	(	HWND	hwnd,
		int	workspace )

{
    if (pWorkspaces) pWorkspaces->MoveWindowToWorkspace(hwnd, workspace);
}

GetTaskWorkspace()

DLL_EXPORT int GetTaskWorkspace

(

HWND

hwnd

)

{
    if (pWorkspaces) return pWorkspaces->GetWorkspaceByWindow(hwnd);
    else return 0;
}

GetTask()

DLL_EXPORT HWND GetTask

(

int

pointer

)

{
    if (pTaskbar)
    {
        if ((pointer >= 0) && (pointer <= (int)pTaskbar->taskList.size()))
        {
            return pTaskbar->taskList[pointer]->hwnd;
        }
    }
 
    return NULL;
}

GetActiveTask()

DLL_EXPORT int GetActiveTask

(

)

{
    if (pTaskbar)
    {
        int index = pTaskbar->GetActiveTask();
        if (index != NULL) return index;
    }
    
    return -1;
}

IsOnTaskbar()

bool IsOnTaskbar

(

HWND

hwnd

)

{
    if (pTaskbar)
    {
        if (pTaskbar->FindTask(hwnd) >= 0) return true;
    }
 
    return false;
}

IsAppRunning()

DLL_EXPORT HWND IsAppRunning

(

LPSTR

path

)

{
    if (pTaskbar)
    {
        for (int i=0; i < (int)pTaskbar->taskList.size(); i++)
        {
            if (!_stricmp(pTaskbar->taskList[i]->path, path)) return pTaskbar->taskList[i]->hwnd;
        }
    }
 
    return NULL;
}

GetMonitorRect()

DLL_EXPORT HMONITOR GetMonitorRect	(	void *	from,
		RECT *	r,
		int	Flags )

{
    return MonitorFromWindow(NULL, MONITOR_DEFAULTTOPRIMARY);
}