path: root/framework/source/uielement/langselectionstatusbarcontroller.cxx

/* -*- 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 <classes/fwkresid.hxx>
#include <services.h>
#include <strings.hrc>
#include <vcl/svapp.hxx>

#include <cppuhelper/supportsservice.hxx>
#include <com/sun/star/awt/PopupMenu.hpp>
#include <com/sun/star/awt/PopupMenuDirection.hpp>
#include <svtools/langtab.hxx>
#include <svtools/statusbarcontroller.hxx>
#include <sal/types.h>
#include <sal/log.hxx>
#include <com/sun/star/document/XDocumentLanguages.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/i18n/ScriptType.hpp>
#include <com/sun/star/ui/XStatusbarItem.hpp>

#include <com/sun/star/frame/XFrame.hpp>

#include <com/sun/star/awt/Command.hpp>
#include <svl/languageoptions.hxx>

#include <helper/mischelper.hxx>

#include <rtl/ustrbuf.hxx>

#include <map>
#include <set>

using namespace ::cppu;
using namespace ::com::sun::star;
using namespace css::uno;
using namespace css::lang;
using namespace css::frame;
using namespace css::i18n;
using namespace css::document;
using namespace framework;

namespace {

class LangSelectionStatusbarController:
    public svt::StatusbarController
{
public:
    explicit LangSelectionStatusbarController( const css::uno::Reference< css::uno::XComponentContext >& xContext );
    LangSelectionStatusbarController(const LangSelectionStatusbarController&) = delete;
    LangSelectionStatusbarController& operator=(const LangSelectionStatusbarController&) = delete;

    // XInitialization
    virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) override;

    // XStatusListener
    virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& Event ) override;

    // XStatusbarController
    virtual void SAL_CALL command( const css::awt::Point& aPos,
                                   ::sal_Int32 nCommand,
                                   sal_Bool bMouseEvent,
                                   const css::uno::Any& aData ) override;
    virtual void SAL_CALL click( const css::awt::Point& aPos ) override;

private:
    virtual ~LangSelectionStatusbarController() override {}

    bool            m_bShowMenu;        // if the menu is to be displayed or not (depending on the selected object/text)
    SvtScriptType   m_nScriptType;      // the flags for the different script types available in the selection, LATIN = 0x0001, ASIAN = 0x0002, COMPLEX = 0x0004
    OUString        m_aCurLang;         // the language of the current selection, "*" if there are more than one languages
    OUString        m_aKeyboardLang;    // the keyboard language
    OUString        m_aGuessedTextLang;     // the 'guessed' language for the selection, "" if none could be guessed
    LanguageGuessingHelper      m_aLangGuessHelper;

    /// @throws css::uno::RuntimeException
    void LangMenu( const css::awt::Point& aPos );
};

LangSelectionStatusbarController::LangSelectionStatusbarController( const uno::Reference< uno::XComponentContext >& xContext ) :
    svt::StatusbarController( xContext, uno::Reference< frame::XFrame >(), OUString(), 0 ),
    m_bShowMenu( true ),
    m_nScriptType( SvtScriptType::LATIN | SvtScriptType::ASIAN | SvtScriptType::COMPLEX ),
    m_aLangGuessHelper( xContext )
{
}

void SAL_CALL LangSelectionStatusbarController::initialize( const css::uno::Sequence< css::uno::Any >& aArguments )
{
    SolarMutexGuard aSolarMutexGuard;

    svt::StatusbarController::initialize( aArguments );

    if ( m_xStatusbarItem.is() )
    {
        m_xStatusbarItem->setText( FwkResId(STR_LANGSTATUS_MULTIPLE_LANGUAGES) );
        m_xStatusbarItem->setQuickHelpText(FwkResId(STR_LANGSTATUS_HINT));
    }
}

void LangSelectionStatusbarController::LangMenu(
    const css::awt::Point& aPos )
{
    if (!m_bShowMenu)
        return;

    const Reference<XServiceInfo> xService(m_xFrame->getController()->getModel(), UNO_QUERY);
    bool bWriter = xService.is() && xService->supportsService("com.sun.star.text.GenericTextDocument");
    //add context menu
    Reference< awt::XPopupMenu > xPopupMenu( awt::PopupMenu::create( m_xContext ) );
    //sub menu that contains all items except the last two items: Separator + Set Language for Paragraph
    Reference< awt::XPopupMenu > subPopupMenu( awt::PopupMenu::create( m_xContext ) );

    // get languages to be displayed in the menu
    std::set< OUString > aLangItems;
    FillLangItems( aLangItems, m_xFrame, m_aLangGuessHelper,
            m_nScriptType, m_aCurLang, m_aKeyboardLang, m_aGuessedTextLang );

    // add first few entries to main menu
    sal_Int16 nItemId = static_cast< sal_Int16 >(MID_LANG_SEL_1);
    const OUString sAsterisk("*");  // multiple languages in current selection
    const OUString sNone( SvtLanguageTable::GetLanguageString( LANGUAGE_NONE ));
    std::map< sal_Int16, OUString > aLangMap;
    for (auto const& langItem : aLangItems)
    {
        if ( langItem != sNone &&
             langItem != sAsterisk &&
             !langItem.isEmpty()) // 'no language found' from language guessing
        {
            SAL_WARN_IF( MID_LANG_SEL_1 > nItemId || nItemId > MID_LANG_SEL_9,
                    "fwk.uielement", "nItemId outside of expected range!" );
            xPopupMenu->insertItem( nItemId, langItem, 0, nItemId );
            if ( langItem == m_aCurLang )
            {
                //make a sign for the current language
                xPopupMenu->checkItem( nItemId, true );
            }
            aLangMap[ nItemId ] = langItem;
            ++nItemId;
        }
    }

    if (bWriter)
    {
        xPopupMenu->insertItem( MID_LANG_SEL_NONE,  FwkResId(STR_LANGSTATUS_NONE), 0, MID_LANG_SEL_NONE );
        if ( sNone == m_aCurLang )
            xPopupMenu->checkItem( MID_LANG_SEL_NONE, true );
        xPopupMenu->insertItem( MID_LANG_SEL_RESET, FwkResId(STR_RESET_TO_DEFAULT_LANGUAGE), 0, MID_LANG_SEL_RESET );
        xPopupMenu->insertItem( MID_LANG_SEL_MORE,  FwkResId(STR_LANGSTATUS_MORE), 0, MID_LANG_SEL_MORE );

        // add entries to submenu ('set language for paragraph')
        nItemId = static_cast< sal_Int16 >(MID_LANG_PARA_1);
        for (auto const& langItem : aLangItems)
        {
            if( langItem != sNone &&
                langItem != sAsterisk &&
                !langItem.isEmpty()) // 'no language found' from language guessing
            {
                SAL_WARN_IF( MID_LANG_PARA_1 > nItemId || nItemId > MID_LANG_PARA_9,
                        "fwk.uielement", "nItemId outside of expected range!" );
                subPopupMenu->insertItem( nItemId, langItem, 0, nItemId );
                aLangMap[nItemId] = langItem;
                ++nItemId;
            }
        }
        subPopupMenu->insertItem( MID_LANG_PARA_NONE,  FwkResId(STR_LANGSTATUS_NONE), 0, MID_LANG_PARA_NONE );
        subPopupMenu->insertItem( MID_LANG_PARA_RESET, FwkResId(STR_RESET_TO_DEFAULT_LANGUAGE), 0, MID_LANG_PARA_RESET );
        subPopupMenu->insertItem( MID_LANG_PARA_MORE,  FwkResId(STR_LANGSTATUS_MORE), 0, MID_LANG_PARA_MORE );

        // add last two entries to main menu
        xPopupMenu->insertSeparator( MID_LANG_PARA_SEPARATOR );
        xPopupMenu->insertItem( MID_LANG_PARA_STRING, FwkResId(STR_SET_LANGUAGE_FOR_PARAGRAPH), 0, MID_LANG_PARA_STRING );
        xPopupMenu->setPopupMenu( MID_LANG_PARA_STRING, subPopupMenu );
    }
    else
    {
        xPopupMenu->insertItem( MID_LANG_DEF_NONE,  FwkResId(STR_LANGSTATUS_NONE), 0, MID_LANG_DEF_NONE );
        if ( sNone == m_aCurLang )
            xPopupMenu->checkItem( MID_LANG_DEF_NONE, true );
        xPopupMenu->insertItem( MID_LANG_DEF_RESET, FwkResId(STR_RESET_TO_DEFAULT_LANGUAGE), 0, MID_LANG_DEF_RESET );
        xPopupMenu->insertItem( MID_LANG_DEF_MORE,  FwkResId(STR_LANGSTATUS_MORE), 0, MID_LANG_DEF_MORE );
    }

    // now display the popup menu and execute every command ...

    Reference< awt::XWindowPeer > xParent( m_xParentWindow, UNO_QUERY );
    css::awt::Rectangle aRect( aPos.X, aPos.Y, 0, 0 );
    sal_Int16 nId = xPopupMenu->execute( xParent, aRect, css::awt::PopupMenuDirection::EXECUTE_UP+16 );
    //click "More..."
    if ( !(nId && m_xFrame.is()) )
        return;

    OUStringBuffer aBuff;
    //set selected language as current language for selection
    const OUString aSelectedLang = aLangMap[nId];

    if (MID_LANG_SEL_1 <= nId && nId <= MID_LANG_SEL_9)
    {
        if (bWriter)
            aBuff.append( ".uno:LanguageStatus?Language:string=Current_" );
        else
            aBuff.append( ".uno:LanguageStatus?Language:string=Default_" );

        aBuff.append( aSelectedLang );
    }
    else if (nId == MID_LANG_SEL_NONE)
    {
        //set None as current language for selection
        aBuff.append( ".uno:LanguageStatus?Language:string=Current_LANGUAGE_NONE" );
    }
    else if (nId == MID_LANG_SEL_RESET)
    {
        // reset language attributes for selection
        aBuff.append( ".uno:LanguageStatus?Language:string=Current_RESET_LANGUAGES" );
    }
    else if (nId == MID_LANG_SEL_MORE)
    {
        //open the dialog "format/character" for current selection
        aBuff.append( ".uno:FontDialog?Page:string=font" );
    }
    else if (nId == MID_LANG_DEF_NONE)
    {
         aBuff.append( ".uno:LanguageStatus?Language:string=Default_LANGUAGE_NONE" );
    }
    else if (nId == MID_LANG_DEF_RESET)
    {
         aBuff.append( ".uno:LanguageStatus?Language:string=Default_RESET_LANGUAGES" );
    }
    else if (nId == MID_LANG_DEF_MORE)
    {
        aBuff.append( ".uno:LanguageStatus?Language:string=*" );
    }
    else if (MID_LANG_PARA_1 <= nId && nId <= MID_LANG_PARA_9)
    {
        aBuff.append( ".uno:LanguageStatus?Language:string=Paragraph_" );
        aBuff.append( aSelectedLang );
    }
    else if (nId == MID_LANG_PARA_NONE)
    {
        //set None as language for current paragraph
        aBuff.append( ".uno:LanguageStatus?Language:string=Paragraph_LANGUAGE_NONE" );
    }
    else if (nId == MID_LANG_PARA_RESET)
    {
        // reset language attributes for paragraph
        aBuff.append( ".uno:LanguageStatus?Language:string=Paragraph_RESET_LANGUAGES" );
    }
    else if (nId == MID_LANG_PARA_MORE)
    {
        //open the dialog "format/character" for current paragraph
        aBuff.append( ".uno:FontDialogForParagraph" );
    }

    const Sequence< beans::PropertyValue > aDummyArgs;
    execute( aBuff.makeStringAndClear(), aDummyArgs );
}

void SAL_CALL LangSelectionStatusbarController::command(
    const css::awt::Point& aPos,
    ::sal_Int32 nCommand,
    sal_Bool /*bMouseEvent*/,
    const css::uno::Any& /*aData*/ )
{
    if ( nCommand & ::awt::Command::CONTEXTMENU )
    {
        LangMenu( aPos );
    }
}

