blackbox for windows - API|DLL exports

BlackBox for Windows

blackbox.exe API|DLL exports

available to Plugin developers

ReadBool	MakeMenuNOP	GetTask
ReadInt	MakeMenuItem	GetActiveTask
ReadString	GetBlackboxPath	GetTaskListSize
ReadColor	bbrcPath	GetTaskWorkspace
ReadValue	extensionsrcPath	SetTaskWorkspace
menuPath	MakeSubmenu	bbLean family only
WriteBool	plugrcPath	MakePathMenu
WriteInt	stylePath	DisableLastItem
WriteString	GetBBWnd	BBMessageBox
WriteColor	GetBBVersion	MenuExists
GetOSInfo	MakeMenu	DeleteSetting
GetUnderExplorer	DelMenu	RenameSetting
GetSettingPtr	Tokenize	GetToolbarInfo
FileExists	BBTokenize	GetMonitorRect
FileOpen	BBExecute	EnumTray
FileClose	Log	GetBlackboxEditor
FileRead	MBoxErrorFile	SetDesktopMargin
ReadNextCommand	MBoxErrorValue	MakeNamedMenu
GetDesktopInfo	ShowMenu	GetTaskListPtr
ConfigFileExists	ParseItem	GetTaskLocation
MakeSticky	IsInString	SetTaskLocation
RemoveSticky	StrRemoveEncap	EnumTasks
CheckSticky	ReplaceEnvVars	GetAppByWindow
ReplaceShellFolders	MakeMenuItemString	FoundLastValue
IsAppWindow	MakeGradient	FindConfigFile
MakeStyleGradient	CreateBorder	EnumDesks
SnapWindowToEdge	CreateStyleFont	dbg_printf
SetTransparency	GetTrayIcon	xoblite only
MakeMenuItemInt	GetTraySize	ParseFontString *only*
		CheckFontSubstitution *only*

BBAPI.cpp

//===========================================================================

// API: GetBBWnd

// Purpose: Returns the handle to the main Blackbox window

// In: None

// Out: HWND = Handle to the Blackbox window

//===========================================================================

// API: GetOSInfo

// Purpose: Retrieves info about the current OS

// In: None

// Out: LPCSTR = Returns a readable string containing the OS name

//===========================================================================

LPCSTR GetOSInfo(void)

{

if (osInfo.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)

{

if (osInfo.dwMinorVersion >= 90)

return "Windows ME";

if (osInfo.dwMinorVersion >= 10)

return "Windows 98";

return "Windows 95";

}

if (osInfo.dwMajorVersion == 5)

{

if (osInfo.dwMinorVersion >= 1)

return "Windows XP";

return "Windows 2000";

}

static char osinfo_buf[33];

sprintf(osinfo_buf, "Windows NT %d.%d", (int)osInfo.dwMajorVersion, (int)osInfo.dwMinorVersion);

return osinfo_buf;

}

//===========================================================================

// API: GetBlackboxPath

// Purpose: Copies the path of the Blackbox executable to the specified buffer

// In: LPSTR pszPath = Location of the buffer for the path

// In: int nMaxLen = Maximum length for the buffer

// Out: bool = Returns status of completion

//===========================================================================

LPSTR WINAPI GetBlackboxPath(LPSTR pszPath, int nMaxLen)

{

GetModuleFileName(NULL, pszPath, nMaxLen);

*(char*)get_file(pszPath) = 0;

return pszPath;

}

//===========================================================================

// Function: NextToken

// Purpose: Copy the first token of 'string' seperated by the delim to 'buf'

// and move the rest of 'string' down.

// returns: 'buf'

//===========================================================================

// API: Tokenize

// Purpose: Retrieve the first string seperated by the delim and return a pointer to the rest of the string

// In: LPCSTR string = String to be parsed

// In: LPSTR buf = String where the tokenized string will be placed

// In: LPSTR delims = The delimeter that signifies the seperation of the tokens in the string

// Out: LPSTR = Returns a pointer to the entire remaining string

//===========================================================================

// API: BBTokenize

// Purpose: Assigns a specified number of string variables and outputs the remaining to a variable

// In: LPCSTR szString = The string to be parsed

// In: LPSTR lpszBuffers[] = A pointer to the location for the tokenized strings

// In: DWORD dwNumBuffers = The amount of tokens to be parsed

// In: LPSTR szExtraParameters = A pointer to the location for the remaining string

// Out: int = Number of tokens parsed

//===========================================================================

// API: StrRemoveEncap

// Purpose: Removes the first and last characters of a string

// In: LPSTR string = The string to be altered

// Out: LPSTR = A pointer to the altered string

//===========================================================================

// API: IsInString

// Purpose: Checks a given string to an occurance of the second string

// In: LPCSTR = string to search

// In: LPCSTR = string to search for

// Out: bool = found or not

//===========================================================================

// tiny cache reader: first checks, if the file had already been read, if not,

// reads the file into a malloc'ed buffer, then for each line separates

// keyword from value, cuts off leading and trailing spaces, strlwr's the

// keyword and adds both to a list of below defined structures, where k is

// the offset to the start of the value-string. Comments or other non-keyword

// lines have a "" keyword and the line as value.

// added checking for external updates by the user.

// added *wild*card* processing, it first looks for an exact match, if it

// cant find any, returns the first wildcard value, that matches, or null,

// if none...

//===========================================================================

// API: FoundLastValue

// Purpose: Was the last read value actually in the rc-file?

// returns: 0=no 1=yes 2=wildcard matched

//===========================================================================

// API: ReadValue

// Purpose: Searches the given file for the supplied keyword and returns a

// pointer to the value - string

// In: LPCSTR path = String containing the name of the file to be opened

// In: LPCSTR szKey = String containing the keyword to be looked for

// In: LONG ptr: optional: an index into the file to start search.

// Out: LPSTR = Pointer to the value string of the keyword

//===========================================================================

// API: DeleteSetting

bool DeleteSetting(LPCSTR path, LPCSTR szKey)

//===========================================================================

// API: RenameSetting

bool RenameSetting(LPCSTR path, LPCSTR szKey, LPCSTR new_keyword)

//===========================================================================

// API: WriteString

void WriteString(LPCSTR fileName, LPCSTR szKey, LPCSTR value)

// API: WriteBool

void WriteBool(LPCSTR fileName, LPCSTR szKey, bool value)

// API: WriteInt

void WriteInt(LPCSTR fileName, LPCSTR szKey, int value)

// API: WriteColor

void WriteColor(LPCSTR fileName, LPCSTR szKey, COLORREF value)

//===========================================================================

// API: ReadBool

bool ReadBool(LPCSTR fileName, LPCSTR szKey, bool bDefault)

// API: ReadInt

int ReadInt(LPCSTR fileName, LPCSTR szKey, int nDefault)

// API: ReadString

LPCSTR ReadString(LPCSTR fileName, LPCSTR szKey, LPCSTR szDefault)

// API: ReadColor

COLORREF ReadColor(LPCSTR fileName, LPCSTR szKey, LPCSTR defaultString)

//===========================================================================

// API: FileExists

// Purpose: Checks for a files existence

// In: LPCSTR = file to set as check for

// Out: bool = whether found or not

//===========================================================================

// API: FileOpen

// Purpose: Opens file for parsing

// In: LPCSTR = file to open

// Out: FILE* = the file itself

//===========================================================================

// API: FileClose

// Purpose: Close selected file

// In: FILE *fp = The file you wish to close

// Out: bool = Returns the status of completion

//===========================================================================

// API: FileRead

// Purpose: Read's a line from given FILE and returns boolean on status

// In: FILE *stream = FILE to parse

// In: LPSTR string = Pointer to returned line from the file

// Out: bool = Status (true if read, false if not)

//===========================================================================

// API: ReadNextCommand

// Purpose: Reads the next line of the file

// In: FILE* = File to be parsed

// In: LPSTR = buffer to assign next line to

// DWORD = maximum size of line to be outputted

// Out: bool = whether there was a next line to parse

//===========================================================================

// API: ReplaceShellFolders

// Purpose: replace shell folders in a string path, like DESKTOP\...

//===========================================================================

// API: ReplaceEnvVars

// Purpose: parses a given string and replaces all %VAR% with the environment

// variable value if such a value exists

// In: LPSTR = string to replace env vars in

// Out: void = None

//===========================================================================

// API: GetBlackboxEditor

//===========================================================================

void GetBlackboxEditor(LPSTR editor)

//===========================================================================

// API: FindConfigFile

// Purpose: Look for a config file in the Blackbox, UserAppData and

// (optionally) plugin directories

// In: LPSTR = pszOut = the location where to put the result

// In: LPCSTR = filename to look for, LPCSTR = plugin directory or NULL

// Out: bool = true of found, FALSE otherwise

//===========================================================================

// API: ConfigFileExists

//===========================================================================

LPCSTR ConfigFileExists(LPCSTR filename, LPCSTR pluginDir)

//===========================================================================

// API: bbrcPath

// Purpose: Returns the handle to the blackboxrc file that is being used

// In: LPCSTR = file to set as default bbrc file (defaults to NULL if not specified)