/* * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, * 2018, 2019 * 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. */ #import "OFObject.h" OF_ASSUME_NONNULL_BEGIN /*! * @class OFValue OFValue.h ObjFW/OFValue.h * * @brief A class for storing arbitrary values in an object. */ @interface OFValue: OFObject <OFCopying> /*! * @brief The ObjC type encoding of the value. */ @property (readonly, nonatomic) const char *objCType; /*! * @brief The value as a pointer to void. * * If the value is not pointer-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) void *pointerValue; /*! * @brief The value as a non-retained object. * * If the value is not pointer-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) id nonretainedObjectValue; /*! * @brief The value as a range. * * If the value is not range-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) of_range_t rangeValue; /*! * @brief The value as a point. * * If the value is not point-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) of_point_t pointValue; /*! * @brief The value as a dimension. * * If the value is not dimension-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) of_dimension_t dimensionValue; /*! * @brief The value as a rectangle. * * If the value is not rectangle-sized, @ref OFOutOfRangeException is thrown. */ @property (readonly, nonatomic) of_rectangle_t rectangleValue; /*! * @brief Creates a new, autorelease OFValue with the specified bytes of the * specified type. * * @param bytes The bytes containing the value * @param objCType The ObjC type encoding for the value * @return A new, autoreleased OFValue */ + (instancetype)valueWithBytes: (const void *)bytes objCType: (const char *)objCType; /*! * @brief Creates a new, autoreleased OFValue containing the specified pointer. * * Only the raw value of the pointer is stored and no data will be copied. * * @param pointer The pointer the OFValue should contain * @return A new, autoreleased OFValue */ + (instancetype)valueWithPointer: (const void *)pointer; /*! * @brief Creates a new, autoreleased OFValue containing the specified * non-retained object. * * The object is not retained, which makes this useful for storing objects in * collections without retaining them. * * @param object The object the OFValue should contain without retaining it * @return A new, autoreleased OFValue */ + (instancetype)valueWithNonretainedObject: (id)object; /*! * @brief Creates a new, autoreleased OFValue containing the specified range. * * @param range The range the OFValue should contain * @return A new, autoreleased OFValue */ + (instancetype)valueWithRange: (of_range_t)range; /*! * @brief Creates a new, autoreleased OFValue containing the specified point. * * @param point The point the OFValue should contain * @return A new, autoreleased OFValue */ + (instancetype)valueWithPoint: (of_point_t)point; /*! * @brief Creates a new, autoreleased OFValue containing the specified * dimension. * * @param dimension The dimension the OFValue should contain * @return A new, autoreleased OFValue */ + (instancetype)valueWithDimension: (of_dimension_t)dimension; /*! * @brief Creates a new, autoreleased OFValue containing the specified * rectangle. * * @param rectangle The rectangle the OFValue should contain * @return A new, autoreleased OFValue */ + (instancetype)valueWithRectangle: (of_rectangle_t)rectangle; /*! * @brief Initializes an already allocated OFValue with the specified bytes of * the specified type. * * @param bytes The bytes containing the value * @param objCType The ObjC type encoding for the value * @return An initialized OFValue */ - (instancetype)initWithBytes: (const void *)bytes objCType: (const char *)objCType; /*! * @brief Initializes an already allocated OFValue containing the specified * pointer. * * Only the raw value of the pointer is stored and no data will be copied. * * @param pointer The pointer the OFValue should contain * @return An initialized OFValue */ - (instancetype)initWithPointer: (const void *)pointer; /*! * @brief Initializes an already allocated OFValue containing the specified * non-retained object. * * The object is not retained, which makes this useful for storing objects in * collections without retaining them. * * @param object The object the OFValue should contain without retaining it * @return An initialized OFValue */ - (instancetype)initWithNonretainedObject: (id)object; /*! * @brief Initializes an already allocated OFValue containing the specified * range. * * @param range The range the OFValue should contain * @return An initialized OFValue */ - (instancetype)initWithRange: (of_range_t)range; /*! * @brief Initializes an already allocated OFValue containing the specified * point. * * @param point The point the OFValue should contain * @return An initialized OFValue */ - (instancetype)initWithPoint: (of_point_t)point; /*! * @brief Initializes an already allocated OFValue containing the specified * dimension. * * @param dimension The dimension the OFValue should contain * @return An initialized OFValue */ - (instancetype)initWithDimension: (of_dimension_t)dimension; /*! * @brief Initializes an already allocated OFValue containing the specified * rectangle. * * @param rectangle The rectangle the OFValue should contain * @return An initialized OFValue */ - (instancetype)initWithRectangle: (of_rectangle_t)rectangle; /*! * @brief Gets the value. * * If the specified size does not match, this raises an * @ref OFOutOfRangeException. * * @param value The buffer to copy the value into * @param size The size of the value */ - (void)getValue: (void *)value size: (size_t)size; @end OF_ASSUME_NONNULL_END #if !defined(NSINTEGER_DEFINED) && !__has_feature(modules) /* Required for array literals to work */ @compatibility_alias NSValue OFValue; #endif