SFocusManager.cpp

#include "souistd.h"
#include "core/SFocusManager.h"
#include "core/SWindowMgr.h"
#include "core/SAccelerator.h"
 
#pragma warning(disable : 4800)
 
SNSBEGIN
 
FocusSearch::FocusSearch(SWindow *root, bool cycle)
    : root_(root)
    , cycle_(cycle)
{
}
 
SWindow *FocusSearch::FindNextFocusableView(SWindow *starting_view, bool reverse, bool check_starting_view)
{
    if (root_->GetChildrenCount() == 0)
        return NULL;
 
    if (!starting_view)
    {
        if (reverse)
        {
            starting_view = root_->GetWindow(GSW_LASTCHILD);
            while (starting_view->GetChildrenCount())
                starting_view = starting_view->GetWindow(GSW_LASTCHILD);
        }
        else
        {
            starting_view = root_->GetWindow(GSW_FIRSTCHILD);
        }
        check_starting_view = true;
    }
 
    SWindow *pRet = NULL;
    SWindow *pStartGroupOwner = NULL;
    if (starting_view && starting_view->IsSiblingsAutoGroupped())
        pStartGroupOwner = starting_view->GetParent();
 
    if (reverse)
    {
        bool can_go_down = !IsFocusable(starting_view);
        pRet = FindPreviousFocusableViewImpl(starting_view, check_starting_view, true, can_go_down, pStartGroupOwner);
    }
    else
    {
        pRet = FindNextFocusableViewImpl(starting_view, check_starting_view, true, true, pStartGroupOwner);
    }
    if (!pRet && cycle_ && starting_view)
    {
        cycle_ = false;
        pRet = FindNextFocusableView(NULL, reverse, false);
    }
    return pRet;
}
 
// Strategy for finding the next focusable view:
// - keep going down the first child, stop when you find a focusable view or
//   a focus traversable view (in that case return it) or when you reach a view
//   with no children.
// - go to the right sibling and start the search from there (by invoking
//   FindNextFocusableViewImpl on that view).
// - if the view has no right sibling, go up the parents until you find a parent
//   with a right sibling and start the search from there.
SWindow *FocusSearch::FindNextFocusableViewImpl(SWindow *starting_view, bool check_starting_view, bool can_go_up, bool can_go_down, SWindow *pSkipGroupOwner)
{
    if (check_starting_view)
    {
        if (IsViewFocusableCandidate(starting_view, pSkipGroupOwner))
        {
            SWindow *v = starting_view->GetSelectedSiblingInGroup();
            if (!v)
                v = starting_view;
            // The selected view might not be focusable (if it is disabled for
            // example).
            if (IsFocusable(v))
            {
                return v;
            }
        }
    }
 
    // First let's try the left child.
    if (can_go_down)
    {
        SWindow *pChild = starting_view->GetWindow(GSW_FIRSTCHILD);
        if (pChild)
        {
            SWindow *v = FindNextFocusableViewImpl(pChild, true, false, true, pSkipGroupOwner);
            if (v)
            {
                return v;
            }
        }
    }
 
    // Then try the right sibling.
    SWindow *sibling = starting_view->GetWindow(GSW_NEXTSIBLING);
    if (sibling)
    {
        SWindow *v = FindNextFocusableViewImpl(sibling, true, false, true, pSkipGroupOwner);
        if (v)
        {
            return v;
        }
    }
 
    // Then go up to the parent sibling.
    if (can_go_up)
    {
        SWindow *parent = starting_view->GetParent();
        while (parent)
        {
            sibling = parent->GetWindow(GSW_NEXTSIBLING);
            if (sibling)
            {
                return FindNextFocusableViewImpl(sibling, true, true, true, pSkipGroupOwner);
            }
            parent = parent->GetParent();
        }
    }
 
    // We found nothing.
    return NULL;
}
 
// Strategy for finding the previous focusable view:
// - keep going down on the right until you reach a view with no children, if it
//   it is a good candidate return it.
// - start the search on the left sibling.
// - if there are no left sibling, start the search on the parent (without going
//   down).
SWindow *FocusSearch::FindPreviousFocusableViewImpl(SWindow *starting_view, bool check_starting_view, bool can_go_up, bool can_go_down, SWindow *pSkipGroupOwner)
{
    if (can_go_down)
    { // find the last focusable window
        SWindow *pChild = starting_view->GetWindow(GSW_LASTCHILD);
        if (pChild)
        {
            SWindow *pRet = FindPreviousFocusableViewImpl(pChild, true, false, true, pSkipGroupOwner);
            if (pRet)
                return pRet;
        }
    }
 
    if (check_starting_view && IsViewFocusableCandidate(starting_view, pSkipGroupOwner))
    {
        SWindow *v = starting_view->GetSelectedSiblingInGroup();
        if (!v)
            v = starting_view;
        // The selected view might not be focusable (if it is disabled for example).
        if (IsFocusable(v))
        {
            return v;
        }
    }
 
    SWindow *pPrevSibling = starting_view->GetWindow(GSW_PREVSIBLING);
    if (pPrevSibling)
    {
        return FindPreviousFocusableViewImpl(pPrevSibling, true, true, true, pSkipGroupOwner);
    }
    if (can_go_up)
    {
        SWindow *pParent = starting_view->GetWindow(GSW_PARENT);
        if (pParent)
            return FindPreviousFocusableViewImpl(pParent, true, true, false, pSkipGroupOwner);
    }
 
    return NULL;
}
 
bool FocusSearch::IsViewFocusableCandidate(SWindow *v, SWindow *pGroupOwner)
{
    if (!IsFocusable(v))
        return false;
    if (pGroupOwner && v->IsSiblingsAutoGroupped() && v->GetParent() == pGroupOwner)
        return false;
    return true;
}
 
bool FocusSearch::IsFocusable(const SWindow *view) const
{
    if (!view)
        return false;
    return view->IsFocusable() && view->IsVisible(TRUE) && !view->IsDisabled(TRUE);
}
 
//////////////////////////////////////////////////////////////////////////
SFocusManager::SFocusManager()
    : m_pOwner(NULL)
    , focused_view_(0)
    , focused_backup_(0)
{
}
 
SFocusManager::~SFocusManager(void)
{
}
 
void SFocusManager::SetOwner(SWindow *pOwner)
{
    m_pOwner = pOwner;
}
 
BOOL SFocusManager::IsTabTraversalKey(UINT vKey)
{
    if (vKey != VK_TAB)
        return FALSE;
    SWindow *pFocus = SWindowMgr::GetWindow(focused_view_);
    if (pFocus && pFocus->OnGetDlgCode() & SC_WANTTAB)
        return FALSE;
    if (GetKeyState(VK_CONTROL) & 0x8000)
        return FALSE;
    else
        return TRUE;
}
 
BOOL SFocusManager::OnKeyDown(UINT vKey)
{
    // tab traversal
    if (IsTabTraversalKey(vKey))
    {
        AdvanceFocus(GetKeyState(VK_SHIFT) & 0x8000);
        return TRUE;
    }
 
    // Intercept arrow key messages to switch between grouped views.
    SWindow *pFocusWnd = SWindowMgr::GetWindow(focused_view_);
    if (pFocusWnd && pFocusWnd->IsSiblingsAutoGroupped() && (vKey == VK_LEFT || vKey == VK_RIGHT || vKey == VK_UP || vKey == VK_DOWN))
    {
        UINT ucode = (vKey == VK_RIGHT || vKey == VK_DOWN) ? GSW_NEXTSIBLING : GSW_PREVSIBLING;
        SWindow *pNext = pFocusWnd->GetWindow(ucode);
        while (pNext)
        {
            if (pNext->IsSiblingsAutoGroupped())
            {
                SetFocusedHwndWithReason(pNext->GetSwnd(), kReasonFocusTraversal);
                break;
            }
            pNext = pNext->GetWindow(ucode);
        }
        if (!pNext)
        {
            pNext = pFocusWnd->GetParent()->GetWindow(ucode == GSW_NEXTSIBLING ? GSW_FIRSTCHILD : GSW_LASTCHILD);
            while (pNext)
            {
                if (pNext->IsSiblingsAutoGroupped())
                {
                    SetFocusedHwndWithReason(pNext->GetSwnd(), kReasonFocusTraversal);
                    break;
                }
                pNext = pNext->GetWindow(ucode);
            }
        }
        return TRUE;
    }
    // Process keyboard accelerators.
    SAccelerator accelerator(vKey, GetKeyState(VK_CONTROL) & 0x8000, GetKeyState(VK_MENU) & 0x8000, GetKeyState(VK_SHIFT) & 0x8000);
    if (ProcessAccelerator(&accelerator))
    {
        // If a shortcut was activated for this keydown message, do not propagate
        // the event further.
        return TRUE;
    }
 
    return FALSE;
}
 
void SFocusManager::AdvanceFocus(bool reverse)
{
    // Let's revalidate the focused view.
    ValidateFocusedView();
    SWindow *pFocus = SWindowMgr::GetWindow(focused_view_);
    SWindow *pSwnd = GetNextFocusableView(pFocus, reverse, true);
    if (pSwnd)
    {
        SetFocusedHwndWithReason(pSwnd->GetSwnd(), kReasonFocusTraversal);
    }
}
 
SWindow *SFocusManager::GetNextFocusableView(SWindow *original_starting_view, bool bReverse, bool bLoop)
{
 
    FocusSearch fs(m_pOwner, bLoop);
    return fs.FindNextFocusableView(original_starting_view, bReverse, false);
}
 
