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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
/* -*- 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_VCL_TEXTENG_HXX
#define INCLUDED_VCL_TEXTENG_HXX
#include <memory>
#include <sal/config.h>
#include <cstddef>
#include <vector>
#include <vcl/dllapi.h>
#include <vcl/vclptr.hxx>
#include <rtl/ustring.hxx>
#include <svl/SfxBroadcaster.hxx>
#include <tools/lineend.hxx>
#include <tools/link.hxx>
#include <tools/gen.hxx>
#include <tools/color.hxx>
#include <vcl/font.hxx>
#include <vcl/vclenum.hxx>
#include <com/sun/star/lang/Locale.hpp>
#include <com/sun/star/uno/Reference.hxx>
class TextDoc;
class TextView;
class TextPaM;
class TextSelection;
class TEParaPortions;
class TextAttrib;
class TextCharAttrib;
class TextUndo;
class TextUndoManager;
class IdleFormatter;
class TextNode;
class OutputDevice;
class KeyEvent;
class Timer;
class SfxUndoManager;
class TextLine;
struct TEIMEInfos;
namespace com::sun::star::i18n {
class XBreakIterator;
class XExtendedInputSequenceChecker;
}
class LocaleDataWrapper;
typedef std::vector<TextView*> TextViews;
class VCL_DLLPUBLIC TextEngine : public SfxBroadcaster
{
friend class TextView;
friend class TextSelFunctionSet;
friend class ExtTextEngine;
friend class TextUndo;
friend class TextUndoManager;
friend class TextUndoDelPara;
friend class TextUndoConnectParas;
friend class TextUndoSplitPara;
friend class TextUndoInsertChars;
friend class TextUndoRemoveChars;
std::unique_ptr<TextDoc> mpDoc;
std::unique_ptr<TEParaPortions> mpTEParaPortions;
VclPtr<OutputDevice> mpRefDev;
std::unique_ptr<TextViews> mpViews;
TextView* mpActiveView;
std::unique_ptr<TextUndoManager> mpUndoManager;
std::unique_ptr<IdleFormatter> mpIdleFormatter;
std::unique_ptr<TEIMEInfos> mpIMEInfos;
css::lang::Locale maLocale;
css::uno::Reference< css::i18n::XBreakIterator > mxBreakIterator;
css::uno::Reference < css::i18n::XExtendedInputSequenceChecker > mxISC;
tools::Rectangle maInvalidRect;
std::unique_ptr<LocaleDataWrapper> mpLocaleDataWrapper;
vcl::Font maFont;
Color maTextColor;
sal_Int32 mnMaxTextLen;
tools::Long mnMaxTextWidth;
tools::Long mnCharHeight;
tools::Long mnCurTextWidth;
tools::Long mnCurTextHeight;
tools::Long mnDefTab;
TxtAlign meAlign;
bool mbIsFormatting : 1; // semaphore for the Hook's
bool mbFormatted : 1;
bool mbUpdate : 1;
bool mbModified : 1;
bool mbUndoEnabled : 1;
bool mbIsInUndo : 1;
bool mbDowning : 1;
bool mbRightToLeft : 1;
bool mbHasMultiLineParas : 1;
SAL_DLLPRIVATE void CursorMoved( sal_uInt32 nNode );
SAL_DLLPRIVATE void TextModified();
SAL_DLLPRIVATE void ImpInitDoc();
SAL_DLLPRIVATE void ImpRemoveText();
SAL_DLLPRIVATE TextPaM ImpDeleteText( const TextSelection& rSel );
SAL_DLLPRIVATE TextPaM ImpInsertText( const TextSelection& rSel, sal_Unicode c, bool bOverwrite = false );
SAL_DLLPRIVATE TextPaM ImpInsertText( const TextSelection& rSel, const OUString& rText );
SAL_DLLPRIVATE TextPaM ImpInsertParaBreak( const TextSelection& rTextSelection );
SAL_DLLPRIVATE TextPaM ImpInsertParaBreak( const TextPaM& rPaM );
SAL_DLLPRIVATE void ImpRemoveChars( const TextPaM& rPaM, sal_Int32 nChars );
SAL_DLLPRIVATE TextPaM ImpConnectParagraphs( sal_uInt32 nLeft, sal_uInt32 nRight );
SAL_DLLPRIVATE void ImpRemoveParagraph( sal_uInt32 nPara );
SAL_DLLPRIVATE void ImpInitWritingDirections( sal_uInt32 nPara );
SAL_DLLPRIVATE LocaleDataWrapper* ImpGetLocaleDataWrapper();
// to remain compatible in the minor release we copy the above ImpInsertText
// function and add the extra parameter we need but make sure this function
// gets not exported. First and second parameter swapped to have a different signature.
SAL_DLLPRIVATE TextPaM ImpInsertText( sal_Unicode c, const TextSelection& rSel, bool bOverwrite, bool bIsUserInput = false );
// some other new functions needed that must not be exported to remain compatible
SAL_DLLPRIVATE css::uno::Reference< css::i18n::XExtendedInputSequenceChecker > const & GetInputSequenceChecker();
SAL_DLLPRIVATE bool IsInputSequenceCheckingRequired( sal_Unicode c, const TextSelection& rCurSel ) const;
// broadcast or adjust selections
SAL_DLLPRIVATE void ImpParagraphInserted( sal_uInt32 nPara );
SAL_DLLPRIVATE void ImpParagraphRemoved( sal_uInt32 nPara );
SAL_DLLPRIVATE void ImpCharsRemoved( sal_uInt32 nPara, sal_Int32 nPos, sal_Int32 nChars );
SAL_DLLPRIVATE void ImpCharsInserted( sal_uInt32 nPara, sal_Int32 nPos, sal_Int32 nChars );
DECL_DLLPRIVATE_LINK( IdleFormatHdl, Timer *, void );
SAL_DLLPRIVATE void CheckIdleFormatter();
SAL_DLLPRIVATE void IdleFormatAndUpdate( TextView* pCurView, sal_uInt16 nMaxTimerRestarts = 5 );
SAL_DLLPRIVATE bool CreateLines( sal_uInt32 nPara );
SAL_DLLPRIVATE void CreateAndInsertEmptyLine( sal_uInt32 nPara );
SAL_DLLPRIVATE void ImpBreakLine( sal_uInt32 nPara, TextLine* pLine, sal_Int32 nPortionStart, tools::Long nRemainingWidth );
SAL_DLLPRIVATE std::size_t SplitTextPortion( sal_uInt32 nPara, sal_Int32 nPos );
SAL_DLLPRIVATE void CreateTextPortions( sal_uInt32 nPara, sal_Int32 nStartPos );
SAL_DLLPRIVATE void RecalcTextPortion( sal_uInt32 nPara, sal_Int32 nStartPos, sal_Int32 nNewChars );
SAL_DLLPRIVATE void SeekCursor( sal_uInt32 nNode, sal_Int32 nPos, vcl::Font& rFont, OutputDevice* pOutDev );
SAL_DLLPRIVATE void FormatDoc();
SAL_DLLPRIVATE void FormatFullDoc();
SAL_DLLPRIVATE void FormatAndUpdate( TextView* pCurView = nullptr );
bool IsFormatting() const { return mbIsFormatting; }
SAL_DLLPRIVATE void UpdateViews( TextView* pCurView = nullptr );
SAL_DLLPRIVATE void ImpPaint( OutputDevice* pOut, const Point& rStartPos, tools::Rectangle const* pPaintArea, TextSelection const* pSelection = nullptr );
bool IsFormatted() const { return mbFormatted; }
SAL_DLLPRIVATE sal_Int32 GetCharPos( sal_uInt32 nPara, std::vector<TextLine>::size_type nLine, tools::Long nDocPosX );
SAL_DLLPRIVATE tools::Rectangle GetEditCursor( const TextPaM& rPaM, bool bSpecial, bool bPreferPortionStart = false );
SAL_DLLPRIVATE sal_Int32 ImpFindIndex( sal_uInt32 nPortion, const Point& rPosInPara );
SAL_DLLPRIVATE tools::Long ImpGetPortionXOffset( sal_uInt32 nPara, TextLine const * pLine, std::size_t nTextPortion );
SAL_DLLPRIVATE tools::Long ImpGetXPos( sal_uInt32 nPara, TextLine* pLine, sal_Int32 nIndex, bool bPreferPortionStart = false );
SAL_DLLPRIVATE tools::Long ImpGetOutputOffset( sal_uInt32 nPara, TextLine* pLine, sal_Int32 nIndex, sal_Int32 nIndex2 );
SAL_DLLPRIVATE bool ImpGetRightToLeft( sal_uInt32 nPara, sal_Int32 nPos );
SAL_DLLPRIVATE static void ImpInitLayoutMode( OutputDevice* pOutDev );
SAL_DLLPRIVATE TxtAlign ImpGetAlign() const;
SAL_DLLPRIVATE tools::Long CalcTextHeight() const;
SAL_DLLPRIVATE tools::Long CalcParaHeight( sal_uInt32 nParagraph ) const;
SAL_DLLPRIVATE tools::Long CalcTextWidth( sal_uInt32 nPara );
SAL_DLLPRIVATE tools::Long CalcTextWidth( sal_uInt32 nPara, sal_Int32 nPortionStart, sal_Int32 nPortionLen);
SAL_DLLPRIVATE Range GetInvalidYOffsets( sal_uInt32 nPortion );
// for Undo/Redo
SAL_DLLPRIVATE void InsertContent( std::unique_ptr<TextNode> pNode, sal_uInt32 nPara );
SAL_DLLPRIVATE TextPaM SplitContent( sal_uInt32 nNode, sal_Int32 nSepPos );
SAL_DLLPRIVATE TextPaM ConnectContents( sal_uInt32 nLeftNode );
// adjust PaM's and selections that were transferred to the API to a valid range
SAL_DLLPRIVATE void ValidateSelection( TextSelection& rSel ) const;
SAL_DLLPRIVATE void ValidatePaM( TextPaM& rPaM ) const;
public:
TextEngine();
virtual ~TextEngine() override;
TextEngine( const TextEngine& ) = delete;
TextEngine& operator=( const TextEngine& ) = delete;
void SetText( const OUString& rStr );
SAL_DLLPRIVATE OUString GetText( LineEnd aSeparator = LINEEND_LF ) const;
OUString GetText( const TextSelection& rSel, LineEnd aSeparator = LINEEND_LF ) const;
SAL_DLLPRIVATE OUString GetTextLines( LineEnd aSeparator = LINEEND_LF ) const;
void ReplaceText(const TextSelection& rSel, const OUString& rText);
SAL_DLLPRIVATE sal_Int32 GetTextLen() const;
SAL_DLLPRIVATE sal_Int32 GetTextLen( const TextSelection& rSel ) const;
void SetFont( const vcl::Font& rFont );
const vcl::Font& GetFont() const { return maFont; }
SAL_DLLPRIVATE void SetLeftMargin( sal_uInt16 n );
void SetUpdateMode( bool bUpdate );
bool GetUpdateMode() const { return mbUpdate; }
SAL_DLLPRIVATE sal_uInt16 GetViewCount() const;
SAL_DLLPRIVATE TextView* GetView( sal_uInt16 nView ) const;
void InsertView( TextView* pTextView );
void RemoveView( TextView* pTextView );
TextView* GetActiveView() const { return mpActiveView;}
void SetActiveView( TextView* pView );
SAL_DLLPRIVATE void SetMaxTextLen( sal_Int32 nLen );
sal_Int32 GetMaxTextLen() const { return mnMaxTextLen; }
void SetMaxTextWidth( tools::Long nWidth );
tools::Long GetMaxTextWidth() const { return mnMaxTextWidth; }
tools::Long GetTextHeight() const;
tools::Long CalcTextWidth();
tools::Long GetCharHeight() const { return mnCharHeight; }
sal_uInt32 GetParagraphCount() const;
OUString GetText( sal_uInt32 nParagraph ) const;
sal_Int32 GetTextLen( sal_uInt32 nParagraph ) const;
tools::Long GetTextHeight( sal_uInt32 nParagraph ) const;
void GetTextPortionRange(const TextPaM& rPaM, sal_Int32& nStart, sal_Int32& nEnd);
sal_uInt16 GetLineCount( sal_uInt32 nParagraph ) const;
sal_Int32 GetLineLen( sal_uInt32 nParagraph, sal_uInt16 nLine ) const;
SAL_DLLPRIVATE void SetRightToLeft( bool bR2L );
bool IsRightToLeft() const { return mbRightToLeft; }
bool HasUndoManager() const { return mpUndoManager != nullptr; }
SfxUndoManager& GetUndoManager();
SAL_DLLPRIVATE void UndoActionStart( sal_uInt16 nId = 0 );
SAL_DLLPRIVATE void UndoActionEnd();
SAL_DLLPRIVATE void InsertUndo( std::unique_ptr<TextUndo> pUndo, bool bTryMerge = false );
bool IsInUndo() const { return mbIsInUndo; }
void SetIsInUndo( bool bInUndo ) { mbIsInUndo = bInUndo; }
void ResetUndo();
void EnableUndo( bool bEnable );
bool IsUndoEnabled() const { return mbUndoEnabled; }
void SetModified( bool bModified ) { mbModified = bModified; }
bool IsModified() const { return mbModified; }
bool Read( SvStream& rInput, const TextSelection* pSel = nullptr );
void Write( SvStream& rOutput );
TextPaM GetPaM( const Point& rDocPos );
tools::Rectangle PaMtoEditCursor( const TextPaM& rPaM, bool bSpecial = false );
OUString GetWord( const TextPaM& rCursorPos, TextPaM* pStartOfWord = nullptr, TextPaM* pEndOfWord = nullptr );
const TextAttrib* FindAttrib( const TextPaM& rPaM, sal_uInt16 nWhich ) const;
SAL_DLLPRIVATE const TextCharAttrib* FindCharAttrib( const TextPaM& rPaM, sal_uInt16 nWhich ) const;
void RemoveAttribs( sal_uInt32 nPara );
void SetAttrib( const TextAttrib& rAttr, sal_uInt32 nPara, sal_Int32 nStart, sal_Int32 nEnd );
TxtAlign GetTextAlign() const { return meAlign; }
SAL_DLLPRIVATE void SetTextAlign( TxtAlign eAlign );
SAL_DLLPRIVATE void Draw( OutputDevice* pDev, const Point& rPos );
SAL_DLLPRIVATE void SetLocale( const css::lang::Locale& rLocale );
css::lang::Locale const & GetLocale();
SAL_DLLPRIVATE css::uno::Reference< css::i18n::XBreakIterator > const & GetBreakIterator();
static bool DoesKeyChangeText( const KeyEvent& rKeyEvent );
SAL_DLLPRIVATE static bool IsSimpleCharInput( const KeyEvent& rKeyEvent );
const Color& GetTextColor() const { return maTextColor; }
};
#endif // INCLUDED_VCL_TEXTENG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|