/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#include <accessibility/vclxaccessiblebox.hxx>

#include <accessibility/vclxaccessibletextfield.hxx>

#include <accessibility/vclxaccessibleedit.hxx>

#include <accessibility/vclxaccessiblelist.hxx>

#include <com/sun/star/accessibility/AccessibleStateType.hpp>

#include <com/sun/star/accessibility/AccessibleEventId.hpp>

#include <com/sun/star/accessibility/AccessibleRole.hpp>

#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>

#include <vcl/accessibility/strings.hxx>

#include <vcl/vclevent.hxx>

#include <vcl/svapp.hxx>

#include <vcl/toolkit/combobox.hxx>

using namespace ::com::sun::star;

using namespace ::com::sun::star::uno;

using namespace ::com::sun::star::lang;

using namespace ::com::sun::star::beans;

using namespace ::com::sun::star::accessibility;

VCLXAccessibleBox::VCLXAccessibleBox(vcl::Window* pBox, BoxType aType, bool bIsDropDownBox)

    : ImplInheritanceHelper(pBox),

      m_aBoxType (aType),

      m_bIsDropDownBox (bIsDropDownBox)

{

    // Set up the flags that indicate which children this object has.

    m_bHasListChild = true;

    // A text field is not present for non drop down list boxes.

    if ((m_aBoxType==LISTBOX) && ! m_bIsDropDownBox)

        m_bHasTextChild = false;

    else

        m_bHasTextChild = true;

}

VCLXAccessibleBox::~VCLXAccessibleBox() {}

bool VCLXAccessibleBox::IsValid() const

{

    return GetWindow();

}

void VCLXAccessibleBox::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent )

{

    uno::Any aOldValue, aNewValue;

    switch ( rVclWindowEvent.GetId() )

    {

        case VclEventId::WindowShow:

        case VclEventId::WindowHide:

        {

            vcl::Window* pChildWindow = static_cast<vcl::Window *>(rVclWindowEvent.GetData());

            // Just compare to the combo box text field.  All other children

            // are identical to this object in which case this object will

            // be removed in a short time.

            if (m_aBoxType==COMBOBOX)

            {

                VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();

                if (pComboBox && pChildWindow && pChildWindow == pComboBox->GetSubEdit()

                    && m_xText.is())

                {

                    if (rVclWindowEvent.GetId() == VclEventId::WindowShow)

                    {

                        // Instantiate text field.

                        getAccessibleChild (0);

                        aNewValue <<= m_xText;

                    }

                    else

                    {

                        // Release text field.

                        aOldValue <<= m_xText;

                        m_xText = nullptr;

                    }

                    // Tell the listeners about the new/removed child.

                    NotifyAccessibleEvent (

                        AccessibleEventId::CHILD,

                        aOldValue, aNewValue);

                }

            }

        }

        break;

        default:

            VCLXAccessibleComponent::ProcessWindowChildEvent (rVclWindowEvent);

    }

}

void VCLXAccessibleBox::ProcessWindowEvent (const VclWindowEvent& rVclWindowEvent)

