inc/FBaseLongLong.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FBaseLongLong.h
  19  * @brief               This is the header file for the %LongLong class.
  20  *
  21  * This header file contains the declarations of the %LongLong class.
  22  *
  23  * @see                 Tizen::Base::Number
  24  */
  25 #ifndef _FBASE_LONG_LONG_H_
  26 #define _FBASE_LONG_LONG_H_
  27
  28 #include <FBaseNumber.h>
  29
  30 namespace Tizen { namespace Base
  31 {
  32 /**
  33  *      @class  LongLong
  34  *      @brief  This class is the wrapper class for the @c signed @c long @c long built-in type.
  35  *
  36  *      @since  2.0
  37  *
  38  *      The %LongLong class represents an integer value ranging from @c -9223372036854775808 to @c 9223372036854775807,
  39  *      that is, @c -(2^63) to @c +((2^63)-1). The class is useful when passing a 64-bit @c signed
  40  *      integral value to a method that accepts only an instance of Object. Furthermore,
  41  *      this class provides methods for converting %LongLong (and @c long @c long) to String, and %String
  42  *      to %LongLong (and @c long @c long).
  43  *
  44  * The following example demonstrates how to use the %LongLong class.
  45  *
  46  *      @code
  47  *
  48  *      #include <FBase.h>
  49  *
  50  *      using namespace Tizen::Base;
  51  *
  52  *      // This method checks whether the given string object contains a string
  53  *      // representation of the pre-defined minimum 64-bit integral value
  54  *      result
  55  *      MyClass::Verify(String& string, bool& out)
  56  *      {
  57  *              static const LongLong MINIMUM(123456789);
  58  *              result r = E_SUCCESS;
  59  *
  60  *              long long l;
  61  *              r = LongLong::Parse(string, l);
  62  *              if (IsFailed(r))
  63  *              {
  64  *                      goto CATCH;
  65  *              }
  66  *
  67  *              out = (MINIMUM.CompareTo(l) == 0) ? true: false;
  68  *
  69  *              return r;
  70  *      CATCH:
  71  *              return r;
  72  *      }
  73  *      @endcode
  74  */
  75 class _OSP_EXPORT_ LongLong
  76         : public Number
  77 {
  78 public:
  79         /**
  80          *      Initializes this instance of %LongLong with the specified value.
  81          *
  82          *      @since                  2.0
  83          *
  84          *      @param[in]      value   The @c long @c long value
  85          */
  86         LongLong(long long value = 0);
  87
  88         /**
  89          *      Copying of objects using this copy constructor is allowed.
  90          *
  91          *      @since                  2.0
  92          *
  93          *      @param[in]      value   An instance of %LongLong to copy
  94          */
  95         LongLong(const LongLong& value);
  96
  97         /**
  98          *      This destructor overrides Tizen::Base::Object::~Object().
  99          *
 100          *      @since  2.0
 101          */
 102         virtual ~LongLong(void);
 103
 104         /**
 105          *      Copying of objects using this copy assignment operator is allowed.
 106          *
 107          *      @since                  2.0
 108          *
 109          *      @param[in]      rhs     An instance of %LongLong to copy
 110          */
 111         LongLong& operator =(const LongLong& rhs);
 112
 113         /**
 114          *      Compares two @c long @c long values.
 115          *
 116          *      @since          2.0
 117          *
 118          *      @return         The 32-bit @c signed integer value
 119          *      @code
 120          *      <  0  if the value of l1 is less than the value of l2
 121          *      == 0  if the value of l1 is equal to the value of l2
 122          *      >  0  if the value of l1 is greater than the value of l2
 123          *      @endcode
 124          *      @param[in]      l1      The first @c long @c long value to compare
 125          *      @param[in]      l2      The second @c long @c long value to compare
 126          */
 127         static int Compare(long long l1, long long l2);
 128
 129         /**
 130          *      Compares the value of the current instance with the value of the specified instance of %LongLong.
 131          *
 132          *      @since          2.0
 133          *
 134          *      @return         The 32-bit @c signed integer value
 135          *      @code
 136          *      <  0  if the value of the current instance is less than the value of the specified instance
 137          *      == 0  if the value of the current instance is equal to the value of the specified instance
 138          *      >  0  if the value of the current instance is greater than the value of the specified instance
 139          *      @endcode
 140          *      @param[in]      value   An instance of %LongLong to compare
 141          */
 142         int CompareTo(const LongLong& value) const;
 143
 144         /**
 145          *      Checks whether the value of the specified instance of Object is equal to the value of the current instance of %LongLong.
 146          *
 147          *      @since          2.0
 148          *
 149          *      @return         @c true if the value of the specified instance of Object is equal to the value of the current instance of %LongLong, @n
 150          *                              else @c false
 151          *      @param[in]      obj     An instance of Object to compare
 152          *      @see            Tizen::Base::Object::Equals()
 153          */
 154         virtual bool Equals(const Object& obj) const;
 155
 156         /**
 157          *      Gets the hash value of the current instance of %LongLong.
 158          *
 159          *      @since          2.0
 160          *
 161          *      @return         The integer value that indicates the hash value of the current instance of %LongLong
 162          *      @remarks
 163          *                              - Two equal instances must return the same hash value. @n
 164          *                              For better performance, the used hash function must generate a random distribution for all the inputs. @n
 165          *                              - The default implementation of this method returns the value of the current instance.
 166          */
 167         virtual int GetHashCode(void) const;
 168
 169         /**
 170          *  Gets the hash value of the specified @c long @c long value.
 171          *
 172          *  @since         2.0
 173          *
 174          *  @return      The integer value that indicates the hash value of the specified @c long @c long value
 175          *  @param[in]   val   The @c long @c long value used to get the hash value
 176         */
 177         static int GetHashCode(long long val);
 178
 179         /**
 180          *      Gets the @c signed @c char equivalent of the current instance of %LongLong.
 181          *
 182          *      @since          2.0
 183          *
 184          *      @return         The @c signed @c char equivalent of the current instance
 185          */
 186         virtual char ToChar(void) const;
 187
 188         /**
 189          *      Gets the @c signed @c short equivalent of the current instance of %LongLong.
 190          *
 191          *      @since          2.0
 192          *
 193          *      @return         The @c signed @c short equivalent of the current instance
 194          */
 195         virtual short ToShort(void) const;
 196
 197         /**
 198          *      Gets the @c signed @c int equivalent of the current instance of %LongLong.
 199          *
 200          *      @since          2.0
 201          *
 202          *      @return         The @c signed @c int equivalent of the current instance
 203          */
 204         virtual int ToInt(void) const;
 205
 206         /**
 207          *      Gets the @c signed @c long equivalent of the current instance of %LongLong.
 208          *
 209          *      @since          2.0
 210          *
 211          *      @return         The @c signed @c long equivalent of the current instance
 212          */
 213         virtual long ToLong(void) const;
 214
 215         /**
 216          *      Gets the @c signed @c float equivalent of the current instance of %LongLong.
 217          *
 218          *      @since          2.0
 219          *
 220          *      @return         The @c signed @c float equivalent of the current instance
 221          */
 222         virtual float ToFloat(void) const;
 223
 224         /**
 225          *      Gets the @c signed @c double equivalent of the current instance of %LongLong.
 226          *
 227          *      @since          2.0
 228          *
 229          *      @return         The @c signed @c double equivalent of the current instance
 230          */
 231         virtual double ToDouble(void) const;
 232
 233         /**
 234          *      Gets the @c signed @c long @c long equivalent of the current instance of %LongLong.
 235          *
 236          *      @since          2.0
 237          *
 238          *      @return         The @c signed @c long @c long equivalent of the current instance
 239          */
 240         virtual long long ToLongLong(void) const;
 241
 242         /**
 243          *      Gets the string that represents the value of the current instance of %LongLong.
 244          *
 245          *      @since          2.0
 246          *
 247          *      @return         The string that represents the value of the current instance
 248          */
 249         virtual String ToString(void) const;
 250
 251         /**
 252          *      Gets the string that represents the specified @c signed @c long @c long value.
 253          *
 254          *      @since                  2.0
 255          *
 256          *      @return         The string that contains the Unicode representation of the specified @c signed @c long @c long value
 257          *      @param[in]      value   The @c signed @c long @c long value to convert
 258          */
 259         static String ToString(long long value);
 260
 261         /**
 262          *      Parses the specified string that represents a numeric value and
 263          *      returns the value as a @c signed @c long @c long (as out parameter).
 264          *
 265          *      @since                  2.0
 266          *
 267          *      @return                 An error code
 268          *      @param[in]      s                               The string that represents the numeric value
 269          *      @param[out]     ret                             The result of the operation
 270          *      @exception      E_SUCCESS               The method is successful.
 271          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 272          *      @remarks
 273          *                              - This method assumes that the string that represents the numeric value uses a radix @c 10.
 274          *                              - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 275          */
 276         static result Parse(const String& s, long long& ret);
 277
 278         /**
 279          *      Parses the specified string that represents a numeric value using the specified radix and
 280          *      returns the value as a @c signed @c long @c long (as out parameter).
 281          *
 282          *      @since                  2.1
 283          *
 284          *      @return                 An error code
 285          *      @param[in]      s                               The string that represents the numeric value
 286          *      @param[in]      radix                   The radix of the string that represents a numeric value @n
 287          *                                                              It must be either 2, 8, 10 or 16.
 288          *      @param[out]     ret                             The result of the operation
 289          *      @exception      E_SUCCESS               The method is successful.
 290          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 291          *      @exception      E_OUT_OF_RANGE  The specified @c radix is invalid.
 292          *      @remarks        This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 293          */
 294         static result Parse(const String& s, int radix, long long& ret);
 295
 296         /**
 297          *      The constant holding the maximum value a @c long @c long can have; @c 2^63-1.
 298          *
 299          *      @since  2.0
 300          */
 301         static const long long VALUE_MAX = (long long) 0x7FFFFFFFFFFFFFFFLL;
 302
 303         /**
 304          *      The constant holding the minimum value a @c long @c long can have; @c -2^63.
 305          *
 306          *      @since  2.0
 307          */
 308         static const long long VALUE_MIN = (long long) 0x8000000000000000LL;
 309
 310         /**
 311          * The @c long @c long value of this instance.
 312          *
 313          * @since       2.0
 314          */
 315         long long value;
 316
 317
 318 private:
 319         friend class _LongLongImpl;
 320         class _LongLongImpl* __pLongLongImpl;
 321
 322 }; // LongLong
 323
 324 }} // Tizen::Base
 325
 326 #endif //_FBASE_LONG_LONG_H_