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
|
/* -*- 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 <vcl/timer.hxx>
#include <IGrammarContact.hxx>
#include <pam.hxx>
#include <ndtxt.hxx>
#include <SwGrammarMarkUp.hxx>
#include <txtfrm.hxx>
#include <svl/listener.hxx>
namespace {
/*
* This class is responsible for the delayed display of grammar checks when a paragraph is edited
* It's a client of the paragraph the cursor points to.
* If the cursor position changes, updateCursorPosition has to be called
* If the grammar checker wants to set a grammar marker at a paragraph, he has to request
* the grammar list from this class. If the requested paragraph is not edited, it returns
* the normal grammar list. But if the paragraph is the active one, a proxy list will be returned and
* all changes are set in this proxy list. If the cursor leaves the paragraph the proxy list
* will replace the old list. If the grammar checker has completed the paragraph ('setChecked')
* then a timer is setup which replaces the old list as well.
*/
class SwGrammarContact final : public IGrammarContact, public SvtListener
{
Timer m_aTimer;
std::unique_ptr<SwGrammarMarkUp> m_pProxyList;
bool m_isFinished;
SwTextNode* m_pTextNode;
DECL_LINK( TimerRepaint, Timer *, void );
public:
SwGrammarContact();
virtual ~SwGrammarContact() override { m_aTimer.Stop(); }
// (pure) virtual functions of IGrammarContact
virtual void updateCursorPosition( const SwPosition& rNewPos ) override;
virtual SwGrammarMarkUp* getGrammarCheck( SwTextNode& rTextNode, bool bCreate ) override;
virtual void finishGrammarCheck( SwTextNode& rTextNode ) override;
void CheckBroadcaster()
{
if(HasBroadcaster())
return;
m_pTextNode = nullptr;
m_pProxyList.reset();
}
};
}
SwGrammarContact::SwGrammarContact()
: m_aTimer( "sw::SwGrammarContact TimerRepaint" ),
m_isFinished( false ),
m_pTextNode(nullptr)
{
m_aTimer.SetTimeout( 2000 ); // Repaint of grammar check after 'setChecked'
m_aTimer.SetInvokeHandler( LINK(this, SwGrammarContact, TimerRepaint) );
}
IMPL_LINK( SwGrammarContact, TimerRepaint, Timer *, pTimer, void )
{
CheckBroadcaster();
if( pTimer )
{
pTimer->Stop();
if( m_pTextNode )
{ //Replace the old wrong list by the proxy list and repaint all frames
m_pTextNode->SetGrammarCheck( std::move(m_pProxyList) );
SwTextFrame::repaintTextFrames( *m_pTextNode );
}
}
}
/* I'm always a client of the current paragraph */
void SwGrammarContact::updateCursorPosition( const SwPosition& rNewPos )
{
CheckBroadcaster();
SwTextNode* pTextNode = rNewPos.nNode.GetNode().GetTextNode();
if( pTextNode == m_pTextNode ) // paragraph has been changed
return;
m_aTimer.Stop();
if( m_pTextNode ) // My last paragraph has been left
{
if( m_pProxyList )
{ // replace old list by the proxy list and repaint
m_pTextNode->SetGrammarCheck( std::move(m_pProxyList) );
SwTextFrame::repaintTextFrames( *m_pTextNode );
}
EndListeningAll();
}
if( pTextNode )
{
m_pTextNode = pTextNode;
EndListeningAll();
StartListening(pTextNode->GetNotifier()); // welcome new paragraph
}
}
/* deliver a grammar check list for the given text node */
SwGrammarMarkUp* SwGrammarContact::getGrammarCheck( SwTextNode& rTextNode, bool bCreate )
{
SwGrammarMarkUp *pRet = nullptr;
CheckBroadcaster();
if( m_pTextNode == &rTextNode ) // hey, that's my current paragraph!
{ // so you will get a proxy list...
if( bCreate )
{
if( m_isFinished )
{
m_pProxyList.reset();
}
if( !m_pProxyList )
{
if( rTextNode.GetGrammarCheck() )
m_pProxyList.reset( static_cast<SwGrammarMarkUp*>(rTextNode.GetGrammarCheck()->Clone()) );
else
{
m_pProxyList.reset( new SwGrammarMarkUp() );
m_pProxyList->SetInvalid( 0, COMPLETE_STRING );
}
}
m_isFinished = false;
}
pRet = m_pProxyList.get();
}
else
{
pRet = rTextNode.GetGrammarCheck(); // do you have already a list?
if( bCreate && !pRet ) // do you want to create a list?
{
pRet = new SwGrammarMarkUp();
pRet->SetInvalid( 0, COMPLETE_STRING );
rTextNode.SetGrammarCheck( std::unique_ptr<SwGrammarMarkUp>(pRet) );
rTextNode.SetGrammarCheckDirty( true );
}
}
return pRet;
}
void SwGrammarContact::finishGrammarCheck( SwTextNode& rTextNode )
{
CheckBroadcaster();
if( &rTextNode != m_pTextNode ) // not my paragraph
SwTextFrame::repaintTextFrames( rTextNode ); // can be repainted directly
else
{
if( m_pProxyList )
{
m_isFinished = true;
m_aTimer.Start(); // will replace old list and repaint with delay
}
else if( m_pTextNode->GetGrammarCheck() )
{ // all grammar problems seems to be gone, no delay needed
m_pTextNode->ClearGrammarCheck();
SwTextFrame::repaintTextFrames( *m_pTextNode );
}
}
}
IGrammarContact* createGrammarContact()
{
return new SwGrammarContact();
}
void finishGrammarCheck( SwTextNode& rTextNode )
{
IGrammarContact* pGrammarContact = getGrammarContact( rTextNode );
if( pGrammarContact )
pGrammarContact->finishGrammarCheck( rTextNode );
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