{

    switch ( rVclWindowEvent.GetId() )

    {

        case VclEventId::DropdownSelect:

        case VclEventId::ListboxSelect:

        {

            // Forward the call to the list child.

            if (!m_xList.is())

            {

                getAccessibleChild ( m_bHasTextChild ? 1 : 0 );

            }

            if (m_xList.is())

            {

                m_xList->ProcessWindowEvent(rVclWindowEvent, m_bIsDropDownBox);

#if defined(_WIN32)

                if (m_bIsDropDownBox)

                {

                    NotifyAccessibleEvent(AccessibleEventId::VALUE_CHANGED, Any(), Any());

                }

#endif

            }

            break;

        }

        case VclEventId::DropdownOpen:

        {

            if (!m_xList.is())

            {

                getAccessibleChild ( m_bHasTextChild ? 1 : 0 );

            }

            if (m_xList.is())

            {

                m_xList->ProcessWindowEvent(rVclWindowEvent);

                m_xList->HandleDropOpen();

            }

            break;

        }

        case VclEventId::DropdownClose:

        {

            if (!m_xList.is())

            {

                getAccessibleChild ( m_bHasTextChild ? 1 : 0 );

            }

            if (m_xList.is())

            {

                m_xList->ProcessWindowEvent(rVclWindowEvent);

            }

            VclPtr<vcl::Window> pWindow = GetWindow();

            if( pWindow && (pWindow->HasFocus() || pWindow->HasChildPathFocus()) )

            {

                Any aOldValue, aNewValue;

                aNewValue <<= AccessibleStateType::FOCUSED;

                NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );

            }

            break;

        }

        case VclEventId::ComboboxSelect:

        {

            if (m_xList.is() && m_xText.is())

            {

                Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);

                if ( xText.is() )

                {

                    OUString sText = xText->getSelectedText();

                    if ( sText.isEmpty() )

                        sText = xText->getText();

                    m_xList->UpdateSelection_Acc(sText, m_bIsDropDownBox);

#if defined(_WIN32)

                    if (m_bIsDropDownBox || m_aBoxType==COMBOBOX)

                        NotifyAccessibleEvent(AccessibleEventId::VALUE_CHANGED, Any(), Any());

#endif

                }

            }

            break;

        }

        //case VclEventId::DropdownOpen:

        //case VclEventId::DropdownClose:

        case VclEventId::ListboxDoubleClick:

        case VclEventId::ListboxScrolled:

        //case VclEventId::ListboxSelect:

        case VclEventId::ListboxItemAdded:

        case VclEventId::ListboxItemRemoved:

        case VclEventId::ComboboxItemAdded:

        case VclEventId::ComboboxItemRemoved:

        {

            // Forward the call to the list child.

            if (!m_xList.is())

            {

                getAccessibleChild ( m_bHasTextChild ? 1 : 0 );

            }

            if (m_xList.is())

                m_xList->ProcessWindowEvent(rVclWindowEvent);

            break;

        }

        //case VclEventId::ComboboxSelect:

        case VclEventId::ComboboxDeselect:

        {

            // Selection is handled by VCLXAccessibleList which operates on

            // the same VCL object as this box does.  In case of the

            // combobox, however, we have to help by providing the list with

            // the text of the currently selected item.

            if (m_xList.is() && m_xText.is())

            {

                Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);

                if ( xText.is() )

                {

                    OUString sText = xText->getSelectedText();

                    if ( sText.isEmpty() )

                        sText = xText->getText();

                    m_xList->UpdateSelection(sText);

                }

            }

            break;

        }

        case VclEventId::EditModify:

        case VclEventId::EditSelectionChanged:

        case VclEventId::EditCaretChanged:

            // Modify/Selection events are handled by the combo box instead of

            // directly by the edit field (Why?).  Therefore, delegate this

            // call to the edit field.

            if (m_aBoxType==COMBOBOX)

            {

                if (m_xText.is())

                {

                    Reference<XAccessibleContext> xContext = m_xText->getAccessibleContext();

                    VCLXAccessibleEdit* pEdit = static_cast<VCLXAccessibleEdit*>(xContext.get());

                    if (pEdit != nullptr)

                        pEdit->ProcessWindowEvent (rVclWindowEvent);

                }

            }

            break;

        default:

            VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );

    }

}

//=====  XAccessibleContext  ==================================================

sal_Int64 VCLXAccessibleBox::getAccessibleChildCount()

{

    SolarMutexGuard aSolarGuard;

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    return implGetAccessibleChildCount();

}

sal_Int64 VCLXAccessibleBox::implGetAccessibleChildCount()

{

    // Usually a box has a text field and a list of items as its children.

    // Non drop down list boxes have no text field.  Additionally check

    // whether the object is valid.

    sal_Int64 nCount = 0;

    if (IsValid())

        nCount += (m_bHasTextChild?1:0) + (m_bHasListChild?1:0);

    else

    {

        // Object not valid anymore.  Release references to children.

        m_bHasTextChild = false;

        m_xText = nullptr;

        m_bHasListChild = false;

        m_xList = nullptr;

    }

    return nCount;

}

Reference<XAccessible> SAL_CALL VCLXAccessibleBox::getAccessibleChild (sal_Int64 i)

{

    SolarMutexGuard aSolarGuard;

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    if (i<0 || i>=implGetAccessibleChildCount())

        throw IndexOutOfBoundsException();

    if (!IsValid())

        return nullptr;

    if (i==1 || ! m_bHasTextChild)

    {

        // List.

        if ( ! m_xList.is())

        {

            m_xList = new VCLXAccessibleList(GetWindow(),

                (m_aBoxType == LISTBOX ? VCLXAccessibleList::LISTBOX : VCLXAccessibleList::COMBOBOX),

                                                                this);

            m_xList->SetIndexInParent(i);

        }

        return m_xList;

    }

    else

    {

        // Text Field.

        if ( ! m_xText.is())

        {

            if (m_aBoxType==COMBOBOX)

            {

                VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();

                if (pComboBox && pComboBox->GetSubEdit())

                    m_xText = pComboBox->GetSubEdit()->GetAccessible();

            }

            else if (m_bIsDropDownBox)

                m_xText = new VCLXAccessibleTextField(GetAs<ListBox>(), this);

        }

        return m_xText;

    }

}

sal_Int16 SAL_CALL VCLXAccessibleBox::getAccessibleRole()

{

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    // Return the role <const>COMBO_BOX</const> for both VCL combo boxes and

    // VCL list boxes in DropDown-Mode else <const>PANEL</const>.

    // This way the Java bridge has not to handle both independently.

    //return m_bIsDropDownBox ? AccessibleRole::COMBO_BOX : AccessibleRole::PANEL;

    if (m_bIsDropDownBox || (m_aBoxType == COMBOBOX))

        return AccessibleRole::COMBO_BOX;

    else

        return AccessibleRole::PANEL;

}