void SFocusManager::SetFocusedHwndWithReason(SWND swnd, FocusChangeReason reason)
{
    if (swnd == focused_view_)
    {
        if (swnd == 0 && focused_backup_)
        { // clear focus
            focused_backup_ = swnd;
        }
        return;
    }
 
    if (focused_backup_ != 0)
    { //当前是在最小化状态,直接修改状态
        focused_backup_ = swnd;
        return;
    }
 
    // Update the reason for the focus change (since this is checked by
    // some listeners), then notify all listeners.
    SWindow *pOldFocus = SWindowMgr::GetWindow(focused_view_);
    SWindow *pNewFocus = SWindowMgr::GetWindow(swnd);
 
    focus_change_reason_ = reason;
    focused_view_ = 0;
    if (pOldFocus)
    {
        pOldFocus->SSendMessage(WM_KILLFOCUS, (WPARAM)swnd);
    }
    if (pNewFocus && !pNewFocus->IsDisabled(TRUE) && pNewFocus->IsFocusable())
    {
        focused_view_ = swnd;
        pNewFocus->SSendMessage(WM_SETFOCUS, (WPARAM)focused_view_, (LPARAM)reason);
    }
}
 
void SFocusManager::SetFocusedHwnd(SWND swnd)
{
    SetFocusedHwndWithReason(swnd, kReasonDirectFocusChange);
}
 
void SFocusManager::ValidateFocusedView()
{
    if (focused_view_)
    {
        SWindow *pFocus = SWindowMgr::GetWindow(focused_view_);
        if (pFocus)
        {
            pFocus = pFocus->GetRoot();
            if (pFocus != m_pOwner)
            {
                focused_view_ = 0;
            }
        }
        else
        {
            focused_view_ = 0;
        }
    }
}
 
void SFocusManager::ClearFocus()
{
    SetFocusedHwnd(0);
}
 
SWND SFocusManager::GetFocusedHwnd() const
{
    return focused_view_;
}
 
void SFocusManager::StoreFocusedView()
{
    ValidateFocusedView();
    focused_backup_ = focused_view_;
    focused_view_ = 0;
    SWindow *pWnd = SWindowMgr::GetWindow(focused_backup_);
 
    if (pWnd)
    {
        pWnd->SSendMessage(WM_KILLFOCUS);
    }
    else
    {
        focused_backup_ = -1; //标识一下当前是最小化状态
    }
}
 
void SFocusManager::RestoreFocusedView()
{
    SWindow *pWnd = SWindowMgr::GetWindow(focused_backup_);
    if (pWnd && !pWnd->IsDisabled(TRUE) && pWnd->IsVisible(TRUE))
    {
        focused_view_ = focused_backup_;
        pWnd->SSendMessage(WM_SETFOCUS, 0, (LPARAM)kReasonFocusRestore);
    }
    focused_backup_ = 0;
}
 
void SFocusManager::RegisterAccelerator(const IAccelerator *pAcc, IAcceleratorTarget *target)
{
    DWORD dwAcc = pAcc->GetAcc();
    AcceleratorTargetList &targets = accelerators_[dwAcc];
    targets.AddHead(target);
}
 
void SFocusManager::UnregisterAccelerator(const IAccelerator *pAcc, IAcceleratorTarget *target)
{
    DWORD dwAcc = pAcc->GetAcc();
    if (!accelerators_.Lookup(dwAcc))
        return;
    AcceleratorTargetList *targets = &accelerators_[dwAcc];
    SPOSITION pos = targets->Find(target);
    if (pos)
        targets->RemoveAt(pos);
}
 
void SFocusManager::UnregisterAccelerators(IAcceleratorTarget *target)
{
    SPOSITION pos = accelerators_.GetStartPosition();
    while (pos)
    {
        AcceleratorTargetList &targets = accelerators_.GetValueAt(pos);
        SPOSITION pos2 = targets.Find(target);
        if (pos2)
            targets.RemoveAt(pos2);
        accelerators_.GetNext(pos);
    }
}
 
bool SFocusManager::ProcessAccelerator(const IAccelerator *pAcc)
{
    DWORD dwAcc = pAcc->GetAcc();
    if (!accelerators_.Lookup(dwAcc))
        return false;
 
    // We have to copy the target list here, because an AcceleratorPressed
    // event handler may modify the list.
    AcceleratorTargetList targets = accelerators_[dwAcc];
 
    SPOSITION pos = targets.GetHeadPosition();
 
    while (pos)
    {
        IAcceleratorTarget *pTarget = targets.GetNext(pos);
        if (pTarget->OnAcceleratorPressed(pAcc))
        {
            return true;
        }
    }
    return false;
}
SNSEND