utility.h File Reference

#include <stdarg.h>
#include <windef.h>
#include <winbase.h>
#include <winuser.h>
#include <tchar.h>
#include <windowsx.h>
#include <commctrl.h>
#include <objbase.h>
#include <assert.h>
#include <stdio.h>

Include dependency graph for utility.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	WIN32_LEAN_AND_MEAN
#define	WIN32_EXTRA_LEAN
#define	WIN32_NO_STATUS
#define	_INC_WINDOWS
#define	COM_NO_WINDOWS_H
#define	_MAX_DRIVE   3
#define	_MAX_FNAME   256
#define	_MAX_DIR   _MAX_FNAME
#define	_MAX_EXT   _MAX_FNAME
#define	_MAX_PATH   260
#define	W_VER_NT   0
#define	for   if (0) {} else for
#define	COUNTOF(x)   (sizeof(x)/sizeof(x[0]))
#define	BUFFER_LEN   2048
#define	LOG(txt)   _log_(txt)
#define	LONGLONGARG   TEXT("L")
#define	_tcsrchr   strrchr
#define	_stprintf   sprintf
#define	U2A(s, d, l)   WideCharToMultiByte(CP_ACP, 0, s, -1, d, l, NULL, NULL)
#define	U2nA(s, d, l)   WideCharToMultiByte(CP_ACP, 0, s, l, d, l, NULL, NULL)
#define	A2U(s, d, l)   MultiByteToWideChar(CP_ACP, 0, s, -1, d, l)
#define	A2nU(s, d, l)   MultiByteToWideChar(CP_ACP, 0, s, l, d, l)
#define	FILE_ATTRIBUTE_ENCRYPTED   0x00000040
#define	FILE_ATTRIBUTE_SPARSE_FILE   0x00000200
#define	FILE_ATTRIBUTE_REPARSE_POINT   0x00000400
#define	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED   0x00002000
#define	SetDlgCtrlID(hwnd, id)   SetWindowLongPtr(hwnd, GWL_ID, id)
#define	SetWindowStyle(hwnd, val)   (DWORD)SetWindowLongPtr(hwnd, GWL_STYLE, val)
#define	SetWindowExStyle(h, val)   (DWORD)SetWindowLongPtr(hwnd, GWL_EXSTYLE, val)
#define	Window_SetIcon(hwnd, type, hicon)   (HICON)SendMessage(hwnd, WM_SETICON, type, (LPARAM)(hicon))
#define	strcpy_s(d, l, s)   strcpy(d, s)
#define	wcscpy_s(d, l, s)   wcscpy(d, s)
#define	wcsncpy_s(d, l, s, n)   wcsncpy(d, s, n)
#define	_wsplitpath_s(f, d, dl, p, pl, n, nl, e, el)   _wsplitpath(f, d, p, n, e)
#define	_splitpath_s(f, d, dl, p, pl, n, nl, e, el)   _splitpath(f, d, p, n, e)
#define	_stprintf_s1(b, l, f, p1)   _stprintf(b, f, p1)
#define	_stprintf_s2(b, l, f, p1, p2)   _stprintf(b, f, p1,p2)

Functions
void	_log_ (LPCTSTR txt)
void	CenterWindow (HWND hwnd)
void	MoveVisible (HWND hwnd)
void	display_error (HWND hwnd, DWORD error)
BOOL	time_to_filetime (const time_t *t, FILETIME *ftime)
int	find_window_class (LPCTSTR classname)
BOOL	RecursiveCreateDirectory (LPCTSTR path_in)
DWORD	RegGetDWORDValue (HKEY root, LPCTSTR path, LPCTSTR valueName, DWORD def)
BOOL	RegSetDWORDValue (HKEY root, LPCTSTR path, LPCTSTR valueName, DWORD value)
BOOL	exists_path (LPCTSTR path)

Macro Definition Documentation

_INC_WINDOWS

#define _INC_WINDOWS

Definition at line 32 of file utility.h.

_MAX_DIR

#define _MAX_DIR   _MAX_FNAME

Definition at line 75 of file utility.h.

_MAX_DRIVE

#define _MAX_DRIVE   3

Definition at line 73 of file utility.h.

_MAX_EXT

#define _MAX_EXT   _MAX_FNAME

Definition at line 76 of file utility.h.

_MAX_FNAME

#define _MAX_FNAME   256

Definition at line 74 of file utility.h.

_MAX_PATH

#define _MAX_PATH   260