//=====  XAccessibleAction  ===================================================

sal_Int32 SAL_CALL VCLXAccessibleBox::getAccessibleActionCount()

{

    ::osl::Guard< ::osl::Mutex> aGuard (GetMutex());

    // There is one action for drop down boxes (toggle popup) and none for

    // the other boxes.

    return m_bIsDropDownBox ? 1 : 0;

}

sal_Bool SAL_CALL VCLXAccessibleBox::doAccessibleAction (sal_Int32 nIndex)

{

    bool bNotify = false;

    {

        SolarMutexGuard aSolarGuard;

        ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

        if (nIndex!=0 || !m_bIsDropDownBox)

            throw css::lang::IndexOutOfBoundsException(

                ("VCLXAccessibleBox::doAccessibleAction: index "

                 + OUString::number(nIndex) + " not among 0.."

                 + OUString::number(getAccessibleActionCount())),

                getXWeak());

        if (m_aBoxType == COMBOBOX)

        {

            VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();

            if (pComboBox != nullptr)

            {

                pComboBox->ToggleDropDown();

                bNotify = true;

            }

        }

        else if (m_aBoxType == LISTBOX)

        {

            VclPtr< ListBox > pListBox = GetAs< ListBox >();

            if (pListBox != nullptr)

            {

                pListBox->ToggleDropDown();

                bNotify = true;

            }

        }

    }

    if (bNotify)

        NotifyAccessibleEvent (AccessibleEventId::ACTION_CHANGED, Any(), Any());

    return bNotify;

}

OUString SAL_CALL VCLXAccessibleBox::getAccessibleActionDescription (sal_Int32 nIndex)

{

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    if (nIndex!=0 || !m_bIsDropDownBox)

        throw css::lang::IndexOutOfBoundsException();

    return RID_STR_ACC_ACTION_TOGGLEPOPUP;

}

Reference< XAccessibleKeyBinding > VCLXAccessibleBox::getAccessibleActionKeyBinding( sal_Int32 nIndex )

{

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    Reference< XAccessibleKeyBinding > xRet;

    if (nIndex<0 || nIndex>=getAccessibleActionCount())

        throw css::lang::IndexOutOfBoundsException();

    // ... which key?

    return xRet;

}

// =====  XAccessibleValue  ===============================================

Any VCLXAccessibleBox::getCurrentValue( )

{

    SolarMutexGuard aSolarGuard;

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    Any aAny;

    if( m_xList.is() && m_xText.is())

    {

        // VCLXAccessibleList* pList = static_cast<VCLXAccessibleList*>(m_xList.get());

        Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);

        if ( xText.is() )

        {

            OUString sText = xText->getText();

            aAny <<= sText;

        }

    }

    if (m_aBoxType == LISTBOX && m_bIsDropDownBox  && m_xList.is() )

    {

        if (m_xList->IsInDropDown())

        {

            if (m_xList->getSelectedAccessibleChildCount() > 0)

            {

                Reference<XAccessibleContext> xName (m_xList->getSelectedAccessibleChild(sal_Int64(0)), UNO_QUERY);

                if(xName.is())

                {

                    aAny <<= xName->getAccessibleName();

                }

            }

        }

    }

    return aAny;

}

sal_Bool VCLXAccessibleBox::setCurrentValue( const Any& aNumber )

{

    SolarMutexGuard aSolarGuard;

    ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );

    OUString  fValue;

    bool bValid = (aNumber >>= fValue);

    return bValid;

}

Any VCLXAccessibleBox::getMaximumValue( )

{

    Any aAny;

    return aAny;

}

Any VCLXAccessibleBox::getMinimumValue(  )

{

    Any aAny;

    return aAny;

}

Any VCLXAccessibleBox::getMinimumIncrement(  )

{

    return Any();

}

// Set the INDETERMINATE state when there is no selected item for combobox

void VCLXAccessibleBox::FillAccessibleStateSet( sal_Int64& rStateSet )

{

    VCLXAccessibleComponent::FillAccessibleStateSet(rStateSet);

    if (m_aBoxType == COMBOBOX )

    {

        OUString sText;

        sal_Int32 nEntryCount = 0;

        VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();

        if (pComboBox != nullptr)

        {

            Edit* pSubEdit = pComboBox->GetSubEdit();

            if ( pSubEdit)

                sText = pSubEdit->GetText();

            nEntryCount = pComboBox->GetEntryCount();

        }

        if ( sText.isEmpty() && nEntryCount > 0 )

            rStateSet |= AccessibleStateType::INDETERMINATE;

    }

    else if (m_aBoxType == LISTBOX && m_bIsDropDownBox)

    {

        VclPtr< ListBox > pListBox = GetAs< ListBox >();

        if (pListBox != nullptr && pListBox->GetEntryCount() > 0)

        {

            sal_Int32 nSelectedEntryCount = pListBox->GetSelectedEntryCount();

            if ( nSelectedEntryCount == 0)

                rStateSet |= AccessibleStateType::INDETERMINATE;

        }

    }

}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */