List.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/Object.h>
 
typedef struct List List;
typedef struct ListInterface ListInterface;
typedef struct ListNode ListNode;
 
typedef bool (*ListEnumerator)(const List *list, ListNode *node, ident data);
 
struct ListNode {
  ident element;
  ListNode *prev;
  ListNode *next;
};
 
struct List {
 
  Object object;
 
  ListInterface *interface;
 
  size_t count;
 
  ListNode *head;
 
  ListNode *tail;
 
  Consumer destroy;
};
 
struct ListInterface {
 
  ObjectInterface objectInterface;
 
  void (*append)(List *self, const ident element);
 
  bool (*contains)(const List *self, const ident element);
 
  void (*enumerate)(const List *self, ListEnumerator enumerator, ident data);
 
  void (*filter)(List *self, Predicate predicate, ident data);
 
  List *(*filteredList)(const List *self, Predicate predicate, ident data);
 
  ident (*find)(const List *self, Predicate predicate, ident data);
 
  List *(*init)(List *self);
 
  void (*insertAfter)(List *self, ListNode *node, const ident element);
 
  void (*map)(List *self, Functor functor, ident data);
 
  List *(*mappedList)(const List *self, Functor functor, ident data);
 
  ListNode *(*nodeForElement)(const List *self, const ident element);
 
  void (*prepend)(List *self, const ident element);
 
  ident (*reduce)(const List *self, Reducer reducer, ident accumulator, ident data);
 
  void (*removeAll)(List *self);
 
  void (*remove)(List *self, const ident element);
 
  void (*removeNode)(List *self, ListNode *node);
 
  void (*sort)(List *self, Comparator comparator);
};
 
OBJECTIVELY_EXPORT Class *_List(void);