include/svx/SmartTagMgr.hxx

   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 #ifndef INCLUDED_SVX_SMARTTAGMGR_HXX
  21 #define INCLUDED_SVX_SMARTTAGMGR_HXX
  22
  23 #include <cppuhelper/implbase.hxx>
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <com/sun/star/util/XModifyListener.hpp>
  27 #include <com/sun/star/util/XChangesListener.hpp>
  28 #include <svx/svxdllapi.h>
  29
  30 #include <vector>
  31 #include <map>
  32 #include <set>
  33
  34 namespace com { namespace sun { namespace star { namespace uno {
  35     class XComponentContext;
  36 } } } }
  37
  38 namespace com { namespace sun { namespace star { namespace smarttags {
  39     class XSmartTagRecognizer;
  40     class XSmartTagAction;
  41 } } } }
  42
  43 namespace com { namespace sun { namespace star { namespace text {
  44     class XTextMarkup;
  45     class XTextRange;
  46 } } } }
  47
  48 namespace com { namespace sun { namespace star { namespace i18n {
  49     class XBreakIterator;
  50 } } } }
  51
  52 namespace com { namespace sun { namespace star { namespace lang {
  53     struct Locale;
  54     struct EventObject;
  55     struct ChangesEvent;
  56 } } } }
  57
  58 namespace com { namespace sun { namespace star { namespace beans {
  59     class XPropertySet;
  60 } } } }
  61
  62 namespace com { namespace sun { namespace star { namespace frame {
  63     class XController;
  64 } } } }
  65
  66 /** A reference to a smart tag action
  67
  68      An action service can support various actions. Therefore an ActionReference
  69      consists of a reference to the service and index.
  70  */
  71 struct ActionReference
  72 {
  73     css::uno::Reference< css::smarttags::XSmartTagAction > mxSmartTagAction;
  74     sal_Int32 const mnSmartTagIndex;
  75     ActionReference( css::uno::Reference< css::smarttags::XSmartTagAction > const & xSmartTagAction, sal_Int32 nSmartTagIndex )
  76         : mxSmartTagAction( xSmartTagAction), mnSmartTagIndex( nSmartTagIndex ) {}
  77 };
  78
  79 /** The smart tag manager maintains all installed action and recognizer services
  80
  81     This class organizes the available smarttag libraries and provides access functions
  82     to these libraries. The smart tag manager is a singleton.
  83 */
  84 class SVX_DLLPUBLIC SmartTagMgr : public cppu::WeakImplHelper< css::util::XModifyListener,
  85                                                                 css::util::XChangesListener >
  86 {
  87 private:
  88
  89     const OUString maApplicationName;
  90     std::vector< css::uno::Reference< css::smarttags::XSmartTagRecognizer > > maRecognizerList;
  91     std::vector< css::uno::Reference< css::smarttags::XSmartTagAction > > maActionList;
  92     std::set< OUString > maDisabledSmartTagTypes;
  93     std::multimap < OUString, ActionReference > maSmartTagMap;
  94     mutable css::uno::Reference< css::i18n::XBreakIterator > mxBreakIter;
  95     css::uno::Reference< css::uno::XComponentContext> mxContext;
  96     css::uno::Reference< css::beans::XPropertySet > mxConfigurationSettings;
  97     bool mbLabelTextWithSmartTags;
  98
  99     /** Checks for installed smart tag recognizers/actions and stores them in
 100         maRecognizerList and maActionList.
 101     */
 102     void LoadLibraries();
 103
 104     /** Prepare configuration access.
 105     */
 106     void PrepareConfiguration( const OUString& rConfigurationGroupName );
 107
 108     /** Reads the configuration data.
 109     */
 110     void ReadConfiguration( bool bExcludedTypes, bool bRecognize );
 111
 112     /** Registers the smart tag manager as listener at the package manager.
 113     */
 114     void RegisterListener();
 115
 116     /** Sets up a map that maps smart tag type names to actions references.
 117     */
 118     void AssociateActionsWithRecognizers();
 119
 120 public:
 121
 122     SmartTagMgr( const OUString& rApplicationName );
 123     virtual ~SmartTagMgr() override;
 124
 125     /** Triggers configuration reading, library loading and listener registration
 126         NOTE: MUST BE CALLED AFTER CONSTRUCTION!
 127     */
 128     void Init( const OUString& rConfigurationGroupName );
 129
 130     /** Dispatches the recognize call to all installed smart tag recognizers
 131
 132         @param rText
 133             The string to be scanned by the recognizers.
 134
 135         @param xMarkup
 136             The object allows the recognizers to store any found smart tags.
 137
 138         @param xController
 139                 The current controller of the document.
 140
 141         @param rLocale
 142             The locale of rText.
 143
 144         @param nStart
 145             The start offset of the text to be scanned in rText.
 146
 147         @param nLen
 148             The length of the text to be scanned.
 149
 150     */
 151
 152     void RecognizeString( const OUString& rText,
 153                     const css::uno::Reference< css::text::XTextMarkup >& rMarkup,
 154                     const css::uno::Reference< css::frame::XController >& rController,
 155                     const css::lang::Locale& rLocale,
 156                     sal_uInt32 nStart, sal_uInt32 nLen ) const;
 157
 158     void RecognizeTextRange(const css::uno::Reference< css::text::XTextRange>& rRange,
 159                     const css::uno::Reference< css::text::XTextMarkup >& rMarkup,
 160                     const css::uno::Reference< css::frame::XController >& rController) const;
 161
 162     /** Returns all action references associated with a given list of smart tag types
 163
 164         @param rSmartTagTypes
 165             The list of types
 166
 167         @param rActionComponentsSequence
 168             Output parameter
 169
 170         @param rActionIndicesSequence
 171             Output parameter
 172     */
 173     void GetActionSequences( std::vector< OUString >& rSmartTagTypes,
 174                              css::uno::Sequence < css::uno::Sequence< css::uno::Reference< css::smarttags::XSmartTagAction > > >& rActionComponentsSequence,
 175                              css::uno::Sequence < css::uno::Sequence< sal_Int32 > >& rActionIndicesSequence ) const;
 176
 177     /** Returns the caption for a smart tag type.
 178
 179         @param rSmartTagType
 180             The given smart tag type.
 181
 182         @param rLocale
 183             The locale.
 184     */
 185     OUString GetSmartTagCaption( const OUString& rSmartTagType, const css::lang::Locale& rLocale ) const;
 186
 187     /** Returns true if the given smart tag type is enabled.
 188     */
 189     bool IsSmartTagTypeEnabled( const OUString& rSmartTagType ) const;
 190
 191     /** Enable or disable smart tags.
 192     */
 193     bool IsLabelTextWithSmartTags() const { return mbLabelTextWithSmartTags; }
 194
 195     /** Returns the number of registered recognizers.
 196     */
 197     sal_uInt32 NumberOfRecognizers() const { return maRecognizerList.size(); }
 198
 199     /** Returns a recognizer.
 200     */
 201     css::uno::Reference< css::smarttags::XSmartTagRecognizer > const &
 202         GetRecognizer( sal_uInt32 i ) const  { return maRecognizerList[i]; }
 203
 204     /** Is smart tag recognition active?
 205     */
 206     bool IsSmartTagsEnabled() const { return 0 != NumberOfRecognizers() &&
 207                                       IsLabelTextWithSmartTags(); }
 208
 209     /** Writes configuration settings.
 210     */
 211     void WriteConfiguration( const bool* bLabelTextWithSmartTags,
 212                              const std::vector< OUString >* pDisabledTypes ) const;
 213
 214     /** Returns the name of the application this instance has been created by.
 215     */
 216     const OUString& GetApplicationName() const { return maApplicationName; }
 217
 218     // css::lang::XEventListener
 219     virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
 220
 221     // css::util::XModifyListener
 222     virtual void SAL_CALL modified( const css::lang::EventObject& aEvent ) override;
 223
 224     // css::util::XChangesListener
 225       virtual void SAL_CALL changesOccurred( const css::util::ChangesEvent& Event ) override;
 226 };
 227
 228 #endif
 229
 230 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */