sw: combine IGrammarContact and SwGrammarContact

Change-Id: I4b9ab45ff8e21fa5091894f2cd5e3c7de57df425
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/141431
Tested-by: Jenkins
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>

8 files changed, 71 insertions, 82 deletions

diff --git a/sw/inc/IGrammarContact.hxx b/sw/inc/IGrammarContact.hxx
index a2e4cecfeb2e..f2dc8ebe0ee2 100644
--- a/sw/inc/IGrammarContact.hxx
+++ b/sw/inc/IGrammarContact.hxx
@@ -19,29 +19,52 @@
 
 #pragma once
 
+#include <SwGrammarMarkUp.hxx>
+#include <svl/listener.hxx>
+#include <vcl/timer.hxx>
+
 struct SwPosition;
 class SwTextNode;
-class SwGrammarMarkUp;
 
-/** Organizer of the contact between SwTextNodes and grammar checker
-*/
-class IGrammarContact
+namespace sw
 {
+/**
+ * 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 GrammarContact final : public SvtListener
+{
+    Timer m_aTimer;
+    std::unique_ptr<SwGrammarMarkUp> m_pProxyList;
+    bool m_isFinished;
+    SwTextNode* m_pTextNode;
+    DECL_LINK(TimerRepaint, Timer*, void);
+
 public:
+    GrammarContact();
+    ~GrammarContact() { m_aTimer.Stop(); }
+
     /** Update cursor position reacts to a change of the current input cursor
         As long as the cursor in inside a paragraph, the grammar checking does
         not show new grammar faults. When the cursor leaves the paragraph, these
         faults are shown.
     @returns void
     */
-    virtual void updateCursorPosition(const SwPosition& rNewPos) = 0;
+    void updateCursorPosition(const SwPosition& rNewPos);
 
     /** getGrammarCheck checks if the given text node is blocked by the current cursor
         if not, the normal markup list is returned
         if blocked, it will return a markup list "proxy"
     @returns a markup list (grammar) for the given SwTextNode
     */
-    virtual SwGrammarMarkUp* getGrammarCheck(SwTextNode& rTextNode, bool bCreate) = 0;
+    SwGrammarMarkUp* getGrammarCheck(SwTextNode& rTextNode, bool bCreate);
 
     /** finishGrammarCheck() has to be called if a grammar checking has been completed
         for a text node. If this text node has not been hidden by the current proxy list
@@ -49,27 +72,22 @@ public:
         repaint will be triggered by a timer
     @returns void
     */
-    virtual void finishGrammarCheck(SwTextNode& rTextNode) = 0;
+    void finishGrammarCheck(SwTextNode& rTextNode);
 
-public:
-    virtual ~IGrammarContact() {}
+    void CheckBroadcaster();
 };
 
-/** Factory for a grammar contact
-@returns a new created grammar contact object
-*/
-IGrammarContact* createGrammarContact();
-
 /* Helper functions */
 
 /** getGrammarContact() delivers the grammar contact of the document (for a given textnode)
 @returns grammar contact
 */
-IGrammarContact* getGrammarContact(const SwTextNode&);
+GrammarContact* getGrammarContact(const SwTextNode&);
 
 /** finishGrammarCheck() calls the same function of the grammar contact of the document (for a given textnode)
 @returns void
 */
 void finishGrammarCheck(SwTextNode&);
+}
 
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sw/inc/doc.hxx b/sw/inc/doc.hxx
index f3662cb02b17..62785cb8bce8 100644
--- a/sw/inc/doc.hxx
+++ b/sw/inc/doc.hxx
@@ -112,7 +112,6 @@ struct SwSortOptions;
 struct SwDefTOXBase_Impl;
 class SwPrintUIOptions;
 struct SwConversionArgs;
-class IGrammarContact;
 class SwRenderData;
 class IDocumentUndoRedo;
 class IDocumentSettingAccess;
