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
|
/* -*- 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.
*
************************************************************************/
#ifndef _PSTM_HXX
#define _PSTM_HXX
#include <boost/unordered_map.hpp>
#include "tools/toolsdllapi.h"
#include <tools/table.hxx>
#include <tools/unqidx.hxx>
#include <tools/ref.hxx>
#include <tools/rtti.hxx>
#include <tools/stream.hxx>
#define ERRCODE_IO_NOFACTORY ERRCODE_IO_WRONGFORMAT
/*************************************************************************
*************************************************************************/
class SvPersistBase;
typedef void * (*SvCreateInstancePersist)( SvPersistBase ** );
#define SV_CLASS_REGISTER( Class ) \
Register( Class::StaticClassId(), Class::CreateInstance )
class TOOLS_DLLPUBLIC SvClassManager
{
typedef boost::unordered_map< sal_uInt16, SvCreateInstancePersist > Map;
Map aAssocTable;
public:
void Register( sal_uInt16 nClassId, SvCreateInstancePersist pFunc );
SvCreateInstancePersist Get( sal_uInt16 nClassId );
};
/************************** S v R t t i B a s e **************************/
class TOOLS_DLLPUBLIC SvRttiBase : public SvRefBase
{
public:
TYPEINFO();
};
SV_DECL_IMPL_REF(SvRttiBase)
/*************************************************************************/
#define SV_DECL_PERSIST( Class, CLASS_ID ) \
TYPEINFO(); \
static sal_uInt16 StaticClassId() { return CLASS_ID; } \
static void * CreateInstance( SvPersistBase ** ppBase ); \
friend SvPersistStream& operator >> ( SvPersistStream & rStm, \
Class *& rpObj); \
virtual sal_uInt16 GetClassId() const; \
virtual void Load( SvPersistStream & ); \
virtual void Save( SvPersistStream & );
#define SV_DECL_PERSIST1( Class, Super1, CLASS_ID ) \
SV_DECL_PERSIST( Class, CLASS_ID )
#define PRV_SV_IMPL_PERSIST( Class ) \
void * Class::CreateInstance( SvPersistBase ** ppBase )\
{ \
Class * p = new Class(); \
*ppBase = p; \
return p; \
} \
sal_uInt16 Class::GetClassId() const \
{ return StaticClassId(); } \
SvPersistStream& operator >> (SvPersistStream & rStm, Class *& rpObj)\
{ \
SvPersistBase * pObj; \
rStm >> pObj; \
rpObj = PTR_CAST( Class, pObj ); \
return rStm; \
}
#define SV_IMPL_PERSIST( Class ) \
TYPEINIT0( Class ) \
PRV_SV_IMPL_PERSIST( Class )
#define SV_IMPL_PERSIST1( Class, Super1 ) \
TYPEINIT1( Class, Super1 ) \
PRV_SV_IMPL_PERSIST( Class )
/*************************************************************************/
class SvPersistStream;
class SvPersistBase : public SvRttiBase
{
public:
virtual sal_uInt16 GetClassId() const = 0;
virtual void Load( SvPersistStream & ) = 0;
virtual void Save( SvPersistStream & ) = 0;
TOOLS_DLLPUBLIC friend SvPersistStream& operator >> ( SvPersistStream & rStm,
SvPersistBase *& rpObj );
};
SV_DECL_IMPL_REF(SvPersistBase)
/*************************************************************************/
// Damit die Liste, anders benannt wird
typedef SvPersistBase SuperSvPersistBase;
SV_DECL_REF_LIST_VISIBILITY(SuperSvPersistBase,SuperSvPersistBase*,TOOLS_DLLPUBLIC)
SV_IMPL_REF_LIST(SuperSvPersistBase,SuperSvPersistBase*)
class TOOLS_DLLPUBLIC SvPersistBaseMemberList : public SuperSvPersistBaseMemberList
{
public:
SvPersistBaseMemberList();
void WriteObjects( SvPersistStream &, sal_Bool bOnlyStreamedObj = sal_False ) const;
TOOLS_DLLPUBLIC friend SvPersistStream& operator << (SvPersistStream &, const SvPersistBaseMemberList &);
TOOLS_DLLPUBLIC friend SvPersistStream& operator >> (SvPersistStream &, SvPersistBaseMemberList &);
};
/*************************************************************************/
#define SV_DECL_PERSIST_LIST(ClassName,EntryName)\
class ClassName##MemberList : public SvPersistBaseMemberList\
{\
public:\
PRV_SV_DECL_MEMBER_LIST(ClassName,EntryName)\
};
#define SV_IMPL_PERSIST_LIST(ClassName,EntryName)\
PRV_SV_IMPL_MEMBER_LIST(ClassName,EntryName,SvPersistBaseMemberList)
#define SV_DECL_IMPL_PERSIST_LIST(ClassName,EntryName)\
SV_DECL_PERSIST_LIST(ClassName,EntryName)\
SV_IMPL_PERSIST_LIST(ClassName,EntryName)
DECLARE_UNIQUEINDEX( SvPersistUIdx,SvPersistBase *)
//=========================================================================
class SvStream;
class TOOLS_DLLPUBLIC SvPersistStream : public SvStream
/* [Beschreibung]
Mit dieser Klasse k"onnen Laufzeit Objektstrukturen gespeichert
und geladen werden. Es m"ussen immer alle beteiligten Objekte
gespeichert oder geladen werden. Um die Objekte automatisch
laden zu k"onnen, wird eine Factory f"ur jede Klasse von Objekten,
die im Stream vorkommen k"onnen, ben"otigt. Die Liste aller Klassen
wird in einem <SvClassManager> Objekt gespeichert und dem
SvPersistStream "ubergeben, wenn er erzeugt wird.
Weiterhin wird die M"oglichkeit geboten sal_uInt32 Werte komprimiert
zu schreiben und zu lesen (<SvPersistStream::WriteCompressed>,
<SvPersistStream::ReadCompressed>).
Es gibt auch die drei Hilfsmethoden <SvPersistStream::WriteDummyLen>,
<SvPersistStream::WriteLen> und <SvPersistStream::ReadLen> um eine
L"ange vor das Objekt zu schreiben.
[Beispiel]
Ein konkretes Beispiel ist im Konstruktor beschrieben.
Objekt A verweist auf B, dieses auf C und das wieder auf A.
C verweist auf D.
Die Reihenfolge beim Speichern und Laden ist egal, sie muss nur
gleich sein:
Speichern: Laden:
A,B,C,D A,B,C,D richtig
B,A,C,D B,A,C,D richtig
C,A,B,D A,B,C,D falsch
A,B,C,D A,B,C falsch
[Anmerkung]
Das Dateiformat zwischen DBG_UTIL und !DBG_UTIL ist unterschiedlich,
kann aber von beiden Versionen gelesen werden.
*/
{
SvClassManager & rClassMgr;
SvStream * pStm;
Table aPTable; // Pointer und Key gedreht
SvPersistUIdx aPUIdx;
sal_uIntPtr nStartIdx;
const SvPersistStream * pRefStm;
sal_uInt32 nFlags;
virtual sal_uIntPtr GetData( void* pData, sal_uIntPtr nSize );
virtual sal_uIntPtr PutData( const void* pData, sal_uIntPtr nSize );
virtual sal_uIntPtr SeekPos( sal_uIntPtr nPos );
virtual void FlushData();
protected:
sal_uIntPtr GetCurMaxIndex( const SvPersistUIdx & ) const;
sal_uIntPtr GetCurMaxIndex() const
{ return GetCurMaxIndex( aPUIdx ); }
void WriteObj( sal_uInt8 nHdr, SvPersistBase * pObj );
sal_uInt32 ReadObj( SvPersistBase * & rpObj,
sal_Bool bRegister );
public:
sal_Bool IsStreamed( SvPersistBase * pObj ) const
{ return 0 != GetIndex( pObj ); }
virtual void ResetError();
SvPersistStream( SvClassManager &, SvStream * pStream,
sal_uInt32 nStartIdx = 1 );
~SvPersistStream();
void SetStream( SvStream * pStream );
SvStream * GetStream() const { return pStm; }
virtual sal_uInt16 IsA() const;
SvPersistBase * GetObject( sal_uIntPtr nIdx ) const;
sal_uIntPtr GetIndex( SvPersistBase * ) const;
void SetContextFlags( sal_uInt32 n ) { nFlags = n; }
sal_uInt32 GetContextFlags() const { return nFlags; }
static void WriteCompressed( SvStream & rStm, sal_uInt32 nVal );
static sal_uInt32 ReadCompressed( SvStream & rStm );
sal_uInt32 WriteDummyLen();
void WriteLen( sal_uInt32 nLenPos );
sal_uInt32 ReadLen( sal_uInt32 * pTestPos );
SvPersistStream& WritePointer( SvPersistBase * pObj );
SvPersistStream& ReadPointer( SvPersistBase * & rpObj );
TOOLS_DLLPUBLIC friend SvPersistStream& operator << (SvPersistStream &, SvPersistBase *);
TOOLS_DLLPUBLIC friend SvPersistStream& operator >> (SvPersistStream &, SvPersistBase * &);
// Objekte halten ihre Id's w"ahrend geladen und
// gespeichert werden.
friend SvStream& operator >> ( SvStream &, SvPersistStream & );
friend SvStream& operator << ( SvStream &, SvPersistStream & );
};
#endif // _PSTM_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
