1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/Babitflags.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,261 @@
1.4 +// Copyright (c) 1999-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 +#ifndef __BABITFLAGS_H__
1.20 +#define __BABITFLAGS_H__
1.21 +
1.22 +// System includes
1.23 +#include <e32std.h>
1.24 +
1.25 +//
1.26 +// ----> TBitFlagsT (header)
1.27 +//
1.28 +template <class T>
1.29 +class TBitFlagsT
1.30 +/**
1.31 +A simple class which manages the process of setting and clearing
1.32 +flags in an abstract fashion.
1.33 +@publishedAll
1.34 +@released
1.35 +*/
1.36 + {
1.37 +//
1.38 +public: // CONSTRUCT
1.39 +//
1.40 +
1.41 + /**
1.42 + * Default constructor - initialize all flags to zero
1.43 + */
1.44 + inline TBitFlagsT();
1.45 +
1.46 + /**
1.47 + * Initialize the whole flag to a certain value
1.48 + */
1.49 + inline TBitFlagsT(T aFlags);
1.50 +
1.51 + /**
1.52 + * Copy constructor - initialize this flag object to mirror
1.53 + * that of aFlags.
1.54 + */
1.55 + inline TBitFlagsT(const TBitFlagsT& aFlags);
1.56 +
1.57 +//
1.58 +public: // MANIPULATORS
1.59 +//
1.60 +
1.61 + /**
1.62 + * Set all the flags
1.63 + */
1.64 + inline void SetAll();
1.65 +
1.66 + /**
1.67 + * Clear all the flags
1.68 + */
1.69 + inline void ClearAll();
1.70 +
1.71 + /**
1.72 + * Set a particular flag
1.73 + */
1.74 + inline void Set(TInt aFlagIndex);
1.75 +
1.76 + /**
1.77 + * Clear a particular flag
1.78 + */
1.79 + inline void Clear(TInt aFlagIndex);
1.80 +
1.81 + /**
1.82 + * Set or clear a particular flag
1.83 + *
1.84 + * If aValue is 1, then the flag is set
1.85 + * If aValue is 0, then the flag is cleared
1.86 + */
1.87 + inline void Assign(TInt aFlagIndex, TBool aValue);
1.88 +
1.89 + /**
1.90 + * Change the state of a particular flag. If the flag at the specified
1.91 + * index was clear, then it becomes set, otherwise it becomes clear.
1.92 + */
1.93 + inline void Toggle(TInt aFlagIndex);
1.94 +
1.95 +//
1.96 +public: // OPERATORS
1.97 +//
1.98 +
1.99 + /**
1.100 + * Check if a particular flag is set or not
1.101 + *
1.102 + * @return A boolean indicating whether the specified flag is set or clear
1.103 + */
1.104 + inline TBool operator[](TInt aFlagIndex) const;
1.105 +
1.106 + /**
1.107 + * Assignment operator - assign specific value to the whole flag, replacing
1.108 + * any existing value.
1.109 + */
1.110 + inline TBitFlagsT& operator=(const TBitFlagsT& aFlags);
1.111 +
1.112 + /**
1.113 + * Compare the value of the whole flag with a given value.
1.114 + *
1.115 + * @return A boolean indicating whether the two flags are identical.
1.116 + */
1.117 + inline TBool operator==(const TBitFlagsT& aFlags);
1.118 +
1.119 +//
1.120 +public: // ACCESS
1.121 +//
1.122 +
1.123 + /**
1.124 + * Check if a particular flag is set
1.125 + */
1.126 + inline TBool IsSet(TInt aFlagIndex) const;
1.127 +
1.128 + /**
1.129 + * Check if a particular flag is clear
1.130 + */
1.131 + inline TBool IsClear(TInt aFlagIndex) const;
1.132 +
1.133 + /**
1.134 + * Access the underlying value of the flag.
1.135 + */
1.136 + inline T Value() const { return iFlags; }
1.137 +
1.138 + /**
1.139 + * Assign a new value (directly) to this flag object. Replaces any
1.140 + * existing individual flag settings.
1.141 + */
1.142 + inline void SetValue(T aFlags) { iFlags = aFlags; }
1.143 +
1.144 +//
1.145 +private: // INTERNAL
1.146 +//
1.147 +
1.148 + /**
1.149 + * Generate a mask for a particular flag
1.150 + */
1.151 + inline T FlagMask(TInt aFlagIndex) const;
1.152 +
1.153 +//
1.154 +public: // MEMBER DATA
1.155 +//
1.156 +
1.157 + // The underlying object container which represents the flags.
1.158 + T iFlags;
1.159 + };
1.160 +
1.161 +/**
1.162 +Type definitions
1.163 +@publishedAll
1.164 +@released
1.165 +*/
1.166 +typedef TBitFlagsT<TUint8> TBitFlags8;
1.167 +//
1.168 +
1.169 +/**
1.170 +Type definitions
1.171 +@publishedAll
1.172 +@released
1.173 +*/
1.174 +typedef TBitFlagsT<TUint16> TBitFlags16;
1.175 +//
1.176 +
1.177 +/**
1.178 +Type definitions
1.179 +@publishedAll
1.180 +@released
1.181 +*/
1.182 +typedef TBitFlagsT<TUint32> TBitFlags32;
1.183 +//
1.184 +
1.185 +
1.186 +typedef TBitFlags32 TBitFlags;
1.187 +
1.188 +
1.189 +//
1.190 +// ----> TBitFlagsT (inlines)
1.191 +//
1.192 +template <class T>
1.193 +inline TBitFlagsT<T>::TBitFlagsT() : iFlags(T(0))
1.194 + {}
1.195 +
1.196 +template <class T>
1.197 +inline TBitFlagsT<T>::TBitFlagsT(T aFlags) : iFlags(aFlags)
1.198 + {}
1.199 +
1.200 +template <class T>
1.201 +inline TBitFlagsT<T>::TBitFlagsT(const TBitFlagsT<T>& aFlags) : iFlags(aFlags.iFlags)
1.202 + {}
1.203 +
1.204 +template <class T>
1.205 +inline T TBitFlagsT<T>::FlagMask(TInt aFlagIndex) const
1.206 + { return T(T(1)<<aFlagIndex); }
1.207 +
1.208 +template <class T>
1.209 +inline TBool TBitFlagsT<T>::IsSet(TInt aFlagIndex) const
1.210 + {
1.211 + // All out-of-range values should return false
1.212 + if(aFlagIndex <= ((sizeof(T)<<3)-1) )
1.213 + {
1.214 + return iFlags & FlagMask(aFlagIndex);
1.215 + }
1.216 + else
1.217 + {
1.218 + return EFalse;
1.219 + }
1.220 +
1.221 + }
1.222 +
1.223 +template <class T>
1.224 +inline TBool TBitFlagsT<T>::IsClear(TInt aFlagIndex) const
1.225 + { return !IsSet(aFlagIndex); }
1.226 +
1.227 +template <class T>
1.228 +inline void TBitFlagsT<T>::Set(TInt aFlagIndex)
1.229 + { iFlags = T(iFlags | FlagMask(aFlagIndex)); }
1.230 +
1.231 +template <class T>
1.232 +inline void TBitFlagsT<T>::Clear(TInt aFlagIndex)
1.233 + { iFlags = T(iFlags & ~(FlagMask(aFlagIndex))); }
1.234 +
1.235 +template <class T>
1.236 +inline void TBitFlagsT<T>::Assign(TInt aFlagIndex, TBool aVal)
1.237 + { if (aVal) Set(aFlagIndex); else Clear(aFlagIndex); }
1.238 +
1.239 +template <class T>
1.240 +inline void TBitFlagsT<T>::Toggle(TInt aFlagIndex)
1.241 + { iFlags = T(iFlags^FlagMask(aFlagIndex)); }
1.242 +
1.243 +template <class T>
1.244 +inline TBool TBitFlagsT<T>::operator[](TInt aFlagIndex) const
1.245 + { return IsSet(aFlagIndex); }
1.246 +
1.247 +template <class T>
1.248 +inline TBitFlagsT<T>& TBitFlagsT<T>::operator=(const TBitFlagsT<T>& aFlags)
1.249 + { iFlags = aFlags.iFlags; return *this; }
1.250 +
1.251 +template <class T>
1.252 +inline TBool TBitFlagsT<T>::operator==(const TBitFlagsT<T>& aFlags)
1.253 + { return iFlags == aFlags.Value(); }
1.254 +
1.255 +template <class T>
1.256 +inline void TBitFlagsT<T>::SetAll()
1.257 + { iFlags = T(~(T(0))); }
1.258 +
1.259 +template <class T>
1.260 +inline void TBitFlagsT<T>::ClearAll()
1.261 + { iFlags = T(0); }
1.262 +
1.263 +
1.264 +#endif