OFNumber.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#include "objfw-defs.h"

#ifdef OF_HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif

#import "OFObject.h"
#import "OFSerialization.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

typedef enum {
    OF_NUMBER_TYPE_BOOL     = 0x01,
    OF_NUMBER_TYPE_UCHAR        = 0x02,
    OF_NUMBER_TYPE_USHORT       = 0x03,
    OF_NUMBER_TYPE_UINT     = 0x04,
    OF_NUMBER_TYPE_ULONG        = 0x05,
    OF_NUMBER_TYPE_ULONGLONG    = 0x06,
    OF_NUMBER_TYPE_SIZE     = 0x07,
    OF_NUMBER_TYPE_UINT8        = 0x08,
    OF_NUMBER_TYPE_UINT16       = 0x09,
    OF_NUMBER_TYPE_UINT32       = 0x0A,
    OF_NUMBER_TYPE_UINT64       = 0x0B,
    OF_NUMBER_TYPE_UINTPTR      = 0x0C,
    OF_NUMBER_TYPE_UINTMAX      = 0x0D,
    OF_NUMBER_TYPE_SIGNED       = 0x10,
    OF_NUMBER_TYPE_CHAR     = OF_NUMBER_TYPE_UCHAR |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_SHORT        = OF_NUMBER_TYPE_USHORT |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INT      = OF_NUMBER_TYPE_UINT |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_LONG     = OF_NUMBER_TYPE_ULONG |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_LONGLONG     = OF_NUMBER_TYPE_ULONGLONG |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INT8     = OF_NUMBER_TYPE_UINT8 |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INT16        = OF_NUMBER_TYPE_UINT16 |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INT32        = OF_NUMBER_TYPE_UINT32 |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INT64        = OF_NUMBER_TYPE_UINT64 |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_SSIZE        = OF_NUMBER_TYPE_SIZE |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INTMAX       = OF_NUMBER_TYPE_UINTMAX |
                          OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_PTRDIFF      = 0x0E | OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_INTPTR       = 0x0F | OF_NUMBER_TYPE_SIGNED,
    OF_NUMBER_TYPE_FLOAT        = 0x20,
    OF_NUMBER_TYPE_DOUBLE       = 0x40 | OF_NUMBER_TYPE_FLOAT
} of_number_type_t;

@interface OFNumber: OFObject <OFCopying, OFComparing, OFSerialization,
    OFJSONRepresentation, OFMessagePackRepresentation>
{
    union of_number_value {
        bool           bool_;
        signed char    sChar;
        signed short       sShort;
        signed int     sInt;
        signed long    sLong;
        signed long long   sLongLong;
        unsigned char      uChar;
        unsigned short     uShort;
        unsigned int       uInt;
        unsigned long      uLong;
        unsigned long long uLongLong;
        int8_t         int8;
        int16_t        int16;
        int32_t        int32;
        int64_t        int64;
        uint8_t        uInt8;
        uint16_t       uInt16;
        uint32_t       uInt32;
        uint64_t       uInt64;
        size_t         size;
        ssize_t        sSize;
        intmax_t       intMax;
        uintmax_t      uIntMax;
        ptrdiff_t      ptrDiff;
        intptr_t       intPtr;
        uintptr_t      uIntPtr;
        float          float_;
        double         double_;
    } _value;
    of_number_type_t _type;
}

@property (readonly, nonatomic) of_number_type_t type;

+ (instancetype)numberWithBool: (bool)bool_;

+ (instancetype)numberWithChar: (signed char)schar;

+ (instancetype)numberWithShort: (signed short)sshort;

+ (instancetype)numberWithInt: (signed int)sint;

+ (instancetype)numberWithLong: (signed long)slong;

+ (instancetype)numberWithLongLong: (signed long long)slonglong;

+ (instancetype)numberWithUnsignedChar: (unsigned char)uchar;

+ (instancetype)numberWithUnsignedShort: (unsigned short)ushort;

+ (instancetype)numberWithUnsignedInt: (unsigned int)uint;

+ (instancetype)numberWithUnsignedLong: (unsigned long)ulong;

