inc/FBaseInt8.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                FBaseInt8.h
  19  * @brief               This is the header file for the %Int8 class.
  20  *
  21  * @see                 Tizen::Base::Number
  22  *
  23  * This header file contains the declarations of the %Int8 class.
  24  */
  25 #ifndef _FBASE_INT8_H_
  26 #define _FBASE_INT8_H_
  27
  28 #include <FBaseNumber.h>
  29
  30 namespace Tizen { namespace Base
  31 {
  32 /**
  33  * @class       Int8
  34  * @brief       <i> [Deprecated] </i>
  35  * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
  36  *
  37  * @brief       This class is the wrapper class for the @c signed @c char built-in type.
  38  *
  39  * @since 2.0
  40  *
  41  * The %Int8 class represents an integer value ranging from -128 to 127. The class is useful when passing an 8-bit
  42  * signed integral value to a method that accepts only an instance of Object. Furthermore, this class provides
  43  * methods for converting %Int8 (and @c char) to String, and %String to %Int8 (and @c char).
  44  *
  45  * The following example demonstrates how to use the %Int8 class.
  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 8-bit integral value.
  54  *      result
  55  *      MyClass::Verify(String& string, bool& out)
  56  *      {
  57  *              static const Int8 MINIMUM(123);
  58  *
  59  *              result r = E_SUCCESS;
  60  *
  61  *              char ch;
  62  *              r = Int8::Parse(string, ch);
  63  *              if (IsFailed(r))
  64  *              {
  65  *                      goto CATCH;
  66  *              }
  67  *
  68  *              out = (MINIMUM.CompareTo(ch) == 0) ? true: false;
  69  *
  70  *              return r;
  71  *      CATCH:
  72  *              return r;
  73  *      }
  74  * @endcode
  75  */
  76 class _OSP_EXPORT_ Int8
  77         : public Number
  78 {
  79 public:
  80         /**
  81          * Initializes this instance of %Int8 with the specified value.
  82          *
  83          * @since 2.0
  84          * @brief       <i> [Deprecated] </i>
  85          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
  86          *
  87          *
  88          * @param[in]   value   A @c char value
  89          */
  90         Int8(char value = 0);
  91
  92         /**
  93          * Copying of objects using this copy constructor is allowed.
  94          *
  95          * @since 2.0
  96          * @brief       <i> [Deprecated] </i>
  97          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
  98          *
  99          *
 100          * @param[in]   value   An instance of %Int8
 101          */
 102         Int8(const Int8& value);
 103
 104         /**
 105          * This destructor overrides Tizen::Base::Object::~Object().
 106          *
 107          * @since 2.0
 108          * @brief       <i> [Deprecated] </i>
 109          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 110          *
 111          */
 112         virtual ~Int8(void);
 113
 114         /**
 115          * Copying of objects using this copy assignment operator is allowed.
 116          *
 117          * @since 2.0
 118          * @brief       <i> [Deprecated] </i>
 119          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 120          *
 121          * @param[in]   rhs     An instance of %Int8
 122          */
 123         Int8& operator =(const Int8& rhs);
 124
 125         /**
 126          * Compares two @c char values.
 127          *
 128          * @since 2.0
 129          * @brief       <i> [Deprecated] </i>
 130          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 131          *
 132          * @return              A 32-bit @c signed integer value
 133          * @code
 134          * <  0  if the value of ch1 is less than the value of ch2
 135          * == 0  if the value of ch1 is equal to the value of ch2
 136          * >  0  if the value of ch1 is greater than the value of ch2
 137          * @endcode
 138          * @param[in]   ch1     The first @c char value to compare
 139          * @param[in]   ch2     The second @c char value to compare
 140          */
 141         static int Compare(char ch1, char ch2);
 142
 143         /**
 144          * Compares the value of the current instance with the value of the specified instance of the %Int8 class.
 145          *
 146          * @since 2.0
 147          * @brief       <i> [Deprecated] </i>
 148          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 149          *
 150          * @return              A 32-bit @c signed integer value
 151          * @code
 152          * <  0  if the value of the current instance is less than the value of the specified instance
 153          * == 0  if the value of the current instance is equal to the value of the specified instance
 154          * >  0  if the value of the current instance is greater than the value of the specified instance
 155          * @endcode
 156          * @param[in]   value   An instance of the %Int8 class to compare
 157          */
 158         int CompareTo(const Int8& value) const;
 159
 160         /**
 161          * Checks whether the value of the specified instance of %Int8 is equal to the value of the current instance.
 162          *
 163          * @since 2.0
 164          * @brief       <i> [Deprecated] </i>
 165          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 166          *
 167          * @return              @c true if the value of the specified instance is equal to the value of the current instance, @n
 168          *                              else @c false
 169          * @param[in]   obj An instance of Object to compare
 170          * @see                 Tizen::Base::Object::Equals()
 171          */
 172         virtual bool Equals(const Object& obj) const;
 173
 174         /**
 175          * Gets the hash value of the current instance of %Int8.
 176          *
 177          * @since 2.0
 178          * @brief       <i> [Deprecated] </i>
 179          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 180          *
 181          *      @return         An integer value indicating the hash value of the current instance of %Int8
 182          *      @remarks        Two equal instances must return the same hash value. For better performance,
 183          *                              the used hash function must generate a random distribution for all inputs. @n
 184          *                              The default implementation of this method returns the value of the current instance.
 185          */
 186         virtual int GetHashCode(void) const;
 187
 188         /**
 189          * Gets the hash value of the specified @c char value.
 190          *
 191          * @since 2.0
 192          * @brief       <i> [Deprecated] </i>
 193          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 194          *
 195          *   @return            An integer value indicating the hash value of the specified @c char value
 196          *   @param[in] val   A @c char value to get the hash value
 197          */
 198         static int GetHashCode(char val);
 199
 200         /**
 201          * Decodes a string into a @c signed @c char.
 202          *
 203          * @since 2.0
 204          * @brief       <i> [Deprecated] </i>
 205          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 206          *
 207          * @return              An error code
 208          * @param[in]   s       A string representing a numeric value
 209          * @param[out]  ret     The result of the operation
 210          * @exception   E_SUCCESS        The method is successful.
 211          * @exception   E_NUM_FORMAT The specified string does not contain a number that can be parsed.
 212          * @remarks             This method accepts decimal, hexadecimal, and octal numbers given by the
 213          *                              following grammar:
 214          * @code
 215          *      - DecodableString:
 216          *              Sign[opt] DecimalNumeral
 217          *              Sign[opt] 0x HexDigits
 218          *              Sign[opt] 0X HexDigits
 219          *              Sign[opt] # HexDigits
 220          *              Sign[opt] 0 OctalDigits
 221          *      - Sign:
 222          *              '-'
 223          * @endcode
 224          * @remarks             This method has portability issue. @n
 225          *                              When the specified string is nagative number in the ARM architecture, type casting is needed like following code.
 226          * @code
 227          *      char ret;
 228          *      Int8::Decode(L"-0X20", ret);
 229          *      SomeOutputFunction(static_cast< signed char >(ret));
 230          * @endcode
 231          */
 232         static result Decode(const String& s, char& ret);
 233
 234         /**
 235          * Parses the @c signed @c char equivalent of the specified string representing a numeric value.
 236          *
 237          * @since 2.0
 238          * @brief       <i> [Deprecated] </i>
 239          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 240          *
 241          * @return              An error code
 242          * @param[in]   s       A string representing a numeric value
 243          * @param[out]  ret     The result of the operation
 244          * @exception   E_SUCCESS        The method is successful.
 245          * @exception   E_NUM_FORMAT The specified string does not contain a byte that can be parsed.
 246          * @remarks
 247          *                              - This method assumes that the string representing the numeric value uses a radix 10.
 248          *                              - This method guarantees that the original value of out-parameter is not changed when the method returns error.
 249          */
 250         static result Parse(const String& s, char& ret);
 251
 252         /**
 253          * Parses the specified string representing a numeric value and
 254          * returns the value as @c signed @c char (as out parameter).
 255          *
 256          * @since 2.0
 257          * @brief       <i> [Deprecated] </i>
 258          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 259          *
 260          * @return              The @c signed @c char equivalent of the specified string representing the numeric value using the specified index
 261          * @param[in]   s       A string representing a numeric value
 262          * @param[in]   radix   The radix of the string representing a numeric value @n
 263          *                                              It must either be 2, 8, 10, or 16.
 264          * @param[out]  ret             The result of the operation
 265          * @exception   E_SUCCESS        The method is successful.
 266          * @exception   E_NUM_FORMAT The specified string does not contain a number that can be parsed.
 267          * @exception   E_OUT_OF_RANGE The specified @c radix is invalid.
 268          * @remarks             This method guarantees that the original value of out-parameter is not changed when the method returns error.
 269          */
 270         static result Parse(const String& s, int radix, char& ret);
 271
 272         /**
 273          * Gets the @c signed @c char equivalent of the current instance of %Int8.
 274          *
 275          * @since 2.0
 276          * @brief       <i> [Deprecated] </i>
 277          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 278          *
 279          * @return      The @c signed @c char equivalent of the current instance
 280          */
 281         virtual char ToChar(void) const;
 282
 283         /**
 284          * Gets the @c signed @c short equivalent of the current instance of %Int8.
 285          *
 286          * @since 2.0
 287          * @brief       <i> [Deprecated] </i>
 288          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 289          *
 290          * @return      The @c signed @c short equivalent of the current instance
 291          */
 292         virtual short ToShort(void) const;
 293
 294         /**
 295          * Gets the @c signed @c int equivalent of the current instance of %Int8.
 296          *
 297          * @since 2.0
 298          * @brief       <i> [Deprecated] </i>
 299          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 300          *
 301          * @return      The @c signed @c int equivalent of the current instance
 302          */
 303         virtual int ToInt(void) const;
 304
 305         /**
 306          * Gets the @c signed @c long equivalent of the current instance of %Int8.
 307          *
 308          * @since 2.0
 309          * @brief       <i> [Deprecated] </i>
 310          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 311          *
 312          * @return      The @c signed @c long equivalent of the current instance
 313          */
 314         virtual long ToLong(void) const;
 315
 316         /**
 317          * Gets the @c signed @c long @c long equivalent of the current instance of %Int8.
 318          *
 319          * @since 2.0
 320          * @brief       <i> [Deprecated] </i>
 321          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 322          *
 323          * @return      The @c signed @c long @c long equivalent of the current instance
 324          */
 325         virtual long long ToLongLong(void) const;
 326
 327         /**
 328          * Gets the @c signed @c float equivalent of the current instance of %Int8.
 329          *
 330          * @since 2.0
 331          * @brief       <i> [Deprecated] </i>
 332          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 333          *
 334          * @return      The @c signed @c float equivalent of the current instance
 335          */
 336         virtual float ToFloat(void) const;
 337
 338         /**
 339          * Gets the @c signed @c double equivalent of the current instance of %Int8.
 340          *
 341          * @since 2.0
 342          * @brief       <i> [Deprecated] </i>
 343          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 344          *
 345          * @return      The @c signed @c double equivalent of the current instance
 346          */
 347         virtual double ToDouble(void) const;
 348
 349         /**
 350          * Gets the string representing the value of the current instance of %Int8.
 351          *
 352          * @since 2.0
 353          * @brief       <i> [Deprecated] </i>
 354          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 355          *
 356          * @return              A string representing the value of the current instance
 357          */
 358         virtual String ToString(void) const;
 359
 360         /**
 361          * Gets the string representing the specified @c signed @c char value using radix @c 10.
 362          *
 363          * @since 2.0
 364          * @brief       <i> [Deprecated] </i>
 365          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 366          *
 367          * @return              A string containing a Unicode representation of the specified @c char value using radix 10
 368          * @param[in]   value   A @c char value
 369          */
 370         static String ToString(char value);
 371
 372         /**
 373          * A constant holding the maximum value of type @c char. @n
 374          * A @c short character can hold a value of upto 2^7-1.
 375          *
 376          * @since 2.0
 377          * @brief       <i> [Deprecated] </i>
 378          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 379          *
 380          */
 381         static const char VALUE_MAX = (signed char) 0x7F;
 382
 383         /**
 384          * A constant holding the minimum value of type @c char. @n
 385          * A @c short character can hold a value of upto -2^7.
 386          *
 387          * @since 2.0
 388          * @brief       <i> [Deprecated] </i>
 389          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 390          *
 391          */
 392         static const char VALUE_MIN = (signed char) 0x80;
 393
 394         /**
 395          * A @c signed @c char value of this instance.
 396          *
 397          * @since 2.0
 398          * @brief       <i> [Deprecated] </i>
 399          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8 class.
 400          *
 401          */
 402         signed char value;
 403
 404
 405 private:
 406         friend class _Int8Impl;
 407         class _Int8Impl* __pInt8Impl;
 408
 409 }; // Int8
 410
 411 }} // Tizen::Base
 412
 413 #endif //_FBASE_INT8_H_