CIconWatcher Class Reference

Inheritance diagram for CIconWatcher:

Collaboration diagram for CIconWatcher:

Public Member Functions
	CIconWatcher ()
virtual	~CIconWatcher ()
bool	Initialize (_In_ HWND hWndParent)
void	Uninitialize ()
bool	AddIconToWatcher (_In_ CONST NOTIFYICONDATA *iconData)
bool	RemoveIconFromWatcher (_In_ CONST NOTIFYICONDATA *iconData)
IconWatcherData *	GetListEntry (_In_opt_ CONST NOTIFYICONDATA *iconData, _In_opt_ HANDLE hProcess, _In_ bool Remove)

Static Private Member Functions
static UINT WINAPI	WatcherThread (_In_opt_ LPVOID lpParam)

Private Attributes
CAtlList< IconWatcherData * >	m_WatcherList
CRITICAL_SECTION	m_ListLock
HANDLE	m_hWatcherThread
HANDLE	m_WakeUpEvent
HWND	m_hwndSysTray
bool	m_Loop

Detailed Description

Definition at line 61 of file syspager.cpp.

Constructor & Destructor Documentation

CIconWatcher()

CIconWatcher::CIconWatcher

(

)

Definition at line 282 of file syspager.cpp.

                           :
    m_hWatcherThread(NULL),
    m_WakeUpEvent(NULL),
    m_hwndSysTray(NULL),
    m_Loop(false)
{
}

~CIconWatcher()

CIconWatcher::~CIconWatcher ( )

virtual

Definition at line 290 of file syspager.cpp.

{
    Uninitialize();
    DeleteCriticalSection(&m_ListLock);
 
    if (m_WakeUpEvent)
        CloseHandle(m_WakeUpEvent);
    if (m_hWatcherThread)
        CloseHandle(m_hWatcherThread);
}

Member Function Documentation

AddIconToWatcher()

bool CIconWatcher::AddIconToWatcher

(

_In_ CONST NOTIFYICONDATA *

iconData

)

Definition at line 346 of file syspager.cpp.

{
    DWORD ProcessId;
    (void)GetWindowThreadProcessId(iconData->hWnd, &ProcessId);
 
    HANDLE hProcess;
    hProcess = OpenProcess(SYNCHRONIZE, FALSE, ProcessId);
    if (hProcess == NULL)
    {
        return false;
    }
 
    IconWatcherData *Icon = new IconWatcherData(iconData);
    Icon->hProcess = hProcess;
    Icon->ProcessId = ProcessId;
 
    bool Added = false;
    EnterCriticalSection(&m_ListLock);
 
    // The likelyhood of someone having more than 64 icons in their tray is
    // pretty slim. We could spin up a new thread for each multiple of 64, but
    // it's not worth the effort, so we just won't bother watching those icons
    if (m_WatcherList.GetCount() < MAXIMUM_WAIT_OBJECTS)
    {
        m_WatcherList.AddTail(Icon);
        SetEvent(m_WakeUpEvent);
        Added = true;
    }
 
    LeaveCriticalSection(&m_ListLock);
 
    if (!Added)
    {
        delete Icon;
    }
 
    return Added;
}

Referenced by CSysPagerWnd::NotifyIcon().

GetListEntry()

IconWatcherData * CIconWatcher::GetListEntry	(	_In_opt_ CONST NOTIFYICONDATA *	iconData,
		_In_opt_ HANDLE	hProcess,
		_In_ bool	Remove
	)

Definition at line 399 of file syspager.cpp.

{
    IconWatcherData *Entry = NULL;
    for (POSITION NextPosition = m_WatcherList.GetHeadPosition(); NextPosition;)
    {
        POSITION Position = NextPosition;
        Entry = m_WatcherList.GetNext(NextPosition); // Note: This will advance NextPosition
        if (Entry)
        {
            if ((iconData && ((Entry->IconData.hWnd == iconData->hWnd) && (Entry->IconData.uID == iconData->uID))) ||
                    (hProcess && (Entry->hProcess == hProcess)))
            {
                if (Remove)
                    m_WatcherList.RemoveAt(Position);
                return Entry;
            }
        }
    }
    return NULL;
}

Initialize()

bool CIconWatcher::Initialize

(

_In_ HWND

hWndParent

)

Definition at line 301 of file syspager.cpp.

{
    m_hwndSysTray = hWndParent;
 
    InitializeCriticalSection(&m_ListLock);
    m_WakeUpEvent = CreateEventW(NULL, FALSE, FALSE, NULL);
    if (m_WakeUpEvent == NULL)
        return false;
 
    m_hWatcherThread = (HANDLE)_beginthreadex(NULL,
                                                0,
                                                WatcherThread,
                                                (LPVOID)this,
                                                0,
                                                NULL);
    if (m_hWatcherThread == NULL)
        return false;
 
    return true;
}

Referenced by CSysPagerWnd::OnCreate().

RemoveIconFromWatcher()

bool CIconWatcher::RemoveIconFromWatcher

(

_In_ CONST NOTIFYICONDATA *

iconData

)

