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
|
/* -*- 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/embed/XStorage.hpp>
#include <mutex>
#include <unordered_map>
#include <vector>
namespace framework
{
class XMLBasedAcceleratorConfiguration;
/**
TODO document me
*/
class StorageHolder final
{
// types
public:
/** @short TODO */
typedef ::std::vector< css::uno::Reference< css::embed::XStorage > > TStorageList;
typedef ::std::vector< XMLBasedAcceleratorConfiguration* > TStorageListenerList;
struct TStorageInfo
{
public:
css::uno::Reference< css::embed::XStorage > Storage;
sal_Int32 UseCount;
TStorageListenerList Listener;
TStorageInfo()
: UseCount(0)
{}
};
/** @short TODO */
typedef std::unordered_map< OUString,
TStorageInfo > TPath2StorageInfo;
// member
private:
mutable std::mutex m_mutex;
/** @short TODO */
css::uno::Reference< css::embed::XStorage > m_xRoot;
/** @short TODO */
TPath2StorageInfo m_lStorages;
// interface
public:
/** @short TODO
*/
StorageHolder();
/** @short TODO
*/
~StorageHolder();
/** @short TODO
*/
void forgetCachedStorages();
/** @short TODO
*/
void setRootStorage(const css::uno::Reference< css::embed::XStorage >& xRoot);
/** @short TODO
*/
css::uno::Reference< css::embed::XStorage > getRootStorage() const;
/** @short TODO
open or get!
*/
css::uno::Reference< css::embed::XStorage > openPath(const OUString& sPath ,
sal_Int32 nOpenMode);
/** @short TODO
*/
StorageHolder::TStorageList getAllPathStorages(const OUString& sPath);
/** @short TODO
*/
void commitPath(const OUString& sPath);
/** @short TODO
*/
void closePath(const OUString& sPath);
/** @short TODO
*/
void notifyPath(const OUString& sPath);
/** @short TODO
*/
void addStorageListener( XMLBasedAcceleratorConfiguration* pListener,
const OUString& sPath );
/** @short TODO
*/
void removeStorageListener( XMLBasedAcceleratorConfiguration* pListener,
const OUString& sPath );
/** @short TODO
*/
OUString getPathOfStorage(const css::uno::Reference< css::embed::XStorage >& xStorage);
/** @short TODO
*/
css::uno::Reference< css::embed::XStorage > getParentStorage(const css::uno::Reference< css::embed::XStorage >& xChild);
/** @short TODO
*/
css::uno::Reference< css::embed::XStorage > getParentStorage(const OUString& sChildPath);
/** @short TODO
*/
StorageHolder& operator=(const StorageHolder& rCopy);
/** @short opens a sub element of the specified base storage.
If eOpenMode contains an ELEMENT_WRITE flag remove it and try it with the rest of eOpenMode flags
again.
@descr First this method try to open the requested sub element
using the given open mode. If it failed there is second step,
which tries to do the same again ... but removing a might existing
WRITE flag from the open mode. The user can suppress this fallback
handling by setting the parameter bAllowFallback to sal_False.
@param xBaseStorage
the storage, where the sub element should be searched.
@param sSubElement
the full name of the sub element.
e.g. "default.xml"
@param eOpenMode
a flag field, which set the open mode for this operation.
*/
static css::uno::Reference< css::embed::XStorage > openSubStorageWithFallback(const css::uno::Reference< css::embed::XStorage >& xBaseStorage ,
const OUString& sSubStorage ,
sal_Int32 eOpenMode);
// helper
private:
/** @short TODO
*/
static OUString impl_st_normPath(const OUString& sPath);
/** @short TODO
*/
static std::vector<OUString> impl_st_parsePath(std::u16string_view sPath);
};
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
