xref: /trunk/main/sot/source/sdstor/stgio.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _STGIO_HXX
29*cdf0e10cSrcweir #define _STGIO_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <stgcache.hxx>
32*cdf0e10cSrcweir #include <stgelem.hxx>
33*cdf0e10cSrcweir #include <tools/string.hxx>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir class StgFATStrm;
36*cdf0e10cSrcweir class StgDataStrm;
37*cdf0e10cSrcweir class StgDirStrm;
38*cdf0e10cSrcweir class String;
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir enum FAT_ERROR
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir 	FAT_OK,
43*cdf0e10cSrcweir 	FAT_WRONGLENGTH,
44*cdf0e10cSrcweir 	FAT_UNREFCHAIN,
45*cdf0e10cSrcweir 	FAT_OVERWRITE,
46*cdf0e10cSrcweir 	FAT_OUTOFBOUNDS,
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir 	FAT_INMEMORYERROR,
49*cdf0e10cSrcweir 	FAT_ONFILEERROR,
50*cdf0e10cSrcweir 	FAT_BOTHERROR
51*cdf0e10cSrcweir };
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir struct StgLinkArg
54*cdf0e10cSrcweir {
55*cdf0e10cSrcweir 	String aFile;
56*cdf0e10cSrcweir 	sal_uLong nErr;
57*cdf0e10cSrcweir };
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir class StgIo : public StgCache {
60*cdf0e10cSrcweir 	void SetupStreams();			// load all internal streams
61*cdf0e10cSrcweir 	sal_Bool         bCopied;
62*cdf0e10cSrcweir public:
63*cdf0e10cSrcweir 	StgIo();
64*cdf0e10cSrcweir    ~StgIo();
65*cdf0e10cSrcweir 	StgHeader    aHdr;				// storage file header
66*cdf0e10cSrcweir 	StgFATStrm*  pFAT;				// FAT stream
67*cdf0e10cSrcweir 	StgDirStrm*  pTOC;				// TOC stream
68*cdf0e10cSrcweir 	StgDataStrm* pDataFAT;			// small data FAT stream
69*cdf0e10cSrcweir 	StgDataStrm* pDataStrm;			// small data stream
70*cdf0e10cSrcweir 	short	  	 GetDataPageSize();	// get the logical data page size
71*cdf0e10cSrcweir 	sal_Bool Load();					// load a storage file
72*cdf0e10cSrcweir 	sal_Bool Init();					// set up an empty file
73*cdf0e10cSrcweir 	sal_Bool CommitAll();				// commit everything (root commit)
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir 	static void SetErrorLink( const Link& );
76*cdf0e10cSrcweir 	static const Link& GetErrorLink();
77*cdf0e10cSrcweir 	sal_uLong ValidateFATs( );
78*cdf0e10cSrcweir };
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir #endif
81