Definition at line 385 of file syspager.cpp.

{
    EnterCriticalSection(&m_ListLock);
 
    IconWatcherData *Icon;
    Icon = GetListEntry(iconData, NULL, true);
 
    SetEvent(m_WakeUpEvent);
    LeaveCriticalSection(&m_ListLock);
 
    delete Icon;
    return true;
}

Referenced by CSysPagerWnd::NotifyIcon().

Uninitialize()

void CIconWatcher::Uninitialize

(

)

Definition at line 322 of file syspager.cpp.

{
    m_Loop = false;
    if (m_WakeUpEvent)
        SetEvent(m_WakeUpEvent);
 
    EnterCriticalSection(&m_ListLock);
 
    POSITION Pos;
    for (size_t i = 0; i < m_WatcherList.GetCount(); i++)
    {
        Pos = m_WatcherList.FindIndex(i);
        if (Pos)
        {
            IconWatcherData *Icon;
            Icon = m_WatcherList.GetAt(Pos);
            delete Icon;
        }
    }
    m_WatcherList.RemoveAll();
 
    LeaveCriticalSection(&m_ListLock);
}

Referenced by CSysPagerWnd::OnDestroy().

WatcherThread()

UINT WINAPI CIconWatcher::WatcherThread ( _In_opt_ LPVOID  lpParam )

staticprivate

Definition at line 420 of file syspager.cpp.

{
    CIconWatcher* This = reinterpret_cast<CIconWatcher *>(lpParam);
    HANDLE *WatchList = NULL;
 
    This->m_Loop = true;
    while (This->m_Loop)
    {
        EnterCriticalSection(&This->m_ListLock);
 
        DWORD Size;
        Size = This->m_WatcherList.GetCount() + 1;
        ASSERT(Size <= MAXIMUM_WAIT_OBJECTS);
 
        if (WatchList)
            delete[] WatchList;
        WatchList = new HANDLE[Size];
        WatchList[0] = This->m_WakeUpEvent;
 
        POSITION Pos;
        for (size_t i = 0; i < This->m_WatcherList.GetCount(); i++)
        {
            Pos = This->m_WatcherList.FindIndex(i);
            if (Pos)
            {
                IconWatcherData *Icon;
                Icon = This->m_WatcherList.GetAt(Pos);
                WatchList[i + 1] = Icon->hProcess;
            }
        }
 
        LeaveCriticalSection(&This->m_ListLock);
 
        DWORD Status;
        Status = WaitForMultipleObjects(Size,
                                        WatchList,
                                        FALSE,
                                        INFINITE);
        if (Status == WAIT_OBJECT_0)
        {
            // We've been kicked, we have updates to our list (or we're exiting the thread)
            if (This->m_Loop)
                TRACE("Updating watched icon list\n");
        }
        else if ((Status >= WAIT_OBJECT_0 + 1) && (Status < Size))
        {
            IconWatcherData *Icon;
            Icon = This->GetListEntry(NULL, WatchList[Status], false);
 
            TRACE("Pid %lu owns a notification icon and has stopped without deleting it. We'll cleanup on its behalf\n", Icon->ProcessId);
 
            TRAYNOTIFYDATAW tnid = {0};
            tnid.dwSignature = NI_NOTIFY_SIG;
            tnid.dwMessage   = NIM_DELETE;
            CopyMemory(&tnid.nid, &Icon->IconData, Icon->IconData.cbSize);
 
            COPYDATASTRUCT data;
            data.dwData = 1;
            data.cbData = sizeof(tnid);
            data.lpData = &tnid;
 
            BOOL Success = ::SendMessage(This->m_hwndSysTray, WM_COPYDATA,
                                         (WPARAM)&Icon->IconData, (LPARAM)&data);
            if (!Success)
            {
                // If we failed to handle the delete message, forcibly remove it
                This->RemoveIconFromWatcher(&Icon->IconData);
            }
        }
        else
        {
            if (Status == WAIT_FAILED)
            {
                Status = GetLastError();
            }
            ERR("Failed to wait on process handles : %lu\n", Status);
            This->Uninitialize();
        }
    }
 
    if (WatchList)
        delete[] WatchList;
 
    return 0;
}

Member Data Documentation

m_hWatcherThread

HANDLE CIconWatcher::m_hWatcherThread

private

Definition at line 65 of file syspager.cpp.

m_hwndSysTray

HWND CIconWatcher::m_hwndSysTray

private

Definition at line 67 of file syspager.cpp.

m_ListLock

CRITICAL_SECTION CIconWatcher::m_ListLock

private

Definition at line 64 of file syspager.cpp.

m_Loop

bool CIconWatcher::m_Loop

private

Definition at line 68 of file syspager.cpp.

m_WakeUpEvent

HANDLE CIconWatcher::m_WakeUpEvent

private

Definition at line 66 of file syspager.cpp.

m_WatcherList

CAtlList<IconWatcherData *> CIconWatcher::m_WatcherList

private

Definition at line 63 of file syspager.cpp.

---

The documentation for this class was generated from the following file:

• base/shell/explorer/syspager.cpp