+ (instancetype)numberWithUnsignedLongLong: (unsigned long long)ulonglong;

+ (instancetype)numberWithInt8: (int8_t)int8;

+ (instancetype)numberWithInt16: (int16_t)int16;

+ (instancetype)numberWithInt32: (int32_t)int32;

+ (instancetype)numberWithInt64: (int64_t)int64;

+ (instancetype)numberWithUInt8: (uint8_t)uint8;

+ (instancetype)numberWithUInt16: (uint16_t)uint16;

+ (instancetype)numberWithUInt32: (uint32_t)uint32;

+ (instancetype)numberWithUInt64: (uint64_t)uint64;

+ (instancetype)numberWithSize: (size_t)size;

+ (instancetype)numberWithSSize: (ssize_t)ssize;

+ (instancetype)numberWithIntMax: (intmax_t)intmax;

+ (instancetype)numberWithUIntMax: (uintmax_t)uintmax;

+ (instancetype)numberWithPtrDiff: (ptrdiff_t)ptrdiff;

+ (instancetype)numberWithIntPtr: (intptr_t)intptr;

+ (instancetype)numberWithUIntPtr: (uintptr_t)uintptr;

+ (instancetype)numberWithFloat: (float)float_;

+ (instancetype)numberWithDouble: (double)double_;

- init OF_UNAVAILABLE;

- initWithBool: (bool)bool_;

- initWithChar: (signed char)schar;

- initWithShort: (signed short)sshort;

- initWithInt: (signed int)sint;

- initWithLong: (signed long)slong;

- initWithLongLong: (signed long long)slonglong;

- initWithUnsignedChar: (unsigned char)uchar;

- initWithUnsignedShort: (unsigned short)ushort;

- initWithUnsignedInt: (unsigned int)uint;

- initWithUnsignedLong: (unsigned long)ulong;

- initWithUnsignedLongLong: (unsigned long long)ulonglong;

- initWithInt8: (int8_t)int8;

- initWithInt16: (int16_t)int16;

- initWithInt32: (int32_t)int32;

- initWithInt64: (int64_t)int64;

- initWithUInt8: (uint8_t)uint8;

- initWithUInt16: (uint16_t)uint16;

- initWithUInt32: (uint32_t)uint32;

- initWithUInt64: (uint64_t)uint64;

- initWithSize: (size_t)size;

- initWithSSize: (ssize_t)ssize;

- initWithIntMax: (intmax_t)intmax;

- initWithUIntMax: (uintmax_t)uintmax;

- initWithPtrDiff: (ptrdiff_t)ptrdiff;

- initWithIntPtr: (intptr_t)intptr;

- initWithUIntPtr: (uintptr_t)uintptr;

- initWithFloat: (float)float_;

- initWithDouble: (double)double_;

- (bool)boolValue;

- (signed char)charValue;

- (signed short)shortValue;

- (signed int)intValue;

- (signed long)longValue;

- (signed long long)longLongValue;

- (unsigned char)unsignedCharValue;

- (unsigned short)unsignedShortValue;

- (unsigned int)unsignedIntValue;

- (unsigned long)unsignedLongValue;

- (unsigned long long)unsignedLongLongValue;

- (int8_t)int8Value;

- (int16_t)int16Value;

- (int32_t)int32Value;

- (int64_t)int64Value;

- (uint8_t)uInt8Value;

- (uint16_t)uInt16Value;

- (uint32_t)uInt32Value;

- (uint64_t)uInt64Value;

- (size_t)sizeValue;

- (ssize_t)sSizeValue;

- (intmax_t)intMaxValue;

- (uintmax_t)uIntMaxValue;

- (ptrdiff_t)ptrDiffValue;

- (intptr_t)intPtrValue;

- (uintptr_t)uIntPtrValue;

- (float)floatValue;

- (double)doubleValue;
@end

OF_ASSUME_NONNULL_END

#if !defined(NSINTEGER_DEFINED) && !__has_feature(modules)
/* Required for number literals to work */
@compatibility_alias NSNumber OFNumber;
#endif