caret.c File Reference

#include "precomp.h"

Go to the source code of this file.

Functions
BOOL	UT_CaretSet (PWND pwnd)
void	UT_InvertCaret ()
void	zzzInternalDestroyCaret ()
BOOL	zzzDestroyCaret ()
BOOL	xxxCreateCaret (PWND pwnd, HBITMAP hBitmap, int cx, int cy)
void	zzzInternalShowCaret ()
void	zzzInternalHideCaret ()
BOOL	zzzShowCaret (PWND pwnd)
BOOL	zzzHideCaret (PWND pwnd)
VOID	CaretBlinkProc (PWND pwnd, UINT message, UINT_PTR id, LPARAM lParam)
BOOL	_SetCaretBlinkTime (UINT cmsBlink)
BOOL	zzzSetCaretPos (int x, int y)

---

Function Documentation

BOOL _SetCaretBlinkTime (  UINT  cmsBlink  )

Definition at line 513 of file caret.c. References _KillSystemTimer(), _SetSystemTimer(), BOOL, tagQ::caret, CaretBlinkProc(), CheckWinstaWriteAttributesAccess(), FALSE, gpsi, tagCARET::hTimer, IDSYS_CARET, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, and TRUE. Referenced by xxxUpdatePerUserSystemParameters(). { PQ pq; PTHREADINFO ptiCurrent = PtiCurrent(); /* * Blow it off if the caller doesn't have the proper access rights */ if (!CheckWinstaWriteAttributesAccess()) { return FALSE; } gpsi->dtCaretBlink = cmsBlink; pq = ptiCurrent->pq; if (pq->caret.spwnd) { _KillSystemTimer(pq->caret.spwnd, IDSYS_CARET); pq->caret.hTimer = _SetSystemTimer(pq->caret.spwnd, IDSYS_CARET, gpsi->dtCaretBlink, CaretBlinkProc); } return TRUE; }

VOID CaretBlinkProc (  PWND  pwnd, UINT  message, UINT_PTR  id, LPARAM  lParam )

Definition at line 454 of file caret.c. References _KillSystemTimer(), tagQ::caret, tagCARET::fOn, tagCARET::fVisible, gbRemoteSession, gpsi, IDSYS_CARET, tagCARET::iHideLevel, PtiCurrent, tagCARET::spwnd, UT_InvertCaret(), and VOID(). Referenced by _SetCaretBlinkTime(), xxxCreateCaret(), and zzzSetCaretPos(). { PQ pq; /* * If this window doesn't even have a timer, just return. TRUE is * returned, which gets returned from DispatchMessage(). Why? Because * it is compatible with Win3. */ pq = PtiCurrent()->pq; if (pwnd != pq->caret.spwnd) return; /* * leave caret on, don't blink it off for remote sessions */ if (gbRemoteSession && (gpsi->dtCaretBlink >= 1200) && pq->caret.fOn && pq->caret.fVisible) { /* * Kill the timer for performance */ _KillSystemTimer(pq->caret.spwnd, IDSYS_CARET); return; } /* * Flip the logical cursor state. If the hide level permits it, flip * the physical state and draw the caret. */ pq->caret.fOn ^= 1; if (pq->caret.iHideLevel == 0) { pq->caret.fVisible ^= 1; UT_InvertCaret(); } return; DBG_UNREFERENCED_PARAMETER(message); DBG_UNREFERENCED_PARAMETER(id); DBG_UNREFERENCED_PARAMETER(lParam); }

BOOL UT_CaretSet (  PWND  pwnd  )

Definition at line 28 of file caret.c. References BOOL, tagQ::caret, FALSE, NULL, tagTHREADINFO::ppi, tagTHREADINFO::pq, PtiCurrent, PtiFromThreadId(), tagCARET::spwnd, tagCARET::tid, TIDq, TIF_16BIT, tagTHREADINFO::TIF_flags, and TRUE. Referenced by zzzDestroyCaret(), zzzHideCaret(), zzzSetCaretPos(), and zzzShowCaret(). { PQ pq; PTHREADINFO ptiCurrent; /* * Current queue have a caret? If not, return FALSE. */ ptiCurrent = PtiCurrent(); pq = ptiCurrent->pq; if (pq->caret.spwnd == NULL) { RIPERR0(ERROR_ACCESS_DENIED, RIP_VERBOSE, "Access denied in UT_CaretSet to current queue's caret"); return FALSE; } /* * If the current task does not own the caret, then return FALSE * but we let 32 bit multithreaded apps set the caret position from * a second thread for compatibility to our NT 3.1 BETAs */ if (pq->caret.tid != TIDq(ptiCurrent)) { PTHREADINFO ptiCursorOwner; ptiCursorOwner = PtiFromThreadId(pq->caret.tid); if ((ptiCurrent->TIF_flags & TIF_16BIT) || ptiCursorOwner == NULL || (ptiCurrent->ppi != ptiCursorOwner->ppi)) { RIPERR0(ERROR_ACCESS_DENIED, RIP_VERBOSE, "Access denied in UT_CaretSet"); return FALSE; } } /* * If pwnd == NULL, just checking to see if current queue has caret. * It does, so return TRUE. */ if (pwnd == NULL) return TRUE; /* * pwnd != NULL. Check to see if the caret is for pwnd. If so, return * TRUE. */ if (pwnd == pq->caret.spwnd) return TRUE; return FALSE; }