@@ -162,6 +161,7 @@ namespace sw {
     class DocumentLayoutManager;
     class DocumentStylePoolManager;
     class DocumentExternalDataManager;
+    class GrammarContact;
 }
 
 namespace com::sun::star {
@@ -282,7 +282,7 @@ class SW_DLLPUBLIC SwDoc final
     std::unique_ptr<SwLayoutCache> mpLayoutCache;                /**< Layout cache to read and save with the
                                                                     document for a faster formatting */
 
-    std::unique_ptr<IGrammarContact> mpGrammarContact;             //< for grammar checking in paragraphs during editing
+    std::unique_ptr<sw::GrammarContact> mpGrammarContact; //< for grammar checking in paragraphs during editing
 
     css::uno::Reference< css::script::vba::XVBAEventProcessor > mxVbaEvents;
     css::uno::Reference< ooo::vba::word::XFind > mxVbaFind;
@@ -1559,7 +1559,7 @@ public:
     */
     bool ContainsHiddenChars() const;
 
-    IGrammarContact* getGrammarContact() const { return mpGrammarContact.get(); }
+    std::unique_ptr<sw::GrammarContact> const& getGrammarContact() const { return mpGrammarContact; }
 
     /** Marks/Unmarks a list level of a certain list
 
diff --git a/sw/source/core/crsr/crsrsh.cxx b/sw/source/core/crsr/crsrsh.cxx
index d0a71e136d33..41a12ab26229 100644
--- a/sw/source/core/crsr/crsrsh.cxx
+++ b/sw/source/core/crsr/crsrsh.cxx
@@ -1502,9 +1502,10 @@ void SwCursorShell::UpdateCursorPos()
                                      &aTmpState );
         pShellCursor->DeleteMark();
     }
-    IGrammarContact *pGrammarContact = GetDoc() ? GetDoc()->getGrammarContact() : nullptr;
-    if( pGrammarContact )
-        pGrammarContact->updateCursorPosition( *m_pCurrentCursor->GetPoint() );
+    auto* pDoc = GetDoc();
+    if (pDoc)
+        pDoc->getGrammarContact()->updateCursorPosition(*m_pCurrentCursor->GetPoint());
+
     --mnStartAction;
     if( aOldSz != GetDocSize() )
         SizeChgNotify();
diff --git a/sw/source/core/doc/docnew.cxx b/sw/source/core/doc/docnew.cxx
index 798a279b930a..55bb56da9dc7 100644
--- a/sw/source/core/doc/docnew.cxx
+++ b/sw/source/core/doc/docnew.cxx
@@ -247,7 +247,7 @@ SwDoc::SwDoc()
     mpNumberFormatter( nullptr ),
     mpNumRuleTable( new SwNumRuleTable ),
     mpExtInputRing( nullptr ),
-    mpGrammarContact(createGrammarContact()),
+    mpGrammarContact(new sw::GrammarContact),
     mpCellStyles(new SwCellStyleTable),
     mReferenceCount(0),
     mbDtor(false),
@@ -808,14 +808,19 @@ void SwDoc::WriteLayoutCache( SvStream& rStream )
     SwLayoutCache::Write( rStream, *this );
 }
 
-IGrammarContact* getGrammarContact( const SwTextNode& rTextNode )
+namespace sw
+{
+
+sw::GrammarContact* getGrammarContact(const SwTextNode& rTextNode)
 {
     const SwDoc& rDoc = rTextNode.GetDoc();
     if (rDoc.IsInDtor())
         return nullptr;
-    return rDoc.getGrammarContact();
+    return rDoc.getGrammarContact().get();
 }
 
+} // end sw
+
 ::sfx2::IXmlIdRegistry&
 SwDoc::GetXmlIdRegistry()
 {
diff --git a/sw/source/core/text/txtfrm.cxx b/sw/source/core/text/txtfrm.cxx
index af3955a23e87..405d124c09e0 100644
--- a/sw/source/core/text/txtfrm.cxx
+++ b/sw/source/core/text/txtfrm.cxx
@@ -1801,7 +1801,7 @@ static void lcl_SetWrong( SwTextFrame& rFrame, SwTextNode const& rNode,
     if ( !rFrame.IsFollow() )
     {
         SwTextNode* pTextNode = const_cast<SwTextNode*>(&rNode);
-        IGrammarContact* pGrammarContact = getGrammarContact( *pTextNode );
+        sw::GrammarContact* pGrammarContact = getGrammarContact(*pTextNode);
         SwGrammarMarkUp* pWrongGrammar = pGrammarContact ?
             pGrammarContact->getGrammarCheck( *pTextNode, false ) :
             pTextNode->GetGrammarCheck();
diff --git a/sw/source/core/txtnode/SwGrammarContact.cxx b/sw/source/core/txtnode/SwGrammarContact.cxx
index e2c1049f42ec..aaddc1406cfb 100644
--- a/sw/source/core/txtnode/SwGrammarContact.cxx
+++ b/sw/source/core/txtnode/SwGrammarContact.cxx
@@ -17,64 +17,32 @@
  *   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
+namespace sw
 {
-    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()
+GrammarContact::GrammarContact()
   : 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) );
+    m_aTimer.SetInvokeHandler( LINK(this, GrammarContact, TimerRepaint) );
 }
 
-IMPL_LINK( SwGrammarContact, TimerRepaint, Timer *, pTimer, void )
+void GrammarContact::CheckBroadcaster()
+{
+    if (HasBroadcaster())
+        return;
+    m_pTextNode = nullptr;
+    m_pProxyList.reset();
+}
+
+IMPL_LINK( GrammarContact, TimerRepaint, Timer *, pTimer, void )
 {
     CheckBroadcaster();
     if( pTimer )
@@ -89,7 +57,7 @@ IMPL_LINK( SwGrammarContact, TimerRepaint, Timer *, pTimer, void )
 }
 
 /* I'm always a client of the current paragraph */
-void SwGrammarContact::updateCursorPosition( const SwPosition& rNewPos )
+void GrammarContact::updateCursorPosition( const SwPosition& rNewPos )
 {
     CheckBroadcaster();
     SwTextNode* pTextNode = rNewPos.GetNode().GetTextNode();
@@ -115,7 +83,7 @@ void SwGrammarContact::updateCursorPosition( const SwPosition& rNewPos )
 }
 
 /* deliver a grammar check list for the given text node */
-SwGrammarMarkUp* SwGrammarContact::getGrammarCheck( SwTextNode& rTextNode, bool bCreate )
+SwGrammarMarkUp* GrammarContact::getGrammarCheck( SwTextNode& rTextNode, bool bCreate )
 {
     SwGrammarMarkUp *pRet = nullptr;
     CheckBroadcaster();
@@ -155,7 +123,7 @@ SwGrammarMarkUp* SwGrammarContact::getGrammarCheck( SwTextNode& rTextNode, bool
     return pRet;
 }
 
-void SwGrammarContact::finishGrammarCheck( SwTextNode& rTextNode )
+void GrammarContact::finishGrammarCheck( SwTextNode& rTextNode )
 {
     CheckBroadcaster();
     if( &rTextNode != m_pTextNode ) // not my paragraph
@@ -175,16 +143,13 @@ void SwGrammarContact::finishGrammarCheck( SwTextNode& rTextNode )
     }
 }
 
-IGrammarContact* createGrammarContact()
-{
-    return new SwGrammarContact();
-}
-
 void finishGrammarCheck( SwTextNode& rTextNode )
 {
-    IGrammarContact* pGrammarContact = getGrammarContact( rTextNode );
-    if( pGrammarContact )
+    sw::GrammarContact* pGrammarContact = getGrammarContact( rTextNode );
+    if (pGrammarContact)
         pGrammarContact->finishGrammarCheck( rTextNode );
 }
 
+} // end sw
+
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sw/source/core/unocore/unoflatpara.cxx b/sw/source/core/unocore/unoflatpara.cxx
index 6fa124a824fd..4f2c8e385620 100644
--- a/sw/source/core/unocore/unoflatpara.cxx
+++ b/sw/source/core/unocore/unoflatpara.cxx
@@ -190,7 +190,7 @@ void SAL_CALL SwXFlatParagraph::setChecked( ::sal_Int32 nType, sal_Bool bVal )
     {
         GetTextNode()->SetGrammarCheckDirty( !bVal );
         if( bVal )
-            ::finishGrammarCheck( *GetTextNode() );
+            sw::finishGrammarCheck( *GetTextNode() );
     }
 }
 
diff --git a/sw/source/core/unocore/unotextmarkup.cxx b/sw/source/core/unocore/unotextmarkup.cxx
index 8160da91a8ae..86add0f34c9c 100644
--- a/sw/source/core/unocore/unotextmarkup.cxx
+++ b/sw/source/core/unocore/unotextmarkup.cxx
@@ -157,7 +157,7 @@ void SAL_CALL SwXTextMarkup::commitStringMarkup(
     }
     else if ( nType == text::TextMarkupType::PROOFREADING || nType == text::TextMarkupType::SENTENCE )
     {
-        IGrammarContact *pGrammarContact = getGrammarContact(*m_pImpl->m_pTextNode);
+        sw::GrammarContact* pGrammarContact = getGrammarContact(*m_pImpl->m_pTextNode);
         if( pGrammarContact )
         {
             pWList = pGrammarContact->getGrammarCheck(*m_pImpl->m_pTextNode, true);
@@ -411,7 +411,7 @@ void SAL_CALL SwXTextMarkup::commitMultiTextMarkup(
     // get appropriate list to use...
     SwGrammarMarkUp* pWList = nullptr;
     bool bRepaint = false;
-    IGrammarContact *pGrammarContact = getGrammarContact(*m_pImpl->m_pTextNode);
+    sw::GrammarContact* pGrammarContact = getGrammarContact(*m_pImpl->m_pTextNode);
     if( pGrammarContact )
     {
         pWList = pGrammarContact->getGrammarCheck(*m_pImpl->m_pTextNode, true);