LCOV - code coverage report
Current view: top level - libreoffice/solver/unxlngi6.pro/inc/svx - fmsrcimp.hxx (source / functions) Hit Total Coverage
Test: libreoffice_filtered.info Lines: 0 26 0.0 %
Date: 2012-12-27 Functions: 0 27 0.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef _FMSRCIMP_HXX
      21             : #define _FMSRCIMP_HXX
      22             : 
      23             : #include <svx/fmtools.hxx>
      24             : #include "svx/svxdllapi.h"
      25             : 
      26             : #include <com/sun/star/awt/XCheckBox.hpp>
      27             : #include <com/sun/star/awt/XListBox.hpp>
      28             : #include <com/sun/star/awt/XTextComponent.hpp>
      29             : #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
      30             : #include <com/sun/star/util/XNumberFormatter.hpp>
      31             : 
      32             : #include <comphelper/stl_types.hxx>
      33             : #include <cppuhelper/implbase1.hxx>
      34             : #include <osl/mutex.hxx>
      35             : #include <unotools/charclass.hxx>
      36             : #include <unotools/collatorwrapper.hxx>
      37             : #include <osl/thread.hxx>
      38             : 
      39             : #include <deque>
      40             : 
      41             : // ===================================================================================================
      42             : // = class FmSearchThread
      43             : // ===================================================================================================
      44             : 
      45             : class FmSearchEngine;
      46             : class FmSearchThread : public ::osl::Thread
      47             : {
      48             :     FmSearchEngine*     m_pEngine;
      49             :     Link                m_aTerminationHdl;
      50             : 
      51             :     virtual void SAL_CALL run();
      52             :     virtual void SAL_CALL onTerminated();
      53             : 
      54             : public:
      55             :     FmSearchThread(FmSearchEngine* pEngine) : m_pEngine(pEngine) { }
      56             :     void setTerminationHandler(Link aHdl) { m_aTerminationHdl = aHdl; }
      57             : };
      58             : 
      59             : // ===================================================================================================
      60             : // = struct FmSearchProgress - the owner of SearchEngine receives this structure for status updates
      61             : // = (at the end of the search)
      62             : // ===================================================================================================
      63             : 
      64             : struct FmSearchProgress
      65             : {
      66             :     enum STATE { STATE_PROGRESS, STATE_PROGRESS_COUNTING, STATE_CANCELED, STATE_SUCCESSFULL, STATE_NOTHINGFOUND, STATE_ERROR };
      67             :         // (move to new record; progress during counting of records; cancelled; record found; nothing found;
      68             :         // any non-processable error)
      69             :     STATE   aSearchState;
      70             : 
      71             :     // current record - always valid (e.g. of interest for continuing search in case of cancellation)
      72             :     sal_uInt32  nCurrentRecord;
      73             :     // Overflow - only valid in case of STATE_PROGRESS
      74             :     sal_Bool    bOverflow;
      75             : 
      76             :     // the position of the search cursor - valid in case of STATE_SUCCESSFULL, STATE_CANCELED and STATE_NOTHING_FOUND
      77             :     ::com::sun::star::uno::Any  aBookmark;
      78             :     // the field, in which the text was found - valid in case of STATE_SUCCESSFULL
      79             :     sal_Int32   nFieldIndex;
      80             : };
      81             : 
      82             : // ===================================================================================================
      83             : // = class FmRecordCountListener - utility class for FmSearchEngine, listens at a certain cursor and provides
      84             : // =                                the differences in RecordCount
      85             : // ===================================================================================================
      86             : 
      87             : class FmRecordCountListener : public ::cppu::WeakImplHelper1< ::com::sun::star::beans::XPropertyChangeListener>
      88             : {
      89             : // attribute
      90             :     Link            m_lnkWhoWantsToKnow;
      91             :     ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >   m_xListening;
      92             : 
      93             : // attribute access
      94             : public:
      95             :     Link SetPropChangeHandler(const Link& lnk);
      96             : 
      97             : // methods
      98             : public:
      99             :     FmRecordCountListener(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& dbcCursor);
     100             :         // the set has to support the sdb::ResultSet service
     101             :     virtual ~FmRecordCountListener();
     102             : 
     103             :     //  DECLARE_UNO3_AGG_DEFAULTS(FmPropertyListener, UsrObject);
     104             :     //  virtual sal_Bool queryInterface(::com::sun::star::uno::Uik aUik, ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& rOut);
     105             : 
     106             : // ::com::sun::star::lang::XEventListener
     107             :     virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& Source) throw(::com::sun::star::uno::RuntimeException);
     108             : 
     109             : // ::com::sun::star::beans::XPropertyChangeListener
     110             :     virtual void SAL_CALL propertyChange(const ::com::sun::star::beans::PropertyChangeEvent& evt) throw(::com::sun::star::uno::RuntimeException);
     111             : 
     112             :     void DisConnect();
     113             : 
     114             : private:
     115             :     void NotifyCurrentCount();
     116             : 
     117             : };
     118             : 
     119             : // ===================================================================================================
     120             : // = class FmSearchEngine - Impl class for FmSearchDialog
     121             : // ===================================================================================================
     122             : 
     123             : namespace svxform {
     124             :     // We have three possible control types we may search in, determined by the supported interfaces : ::com::sun::star::awt::XTextComponent, ::com::sun::star::awt::XListBox, ::com::sun::star::awt::XCheckBox.
     125             :     // While searching we don't want to do this distinction for every control in every round. So we need some helpers.
     126             :     class ControlTextWrapper
     127             :     {
     128             :         // attributes
     129             :         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >   m_xControl;
     130             :         // attribute access
     131             :     public:
     132             :         ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >  getControl() const{ return m_xControl; }
     133             :     public:
     134             :         ControlTextWrapper(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _xControl) { m_xControl = _xControl; }
     135           0 :         virtual ~ControlTextWrapper() { }
     136             : 
     137             :         virtual ::rtl::OUString getCurrentText() const = 0;
     138             :     };
     139             :     class SimpleTextWrapper : public ControlTextWrapper
     140             :     {
     141             :         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTextComponent >  m_xText;
     142             :     public:
     143             :         SimpleTextWrapper(const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTextComponent >& _xText);
     144             :         virtual ::rtl::OUString getCurrentText() const;
     145             :     };
     146             :     class ListBoxWrapper : public ControlTextWrapper
     147             :     {
     148             :         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XListBox >  m_xBox;
     149             :     public:
     150             :         ListBoxWrapper(const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XListBox >& _xBox);
     151             :         virtual ::rtl::OUString getCurrentText() const;
     152             :     };
     153             :     class CheckBoxWrapper : public ControlTextWrapper
     154             :     {
     155             :         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XCheckBox >  m_xBox;
     156             :     public:
     157             :         CheckBoxWrapper(const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XCheckBox >& _xBox);
     158             :         virtual ::rtl::OUString getCurrentText() const;
     159             :     };
     160             : }
     161             : 
     162             : enum FMSEARCH_MODE { SM_BRUTE, SM_ALLOWSCHEDULE, SM_USETHREAD };
     163             : 
     164             : DECLARE_STL_VECTOR( ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>, InterfaceArray);
     165             : 
     166             : class SVX_DLLPUBLIC FmSearchEngine
     167             : {
     168             :     friend class FmSearchThread;
     169             : 
     170             :     enum SEARCH_RESULT { SR_FOUND, SR_NOTFOUND, SR_ERROR, SR_CANCELED };
     171             :     enum SEARCHFOR_TYPE { SEARCHFOR_STRING, SEARCHFOR_NULL, SEARCHFOR_NOTNULL };
     172             : 
     173             :     CursorWrapper                   m_xSearchCursor;
     174             :     std::deque<sal_Int32>           m_arrFieldMapping;
     175             :         // since the iterator could have more columns, as managed here (in this field listbox),
     176             :         // a mapping of this ::com::sun::star::form keys on the indices of the respective columns is kept in the iterator
     177             : 
     178             :     // the formatter
     179             :     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >  m_xFormatSupplier;
     180             :     ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >        m_xFormatter;
     181             : 
     182             :     CharClass               m_aCharacterClassficator;
     183             :     CollatorWrapper         m_aStringCompare;
     184             : 
     185             :     // the collection of all interesting fields (or their ::com::sun::star::data::XDatabaseVariant interfaces and FormatKeys)
     186             :     struct FieldInfo
     187             :     {
     188             :         ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn >          xContents;
     189             :         sal_uInt32              nFormatKey;
     190             :         sal_Bool                bDoubleHandling;
     191             :     };
     192             : 
     193             :     DECLARE_STL_VECTOR(FieldInfo, FieldCollection);
     194             :     FieldCollection             m_arrUsedFields;
     195             :     sal_Int32                   m_nCurrentFieldIndex;   // the last parameter of RebuildUsedFields, it allows checks in FormatField
     196             : 
     197             :     DECLARE_STL_VECTOR(svxform::ControlTextWrapper*, ControlTextSuppliers);
     198             :     ControlTextSuppliers    m_aControlTexts;
     199             : 
     200             :     sal_Bool                m_bUsingTextComponents;
     201             :     CursorWrapper           m_xOriginalIterator;
     202             :     CursorWrapper           m_xClonedIterator;
     203             : 
     204             :     // data for the decision in which field a "Found" is accepted
     205             :     ::com::sun::star::uno::Any  m_aPreviousLocBookmark;             // position of the last finding
     206             :     FieldCollectionIterator     m_iterPreviousLocField;             // field of the last finding
     207             : 
     208             :     // Kommunikation mit dem Thread, der die eigentliche Suche durchfuehrt
     209             :     ::rtl::OUString             m_strSearchExpression;              // forward direction
     210             :     SEARCHFOR_TYPE      m_eSearchForType;                   // ditto
     211             :     SEARCH_RESULT       m_srResult;                         // backward direction
     212             : 
     213             :     // der Link, dem ich Fortschritte und Ergebnisse mitteile
     214             :     Link                m_aProgressHandler;
     215             :     sal_Bool            m_bSearchingCurrently : 1;      // is an (asynchronous) search running?
     216             :     sal_Bool            m_bCancelAsynchRequest : 1;     // should be cancelled ?
     217             :     ::osl::Mutex        m_aCancelAsynchAccess;          // access to_bCancelAsynchRequest (technically only
     218             :                                                         // relevant for m_eMode == SM_USETHREAD)
     219             :     FMSEARCH_MODE   m_eMode;                            // current mode
     220             : 
     221             :     // parameters for the search
     222             :     sal_Bool    m_bFormatter : 1;       // use field formatting
     223             :     sal_Bool    m_bForward : 1;         // direction
     224             :     sal_Bool    m_bWildcard : 1;        // wildcard search
     225             :     sal_Bool    m_bRegular : 1;         // regular expression
     226             :     sal_Bool    m_bLevenshtein : 1;     // Levenshtein search
     227             :     sal_Bool    m_bTransliteration : 1; // Levenshtein search
     228             : 
     229             :     sal_Bool    m_bLevRelaxed : 1;      // parameters for Levenshtein search
     230             :     sal_uInt16  m_nLevOther;
     231             :     sal_uInt16  m_nLevShorter;
     232             :     sal_uInt16  m_nLevLonger;
     233             : 
     234             :     sal_uInt16  m_nPosition;            // if not regular or levenshtein, then one of the MATCHING_... values
     235             : 
     236             :     sal_Int32   m_nTransliterationFlags;
     237             : 
     238             : // -------------
     239             : // member access
     240             : private:
     241             :     SVX_DLLPRIVATE sal_Bool CancelRequested();      // provides a through m_aCancelAsynchAccess backed interpretation of m_bCancelAsynchRequest
     242             : 
     243             : public:
     244             :     void        SetCaseSensitive(sal_Bool bSet);
     245             :     sal_Bool    GetCaseSensitive() const;
     246             : 
     247             :     void        SetFormatterUsing(sal_Bool bSet);   // this is somewhat more extensive, so no inline ... here
     248           0 :     sal_Bool    GetFormatterUsing() const           { return m_bFormatter; }
     249             : 
     250           0 :     void        SetDirection(sal_Bool bForward)     { m_bForward = bForward; }
     251           0 :     sal_Bool    GetDirection() const                { return m_bForward; }
     252             : 
     253           0 :     void        SetWildcard(sal_Bool bSet)          { m_bWildcard = bSet; }
     254           0 :     sal_Bool    GetWildcard() const                 { return m_bWildcard; }
     255             : 
     256           0 :     void        SetRegular(sal_Bool bSet)           { m_bRegular = bSet; }
     257           0 :     sal_Bool    GetRegular() const                  { return m_bRegular; }
     258             : 
     259           0 :     void        SetLevenshtein(sal_Bool bSet)       { m_bLevenshtein = bSet; }
     260           0 :     sal_Bool    GetLevenshtein() const              { return m_bLevenshtein; }
     261             : 
     262             :     void        SetIgnoreWidthCJK(sal_Bool bSet);
     263             :     sal_Bool    GetIgnoreWidthCJK() const;
     264             : 
     265           0 :     void        SetTransliteration(sal_Bool bSet)   { m_bTransliteration = bSet; }
     266           0 :     sal_Bool    GetTransliteration() const          { return m_bTransliteration; }
     267             : 
     268           0 :     void        SetLevRelaxed(sal_Bool bSet)        { m_bLevRelaxed = bSet; }
     269           0 :     sal_Bool    GetLevRelaxed() const               { return m_bLevRelaxed; }
     270           0 :     void        SetLevOther(sal_uInt16 nHowMuch)    { m_nLevOther = nHowMuch; }
     271           0 :     sal_uInt16  GetLevOther() const                 { return m_nLevOther; }
     272           0 :     void        SetLevShorter(sal_uInt16 nHowMuch)  { m_nLevShorter = nHowMuch; }
     273           0 :     sal_uInt16  GetLevShorter() const               { return m_nLevShorter; }
     274           0 :     void        SetLevLonger(sal_uInt16 nHowMuch)   { m_nLevLonger = nHowMuch; }
     275           0 :     sal_uInt16  GetLevLonger() const                { return m_nLevLonger; }
     276             :         // all Lev. values will only be considered in case of m_bLevenshtein==sal_True
     277             : 
     278           0 :     void        SetTransliterationFlags(sal_Int32 _nFlags)  { m_nTransliterationFlags = _nFlags; }
     279           0 :     sal_Int32   GetTransliterationFlags() const             { return m_nTransliterationFlags; }
     280             : 
     281           0 :     void    SetPosition(sal_uInt16 nValue)      { m_nPosition = nValue; }
     282           0 :     sal_uInt16  GetPosition() const             { return m_nPosition; }
     283             :         // position will be ignored in case of m_bWildCard==sal_True
     284             : 
     285           0 :     FMSEARCH_MODE GetSearchMode() const { return m_eMode; }
     286             : 
     287             : public:
     288             :     /** two constructs, both analogical to FmSearchDialog, therefore look this up for explanations ....
     289             :         xCursor has to implement ::com::sun::star::data::DatabaseCursor service  each time.
     290             :         If eMode == SM_USETHREAD, a ProgressHandler should be set, because in this case the result forwarding will be done
     291             :         by this handler.
     292             :         If eMode != SM_USETHREAD, SearchNext and StarOver won't return, until the search has finished (independently of its
     293             :         success), only then the result can be requested. If additionally the ProgressHandler is set, it will be called for
     294             :         every record as well as at the end of the search.
     295             :     */
     296             :     FmSearchEngine(
     297             :         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
     298             :         const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& xCursor,
     299             :         const ::rtl::OUString& strVisibleFields,
     300             :         const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >& xFormat,
     301             :         FMSEARCH_MODE eMode);
     302             :     FmSearchEngine(
     303             :         const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
     304             :         const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& xCursor,
     305             :         const ::rtl::OUString& strVisibleFields,
     306             :         const InterfaceArray& arrFields,
     307             :         FMSEARCH_MODE eMode);
     308             : 
     309             :     virtual ~FmSearchEngine();
     310             : 
     311             :     /** the link will be called on every record and after the completion of the search, the parameter is a pointer to
     312             :         a FmSearchProgress structure
     313             :         the handler should be in any case thread-safe
     314             :     */
     315           0 :     void SetProgressHandler(Link aHdl) { m_aProgressHandler = aHdl; }
     316             : 
     317             :     /// search for the next appearance (for nDirection values check DIRECTION_*-defines)
     318             :     void SearchNext(const ::rtl::OUString& strExpression);
     319             :     /// analogous, search for "NULL" (_bSearchForNull==sal_True) or "not NULL"
     320             :     void SearchNextSpecial(sal_Bool _bSearchForNull);
     321             :     /// search for the next appearance, dependent on nDirection from the start or end
     322             :     void StartOver(const ::rtl::OUString& strExpression);
     323             :     /// analogous, search for "NULL" (_bSearchForNull==sal_True) or "not NULL"
     324             :     void StartOverSpecial(sal_Bool _bSearchForNull);
     325             :     /// invalidate previous search reference
     326             :     void InvalidatePreviousLoc();
     327             : 
     328             :     /** rebuilds m_arrUsedFields (nFieldIndex==-1 means all fields, otherwise it specifies the field index)
     329             :         if bForce is not set, nothing will happen in case of nFieldIndex == m_nCurrentFieldIndex
     330             :         (calls InvalidatePreviousLoc)
     331             :     */
     332             :     void RebuildUsedFields(sal_Int32 nFieldIndex, sal_Bool bForce = sal_False);
     333             :     ::rtl::OUString FormatField(sal_Int32 nWhich);
     334             : 
     335             :     /// returns directly; once it was really aborted, ProgressHandler is called with STATE_CANCELED
     336             :     void CancelSearch();
     337             : 
     338             :     /** only valid, if not an (asynchronous) search is running, the next search will then be executed
     339             :         on top of the new iterator with the new parameter
     340             :     */
     341             :     sal_Bool SwitchToContext(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& xCursor, const ::rtl::OUString& strVisibleFields, const InterfaceArray& arrFields,
     342             :         sal_Int32 nFieldIndex);
     343             : 
     344             : protected:
     345             :     void Init(const ::rtl::OUString& strVisibleFields);
     346             : 
     347             :     void SearchNextImpl();
     348             :         // this Impl method is running in SearchThread
     349             : 
     350             :     // start a thread-search (or call SearchNextImpl directly, depending on the search mode)
     351             :     void ImplStartNextSearch();
     352             : 
     353             : private:
     354             :     SVX_DLLPRIVATE void clearControlTexts();
     355             :     SVX_DLLPRIVATE void fillControlTexts(const InterfaceArray& arrFields);
     356             : 
     357             :     // three methods implementing a complete search loop (null/not null, wildcard, SearchText)
     358             :     // (they all have some code in common, but with this solution we have do do a distinction only once per search (before
     359             :     // starting the loop), not in every loop step
     360             :     SVX_DLLPRIVATE SEARCH_RESULT SearchSpecial(sal_Bool _bSearchForNull, sal_Int32& nFieldPos, FieldCollectionIterator& iterFieldLoop,
     361             :         const FieldCollectionIterator& iterBegin, const FieldCollectionIterator& iterEnd);
     362             :     SVX_DLLPRIVATE SEARCH_RESULT SearchWildcard(const ::rtl::OUString& strExpression, sal_Int32& nFieldPos, FieldCollectionIterator& iterFieldLoop,
     363             :         const FieldCollectionIterator& iterBegin, const FieldCollectionIterator& iterEnd);
     364             :     SVX_DLLPRIVATE SEARCH_RESULT SearchRegularApprox(const ::rtl::OUString& strExpression, sal_Int32& nFieldPos, FieldCollectionIterator& iterFieldLoop,
     365             :         const FieldCollectionIterator& iterBegin, const FieldCollectionIterator& iterEnd);
     366             : 
     367             :     SVX_DLLPRIVATE void PropagateProgress(sal_Bool _bDontPropagateOverflow);
     368             :         // call the ProgressHandler with STATE_PROGRESS and the current position of the search iterator
     369             : 
     370             :     // helpers, that are needed several times
     371             :     SVX_DLLPRIVATE sal_Bool MoveCursor();
     372             :         // moves m_xSearchIterator with respect to direction/overflow cursor
     373             :     SVX_DLLPRIVATE sal_Bool MoveField(sal_Int32& nPos, FieldCollectionIterator& iter, const FieldCollectionIterator& iterBegin, const FieldCollectionIterator& iterEnd);
     374             :         // moves the iterator with respect to the direction/overflow iterator/overflow cursor
     375             :     SVX_DLLPRIVATE void BuildAndInsertFieldInfo(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess >& xAllFields, sal_Int32 nField);
     376             :         // builds a FieldInfo in relation to field number nField (in xAllFields) and adds it to m_arrUsedFields
     377             :         // xAllFields needs to support the DatabaseRecord service
     378             :     SVX_DLLPRIVATE ::rtl::OUString FormatField(const FieldInfo& rField);
     379             :         // formats the field with the NumberFormatter
     380             : 
     381             :     SVX_DLLPRIVATE sal_Bool HasPreviousLoc() { return m_aPreviousLocBookmark.hasValue(); }
     382             : 
     383             :     DECL_LINK(OnSearchTerminated, FmSearchThread*);
     384             :         // is used by SearchThread, after the return from this handler the thread removes itself
     385             :     DECL_LINK(OnNewRecordCount, void*);
     386             : };
     387             : 
     388             : #endif // _FMSRCIMP_HXX
     389             : 
     390             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.10