void UT_InvertCaret (   )

Definition at line 94 of file caret.c. References _ExcludeUpdateRgn(), _GetDC(), _ReleaseDC(), BOOL, tagQ::caret, tagCARET::cx, tagCARET::cy, FALSE, tagCARET::fVisible, ghbrWhite, ghdcMem, gpsi, tagCARET::hBitmap, tagWND::hrgnUpdate, IsVisible(), NULL, PtiCurrent, tagCARET::spwnd, TestWF, TRUE, WFWIN31COMPAT, tagCARET::x, and tagCARET::y. Referenced by CaretBlinkProc(), zzzInternalHideCaret(), zzzInternalShowCaret(), and zzzSetCaretPos(). { HDC hdc; PWND pwnd; PQ pq; HBITMAP hbmSave; BOOL fRestore; pq = PtiCurrent()->pq; pwnd = pq->caret.spwnd; if (pwnd == NULL || !IsVisible(pwnd)) { pq->caret.fVisible = FALSE; return; } /* * Don't have a dc. Get one for this window and draw the caret. */ hdc = _GetDC(pwnd); if (fRestore = (pwnd->hrgnUpdate ? TRUE : FALSE)) { GreSaveDC(hdc); if (TestWF(pwnd, WFWIN31COMPAT)) _ExcludeUpdateRgn(hdc, pwnd); } /* * If the caret bitmap is NULL, the caret is a white pattern invert * If the caret bitmap is == 1, the caret is a gray pattern. * If the caret bitmap is > 1, the caret is really a bitmap. */ if ((pq->caret.hBitmap) > (HBITMAP)1) { /* * The caret is a bitmap... SRCINVERT it onto the screen. */ hbmSave = GreSelectBitmap(ghdcMem, pq->caret.hBitmap); GreBitBlt(hdc, pq->caret.x, pq->caret.y, pq->caret.cx, pq->caret.cy, ghdcMem, 0, 0, SRCINVERT, 0); GreSelectBitmap(ghdcMem, hbmSave); } else { POLYPATBLT PolyData; /* * The caret is a pattern (gray or white). PATINVERT it onto the * screen. Remember to unrealize the gray object so it aligns * to the window correctly. * * Remove call to UnrealizeObject. GDI handles this on NT for * brushes. * * UnrealizeObject(hbrGray); */ PolyData.x = pq->caret.x; PolyData.y = pq->caret.y; PolyData.cx = pq->caret.cx; PolyData.cy = pq->caret.cy; if ((pq->caret.hBitmap) == (HBITMAP)1) { //hbrSave = GreSelectBrush(hdc, ghbrGray); PolyData.BrClr.hbr = gpsi->hbrGray; } else { //hbrSave = GreSelectBrush(hdc, ghbrWhite); PolyData.BrClr.hbr = ghbrWhite; } GrePolyPatBlt(hdc,PATINVERT,&PolyData,1,PPB_BRUSH); //GrePatBlt(hdc, pq->caret.x, pq->caret.y, pq->caret.cx, pq->caret.cy, // PATINVERT); // //GreSelectBrush(hdc,hbrSave); } if (fRestore) GreRestoreDC(hdc, -1); _ReleaseDC(hdc); }

BOOL xxxCreateCaret (  PWND  pwnd, HBITMAP  hBitmap, int  cx, int  cy )

Definition at line 254 of file caret.c. References _SetSystemTimer(), BOOL, tagQ::caret, CaretBlinkProc(), CheckLock, tagCARET::cx, cy, tagCARET::cy, DeferWinEventNotify, FALSE, tagCARET::fOn, tagCARET::fVisible, FWINABLE, GETPTI, gpsi, tagCARET::hBitmap, tagCARET::hTimer, IDSYS_CARET, tagCARET::iHideLevel, IsWinEventNotifyDeferredOK, Lock, NULL, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, SYSMET, tagCARET::tid, TIDq, TRUE, xxxWindowEvent(), zzzEndDeferWinEventNotify, and zzzInternalDestroyCaret(). Referenced by NtUserCreateCaret(), and xxxSBWndProc(). { PQ pq; BITMAP bitmap; PTHREADINFO ptiCurrent = PtiCurrent(); CheckLock(pwnd); UserAssert(IsWinEventNotifyDeferredOK()); pq = ptiCurrent->pq; /* * Don't allow the app to create a caret in a window * from another queue. */ if (GETPTI(pwnd)->pq != pq) { return FALSE; } /* * Defer WinEvent notifications to preserve pq */ DeferWinEventNotify(); if (pq->caret.spwnd != NULL) zzzInternalDestroyCaret(); Lock(&pq->caret.spwnd, pwnd); pq->caret.iHideLevel = 1; pq->caret.fOn = TRUE; pq->caret.fVisible = FALSE; pq->caret.tid = TIDq(ptiCurrent); if (cy == 0) cy = SYSMET(CYBORDER); if (cx == 0) cx = SYSMET(CXBORDER); if ((pq->caret.hBitmap = hBitmap) > (HBITMAP)1) { GreExtGetObjectW(hBitmap, sizeof(BITMAP), &bitmap); cy = bitmap.bmHeight; cx = bitmap.bmWidth; } pq->caret.cy = cy; pq->caret.cx = cx; pq->caret.hTimer = _SetSystemTimer(pwnd, IDSYS_CARET, gpsi->dtCaretBlink, CaretBlinkProc); UserAssert(pwnd == pq->caret.spwnd); zzzEndDeferWinEventNotify(); if (FWINABLE()) { /* * It's best to force this routine to be an xxx routine: that way we can * force pwnd to be locked and force notifications from within this routine * and all of the callers are happy with this. */ xxxWindowEvent(EVENT_OBJECT_CREATE, pwnd, OBJID_CARET, INDEXID_CONTAINER, 0); } return TRUE; }

BOOL zzzDestroyCaret (   )

Definition at line 234 of file caret.c. References BOOL, FALSE, NULL, TRUE, UT_CaretSet(), and zzzInternalDestroyCaret(). Referenced by xxxCheckFocus(), and xxxSBWndProc(). { if (UT_CaretSet(NULL)) { zzzInternalDestroyCaret(); return TRUE; } return FALSE; }

BOOL zzzHideCaret (  PWND  pwnd  )

Definition at line 434 of file caret.c. References BOOL, FALSE, TRUE, UT_CaretSet(), and zzzInternalHideCaret(). Referenced by NtUserHideCaret(), and xxxSBWndProc(). { if (UT_CaretSet(pwnd)) { zzzInternalHideCaret(); return TRUE; } return FALSE; }

void zzzInternalDestroyCaret (   )

Definition at line 189 of file caret.c. References _KillSystemTimer(), tagQ::caret, FWINABLE, tagCARET::hBitmap, tagCARET::hTimer, IDSYS_CARET, tagCARET::iHideLevel, NULL, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, ThreadLockWithPti, ThreadUnlock, Unlock, zzzInternalHideCaret(), and zzzWindowEvent. Referenced by xxxCreateCaret(), xxxDestroyWindow(), and zzzDestroyCaret(). { PQ pq; PTHREADINFO ptiCurrent = PtiCurrent(); PWND pwndCaret; TL tlpwndCaret; /* * Hide the caret, kill the timer, and null out the caret structure. */ zzzInternalHideCaret(); pq = ptiCurrent->pq; _KillSystemTimer(pq->caret.spwnd, IDSYS_CARET); pq->caret.hTimer = 0; pq->caret.hBitmap = NULL; pq->caret.iHideLevel = 0; pwndCaret = pq->caret.spwnd; if (pwndCaret != NULL) { /* * Threadlock caret's spwnd for WinEvent notification below */ ThreadLockWithPti(ptiCurrent, pwndCaret, &tlpwndCaret); Unlock(&pq->caret.spwnd); if (FWINABLE()) { zzzWindowEvent(EVENT_OBJECT_DESTROY, pwndCaret, OBJID_CARET, INDEXID_CONTAINER, 0); } ThreadUnlock(&tlpwndCaret); } }

void zzzInternalHideCaret (   )

Definition at line 376 of file caret.c. References tagQ::caret, FALSE, tagCARET::fVisible, FWINABLE, tagCARET::iHideLevel, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, UT_InvertCaret(), and zzzWindowEvent. Referenced by xxxBeginPaint(), xxxScrollWindowEx(), zzzHideCaret(), and zzzInternalDestroyCaret(). { PQ pq; PTHREADINFO ptiCurrent = PtiCurrent(); pq = ptiCurrent->pq; /* * If the caret is physically visible, invert it to turn off the bits. * Adjust the hide count upwards to remember this hide level. */ if (pq->caret.fVisible) UT_InvertCaret(); pq->caret.fVisible = FALSE; pq->caret.iHideLevel++; /* * Is the caret transitioning to being hidden? If so, iHideLevel is * going from 0 to 1. */ if (FWINABLE() && (pq->caret.iHideLevel == 1)) { zzzWindowEvent(EVENT_OBJECT_HIDE, pq->caret.spwnd, OBJID_CARET, INDEXID_CONTAINER, 0); } }

void zzzInternalShowCaret (   )

Definition at line 331 of file caret.c. References tagQ::caret, tagCARET::fOn, tagCARET::fVisible, FWINABLE, tagCARET::iHideLevel, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, UT_InvertCaret(), and zzzWindowEvent. Referenced by xxxEndPaint(), xxxScrollWindowEx(), and zzzShowCaret(). { PQ pq; PTHREADINFO ptiCurrent = PtiCurrent(); pq = ptiCurrent->pq; /* * If the caret hide level is aleady 0 (meaning it's ok to show) and the * caret is not physically on, try to invert now if it's turned on. */ if (pq->caret.iHideLevel == 0) { if (!pq->caret.fVisible) { if ((pq->caret.fVisible = pq->caret.fOn) != 0) { UT_InvertCaret(); } } return; } /* * Adjust the hide caret hide count. If we hit 0, we can show the * caret. Try to invert it if it's turned on. */ if (--pq->caret.iHideLevel == 0) { if ((pq->caret.fVisible = pq->caret.fOn) != 0) UT_InvertCaret(); if (FWINABLE()) { zzzWindowEvent(EVENT_OBJECT_SHOW, pq->caret.spwnd, OBJID_CARET, INDEXID_CONTAINER, 0); } } }

BOOL zzzSetCaretPos (  int  x, int  y )

Definition at line 550 of file caret.c. References _KillSystemTimer(), _SetSystemTimer(), BOOL, tagQ::caret, CaretBlinkProc(), FALSE, tagCARET::fOn, tagCARET::fVisible, FWINABLE, gpsi, tagCARET::hTimer, IDSYS_CARET, tagCARET::iHideLevel, NULL, tagTHREADINFO::pq, PtiCurrent, tagCARET::spwnd, TRUE, UT_CaretSet(), UT_InvertCaret(), tagCARET::x, tagCARET::y, and zzzWindowEvent. Referenced by zzzSetSBCaretPos(). { PQ pq; PTHREADINFO ptiCurrent = PtiCurrent(); /* * If this thread does not have the caret set, return FALSE. */ if (!UT_CaretSet(NULL)) { RIPERR0(ERROR_ACCESS_DENIED, RIP_VERBOSE, "Access denied in zzzSetCaretPos"); return FALSE; } /* * If the caret isn't changing position, do nothing (but return success). */ pq = ptiCurrent->pq; if (pq->caret.x == x && pq->caret.y == y) return TRUE; /* * If the caret is visible, turn it off while we move it. */ if (pq->caret.fVisible) UT_InvertCaret(); /* * Adjust to the new position. */ pq->caret.x = x; pq->caret.y = y; /* * Set a new timer so it'll blink in the new position dtCaretBlink * milliseconds from now. */ _KillSystemTimer(pq->caret.spwnd, IDSYS_CARET); pq->caret.hTimer = _SetSystemTimer(pq->caret.spwnd, IDSYS_CARET, gpsi->dtCaretBlink, CaretBlinkProc); pq->caret.fOn = TRUE; /* * Draw it immediately now if the hide level permits it. */ pq->caret.fVisible = FALSE; if (pq->caret.iHideLevel == 0) { pq->caret.fVisible = TRUE; UT_InvertCaret(); } if (FWINABLE()) { zzzWindowEvent(EVENT_OBJECT_LOCATIONCHANGE, pq->caret.spwnd, OBJID_CARET, INDEXID_CONTAINER, 0); } return TRUE; }

BOOL zzzShowCaret (  PWND  pwnd  )

Definition at line 413 of file caret.c. References BOOL, FALSE, TRUE, UT_CaretSet(), and zzzInternalShowCaret(). Referenced by NtUserShowCaret(), xxxEndScroll(), xxxSBTrackInit(), and xxxSBWndProc(). { if (UT_CaretSet(pwnd)) { zzzInternalShowCaret(); return TRUE; } return FALSE; }

---