summaryrefslogtreecommitdiff
path: root/registry/source/regimpl.hxx
blob: 26b0b4924cc8740598b7e3a14b98b0e53033aace (plain)
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
/*************************************************************************
 *
 *  $RCSfile: regimpl.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: jbu $ $Date: 2002-10-23 15:27:49 $
 *
 *  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 _REGIMPL_HXX_
#define _REGIMPL_HXX_

#include 	<registry/registry.h>

#ifndef _REGMAP_HXX_
#include	"regmap.hxx"
#endif

#ifndef _OSL_MUTEX_HXX_ 
#include	<osl/mutex.hxx>
#endif

#ifndef _STORE_STORE_HXX_
#include	<store/store.hxx>
#endif

#define REG_PAGESIZE 512

#define	REG_MODE_CREATE		store_AccessCreate
#define	REG_MODE_OPEN		store_AccessReadWrite 
#define	REG_MODE_OPENREAD	store_AccessReadOnly 

#define	KEY_MODE_CREATE		store_AccessCreate
#define	KEY_MODE_OPEN		store_AccessReadWrite 
#define	KEY_MODE_OPENREAD	store_AccessReadOnly 


#define	VALUE_MODE_CREATE	store_AccessCreate
#define	VALUE_MODE_OPEN		store_AccessReadWrite 
#define	VALUE_MODE_OPENREAD	store_AccessReadOnly 

#define	VALUE_PREFIX		"$VL_"
#define	VALUE_LINKTARGET	"$VL_LINK_TARGET"

// 5 Bytes = 1 (Byte fuer den Typ) + 4 (Bytes fuer die Groesse der Daten)
#define	VALUE_HEADERSIZE	5
#define	VALUE_TYPEOFFSET	1
#define	VALUE_HEADEROFFSET	5

#define REG_CREATE  	0x0004  // allow write accesses

#define REG_GUARD(mutex) \
    Guard< Mutex > aGuard( mutex );

using namespace rtl;
using namespace osl;
using namespace store;

enum RESOLVE
{
    // alle Links werden aufgeloest
    RESOLVE_FULL,
    // alles bis zum letzten TeilStueck wird aufgeloest
    RESOLVE_PART,
    // kein Link wird aufgeloest
    RESOLVE_NOTHING
};

class ORegManager;
class RegistryTypeReader;

class ORegistry
{
public:
    ORegistry();

    sal_uInt32	acquire()
        { return ++m_refCount; }

    sal_uInt32	release()
        { return --m_refCount; }

    RegError	initRegistry(const OUString& name, 
                             RegAccessMode accessMode);

    RegError	closeRegistry();

    RegError	destroyRegistry(const OUString& name);

    RegError	createKey(RegKeyHandle hKey, 
                          const OUString& keyName, 
                          RegKeyHandle* phNewKey);

    RegError	openKey(RegKeyHandle hKey, 
                        const OUString& keyName, 
                        RegKeyHandle* phOpenKey,
                        RESOLVE eResolve=RESOLVE_FULL);

    RegError	closeKey(RegKeyHandle hKey);

    RegError	deleteKey(RegKeyHandle hKey, const OUString& keyName);

    RegError	loadKey(RegKeyHandle hKey, 
                        const OUString& regFileName,
                        sal_Bool bWarings=sal_False, 
                        sal_Bool bReport=sal_False);

    RegError	saveKey(RegKeyHandle hKey, 
                        const OUString& regFileName,
                        sal_Bool bWarings=sal_False, 
                        sal_Bool bReport=sal_False);

    RegError	dumpRegistry(RegKeyHandle hKey) const;

    RegError 	createLink(RegKeyHandle hKey, 
                           const OUString& linkName, 
                           const OUString& linkTarget);

       RegError 	deleteLink(RegKeyHandle hKey, 
                           const OUString& linkName);

public:
    virtual	~ORegistry();

    sal_Bool			isKeyOpen(const OUString&	keyName) const;
    sal_Bool			isReadOnly() const
        { return m_readOnly; }

    sal_Bool			isOpen() const
        { return m_isOpen; }

    ORegKey* 	getRootKey();

    const OStoreFile&	getStoreFile()
        { return m_file; }

    const OUString& 	getName() const
        { return m_name; }

    RegError getResolvedKeyName(RegKeyHandle hKey,
                                 const OUString& keyName,
                                 OUString& resolvedName,
                                 sal_Bool firstLinkOnly=sal_False);

    friend class ORegKey;			
protected:
    RegError	eraseKey(ORegKey* pKey, 
                         const OUString& keyName,
                         RESOLVE eResolve=RESOLVE_FULL);

    RegError	deleteSubkeysAndValues(ORegKey* pKey,
                                       RESOLVE eResolve=RESOLVE_FULL);

    sal_uInt32		countSubKeys(ORegKey* pKey);

    RegError	loadAndSaveValue(ORegKey* pTargetKey, 
                                 ORegKey* pSourceKey, 
                                 const OUString& valueName, 
                                 sal_uInt32 nCut,
                                 sal_Bool bWarnings=sal_False,
                                 sal_Bool bReport=sal_False);

    RegError	checkBlop(OStoreStream& rValue,
                          ORegKey* pTargetKey, 
                          const OUString& sTargetPath,
                          const OUString& valueName,
                          sal_uInt32 srcValueSize, 
                          sal_uInt8* pSrcBuffer,
                          sal_Bool bReport=sal_False);

    RegError	mergeModuleValue(OStoreStream& rTargetValue,
                                 ORegKey* pTargetKey, 
                                 const OUString& sTargetPath,
                                 const OUString& valueName, 
                                 RegistryTypeReader& reader, 
                                 RegistryTypeReader& reader2);
    
    RegError	loadAndSaveKeys(ORegKey* pTargetKey, 
                                ORegKey* pSourceKey, 
                                const OUString& keyName, 
                                sal_uInt32 nCut,
                                sal_Bool bWarnings=sal_False,
                                sal_Bool bReport=sal_False);

    RegError	dumpValue(const OUString& sPath, 
                          const OUString& sName, 
                          sal_Int16 nSpace) const;			

    RegError	dumpKey(const OUString& sPath, 
                        const OUString& sName, 
                        sal_Int16 nSpace) const;

    RegError	openKeyWithoutLink(RegKeyHandle hKey, 
                                   const OUString& keyName, 
                                   RegKeyHandle* phOpenKey);

    OUString resolveLinks(ORegKey* pKey, const OUString& path, sal_Bool firstLinkOnly=sal_False);
    ORegKey* resolveLink(ORegKey* pKey, OUString& resolvedPath, const OUString& name);

    sal_Bool insertRecursionLink(ORegKey* pLink);
    sal_Bool resetRecursionLinks();

protected:

    sal_uInt32 		m_refCount;
    Mutex	    	m_mutex;
    sal_Bool   		m_readOnly;
    sal_Bool   		m_isOpen;
    OUString   		m_name;
    OStoreFile 		m_file;
    KeyMap	   		m_openKeyTable;
    LinkList   		m_recursionList;

    const OUString  ROOT;
};

#endif