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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/* -*- 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 .
*/
#ifndef INCLUDED_SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
#define INCLUDED_SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/document/XDocumentProperties.hpp>
#include <salhelper/thread.hxx>
#include <ucbhelper/content.hxx>
#include <rtl/ustring.hxx>
#include <tools/datetime.hxx>
#include <vcl/image.hxx>
namespace svt
{
//= SortingData_Impl
struct SortingData_Impl
{
private:
OUString maFilename; // only filename in upper case - for compare purposes
OUString maTitle; // -> be careful when changing maTitle to update maFilename only when new
OUString maLowerTitle;
public:
OUString maType;
OUString maTargetURL;
OUString maDisplayText;
DateTime maModDate;
Image maImage;
sal_Int64 maSize;
bool mbIsFolder;
bool mbIsVolume;
bool mbIsRemote;
bool mbIsRemoveable;
bool mbIsFloppy;
bool mbIsCompactDisc;
inline SortingData_Impl();
inline const OUString& GetTitle() const;
inline const OUString& GetLowerTitle() const;
inline const OUString& GetFileName() const;
inline void SetNewTitle( const OUString& rNewTitle ); // new maTitle is set -> maFilename is set to same!
inline void ChangeTitle( const OUString& rChangedTitle ); // maTitle is changed, maFilename is unchanged!
private:
inline void SetTitles( const OUString& rNewTitle );
};
inline SortingData_Impl::SortingData_Impl() :
maModDate ( DateTime::EMPTY ),
maSize ( 0 ),
mbIsFolder ( false ),
mbIsVolume ( false ),
mbIsRemote ( false ),
mbIsRemoveable ( false ),
mbIsFloppy ( false ),
mbIsCompactDisc ( false )
{
}
inline const OUString& SortingData_Impl::GetTitle() const
{
return maTitle;
}
inline const OUString& SortingData_Impl::GetLowerTitle() const
{
return maLowerTitle;
}
inline const OUString& SortingData_Impl::GetFileName() const
{
return maFilename;
}
inline void SortingData_Impl::SetNewTitle( const OUString& rNewTitle )
{
SetTitles( rNewTitle );
maFilename = rNewTitle.toAsciiUpperCase();
}
inline void SortingData_Impl::ChangeTitle( const OUString& rChangedTitle )
{
SetTitles( rChangedTitle );
}
inline void SortingData_Impl::SetTitles( const OUString& rNewTitle )
{
maTitle = rNewTitle;
maLowerTitle = rNewTitle.toAsciiLowerCase();
}
//= IContentTitleTranslation
class IContentTitleTranslation
{
public:
virtual bool GetTranslation( const OUString& _rOriginalName, OUString& _rTranslatedName ) const = 0;
protected:
~IContentTitleTranslation() {}
};
//= EnumerationResult
enum EnumerationResult
{
SUCCESS, /// the enumeration was successful
ERROR, /// the enumeration was unsuccessful
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.
*/
::ucbhelper::Content aContent;
/** the URL of a folder. Will be ignored if <member>aContent</member> is not <NULL/>.
*/
OUString sURL;
FolderDescriptor() { }
explicit FolderDescriptor( const ::ucbhelper::Content& _rContent )
:aContent( _rContent )
{
}
explicit FolderDescriptor( const OUString& _rURL )
:sURL( _rURL )
{
}
};
//= IEnumerationResultHandler
class IEnumerationResultHandler
{
public:
virtual void enumerationDone( EnumerationResult _eResult ) = 0;
protected:
~IEnumerationResultHandler() {}
};
//= FileViewContentEnumerator
class FileViewContentEnumerator: public salhelper::Thread
{
public:
typedef ::std::vector< SortingData_Impl* > ContentData;
private:
ContentData& m_rContent;
::osl::Mutex& m_rContentMutex;
mutable ::osl::Mutex m_aMutex;
FolderDescriptor m_aFolder;
css::uno::Reference< css::ucb::XCommandEnvironment >
m_xCommandEnv;
const IContentTitleTranslation* m_pTranslator;
IEnumerationResultHandler* m_pResultHandler;
bool m_bCancelled;
mutable css::uno::Reference< css::document::XDocumentProperties>
m_xDocProps;
css::uno::Sequence< OUString > m_rBlackList;
bool URLOnBlackList ( const OUString& sRealURL );
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 css::uno::Reference< css::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,
IEnumerationResultHandler* _pResultHandler
);
/** enumerates the content of a given folder synchronously
*/
EnumerationResult enumerateFolderContentSync(
const FolderDescriptor& _rFolder,
const css::uno::Sequence< OUString >& rBlackList
);
/** cancels the running operation.
Note that "cancel" may mean that the operation is running, but its result
is simply disregarded later on.
*/
void cancel();
protected:
virtual ~FileViewContentEnumerator() override;
private:
EnumerationResult enumerateFolderContent();
// Thread overridables
virtual void execute() override;
private:
bool implGetDocTitle( const OUString& _rTargetURL, OUString& _rRet ) const;
};
} // namespace svt
#endif // INCLUDED_SVTOOLS_SOURCE_CONTNR_CONTENTENUMERATION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
