summaryrefslogtreecommitdiffstats
path: root/linguistic/source/gciterator.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'linguistic/source/gciterator.hxx')
-rw-r--r--linguistic/source/gciterator.hxx214
1 files changed, 214 insertions, 0 deletions
diff --git a/linguistic/source/gciterator.hxx b/linguistic/source/gciterator.hxx
new file mode 100644
index 0000000000..e25b15a962
--- /dev/null
+++ b/linguistic/source/gciterator.hxx
@@ -0,0 +1,214 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <com/sun/star/i18n/XBreakIterator.hpp>
+#include <com/sun/star/lang/XComponent.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/lang/XEventListener.hpp>
+#include <com/sun/star/linguistic2/XProofreadingIterator.hpp>
+#include <com/sun/star/linguistic2/XLinguServiceEventListener.hpp>
+#include <com/sun/star/linguistic2/XLinguServiceEventBroadcaster.hpp>
+#include <com/sun/star/util/XChangesBatch.hpp>
+
+#include <cppuhelper/implbase.hxx>
+#include <osl/mutex.hxx>
+#include <osl/conditn.hxx>
+#include <osl/thread.h>
+
+#include <com/sun/star/uno/Any.hxx>
+#include <comphelper/interfacecontainer3.hxx>
+#include <i18nlangtag/lang.h>
+
+#include <map>
+#include <optional>
+#include <utility>
+#include <deque>
+
+#include "defs.hxx"
+
+
+struct FPEntry
+{
+ // flat paragraph iterator
+ css::uno::Reference< css::text::XFlatParagraphIterator > m_xParaIterator;
+
+ // flat paragraph
+ css::uno::Reference< css::text::XFlatParagraph > m_xPara;
+
+ // document ID to identify different documents
+ OUString m_aDocId;
+
+ // the starting position to be checked
+ sal_Int32 m_nStartIndex;
+
+ // the flag to identify whether the document does automatic grammar checking
+ bool m_bAutomatic;
+
+ FPEntry()
+ : m_aDocId()
+ , m_nStartIndex( 0 )
+ , m_bAutomatic( false )
+ {
+ }
+};
+
+
+class GrammarCheckingIterator:
+ public cppu::WeakImplHelper
+ <
+ css::linguistic2::XProofreadingIterator,
+ css::linguistic2::XLinguServiceEventListener,
+ css::linguistic2::XLinguServiceEventBroadcaster,
+ css::lang::XComponent,
+ css::lang::XServiceInfo
+ >,
+ public LinguDispatcher
+{
+ //the queue is keeping track of all sentences to be checked
+ //every element of this queue is a FlatParagraphEntry struct-object
+ typedef std::deque< FPEntry > FPQueue_t;
+
+ // queue for entries to be processed
+ FPQueue_t m_aFPEntriesQueue;
+
+ // the flag to end the endless loop
+ bool m_bEnd;
+
+ // Note that it must be the pointer and not the uno-reference to check if it is the same implementation object
+ typedef std::map< XComponent *, OUString > DocMap_t;
+ DocMap_t m_aDocIdMap;
+
+
+ // BCP-47 language tag -> implname mapping
+ typedef std::map< OUString, OUString > GCImplNames_t;
+ GCImplNames_t m_aGCImplNamesByLang;
+
+ // implname -> UNO reference mapping
+ typedef std::map< OUString, css::uno::Reference< css::linguistic2::XProofreader > > GCReferences_t;
+ GCReferences_t m_aGCReferencesByService;
+
+ OUString m_aCurCheckedDocId;
+ bool m_bGCServicesChecked;
+ sal_Int32 m_nDocIdCounter;
+ osl::Condition m_aWakeUpThread;
+ oslThread m_thread;
+
+ //! beware of initialization order!
+ static osl::Mutex& MyMutex();
+ comphelper::OInterfaceContainerHelper3<css::lang::XEventListener> m_aEventListeners;
+ comphelper::OInterfaceContainerHelper3<css::linguistic2::XLinguServiceEventListener> m_aNotifyListeners;
+
+ css::uno::Reference< css::i18n::XBreakIterator > m_xBreakIterator;
+ mutable css::uno::Reference< css::util::XChangesBatch > m_xUpdateAccess;
+
+ void TerminateThread();
+
+ sal_Int32 NextDocId();
+ OUString GetOrCreateDocId( const css::uno::Reference< css::lang::XComponent > &xComp );
+
+ void AddEntry(
+ const css::uno::Reference< css::text::XFlatParagraphIterator >& xFlatParaIterator,
+ const css::uno::Reference< css::text::XFlatParagraph >& xFlatPara,
+ const OUString &rDocId, sal_Int32 nStartIndex, bool bAutomatic );
+
+ void ProcessResult( const css::linguistic2::ProofreadingResult &rRes,
+ const css::uno::Reference< css::text::XFlatParagraphIterator > &rxFlatParagraphIterator,
+ bool bIsAutomaticChecking );
+
+ sal_Int32 GetSuggestedEndOfSentence( const OUString &rText, sal_Int32 nSentenceStartPos, const css::lang::Locale &rLocale );
+
+ void GetConfiguredGCSvcs_Impl();
+ css::uno::Reference< css::linguistic2::XProofreader > GetGrammarChecker( css::lang::Locale & rLocale );
+
+ css::uno::Reference< css::util::XChangesBatch > const & GetUpdateAccess() const;
+
+ GrammarCheckingIterator( const GrammarCheckingIterator & ) = delete;
+ GrammarCheckingIterator & operator = ( const GrammarCheckingIterator & ) = delete;
+
+ // Gets the grammar checker service, using fallback locales if necessary,
+ // and the BCP-47 tag for the updated locale, if the fallback was used.
+ // Precondition: MyMutex() is locked.
+ std::pair<OUString, std::optional<OUString>>
+ getServiceForLocale(const css::lang::Locale& rLocale) const;
+
+public:
+
+ void DequeueAndCheck();
+
+ explicit GrammarCheckingIterator();
+ virtual ~GrammarCheckingIterator() override;
+
+ // XProofreadingIterator
+ virtual void SAL_CALL startProofreading( const css::uno::Reference< css::uno::XInterface >& xDocument, const css::uno::Reference< css::text::XFlatParagraphIteratorProvider >& xIteratorProvider ) override;
+ virtual css::linguistic2::ProofreadingResult SAL_CALL checkSentenceAtPosition( const css::uno::Reference< css::uno::XInterface >& xDocument, const css::uno::Reference< css::text::XFlatParagraph >& xFlatParagraph, const OUString& aText, const css::lang::Locale& aLocale, ::sal_Int32 nStartOfSentencePosition, ::sal_Int32 nSuggestedBehindEndOfSentencePosition, ::sal_Int32 nErrorPositionInParagraph ) override;
+ virtual void SAL_CALL resetIgnoreRules( ) override;
+ virtual sal_Bool SAL_CALL isProofreading( const css::uno::Reference< css::uno::XInterface >& xDocument ) override;
+
+ // XLinguServiceEventListener
+ virtual void SAL_CALL processLinguServiceEvent( const css::linguistic2::LinguServiceEvent& aLngSvcEvent ) override;
+
+ // XLinguServiceEventBroadcaster
+ virtual sal_Bool SAL_CALL addLinguServiceEventListener( const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& xLstnr ) override;
+ virtual sal_Bool SAL_CALL removeLinguServiceEventListener( const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >& xLstnr ) override;
+
+ // XComponent
+ virtual void SAL_CALL dispose( ) override;
+ virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
+ virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
+
+ // XEventListener
+ virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
+
+ // XServiceInfo
+ virtual OUString SAL_CALL getImplementationName( ) override;
+ virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
+ virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) override;
+
+ // LinguDispatcher
+ virtual void SetServiceList( const css::lang::Locale &rLocale, const css::uno::Sequence< OUString > &rSvcImplNames ) override;
+ virtual css::uno::Sequence< OUString > GetServiceList( const css::lang::Locale &rLocale ) const override;
+};
+
+
+/** Implementation of the css::container::XStringKeyMap interface
+ */
+class LngXStringKeyMap : public ::cppu::WeakImplHelper<css::container::XStringKeyMap>
+{
+public:
+ LngXStringKeyMap();
+
+ virtual css::uno::Any SAL_CALL getValue(const OUString& aKey) override;
+ virtual sal_Bool SAL_CALL hasValue(const OUString& aKey) override;
+ virtual void SAL_CALL insertValue(const OUString& aKey, const css::uno::Any& aValue) override;
+ virtual ::sal_Int32 SAL_CALL getCount() override;
+ virtual OUString SAL_CALL getKeyByIndex(::sal_Int32 nIndex) override;
+ virtual css::uno::Any SAL_CALL getValueByIndex(::sal_Int32 nIndex) override;
+
+private:
+ LngXStringKeyMap(LngXStringKeyMap const &) = delete;
+ void operator=(LngXStringKeyMap const &) = delete;
+
+ ~LngXStringKeyMap() override{};
+
+ std::map<OUString, css::uno::Any> maMap;
+};
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */