List Interface¶

#include "libstephen/list.h"

Header (master)

The list interface, defined in libstephen/list.h, is designed to be an implementation-agnostic interface to a list. It comes at a very high price. It is a struct containing a large set of function pointers, and a pointer to data. This means that you have a powerful, full-featured interface to the list. However, frequently using this interface is probably inefficient.

Operations¶

typedef struct smb_list
{
  void *data;
  void (*append)(struct smb_list *l, DATA newData);
  void (*prepend)(struct smb_list *l, DATA newData);
  DATA (*get)(const struct smb_list *l, int index, smb_status *status);
  void (*set)(struct smb_list *l, int index, DATA newData, smb_status *status);
  void (*remove)(struct smb_list *l, int index, smb_status *status);
  void (*insert)(struct smb_list *l, int index, DATA newData);
  void (*delete)(struct smb_list *l);
  int (*length)(const struct smb_list *l);
  void (*push_back)(struct smb_list *l, DATA newData);
  DATA (*pop_back)(struct smb_list *l, smb_status *status);
  DATA (*peek_back)(struct smb_list *l, smb_status *status);
  void (*push_front)(struct smb_list *l, DATA newData);
  DATA (*pop_front)(struct smb_list *l, smb_status *status);
  DATA (*peek_front)(struct smb_list *l, smb_status *status);
  int (*index_of)(const struct smb_list *l, DATA d, DATA_COMPARE comp);
} smb_list;

These operations are most of the useful features of the array and linked lists.

Sample Usage¶

The following code is straight from one of my simpler tests for lists. It works with linked lists or array lists (but a linked list is created here). Each iteration the following code adds a number to the list, and then verifies that the list contains the expected values.

smb_status status = SMB_SUCCESS;
smb_list list = ll_create_list();
int i, j;

for (i = 0; i < 200; i++) {
  list.append(&list, LLINT(i));
  assert(list.length(&list) == i + 1);

  for (j = 0; j < list.length(&list); j++) {
    assert(list.get(&list, j, &status).data_llint == j);
    assert(status == SMB_SUCCESS);
  }
}

list.delete(&list);