framework/source/uielement/thesaurusmenucontroller.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <comphelper/processfactory.hxx>
  21 #include <comphelper/propertyvalue.hxx>
  22 #include <i18nlangtag/languagetag.hxx>
  23 #include <sal/log.hxx>
  24 #include <svl/lngmisc.hxx>
  25 #include <svtools/popupmenucontrollerbase.hxx>
  26 #include <comphelper/diagnose_ex.hxx>
  27 #include <unotools/lingucfg.hxx>
  28 #include <vcl/commandinfoprovider.hxx>
  29
  30 #include <com/sun/star/graphic/GraphicProvider.hpp>
  31 #include <com/sun/star/linguistic2/LinguServiceManager.hpp>
  32
  33 namespace {
  34
  35 class ThesaurusMenuController : public svt::PopupMenuControllerBase
  36 {
  37 public:
  38     explicit ThesaurusMenuController( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  39
  40     // XStatusListener
  41     virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& rEvent ) override;
  42
  43     // XServiceInfo
  44     virtual OUString SAL_CALL getImplementationName() override;
  45     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  46
  47 private:
  48     void fillPopupMenu();
  49     void getMeanings( std::vector< OUString >& rSynonyms, const OUString& rWord, const css::lang::Locale& rLocale, size_t nMaxSynonms );
  50     OUString getThesImplName( const css::lang::Locale& rLocale ) const;
  51     css::uno::Reference< css::linguistic2::XLinguServiceManager2 > m_xLinguServiceManager;
  52     css::uno::Reference< css::linguistic2::XThesaurus > m_xThesaurus;
  53     OUString m_aLastWord;
  54 };
  55
  56 }
  57
  58 ThesaurusMenuController::ThesaurusMenuController( const css::uno::Reference< css::uno::XComponentContext >& rxContext ) :
  59     svt::PopupMenuControllerBase( rxContext ),
  60     m_xLinguServiceManager( css::linguistic2::LinguServiceManager::create( rxContext ) ),
  61     m_xThesaurus( m_xLinguServiceManager->getThesaurus() )
  62 {
  63 }
  64
  65 void ThesaurusMenuController::statusChanged( const css::frame::FeatureStateEvent& rEvent )
  66 {
  67     rEvent.State >>= m_aLastWord;
  68     m_xPopupMenu->clear();
  69     if ( rEvent.IsEnabled )
  70         fillPopupMenu();
  71 }
  72
  73 void ThesaurusMenuController::fillPopupMenu()
  74 {
  75     sal_Int32 nIdx{ 0 };
  76     OUString aText = m_aLastWord.getToken(0, '#', nIdx);
  77     OUString aIsoLang = m_aLastWord.getToken(0, '#', nIdx);
  78     if ( aText.isEmpty() || aIsoLang.isEmpty() )
  79         return;
  80
  81     std::vector< OUString > aSynonyms;
  82     css::lang::Locale aLocale = LanguageTag::convertToLocale( aIsoLang );
  83     getMeanings( aSynonyms, aText, aLocale, 7 /*max number of synonyms to retrieve*/ );
  84
  85     m_xPopupMenu->enableAutoMnemonics(false);
  86     if ( aSynonyms.empty() )
  87         return;
  88
  89     SvtLinguConfig aCfg;
  90     css::uno::Reference<css::graphic::XGraphic> xGraphic;
  91     OUString aThesImplName( getThesImplName( aLocale ) );
  92     OUString aSynonymsImageUrl( aCfg.GetSynonymsContextImage( aThesImplName ) );
  93     if (!aThesImplName.isEmpty() && !aSynonymsImageUrl.isEmpty())
  94     {
  95         try
  96         {
  97             css::uno::Reference<css::uno::XComponentContext> xContext(::comphelper::getProcessComponentContext());
  98             css::uno::Reference<css::graphic::XGraphicProvider> xProvider(css::graphic::GraphicProvider::create(xContext));
  99             xGraphic = xProvider->queryGraphic({ comphelper::makePropertyValue("URL", aSynonymsImageUrl) });
 100         }
 101         catch (const css::uno::Exception&)
 102         {
 103             DBG_UNHANDLED_EXCEPTION("fwk");
 104         }
 105     }
 106
 107     sal_uInt16 nId = 1;
 108     for ( const auto& aSynonym : aSynonyms )
 109     {
 110         OUString aItemText( linguistic::GetThesaurusReplaceText( aSynonym ) );
 111         m_xPopupMenu->insertItem(nId, aItemText, 0, -1);
 112         m_xPopupMenu->setCommand(nId, ".uno:ThesaurusFromContext?WordReplace:string=" + aItemText);
 113
 114         if (xGraphic.is())
 115             m_xPopupMenu->setItemImage(nId, xGraphic, false);
 116
 117         nId++;
 118     }
 119
 120     m_xPopupMenu->insertSeparator(-1);
 121     OUString aThesaurusDialogCmd( ".uno:ThesaurusDialog" );
 122     auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(aThesaurusDialogCmd, m_aModuleName);
 123     m_xPopupMenu->insertItem(nId, vcl::CommandInfoProvider::GetPopupLabelForCommand(aProperties), 0, -1);
 124     m_xPopupMenu->setCommand(nId, aThesaurusDialogCmd);
 125 }
 126
 127 void ThesaurusMenuController::getMeanings( std::vector< OUString >& rSynonyms, const OUString& rWord,
 128                                            const css::lang::Locale& rLocale, size_t nMaxSynonms )
 129 {
 130     rSynonyms.clear();
 131     if ( !(m_xThesaurus.is() && m_xThesaurus->hasLocale( rLocale ) && !rWord.isEmpty() && nMaxSynonms > 0) )
 132         return;
 133
 134     try
 135     {
 136         const css::uno::Sequence< css::uno::Reference< css::linguistic2::XMeaning > > aMeaningSeq(
 137             m_xThesaurus->queryMeanings( rWord, rLocale, css::uno::Sequence< css::beans::PropertyValue >() ) );
 138
 139         for ( const auto& xMeaning : aMeaningSeq )
 140         {
 141             const css::uno::Sequence< OUString > aSynonymSeq( xMeaning->querySynonyms() );
 142             for ( const auto& aSynonym : aSynonymSeq )
 143             {
 144                 rSynonyms.push_back( aSynonym );
 145                 if ( rSynonyms.size() == nMaxSynonms )
 146                     return;
 147             }
 148         }
 149     }
 150     catch ( const css::uno::Exception& )
 151     {
 152         SAL_WARN( "fwk.uielement", "Failed to get synonyms" );
 153     }
 154 }
 155
 156 OUString ThesaurusMenuController::getThesImplName( const css::lang::Locale& rLocale ) const
 157 {
 158     css::uno::Sequence< OUString > aServiceNames =
 159         m_xLinguServiceManager->getConfiguredServices( "com.sun.star.linguistic2.Thesaurus", rLocale );
 160     SAL_WARN_IF( aServiceNames.getLength() > 1, "fwk.uielement", "Only one thesaurus is allowed per locale, but found more!" );
 161     if ( aServiceNames.getLength() == 1 )
 162         return aServiceNames[0];
 163
 164     return OUString();
 165 }
 166
 167 OUString ThesaurusMenuController::getImplementationName()
 168 {
 169     return "com.sun.star.comp.framework.ThesaurusMenuController";
 170 }
 171
 172 css::uno::Sequence< OUString > ThesaurusMenuController::getSupportedServiceNames()
 173 {
 174     return { "com.sun.star.frame.PopupMenuController" };
 175 }
 176
 177 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 178 com_sun_star_comp_framework_ThesaurusMenuController_get_implementation(
 179     css::uno::XComponentContext* xContext,
 180     css::uno::Sequence< css::uno::Any > const & )
 181 {
 182     return cppu::acquire( new ThesaurusMenuController( xContext ) );
 183 }
 184
 185 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */