1

#ifndef CHAIN_H

     2

#define CHAIN_H

     3

     4

/**

     8

 *

    10

 * induvidual items.

    11

 */

    12

#include "error.h"

    13

#include <sys/queue.h>

    14

    15

/**

    16

 * The chain header.

    17

 */

    18

struct chain_head {

    20

    const void *chain;

    23

    void *arg;

    26

    STAILQ_ENTRY(chain_head) node;

    27

};

    28

    29

/**

    30

 * @struct chain_list

    31

 *

    32

 * The chain list

    33

 */

    34

STAILQ_HEAD(chain_list, chain_head);

    35

    36

/**

    37

 * Initialize a `struct chain_list`

    38

 */

    39

#define CHAIN_INIT(list_ptr) STAILQ_INIT(list_ptr)

    40

    41

/**

    42

 * Add an item onto the end of a chain_list

    43

 */

    44

err_t chain_add (struct chain_list *list, const void *chain, void *arg);

    45

    46

/**

    47

 * Iterate over the contents of a chain_list

    48

 *

    49

 * struct chain_list *list = ...;

    50

 * struct chain_head *head;

    51

 * struct foo *foo;

    52

 *

    53

 *  CHAIN_FOREACH(list, head) {

    54

 *      for (foo = head->chain; foo->bar; foo++) {

    55

 *          foo->bar(foo, head->arg);

    56

 *      }

    57

 *  }

    58

 */

    59

#define CHAIN_FOREACH(list_ptr, head_ptr) STAILQ_FOREACH(head_ptr, list_ptr, node)

    60

    61

/**

    62

 * Remove an item added with chain_add from a chain_list, matching against the given chain/arg.

    63

 *

    64

 * If no item matches, nothing is done.

    65

 */

    66

void chain_remove (struct chain_list *list, const void *chain, void *arg);

    67

    68

/**

    69

 * Free a chain_list

    70

 */

    71

void chain_free (struct chain_list *list);

    72

    73

#endif