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