INTEGRATION: CWS dba17 (1.1.2); FILE ADDED

2004/09/17 15:14:29 fs 1.1.2.2: #b5008519# also allow synchronous enumeration
2004/09/17 08:23:55 fs 1.1.2.1: helper class which enumerates the content of a folder asynchronously

1 files changed, 332 insertions, 0 deletions

diff --git a/svtools/source/contnr/contentenumeration.hxx b/svtools/source/contnr/contentenumeration.hxx
new file mode 100644
index 000000000000..88608b349e08
--- /dev/null
+++ b/svtools/source/contnr/contentenumeration.hxx
@@ -0,0 +1,332 @@
+/*************************************************************************
+ *
+ *  $RCSfile: contentenumeration.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: pjunck $ $Date: 2004-10-22 12:33:08 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
+#define SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_UCB_XCOMMANDENVIRONMENT_HPP_
+#include <com/sun/star/ucb/XCommandEnvironment.hpp>
+#endif
+#ifndef _COM_SUN_STAR_IO_XPERSIST_HPP_
+#include <com/sun/star/io/XPersist.hpp>
+#endif
+/** === end UNO includes === **/
+
+#ifndef _THREAD_HXX_
+#include <osl/thread.hxx>
+#endif
+#ifndef _RTL_REF_HXX_
+#include <rtl/ref.hxx>
+#endif
+#ifndef _UCBHELPER_CONTENT_HXX
+#include <ucbhelper/content.hxx>
+#endif
+#ifndef _RTL_USTRING_HXX_
+#include <rtl/ustring.hxx>
+#endif
+#ifndef _DATETIME_HXX
+#include <tools/datetime.hxx>
+#endif
+#ifndef _SV_IMAGE_HXX
+#include <vcl/image.hxx>
+#endif
+
+class IUrlFilter;
+//........................................................................
+namespace svt
+{
+//........................................................................
+
+    //====================================================================
+    //= SortingData_Impl
+    //====================================================================
+    struct SortingData_Impl
+    {
+    private:
+        ::rtl::OUString maFilename;     // only filename in upper case - for compare purposes
+        ::rtl::OUString maTitle;        //  -> be carefull when changing maTitle to update maFilename only when new
+        ::rtl::OUString maLowerTitle;
+
+    public:
+        ::rtl::OUString maType;
+        ::rtl::OUString maTargetURL;
+        ::rtl::OUString maImageURL;
+        ::rtl::OUString maDisplayText;
+        DateTime        maModDate;
+        Image           maImage;
+        sal_Int64       maSize;
+        sal_Bool        mbIsFolder;
+        sal_Bool        mbIsVolume;
+        sal_Bool        mbIsRemote;
+        sal_Bool        mbIsRemoveable;
+        sal_Bool        mbIsFloppy;
+        sal_Bool        mbIsCompactDisc;
+
+        inline                          SortingData_Impl();
+        inline const ::rtl::OUString&   GetTitle() const;
+        inline const ::rtl::OUString&   GetLowerTitle() const;
+        inline const ::rtl::OUString&   GetFileName() const;
+        inline void                     SetNewTitle( const ::rtl::OUString& rNewTitle );        // new maTitle is set -> maFilename is set to same!
+        inline void                     ChangeTitle( const ::rtl::OUString& rChangedTitle );    // maTitle is changed, maFilename is unchanged!
+
+    private:
+        inline void                     SetTitles( const ::rtl::OUString& rNewTitle );
+    };
+
+    inline SortingData_Impl::SortingData_Impl() :
+        maSize          ( 0 ),
+        mbIsFolder      ( sal_False ),
+        mbIsVolume      ( sal_False ),
+        mbIsRemote      ( sal_False ),
+        mbIsRemoveable  ( sal_False ),
+        mbIsFloppy      ( sal_False ),
+        mbIsCompactDisc ( sal_False )
+    {
+    }
+
+    inline const ::rtl::OUString& SortingData_Impl::GetTitle() const
+    {
+        return maTitle;
+    }
+
+    inline const ::rtl::OUString& SortingData_Impl::GetLowerTitle() const
+    {
+        return maLowerTitle;
+    }
+
+    inline const ::rtl::OUString& SortingData_Impl::GetFileName() const
+    {
+        return maFilename;
+    }
+
+    inline void SortingData_Impl::SetNewTitle( const ::rtl::OUString& rNewTitle )
+    {
+        SetTitles( rNewTitle );
+        maFilename = rNewTitle.toAsciiUpperCase();
+    }
+
+    inline void SortingData_Impl::ChangeTitle( const ::rtl::OUString& rChangedTitle )
+    {
+        SetTitles( rChangedTitle );
+    }
+
+    inline void SortingData_Impl::SetTitles( const ::rtl::OUString& rNewTitle )
+    {
+        maTitle = rNewTitle;
+        maLowerTitle = rNewTitle.toAsciiLowerCase();
+    }
+
+    //====================================================================
+    //= IContentTitleTranslation
+    //====================================================================
+    class IContentTitleTranslation
+    {
+    public:
+        virtual sal_Bool    GetTranslation( const ::rtl::OUString& _rOriginalName, ::rtl::OUString& _rTranslatedName ) const = 0;
+    };
+
+    //====================================================================
+    //= EnumerationResult
+    //====================================================================
+    enum EnumerationResult
+    {
+        SUCCESS,    /// the enumration was successfull
+        ERROR,      /// the enumration was unsuccessfull
+        RUNNING     /// the enumeration is still running, and the maximum wait time has passed
+    };
+
+    //====================================================================
+    //= FolderDescriptor
+    //====================================================================
+    struct FolderDescriptor
+    {
+        /** a content object describing the folder. Can be <NULL/>, in this case <member>sURL</member>
+            is relevant.
+        */
+        ::ucb::Content  aContent;
+        /** the URL of a folder. Will be ignored if <member>aContent</member> is not <NULL/>.
+        */
+        String          sURL;
+
+        FolderDescriptor() { }
+
+        FolderDescriptor( const ::ucb::Content& _rContent )
+            :aContent( _rContent )
+        {
+        }
+
+        FolderDescriptor( const String& _rURL )
+            :sURL( _rURL )
+        {
+        }
+    };
+
+    //====================================================================
+    //= IEnumerationResultHandler
+    //====================================================================
+    class IEnumerationResultHandler
+    {
+    public:
+        virtual void        enumerationDone( EnumerationResult _eResult ) = 0;
+    };
+
+    //====================================================================
+    //= FileViewContentEnumerator
+    //====================================================================
+    class FileViewContentEnumerator
+            :public  ::rtl::IReference
+            ,private ::osl::Thread
+    {
+    public:
+        typedef ::std::vector< SortingData_Impl* >  ContentData;
+
+    private:
+        ContentData&                    m_rContent;
+        ::osl::Mutex&                   m_rContentMutex;
+
+        oslInterlockedCount             m_refCount;
+        mutable ::osl::Mutex            m_aMutex;
+
+        FolderDescriptor                m_aFolder;
+        ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >
+                                        m_xCommandEnv;
+        const IUrlFilter*               m_pFilter;
+        const IContentTitleTranslation* m_pTranslator;
+        IEnumerationResultHandler*      m_pResultHandler;
+        bool                            m_bCancelled;
+
+        mutable ::com::sun::star::uno::Reference< ::com::sun::star::io::XPersist >
+                                        m_xDocInfo;
+
+    public:
+        /** constructs an enumerator instance
+
+            @param _rContentToFill
+                the structure which is to be filled with the found content
+            @param _rContentMutex
+                the mutex which protects the access to <arg>_rContentToFill</arg>
+            @param _pTranslator
+                an instance which should be used to translate content titles. May be <NULL/>
+        */
+        FileViewContentEnumerator(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandEnvironment >& _rxCommandEnv,
+            ContentData& _rContentToFill,
+            ::osl::Mutex& _rContentMutex,
+            const IContentTitleTranslation* _pTranslator
+        );
+
+        /** enumerates the content of a given folder
+
+            @param _rFolder
+                the folder whose content is to be enumerated
+            @param _pFilter
+                a filter to apply to the found contents
+            @param _pResultHandler
+                an instance which should handle the results of the enumeration
+        */
+        void    enumerateFolderContent(
+                    const FolderDescriptor& _rFolder,
+                    const IUrlFilter* _pFilter,
+                    IEnumerationResultHandler* _pResultHandler
+                );
+
+        /** enumerates the content of a given folder synchronously
+        */
+        EnumerationResult   enumerateFolderContentSync(
+                    const FolderDescriptor& _rFolder,
+                    const IUrlFilter* _pFilter
+                );
+
+        /** cancels the running operation.
+
+            Note that "cancel" may mean that the operation is running, but its result
+            is simply disregarded later on.
+        */
+        void    cancel();
+
+        // IReference overridables
+        virtual oslInterlockedCount SAL_CALL acquire();
+        virtual oslInterlockedCount SAL_CALL release();
+
+        Thread::operator new;
+        Thread::operator delete;
+
+    protected:
+        ~FileViewContentEnumerator();
+
+    private:
+        EnumerationResult enumerateFolderContent();
+
+        // Thread overridables
+        virtual void SAL_CALL run();
+        virtual void SAL_CALL onTerminated();
+
+    private:
+        sal_Bool implGetDocTitle( const ::rtl::OUString& _rTargetURL, ::rtl::OUString& _rRet ) const;
+    };
+
+//........................................................................
+} // namespace svt
+//........................................................................
+
+#endif // SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
+