1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/store/INC/S32STD.INL Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,452 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +// Class TStreamId
1.20 +inline TStreamId::TStreamId(TUint32 aValue)
1.21 + : iVal(aValue)
1.22 +/** Constructs the object with the specified stream ID value.
1.23 +
1.24 +Users of stores do not normally use this function.
1.25 +
1.26 +In debug mode, the function checks that the supplied stream ID value is not
1.27 +greater than the maximum permitted value, and raises a STORE-Store 2 panic
1.28 +if it is. In release mode, no checking on the supplied value is done.
1.29 +
1.30 +The checking of the supplied value is done by a private function implemented
1.31 +in estor. dll. This means that in debug mode, a call is made into estor.dll,
1.32 +but in release mode it is not.
1.33 +
1.34 +@param aValue The stream ID value. */
1.35 + {
1.36 +#if defined (_DEBUG)
1.37 + __DbgChkRange(aValue);
1.38 +#endif
1.39 + }
1.40 +inline TBool TStreamId::operator==(TStreamId anId) const
1.41 +/** Equality comparison operator. Use this operator to determine whether this stream
1.42 +id is equal to the specified stream id.
1.43 +
1.44 +@param anId The stream id to be compared with this stream id.
1.45 +@return True, if the stream ids are equal; false otherwise */
1.46 + {return iVal==anId.iVal;}
1.47 +inline TBool TStreamId::operator!=(TStreamId anId) const
1.48 +/** Inequality comparison operator. Use this operator to determine whether this
1.49 +stream id is unequal to the specified stream id.
1.50 +
1.51 +@param anId The stream id to be compared with this stream id.
1.52 +@return True, if the two stream ids are unequal, false otherwise. */
1.53 + {return iVal!=anId.iVal;}
1.54 +inline void TStreamId::ExternalizeL(RWriteStream& aStream) const
1.55 +/** Externalises an object of this class to a write stream.
1.56 +
1.57 +The presence of this function means that the standard templated operator<<()
1.58 +can be used to externalise objects of this class.
1.59 +
1.60 +@param aStream Stream to which the object should be externalised. */
1.61 + {
1.62 +#if defined (_DEBUG)
1.63 + __DbgChkRange(iVal);
1.64 +#endif
1.65 + aStream<<iVal;
1.66 + }
1.67 +inline TUint32 TStreamId::Value() const
1.68 +/** Gets the stream ID value encapsulated by this object.
1.69 +
1.70 +@return The stream ID value. */
1.71 + {
1.72 +#if defined (_DEBUG)
1.73 + __DbgChkRange(iVal);
1.74 +#endif
1.75 + return iVal;
1.76 + }
1.77 +
1.78 +// Class RStoreWriteStream
1.79 +inline RStoreWriteStream::RStoreWriteStream(const MExternalizer<TStreamRef>& anExter)
1.80 + : RWriteStream(anExter)
1.81 +/** Constructs an object with an externaliser. The store map CStoreMap is an example
1.82 +of an externalizer.
1.83 +
1.84 +@param anExter Specifies an externaliser */
1.85 + {}
1.86 +
1.87 +// Class TSwizzleCBase
1.88 +inline TSwizzleCBase::TSwizzleCBase(TStreamRef aRef)
1.89 + : iPtr(aRef.Ptr())
1.90 + {
1.91 +#if defined (_DEBUG)
1.92 + __DbgChkRef(aRef);
1.93 +#endif
1.94 + }
1.95 +inline TBool TSwizzleCBase::operator==(const TSwizzleCBase& aSwizzle) const
1.96 +/** Compares for equality with another swizzle.
1.97 +
1.98 +Use this operator to determine whether this swizzle represents the same object
1.99 +as that represented by the specified swizzle.
1.100 +
1.101 +Both this swizzle and the specified swizzle must maintain the representation
1.102 +of their respective objects as either pointers or stream ids.
1.103 +
1.104 +If one swizzle maintains the representation of its object as a pointer while
1.105 +the other swizzle maintains the representation of its object as a stream id,
1.106 +the comparison is meaningless and always returns false.
1.107 +
1.108 +@param aSwizzle A reference to the swizzle to be compared with this swizzle.
1.109 +@return True, if the represented objects are the same; False, otherwise. */
1.110 + {return iPtr==aSwizzle.iPtr;}
1.111 +inline TBool TSwizzleCBase::operator==(const TAny* aPtr) const
1.112 +/** Compares for equality with an in-memory object.
1.113 +
1.114 +Use this operator to determine whether this swizzle represents the same in-memory
1.115 +object as that represented by the specified pointer.
1.116 +
1.117 +This swizzle must maintain the representation of its object as a pointer.
1.118 +If it maintains the representation of its object as a swizzle, the comparison
1.119 +is meaningless and always returns false.
1.120 +
1.121 +@param aPtr A pointer to the object to be compared with this swizzle.
1.122 +@return True, if the represented objects are the same; False, otherwise. */
1.123 + {return iPtr==aPtr;}
1.124 +inline TBool TSwizzleCBase::operator!=(const TSwizzleCBase& aSwizzle) const
1.125 +/** Compares for inequality with another swizzle.
1.126 +
1.127 +Use this operator to determine whether this swizzle represents a different
1.128 +object to that represented by the specified swizzle.
1.129 +
1.130 +Both this swizzle and the specified swizzle must maintain the representation
1.131 +of their respective objects as either pointers or stream ids.
1.132 +
1.133 +If one swizzle maintains the representation of its object as a pointer while
1.134 +the other swizzle maintains the representation of its object as a stream id,
1.135 +the comparison is meaningless and always returns true.
1.136 +
1.137 +@param aSwizzle A reference to the swizzle to be compared with this swizzle.
1.138 +@return True, if the represented objects are not the same; False, otherwise */
1.139 + {return iPtr!=aSwizzle.iPtr;}
1.140 +inline TBool TSwizzleCBase::operator!=(const TAny* aPtr) const
1.141 +/** Compares for inequality with an in-memory object.
1.142 +
1.143 +Use this operator to determine whether this swizzle represents a different
1.144 +in-memory object to that represented by the specified pointer.
1.145 +
1.146 +This swizzle must maintain the representation of its object as a pointer.
1.147 +If it maintains the representation of its object as a swizzle, the comparison
1.148 +is meaningless and always returns true.
1.149 +
1.150 +@param aPtr A pointer to the object to be compared with this swizzle.
1.151 +@return True, if the represented objects are not the same; False, otherwise */
1.152 + {return iPtr!=aPtr;}
1.153 +inline TBool TSwizzleCBase::IsPtr() const
1.154 +/** Tests whether this swizzle currently represents an object as a pointer.
1.155 +
1.156 +@return True, if this swizzle currently maintains the object representation
1.157 +as a pointer; False, otherwise. Note that if the swizzle is uninitialised,
1.158 +the value returned by this function is not defined. */
1.159 + {return IsPtrRep(iPtr);}
1.160 +inline TBool TSwizzleCBase::IsId() const
1.161 +/** Tests whether this swizzle currently represents an object as a stream id.
1.162 +
1.163 +@return True, if this swizzle currently maintains the representation of the
1.164 +object as a stream id; False, otherwise. Note that if the swizzle is uninitialised,
1.165 +the value returned by this function is not defined. */
1.166 + {return IsIdRep(iPtr);}
1.167 +inline TSwizzleCBase::TSwizzleCBase(const TAny* aPtr)
1.168 + : iPtr(aPtr)
1.169 + {
1.170 +#if defined (_DEBUG)
1.171 + __DbgChkPtr(aPtr);
1.172 +#endif
1.173 + }
1.174 +inline const TAny* TSwizzleCBase::Ptr() const
1.175 + {
1.176 +#if defined (_DEBUG)
1.177 + __DbgChkPtr(iPtr);
1.178 +#endif
1.179 + return iPtr;
1.180 + }
1.181 +inline TBool operator==(const TAny* aPtr,const TSwizzleCBase& aSwizzle)
1.182 + {return aSwizzle==aPtr;}
1.183 +inline TBool operator!=(const TAny* aPtr,const TSwizzleCBase& aSwizzle)
1.184 + {return aSwizzle!=aPtr;}
1.185 +
1.186 +// Class TSwizzleBase
1.187 +inline TSwizzleBase::TSwizzleBase(TAny* aPtr)
1.188 + : TSwizzleCBase(aPtr)
1.189 + {}
1.190 +inline TSwizzleBase::TSwizzleBase(TStreamId anId)
1.191 + : TSwizzleCBase(anId)
1.192 + {}
1.193 +inline TAny* TSwizzleBase::Ptr() const
1.194 + {return (TAny*)TSwizzleCBase::Ptr();}
1.195 +
1.196 +// Template class TSwizzle
1.197 +template <class T>
1.198 +inline TSwizzle<T>::TSwizzle(T* aPtr)
1.199 + : TSwizzleBase(aPtr)
1.200 +/** Constructs a swizzle for a class T type object, represented by a pointer.
1.201 +
1.202 +@param aPtr A pointer to a class T type object. */
1.203 + {}
1.204 +template <class T>
1.205 +inline TSwizzle<T>::TSwizzle(TStreamId anId)
1.206 + : TSwizzleBase(anId)
1.207 +/** Constructs a swizzle for a class T type object, represented as a stream id.
1.208 +
1.209 +@param anId The id of a stream containing the external representation of a
1.210 +class T type object. */
1.211 + {}
1.212 +template <class T>
1.213 +inline TSwizzle<T>& TSwizzle<T>::operator=(T* aPtr)
1.214 +/** Sets this swizzle to represent the in-memory type T object, pointed to by the
1.215 +specified T* pointer.
1.216 +
1.217 +@param aPtr A pointer to an object of type T which the swizzle is to represent.
1.218 +@return A reference to this swizzle representing the object of type T. */
1.219 + {return *this=TSwizzle<T>(aPtr);}
1.220 +template <class T>
1.221 +inline T* TSwizzle<T>::AsPtr() const
1.222 +/** Returns a pointer to the object which this swizzle represents.
1.223 +
1.224 +Note that the indirect component selector operator->() can be used to access
1.225 +members of the represented object.
1.226 +
1.227 +@return A pointer to the class T type object represented by this swizzle. */
1.228 + {return (T*)Ptr();}
1.229 +template <class T>
1.230 +inline TSwizzle<T>::operator T*() const
1.231 + {return AsPtr();}
1.232 +template <class T>
1.233 +inline T& TSwizzle<T>::operator*() const
1.234 +/** Returns a reference to the type T object which this swizzle represents.
1.235 +
1.236 +@return A reference to the type T object represented by this swizzle. */
1.237 + {return *AsPtr();}
1.238 +template <class T>
1.239 +inline T* TSwizzle<T>::operator->() const
1.240 +/** Gives access to members of the type T object which this swizzle represents.
1.241 +
1.242 +Note, use the AsPtr() member function to return a pointer to the object itself.
1.243 +
1.244 +@return A pointer to the T type object; not explicitly accessible. */
1.245 + {return AsPtr();}
1.246 +template <class T>
1.247 +inline void TSwizzle<T>::ExternalizeL(RWriteStream& aStream) const
1.248 +/** Externalises the stream id of the stream associated with this swizzle.
1.249 +
1.250 +This function presupposes that:
1.251 +
1.252 +a store map, i.e. an object of type CStoreMap, has been constructed
1.253 +
1.254 +the id of the stream containing the external representation of the represented
1.255 +type T object has been bound to this swizzle and added to the store map.
1.256 +
1.257 +the concrete stream referenced by aStream has been constructed, specifying
1.258 +the store map as an externaliser.
1.259 +
1.260 +The presence of this function means that the standard templated operator<<()
1.261 +can be used.
1.262 +
1.263 +@param aStream Stream to which the stream id should be externalised.
1.264 +@see CStoreMap */
1.265 + {TSwizzleBase::DoExternalizeL(aStream,TExternalizer<T>::Function());}
1.266 +inline TSwizzle<TAny>::TSwizzle(TAny* aPtr)
1.267 + : TSwizzleBase(aPtr)
1.268 +/** Constructs the swizzle representing the specified untyped object as a pointer.
1.269 +
1.270 +@param aPtr A pointer to an untyped object which this swizzle is to represent. */
1.271 + {}
1.272 +inline TSwizzle<TAny>::TSwizzle(TStreamId anId)
1.273 + : TSwizzleBase(anId)
1.274 +/** Constructs the swizzle for an untyped object, represented as a stream id.
1.275 +
1.276 +@param anId The id of a stream containing the external representation of the
1.277 + untyped object which this swizzle is to represent. */
1.278 + {}
1.279 +inline TSwizzle<TAny>::TSwizzle(const TSwizzleBase& aSwizzle)
1.280 + : TSwizzleBase(aSwizzle)
1.281 +/** Constructs the swizzle to represent the untyped object currently represented
1.282 + by the specified swizzle.
1.283 +
1.284 +@param aSwizzle A reference to a swizzle whose representation of an object
1.285 + is to be copied to this swizzle */
1.286 + {}
1.287 +inline TSwizzle<TAny>& TSwizzle<TAny>::operator=(TAny* aPtr)
1.288 +/** Sets this swizzle to represent the in-memory object, pointed to by the specified
1.289 + pointer.
1.290 +
1.291 +@param aPtr A pointer to the untyped object which the swizzle is to represent.
1.292 +@return A reference to this swizzle. */
1.293 + {return *this=TSwizzle<TAny>(aPtr);}
1.294 +inline TSwizzle<TAny>& TSwizzle<TAny>::operator=(const TSwizzleBase& aSwizzle)
1.295 + /** Sets the swizzle to represent the untyped object currently represented by the
1.296 + specified swizzle.
1.297 +
1.298 + @param aSwizzle The swizzle whose representation of an object is to be copied
1.299 + to this swizzle.
1.300 + @return A reference to this swizzle. */
1.301 + {return *this=TSwizzle<TAny>(aSwizzle);}
1.302 +inline TAny* TSwizzle<TAny>::AsPtr() const
1.303 +/** Returns a pointer to the untyped object that this swizzle represents.
1.304 +
1.305 + @return A pointer to the untyped object represented by this swizzle. */
1.306 + {return Ptr();}
1.307 +inline TSwizzle<TAny>::operator TAny*() const
1.308 + {return AsPtr();}
1.309 +
1.310 +// Template class TSwizzleC
1.311 +template <class T>
1.312 +inline TSwizzleC<T>::TSwizzleC(const T* aPtr)
1.313 + : TSwizzleCBase(aPtr)
1.314 +/** Constructs a swizzle for a class T type object and represents the object by
1.315 +pointer.
1.316 +
1.317 +@param aPtr A pointer to a class T type object. */
1.318 + {}
1.319 +template <class T>
1.320 +inline TSwizzleC<T>::TSwizzleC(TStreamId anId)
1.321 + : TSwizzleCBase(anId)
1.322 +/** Constructs a swizzle for a class T type object and represents the object as
1.323 +a stream id.
1.324 +
1.325 +@param anId The stream id of a stream containing the external representation
1.326 +of an object of type class T. */
1.327 + {}
1.328 +template <class T>
1.329 +inline TSwizzleC<T>::TSwizzleC(TSwizzle<T> aSwizzle)
1.330 + : TSwizzleCBase(aSwizzle)
1.331 +/** Constructs a swizzle for a class T type object that is currently represented
1.332 +by another swizzle.
1.333 +
1.334 +The representation of the class T type object is the same as its representation
1.335 +by the specified swizzle, i.e. if the specified swizzle represents the object
1.336 +as a pointer, then this newly constructed swizzle also represents the object
1.337 +as a pointer.
1.338 +
1.339 +@param aSwizzle The swizzle whose representation of the class T type object
1.340 +is to be copied to this swizzle. */
1.341 + {}
1.342 +template <class T>
1.343 +inline TSwizzleC<T>& TSwizzleC<T>::operator=(const T* aPtr)
1.344 +/** Sets this swizzle to represent the in-memory type T object, pointed to by the
1.345 +specified T* pointer.
1.346 +
1.347 +@param aPtr A pointer to an object of type T which the swizzle is to represent.
1.348 +@return A reference to this swizzle representing the object of type T.
1.349 +@see TSwizzle::operator=() */
1.350 + {return *this=TSwizzleC<T>(aPtr);}
1.351 +template <class T>
1.352 +inline const T* TSwizzleC<T>::AsPtr() const
1.353 +/** Returns a constant pointer to the object which this swizzle represents.
1.354 +
1.355 +Note:
1.356 +
1.357 +The in memory object cannot be changed through this swizzle.
1.358 +
1.359 +To access members of the object, the indirect component selector operator->()
1.360 +can be used.
1.361 +
1.362 +@return A const pointer to the class T type object represented by this swizzle. */
1.363 + {return (const T*)Ptr();}
1.364 +template <class T>
1.365 +inline TSwizzleC<T>::operator const T*() const
1.366 + {return AsPtr();}
1.367 +template <class T>
1.368 +inline const T& TSwizzleC<T>::operator*() const
1.369 +/** Returns a const reference to the type T object which this swizzle represents.
1.370 +
1.371 +@return A const reference to the type T object represented by this swizzle.
1.372 +@see TSwizzle::operator*() */
1.373 + {return *AsPtr();}
1.374 +template <class T>
1.375 +inline const T* TSwizzleC<T>::operator->() const
1.376 +/** Gives access to members of the type T object which this swizzle represents.
1.377 +
1.378 +Note:
1.379 +
1.380 +use the AsPtr() member function to return a pointer to the object itself.
1.381 +
1.382 +the type T object cannot be changed through this operator.
1.383 +
1.384 +@return A const pointer to the T type object; not explicitly accessible.
1.385 +@see TSwizzle::operator->() */
1.386 + {return AsPtr();}
1.387 +template <class T>
1.388 +inline void TSwizzleC<T>::ExternalizeL(RWriteStream& aStream) const
1.389 +/** Externalises the stream id of the stream associated with this swizzle.
1.390 +
1.391 +This function presupposes that:
1.392 +
1.393 +a store map, i.e. an object of type CStoreMap, has been constructed
1.394 +
1.395 +the id of the stream containing the external representation of the <class T>
1.396 +object has been bound to this swizzle and added to the store map.
1.397 +
1.398 +the concrete stream referenced by aStream has been constructed, specifying
1.399 +the store map as an externalizer.
1.400 +
1.401 +The presence of this function means that the standard templated operator<<()
1.402 +can be used.
1.403 +
1.404 +@param aStream Stream to which the stream id should be externalised
1.405 +@see CStoreMap */
1.406 + {TSwizzleCBase::DoExternalizeL(aStream,TExternalizer<T>::Function());}
1.407 +inline TSwizzleC<TAny>::TSwizzleC(const TAny* aPtr)
1.408 + : TSwizzleCBase(aPtr)
1.409 +/** Constructs the swizzle representing the specified untyped object as a pointer.
1.410 +
1.411 +@param aPtr A pointer to an untyped object which this swizzle is to represent. */
1.412 + {}
1.413 +inline TSwizzleC<TAny>::TSwizzleC(TStreamId anId)
1.414 + : TSwizzleCBase(anId)
1.415 +/** Constructs the swizzle for an untyped object, represented as a stream id.
1.416 +
1.417 +@param anId The id of a stream containing the external representation of the
1.418 + untyped object which this swizzle is to represent. */
1.419 + {}
1.420 +inline TSwizzleC<TAny>::TSwizzleC(const TSwizzleCBase& aSwizzle)
1.421 + : TSwizzleCBase(aSwizzle)
1.422 +/** Constructs the swizzle to represent the untyped object currently represented
1.423 + by the specified swizzle.
1.424 +
1.425 +@param aSwizzle The swizzle whose representation of an object is to be copied
1.426 + to this swizzle. */
1.427 + {}
1.428 +inline TSwizzleC<TAny>::TSwizzleC(TStreamRef aRef)
1.429 + : TSwizzleCBase(aRef)
1.430 +/** Constructs the swizzle from a stream reference.
1.431 +
1.432 +@param aRef The stream reference. */
1.433 + {}
1.434 +inline TSwizzleC<TAny>& TSwizzleC<TAny>::operator=(const TAny* aPtr)
1.435 +/** Sets this swizzle to represent the specified in-memory untyped object.
1.436 +
1.437 +@param aPtr A pointer to the untyped object that the swizzle is to represent.
1.438 +@return A reference to this swizzle representing the untyped object. */
1.439 + {return *this=TSwizzleC<TAny>(aPtr);}
1.440 +inline TSwizzleC<TAny>& TSwizzleC<TAny>::operator=(const TSwizzleCBase& aSwizzle)
1.441 +/** Sets this swizzle to represent the untyped object currently represented by the
1.442 + specific swizzle.
1.443 +
1.444 +@param aSwizzle A pointer to the untyped object that the swizzle is to represent.
1.445 +@return A reference to a swizzle whose representation of an object is to be
1.446 + copied to this swizzle. */
1.447 + {return *this=TSwizzleC<TAny>(aSwizzle);}
1.448 +inline const TAny* TSwizzleC<TAny>::AsPtr() const
1.449 +/** Gets a constant pointer to the untyped object that this swizzle represents.
1.450 +
1.451 +@return A const pointer to the untyped object represented by this swizzle. */
1.452 + {return Ptr();}
1.453 +inline TSwizzleC<TAny>::operator const TAny*() const
1.454 + {return AsPtr();}
1.455 +