list.h

Go to the documentation of this file.

/*
 * Copyright 2013-2015 Guardtime, Inc.
 *
 * This file is part of the Guardtime client SDK.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES, CONDITIONS, OR OTHER LICENSES OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 * "Guardtime" and "KSI" are trademarks or registered trademarks of
 * Guardtime, Inc., and no license to trademarks is granted; Guardtime
 * reserves and retains all trademark rights.
 */

#ifndef KSI_LIST_H_
#define KSI_LIST_H_

#include <stddef.h>
#include "common.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct KSI_List_st KSI_List;

#define KSI_LIST(type) type##List

#define KSI_NEW_LIST(type, list) KSI_List_new(type##_free, (list))

#define KSI_NEW_REFLIST(type, list) KSI_RefList_new(type##_free, type##_ref, (list))

#define KSI_LIST_FN_NAME(type, name) type##List_##name

#define KSI_DEFINE_LIST_STRUCT(ltype, rtype)                    \
                                                                                                                                                                \
        int (*append)(ltype *, rtype *);                                        \
 \
        int (*removeElement)(ltype *, size_t, rtype **);        \
                                                                                                                                                                \
        int (*indexOf)(ltype *, rtype *, size_t **);            \
                                                                                                                                                                \
        int (*insertAt)(ltype *, size_t, rtype *);                      \
                                                                                                                                                                \
        int (*replaceAt)(ltype *, size_t, rtype *);                     \
 \
        int (*elementAt)(ltype *, size_t pos, rtype **);        \
 \
        size_t (*length)(ltype *list);                                          \
        void (*obj_free)(rtype *);                                                      \
 \
        int (*sort)(ltype *list, int (*cmp)(const rtype **, const rtype **)); \
 \
        int (*foldl)(ltype *list, void *foldCtx, int (*fn)(rtype *el, void *foldCtx)); \
 \
        void *pImpl;\
 \
        int (*find)(ltype *list, rtype *el, int *found, size_t *pos); \


#define KSI_DEFINE_LIST(type)                                                                   \
        typedef struct type##_list_st KSI_LIST(type);                           \
        struct type##_list_st {                                                                         \
                KSI_DEFINE_LIST_STRUCT(KSI_LIST(type), type)                    \
        };                                                                                                                      \
        int KSI_LIST_FN_NAME(type, new)(KSI_LIST(type) **list);         \
        void KSI_LIST_FN_NAME(type, free)(KSI_LIST(type) *list);        \


void KSI_List_free(KSI_List *list);
int KSI_List_new(void (*obj_free)(void *), KSI_List **list);
int KSI_List_append(KSI_List *list, void *o);
int KSI_List_remove(KSI_List *list, size_t pos, void **o);
int KSI_List_indexOf(KSI_List *list, void *o, size_t **i);
int KSI_List_insertAt(KSI_List *list, size_t pos, void *o);
int KSI_List_replaceAt(KSI_List *list, size_t pos, void *o);
int KSI_List_elementAt(KSI_List *list, size_t pos, void **o);
size_t KSI_List_length(KSI_List *list);
int KSI_List_sort(KSI_List *list, int (*)(const void **, const void **));
int KSI_List_foldl(KSI_List *list, void *foldCtx, int (*fn)(void *el, void *foldCtx));
int KSI_List_find(KSI_List *list, void *el, int *found, size_t *pos);

#define KSI_IMPLEMENT_LIST(type, free_fn)                                                                                       \
int KSI_LIST_FN_NAME(type, new)(KSI_LIST(type) **list) {                                                        \
        return KSI_List_new((void (*)(void *))free_fn, (KSI_List **)list);                              \
}                                                                                                                                                                       \
void KSI_LIST_FN_NAME(type, free)(KSI_LIST(type) *list) {                                                       \
        KSI_List_free((KSI_List *)list);                                                                                                \
}                                                                                                                                                                       \


#ifdef __cplusplus
}
#endif

#endif /* KSI_LIST_H_ */