/*
* Copyright (c) 2008-2021 Jonathan Schleifer <js@nil.im>
*
* 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 "OFList.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFSortedList OFSortedList.h ObjFW/OFSortedList.h
*
* @brief A class which provides easy to use sorted double-linked lists.
*
* @warning Because the list is sorted, all methods inserting an object at a
* specific place are unavailable, even though they exist in OFList!
*/
@interface OFSortedList OF_GENERIC(ObjectType): OFList OF_GENERIC(ObjectType)
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
{
OF_RESERVE_IVARS(OFSortedList, 4)
}
- (of_list_object_t *)appendObject: (ObjectType)object OF_UNAVAILABLE;
- (of_list_object_t *)prependObject: (ObjectType)object OF_UNAVAILABLE;
- (of_list_object_t *)insertObject: (ObjectType)object
beforeListObject: (of_list_object_t *)listObject
OF_UNAVAILABLE;
- (of_list_object_t *)insertObject: (ObjectType)object
afterListObject: (of_list_object_t *)listObject
OF_UNAVAILABLE;
/**
* @brief Inserts the object to the list while keeping the list sorted.
*
* @param object The object to insert
* @return The list object for the object just added
*/
- (of_list_object_t *)insertObject: (ObjectType <OFComparing>)object;
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end
OF_ASSUME_NONNULL_END