void SAL_CALL LangSelectionStatusbarController::click(
    const css::awt::Point& aPos )
{
    LangMenu( aPos );
}

// XStatusListener
void SAL_CALL LangSelectionStatusbarController::statusChanged( const FeatureStateEvent& Event )
{
    // This function will be called when observed data changes,
    // for example the selection or keyboard language.
    // - It displays the language in use in the status bar
    // - and it stores the relevant data for creating the menu
    //   at some later point in the member variables
    //      m_nScriptType, m_aCurLang, m_aKeyboardLang, m_aGuessedText

    SolarMutexGuard aSolarMutexGuard;

    if ( m_bDisposed )
        return;

    m_bShowMenu = true;
    m_nScriptType = SvtScriptType::LATIN | SvtScriptType::ASIAN | SvtScriptType::COMPLEX;  //set the default value

    if ( !m_xStatusbarItem.is() )
        return;

    OUString aStrValue;
    Sequence< OUString > aSeq;

    if ( Event.State >>= aStrValue )
    {
        m_xStatusbarItem->setText( aStrValue );
        m_aCurLang = aStrValue;
    }
    else if ( Event.State >>= aSeq )
    {
        if ( aSeq.getLength() == 4 )
        {
            OUString aStatusText = aSeq[0];
            if (aStatusText == "*")
            {
                aStatusText = FwkResId(STR_LANGSTATUS_MULTIPLE_LANGUAGES);
            }
            m_xStatusbarItem->setText( aStatusText );

            // Retrieve all other values from the sequence and
            // store it members!
            m_aCurLang      = aSeq[0];
            m_nScriptType   = static_cast< SvtScriptType >( aSeq[1].toInt32() );
            m_aKeyboardLang = aSeq[2];
            m_aGuessedTextLang  = aSeq[3];
        }
    }
    else if ( !Event.State.hasValue() )
    {
        m_xStatusbarItem->setText( OUString() );
        m_bShowMenu = false;    // no language -> no menu
    }
}

}

extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
com_sun_star_comp_framework_LangSelectionStatusbarController_get_implementation(
    css::uno::XComponentContext *context,
    css::uno::Sequence<css::uno::Any> const &)
{
    return cppu::acquire(new LangSelectionStatusbarController(context));
}

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