Definition at line 77 of file utility.h.

_splitpath_s

#define _splitpath_s	(		f,
			d,
			dl,
			p,
			pl,
			n,
			nl,
			e,
			el
	)		_splitpath(f, d, p, n, e)

Definition at line 212 of file utility.h.

_stprintf

#define _stprintf   sprintf

Definition at line 124 of file utility.h.

_stprintf_s1

#define _stprintf_s1	(		b,
			l,
			f,
			p1
	)		_stprintf(b, f, p1)

Definition at line 215 of file utility.h.

_stprintf_s2

#define _stprintf_s2	(		b,
			l,
			f,
			p1,
			p2
	)		_stprintf(b, f, p1,p2)

Definition at line 216 of file utility.h.

_tcsrchr

#define _tcsrchr   strrchr

Definition at line 116 of file utility.h.

_wsplitpath_s

#define _wsplitpath_s	(		f,
			d,
			dl,
			p,
			pl,
			n,
			nl,
			e,
			el
	)		_wsplitpath(f, d, p, n, e)

Definition at line 211 of file utility.h.

A2nU

#define A2nU	(		s,
			d,
			l
	)		MultiByteToWideChar(CP_ACP, 0, s, l, d, l)

Definition at line 131 of file utility.h.

A2U

#define A2U	(		s,
			d,
			l
	)		MultiByteToWideChar(CP_ACP, 0, s, -1, d, l)

Definition at line 130 of file utility.h.

BUFFER_LEN

#define BUFFER_LEN   2048

Definition at line 97 of file utility.h.

COM_NO_WINDOWS_H

#define COM_NO_WINDOWS_H

Definition at line 33 of file utility.h.

COUNTOF

#define COUNTOF

(

x

)

(sizeof(x)/sizeof(x[0]))

Definition at line 93 of file utility.h.

FILE_ATTRIBUTE_ENCRYPTED

#define FILE_ATTRIBUTE_ENCRYPTED   0x00000040

Definition at line 145 of file utility.h.

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED

#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED   0x00002000

Definition at line 148 of file utility.h.

FILE_ATTRIBUTE_REPARSE_POINT

#define FILE_ATTRIBUTE_REPARSE_POINT   0x00000400

Definition at line 147 of file utility.h.

FILE_ATTRIBUTE_SPARSE_FILE

#define FILE_ATTRIBUTE_SPARSE_FILE   0x00000200

Definition at line 146 of file utility.h.

for

#define for   if (0) {} else for

Definition at line 88 of file utility.h.

LOG

#define LOG

(

txt

)

_log_(txt)

Definition at line 102 of file utility.h.

LONGLONGARG

#define LONGLONGARG   TEXT("L")

Definition at line 108 of file utility.h.

SetDlgCtrlID

#define SetDlgCtrlID	(		hwnd,
			id
	)		SetWindowLongPtr(hwnd, GWL_ID, id)

Definition at line 152 of file utility.h.

SetWindowExStyle

#define SetWindowExStyle	(		h,
			val
	)		(DWORD)SetWindowLongPtr(hwnd, GWL_EXSTYLE, val)

Definition at line 154 of file utility.h.

SetWindowStyle

#define SetWindowStyle	(		hwnd,
			val
	)		(DWORD)SetWindowLongPtr(hwnd, GWL_STYLE, val)

Definition at line 153 of file utility.h.

strcpy_s

#define strcpy_s	(		d,
			l,
			s
	)		strcpy(d, s)

Definition at line 200 of file utility.h.

U2A

#define U2A	(		s,
			d,
			l
	)		WideCharToMultiByte(CP_ACP, 0, s, -1, d, l, NULL, NULL)

Definition at line 128 of file utility.h.

U2nA

#define U2nA	(		s,
			d,
			l
	)		WideCharToMultiByte(CP_ACP, 0, s, l, d, l, NULL, NULL)

Definition at line 129 of file utility.h.

W_VER_NT

#define W_VER_NT   0

Definition at line 80 of file utility.h.

wcscpy_s

#define wcscpy_s	(		d,
			l,
			s
	)		wcscpy(d, s)

Definition at line 201 of file utility.h.

wcsncpy_s

#define wcsncpy_s	(		d,
			l,
			s,
			n
	)		wcsncpy(d, s, n)

Definition at line 202 of file utility.h.

WIN32_EXTRA_LEAN

#define WIN32_EXTRA_LEAN

Definition at line 30 of file utility.h.

WIN32_LEAN_AND_MEAN

#define WIN32_LEAN_AND_MEAN

Definition at line 29 of file utility.h.

WIN32_NO_STATUS

#define WIN32_NO_STATUS

Definition at line 31 of file utility.h.

Window_SetIcon

#define Window_SetIcon	(		hwnd,
			type,
			hicon
	)		(HICON)SendMessage(hwnd, WM_SETICON, type, (LPARAM)(hicon))

Definition at line 155 of file utility.h.

Function Documentation

_log_()

void _log_

(

LPCTSTR

txt

)

Definition at line 139 of file explorer.cpp.

{
    FmtString msg(TEXT("%s\n"), txt);
 
    if (g_Globals._log)
        _fputts(msg, g_Globals._log);
 
    OutputDebugString(msg);
}

CenterWindow()

void CenterWindow

(

HWND

hwnd

)

Definition at line 559 of file livecd.c.

{
    HWND hWndParent;
    RECT rcParent;
    RECT rcWindow;
 
    hWndParent = GetParent(hWnd);
    if (hWndParent == NULL)
        hWndParent = GetDesktopWindow();
 
    GetWindowRect(hWndParent, &rcParent);
    GetWindowRect(hWnd, &rcWindow);
 
    SetWindowPos(hWnd,
                 HWND_TOP,
                 ((rcParent.right - rcParent.left) - (rcWindow.right - rcWindow.left)) / 2,
                 ((rcParent.bottom - rcParent.top) - (rcWindow.bottom - rcWindow.top)) / 2,
                 0,
                 0,
                 SWP_NOSIZE);
}

Referenced by LocaleDlgProc(), and StartDlgProc().

display_error()

void display_error	(	HWND	hwnd,
		DWORD	error
	)

Definition at line 98 of file utility.cpp.

{
    PTSTR msg;
 
    if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
        0, error, MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT), (PTSTR)&msg, 0, NULL)) {
        LOG(FmtString(TEXT("display_error(%#x): %s"), error, msg));
 
        SetLastError(0);
        MessageBox(hwnd, msg, TEXT("ROS Explorer"), MB_OK);
 
        if (GetLastError() == ERROR_INVALID_WINDOW_HANDLE)
            MessageBox(0, msg, TEXT("ROS Explorer"), MB_OK);
    } else {
        LOG(FmtString(TEXT("Unknown Error %#x"), error));
 
        FmtString msg(TEXT("Unknown Error %#x"), error);
 
        SetLastError(0);
        MessageBox(hwnd, msg, TEXT("ROS Explorer"), MB_OK);
 
        if (GetLastError() == ERROR_INVALID_WINDOW_HANDLE)
            MessageBox(0, msg, TEXT("ROS Explorer"), MB_OK);
    }
 
    LocalFree(msg);
}

Referenced by StartMenu::ActivateEntry(), MainFrameBase::Command(), MDIMainFrame::Command(), ShellEntry::launch_entry(), and launch_file().

exists_path()

BOOL exists_path

(

LPCTSTR

path

)

Definition at line 489 of file utility.cpp.

{
    WIN32_FIND_DATA fd;
 
    HANDLE hfind = FindFirstFile(path, &fd);
 
    if (hfind != INVALID_HANDLE_VALUE) {
        FindClose(hfind);
 
        return TRUE;
    } else
        return FALSE;
}

Referenced by SplitFileSysURL().

find_window_class()

int find_window_class

(

LPCTSTR

classname

)

Definition at line 237 of file utility.cpp.

{
    EnumWindows(EnumWndProc, (LPARAM)classname);
 
    if (g_foundPrevInstance)
        return 1;
 
    return 0;
}

MoveVisible()

void MoveVisible

(

HWND

hwnd

)

Definition at line 72 of file utility.cpp.

{
    RECT rc;
    GetWindowRect(hwnd, &rc);
    int left=rc.left, top=rc.top;
 
    int xmax = GetSystemMetrics(SM_CXSCREEN);
    int ymax = GetSystemMetrics(SM_CYSCREEN);
 
    if (rc.left < 0)
        rc.left = 0;
    else if (rc.right > xmax)
        if ((rc.left-=rc.right-xmax) < 0)
            rc.left = 0;
 
    if (rc.top < 0)
        rc.top = 0;
    else if (rc.bottom > ymax)
        if ((rc.top-=rc.bottom-ymax) < 0)
            rc.top = 0;
 
    if (rc.left!=left || rc.top!=top)
        SetWindowPos(hwnd, 0, rc.left,rc.top, 0,0, SWP_NOZORDER|SWP_NOSIZE|SWP_NOACTIVATE);
}

Referenced by CenterWindow(), StartMenu::Create(), and ResizeManager::Resize().

RecursiveCreateDirectory()

BOOL RecursiveCreateDirectory

(

LPCTSTR

path_in

)

Definition at line 394 of file utility.cpp.

{
    TCHAR path[MAX_PATH], hole_path[MAX_PATH];
 
    _tcscpy(hole_path, path_in);
 
    int drv_len = 0;
    LPCTSTR d;
 
    for(d=hole_path; *d && *d!='/' && *d!='\\'; ++d) {
        ++drv_len;
 
        if (*d == ':')
            break;
    }
 
    LPTSTR dir = hole_path + drv_len;
 
    int l;
    LPTSTR p = hole_path + (l=_tcslen(hole_path));
 
    while(--p>=hole_path && (*p=='/' || *p=='\\'))
        *p = '\0';
 
    WIN32_FIND_DATA w32fd;
 
    HANDLE hFind = FindFirstFile(hole_path, &w32fd);
 
    if (hFind == INVALID_HANDLE_VALUE) {
        _tcsncpy(path, hole_path, drv_len);
        int i = drv_len;
 
        for(p=dir; *p=='/'||*p=='\\'; p++)
            path[i++] = *p++;
 
        for(; i<l; i++) {
            memcpy(path, hole_path, i*sizeof(TCHAR));
 
            for(; hole_path[i] && hole_path[i]!='/' && hole_path[i]!='\\'; i++)
                path[i] = hole_path[i];
 
            path[i] = '\0';
 
            hFind = FindFirstFile(path, &w32fd);
 
            if (hFind != INVALID_HANDLE_VALUE)
                FindClose(hFind);
            else {
                LOG(FmtString(TEXT("CreateDirectory(\"%s\")"), path));
 
                if (!CreateDirectory(path, 0))
                    return FALSE;
            }
        }
    } else
        FindClose(hFind);
 
    return TRUE;
}

Referenced by QuickLaunchBar::AddShortcuts(), and ExplorerGlobals::write_persistent().

RegGetDWORDValue()

DWORD RegGetDWORDValue	(	HKEY	root,
		LPCTSTR	path,
		LPCTSTR	valueName,
		DWORD	def
	)

Definition at line 455 of file utility.cpp.

{
    HKEY hkey;
    DWORD ret;
 
    if (!RegOpenKey(root, path, &hkey)) {
        DWORD len = sizeof(ret);
 
        if (RegQueryValueEx(hkey, valueName, 0, NULL, (LPBYTE)&ret, &len))
            ret = def;
 
        RegCloseKey(hkey);
 
        return ret;
    } else
        return def;
}

RegSetDWORDValue()

BOOL RegSetDWORDValue	(	HKEY	root,
		LPCTSTR	path,
		LPCTSTR	valueName,
		DWORD	value
	)

Definition at line 474 of file utility.cpp.

{
    HKEY hkey;
    BOOL ret = FALSE;
 
    if (!RegOpenKey(root, path, &hkey)) {
        ret = RegSetValueEx(hkey, valueName, 0, REG_DWORD, (LPBYTE)&value, sizeof(value));
 
        RegCloseKey(hkey);
    }
 
    return ret;
}

time_to_filetime()

BOOL time_to_filetime	(	const time_t *	t,
		FILETIME *	ftime
	)

Definition at line 159 of file utility.cpp.

{
#if defined(__STDC_WANT_SECURE_LIB__) && defined(_MS_VER)
    SYSTEMTIME stime;
    struct tm tm_;
    struct tm* tm = &tm_;
 
    if (gmtime_s(tm, t) != 0)
        return FALSE;
#else
    struct tm* tm = gmtime(t);
    SYSTEMTIME stime;
 
    if (!tm)
        return FALSE;
#endif
 
    stime.wYear = tm->tm_year+1900;
    stime.wMonth = tm->tm_mon+1;
    stime.wDayOfWeek = (WORD)-1;
    stime.wDay = tm->tm_mday;
    stime.wHour = tm->tm_hour;
    stime.wMinute = tm->tm_min;
    stime.wSecond = tm->tm_sec;
    stime.wMilliseconds = 0;
 
    return SystemTimeToFileTime(&stime, ftime);
}