1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
17 Returns the start position of the write area within the
18 intermediate buffer taking into account seeks.
20 @param The enumerator indicates we are setting a write buffer.
23 inline TUint8* RFileBuf::Limit(TWrite) const
27 /** Sets the start position of the write area within the
28 intermediate buffer taking into account seeks.
30 @param The enumerator indicates we are setting a write buffer.
31 @param aPtr The start point to set the limit to.
33 inline void RFileBuf::SetLimit(TWrite,TUint8* aLimit)
37 /** Sets the read position of the stream to the specified offset within the file.
39 @param The enumerator indicates we are setting a read buffer.
40 @param aPos The offset within the file to which the read stream position
41 is set. By default this is zero.
42 @see MStreamBuf::TRead */
43 inline void RFileBuf::SetPos(TRead,TInt aPos)
47 /** Sets the write position of the stream to the specified offset within the file.
49 @param The enumerator indicates we are setting a write buffer.
50 @param aPos The offset within the file to which the write stream position
51 is set. By default this is zero.
52 @see MStreamBuf::TWrite */
53 inline void RFileBuf::SetPos(TWrite,TInt aPos)
57 /** Returns the read stream position.
59 @param The enumerator indicates we are setting a read buffer.
60 @see MStreamBuf::TRead */
61 inline TInt RFileBuf::Pos(TRead) const
65 /** Returns the write stream position.
67 @param The enumerator indicates we are setting a write buffer.
68 @see MStreamBuf::TWrite */
69 inline TInt RFileBuf::Pos(TWrite) const
73 /** Moves the file offset to which the read stream position is set.
75 @param The enumerator indicates we are setting a read buffer.
76 @param The number of bytes to move by.
77 @see MStreamBuf::TRead */
78 inline TInt RFileBuf::MovePos(TRead,TInt anOffset)
80 return iRPos+=anOffset;
82 /** Moves the file offset to which the write stream position is set.
84 @param The enumerator indicates we are setting a write buffer.
85 @param The number of bytes to move by.
86 @see MStreamBuf::TWrite */
87 inline TInt RFileBuf::MovePos(TWrite,TInt anOffset)
89 return iWPos+=anOffset;
91 /** Returns the number of bytes that are/were in the read area of the
92 intermediate buffer yet to be passed to the user.
94 @param The enumerator indicates we are setting a read buffer.
95 @see MStreamBuf::TRead */
96 inline TInt RFileBuf::Lag(TRead) const
98 return Ptr(ERead)-End(ERead);
100 /** Returns the number of bytes that are/were in the write area of the
101 intermediate buffer yet to be written to the file.
103 @param The enumerator indicates we are setting a write buffer.
104 @see MStreamBuf::TWrite */
105 inline TInt RFileBuf::Lag(TWrite) const
107 return Ptr(EWrite)-iBase;
109 /** Returns the number of bytes of outstanding data in the intermediate
110 buffer that is yet to be written, taking into account any changes brought
113 @param The enumerator indicates we are using a write buffer.
114 @see MStreamBuf::TWrite */
115 inline TInt RFileBuf::Span(TWrite) const
117 return Max(Ptr(EWrite),Limit(EWrite))-iBase;
119 /** Gets the the read position within the stream taking
120 into account the data in the intermediate buffer not yet passed up
123 @param The enumerator indicates we are using a read buffer.
124 @see MStreamBuf::TRead */
125 inline TInt RFileBuf::Mark(TRead) const
127 return Pos(ERead)+Lag(ERead);
129 /** Gets the write position within the stream taking
130 into account data in the intermediate buffer not yet written.
132 @param The enumerator indicates we are using a write buffer.
133 @see MStreamBuf::TWrite */
134 inline TInt RFileBuf::Mark(TWrite) const
136 return Pos(EWrite)+Lag(EWrite);
138 /** Returns the possible end position of the write position in the stream
139 should the current data in the intermediate buffer be written.
141 @param The enumerator indicates we are using a write buffer.
142 @see MStreamBuf::TWrite */
143 inline TInt RFileBuf::Reach(TWrite) const
145 return Pos(EWrite)+Span(EWrite);
147 /** Sets the start and end points of the read area within the intermediate buffer.
149 @param The enumerator indicates we are setting a read buffer.
150 @param aPtr The start point.
151 @param anEnd The end point.
152 @see MStreamBuf::TRead
153 @see TStreamBuf::SetBuf
155 inline void RFileBuf::SetBuf(TRead,TUint8* aPtr,TUint8* anEnd)
157 TStreamBuf::SetBuf(ERead,aPtr,anEnd);
159 /** Sets the start and end points of the read area within the intermediate buffer.
161 @param The enumerator indicates we are setting a write buffer.
162 @param aPtr The start point.
163 @param anEnd The end point.
164 @see MStreamBuf::TWrite
165 @see TStreamBuf::SetBuf
167 inline void RFileBuf::SetBuf(TWrite,TUint8* aPtr,TUint8* anEnd)
169 TStreamBuf::SetBuf(EWrite,aPtr,anEnd);
170 SetLimit(EWrite,aPtr);
172 /** Sets the start and end points of the read area within the intermediate buffer.
174 @param The enumerator indicates we are setting a read buffer. ???
175 @param aPtr The start point.
176 @param anEnd The end point.
177 @see MStreamBuf::TArea
178 @see TStreamBuf::SetBuf
180 inline void RFileBuf::SetBuf(TArea anArea,TUint8* aPtr,TUint8* anEnd)
182 TStreamBuf::SetBuf(anArea,aPtr,anEnd);
184 SetLimit(EWrite,aPtr);
188 /** Returns a pointer to the CPermanentStoreCoord object.
190 @see CPermanentStoreCoord */
191 inline CPermanentStoreCoord& CPermanentFileStore::Coord() const
193 __ASSERT_DEBUG(iCoord!=NULL,User::Invariant());