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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include <bf_svtools/viewoptions.hxx>
#include <com/sun/star/uno/Any.hxx>
#include <boost/unordered_map.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <rtl/ustrbuf.hxx>
#include <unotools/configpathes.hxx>
#include <comphelper/configurationhelper.hxx>
#include <comphelper/processfactory.hxx>
#include <itemholder1.hxx>
namespace binfilter
{
//_________________________________________________________________________________________________________________
// namespaces
//_________________________________________________________________________________________________________________
namespace css = ::com::sun::star;
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
#ifdef CONST_ASCII
#error "Who define CONST_ASCII before! I use it to create const ascii strings ..."
#else
#define CONST_ASCII(SASCIIVALUE) ::rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(SASCIIVALUE))
#endif
#define PATHSEPERATOR CONST_ASCII("/")
#define PACKAGE_VIEWS CONST_ASCII("org.openoffice.Office.Views")
#define LIST_DIALOGS CONST_ASCII("Dialogs" )
#define LIST_TABDIALOGS CONST_ASCII("TabDialogs")
#define LIST_TABPAGES CONST_ASCII("TabPages" )
#define LIST_WINDOWS CONST_ASCII("Windows" )
#define PROPERTY_WINDOWSTATE CONST_ASCII("WindowState")
#define PROPERTY_PAGEID CONST_ASCII("PageID" )
#define PROPERTY_VISIBLE CONST_ASCII("Visible" )
#define PROPERTY_USERDATA CONST_ASCII("UserData" )
#define PROPCOUNT_DIALOGS 1
#define PROPCOUNT_TABDIALOGS 2
#define PROPCOUNT_TABPAGES 1
#define PROPCOUNT_WINDOWS 2
#define DEFAULT_WINDOWSTATE ::rtl::OUString()
#define DEFAULT_USERDATA css::uno::Sequence< css::beans::NamedValue >()
#define DEFAULT_PAGEID 0
#define DEFAULT_VISIBLE sal_False
//#define DEBUG_VIEWOPTIONS
#ifdef DEBUG_VIEWOPTIONS
#define _LOG_COUNTER_( _SVIEW_, _NREAD_, _NWRITE_ ) \
{ \
FILE* pFile = fopen( "viewdbg.txt", "a" ); \
fprintf( pFile, "%s[%d, %d]\n", ::rtl::OUStringToOString(_SVIEW_, RTL_TEXTENCODING_UTF8).getStr(), _NREAD_, _NWRITE_ ); \
fclose( pFile ); \
}
#endif // DEBUG_VIEWOPTIONS
#define SVTVIEWOPTIONS_LOG_UNEXPECTED_EXCEPTION(SVTVIEWOPTIONS_LOG_UNEXPECTED_EXCEPTION_PARAM_EXCEPTION) \
{ \
::rtl::OUStringBuffer sMsg(256); \
sMsg.appendAscii("Unexpected exception catched. Original message was:\n\"" ); \
sMsg.append (SVTVIEWOPTIONS_LOG_UNEXPECTED_EXCEPTION_PARAM_EXCEPTION.Message); \
sMsg.appendAscii("\"" ); \
OSL_FAIL(::rtl::OUStringToOString(sMsg.makeStringAndClear(), RTL_TEXTENCODING_UTF8).getStr()); \
}
//_________________________________________________________________________________________________________________
// initialization!
//_________________________________________________________________________________________________________________
SvtViewOptionsBase_Impl* SvtViewOptions::m_pDataContainer_Dialogs = NULL ;
sal_Int32 SvtViewOptions::m_nRefCount_Dialogs = 0 ;
SvtViewOptionsBase_Impl* SvtViewOptions::m_pDataContainer_TabDialogs = NULL ;
sal_Int32 SvtViewOptions::m_nRefCount_TabDialogs = 0 ;
SvtViewOptionsBase_Impl* SvtViewOptions::m_pDataContainer_TabPages = NULL ;
sal_Int32 SvtViewOptions::m_nRefCount_TabPages = 0 ;
SvtViewOptionsBase_Impl* SvtViewOptions::m_pDataContainer_Windows = NULL ;
sal_Int32 SvtViewOptions::m_nRefCount_Windows = 0 ;
//_________________________________________________________________________________________________________________
// private declarations!
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@descr declare one configuration item
These struct hold information about one view item. But not all member are used for all entries!
User must decide which information are usefull and which not. We are a container iztem only and doesnt
know anything about the context.
But; we support a feature:
decision between items with default values (should not realy exist in configuration!)
and items with real values - changed by user. So user can suppress saving of realy unused items
to disk - because; defaulted items could be restored on runtime without reading from disk!!!
And if only items with valid information was written to cfg - we mustn't read so much and save time.
So we start with an member m_bDefault=True and reset it to False after first set-call.
Deficiencies of these solution - we cant allow direct read/write access to our member. We must
support it by set/get-methods ...
*//*-*************************************************************************************************************/
class IMPL_TViewData
{
public:
//---------------------------------------------------------------------------------------------------------
// create "default" item
IMPL_TViewData()
{
m_sWindowState = DEFAULT_WINDOWSTATE ;
m_lUserData = DEFAULT_USERDATA ;
m_nPageID = DEFAULT_PAGEID ;
m_bVisible = DEFAULT_VISIBLE ;
m_bDefault = sal_True ;
}
//---------------------------------------------------------------------------------------------------------
// write access - with reseting of default state
void setWindowState( const ::rtl::OUString& sValue )
{
m_bDefault = (
( m_bDefault == sal_True ) &&
( sValue == DEFAULT_WINDOWSTATE )
);
m_sWindowState = sValue;
}
//---------------------------------------------------------------------------------------------------------
void setUserData( const css::uno::Sequence< css::beans::NamedValue >& lValue )
{
m_bDefault = (
( m_bDefault == sal_True ) &&
( lValue == DEFAULT_USERDATA )
);
m_lUserData = lValue;
}
//---------------------------------------------------------------------------------------------------------
void setPageID( sal_Int32 nValue )
{
m_bDefault = (
( m_bDefault == sal_True ) &&
( nValue == DEFAULT_PAGEID )
);
m_nPageID = nValue;
}
//---------------------------------------------------------------------------------------------------------
void setVisible( sal_Bool bValue )
{
m_bDefault = (
( m_bDefault == sal_True ) &&
( bValue == DEFAULT_VISIBLE )
);
m_bVisible = bValue;
}
//---------------------------------------------------------------------------------------------------------
// read access
::rtl::OUString getWindowState() { return m_sWindowState; }
css::uno::Sequence< css::beans::NamedValue > getUserData () { return m_lUserData ; }
sal_Int32 getPageID () { return m_nPageID ; }
sal_Bool getVisible () { return m_bVisible ; }
//---------------------------------------------------------------------------------------------------------
// special operation for easy access on user data
void setUserItem( const ::rtl::OUString& sName ,
const css::uno::Any& aValue )
{
// we change UserData in every case!
// a) we change already existing item
// or b) we add a new one
m_bDefault = sal_False;
sal_Bool bExist = sal_False;
sal_Int32 nCount = m_lUserData.getLength();
// change it, if it already exist ...
for( sal_Int32 nStep=0; nStep<nCount; ++nStep )
{
if( m_lUserData[nStep].Name == sName )
{
m_lUserData[nStep].Value = aValue ;
bExist = sal_True;
break;
}
}
// ... or create new list item
if( bExist == sal_False )
{
m_lUserData.realloc( nCount+1 );
m_lUserData[nCount].Name = sName ;
m_lUserData[nCount].Value = aValue ;
}
}
//---------------------------------------------------------------------------------------------------------
css::uno::Any getUserItem( const ::rtl::OUString& sName )
{
// default value - if item not exist!
css::uno::Any aValue;
sal_Int32 nCount = m_lUserData.getLength();
for( sal_Int32 nStep=0; nStep<nCount; ++nStep )
{
if( m_lUserData[nStep].Name == sName )
{
aValue = m_lUserData[nStep].Value;
break;
}
}
return aValue;
}
//---------------------------------------------------------------------------------------------------------
// check for default items
sal_Bool isDefault() { return m_bDefault; }
private:
::rtl::OUString m_sWindowState ;
css::uno::Sequence< css::beans::NamedValue > m_lUserData ;
sal_Int32 m_nPageID ;
sal_Bool m_bVisible ;
sal_Bool m_bDefault ;
};
struct IMPL_TStringHashCode
{
size_t operator()(const ::rtl::OUString& sString) const
{
return sString.hashCode();
}
};
typedef ::boost::unordered_map< ::rtl::OUString ,
IMPL_TViewData ,
IMPL_TStringHashCode ,
::std::equal_to< ::rtl::OUString > > IMPL_TViewHash;
/*-************************************************************************************************************//**
@descr Implement base data container for view options elements.
Every item support ALL possible configuration informations.
But not every superclass should use them! Because some view types don't
have it realy.
@attention We implement a write-througt-cache! We use it for reading - but write all changes directly to
configuration. (changes are made on internal cache too!). So it's easier to distinguish
between added/changed/removed elements without any complex mask or bool flag informations.
Caches from configuration and our own one are synchronized every time - if we do so.
*//*-*************************************************************************************************************/
class SvtViewOptionsBase_Impl
{
//-------------------------------------------------------------------------------------------------------------
public:
SvtViewOptionsBase_Impl ( const ::rtl::OUString& sList );
virtual ~SvtViewOptionsBase_Impl ( );
//-------------------------------------------------------------------------------------------------------------
private:
::rtl::OUString m_sListName;
css::uno::Reference< css::container::XNameAccess > m_xRoot;
css::uno::Reference< css::container::XNameAccess > m_xSet;
#ifdef DEBUG_VIEWOPTIONS
sal_Int32 m_nReadCount ;
sal_Int32 m_nWriteCount ;
#endif
};
/*-************************************************************************************************************//**
@descr Implement the base data container.
*//*-*************************************************************************************************************/
/*-************************************************************************************************************//**
@short ctor
@descr We use it to open right configuration file and let configuration objects fill her caches.
Then we read all existing entries from right list and cached it inside our object too.
Normaly we should enable notifications for changes on these values too ... but these feature
isn't full implemented in the moment.
@seealso baseclass ::utl::ConfigItem
@seealso method Notify()
@param -
@return -
*//*-*************************************************************************************************************/
SvtViewOptionsBase_Impl::SvtViewOptionsBase_Impl( const ::rtl::OUString& sList )
: m_sListName ( sList ) // we must know, which view type we must support
#ifdef DEBUG_VIEWOPTIONS
, m_nReadCount ( 0 )
, m_nWriteCount( 0 )
#endif
{
try
{
m_xRoot = css::uno::Reference< css::container::XNameAccess >(
::comphelper::ConfigurationHelper::openConfig(
::comphelper::getProcessServiceFactory(),
PACKAGE_VIEWS,
::comphelper::ConfigurationHelper::E_STANDARD),
css::uno::UNO_QUERY);
if (m_xRoot.is())
m_xRoot->getByName(sList) >>= m_xSet;
}
catch(const css::uno::Exception& ex)
{
m_xRoot.clear();
m_xSet.clear();
SVTVIEWOPTIONS_LOG_UNEXPECTED_EXCEPTION(ex)
}
}
/*-************************************************************************************************************//**
@short dtor
@descr If something was changed on our internal cached values - baselcass can tell us that by return value
of method "IsModified()". So we should flush these changes by calling "Commit()" of our own instance.
It's an auto-save. Normaly user of these object should do that explicitly!
@attention We implement a write through cache! So we mustn't do it realy. All changes was written to cfg directly.
Commit isn't neccessary then.
@seealso baseclass ::utl::ConfigItem
@seealso method IsModified()
@seealso method SetModified()
@seealso method Commit()
@param -
@return -
*//*-*************************************************************************************************************/
SvtViewOptionsBase_Impl::~SvtViewOptionsBase_Impl()
{
try
{
if (m_xRoot.is())
::comphelper::ConfigurationHelper::flush(m_xRoot);
}
catch(const css::uno::Exception& ex)
{
SVTVIEWOPTIONS_LOG_UNEXPECTED_EXCEPTION(ex)
}
m_xRoot.clear();
m_xSet.clear();
#ifdef DEBUG_VIEWOPTIONS
_LOG_COUNTER_( m_sListName, m_nReadCount, m_nWriteCount )
#endif // DEBUG_VIEWOPTIONS
}
//_________________________________________________________________________________________________________________
// definitions
//_________________________________________________________________________________________________________________
//*****************************************************************************************************************
// constructor
//*****************************************************************************************************************
SvtViewOptions::SvtViewOptions( EViewType eType ,
const ::rtl::OUString& sViewName )
: m_eViewType ( eType )
, m_sViewName ( sViewName )
{
// Global access, must be guarded (multithreading!)
::osl::MutexGuard aGuard( GetOwnStaticMutex() );
// Search for right dat container for this view type and initialize right data container or set right ref count!
switch( eType )
{
case E_DIALOG : {
// Increase ref count for dialog data container first.
++m_nRefCount_Dialogs;
// If these instance the first user of the dialog data container - create these impl static container!
if( m_nRefCount_Dialogs == 1 )
{
//m_pDataContainer_Dialogs = new SvtViewDialogOptions_Impl( LIST_DIALOGS );
m_pDataContainer_Dialogs = new SvtViewOptionsBase_Impl( LIST_DIALOGS );
ItemHolder1::holdConfigItem(E_VIEWOPTIONS_DIALOG);
}
}
break;
case E_TABDIALOG : {
// Increase ref count for tab-dialog data container first.
++m_nRefCount_TabDialogs;
// If these instance the first user of the tab-dialog data container - create these impl static container!
if( m_nRefCount_TabDialogs == 1 )
{
m_pDataContainer_TabDialogs = new SvtViewOptionsBase_Impl( LIST_TABDIALOGS );
ItemHolder1::holdConfigItem(E_VIEWOPTIONS_TABDIALOG);
}
}
break;
case E_TABPAGE : {
// Increase ref count for tab-page data container first.
++m_nRefCount_TabPages;
// If these instance the first user of the tab-page data container - create these impl static container!
if( m_nRefCount_TabPages == 1 )
{
m_pDataContainer_TabPages = new SvtViewOptionsBase_Impl( LIST_TABPAGES );
ItemHolder1::holdConfigItem(E_VIEWOPTIONS_TABPAGE);
}
}
break;
case E_WINDOW : {
// Increase ref count for window data container first.
++m_nRefCount_Windows;
// If these instance the first user of the window data container - create these impl static container!
if( m_nRefCount_Windows == 1 )
{
m_pDataContainer_Windows = new SvtViewOptionsBase_Impl( LIST_WINDOWS );
ItemHolder1::holdConfigItem(E_VIEWOPTIONS_WINDOW);
}
}
break;
default : OSL_FAIL( "SvtViewOptions::SvtViewOptions()\nThese view type is unknown! All following calls at these instance will do nothing!\n" );
}
}
//*****************************************************************************************************************
// destructor
//*****************************************************************************************************************
SvtViewOptions::~SvtViewOptions()
{
// Global access, must be guarded (multithreading!)
::osl::MutexGuard aGuard( GetOwnStaticMutex() );
// Search for right dat container for this view type and deinitialize right data container or set right ref count!
switch( m_eViewType )
{
case E_DIALOG : {
// Decrease ref count for dialog data container first.
--m_nRefCount_Dialogs;
// If these instance the last user of the dialog data container - delete these impl static container!
if( m_nRefCount_Dialogs == 0 )
{
delete m_pDataContainer_Dialogs;
m_pDataContainer_Dialogs = NULL;
}
}
break;
case E_TABDIALOG : {
// Decrease ref count for tab-dialog data container first.
--m_nRefCount_TabDialogs;
// If these instance the last user of the tab-dialog data container - delete these impl static container!
if( m_nRefCount_TabDialogs == 0 )
{
delete m_pDataContainer_TabDialogs;
m_pDataContainer_TabDialogs = NULL;
}
}
break;
case E_TABPAGE : {
// Decrease ref count for tab-page data container first.
--m_nRefCount_TabPages;
// If these instance the last user of the tab-page data container - delete these impl static container!
if( m_nRefCount_TabPages == 0 )
{
delete m_pDataContainer_TabPages;
m_pDataContainer_TabPages = NULL;
}
}
break;
case E_WINDOW : {
// Decrease ref count for window data container first.
--m_nRefCount_Windows;
// If these instance the last user of the window data container - delete these impl static container!
if( m_nRefCount_Windows == 0 )
{
delete m_pDataContainer_Windows;
m_pDataContainer_Windows = NULL;
}
}
break;
}
}
//*****************************************************************************************************************
// private method
//*****************************************************************************************************************
::osl::Mutex& SvtViewOptions::GetOwnStaticMutex()
{
// Initialize static mutex only for one time!
static ::osl::Mutex* pMutex = NULL;
// If these method first called (Mutex not already exist!) ...
if( pMutex == NULL )
{
// ... we must create a new one. Protect follow code with the global mutex -
// It must be - we create a static variable!
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
// We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
if( pMutex == NULL )
{
// Create the new mutex and set it for return on static variable.
static ::osl::Mutex aMutex;
pMutex = &aMutex;
}
}
// Return new created or already existing mutex object.
return *pMutex;
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|